feat(rpc): update tx status to return logs (#1459)

## Description

Part of #1454

Author: ninabarbakadze

proto/tendermint/store/types.pb.go

@@ -9,14 +9,13 @@ message BlockStoreState {
 }
 
 // TxInfo describes the location of a tx inside a committed block
-// as well as the result of executing the transaction and the raw log output.
+// as well as the result of executing the transaction and the error log output.
 message TxInfo {
   int64 height    = 1;
   uint32 index    = 2;
   // The response code of executing the tx. 0 means
   // successfully executed, all others are error codes.
   uint32 code     = 3;
-  // The log output generated during the execution of a transaction.
-  // Note: this is empty if the transaction succeeded.
-  string log      = 4;
+  // The error log output generated if the transaction execution fails.
+  string error     = 4;
 }

proto/tendermint/store/types.proto

@@ -584,6 +584,8 @@ func TestTxStatus(t *testing.T) {
 	require.EqualValues(bres.Height, result.Height)
 	require.EqualValues(0, result.Index)
 	require.Equal("COMMITTED", result.Status)
+	require.Equal(abci.CodeTypeOK, result.ExecutionCode)
+	require.Equal("", result.Error)
 }
 
 func TestTxSearch(t *testing.T) {

rpc/client/rpc_test.go

@@ -220,16 +220,16 @@ func ProveShares(
 	return shareProof, nil
 }
 
-// TxStatus retrieves the status of a transaction given its hash. It returns a ResultTxStatus
-// containing the height and index of the transaction within the block(if committed)
-// or whether the transaction is pending, evicted from the mempool, or otherwise unknown.
+// TxStatus retrieves the status of a transaction by its hash. It returns a ResultTxStatus
+// with the transaction's height and index if committed, or its pending, evicted, or unknown status.
+// It also includes the execution code and log for failed txs.
 func TxStatus(ctx *rpctypes.Context, hash []byte) (*ctypes.ResultTxStatus, error) {
 	env := GetEnvironment()
 
 	// 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, Status: TxStatusCommitted}, nil
+		return &ctypes.ResultTxStatus{Height: txInfo.Height, Index: txInfo.Index, ExecutionCode: txInfo.Code, Error: txInfo.Error, Status: TxStatusCommitted}, nil
 	}
 
 	// Get the tx key from the hash

rpc/core/tx.go

@@ -126,6 +126,7 @@ func TestTxStatus(t *testing.T) {
 					assert.Equal(t, height, txStatus.Height)
 					assert.Equal(t, uint32(i), txStatus.Index)
 					assert.Equal(t, uint32(0), txStatus.ExecutionCode)
+					assert.Equal(t, "", txStatus.Error)
 				}
 			}
 

rpc/core/tx_status_test.go

@@ -61,11 +61,12 @@ type ResultCommit struct {
 }
 
 // ResultTxStatus represents the status of a transaction during its life cycle.
-// It contains info to locate a tx in a committed block as well as its execution code and status.
+// It contains info to locate a tx in a committed block as well as its execution code, log if it fails and status.
 type ResultTxStatus struct {
 	Height        int64  `json:"height"`
 	Index         uint32 `json:"index"`
 	ExecutionCode uint32 `json:"execution_code"`
+	Error         string `json:"error"`
 	Status        string `json:"status"`
 }
 

rpc/core/types/responses.go

@@ -452,7 +452,7 @@ func (bs *BlockStore) SaveSeenCommit(height int64, seenCommit *types.Commit) err
 }
 
 // SaveTxInfo indexes the txs from the block with the given response codes and logs from execution.
-// The logs are only saved for failed transactions.
+// 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 fmt.Errorf("txResponseCodes length mismatch with block txs length")
@@ -471,9 +471,9 @@ func (bs *BlockStore) SaveTxInfo(block *types.Block, txResponseCodes []uint32, l
 			Index:  uint32(i),
 			Code:   txResponseCodes[i],
 		}
-		// Only save Logs for failed transactions
+		// Set error log for failed txs
 		if txResponseCodes[i] != abci.CodeTypeOK {
-			txInfo.Log = logs[i]
+			txInfo.Error = logs[i]
 		}
 		txInfoBytes, err := proto.Marshal(&txInfo)
 		if err != nil {

store/store.go

@@ -15,6 +15,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	abci "github.com/tendermint/tendermint/abci/types"
 	cfg "github.com/tendermint/tendermint/config"
 	"github.com/tendermint/tendermint/crypto"
 	"github.com/tendermint/tendermint/libs/log"
@@ -418,10 +419,10 @@ func TestSaveTxInfo(t *testing.T) {
 			require.Equal(t, uint32(i), txInfo.Index)
 			require.Equal(t, txResponseCodes[i], txInfo.Code)
 			// We don't save the logs for successful transactions
-			if txResponseCodes[i] == 0 {
-				require.Equal(t, "", txInfo.Log)
+			if txResponseCodes[i] == abci.CodeTypeOK {
+				require.Equal(t, "", txInfo.Error)
 			} else {
-				require.Equal(t, logs[i], txInfo.Log)
+				require.Equal(t, logs[i], txInfo.Error)
 			}
 		}
 	}
@@ -435,7 +436,7 @@ func TestSaveTxInfo(t *testing.T) {
 	require.Equal(t, txInfo.Height, int64(777))
 	require.Equal(t, uint32(1), txInfo.Code)
 	require.Equal(t, uint32(5), txInfo.Index)
-	require.Equal(t, "failure", txInfo.Log)
+	require.Equal(t, "failure", txInfo.Error)
 }
 
 func TestLoadBaseMeta(t *testing.T) {