401354976b
This change introduces 2 new optional methods; `enter()` and `exit()` for js tracers, and makes `step()` optiona. The two new methods are invoked when entering and exiting a call frame (but not invoked for the outermost scope, which has it's own methods). Currently these are the data fields passed to each of them:
enter: type (opcode), from, to, input, gas, value
exit: output, gasUsed, error
The PR also comes with a re-write of the callTracer. As a backup we keep the previous tracing script under the name `callTracerLegacy`. Behaviour of both tracers are equivalent for the most part, although there are some small differences (improvements), where the new tracer is more correct / has more information.
95 lines
2.9 KiB
Go
95 lines
2.9 KiB
Go
// Copyright 2017 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 vm
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io"
|
|
"math/big"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/math"
|
|
)
|
|
|
|
type JSONLogger struct {
|
|
encoder *json.Encoder
|
|
cfg *LogConfig
|
|
}
|
|
|
|
// NewJSONLogger creates a new EVM tracer that prints execution steps as JSON objects
|
|
// into the provided stream.
|
|
func NewJSONLogger(cfg *LogConfig, writer io.Writer) *JSONLogger {
|
|
l := &JSONLogger{json.NewEncoder(writer), cfg}
|
|
if l.cfg == nil {
|
|
l.cfg = &LogConfig{}
|
|
}
|
|
return l
|
|
}
|
|
|
|
func (l *JSONLogger) CaptureStart(env *EVM, from, to common.Address, create bool, input []byte, gas uint64, value *big.Int) {
|
|
}
|
|
|
|
func (l *JSONLogger) CaptureFault(*EVM, uint64, OpCode, uint64, uint64, *ScopeContext, int, error) {}
|
|
|
|
// CaptureState outputs state information on the logger.
|
|
func (l *JSONLogger) CaptureState(env *EVM, pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error) {
|
|
memory := scope.Memory
|
|
stack := scope.Stack
|
|
|
|
log := StructLog{
|
|
Pc: pc,
|
|
Op: op,
|
|
Gas: gas,
|
|
GasCost: cost,
|
|
MemorySize: memory.Len(),
|
|
Depth: depth,
|
|
RefundCounter: env.StateDB.GetRefund(),
|
|
Err: err,
|
|
}
|
|
if l.cfg.EnableMemory {
|
|
log.Memory = memory.Data()
|
|
}
|
|
if !l.cfg.DisableStack {
|
|
log.Stack = stack.data
|
|
}
|
|
if l.cfg.EnableReturnData {
|
|
log.ReturnData = rData
|
|
}
|
|
l.encoder.Encode(log)
|
|
}
|
|
|
|
// CaptureEnd is triggered at end of execution.
|
|
func (l *JSONLogger) CaptureEnd(output []byte, gasUsed uint64, t time.Duration, err error) {
|
|
type endLog struct {
|
|
Output string `json:"output"`
|
|
GasUsed math.HexOrDecimal64 `json:"gasUsed"`
|
|
Time time.Duration `json:"time"`
|
|
Err string `json:"error,omitempty"`
|
|
}
|
|
var errMsg string
|
|
if err != nil {
|
|
errMsg = err.Error()
|
|
}
|
|
l.encoder.Encode(endLog{common.Bytes2Hex(output), math.HexOrDecimal64(gasUsed), t, errMsg})
|
|
}
|
|
|
|
func (l *JSONLogger) CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) {
|
|
}
|
|
|
|
func (l *JSONLogger) CaptureExit(output []byte, gasUsed uint64, err error) {}
|