PolymeshTransaction

Wrapper class for a Polymesh Transaction

Type parameters

Args: unknown[]

Values: unknown[]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Optional blockHash

blockHash? : undefined | string

Inherited from PolymeshTransactionBase.blockHash

Defined in src/base/PolymeshTransactionBase.ts:55

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

Protected context

context: Context

Inherited from PolymeshTransactionBase.context

Defined in src/base/PolymeshTransactionBase.ts:121

Optional error

error? : PolymeshError

Inherited from PolymeshTransactionBase.error

Defined in src/base/PolymeshTransactionBase.ts:40

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

inputArgs

inputArgs: MapMaybePostTransactionValue‹Args›

Defined in src/base/PolymeshTransaction.ts:26

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)

isCritical

isCritical: boolean

Inherited from PolymeshTransactionBase.isCritical

Defined in src/base/PolymeshTransactionBase.ts:60

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

paidByThirdParty

paidByThirdParty: boolean

Inherited from PolymeshTransactionBase.paidByThirdParty

Defined in src/base/PolymeshTransactionBase.ts:66

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

Inherited from PolymeshTransactionBase.receipt

Defined in src/base/PolymeshTransactionBase.ts:45

stores the transaction receipt (if successful)

status

status: TransactionStatus = TransactionStatus.Idle

Inherited from PolymeshTransactionBase.status

Defined in src/base/PolymeshTransactionBase.ts:35

current status of the transaction

Optional txHash

txHash? : undefined | string

Inherited from PolymeshTransactionBase.txHash

Defined in src/base/PolymeshTransactionBase.ts:50

transaction hash (status: Running, Succeeded, Failed)

Accessors

args

get args(): Args

Defined in src/base/PolymeshTransaction.ts:43

Arguments for the transaction

Returns: Args

tag

get tag(): TxTag

Inherited from PolymeshTransactionBase.tag

Defined in src/base/PolymeshTransactionBase.ts:313

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›

Inherited from PolymeshTransactionBase.getFees

Defined in src/base/PolymeshTransactionBase.ts:285

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

Inherited from PolymeshTransactionBase.onStatusChange

Defined in src/base/PolymeshTransactionBase.ts:272

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›

Inherited from PolymeshTransactionBase.run

Defined in src/base/PolymeshTransactionBase.ts:155

Run the poly transaction and update the transaction status

Returns: Promise‹void›

Last updated