x/ibc: implement ADR 032 typed events

proto/ibc/applications/transfer/v1/event.proto → proto/ibc/applications/transfer/v1/events.proto

@@ -12,12 +12,19 @@ message EventTransfer {
     string receiver = 2;
 }
 
+// EventAcknowledgementSuccess is a typed event emitted on packet acknowledgement success
+message EventAcknowledgementSuccess {
+    bytes success = 1;
+}
+
+// EventAcknowledgementError is a typed event emitted on packet acknowledgement error
+message EventAcknowledgementError {
+    string error = 1;
+}
+
 // EventDenominationTrace is a typed event for denomination trace
 message EventDenominationTrace {
-    bytes trace_hash = 1 [
-        (gogoproto.casttype) = "github.com/tendermint/tendermint/libs/bytes.HexBytes",
-        (gogoproto.moretags) = "yaml:\"trace_hash\""
-    ];
+    string trace_hash = 1 [(gogoproto.moretags) = "yaml:\"trace_hash\""];
 
     string denom = 2;
 }

proto/ibc/core/channel/v1/event.proto → proto/ibc/core/channel/v1/events.proto

@@ -15,8 +15,6 @@ message EventChannelOpenInit {
 
     string counterparty_port_id = 3 [(gogoproto.moretags) = "yaml:\"counterparty_port_id\""];
 
-    string counterparty_channel_id = 4 [(gogoproto.moretags) = "yaml:\"counterparty_channel_id\""];
-
     string connection_id = 5 [(gogoproto.moretags) = "yaml:\"connection_id\""];
 }
 
@@ -46,8 +44,8 @@ message EventChannelOpenAck {
     string connection_id = 5 [(gogoproto.moretags) = "yaml:\"connection_id\""];
 }
 
-// EventChannelCloseInit is a typed event emitted on channel close init
-message EventChannelCloseInit {
+// EventChannelOpenConfirm is a typed event emitted on channel open confirm
+message EventChannelOpenConfirm {
     string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
 
     string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
@@ -59,8 +57,8 @@ message EventChannelCloseInit {
     string connection_id = 5 [(gogoproto.moretags) = "yaml:\"connection_id\""];
 }
 
-// EventChannelOpenConfirm is a typed event emitted on channel open confirm
-message EventChannelOpenConfirm {
+// EventChannelCloseInit is a typed event emitted on channel close init
+message EventChannelCloseInit {
     string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
 
     string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
@@ -127,8 +125,6 @@ message EventChannelRecvPacket {
     string dst_channel = 8 [(gogoproto.moretags) = "yaml:\"dst_channel\""];
 
     Order channel_ordering = 9 [(gogoproto.moretags) = "yaml:\"channel_ordering\""];
-
-    bool success = 10;
 }
 
 // EventChannelWriteAck is a typed event emitted on write acknowledgement
@@ -198,13 +194,3 @@ message EventChannelTimeoutPacket {
 
     Order channel_ordering = 9 [(gogoproto.moretags) = "yaml:\"channel_ordering\""];
 }
-
-// EventAcknowledgementSuccess is a typed event emitted on packet acknowledgement success
-message EventAcknowledgementSuccess {
-    bytes success = 1;
-}
-
-// EventAcknowledgementError is a typed event emitted on packet acknowledgement error
-message EventAcknowledgementError {
-    string error = 1;
-}

proto/ibc/core/connection/v1/event.proto → proto/ibc/core/connection/v1/events.proto

@@ -11,8 +11,6 @@ message EventConnectionOpenInit {
 
     string client_id = 2 [(gogoproto.moretags) = "yaml:\"client_id\""];
 
-    string counterparty_connection_id = 3 [(gogoproto.moretags) = "yaml:\"counterparty_connection_id\""];
-
     string counterparty_client_id = 4 [(gogoproto.moretags) = "yaml:\"counterparty_client_id\""];
 }
 

x/ibc/applications/transfer/keeper/keeper.go

@@ -169,8 +169,3 @@ func (k Keeper) AuthenticateCapability(ctx sdk.Context, cap *capabilitytypes.Cap
 func (k Keeper) ClaimCapability(ctx sdk.Context, cap *capabilitytypes.Capability, name string) error {
 	return k.scopedKeeper.ClaimCapability(ctx, cap, name)
 }
-
-// GetChannel returns a channel with a particular identifier binded to a specific port
-func (k Keeper) GetChannel(ctx sdk.Context, portID, channelID string) (channeltypes.Channel, bool) {
-	return k.channelKeeper.GetChannel(ctx, portID, channelID)
-}

x/ibc/applications/transfer/keeper/msg_server.go

@@ -36,12 +36,5 @@ func (k Keeper) Transfer(goCtx context.Context, msg *types.MsgTransfer) (*types.
 		return nil, err
 	}
 
-	ctx.EventManager().EmitEvent(
-		sdk.NewEvent(
-			sdk.EventTypeMessage,
-			sdk.NewAttribute(sdk.AttributeKeyModule, types.ModuleName),
-		),
-	)
-
 	return &types.MsgTransferResponse{}, nil
 }

x/ibc/applications/transfer/keeper/relay.go

@@ -267,7 +267,7 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
 	voucherDenom := denomTrace.IBCDenom()
 	if err := ctx.EventManager().EmitTypedEvent(
 		&types.EventDenominationTrace{
-			TraceHash: traceHash,
+			TraceHash: traceHash.String(),
 			Denom:     voucherDenom,
 		},
 	); err != nil {

x/ibc/applications/transfer/module.go

@@ -26,7 +26,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/ibc/applications/transfer/keeper"
 	"github.com/cosmos/cosmos-sdk/x/ibc/applications/transfer/simulation"
 	"github.com/cosmos/cosmos-sdk/x/ibc/applications/transfer/types"
-	clienttypes "github.com/cosmos/cosmos-sdk/x/ibc/core/02-client/types"
 	channeltypes "github.com/cosmos/cosmos-sdk/x/ibc/core/04-channel/types"
 	porttypes "github.com/cosmos/cosmos-sdk/x/ibc/core/05-port/types"
 	host "github.com/cosmos/cosmos-sdk/x/ibc/core/24-host"
@@ -335,27 +334,6 @@ func (am AppModule) OnRecvPacket(
 		acknowledgement = channeltypes.NewErrorAcknowledgement(err.Error())
 	}
 
-	channel, _ := am.keeper.GetChannel(ctx, packet.GetSourcePort(), packet.GetSourceChannel())
-
-	err = ctx.EventManager().EmitTypedEvent(
-		&channeltypes.EventChannelRecvPacket{
-			Data:             packet.GetData(),
-			TimeoutHeight:    packet.GetTimeoutHeight().(clienttypes.Height),
-			TimeoutTimestamp: packet.GetTimeoutTimestamp(),
-			Sequence:         packet.GetSequence(),
-			SrcPort:          packet.GetSourcePort(),
-			SrcChannel:       packet.GetSourceChannel(),
-			DstPort:          packet.GetDestPort(),
-			DstChannel:       packet.GetDestChannel(),
-			ChannelOrdering:  channel.Ordering,
-			Success:          err != nil,
-		},
-	)
-
-	if err != nil {
-		acknowledgement = channeltypes.NewErrorAcknowledgement(err.Error())
-	}
-
 	// NOTE: acknowledgement will be written synchronously during IBC handler execution.
 	return &sdk.Result{
 		Events: ctx.EventManager().Events().ToABCIEvents(),
@@ -381,37 +359,18 @@ func (am AppModule) OnAcknowledgementPacket(
 		return nil, err
 	}
 
-	channel, _ := am.keeper.GetChannel(ctx, packet.GetSourcePort(), packet.GetSourceChannel())
-
-	if err := ctx.EventManager().EmitTypedEvent(
-		&channeltypes.EventChannelAckPacket{
-			Data:             packet.GetData(),
-			TimeoutHeight:    packet.GetTimeoutHeight().(clienttypes.Height),
-			TimeoutTimestamp: packet.GetTimeoutTimestamp(),
-			Sequence:         packet.GetSequence(),
-			SrcPort:          packet.GetSourcePort(),
-			SrcChannel:       packet.GetSourceChannel(),
-			DstPort:          packet.GetDestPort(),
-			DstChannel:       packet.GetDestChannel(),
-			ChannelOrdering:  channel.Ordering,
-			Acknowledgement:  acknowledgement,
-		},
-	); err != nil {
-		return nil, err
-	}
-
 	switch resp := ack.Response.(type) {
 	case *channeltypes.Acknowledgement_Result:
 		if err := ctx.EventManager().EmitTypedEvent(
-			&channeltypes.EventAcknowledgementSuccess{
+			&types.EventAcknowledgementSuccess{
 				Success: resp.Result,
 			},
 		); err != nil {
 			return nil, err
 		}
 	case *channeltypes.Acknowledgement_Error:
 		if err := ctx.EventManager().EmitTypedEvent(
-			&channeltypes.EventAcknowledgementError{
+			&types.EventAcknowledgementError{
 				Error: resp.Error,
 			},
 		); err != nil {
@@ -438,24 +397,6 @@ func (am AppModule) OnTimeoutPacket(
 		return nil, err
 	}
 
-	channel, _ := am.keeper.GetChannel(ctx, packet.GetSourcePort(), packet.GetSourceChannel())
-
-	if err := ctx.EventManager().EmitTypedEvent(
-		&channeltypes.EventChannelTimeoutPacket{
-			Data:             packet.GetData(),
-			TimeoutHeight:    packet.GetTimeoutHeight().(clienttypes.Height),
-			TimeoutTimestamp: packet.GetTimeoutTimestamp(),
-			Sequence:         packet.GetSequence(),
-			SrcPort:          packet.GetSourcePort(),
-			SrcChannel:       packet.GetSourceChannel(),
-			DstPort:          packet.GetDestPort(),
-			DstChannel:       packet.GetDestChannel(),
-			ChannelOrdering:  channel.Ordering,
-		},
-	); err != nil {
-		return nil, err
-	}
-
 	return &sdk.Result{
 		Events: ctx.EventManager().Events().ToABCIEvents(),
 	}, nil

x/ibc/applications/transfer/spec/05_events.md

@@ -6,39 +6,21 @@ order: 5
 
 ## MsgTransfer
 
-| Type         | Attribute Key | Attribute Value |
-|--------------|---------------|-----------------|
-| ibc_transfer | sender        | {sender}        |
-| ibc_transfer | receiver      | {receiver}      |
-| message      | action        | transfer        |
-| message      | module        | transfer        |
+| Type                                       | Attribute Key | Attribute Value |
+|--------------------------------------------|---------------|-----------------|
+| ibc-applications-transfer-v1-EventTransfer | sender        | {sender}        |
+| ibc-applications-transfer-v1-EventTransfer | receiver      | {receiver}      |
+| message                                    | action        | transfer        |
 
 ## OnRecvPacket callback
 
-| Type                  | Attribute Key | Attribute Value |
-|-----------------------|---------------|-----------------|
-| fungible_token_packet | module        | transfer        |
-| fungible_token_packet | receiver      | {receiver}      |
-| fungible_token_packet | denom         | {denom}         |
-| fungible_token_packet | amount        | {amount}        |
-| fungible_token_packet | success       | {ackSuccess}    |
-| denomination_trace    | trace_hash    | {hex_hash}      |
+| Type                                                | Attribute Key | Attribute Value |
+|-----------------------------------------------------|---------------|-----------------|
+| ibc-applications-transfer-v1-EventDenominationTrace | trace_hash    | {hex_hash}      |
 
-## OnAcknowledgePacket callback
+## OnAcknowledgePacket callback (emitted any one of the below events)
 
-| Type                  | Attribute Key   | Attribute Value   |
-|-----------------------|-----------------|-------------------|
-| fungible_token_packet | module          | transfer          |
-| fungible_token_packet | receiver        | {receiver}        |
-| fungible_token_packet | denom           | {denom}           |
-| fungible_token_packet | amount          | {amount}          |
-| fungible_token_packet | success | error | {ack.Response}    |
-
-## OnTimeoutPacket callback
-
-| Type                  | Attribute Key   | Attribute Value |
-|-----------------------|-----------------|-----------------|
-| fungible_token_packet | module          | transfer        |
-| fungible_token_packet | refund_receiver | {receiver}      |
-| fungible_token_packet | denom           | {denom}         |
-| fungible_token_packet | amount          | {amount}        |
+| Type                                                     | Attribute Key | Attribute Value   |
+|----------------------------------------------------------|---------------|-------------------|
+| ibc-applications-transfer-v1-EventAcknowledgementSuccess | success       | {ack.Response}    |
+| ibc-applications-transfer-v1-EventAcknowledgementError   | error         | {ack.Response}    |