tracers

README

based on github.com/ethereum/go-ethereum/eth/tracers v1.8.14 tag

2020-10-16(rebase to v1.9.23)

• merge commit https://github.com/ethereum/go-ethereum/commit/e8ff318205be2d3e9f793ee876726bf0fbaf579e (eth/tracer: extend create2)
• merge commit https://github.com/ethereum/go-ethereum/commit/dfa16a3e4e0e0b5b20bfda7b7e89ebd07ea0a1a5 (eth/tracers: fixed incorrect storage from prestate_tracer)
• merge commit https://github.com/ethereum/go-ethereum/commit/71c37d82adaa2b69ea98ce0c5505489d6b711c1e (js/tracers: make call tracer report value in selfdestructs)
• merge commit https://github.com/ethereum/go-ethereum/commit/05280a7ae3f47adc8aeb9130c7f5404a42fb3a55 (eth/tracers: revert reason in call_tracer + error for failed internal calls)

2022-05-07

introduce native tracers, forked from https://github.com/ethereum/go-ethereum/tree/v1.10.18 (de23cf910b814867d5c5d1ad6164835d79069638)

• updated vm implementation, added CaptureEnter and CaptureExit
• remove CaptureTxStart CaptureTxEnd from Logger interface
• update contract create function in prestate
• remove js tracers

Documentation

Overview

Package tracers is a manager for transaction tracing engines.

Index

• func RegisterLookup(wildcard bool, lookup lookupFunc)
• type Context
• type Tracer
  • func New(code string, ctx *Context, cfg json.RawMessage) (Tracer, error)

Functions

func RegisterLookup

func RegisterLookup(wildcard bool, lookup 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.

Types

type Context

type Context struct {
	BlockID workshare.Bytes32 // 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)
	TxID    workshare.Bytes32 // Hash of the transaction being traced (zero if dangling call)
}

Context contains some contextual infos for a transaction execution that is not available from within the EVM object.

type Tracer

type Tracer interface {
	vm.Logger
	GetResult() (json.RawMessage, error)
	// Stop terminates execution of the tracer at the first opportune moment.
	Stop(err error)
}

Tracer interface extends vm.EVMLogger and additionally allows collecting the tracing result.

func New

func New(code string, ctx *Context, cfg json.RawMessage) (Tracer, error)

New returns a new instance of a tracer, by iterating through the registered lookups.