eth/tracers: remove revertReasonTracer, add revert reason to callTracer (#25508)

* eth/tracers: add revertReason to callTracer

* update callframe gen json

* add revertal to calltrace test

eth/tracers/internal/tracetest/calltrace_test.go

@@ -113,6 +113,7 @@ type callTrace struct {
 	GasUsed  *hexutil.Uint64 `json:"gasUsed,omitempty"`
 	Value    *hexutil.Big    `json:"value,omitempty"`
 	Error    string          `json:"error,omitempty"`
+	Revertal string          `json:"revertReason,omitempty"`
 	Calls    []callTrace     `json:"calls,omitempty"`
 }
 

eth/tracers/internal/tracetest/testdata/call_tracer/revert_reason.json

@@ -59,6 +59,7 @@
     "to": "0xf58833cf0c791881b494eb79d461e08a1f043f52",
     "type": "CALL",
     "value": "0x0",
-    "output": "0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001e53656c662d64656c65676174696f6e20697320646973616c6c6f7765642e0000"
+    "output": "0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001e53656c662d64656c65676174696f6e20697320646973616c6c6f7765642e0000",
+    "revertReason": "Self-delegation is disallowed."
   }
 }

eth/tracers/native/call.go

@@ -23,6 +23,7 @@ import (
 	"sync/atomic"
 	"time"
 
+	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/core/vm"
@@ -44,6 +45,7 @@ type callFrame struct {
 	Input    []byte         `json:"input" rlp:"optional"`
 	Output   []byte         `json:"output,omitempty" rlp:"optional"`
 	Error    string         `json:"error,omitempty" rlp:"optional"`
+	Revertal string         `json:"revertReason,omitempty"`
 	Calls    []callFrame    `json:"calls,omitempty" rlp:"optional"`
 	// Placed at end on purpose. The RLP will be decoded to 0 instead of
 	// nil if there are non-empty elements after in the struct.
@@ -109,13 +111,20 @@ func (t *callTracer) CaptureStart(env *vm.EVM, from common.Address, to common.Ad
 func (t *callTracer) CaptureEnd(output []byte, gasUsed uint64, _ time.Duration, err error) {
 	t.callstack[0].GasUsed = gasUsed
 	output = common.CopyBytes(output)
-	if err != nil {
+	if err == nil {
-		t.callstack[0].Error = err.Error()
-		if err.Error() == "execution reverted" && len(output) > 0 {
 		t.callstack[0].Output = output
+		return
+	}
+	t.callstack[0].Error = err.Error()
+	if !errors.Is(err, vm.ErrExecutionReverted) || len(output) == 0 {
+		return
 	}
-	} else {
 	t.callstack[0].Output = output
+	if len(output) < 4 {
+		return
+	}
+	if unpacked, err := abi.UnpackRevert(output); err == nil {
+		t.callstack[0].Revertal = unpacked
 	}
 }
 

eth/tracers/native/gen_callframe_json.go

@@ -18,12 +18,13 @@ func (c callFrame) MarshalJSON() ([]byte, error) {
 	type callFrame0 struct {
 		Type       vm.OpCode      `json:"-"`
 		From       common.Address `json:"from"`
-		To         common.Address `json:"to,omitempty" rlp:"optional"`
 		Gas        hexutil.Uint64 `json:"gas"`
 		GasUsed    hexutil.Uint64 `json:"gasUsed"`
+		To         common.Address `json:"to,omitempty" rlp:"optional"`
 		Input      hexutil.Bytes  `json:"input" rlp:"optional"`
 		Output     hexutil.Bytes  `json:"output,omitempty" rlp:"optional"`
 		Error      string         `json:"error,omitempty" rlp:"optional"`
+		Revertal   string         `json:"revertReason,omitempty"`
 		Calls      []callFrame    `json:"calls,omitempty" rlp:"optional"`
 		Value      *hexutil.Big   `json:"value,omitempty" rlp:"optional"`
 		TypeString string         `json:"type"`
@@ -31,12 +32,13 @@ func (c callFrame) MarshalJSON() ([]byte, error) {
 	var enc callFrame0
 	enc.Type = c.Type
 	enc.From = c.From
-	enc.To = c.To
 	enc.Gas = hexutil.Uint64(c.Gas)
 	enc.GasUsed = hexutil.Uint64(c.GasUsed)
+	enc.To = c.To
 	enc.Input = c.Input
 	enc.Output = c.Output
 	enc.Error = c.Error
+	enc.Revertal = c.Revertal
 	enc.Calls = c.Calls
 	enc.Value = (*hexutil.Big)(c.Value)
 	enc.TypeString = c.TypeString()
@@ -48,12 +50,13 @@ func (c *callFrame) UnmarshalJSON(input []byte) error {
 	type callFrame0 struct {
 		Type     *vm.OpCode      `json:"-"`
 		From     *common.Address `json:"from"`
-		To      *common.Address `json:"to,omitempty" rlp:"optional"`
 		Gas      *hexutil.Uint64 `json:"gas"`
 		GasUsed  *hexutil.Uint64 `json:"gasUsed"`
+		To       *common.Address `json:"to,omitempty" rlp:"optional"`
 		Input    *hexutil.Bytes  `json:"input" rlp:"optional"`
 		Output   *hexutil.Bytes  `json:"output,omitempty" rlp:"optional"`
 		Error    *string         `json:"error,omitempty" rlp:"optional"`
+		Revertal *string         `json:"revertReason,omitempty"`
 		Calls    []callFrame     `json:"calls,omitempty" rlp:"optional"`
 		Value    *hexutil.Big    `json:"value,omitempty" rlp:"optional"`
 	}
@@ -67,15 +70,15 @@ func (c *callFrame) UnmarshalJSON(input []byte) error {
 	if dec.From != nil {
 		c.From = *dec.From
 	}
-	if dec.To != nil {
-		c.To = *dec.To
-	}
 	if dec.Gas != nil {
 		c.Gas = uint64(*dec.Gas)
 	}
 	if dec.GasUsed != nil {
 		c.GasUsed = uint64(*dec.GasUsed)
 	}
+	if dec.To != nil {
+		c.To = *dec.To
+	}
 	if dec.Input != nil {
 		c.Input = *dec.Input
 	}
@@ -85,6 +88,9 @@ func (c *callFrame) UnmarshalJSON(input []byte) error {
 	if dec.Error != nil {
 		c.Error = *dec.Error
 	}
+	if dec.Revertal != nil {
+		c.Revertal = *dec.Revertal
+	}
 	if dec.Calls != nil {
 		c.Calls = dec.Calls
 	}

eth/tracers/native/revertreason.go

@@ -1,108 +0,0 @@
-// Copyright 2022 The go-ethereum Authors
-// This file is part of the go-ethereum library.
-//
-// The go-ethereum library is free software: you can redistribute it and/or modify
-// it under the terms of the GNU Lesser General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// The go-ethereum library is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU Lesser General Public License for more details.
-//
-// You should have received a copy of the GNU Lesser General Public License
-// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
-
-package native
-
-import (
-	"bytes"
-	"encoding/json"
-	"math/big"
-	"sync/atomic"
-	"time"
-
-	"github.com/ethereum/go-ethereum/accounts/abi"
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/core/vm"
-	"github.com/ethereum/go-ethereum/crypto"
-	"github.com/ethereum/go-ethereum/eth/tracers"
-)
-
-func init() {
-	register("revertReasonTracer", newRevertReasonTracer)
-}
-
-var revertSelector = crypto.Keccak256([]byte("Error(string)"))[:4]
-
-// revertReasonTracer is a go implementation of the Tracer interface which
-// track the error message or revert reason return by the contract.
-type revertReasonTracer struct {
-	env          *vm.EVM
-	revertReason string // The revert reason return from the tx, if tx success, empty string return
-	interrupt    uint32 // Atomic flag to signal execution interruption
-	reason       error  // Textual reason for the interruption
-}
-
-// newRevertReasonTracer returns a new revert reason tracer.
-func newRevertReasonTracer(_ *tracers.Context, _ json.RawMessage) (tracers.Tracer, error) {
-	return &revertReasonTracer{}, nil
-}
-
-// CaptureStart implements the EVMLogger interface to initialize the tracing operation.
-func (t *revertReasonTracer) CaptureStart(env *vm.EVM, _ common.Address, _ common.Address, _ bool, _ []byte, _ uint64, _ *big.Int) {
-	t.env = env
-}
-
-// CaptureEnd is called after the call finishes to finalize the tracing.
-func (t *revertReasonTracer) CaptureEnd(output []byte, _ uint64, _ time.Duration, err error) {
-	if err != nil {
-		if err == vm.ErrExecutionReverted && len(output) > 4 && bytes.Equal(output[:4], revertSelector) {
-			errMsg, _ := abi.UnpackRevert(output)
-			t.revertReason = err.Error() + ": " + errMsg
-		} else {
-			t.revertReason = err.Error()
-		}
-	}
-}
-
-// CaptureState implements the EVMLogger interface to trace a single step of VM execution.
-func (t *revertReasonTracer) CaptureState(_ uint64, _ vm.OpCode, _, _ uint64, _ *vm.ScopeContext, _ []byte, _ int, _ error) {
-}
-
-// CaptureFault implements the EVMLogger interface to trace an execution fault.
-func (t *revertReasonTracer) CaptureFault(_ uint64, _ vm.OpCode, _, _ uint64, _ *vm.ScopeContext, _ int, _ error) {
-}
-
-// CaptureEnter is called when EVM enters a new scope (via call, create or selfdestruct).
-func (t *revertReasonTracer) CaptureEnter(_ vm.OpCode, _ common.Address, _ common.Address, _ []byte, _ uint64, _ *big.Int) {
-	// Skip if tracing was interrupted
-	if atomic.LoadUint32(&t.interrupt) > 0 {
-		t.env.Cancel()
-		return
-	}
-}
-
-// CaptureExit is called when EVM exits a scope, even if the scope didn't
-// execute any code.
-func (t *revertReasonTracer) CaptureExit(_ []byte, _ uint64, _ error) {}
-
-func (t *revertReasonTracer) CaptureTxStart(_ uint64) {}
-
-func (t *revertReasonTracer) CaptureTxEnd(_ uint64) {}
-
-// GetResult returns an error message json object.
-func (t *revertReasonTracer) GetResult() (json.RawMessage, error) {
-	res, err := json.Marshal(t.revertReason)
-	if err != nil {
-		return nil, err
-	}
-	return res, t.reason
-}
-
-// Stop terminates execution of the tracer at the first opportune moment.
-func (t *revertReasonTracer) Stop(err error) {
-	t.reason = err
-	atomic.StoreUint32(&t.interrupt, 1)
-}