Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
eth/tracers: support for golang tracers + add golang callTracer (#23708)
* eth/tracers: add basic native loader * eth/tracers: add GetResult to tracer interface * eth/tracers: add native call tracer * eth/tracers: fix call tracer json result * eth/tracers: minor fix * eth/tracers: fix * eth/tracers: fix benchTracer * eth/tracers: test native call tracer * eth/tracers: fix * eth/tracers: rm extra make Co-authored-by: Martin Holst Swende <martin@swende.se> * eth/tracers: rm extra make * eth/tracers: make callFrame private * eth/tracers: clean-up and comments * eth/tracers: add license * eth/tracers: rework the model a bit * eth/tracers: move tracecall tests to subpackage * cmd/geth: load native tracers * eth/tracers: minor fix * eth/tracers: impl stop * eth/tracers: add native noop tracer * renamings Co-authored-by: Martin Holst Swende <martin@swende.se> * eth/tracers: more renamings * eth/tracers: make jstracer non-exported, avoid cast * eth/tracers, core/vm: rename vm.Tracer to vm.EVMLogger for clarity * eth/tracers: minor comment fix * eth/tracers/testing: lint nitpicks * core,eth: cancel evm on nativecalltracer stop * Revert "core,eth: cancel evm on nativecalltracer stop" This reverts commit 01bb908. * eth/tracers: linter nits * eth/tracers: fix output on err Co-authored-by: Martin Holst Swende <martin@swende.se>
- Loading branch information
Showing
15 changed files
with
560 additions
and
250 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| // Copyright 2021 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 ( | ||
| "encoding/json" | ||
| "errors" | ||
| "math/big" | ||
| "strconv" | ||
| "strings" | ||
| "sync/atomic" | ||
| "time" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/core/vm" | ||
| "github.com/ethereum/go-ethereum/eth/tracers" | ||
| ) | ||
|
|
||
| func init() { | ||
| tracers.RegisterNativeTracer("callTracerNative", NewCallTracer) | ||
| } | ||
|
|
||
| type callFrame struct { | ||
| Type string `json:"type"` | ||
| From string `json:"from"` | ||
| To string `json:"to,omitempty"` | ||
| Value string `json:"value,omitempty"` | ||
| Gas string `json:"gas"` | ||
| GasUsed string `json:"gasUsed"` | ||
| Input string `json:"input"` | ||
| Output string `json:"output,omitempty"` | ||
| Error string `json:"error,omitempty"` | ||
| Calls []callFrame `json:"calls,omitempty"` | ||
| } | ||
|
|
||
| type callTracer struct { | ||
| callstack []callFrame | ||
| interrupt uint32 // Atomic flag to signal execution interruption | ||
| reason error // Textual reason for the interruption | ||
| } | ||
|
|
||
| // NewCallTracer returns a native go tracer which tracks | ||
| // call frames of a tx, and implements vm.EVMLogger. | ||
| func NewCallTracer() tracers.Tracer { | ||
| // First callframe contains tx context info | ||
| // and is populated on start and end. | ||
| t := &callTracer{callstack: make([]callFrame, 1)} | ||
| return t | ||
| } | ||
|
|
||
| func (t *callTracer) CaptureStart(env *vm.EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int) { | ||
| t.callstack[0] = callFrame{ | ||
| Type: "CALL", | ||
| From: addrToHex(from), | ||
| To: addrToHex(to), | ||
| Input: bytesToHex(input), | ||
| Gas: uintToHex(gas), | ||
| Value: bigToHex(value), | ||
| } | ||
| if create { | ||
| t.callstack[0].Type = "CREATE" | ||
| } | ||
| } | ||
|
|
||
| func (t *callTracer) CaptureEnd(output []byte, gasUsed uint64, _ time.Duration, err error) { | ||
| t.callstack[0].GasUsed = uintToHex(gasUsed) | ||
| if err != nil { | ||
| t.callstack[0].Error = err.Error() | ||
| if err.Error() == "execution reverted" && len(output) > 0 { | ||
| t.callstack[0].Output = bytesToHex(output) | ||
| } | ||
| } else { | ||
| t.callstack[0].Output = bytesToHex(output) | ||
| } | ||
| } | ||
|
|
||
| func (t *callTracer) CaptureState(env *vm.EVM, pc uint64, op vm.OpCode, gas, cost uint64, scope *vm.ScopeContext, rData []byte, depth int, err error) { | ||
| } | ||
|
|
||
| func (t *callTracer) CaptureFault(env *vm.EVM, pc uint64, op vm.OpCode, gas, cost uint64, _ *vm.ScopeContext, depth int, err error) { | ||
| } | ||
|
|
||
| func (t *callTracer) CaptureEnter(typ vm.OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) { | ||
| // Skip if tracing was interrupted | ||
| if atomic.LoadUint32(&t.interrupt) > 0 { | ||
| // TODO: env.Cancel() | ||
| return | ||
| } | ||
|
|
||
| call := callFrame{ | ||
| Type: typ.String(), | ||
| From: addrToHex(from), | ||
| To: addrToHex(to), | ||
| Input: bytesToHex(input), | ||
| Gas: uintToHex(gas), | ||
| Value: bigToHex(value), | ||
| } | ||
| t.callstack = append(t.callstack, call) | ||
| } | ||
|
|
||
| func (t *callTracer) CaptureExit(output []byte, gasUsed uint64, err error) { | ||
| size := len(t.callstack) | ||
| if size <= 1 { | ||
| return | ||
| } | ||
| // pop call | ||
| call := t.callstack[size-1] | ||
| t.callstack = t.callstack[:size-1] | ||
| size -= 1 | ||
|
|
||
| call.GasUsed = uintToHex(gasUsed) | ||
| if err == nil { | ||
| call.Output = bytesToHex(output) | ||
| } else { | ||
| call.Error = err.Error() | ||
| if call.Type == "CREATE" || call.Type == "CREATE2" { | ||
| call.To = "" | ||
| } | ||
| } | ||
| t.callstack[size-1].Calls = append(t.callstack[size-1].Calls, call) | ||
| } | ||
|
|
||
| func (t *callTracer) GetResult() (json.RawMessage, error) { | ||
| if len(t.callstack) != 1 { | ||
| return nil, errors.New("incorrect number of top-level calls") | ||
| } | ||
| res, err := json.Marshal(t.callstack[0]) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return json.RawMessage(res), t.reason | ||
| } | ||
|
|
||
| func (t *callTracer) Stop(err error) { | ||
| t.reason = err | ||
| atomic.StoreUint32(&t.interrupt, 1) | ||
| } | ||
|
|
||
| func bytesToHex(s []byte) string { | ||
| return "0x" + common.Bytes2Hex(s) | ||
| } | ||
|
|
||
| func bigToHex(n *big.Int) string { | ||
| if n == nil { | ||
| return "" | ||
| } | ||
| return "0x" + n.Text(16) | ||
| } | ||
|
|
||
| func uintToHex(n uint64) string { | ||
| return "0x" + strconv.FormatUint(n, 16) | ||
| } | ||
|
|
||
| func addrToHex(a common.Address) string { | ||
| return strings.ToLower(a.Hex()) | ||
| } |
Oops, something went wrong.