@polymeshassociation/polymesh-sdk / base/PolymeshTransactionBase

base/PolymeshTransactionBase

Classes

abstract PolymeshTransactionBase

Defined in: base/PolymeshTransactionBase.ts:59

Wrapper class for a Polymesh Transaction

Extended by

• PolymeshTransaction
• PolymeshTransactionBatch

Type Parameters

Type Parameter	Default type
ReturnValue	void
TransformedReturnValue	ReturnValue

Properties

blockHash?

optional blockHash?: string

Defined in: base/PolymeshTransactionBase.ts:108

hash of the block where this transaction resides (status: Succeeded, Failed)

blockNumber?

optional blockNumber?: BigNumber

Defined in: base/PolymeshTransactionBase.ts:113

number of the block where this transaction resides (status: Succeeded, Failed)

error?

optional error?: PolymeshError

Defined in: base/PolymeshTransactionBase.ts:88

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

multiSig

multiSig: MultiSig | null

Defined in: base/PolymeshTransactionBase.ts:121

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

receipt?

optional receipt?: ISubmittableResult

Defined in: base/PolymeshTransactionBase.ts:93

stores the transaction receipt (if successful)

status

status: TransactionStatus = TransactionStatus.Idle

Defined in: base/PolymeshTransactionBase.ts:83

current status of the transaction

txHash?

optional txHash?: string

Defined in: base/PolymeshTransactionBase.ts:98

transaction hash (status: Running, Succeeded, Failed)

txIndex?

optional txIndex?: BigNumber

Defined in: base/PolymeshTransactionBase.ts:103

transaction index within its block (status: Succeeded, Failed)

Accessors

isSuccess

Get Signature

get isSuccess(): boolean

Defined in: base/PolymeshTransactionBase.ts:963

returns true if transaction has completed successfully

Returns

boolean

result

Get Signature

get result(): TransformedReturnValue

Defined in: base/PolymeshTransactionBase.ts:874

returns the transaction result - this is the same value as the Promise run returns

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!

Returns

TransformedReturnValue

Methods

getProtocolFees()

abstract getProtocolFees(): Promise<BigNumber>

Defined in: base/PolymeshTransactionBase.ts:805

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>

getTotalFees()

getTotalFees(asProposal?): Promise<PayingAccountFees>

Defined in: base/PolymeshTransactionBase.ts:597

Retrieve a breakdown of the fees required to run this transaction, as well as the Account responsible for paying them

Parameters

Parameter	Type	Default value	Description
asProposal	boolean	true	When true (default), treats the transaction as a MultiSig proposal if the signing account is a MultiSig signer. When false, treats the transaction as a direct transaction from the signing account, ignoring the MultiSig.

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)

onProcessedByMiddleware()

onProcessedByMiddleware(listener): UnsubCallback

Defined in: base/PolymeshTransactionBase.ts:637

Subscribe to the results of this transaction being processed by the indexing service (and as such, available to the middleware)

Parameters

Parameter	Type	Description
listener	(err?) => 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

UnsubCallback

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

onStatusChange()

onStatusChange(listener): UnsubCallback

Defined in: base/PolymeshTransactionBase.ts:576

Subscribe to status changes

Parameters

Parameter	Type	Description
listener	(transaction) => void	callback function that will be called whenever the status changes

Returns

UnsubCallback

unsubscribe function

run()

run(): Promise<TransformedReturnValue>

Defined in: base/PolymeshTransactionBase.ts:286

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>

runAsProposal()

runAsProposal(): Promise<MultiSigProposal>

Defined in: base/PolymeshTransactionBase.ts:239

Run the transaction as a multiSig proposal

Returns

Promise<MultiSigProposal>

supportsSubsidy()

abstract supportsSubsidy(): void

Defined in: base/PolymeshTransactionBase.ts:766

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

void

Note

this depends on the type of transaction itself (e.g. staking.bond can't be subsidized, but asset.createAsset can)

toSignablePayload()

toSignablePayload(metadata?, asProposal?): Promise<TransactionPayload>

Defined in: base/PolymeshTransactionBase.ts:899

Returns a representation intended for offline signers.

Parameters

Parameter	Type	Default value	Description
metadata	Record<string, string>	{}	Additional information attached to the payload, such as IDs or memos about the transaction
asProposal	boolean	true	When true (default), treats the transaction as a MultiSig proposal if the signing account is a MultiSig signer. When false, treats the transaction as a direct transaction from the signing account, ignoring the MultiSig.

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.