Class SimulateTraceConfig

An object that configures simulation execution trace.

Hierarchy

Constructors

constructor

Properties

attribute_map enable scratchChange stackChange stateChange

Methods

get_obj_for_encoding from_obj_for_encoding

Constructors

constructor

  • Creates a new SimulateTraceConfig object.

    Parameters

    • __namedParameters: { enable?: boolean; scratchChange?: boolean; stackChange?: boolean; stateChange?: boolean }
      • Optional enable?: boolean
      • Optional scratchChange?: boolean
      • Optional stackChange?: boolean
      • Optional stateChange?: boolean

    Returns SimulateTraceConfig

Properties

attribute_map

attribute_map: Record<string, string>

Optional enable

enable?: boolean

A boolean option for opting in execution trace features simulation endpoint.

Optional scratchChange

scratchChange?: boolean

A boolean option enabling returning scratch slot changes together with execution trace during simulation.

Optional stackChange

stackChange?: boolean

A boolean option enabling returning stack changes together with execution trace during simulation.

Optional stateChange

stateChange?: boolean

A boolean option enabling returning application state changes (global, local, and box changes) with the execution trace during simulation.

Methods

get_obj_for_encoding

  • Get an object ready for encoding to either JSON or msgpack.

    Parameters

    • binary: boolean = false

      Use true to indicate that the encoding can handle raw binary objects (Uint8Arrays). Use false to indicate that raw binary objects should be converted to base64 strings. True should be used for objects that will be encoded with msgpack, and false should be used for objects that will be encoded with JSON.

    Returns Record<string, any>

Static from_obj_for_encoding

Settings

Member Visibility

Theme

Generated using TypeDoc