PolymeshTransactionBase
Wrapper class for a Polymesh Transaction

Type parameters

Args: unknown[]
Values: unknown[]

Hierarchy

Index

Properties

Methods

Properties

Optional blockHash

blockHash? : undefined | string
hash of the block where this transaction resides (status: Succeeded, Failed)

Protected context

context: Context

Optional error

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

isCritical

isCritical: boolean
whether this transaction failing makes the entire transaction queue fail or not

Optional receipt

receipt? : ISubmittableResult
stores the transaction receipt (if successful)

status

status: TransactionStatus = TransactionStatus.Idle
current status of the transaction

tag

tag: TxTag
type of transaction represented by this instance (mostly for display purposes)

Optional txHash

txHash? : undefined | string
transaction hash (status: Running, Succeeded, Failed)

Methods

getFees

getFees(): Promise‹Fees | null›
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)
note this value might change if the transaction is run at a later time. This can be due to a governance vote
Returns: Promise‹Fees | null›

getPayingAccount

getPayingAccount(): Promise‹object | null›
Retrieve the Account that would pay for the transaction fees if it was run at this moment, as well as the maximum amount that can be charged to it. A null allowance means that there is no limit to that amount
A null return value signifies that the current Account will pay for the fees
note this value might change if, before running the transaction, the current Account enters (or leaves) a subsidizer relationship
Returns: Promise‹object | null›

onStatusChange

onStatusChange(listener: function): function
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›
Run the transaction and update its status
Returns: Promise‹void›
Last modified 26d ago