debug

Documentation

Index

• type DebugAPI
  • func NewDebugAPI() *DebugAPI
  • func (api *DebugAPI) TraceCall(args types2.CallArgs, blockNrOrHash rpc.BlockNumberOrHash, ...) (interface{}, error)
• type ExecutionResult
• type StructLogRes
  • func FormatLogs(logs []evm.StructLog) []StructLogRes
• type TraceCallConfig
• type TraceConfig

Types

type DebugAPI

type DebugAPI struct {
}

DebugAPI is the collection of tracing APIs exposed over the private debugging endpoint.

func NewDebugAPI

func NewDebugAPI() *DebugAPI

NewDebugAPI creates a new DebugAPI definition for the tracing methods of the Ethereum service.

func (*DebugAPI) TraceCall

func (api *DebugAPI) TraceCall(args types2.CallArgs, blockNrOrHash rpc.BlockNumberOrHash, config *TraceCallConfig) (interface{}, error)

TraceCall lets you trace a given eth_call. It collects the structured logs created during the execution of EVM if the given transaction was added on top of the provided block and returns them as a JSON object. You can provide -2 as a block number to trace on top of the pending block.

type ExecutionResult

type ExecutionResult struct {
	Gas         uint64         `json:"gas"`
	Failed      bool           `json:"failed"`
	ReturnValue string         `json:"returnValue"`
	StructLogs  []StructLogRes `json:"structLogs"`
}

ExecutionResult groups all structured logs emitted by the EVM while replaying a transaction in debug mode as well as transaction execution status, the amount of gas used and the return value

type StructLogRes

type StructLogRes struct {
	Pc      uint64             `json:"pc"`
	Op      string             `json:"op"`
	Gas     uint64             `json:"gas"`
	GasCost uint64             `json:"gasCost"`
	Depth   int                `json:"depth"`
	Error   error              `json:"error,omitempty"`
	Stack   *[]string          `json:"stack,omitempty"`
	Memory  *[]string          `json:"memory,omitempty"`
	Storage *map[string]string `json:"storage,omitempty"`
}

StructLogRes stores a structured log emitted by the EVM while replaying a transaction in debug mode

func FormatLogs

func FormatLogs(logs []evm.StructLog) []StructLogRes

FormatLogs formats EVM returned structured logs for json output

type TraceCallConfig

type TraceCallConfig struct {
	*evm.LogConfig
	Tracer  *string
	Timeout *string
	Reexec  *uint64
}

TraceCallConfig is the config for traceCall DebugAPI. It holds one more field to override the state for tracing.

type TraceConfig

type TraceConfig struct {
	*evm.LogConfig
	Tracer  *string
	Timeout *string
	Reexec  *uint64
}

TraceConfig holds extra parameters to trace functions.