solitude.debugger module

class solitude.debugger.EvmTrace(rpc: solitude.common.rpc_client.RPCClient, contracts: solitude.common.contract_objectlist.ContractObjectList)

Bases: object

Access debug information from the ETH server

__init__(rpc: solitude.common.rpc_client.RPCClient, contracts: solitude.common.contract_objectlist.ContractObjectList)

Create an EvmTrace instance

Parameters:

• rpc – RPC client connected to the ETH server
• contracts – a collection of contracts (see ContractObjectList)

trace_iter(txhash: bytes) → Iterator[Tuple[solitude.debugger.evm_trace.TraceStep, solitude.debugger.evm_trace.CallStackEvent]]

Iterate contract execution steps (instructions)

Parameters:txhash – transaction hash to inspect, as byte array Returns:generator of tuples of (TraceStep, CallStackEvent)

class solitude.debugger.TraceStep

Bases: tuple

Debugger step (instruction) information

code

a SourceMapping object containing the source code and line information

contractname

contract name

depth

call stack depth

error

Error message

fileno

index which identifies the source unit

gas

Gas cost of the instruction

index

incrementing index of the step

jumptype

type of jump, ‘i’ for ‘jump into call’, ‘o’, for ‘jump out of call’, or empty (‘’)

length

length of the source code mapped to this instruction

memory

EVM memory as list of hex strings

op

opcode string

pc

program counter

stack

EVM stack as list of hex strings

start

index of the character in the source file where the source code mapped to this instruction starts

storage

EVM storage as dictionary of hex strings

class solitude.debugger.SourceMapping

Bases: tuple

Source code and line information related to an instruction

line_index

line index where the relevant portion begins

line_pos

index of the column where the relevant portion begins (in line)

line_start

index of the character where the line starts in the file

lines

full source text split in lines

source

full source text

unitname

source unit name

class solitude.debugger.CallStackElement

Bases: tuple

Basic stack frame information

prev

the TraceStep before entering a call

step

the TraceStep after entering a call

class solitude.debugger.CallStackEvent

Bases: tuple

Call stack event information

data

Event data. If the event is of type ‘push’, a CallStackElement

event

Type of event. Can be ‘push’, ‘pop’ or None

class solitude.debugger.EvmDebugCore(client: solitude.client.eth_client.ETHClient, txhash: bytes, windowsize=50)

Bases: object

Provides common debugger-like access to the EVM’s debug information

INVALID_STEP = <solitude.debugger.evm_debug_core.Step object>

__init__(client: solitude.client.eth_client.ETHClient, txhash: bytes, windowsize=50)

Create an EvmDebugCore.

Parameters:

• client – an ETHClient connected to the ETH node
• txhash – transaction hash, as bytes
• windowsize – amount of previous and next steps buffered, for a total of previous (windowsize) + current (1) + next (windowsize).

get_callstack_depth() → int

Get the call stack depth :return: number of frames in the call stack

get_frames() → List[solitude.debugger.evm_debug_core.Frame]

Get call stack frames :return: a list of Frame

get_step(offset=0) → solitude.debugger.evm_debug_core.Step

Get step, relative to current step.

Parameters:offset – step offset, relative to the current one. Can be in range (-windowsize, windowsize), according to the windowsize value provided in the constructor. Returns:a Step

get_values() → Dict[str, solitude.debugger.evm_debug_core.Value]

Get named values in the current step, from function parameters and local variables.

Returns:list of Value

step()

Step one instruction forward

class solitude.debugger.Function(name: str, parameters: List[solitude.debugger.evm_debug_core.Value])

Bases: solitude._internal.oi_serializable.ISerializable

Object containing a function call information

__init__(name: str, parameters: List[solitude.debugger.evm_debug_core.Value])

Create a Function object

Parameters:

• name – function name
• parameters – list of function parameters, as Value objects

static from_obj(obj)

to_obj()

class solitude.debugger.Frame(prev: solitude.debugger.evm_trace.TraceStep, cur: solitude.debugger.evm_trace.TraceStep)

Bases: solitude._internal.oi_serializable.ISerializable

Call stack frame information

Variables:

• locals – dictionary of local variable values
• return_values – list of values produced by return statements
• function – function call information

Step information is lost during serialization, and the three attributes above are kept

__init__(prev: solitude.debugger.evm_trace.TraceStep, cur: solitude.debugger.evm_trace.TraceStep)

Create a Frame object

Parameters:

• prev – step before entering the function
• cur – step after entering the function

static from_obj(obj)

to_obj()

class solitude.debugger.Step(step: Optional[solitude.debugger.evm_trace.TraceStep], event: Optional[solitude.debugger.evm_trace.CallStackEvent])

Bases: object

Single instruction step information

Variables:

• ast – AST nodes mapped to the instruction, as dictionary of (node type name -> node dict)
• values – values associated to this instruction (variable assignment, value produced by evaluation of statement, …)

__init__(step: Optional[solitude.debugger.evm_trace.TraceStep], event: Optional[solitude.debugger.evm_trace.CallStackEvent])

Create a Step object

Parameters:

• step – step information
• event – call stack event associated with the step

This object may be create empty, with null step and event data.

valid

Wether this object contains step information or is empty

Returns:True if not empty, otherwise False

class solitude.debugger.Value(vtype: str, name: str, value, kind: str, origin=None)

Bases: solitude._internal.oi_serializable.ISerializable

Value debug information

It represents a value associated to a named entity in the source code. Only supports numeric values.

__init__(vtype: str, name: str, value, kind: str, origin=None)

Create a Value object

Parameters:

• vtype – value type name
• name – value name
• value – integer content of value
• kind – one of ValueKind enum values
• origin – type of AST node from which the variable information was extracted

static from_obj(obj)

to_obj()

value_repr() → str

Get string representation of the value

Returns:string representation

class solitude.debugger.InteractiveDebuggerOI(txhash, client, code_lines=(3, 6))

Bases: solitude._internal.oi_interface.ObjectInterface

__init__(txhash, client, code_lines=(3, 6))

Initialize self. See help(type(self)) for accurate signature.

cmd_backtrace(args)

cmd_break(args)

cmd_continue(args)

cmd_delete(args)

cmd_finish(args)

cmd_frame(args)

cmd_info_args(args)

cmd_info_breakpoints(args)

cmd_info_locals(args)

cmd_list(args)

cmd_next(args)

cmd_print(args)

cmd_quit(args)

cmd_step(args)

cmd_stepi(args)

format_code(step, before=None, after=None)

static get_source_lines(step: solitude.debugger.evm_trace.TraceStep, strip=False, color='green', before=0, after=0) → solitude._internal.oi_common_objects.ColorText

on_breakpoint(args)

on_revert(args)

on_step(args)

on_terminate(args)