Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Fix ibchooks v2 receive failures to emit the failure cause as an event and use the ibchooks error code (matching v1) [#2868](https://github.com/provenance-io/provenance/issues/2868).
25 changes: 14 additions & 11 deletions x/ibchooks/v2/ibc_module.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package v2

import (
"encoding/json"
"errors"
"fmt"
"strings"

Expand Down Expand Up @@ -155,7 +156,7 @@ func (im IBCModule) OnRecvPacket(
// Run marker hooks: create marker for IBC denom if needed.
ibcDenom := extractDenomFromV2PacketOnRecv(data, payload, sourceClient, destinationClient)
if err := im.addMarkerForDenom(ctx, data, ibcDenom, destinationClient); err != nil {
return errRecvResult(err, types.ErrMarkerError)
return errRecvResult(ctx, err, types.ErrMarkerError)
}

// Check for wasm routing.
Expand All @@ -164,24 +165,24 @@ func (im IBCModule) OnRecvPacket(
return im.app.OnRecvPacket(ctx, sourceClient, destinationClient, sequence, payload, relayer)
}
if err != nil {
return errRecvResult(err, types.ErrMsgValidation)
return errRecvResult(ctx, err, types.ErrMsgValidation)
}
if msgBytes == nil || contractAddr == nil {
return errRecvResult(types.ErrMsgValidation, types.ErrMsgValidation)
return errRecvResult(ctx, errors.New("wasm memo is missing the contract address or msg"), types.ErrMsgValidation)
}

// Derive intermediate sender from the destination client and original sender.
sender := data.GetSender()
senderBech32, err := keeper.DeriveIntermediateSender(destinationClient, sender, im.bech32PrefixAccAddr)
if err != nil {
return errRecvResult(fmt.Errorf("cannot convert sender address %s/%s to bech32: %w", destinationClient, sender, err), types.ErrBadSender)
return errRecvResult(ctx, fmt.Errorf("cannot convert sender address %s/%s to bech32: %w", destinationClient, sender, err), types.ErrBadSender)
}

// Hijack the receiver to the intermediate sender so the transfer app sends funds there.
data.Receiver = senderBech32
modifiedPayload, err := marshalV2Payload(data, payload)
if err != nil {
return errRecvResult(err, types.ErrMarshaling)
return errRecvResult(ctx, err, types.ErrMarshaling)
}

// Execute the receive with the modified payload.
Expand All @@ -192,7 +193,7 @@ func (im IBCModule) OnRecvPacket(

amount, ok := sdkmath.NewIntFromString(data.GetAmount())
if !ok {
return errRecvResult(fmt.Errorf("amount %q is not an int", data.GetAmount()), types.ErrInvalidPacket)
return errRecvResult(ctx, fmt.Errorf("amount %q is not an int", data.GetAmount()), types.ErrInvalidPacket)
}

funds := sdk.NewCoins(sdk.NewCoin(ibcDenom, amount))
Expand All @@ -205,18 +206,18 @@ func (im IBCModule) OnRecvPacket(
Funds: funds,
}
if err := execMsg.ValidateBasic(); err != nil {
return errRecvResult(fmt.Errorf(types.ErrBadExecutionMsg, err), types.ErrWasmError)
return errRecvResult(ctx, fmt.Errorf(types.ErrBadExecutionMsg, err), types.ErrWasmError)
}
wasmMsgServer := wasmkeeper.NewMsgServerImpl(im.contractKeeper)
response, err := wasmMsgServer.ExecuteContract(ctx, &execMsg)
if err != nil {
return errRecvResult(err, types.ErrWasmError)
return errRecvResult(ctx, err, types.ErrWasmError)
}

fullAck := types.ContractAck{ContractResult: response.Data, IbcAck: result.Acknowledgement}
bz, err := json.Marshal(fullAck)
if err != nil {
return errRecvResult(err, types.ErrBadResponse)
return errRecvResult(ctx, err, types.ErrBadResponse)
}

return channeltypesv2.RecvPacketResult{
Expand Down Expand Up @@ -320,10 +321,12 @@ func (im IBCModule) OnTimeoutPacket(
}

// errRecvResult creates a failure RecvPacketResult with an error acknowledgement.
func errRecvResult(err error, wrapErr error) channeltypesv2.RecvPacketResult {
// The acknowledgement has the ABCI code of wrapErr, and the cause is emitted as an
// ibc-acknowledgement-error event (the same as the v1 hooks).
func errRecvResult(ctx sdk.Context, err error, wrapErr error) channeltypesv2.RecvPacketResult {
return channeltypesv2.RecvPacketResult{
Status: channeltypesv2.PacketStatus_Failure,
Acknowledgement: channeltypes.NewErrorAcknowledgement(fmt.Errorf("%w: %w", wrapErr, err)).Acknowledgement(),
Acknowledgement: ibchooks.NewEmitErrorAcknowledgement(ctx, wrapErr, err.Error()).Acknowledgement(),
Comment thread
SpicyLemon marked this conversation as resolved.
Resolved
}
}

Expand Down
36 changes: 36 additions & 0 deletions x/ibchooks/v2/ibc_module_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,39 @@ func newMockApp() *mockApp {
}
}

// requireErrorAck checks that the result is a failure with an error acknowledgement that has the expected
// ABCI code, and that an ibc-acknowledgement-error event was emitted for expErr with an error-context
// that contains expContext.
func requireErrorAck(t *testing.T, ctx sdk.Context, result channeltypesv2.RecvPacketResult, expErr error, expCode uint32, expContext string) {
t.Helper()
require.Equal(t, channeltypesv2.PacketStatus_Failure, result.Status, "result status")

var ack channeltypes.Acknowledgement
require.NoError(t, channeltypes.SubModuleCdc.UnmarshalJSON(result.Acknowledgement, &ack), "unmarshal acknowledgement")
require.False(t, ack.Success(), "acknowledgement success")
expAckErr := fmt.Sprintf("ABCI code: %d: error handling packet: see events for details", expCode)
assert.Equal(t, expAckErr, ack.GetError(), "acknowledgement error")

var errAttrs, ctxAttrs []string
for _, event := range ctx.EventManager().Events() {
if event.Type != "ibc-acknowledgement-error" {
continue
}
for _, attr := range event.Attributes {
switch attr.Key {
case "error":
errAttrs = append(errAttrs, attr.Value)
case "error-context":
ctxAttrs = append(ctxAttrs, attr.Value)
}
}
}
assert.Equal(t, []string{expErr.Error()}, errAttrs, "ibc-acknowledgement-error event error attributes")
if assert.Len(t, ctxAttrs, 1, "ibc-acknowledgement-error event error-context attributes") {
assert.Contains(t, ctxAttrs[0], expContext, "ibc-acknowledgement-error event error-context")
}
}

// newTestModule creates a fully-configured IBCModule for testing, backed by real keepers.
func newTestModule(t *testing.T, app *mockApp) (v2.IBCModule, sdk.Context) {
t.Helper()
Expand Down Expand Up @@ -353,6 +386,7 @@ func TestOnRecvPacket_WasmMemo_ContractMismatch(t *testing.T) {
result := mw.OnRecvPacket(ctx, "src-client", "dst-client", 1, payload, nil)
assert.Equal(t, channeltypesv2.PacketStatus_Failure, result.Status, "contract/receiver mismatch should fail")
assert.False(t, app.onRecvPacketCalled, "should not delegate on validation error")
requireErrorAck(t, ctx, result, types.ErrMsgValidation, 2, `wasm["contract"] should be the same as the receiver of the packet`)
}

func TestOnRecvPacket_WasmMemo_InvalidContract(t *testing.T) {
Expand All @@ -367,6 +401,7 @@ func TestOnRecvPacket_WasmMemo_InvalidContract(t *testing.T) {
result := mw.OnRecvPacket(ctx, "src-client", "dst-client", 1, payload, nil)
assert.Equal(t, channeltypesv2.PacketStatus_Failure, result.Status, "invalid contract address should fail")
assert.False(t, app.onRecvPacketCalled)
requireErrorAck(t, ctx, result, types.ErrMsgValidation, 2, `wasm["contract"] is not a valid bech32 address`)
}

func TestOnRecvPacket_WasmMemo_ModifiesReceiver(t *testing.T) {
Expand Down Expand Up @@ -402,6 +437,7 @@ func TestOnRecvPacket_WasmMemo_ModifiesReceiver(t *testing.T) {
// Wasm execution will fail (no real contract deployed), so expect a failure result.
assert.Equal(t, channeltypesv2.PacketStatus_Failure, result.Status,
"should fail because the wasm contract does not exist")
requireErrorAck(t, ctx, result, types.ErrWasmError, 6, "no such contract")
Comment thread
nagarajdivine marked this conversation as resolved.
Resolved

// Verify the receiver was modified to the derived intermediate sender.
modifiedData, err := transfertypes.UnmarshalPacketData(
Expand Down
Loading