Move emissions to functions (cosmos#783) (cosmos#855)

* WIP move emissions

* refactor events emission

* update typo and code clean up following review

* Update modules/core/03-connection/keeper/events.go

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* Update modules/core/03-connection/keeper/events.go

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* refactore based on code review

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
(cherry picked from commit 81b619d)

Co-authored-by: nir1218 <nir1218@users.noreply.github.com>

modules/core/02-client/keeper/client.go

@@ -51,6 +51,8 @@ func (k Keeper) CreateClient(
  )
  }()
 
+ EmitCreateClientEvent(ctx, clientID, clientState)
+
  return clientID, nil
 }
 
@@ -67,8 +69,6 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
  return sdkerrors.Wrapf(types.ErrClientNotActive, "cannot update client (%s) with status %s", clientID, status)
  }
 
- eventType := types.EventTypeUpdateClient
-
  // Any writes made in CheckHeaderAndUpdateState are persisted on both valid updates and misbehaviour updates.
  // Light client implementations are responsible for writing the correct metadata (if any) in either case.
  newClientState, newConsensusState, err := clientState.CheckHeaderAndUpdateState(ctx, k.cdc, clientStore, header)
@@ -118,9 +118,10 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
  },
  )
  }()
+
+ // emitting events in the keeper emits for both begin block and handler client updates
+ EmitUpdateClientEvent(ctx, clientID, newClientState, consensusHeight, headerStr)
  } else {
- // set eventType to SubmitMisbehaviour
- eventType = types.EventTypeSubmitMisbehaviour
 
  k.Logger(ctx).Info("client frozen due to misbehaviour", "client-id", clientID)
 
@@ -135,18 +136,10 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
  },
  )
  }()
+
+ EmitSubmitMisbehaviourEventOnUpdate(ctx, clientID, newClientState, consensusHeight, headerStr)
  }
 
- // emitting events in the keeper emits for both begin block and handler client updates
- ctx.EventManager().EmitEvent(
- sdk.NewEvent(
- eventType,
- sdk.NewAttribute(types.AttributeKeyClientID, clientID),
- sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
- sdk.NewAttribute(types.AttributeKeyConsensusHeight, consensusHeight.String()),
- sdk.NewAttribute(types.AttributeKeyHeader, headerStr),
- ),
- )
  return nil
 }
 
@@ -188,14 +181,7 @@ func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient e
  }()
 
  // emitting events in the keeper emits for client upgrades
- ctx.EventManager().EmitEvent(
- sdk.NewEvent(
- types.EventTypeUpgradeClient,
- sdk.NewAttribute(types.AttributeKeyClientID, clientID),
- sdk.NewAttribute(types.AttributeKeyClientType, updatedClientState.ClientType()),
- sdk.NewAttribute(types.AttributeKeyConsensusHeight, updatedClientState.GetLatestHeight().String()),
- ),
- )
+ EmitUpgradeClientEvent(ctx, clientID, updatedClientState)
 
  return nil
 }
@@ -237,5 +223,7 @@ func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour ex
  )
  }()
 
+ EmitSubmitMisbehaviourEvent(ctx, misbehaviour.GetClientID(), clientState)
+
  return nil
 }

modules/core/02-client/keeper/events.go

@@ -0,0 +1,93 @@
+package keeper
+
+import (
+ sdk "github.com/cosmos/cosmos-sdk/types"
+
+ "github.com/cosmos/ibc-go/v3/modules/core/02-client/types"
+ "github.com/cosmos/ibc-go/v3/modules/core/exported"
+)
+
+// EmitCreateClientEvent emits a create client event
+func EmitCreateClientEvent(ctx sdk.Context, clientID string, clientState exported.ClientState) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeCreateClient,
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
+ sdk.NewAttribute(types.AttributeKeyConsensusHeight, clientState.GetLatestHeight().String()),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}
+
+// EmitUpdateClientEvent emits an update client event
+func EmitUpdateClientEvent(ctx sdk.Context, clientID string, clientState exported.ClientState, consensusHeight exported.Height, headerStr string) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeUpdateClient,
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
+ sdk.NewAttribute(types.AttributeKeyConsensusHeight, consensusHeight.String()),
+ sdk.NewAttribute(types.AttributeKeyHeader, headerStr),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}
+
+// EmitUpdateClientEvent emits an upgrade client event
+func EmitUpgradeClientEvent(ctx sdk.Context, clientID string, clientState exported.ClientState) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeUpgradeClient,
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
+ sdk.NewAttribute(types.AttributeKeyConsensusHeight, clientState.GetLatestHeight().String()),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}
+
+// EmitUpdateClientProposalEvent emits an update client proposal event
+func EmitUpdateClientProposalEvent(ctx sdk.Context, clientID string, clientState exported.ClientState) {
+ ctx.EventManager().EmitEvent(
+ sdk.NewEvent(
+ types.EventTypeUpdateClientProposal,
+ sdk.NewAttribute(types.AttributeKeySubjectClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
+ sdk.NewAttribute(types.AttributeKeyConsensusHeight, clientState.GetLatestHeight().String()),
+ ),
+ )
+}
+
+// EmitSubmitMisbehaviourEvent emits a client misbehaviour event
+func EmitSubmitMisbehaviourEvent(ctx sdk.Context, clientID string, clientState exported.ClientState) {
+ ctx.EventManager().EmitEvent(
+ sdk.NewEvent(
+ types.EventTypeSubmitMisbehaviour,
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
+ ),
+ )
+}
+
+// EmitSubmitMisbehaviourEventOnUpdate emits a client misbehaviour event on a client update event
+func EmitSubmitMisbehaviourEventOnUpdate(ctx sdk.Context, clientID string, clientState exported.ClientState, consensusHeight exported.Height, headerStr string) {
+ ctx.EventManager().EmitEvent(
+ sdk.NewEvent(
+ types.EventTypeSubmitMisbehaviour,
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
+ sdk.NewAttribute(types.AttributeKeyConsensusHeight, consensusHeight.String()),
+ sdk.NewAttribute(types.AttributeKeyHeader, headerStr),
+ ),
+ )
+}

modules/core/02-client/keeper/proposal.go

@@ -70,14 +70,7 @@ func (k Keeper) ClientUpdateProposal(ctx sdk.Context, p *types.ClientUpdatePropo
  }()
 
  // emitting events in the keeper for proposal updates to clients
- ctx.EventManager().EmitEvent(
- sdk.NewEvent(
- types.EventTypeUpdateClientProposal,
- sdk.NewAttribute(types.AttributeKeySubjectClientID, p.SubjectClientId),
- sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
- sdk.NewAttribute(types.AttributeKeyConsensusHeight, clientState.GetLatestHeight().String()),
- ),
- )
+ EmitUpdateClientProposalEvent(ctx, p.SubjectClientId, clientState)
 
  return nil
 }

modules/core/03-connection/keeper/events.go

@@ -0,0 +1,75 @@
+package keeper
+
+import (
+ sdk "github.com/cosmos/cosmos-sdk/types"
+
+ "github.com/cosmos/ibc-go/v3/modules/core/03-connection/types"
+)
+
+// EmitConnectionOpenInitEvent emits a connection open init event
+func EmitConnectionOpenInitEvent(ctx sdk.Context, connectionID string, clientID string, counterparty types.Counterparty) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeConnectionOpenInit,
+ sdk.NewAttribute(types.AttributeKeyConnectionID, connectionID),
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyClientID, counterparty.ClientId),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyConnectionID, counterparty.ConnectionId),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}
+
+// EmitConnectionOpenTryEvent emits a connection open try event
+func EmitConnectionOpenTryEvent(ctx sdk.Context, connectionID string, clientID string, counterparty types.Counterparty) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeConnectionOpenTry,
+ sdk.NewAttribute(types.AttributeKeyConnectionID, connectionID),
+ sdk.NewAttribute(types.AttributeKeyClientID, clientID),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyClientID, counterparty.ClientId),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyConnectionID, counterparty.ConnectionId),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}
+
+// EmitConnectionOpenAckEvent emits a connection open acknowledge event
+func EmitConnectionOpenAckEvent(ctx sdk.Context, connectionID string, connectionEnd types.ConnectionEnd) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeConnectionOpenAck,
+ sdk.NewAttribute(types.AttributeKeyConnectionID, connectionID),
+ sdk.NewAttribute(types.AttributeKeyClientID, connectionEnd.ClientId),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyClientID, connectionEnd.Counterparty.ClientId),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyConnectionID, connectionEnd.Counterparty.ConnectionId),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}
+
+// EmitConnectionOpenConfirmEvent emits a connection open confirm event
+func EmitConnectionOpenConfirmEvent(ctx sdk.Context, connectionID string, connectionEnd types.ConnectionEnd) {
+ ctx.EventManager().EmitEvents(sdk.Events{
+ sdk.NewEvent(
+ types.EventTypeConnectionOpenConfirm,
+ sdk.NewAttribute(types.AttributeKeyConnectionID, connectionID),
+ sdk.NewAttribute(types.AttributeKeyClientID, connectionEnd.ClientId),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyClientID, connectionEnd.Counterparty.ClientId),
+ sdk.NewAttribute(types.AttributeKeyCounterpartyConnectionID, connectionEnd.Counterparty.ConnectionId),
+ ),
+ sdk.NewEvent(
+ sdk.EventTypeMessage,
+ sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
+ ),
+ })
+}

modules/core/03-connection/keeper/handshake.go

@@ -50,6 +50,8 @@ func (k Keeper) ConnOpenInit(
  telemetry.IncrCounter(1, "ibc", "connection", "open-init")
  }()
 
+ EmitConnectionOpenInitEvent(ctx, connectionID, clientID, counterparty)
+
  return connectionID, nil
 }
 
@@ -185,6 +187,8 @@ func (k Keeper) ConnOpenTry(
  telemetry.IncrCounter(1, "ibc", "connection", "open-try")
  }()
 
+ EmitConnectionOpenTryEvent(ctx, connectionID, clientID, counterparty)
+
  return connectionID, nil
 }
 
@@ -290,6 +294,9 @@ func (k Keeper) ConnOpenAck(
  connection.Versions = []*types.Version{version}
  connection.Counterparty.ConnectionId = counterpartyConnectionID
  k.SetConnection(ctx, connectionID, connection)
+
+ EmitConnectionOpenAckEvent(ctx, connectionID, connection)
+
  return nil
 }
 
@@ -338,5 +345,7 @@ func (k Keeper) ConnOpenConfirm(
  telemetry.IncrCounter(1, "ibc", "connection", "open-confirm")
  }()
 
+ EmitConnectionOpenConfirmEvent(ctx, connectionID, connection)
+
  return nil
 }