fix: Add Events to TxResponse (backport #10630) (#10644)

* fix: Add Events to TxResponse (#10630)

(cherry picked from commit c4bedf8)

# Conflicts:
#	CHANGELOG.md
#	go.sum
#	types/abci.pb.go
#	types/result.go

* Michael sucks

* Who Let the Bugs Out??

* Reinventing the wheel. Again.

* No changes made

Co-authored-by: Aleksandr Bezobchuk <[email protected]>
Co-authored-by: Aleksandr Bezobchuk <[email protected]>

CHANGELOG.md

@@ -38,6 +38,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (types) [\#10630](https://github.com/cosmos/cosmos-sdk/pull/10630) Add an `Events` field to the `TxResponse` type that captures _all_ events emitted by a transaction, unlike `Logs` which only contains events emitted during message execution.
 * [\#10327](https://github.com/cosmos/cosmos-sdk/pull/10327) Add null guard for possible nil `Amount` in tx fee `Coins`
 * [\#10339](https://github.com/cosmos/cosmos-sdk/pull/10339) Improve performance of `removeZeroCoins` by only allocating memory when necessary
 * (deps) [\#10376](https://github.com/cosmos/cosmos-sdk/pull/10376) Bump Tendermint to [v0.34.14](https://github.com/tendermint/tendermint/releases/tag/v0.34.14).

proto/cosmos/base/abci/v1beta1/abci.proto

@@ -39,6 +39,13 @@ message TxResponse {
   // the timestamps of the valid votes in the block.LastCommit. For height == 1,
   // it's genesis time.
   string timestamp = 12;
+  // Events defines all the events emitted by processing a transaction. Note,
+  // these events include those emitted by processing all the messages and those
+  // emitted from the ante handler. Whereas Logs contains the events, with
+  // additional metadata, emitted only by processing the messages.
+  //
+  // Since: cosmos-sdk 0.42.11, 0.44.5, 0.45
+  repeated tendermint.abci.Event events = 13 [(gogoproto.nullable) = false];
 }
 
 // ABCIMessageLog defines a structure containing an indexed tx ABCI message log.

types/result.go

@@ -3,14 +3,10 @@ package types
 import (
 	"encoding/hex"
 	"encoding/json"
-	"fmt"
 	"math"
 	"strings"
 
 	"github.com/gogo/protobuf/proto"
-
-	yaml "gopkg.in/yaml.v2"
-
 	abci "github.com/tendermint/tendermint/abci/types"
 	ctypes "github.com/tendermint/tendermint/rpc/core/types"
 
@@ -21,12 +17,12 @@ import (
 var cdc = codec.NewLegacyAmino()
 
 func (gi GasInfo) String() string {
-	bz, _ := yaml.Marshal(gi)
+	bz, _ := codec.MarshalYAML(codec.NewProtoCodec(nil), &gi)
 	return string(bz)
 }
 
 func (r Result) String() string {
-	bz, _ := yaml.Marshal(r)
+	bz, _ := codec.MarshalYAML(codec.NewProtoCodec(nil), &r)
 	return string(bz)
 }
 
@@ -83,6 +79,7 @@ func NewResponseResultTx(res *ctypes.ResultTx, anyTx *codectypes.Any, timestamp
 		GasUsed:   res.TxResult.GasUsed,
 		Tx:        anyTx,
 		Timestamp: timestamp,
+		Events:    res.TxResult.Events,
 	}
 }
 
@@ -123,6 +120,7 @@ func newTxResponseCheckTx(res *ctypes.ResultBroadcastTxCommit) *TxResponse {
 		Info:      res.CheckTx.Info,
 		GasWanted: res.CheckTx.GasWanted,
 		GasUsed:   res.CheckTx.GasUsed,
+		Events:    res.CheckTx.Events,
 	}
 }
 
@@ -149,6 +147,7 @@ func newTxResponseDeliverTx(res *ctypes.ResultBroadcastTxCommit) *TxResponse {
 		Info:      res.DeliverTx.Info,
 		GasWanted: res.DeliverTx.GasWanted,
 		GasUsed:   res.DeliverTx.GasUsed,
+		Events:    res.DeliverTx.Events,
 	}
 }
 
@@ -171,44 +170,8 @@ func NewResponseFormatBroadcastTx(res *ctypes.ResultBroadcastTx) *TxResponse {
 }
 
 func (r TxResponse) String() string {
-	var sb strings.Builder
-	sb.WriteString("Response:\n")
-
-	if r.Height > 0 {
-		sb.WriteString(fmt.Sprintf("  Height: %d\n", r.Height))
-	}
-	if r.TxHash != "" {
-		sb.WriteString(fmt.Sprintf("  TxHash: %s\n", r.TxHash))
-	}
-	if r.Code > 0 {
-		sb.WriteString(fmt.Sprintf("  Code: %d\n", r.Code))
-	}
-	if r.Data != "" {
-		sb.WriteString(fmt.Sprintf("  Data: %s\n", r.Data))
-	}
-	if r.RawLog != "" {
-		sb.WriteString(fmt.Sprintf("  Raw Log: %s\n", r.RawLog))
-	}
-	if r.Logs != nil {
-		sb.WriteString(fmt.Sprintf("  Logs: %s\n", r.Logs))
-	}
-	if r.Info != "" {
-		sb.WriteString(fmt.Sprintf("  Info: %s\n", r.Info))
-	}
-	if r.GasWanted != 0 {
-		sb.WriteString(fmt.Sprintf("  GasWanted: %d\n", r.GasWanted))
-	}
-	if r.GasUsed != 0 {
-		sb.WriteString(fmt.Sprintf("  GasUsed: %d\n", r.GasUsed))
-	}
-	if r.Codespace != "" {
-		sb.WriteString(fmt.Sprintf("  Codespace: %s\n", r.Codespace))
-	}
-	if r.Timestamp != "" {
-		sb.WriteString(fmt.Sprintf("  Timestamp: %s\n", r.Timestamp))
-	}
-
-	return strings.TrimSpace(sb.String())
+	bz, _ := codec.MarshalYAML(codec.NewProtoCodec(nil), &r)
+	return string(bz)
 }
 
 // Empty returns true if the response is empty