From b7a7231c7ef50d2e82446b395b5c743827a59dc7 Mon Sep 17 00:00:00 2001
From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com>
Date: Tue, 5 Jul 2022 10:53:54 +0200
Subject: [PATCH] feat: emitting an event when handling a client upgrade
 proposal (backport #1570) (#1591)

* feat: emitting an event when handling a client upgrade proposal (#1570)

* feat: emitting an event when handling a client upgrade proposal

* refactor: only emit event if err is nil

* refactor: idiotmatic go:

(cherry picked from commit 8422d0c4c35ef970539466c5bdec1cd27369bab3)

# Conflicts:
#	CHANGELOG.md
#	modules/core/02-client/keeper/events.go

* Update CHANGELOG.md

* fix: imports/changelog

* fix: changelog

* remove unused functions

Co-authored-by: Sean King <seantking@users.noreply.github.com>
Co-authored-by: Sean King <sean@seking.dev>
Co-authored-by: crodriguezvega <carlos@interchain.io>
---
 CHANGELOG.md                              | 16 ++++++++++++++++
 modules/core/02-client/keeper/events.go   | 20 ++++++++++++++++++++
 modules/core/02-client/keeper/proposal.go |  9 ++++++++-
 modules/core/02-client/types/events.go    | 23 +++++++++++++----------
 4 files changed, 57 insertions(+), 11 deletions(-)
 create mode 100644 modules/core/02-client/keeper/events.go

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a4e0b226a7a..a04393804ef 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -34,6 +34,22 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 # Changelog
 
+## [Unreleased]
+
+### Dependencies
+
+### API Breaking
+
+### State Machine Breaking
+
+### Improvements
+
+* (core/02-client) [\#1570](https://github.com/cosmos/ibc-go/pull/1570) Emitting an event when handling an upgrade client proposal.
+
+### Features
+
+### Bug Fixes
+
 ## [v2.2.1](https://github.com/cosmos/ibc-go/releases/tag/v2.2.1) - 2022-04-16
 
 ### Improvements
diff --git a/modules/core/02-client/keeper/events.go b/modules/core/02-client/keeper/events.go
new file mode 100644
index 00000000000..604468f6307
--- /dev/null
+++ b/modules/core/02-client/keeper/events.go
@@ -0,0 +1,20 @@
+package keeper
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/cosmos/ibc-go/v2/modules/core/02-client/types"
+)
+
+// EmitUpgradeClientProposalEvent emits an upgrade client proposal event
+func EmitUpgradeClientProposalEvent(ctx sdk.Context, title string, height int64) {
+	ctx.EventManager().EmitEvent(
+		sdk.NewEvent(
+			types.EventTypeUpgradeClientProposal,
+			sdk.NewAttribute(types.AttributeKeyUpgradePlanTitle, title),
+			sdk.NewAttribute(types.AttributeKeyUpgradePlanHeight, fmt.Sprintf("%d", height)),
+		),
+	)
+}
diff --git a/modules/core/02-client/keeper/proposal.go b/modules/core/02-client/keeper/proposal.go
index 65c357fcfc2..00e2e581b00 100644
--- a/modules/core/02-client/keeper/proposal.go
+++ b/modules/core/02-client/keeper/proposal.go
@@ -105,5 +105,12 @@ func (k Keeper) HandleUpgradeProposal(ctx sdk.Context, p *types.UpgradeProposal)
 
 	// sets the new upgraded client in last height committed on this chain is at plan.Height,
 	// since the chain will panic at plan.Height and new chain will resume at plan.Height
-	return k.upgradeKeeper.SetUpgradedClient(ctx, p.Plan.Height, bz)
+	if err = k.upgradeKeeper.SetUpgradedClient(ctx, p.Plan.Height, bz); err != nil {
+		return err
+	}
+
+	// emitting an event for handling client upgrade proposal
+	EmitUpgradeClientProposalEvent(ctx, p.Title, p.Plan.Height)
+
+	return nil
 }
diff --git a/modules/core/02-client/types/events.go b/modules/core/02-client/types/events.go
index b0df80e4f34..b1b2120c502 100644
--- a/modules/core/02-client/types/events.go
+++ b/modules/core/02-client/types/events.go
@@ -8,20 +8,23 @@ import (
 
 // IBC client events
 const (
-	AttributeKeyClientID        = "client_id"
-	AttributeKeySubjectClientID = "subject_client_id"
-	AttributeKeyClientType      = "client_type"
-	AttributeKeyConsensusHeight = "consensus_height"
-	AttributeKeyHeader          = "header"
+	AttributeKeyClientID          = "client_id"
+	AttributeKeySubjectClientID   = "subject_client_id"
+	AttributeKeyClientType        = "client_type"
+	AttributeKeyConsensusHeight   = "consensus_height"
+	AttributeKeyHeader            = "header"
+	AttributeKeyUpgradePlanTitle  = "title"
+	AttributeKeyUpgradePlanHeight = "height"
 )
 
 // IBC client events vars
 var (
-	EventTypeCreateClient         = "create_client"
-	EventTypeUpdateClient         = "update_client"
-	EventTypeUpgradeClient        = "upgrade_client"
-	EventTypeSubmitMisbehaviour   = "client_misbehaviour"
-	EventTypeUpdateClientProposal = "update_client_proposal"
+	EventTypeCreateClient          = "create_client"
+	EventTypeUpdateClient          = "update_client"
+	EventTypeUpgradeClient         = "upgrade_client"
+	EventTypeSubmitMisbehaviour    = "client_misbehaviour"
+	EventTypeUpdateClientProposal  = "update_client_proposal"
+	EventTypeUpgradeClientProposal = "upgrade_client_proposal"
 
 	AttributeValueCategory = fmt.Sprintf("%s_%s", host.ModuleName, SubModuleName)
 )