forked from cerc-io/plugeth
6b9c77f060
* eth/tracers: restructure tracer package * core/vm/runtime: load js tracers * eth/tracers: mv bigint js code to own file * eth/tracers: add method docs for native tracers * eth/tracers: minor doc fix * core,eth: cancel evm on nativecalltracer stop * core/vm: fix failing test Co-authored-by: Sina Mahmoodi <itz.s1na@gmail.com>
73 lines
2.5 KiB
Go
73 lines
2.5 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 is a manager for transaction tracing engines.
|
|
package tracers
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
|
)
|
|
|
|
// 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)
|
|
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)
|
|
}
|
|
|
|
// Tracer interface extends vm.EVMLogger and additionally
|
|
// allows collecting the tracing result.
|
|
type Tracer interface {
|
|
vm.EVMLogger
|
|
GetResult() (json.RawMessage, error)
|
|
// Stop terminates execution of the tracer at the first opportune moment.
|
|
Stop(err error)
|
|
}
|
|
|
|
type lookupFunc func(string, *Context) (Tracer, error)
|
|
|
|
var (
|
|
lookups []lookupFunc
|
|
)
|
|
|
|
// RegisterLookup registers a method as a lookup for tracers, meaning that
|
|
// users can invoke a named tracer through that lookup. If 'wildcard' is true,
|
|
// then the lookup will be placed last. This is typically meant for interpreted
|
|
// engines (js) which can evaluate dynamic user-supplied code.
|
|
func RegisterLookup(wildcard bool, lookup lookupFunc) {
|
|
if wildcard {
|
|
lookups = append(lookups, lookup)
|
|
} else {
|
|
lookups = append([]lookupFunc{lookup}, lookups...)
|
|
}
|
|
}
|
|
|
|
// New returns a new instance of a tracer, by iterating through the
|
|
// registered lookups.
|
|
func New(code string, ctx *Context) (Tracer, error) {
|
|
for _, lookup := range lookups {
|
|
if tracer, err := lookup(code, ctx); err == nil {
|
|
return tracer, nil
|
|
}
|
|
}
|
|
return nil, errors.New("tracer not found")
|
|
}
|