PolymeshTransactionBatch

Wrapper class for a batch of Polymesh Transactions

Type parameters

Args: unknown[]

Values: unknown[]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Optional blockHash

blockHash? : undefined | string

Inherited from PolymeshTransaction.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 PolymeshTransaction.context

Defined in src/base/PolymeshTransactionBase.ts:119

Optional error

error? : PolymeshError

Inherited from PolymeshTransaction.error

Defined in src/base/PolymeshTransactionBase.ts:40

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

isCritical

isCritical: boolean

Inherited from PolymeshTransaction.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 PolymeshTransaction.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 PolymeshTransaction.receipt

Defined in src/base/PolymeshTransactionBase.ts:45

stores the transaction receipt (if successful)

status

status: TransactionStatus = TransactionStatus.Idle

Inherited from PolymeshTransaction.status

Defined in src/base/PolymeshTransactionBase.ts:35

current status of the transaction

Optional txHash

txHash? : undefined | string

Inherited from PolymeshTransaction.txHash

Defined in src/base/PolymeshTransactionBase.ts:50

transaction hash (status: Running, Succeeded, Failed)

Accessors

args

get args(): Args[]

Defined in src/base/PolymeshTransactionBatch.ts:48

Arguments for each transaction in the batch

Returns: Args[]

tag

get tag(): TxTag

Inherited from PolymeshTransaction.tag

Defined in src/base/PolymeshTransactionBase.ts:309

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 PolymeshTransaction.getFees

Defined in src/base/PolymeshTransactionBase.ts:281

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 PolymeshTransaction.onStatusChange

Defined in src/base/PolymeshTransactionBase.ts:268

Subscribe to status changes

Parameters:

listener: function

callback function that will be called whenever the status changes

▸ (transaction: this): void

Parameters:

Returns: function

unsubscribe function

▸ (): void

run

run(): Promise‹void›

Inherited from PolymeshTransaction.run

Defined in src/base/PolymeshTransactionBase.ts:153

Run the poly transaction and update the transaction status

Returns: Promise‹void›

Last updated