Class: PolymeshTransaction<ReturnValue, TransformedReturnValue, Args>
base/PolymeshTransaction.PolymeshTransaction
Wrapper class for a Polymesh Transaction
Type parameters
| Name | Type |
|---|---|
ReturnValue | ReturnValue |
TransformedReturnValue | ReturnValue |
Args | extends unknown[] | [] = unknown[] |
Hierarchy
-
PolymeshTransactionBase<ReturnValue,TransformedReturnValue>↳
PolymeshTransaction
Properties
args
• args: Args
arguments for the transaction in SCALE format (polkadot.js Codec)
Defined in
base/PolymeshTransaction.ts:40
blockHash
• Optional blockHash: string
hash of the block where this transaction resides (status: Succeeded, Failed)
Inherited from
PolymeshTransactionBase.blockHash
Defined in
base/PolymeshTransactionBase.ts:106
blockNumber
• Optional blockNumber: BigNumber
number of the block where this transaction resides (status: Succeeded, Failed)
Inherited from
PolymeshTransactionBase.blockNumber
Defined in
base/PolymeshTransactionBase.ts:111
error
• Optional error: PolymeshError
stores errors thrown while running the transaction (status: Failed, Aborted)
Inherited from
Defined in
base/PolymeshTransactionBase.ts:86
multiSig
• multiSig: null | MultiSig
This will be set if the signingAddress is a MultiSig signer, otherwise null
When set it indicates the transaction will be wrapped as a proposal for the MultiSig,
meaning .runAsProposal should be used instead of .run
Inherited from
PolymeshTransactionBase.multiSig
Defined in
base/PolymeshTransactionBase.ts:119
receipt
• Optional receipt: ISubmittableResult
stores the transaction receipt (if successful)
Inherited from
PolymeshTransactionBase.receipt
Defined in
base/PolymeshTransactionBase.ts:91
status
• status: TransactionStatus = TransactionStatus.Idle
current status of the transaction
Inherited from
PolymeshTransactionBase.status
Defined in
base/PolymeshTransactionBase.ts:81
tag
• tag: TxTag
type of transaction represented by this instance (mostly for display purposes)
Defined in
base/PolymeshTransaction.ts:45
txHash
• Optional txHash: string
transaction hash (status: Running, Succeeded, Failed)
Inherited from
PolymeshTransactionBase.txHash
Defined in
base/PolymeshTransactionBase.ts:96
txIndex
• Optional txIndex: BigNumber
transaction index within its block (status: Succeeded, Failed)
Inherited from
PolymeshTransactionBase.txIndex
Defined in
base/PolymeshTransactionBase.ts:101
Accessors
isSuccess
• get isSuccess(): boolean
returns true if transaction has completed successfully
Returns
boolean
Inherited from
PolymeshTransactionBase.isSuccess
Defined in
base/PolymeshTransactionBase.ts:903
result
• get result(): TransformedReturnValue
returns the transaction result - this is the same value as the Promise run returns
Returns
TransformedReturnValue
Note
it is generally preferable to await the Promise returned by transaction.run() instead of reading this property
Throws
if the transaction.isSuccess property is false — be sure to check that before accessing!
Inherited from
PolymeshTransactionBase.result
Defined in
base/PolymeshTransactionBase.ts:819
Methods
getProtocolFees
▸ getProtocolFees(): Promise<BigNumber>
Return this transaction's protocol fees. These are extra fees charged for specific operations on the chain. Not to be confused with network fees (which depend on the complexity of the operation), protocol fees are set by governance and/or chain upgrades
Returns
Promise<BigNumber>
Overrides
PolymeshTransactionBase.getProtocolFees
Defined in
base/PolymeshTransaction.ts:108
getTotalFees
▸ getTotalFees(): Promise<PayingAccountFees>
Retrieve a breakdown of the fees required to run this transaction, as well as the Account responsible for paying them
Returns
Promise<PayingAccountFees>
Note
these values might be inaccurate if the transaction is run at a later time. This can be due to a governance vote or other chain related factors (like modifications to a specific subsidizer relationship or a chain upgrade)
Inherited from
PolymeshTransactionBase.getTotalFees
Defined in
base/PolymeshTransactionBase.ts:537
onProcessedByMiddleware
▸ onProcessedByMiddleware(listener): UnsubCallback
Subscribe to the results of this transaction being processed by the indexing service (and as such, available to the middleware)
Parameters
| Name | Type | Description |
|---|---|---|
listener | (err?: PolymeshError) => void | callback function that will be called whenever the middleware is updated with the latest data. If there is an error (timeout or middleware offline) it will be passed to this callback |
Returns
unsubscribe function
Note
this event will be fired even if the queue fails
Throws
if the middleware wasn't enabled when instantiating the SDK client
Inherited from
PolymeshTransactionBase.onProcessedByMiddleware
Defined in
base/PolymeshTransactionBase.ts:577
onStatusChange
▸ onStatusChange(listener): UnsubCallback
Subscribe to status changes
Parameters
| Name | Type | Description |
|---|---|---|
listener | (transaction: GenericPolymeshTransaction<ReturnValue, TransformedReturnValue>) => void | callback function that will be called whenever the status changes |
Returns
unsubscribe function
Inherited from
PolymeshTransactionBase.onStatusChange
Defined in
base/PolymeshTransactionBase.ts:519
run
▸ run(): Promise<TransformedReturnValue>
Run the transaction, update its status and return a result if applicable. Certain transactions create Entities on the blockchain, and those Entities are returned for convenience. For example, when running a transaction that creates an Asset, the Asset itself is returned
Returns
Promise<TransformedReturnValue>
Inherited from
Defined in
base/PolymeshTransactionBase.ts:270
runAsProposal
▸ runAsProposal(): Promise<MultiSigProposal>
Run the transaction as a multiSig proposal
Returns
Promise<MultiSigProposal>
Inherited from
PolymeshTransactionBase.runAsProposal
Defined in
base/PolymeshTransactionBase.ts:228
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
Returns
boolean
Note
this depends on the type of transaction itself (e.g. staking.bond can't be subsidized, but asset.createAsset can)
Overrides
PolymeshTransactionBase.supportsSubsidy
Defined in
base/PolymeshTransaction.ts:131
toSignablePayload
▸ toSignablePayload(metadata?): Promise<TransactionPayload>
Returns a representation intended for offline signers.
Parameters
| Name | Type |
|---|---|
metadata | Record<string, string> |
Returns
Promise<TransactionPayload>
Note
Usually .run() should be preferred due to is simplicity.
Note
When using this method, details like account nonces, and transaction mortality require extra consideration. Generating a payload for offline sign implies asynchronicity. If using this API, be sure each procedure is created with the correct nonce, accounting for in flight transactions, and the lifetime is sufficient.
Inherited from
PolymeshTransactionBase.toSignablePayload