978ca5fc5e
Breaking changes:
- The ChainConfig was exposed to tracers via VMContext passed in
`OnTxStart`. This is unnecessary specially looking through the lens of
live tracers as chain config remains the same throughout the lifetime of
the program. It was there so that native API-invoked tracers could
access it. So instead we moved it to the constructor of API tracers.
Non-breaking:
- Change the default config of the tracers to be `{}` instead of nil.
This way an extra nil check can be avoided.
Refactoring:
- Rename `supply` struct to `supplyTracer`.
- Un-export some hook definitions.
103 lines
3.6 KiB
Go
103 lines
3.6 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 tracers
|
|
|
|
import (
|
|
"encoding/json"
|
|
"math/big"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/core/tracing"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
)
|
|
|
|
// Context contains some contextual infos for a transaction execution that is not
|
|
// available from within the EVM object.
|
|
type Context struct {
|
|
BlockHash common.Hash // Hash of the block the tx is contained within (zero if dangling tx or call)
|
|
BlockNumber *big.Int // Number of the block the tx is contained within (zero if dangling tx or call)
|
|
TxIndex int // Index of the transaction within a block (zero if dangling tx or call)
|
|
TxHash common.Hash // Hash of the transaction being traced (zero if dangling call)
|
|
}
|
|
|
|
// The set of methods that must be exposed by a tracer
|
|
// for it to be available through the RPC interface.
|
|
// This involves a method to retrieve results and one to
|
|
// stop tracing.
|
|
type Tracer struct {
|
|
*tracing.Hooks
|
|
GetResult func() (json.RawMessage, error)
|
|
// Stop terminates execution of the tracer at the first opportune moment.
|
|
Stop func(err error)
|
|
}
|
|
|
|
type ctorFn func(*Context, json.RawMessage, *params.ChainConfig) (*Tracer, error)
|
|
type jsCtorFn func(string, *Context, json.RawMessage, *params.ChainConfig) (*Tracer, error)
|
|
|
|
type elem struct {
|
|
ctor ctorFn
|
|
isJS bool
|
|
}
|
|
|
|
// DefaultDirectory is the collection of tracers bundled by default.
|
|
var DefaultDirectory = directory{elems: make(map[string]elem)}
|
|
|
|
// directory provides functionality to lookup a tracer by name
|
|
// and a function to instantiate it. It falls back to a JS code evaluator
|
|
// if no tracer of the given name exists.
|
|
type directory struct {
|
|
elems map[string]elem
|
|
jsEval jsCtorFn
|
|
}
|
|
|
|
// Register registers a method as a lookup for tracers, meaning that
|
|
// users can invoke a named tracer through that lookup.
|
|
func (d *directory) Register(name string, f ctorFn, isJS bool) {
|
|
d.elems[name] = elem{ctor: f, isJS: isJS}
|
|
}
|
|
|
|
// RegisterJSEval registers a tracer that is able to parse
|
|
// dynamic user-provided JS code.
|
|
func (d *directory) RegisterJSEval(f jsCtorFn) {
|
|
d.jsEval = f
|
|
}
|
|
|
|
// New returns a new instance of a tracer, by iterating through the
|
|
// registered lookups. Name is either name of an existing tracer
|
|
// or an arbitrary JS code.
|
|
func (d *directory) New(name string, ctx *Context, cfg json.RawMessage, chainConfig *params.ChainConfig) (*Tracer, error) {
|
|
if len(cfg) == 0 {
|
|
cfg = json.RawMessage("{}")
|
|
}
|
|
if elem, ok := d.elems[name]; ok {
|
|
return elem.ctor(ctx, cfg, chainConfig)
|
|
}
|
|
// Assume JS code
|
|
return d.jsEval(name, ctx, cfg, chainConfig)
|
|
}
|
|
|
|
// IsJS will return true if the given tracer will evaluate
|
|
// JS code. Because code evaluation has high overhead, this
|
|
// info will be used in determining fast and slow code paths.
|
|
func (d *directory) IsJS(name string) bool {
|
|
if elem, ok := d.elems[name]; ok {
|
|
return elem.isJS
|
|
}
|
|
// JS eval will execute JS code
|
|
return true
|
|
}
|