Class Operation

An operation object.

Index

Constructors

Properties

Methods

getDeployedAddress getFinalEvents getSpeculativeEvents getStatus wait waitFinalExecution waitSpeculativeExecution

Constructors

constructor

new Operation(provider, id): Operation
Parameters
- provider: Provider
- id: string
Returns Operation
- Defined in src/operation/operation.ts:14

Properties

id

id: string

provider

provider: Provider

Methods

getDeployedAddress

getDeployedAddress(waitFinal?): Promise<string>
Parameters
- waitFinal: boolean = false
Returns Promise<string>
- Defined in src/operation/operation.ts:115

getFinalEvents

getFinalEvents(): Promise<SCEvent[]>
Gets the events of the operation once the block reaches the final state.

Returns Promise<SCEvent[]>
The events of the operation.
- Defined in src/operation/operation.ts:94

getSpeculativeEvents

getSpeculativeEvents(): Promise<SCEvent[]>
Gets the events of the speculative execution of the operation.

Returns Promise<SCEvent[]>
The speculative events of the operation.
- Defined in src/operation/operation.ts:107

getStatus

getStatus(): Promise<OperationStatus>
Gets the status of the operation.

Returns Promise<OperationStatus>
The status of the operation.
- Defined in src/operation/operation.ts:24

`Private` wait

wait(exitThreshold, timeout?, period?): Promise<OperationStatus>
Waits for the operation to reach a specific status.
Parameters
- exitThreshold: OperationStatus
  The minimal status to wait for.
- timeout: number = DEFAULT_WAIT_TIMEOUT_MS
  The maximum time to wait.
- period: number = DEFAULT_WAIT_PERIOD_MS
  The time interval to check the status.
Returns Promise<OperationStatus>
The status of the operation or NotFound if the timeout is reached.
- Defined in src/operation/operation.ts:37

waitFinalExecution

waitFinalExecution(timeout?, period?): Promise<OperationStatus>
Waits for the block containing the operation to be final.
Parameters
- Optional timeout: number
  The maximum time to wait.
- Optional period: number
  The time interval to check the status.
Returns Promise<OperationStatus>
The status of the operation or NotFound if the timeout is reached.
- Defined in src/operation/operation.ts:82

waitSpeculativeExecution

waitSpeculativeExecution(timeout?, period?): Promise<OperationStatus>
Waits for the operation to be included in a block.
Parameters
- Optional timeout: number
  The maximum time to wait.
- Optional period: number
  The time interval to check the status.
Returns Promise<OperationStatus>
The status of the operation or NotFound if the timeout is reached.
- Defined in src/operation/operation.ts:67