feat!: extend TxStatus to include more tx info (#2543)

Fixes #2542

Author: ninabarbakadze

consensus/replay_test.go

@@ -1169,7 +1169,7 @@ func newMockBlockStore(t *testing.T, config *cfg.Config, params types.ConsensusP
 	}
 }
 
-func (*mockBlockStore) SaveTxInfo(block *types.Block, txResponseCodes []uint32, logs []string) error {
+func (*mockBlockStore) SaveTxInfo(block *types.Block, execTxRes []*abci.ExecTxResult) error {
 	return nil
 }
 func (bs *mockBlockStore) LoadTxInfo(hash []byte) *cmtstore.TxInfo { return &cmtstore.TxInfo{} }

proto/tendermint/store/types.pb.go

@@ -18,4 +18,10 @@ message TxInfo {
   uint32 code = 3;
   // The error log output generated if the transaction execution fails.
   string error = 4;
+  // The error namespace/module
+  string codespace  = 5;
+  // Requested gas limit
+  int64  gas_wanted = 6;
+  // Actual gas consumed
+  int64  gas_used   = 7;
 }

proto/tendermint/store/types.proto

@@ -364,7 +364,7 @@ func (mockBlockStore) SaveBlockWithExtendedCommit(block *types.Block, blockParts
 func (mockBlockStore) SaveBlock(block *types.Block, blockParts *types.PartSet, seenCommit *types.Commit) {
 }
 
-func (mockBlockStore) SaveTxInfo(block *types.Block, txResponseCodes []uint32, logs []string) error {
+func (mockBlockStore) SaveTxInfo(block *types.Block, txResults []*abci.ExecTxResult) error {
 	return nil
 }
 

rpc/core/blocks_test.go

@@ -228,7 +228,16 @@ func (env *Environment) TxStatus(ctx *rpctypes.Context, hash []byte) (*ctypes.Re
 	// Check if the tx has been committed
 	txInfo := env.BlockStore.LoadTxInfo(hash)
 	if txInfo != nil {
-		return &ctypes.ResultTxStatus{Height: txInfo.Height, Index: txInfo.Index, ExecutionCode: txInfo.Code, Error: txInfo.Error, Status: TxStatusCommitted}, nil
+		return &ctypes.ResultTxStatus{
+			Height:        txInfo.Height,
+			Index:         txInfo.Index,
+			ExecutionCode: txInfo.Code,
+			Error:         txInfo.Error,
+			Status:        TxStatusCommitted,
+			Codespace:     txInfo.Codespace,
+			GasWanted:     txInfo.GasWanted,
+			GasUsed:       txInfo.GasUsed,
+		}, nil
 	}
 
 	// Get the tx key from the hash

rpc/core/tx.go

@@ -272,6 +272,9 @@ type ResultTxStatus struct {
 	ExecutionCode uint32 `json:"execution_code"`
 	Error         string `json:"error"`
 	Status        string `json:"status"`
+	Codespace     string `json:"codespace,omitempty"`
+	GasWanted     int64  `json:"gas_wanted,omitempty"`
+	GasUsed       int64  `json:"gas_used,omitempty"`
 }
 
 type ResultDataCommitment struct {

rpc/core/types/responses.go

@@ -356,9 +356,7 @@ func (blockExec *BlockExecutor) applyBlock(state State, blockID types.BlockID, b
 	// This needs to be done prior to saving state
 	// for correct crash recovery
 	if blockExec.blockStore != nil {
-		respCodes := getResponseCodes(abciResponse.TxResults)
-		logs := getLogs(abciResponse.TxResults)
-		if err := blockExec.blockStore.SaveTxInfo(block, respCodes, logs); err != nil {
+		if err := blockExec.blockStore.SaveTxInfo(block, abciResponse.TxResults); err != nil {
 			return state, err
 		}
 	}
@@ -930,24 +928,6 @@ func (blockExec *BlockExecutor) pruneBlocks(retainHeight int64, state State) (ui
 	return amountPruned, nil
 }
 
-// getResponseCodes gets response codes from a list of ResponseDeliverTx.
-func getResponseCodes(responses []*abci.ExecTxResult) []uint32 {
-	responseCodes := make([]uint32, len(responses))
-	for i, response := range responses {
-		responseCodes[i] = response.Code
-	}
-	return responseCodes
-}
-
-// getLogs gets logs from a list of ResponseDeliverTx.
-func getLogs(responses []*abci.ExecTxResult) []string {
-	logs := make([]string, len(responses))
-	for i, response := range responses {
-		logs[i] = response.Log
-	}
-	return logs
-}
-
 // saveFailedProposalBlock saves a failed proposal block to the debug directory
 func (blockExec *BlockExecutor) saveFailedProposalBlock(state State, block *types.Block, reason string) {
 	if blockExec.rootDir == "" {

state/execution.go

@@ -1,6 +1,7 @@
 package state
 
 import (
+	abci "github.com/cometbft/cometbft/abci/types"
 	"github.com/cometbft/cometbft/types"
 
 	cmtstore "github.com/cometbft/cometbft/proto/tendermint/store"
@@ -40,7 +41,7 @@ type BlockStore interface {
 	LoadBlockExtendedCommit(height int64) *types.ExtendedCommit
 
 	LoadTxInfo(hash []byte) *cmtstore.TxInfo
-	SaveTxInfo(block *types.Block, txResponseCodes []uint32, logs []string) error
+	SaveTxInfo(block *types.Block, execTxRes []*abci.ExecTxResult) error
 
 	DeleteLatestBlock() error
 

state/mocks/block_store.go

@@ -791,30 +791,31 @@ func (bs *BlockStore) DeleteLatestBlock() error {
 	return bs.saveStateAndWriteDB(batch, "failed to delete the latest block")
 }
 
-// SaveTxInfo indexes the txs from the block with the given response codes and logs from execution.
+// SaveTxInfo indexes the txs from the block with the given execution results.
 // Only the error logs are saved for failed transactions.
-func (bs *BlockStore) SaveTxInfo(block *types.Block, txResponseCodes []uint32, logs []string) error {
-	if len(txResponseCodes) != len(block.Txs) {
-		return errors.New("txResponseCodes length mismatch with block txs length")
-	}
-	if len(logs) != len(block.Txs) {
-		return errors.New("logs length mismatch with block txs length")
+func (bs *BlockStore) SaveTxInfo(block *types.Block, execTxRes []*abci.ExecTxResult) error {
+	if len(execTxRes) != len(block.Txs) {
+		return errors.New("tx execution results length mismatch with block txs length")
 	}
 
 	// Create a new batch
 	batch := bs.db.NewBatch()
 
 	// Batch and save txs from the block
 	for i, tx := range block.Txs {
+		result := execTxRes[i]
 		txInfo := cmtstore.TxInfo{
 			Height: block.Height,
 			//nolint:gosec
-			Index: uint32(i),
-			Code:  txResponseCodes[i],
+			Index:     uint32(i),
+			Code:      result.Code,
+			Codespace: result.Codespace,
+			GasWanted: result.GasWanted,
+			GasUsed:   result.GasUsed,
 		}
 		// Set error log for failed txs
-		if txResponseCodes[i] != abci.CodeTypeOK {
-			txInfo.Error = logs[i]
+		if result.Code != abci.CodeTypeOK {
+			txInfo.Error = result.Log
 		}
 		txInfoBytes, err := proto.Marshal(&txInfo)
 		if err != nil {