PolymeshTransactionBatch
Wrapper class for a batch of Polymesh Transactions
Type parameters
▪ Args: unknown[][]
▪ Values: unknown[]
Hierarchy
PolymeshTransactionBase‹Values›
↳ PolymeshTransactionBatch
Index
Properties
Accessors
Methods
Properties
Optional
blockHash
Optional
blockHash• blockHash? : undefined | string
Inherited from PolymeshTransaction.blockHash
Defined in src/base/PolymeshTransactionBase.ts:47
hash of the block where this transaction resides (status: Succeeded
, Failed
)
Optional
blockNumber
Optional
blockNumber• blockNumber? : BigNumber
Inherited from PolymeshTransaction.blockNumber
Defined in src/base/PolymeshTransactionBase.ts:52
number of the block where this transaction resides (status: Succeeded
, Failed
)
Protected
context
Protected
context• context: Context
Inherited from PolymeshTransaction.context
Defined in src/base/PolymeshTransactionBase.ts:105
Optional
error
Optional
error• error? : PolymeshError
Inherited from PolymeshTransaction.error
Defined in src/base/PolymeshTransactionBase.ts:32
stores errors thrown while running the transaction (status: Failed
, Aborted
)
isCritical
• isCritical: boolean
Inherited from PolymeshTransaction.isCritical
Defined in src/base/PolymeshTransactionBase.ts:57
whether this transaction failing makes the entire transaction queue fail or not
Optional
receipt
Optional
receipt• receipt? : ISubmittableResult
Inherited from PolymeshTransaction.receipt
Defined in src/base/PolymeshTransactionBase.ts:37
stores the transaction receipt (if successful)
status
• status: TransactionStatus = TransactionStatus.Idle
Inherited from PolymeshTransaction.status
Defined in src/base/PolymeshTransactionBase.ts:27
current status of the transaction
Optional
txHash
Optional
txHash• txHash? : undefined | string
Inherited from PolymeshTransaction.txHash
Defined in src/base/PolymeshTransactionBase.ts:42
transaction hash (status: Running
, Succeeded
, Failed
)
Accessors
transactions
• get transactions(): MapTxData‹Args›
Defined in src/base/PolymeshTransactionBatch.ts:71
transactions in the batch with their respective arguments
Returns: MapTxData‹Args›
Methods
getFees
▸ getFees(): Promise‹Fees | null›
Inherited from PolymeshTransaction.getFees
Defined in src/base/PolymeshTransactionBase.ts:337
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‹PayingAccount | null›
Inherited from PolymeshTransaction.getPayingAccount
Defined in src/base/PolymeshTransactionBase.ts:295
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
Returns: Promise‹PayingAccount | null›
onStatusChange
▸ onStatusChange(listener
: function): function
Inherited from PolymeshTransaction.onStatusChange
Defined in src/base/PolymeshTransactionBase.ts:278
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:130
Run the transaction and update its status
Returns: Promise‹void›
supportsSubsidy
▸ supportsSubsidy(): boolean
Overrides PolymeshTransactionBase.supportsSubsidy
Defined in src/base/PolymeshTransactionBatch.ts:113
note
batches can't be subsidized
Returns: boolean
Last updated