PolymeshTransaction

Wrapper class for a Polymesh Transaction

Type parameters

▪ Args: unknown[]

▪ Values: unknown[]

Hierarchy

  • PolymeshTransaction

Index

Properties

Accessors

Methods

Properties

args

• args: MapMaybePostTransactionValue‹Args›

Defined in src/base/PolymeshTransaction.ts:66

arguments for the transaction. Available after the transaction starts running (may be Post Transaction Values from a previous transaction in the queue that haven't resolved yet)

Optional blockHash

• blockHash? : undefined | string

Defined in src/base/PolymeshTransaction.ts:55

hash of the block where this transaction resides (status: Succeeded, Failed)

Optional error

• error? : PolymeshError

Defined in src/base/PolymeshTransaction.ts:40

stores errors thrown while running the transaction (status: Failed, Aborted)

isCritical

• isCritical: boolean

Defined in src/base/PolymeshTransaction.ts:60

whether this tx failing makes the entire tx queue fail or not

paidByThirdParty

• paidByThirdParty: boolean

Defined in src/base/PolymeshTransaction.ts:72

whether the fees for this tx are paid by a third party. For example, when accepting/rejecting a request to join an Identity, fees are paid by the Identity that sent the request

Optional receipt

• receipt? : ISubmittableResult

Defined in src/base/PolymeshTransaction.ts:45

stores the transaction receipt (if successful)

status

• status: TransactionStatus = TransactionStatus.Idle

Defined in src/base/PolymeshTransaction.ts:35

current status of the transaction

Optional txHash

• txHash? : undefined | string

Defined in src/base/PolymeshTransaction.ts:50

transaction hash (status: Running, Succeeded, Failed)

Accessors

tag

• get tag(): TxTag

Defined in src/base/PolymeshTransaction.ts:258

type of transaction represented by this instance for display purposes. If the transaction isn't defined at design time, the tag won't be set (will be empty string) until the transaction is about to be run

Returns: TxTag

Methods

getFees

▸ getFees(): Promise‹Fees | null›

Defined in src/base/PolymeshTransaction.ts:218

Get all (protocol and gas) fees associated with this transaction. Returns null if the transaction is not ready yet (this can happen if it depends on the execution of a previous transaction in the queue)

Returns: Promise‹Fees | null›

onStatusChange

▸ onStatusChange(listener: function): function

Defined in src/base/PolymeshTransaction.ts:205

Subscribe to status changes

Parameters:

▪ listener: function

callback function that will be called whenever the status changes

▸ (transaction: this): void

Parameters:

Name

Type

transaction

this

Returns: function

unsubscribe function

▸ (): void

run

▸ run(): Promise‹void›

Defined in src/base/PolymeshTransaction.ts:164

Run the poly transaction and update the transaction status

Returns: Promise‹void›

PreviousPolymeshErrorNextPortfolio

Last updated