Add async support to wasm hooks

CHANGELOG.md

@@ -42,6 +42,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Features
+
+* [#5072](https://github.com/osmosis-labs/osmosis/pull/5072) IBC-hooks: Add support for async acks when processing onRecvPacket
+
 ### State Breaking
 
 * [#5532](https://github.com/osmosis-labs/osmosis/pull/5532) fix: Fix x/tokenfactory genesis import denoms reset x/bank existing denom metadata

app/keepers/keepers.go

@@ -246,8 +246,11 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 	// Configure the hooks keeper
 	hooksKeeper := ibchookskeeper.NewKeeper(
 		appKeepers.keys[ibchookstypes.StoreKey],
+		appKeepers.GetSubspace(ibchookstypes.ModuleName),
+		appKeepers.IBCKeeper.ChannelKeeper,
+		nil,
 	)
-	appKeepers.IBCHooksKeeper = &hooksKeeper
+	appKeepers.IBCHooksKeeper = hooksKeeper
 
 	appKeepers.WireICS20PreWasmKeeper(appCodec, bApp, appKeepers.IBCHooksKeeper)
 
@@ -471,6 +474,7 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 	appKeepers.RateLimitingICS4Wrapper.ContractKeeper = appKeepers.ContractKeeper
 	appKeepers.Ics20WasmHooks.ContractKeeper = appKeepers.ContractKeeper
 	appKeepers.CosmwasmPoolKeeper.SetContractKeeper(appKeepers.ContractKeeper)
+	appKeepers.IBCHooksKeeper.ContractKeeper = appKeepers.ContractKeeper
 
 	// set token factory contract keeper
 	appKeepers.TokenFactoryKeeper.SetContractKeeper(appKeepers.ContractKeeper)
@@ -665,6 +669,7 @@ func (appKeepers *AppKeepers) initParamsKeeper(appCodec codec.BinaryCodec, legac
 	paramsKeeper.Subspace(icqtypes.ModuleName)
 	paramsKeeper.Subspace(packetforwardtypes.ModuleName).WithKeyTable(packetforwardtypes.ParamKeyTable())
 	paramsKeeper.Subspace(cosmwasmpooltypes.ModuleName)
+	paramsKeeper.Subspace(ibchookstypes.ModuleName)
 
 	return paramsKeeper
 }

app/modules.go

@@ -181,7 +181,7 @@ func appModules(
 		tokenfactory.NewAppModule(*app.TokenFactoryKeeper, app.AccountKeeper, app.BankKeeper),
 		valsetprefmodule.NewAppModule(appCodec, *app.ValidatorSetPreferenceKeeper),
 		ibcratelimitmodule.NewAppModule(*app.RateLimitingICS4Wrapper),
-		ibc_hooks.NewAppModule(app.AccountKeeper),
+		ibc_hooks.NewAppModule(app.AccountKeeper, *app.IBCHooksKeeper),
 		icq.NewAppModule(*app.AppKeepers.ICQKeeper),
 		packetforward.NewAppModule(app.PacketForwardKeeper),
 		cwpoolmodule.NewAppModule(appCodec, *app.CosmwasmPoolKeeper),

cosmwasm/contracts/crosschain-registry/src/execute.rs

@@ -828,7 +828,7 @@ mod tests {
         let unauthorized_remove_msg = ExecuteMsg::ModifyContractAlias {
             operations: vec![ContractAliasInput {
                 operation: Operation::Remove,
-                alias: alias,
+                alias,
                 address: Some(address),
                 new_alias: None,
             }],

go.mod

@@ -21,9 +21,9 @@ require (
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/osmosis-labs/go-mutesting v0.0.0-20221208041716-b43bcd97b3b3
 	github.com/osmosis-labs/osmosis/osmomath v0.0.3-dev.0.20230629191111-f375469de8b6
-	github.com/osmosis-labs/osmosis/osmoutils v0.0.0-20230709024311-81c831b050de
+	github.com/osmosis-labs/osmosis/osmoutils v0.0.0-20230717123101-c28fbec0b19b
 	github.com/osmosis-labs/osmosis/x/epochs v0.0.0-20230328024000-175ec88e4304
-	github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20230602130523-f9a94d8bbd10
+	github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20230717123101-c28fbec0b19b
 	github.com/pkg/errors v0.9.1
 	github.com/rakyll/statik v0.1.7
 	github.com/spf13/cast v1.5.1

go.sum

@@ -950,12 +950,12 @@ github.com/osmosis-labs/go-mutesting v0.0.0-20221208041716-b43bcd97b3b3 h1:Ylmch
 github.com/osmosis-labs/go-mutesting v0.0.0-20221208041716-b43bcd97b3b3/go.mod h1:lV6KnqXYD/ayTe7310MHtM3I2q8Z6bBfMAi+bhwPYtI=
 github.com/osmosis-labs/osmosis/osmomath v0.0.3-dev.0.20230629191111-f375469de8b6 h1:Kmkx5Rh72+LB8AL6dc6fZA+IVR0INu0YIiMF2ScDhaQ=
 github.com/osmosis-labs/osmosis/osmomath v0.0.3-dev.0.20230629191111-f375469de8b6/go.mod h1:JTym95/bqrSnG5MPcXr1YDhv43JdCeo3p+iDbazoX68=
-github.com/osmosis-labs/osmosis/osmoutils v0.0.0-20230709024311-81c831b050de h1:W2lMduMgpNA5zheEIIialw08n1pWJ44Y4t2F924tpDU=
-github.com/osmosis-labs/osmosis/osmoutils v0.0.0-20230709024311-81c831b050de/go.mod h1:Pl8Nzx6O6ow/+aqfMoMSz4hX+zz6RrnDYsooptECGxM=
+github.com/osmosis-labs/osmosis/osmoutils v0.0.0-20230717123101-c28fbec0b19b h1:sfhra8bqYR1X/U6HoTMbjN5xQ476bXjNC1awYCa8at4=
+github.com/osmosis-labs/osmosis/osmoutils v0.0.0-20230717123101-c28fbec0b19b/go.mod h1:Pl8Nzx6O6ow/+aqfMoMSz4hX+zz6RrnDYsooptECGxM=
 github.com/osmosis-labs/osmosis/x/epochs v0.0.0-20230328024000-175ec88e4304 h1:RIrWLzIiZN5Xd2JOfSOtGZaf6V3qEQYg6EaDTAkMnCo=
 github.com/osmosis-labs/osmosis/x/epochs v0.0.0-20230328024000-175ec88e4304/go.mod h1:yPWoJTj5RKrXKUChAicp+G/4Ni/uVEpp27mi/FF/L9c=
-github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20230602130523-f9a94d8bbd10 h1:XrES5AHZMZ/Y78boW35PTignkhN9h8VvJ1sP8EJDIu8=
-github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20230602130523-f9a94d8bbd10/go.mod h1:Ln6CKcXg/CJLSBE6Fd96/MIKPyA4iHuQTKSbl9q7vYo=
+github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20230717123101-c28fbec0b19b h1:TFRJCgCjnXCB7/5kC+RttfFwnEQzR5aNnjpXTDFTfcI=
+github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20230717123101-c28fbec0b19b/go.mod h1:sR0lpev9mcm9/9RY50T1og3UC3WpZAsINh/OmgrmFlg=
 github.com/osmosis-labs/wasmd v0.31.0-osmo-v16 h1:X747cZYdnqc/+RV48iPVeGprpVb/fUWSaKGsZUWrdbg=
 github.com/osmosis-labs/wasmd v0.31.0-osmo-v16/go.mod h1:Rf8zW/GgBQyFRRB4s62VQHWA6sTlMFSjoDQQpoq64iI=
 github.com/otiai10/copy v1.2.0/go.mod h1:rrF5dJ5F0t/EWSYODDu4j9/vEeYHMkc8jt0zJChqQWw=

osmoutils/ibc.go

@@ -14,6 +14,22 @@ const IbcAcknowledgementErrorType = "ibc-acknowledgement-error"
 // NewEmitErrorAcknowledgement creates a new error acknowledgement after having emitted an event with the
 // details of the error.
 func NewEmitErrorAcknowledgement(ctx sdk.Context, err error, errorContexts ...string) channeltypes.Acknowledgement {
+	EmitIBCErrorEvents(ctx, err, errorContexts)
+
+	return channeltypes.NewErrorAcknowledgement(err)
+}
+
+// NewSuccessAckRepresentingAnError creates a new success acknowledgement that represents an error.
+// This is useful for notifying the sender that an error has occurred in a way that does not allow
+// the received tokens to be reverted (which means they shouldn't be released by the sender's ics20 escrow)
+func NewSuccessAckRepresentingAnError(ctx sdk.Context, err error, errorContent []byte, errorContexts ...string) channeltypes.Acknowledgement {
+	EmitIBCErrorEvents(ctx, err, errorContexts)
+
+	return channeltypes.NewResultAcknowledgement(errorContent)
+}
+
+// EmitIBCErrorEvents Emit and Log errors
+func EmitIBCErrorEvents(ctx sdk.Context, err error, errorContexts []string) {
 	logger := ctx.Logger().With("module", IbcAcknowledgementErrorType)
 
 	attributes := make([]sdk.Attribute, len(errorContexts)+1)
@@ -29,8 +45,6 @@ func NewEmitErrorAcknowledgement(ctx sdk.Context, err error, errorContexts ...st
 			attributes...,
 		),
 	})
-
-	return channeltypes.NewErrorAcknowledgement(err)
 }
 
 // MustExtractDenomFromPacketOnRecv takes a packet with a valid ICS20 token data in the Data field and returns the

proto/osmosis/ibc-hooks/genesis.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+package osmosis.ibchooks;
+
+import "gogoproto/gogo.proto";
+import "cosmos_proto/cosmos.proto";
+import "osmosis/ibc-hooks/params.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/v16/x/ibc-hooks/types";
+
+message GenesisState { Params params = 1 [ (gogoproto.nullable) = false ]; }

proto/osmosis/ibc-hooks/params.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package osmosis.ibchooks;
+
+import "gogoproto/gogo.proto";
+import "cosmos_proto/cosmos.proto";
+import "google/protobuf/duration.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/v16/x/ibc-hooks/types";
+
+message Params {
+  repeated string allowed_async_ack_contracts = 1
+      [ (gogoproto.moretags) = "yaml:\"allowed_async_ack_contracts\"" ];
+}

proto/osmosis/ibc-hooks/tx.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+package osmosis.ibchooks;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/v16/x/ibc-hooks/types";
+
+// Msg defines the Msg service.
+service Msg {
+  // EmitIBCAck checks the sender can emit the ack and writes the IBC
+  // acknowledgement
+  rpc EmitIBCAck(MsgEmitIBCAck) returns (MsgEmitIBCAckResponse);
+}
+
+message MsgEmitIBCAck {
+  string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ];
+  uint64 packet_sequence = 2
+      [ (gogoproto.moretags) = "yaml:\"packet_sequence\"" ];
+  string channel = 3 [ (gogoproto.moretags) = "yaml:\"channel\"" ];
+}
+message MsgEmitIBCAckResponse {
+  string contract_result = 1
+      [ (gogoproto.moretags) = "yaml:\"contract_result\"" ];
+  string ibc_ack = 2 [ (gogoproto.moretags) = "yaml:\"ibc_ack\"" ];
+}

tests/ibc-hooks/async_acks_test.go

@@ -0,0 +1,120 @@
+package ibc_hooks_test
+
+import (
+	"encoding/base64"
+	"encoding/json"
+	"fmt"
+	wasmkeeper "github.com/CosmWasm/wasmd/x/wasm/keeper"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	channeltypes "github.com/cosmos/ibc-go/v4/modules/core/04-channel/types"
+	ibctesting "github.com/cosmos/ibc-go/v4/testing"
+	"github.com/osmosis-labs/osmosis/osmoutils"
+	"github.com/osmosis-labs/osmosis/v16/app"
+	"github.com/osmosis-labs/osmosis/x/ibc-hooks/types"
+	"github.com/tidwall/gjson"
+)
+
+func (suite *HooksTestSuite) forceContractToEmitAckForPacket(osmosisApp *app.OsmosisApp, ctx sdk.Context, contractAddr sdk.AccAddress, packet channeltypes.Packet, success bool) ([]byte, error) {
+	packetJson, err := json.Marshal(packet)
+	suite.Require().NoError(err)
+
+	msg := fmt.Sprintf(`{"force_emit_ibc_ack": {"packet": %s, "channel": "channel-0", "success": %v }}`, packetJson, success)
+	contractKeeper := wasmkeeper.NewDefaultPermissionKeeper(osmosisApp.WasmKeeper)
+	return contractKeeper.Execute(ctx, contractAddr, suite.chainA.SenderAccount.GetAddress(), []byte(msg), sdk.NewCoins())
+
+}
+
+func (suite *HooksTestSuite) TestWasmHooksAsyncAcks() {
+	sender := suite.chainB.SenderAccount.GetAddress()
+	osmosisApp := suite.chainA.GetOsmosisApp()
+
+	// Instantiate a contract that knows how to send async Acks
+	suite.chainA.StoreContractCode(&suite.Suite, "./bytecode/echo.wasm")
+	contractAddr := suite.chainA.InstantiateContract(&suite.Suite, "{}", 1)
+
+	// Calls that don't specify async acks work as expected
+	memo := fmt.Sprintf(`{"wasm": {"contract": "%s", "msg": {"async": {"use_async": false}}}}`, contractAddr)
+	suite.fundAccount(suite.chainB, sender)
+	transferMsg := NewMsgTransfer(sdk.NewCoin("token0", sdk.NewInt(2000)), sender.String(), contractAddr.String(), "channel-0", memo)
+	sendResult, receiveResult, ack, err := suite.FullSend(transferMsg, BtoA)
+	suite.Require().NoError(err)
+	suite.Require().NotNil(sendResult)
+	suite.Require().NotNil(receiveResult)
+	suite.Require().NotNil(ack)
+
+	// the ack has been written
+	allAcks := osmosisApp.IBCKeeper.ChannelKeeper.GetAllPacketAcks(suite.chainA.GetContext())
+	suite.Require().Equal(1, len(allAcks))
+
+	// Try to emit an ack for a packet that already has been acked. This should fail
+
+	// we extract the packet that has been acked here to test later that our contract can't emit an ack for it
+	alreadyAckedPacket, err := ibctesting.ParsePacketFromEvents(sendResult.GetEvents())
+	suite.Require().NoError(err)
+
+	_, err = suite.forceContractToEmitAckForPacket(osmosisApp, suite.chainA.GetContext(), contractAddr, alreadyAckedPacket, true)
+	suite.Require().Error(err)
+	suite.Require().Contains(err.Error(), "no ack actor set for channel channel-0 packet 1")
+
+	params := types.DefaultParams()
+	params.AllowedAsyncAckContracts = []string{contractAddr.String()}
+	osmosisApp.IBCHooksKeeper.SetParams(suite.chainA.GetContext(), params)
+
+	totalExpectedAcks := 1
+	testCases := []struct {
+		success bool
+	}{
+		{true},
+		{false},
+	}
+	for _, tc := range testCases {
+		// Calls that specify async Acks work and no Acks are sent
+		memo = fmt.Sprintf(`{"wasm": {"contract": "%s", "msg": {"async": {"use_async": true}}}}`, contractAddr)
+		suite.fundAccount(suite.chainB, sender)
+		transferMsg = NewMsgTransfer(sdk.NewCoin("token0", sdk.NewInt(2000)), sender.String(), contractAddr.String(), "channel-0", memo)
+
+		sendResult, err = suite.chainB.SendMsgsNoCheck(transferMsg)
+		suite.Require().NoError(err)
+
+		packet, err := ibctesting.ParsePacketFromEvents(sendResult.GetEvents())
+		suite.Require().NoError(err)
+
+		receiveResult = suite.RelayPacketNoAck(packet, BtoA)
+		newAck, err := ibctesting.ParseAckFromEvents(receiveResult.GetEvents())
+		suite.Require().Error(err) // No ack!
+		suite.Require().Nil(newAck)
+
+		// No new ack has been written
+		allAcks = osmosisApp.IBCKeeper.ChannelKeeper.GetAllPacketAcks(suite.chainA.GetContext())
+		suite.Require().Equal(totalExpectedAcks, len(allAcks))
+
+		// Store a second contract and ask that one to emit an ack for the packet that the first contract sent
+		contractAddr2 := suite.chainA.InstantiateContract(&suite.Suite, "{}", 1)
+		_, err = suite.forceContractToEmitAckForPacket(osmosisApp, suite.chainA.GetContext(), contractAddr2, packet, tc.success)
+		// This should fail because the new contract is not authorized to emit acks for that packet
+		suite.Require().Error(err)
+		suite.Require().Contains(err.Error(), "is not allowed to send an ack for channel channel-0 packet")
+
+		// only the contract that sent the packet can send an ack for that packet sequence
+		ctx := suite.chainA.GetContext()
+		_, err = suite.forceContractToEmitAckForPacket(osmosisApp, ctx, contractAddr, packet, tc.success)
+		totalExpectedAcks++
+		suite.Require().NoError(err)
+		writtenAck, err := ibctesting.ParseAckFromEvents(ctx.EventManager().Events())
+		suite.Require().NoError(err)
+
+		allAcks = osmosisApp.IBCKeeper.ChannelKeeper.GetAllPacketAcks(suite.chainA.GetContext())
+		suite.Require().Equal(totalExpectedAcks, len(allAcks))
+		suite.Require().False(osmoutils.IsAckError(writtenAck))
+		ackBase64 := gjson.ParseBytes(writtenAck).Get("result").String()
+		// decode base64
+		ackBytes, err := base64.StdEncoding.DecodeString(ackBase64)
+		suite.Require().NoError(err)
+		if tc.success {
+			suite.Require().Equal("YWNr", gjson.ParseBytes(ackBytes).Get("ibc_ack").String())
+		} else {
+			suite.Require().Equal("forced error", gjson.ParseBytes(ackBytes).Get("error").String())
+		}
+
+	}
+}