refactor: Update IBC callback handling to include transfer details

Author: chipshort

tests/e2e/ibc_callbacks_test.go

@@ -145,8 +145,9 @@ func TestIBCCallbacks(t *testing.T) {
 				assert.Equal(t, []byte("{\"result\":\"AQ==\"}"), response.IBCDestinationCallbacks[0].Ack.Data)
 				assert.Equal(t,
 					wasmvmtypes.Array[wasmvmtypes.Coin]{wasmvmtypes.NewCoin(1, ibcDenom)},
-					response.IBCDestinationCallbacks[0].Funds,
+					response.IBCDestinationCallbacks[0].Transfer.Funds,
 				)
+				assert.Equal(t, contractAddrA.String(), response.IBCDestinationCallbacks[0].Transfer.Receiver)
 
 				balances := chainB.GetWasmApp().BankKeeper.GetAllBalances(chainB.GetContext(), contractAddrB)
 				// sanity check that the balance of the contract is correct
@@ -184,13 +185,13 @@ func TestIBCCallbacks(t *testing.T) {
 	}
 }
 
-func TestIBCDestinationCallbackFunds(t *testing.T) {
+func TestIBCDestinationCallbackTransfer(t *testing.T) {
 	// scenario:
 	// given two chains
 	//   with an ics-20 channel established
 	//   and an ibc-callbacks contract deployed on chain A
 	// when someone sends an ibc transfer to chain B and back to the contract on A
-	// then the contract on A should receive a destination chain callback with correct funds
+	// then the contract on A should receive a destination chain callback with correct transfer info
 
 	coord := wasmibctesting.NewCoordinator(t, 2)
 	chainA := wasmibctesting.NewWasmTestChain(coord.GetChain(ibctesting.GetChainID(1)))
@@ -226,7 +227,7 @@ func TestIBCDestinationCallbackFunds(t *testing.T) {
 	contractAddr := chainA.InstantiateContract(codeID, []byte(`{}`))
 	require.NotEmpty(t, contractAddr)
 
-	// when someone sends an ibc transfer to chain B and back to the contract on A
+	// when someone sends an ibc transfer to chain B
 	chainA.SendMsgs(
 		ibctransfertypes.NewMsgTransfer(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID,
 			oneToken[0], actorChainA.String(), actorChainB.String(), chainA.GetTimeoutHeight(), 0, ""),
@@ -252,8 +253,10 @@ func TestIBCDestinationCallbackFunds(t *testing.T) {
 	// the denom should be reversed back correctly to the original denom
 	assert.Equal(t,
 		wasmvmtypes.Array[wasmvmtypes.Coin]{wasmvmtypes.NewCoin(1, sdk.DefaultBondDenom)},
-		response.IBCDestinationCallbacks[0].Funds,
+		response.IBCDestinationCallbacks[0].Transfer.Funds,
 	)
+	assert.Equal(t, contractAddr.String(), response.IBCDestinationCallbacks[0].Transfer.Receiver)
+	assert.Equal(t, actorChainB.String(), response.IBCDestinationCallbacks[0].Transfer.Sender)
 }
 
 func TestIBCCallbacksWithoutEntrypoints(t *testing.T) {

tests/e2e/testdata/ibc_callbacks.wasm

@@ -416,7 +416,7 @@ func (i IBCHandler) IBCReceivePacketCallback(
 		return err
 	}
 
-	var funds wasmvmtypes.Array[wasmvmtypes.Coin]
+	var transfer *wasmvmtypes.IBCTransferCallback
 
 	var parsedAck channeltypes.Acknowledgement_Result
 	err = json.Unmarshal(ack.Acknowledgement(), &parsedAck)
@@ -432,37 +432,40 @@ func (i IBCHandler) IBCReceivePacketCallback(
 			return errorsmod.Wrap(err, "unmarshal transfer packet data")
 		}
 
+		// just making sure we have a valid address
 		receiverAddr, err := sdk.AccAddressFromBech32(transferData.Receiver)
 		if err != nil {
 			return err
 		}
-		// we only want to tell the contract about the funds if the transfer was sent to the contract
-		if receiverAddr.Equals(contractAddr) {
-			// fill funds with the transfer amount
-
-			// For a more in-depth explanation of the logic here, see the transfer module implementation:
-			// https://github.com/cosmos/ibc-go/blob/a6217ab02a4d57c52a938eeaff8aeb383e523d12/modules/apps/transfer/keeper/relay.go#L147-L175
-			if transferData.Token.Denom.HasPrefix(packet.GetSourcePort(), packet.GetSourceChannel()) {
-				// this is a denom coming from this chain, being sent back again
-				// remove prefix
-				transferData.Token.Denom.Trace = transferData.Token.Denom.Trace[1:]
-			} else {
-				// prefixing happens on the receiving end, so we need to do that here
-				trace := []transfertypes.Hop{transfertypes.NewHop(packet.GetDestPort(), packet.GetDestChannel())}
-				transferData.Token.Denom.Trace = append(trace, transferData.Token.Denom.Trace...)
-			}
-
-			funds = append(funds, wasmvmtypes.Coin{
-				Denom:  transferData.Token.GetDenom().IBCDenom(),
-				Amount: transferData.Token.GetAmount(),
-			})
+
+		// For a more in-depth explanation of the logic here, see the transfer module implementation:
+		// https://github.com/cosmos/ibc-go/blob/a6217ab02a4d57c52a938eeaff8aeb383e523d12/modules/apps/transfer/keeper/relay.go#L147-L175
+		if transferData.Token.Denom.HasPrefix(packet.GetSourcePort(), packet.GetSourceChannel()) {
+			// this is a denom coming from this chain, being sent back again
+			// remove prefix
+			transferData.Token.Denom.Trace = transferData.Token.Denom.Trace[1:]
+		} else {
+			// prefixing happens on the receiving end, so we need to do that here
+			trace := []transfertypes.Hop{transfertypes.NewHop(packet.GetDestPort(), packet.GetDestChannel())}
+			transferData.Token.Denom.Trace = append(trace, transferData.Token.Denom.Trace...)
+		}
+
+		transfer = &wasmvmtypes.IBCTransferCallback{
+			Receiver: receiverAddr.String(),
+			Sender:   transferData.Sender,
+			Funds: wasmvmtypes.Array[wasmvmtypes.Coin]{
+				{
+					Denom:  transferData.Token.GetDenom().IBCDenom(),
+					Amount: transferData.Token.GetAmount(),
+				},
+			},
 		}
 	}
 
 	msg := wasmvmtypes.IBCDestinationCallbackMsg{
-		Ack:    wasmvmtypes.IBCAcknowledgement{Data: ack.Acknowledgement()},
-		Packet: newIBCPacket(packet),
-		Funds:  funds,
+		Ack:      wasmvmtypes.IBCAcknowledgement{Data: ack.Acknowledgement()},
+		Packet:   newIBCPacket(packet),
+		Transfer: transfer,
 	}
 
 	err = i.keeper.IBCDestinationCallback(cachedCtx, contractAddr, msg)