Class SimulateRequest

Request type for simulation endpoint.

Implements

Encodable

Index

Constructors

Constructors

constructor

new SimulateRequest(__namedParameters): SimulateRequest
Creates a new SimulateRequest object.
Parameters
- __namedParameters: {
      allowEmptySignatures?: boolean;
      allowMoreLogging?: boolean;
      allowUnnamedResources?: boolean;
      execTraceConfig?: SimulateTraceConfig;
      extraOpcodeBudget?: number | bigint;
      fixSigners?: boolean;
      round?: number | bigint;
      txnGroups: SimulateRequestTransactionGroup[];
  }
  - Optional allowEmptySignatures?: boolean
  - Optional allowMoreLogging?: boolean
  - Optional allowUnnamedResources?: boolean
  - Optional execTraceConfig?: SimulateTraceConfig
  - Optional extraOpcodeBudget?: number | bigint
  - Optional fixSigners?: boolean
  - Optional round?: number | bigint
  - txnGroups: SimulateRequestTransactionGroup[]
Returns SimulateRequest
- Defined in client/v2/algod/models/types.ts:6045

Properties

`Optional` allowEmptySignatures

allowEmptySignatures?: boolean

Allows transactions without signatures to be simulated as if they had correct signatures.

`Optional` allowMoreLogging

allowMoreLogging?: boolean

Lifts limits on log opcode usage during simulation.

`Optional` allowUnnamedResources

allowUnnamedResources?: boolean

Allows access to unnamed resources during simulation.

`Optional` execTraceConfig

execTraceConfig?: SimulateTraceConfig

An object that configures simulation execution trace.

`Optional` extraOpcodeBudget

extraOpcodeBudget?: number

Applies extra opcode budget during simulation for each transaction group.

`Optional` fixSigners

fixSigners?: boolean

If true, signers for transactions that are missing signatures will be fixed during evaluation.

`Optional` round

round?: bigint

If provided, specifies the round preceding the simulation. State changes through this round will be used to run this simulation. Usually only the 4 most recent rounds will be available (controlled by the node config value MaxAcctLookback). If not specified, defaults to the latest available round.

txnGroups

txnGroups: SimulateRequestTransactionGroup[]

The transaction groups to simulate.

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/algod/models/types.ts:5933

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/algod/models/types.ts:6078

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/algod/models/types.ts:6082

`Static` fromEncodingData

fromEncodingData(data): SimulateRequest
Parameters
- data: unknown
Returns SimulateRequest
- Defined in client/v2/algod/models/types.ts:6100

Class SimulateRequest

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { allowEmptySignatures?: boolean; allowMoreLogging?: boolean; allowUnnamedResources?: boolean; execTraceConfig?: SimulateTraceConfig; extraOpcodeBudget?: number | bigint; fixSigners?: boolean; round?: number | bigint; txnGroups: SimulateRequestTransactionGroup[]; }

Optional allowEmptySignatures?: boolean

Optional allowMoreLogging?: boolean

Optional allowUnnamedResources?: boolean

Optional execTraceConfig?: SimulateTraceConfig

Optional extraOpcodeBudget?: number | bigint

Optional fixSigners?: boolean

Optional round?: number | bigint

txnGroups: SimulateRequestTransactionGroup[]

Returns SimulateRequest

Properties

Optional allowEmptySignatures

Optional allowMoreLogging

Optional allowUnnamedResources

Optional execTraceConfig

Optional extraOpcodeBudget

Optional fixSigners

Optional round

txnGroups

Static Private encodingSchemaValue

Accessors

Static encodingSchema

Returns Schema

Methods

getEncodingSchema

Returns Schema

toEncodingData

Returns Map<string, unknown>

Static fromEncodingData

Parameters

data: unknown

Returns SimulateRequest

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
allowEmptySignatures?: boolean;
allowMoreLogging?: boolean;
allowUnnamedResources?: boolean;
execTraceConfig?: SimulateTraceConfig;
extraOpcodeBudget?: number | bigint;
fixSigners?: boolean;
round?: number | bigint;
txnGroups: SimulateRequestTransactionGroup[];
}

`Optional` allowEmptySignatures?: boolean

`Optional` allowMoreLogging?: boolean

`Optional` allowUnnamedResources?: boolean

`Optional` execTraceConfig?: SimulateTraceConfig

`Optional` extraOpcodeBudget?: number | bigint

`Optional` fixSigners?: boolean

`Optional` round?: number | bigint

`Optional` allowEmptySignatures

`Optional` allowMoreLogging

`Optional` allowUnnamedResources

`Optional` execTraceConfig

`Optional` extraOpcodeBudget

`Optional` fixSigners

`Optional` round

`Static` `Private` encodingSchemaValue

`Static` encodingSchema

`Static` fromEncodingData