PolymeshTransactionBase
Last updated
Was this helpful?
Last updated
Was this helpful?
Wrapper class for a Polymesh Transaction
▪ Values: unknown[]
PolymeshTransactionBase
↳
↳
Optional
blockHash• blockHash? : undefined | string
hash of the block where this transaction resides (status: Succeeded
, Failed
)
Optional
blockNumber• blockNumber? : BigNumber
number of the block where this transaction resides (status: Succeeded
, Failed
)
Protected
context• context: Context
Optional
errorstores errors thrown while running the transaction (status: Failed
, Aborted
)
• isCritical: boolean
whether this transaction failing makes the entire transaction queue fail or not
Optional
receipt• receipt? : ISubmittableResult
stores the transaction receipt (if successful)
current status of the transaction
Optional
txHash• txHash? : undefined | string
transaction hash (status: Running
, Succeeded
, Failed
)
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
Retrieve the Account that would pay fees for the transaction if it was run at this moment, as well as the total amount that can be charged to it (allowance). A null allowance means that there is no limit to that amount
A null return value signifies that the caller Account would pay the fees
note
this value might change if, before running the transaction, the caller Account enters (or leaves) a subsidizer relationship
▸ 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:
transaction
this
Returns: function
unsubscribe function
▸ (): void
▸ run(): Promise‹void›
Run the transaction and update its status
Returns: Promise‹void›
Abstract
supportsSubsidy▸ supportsSubsidy(): boolean
Return whether the transaction can be subsidized. If the result is false AND the caller is being subsidized by a third party, the transaction can't be executed and trying to do so will result in an error
note
this depends on the type of transaction itself (i.e. staking.bond
can't be subsidized, but asset.createAsset
can)
Returns: boolean
Defined in
Defined in
Defined in
• error? :
Defined in
Defined in
Defined in
• status: = TransactionStatus.Idle
Defined in
Defined in
▸ getFees(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
▸ getPayingAccount(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
Defined in
Defined in
Defined in