Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Type parameters
  • Hierarchy
  • Index
  • Properties
  • Accessors
  • Methods
  • Properties
  • Optional blockHash
  • Optional blockNumber
  • Protected context
  • Optional error
  • inputArgs
  • isCritical
  • Optional receipt
  • status
  • tag
  • Optional txHash
  • Accessors
  • args
  • Methods
  • Protected composeTx
  • getFees
  • getPayingAccount
  • Protected getProtocolFees
  • Protected ignoresSubsidy
  • onStatusChange
  • run
  • supportsSubsidy

Was this helpful?

  1. Classes

PolymeshTransaction

PreviousPolymeshErrorNextPolymeshTransactionBase

Last updated 2 years ago

Was this helpful?

Wrapper class for a Polymesh Transaction

Type parameters

▪ Args: unknown[] | []

▪ Values: unknown[]

Hierarchy

  • ‹Values›

    ↳ PolymeshTransaction

Index

Properties

Accessors

Methods

Properties

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 error

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


inputArgs

• inputArgs: MapMaybePostTransactionValue‹Args›

arguments for the transaction. Available after the transaction starts running (may be Post Transaction Values from a previous transaction in the queue that haven't resolved yet)


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

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)

Accessors

args

• get args(): Args

arguments for the transaction

Returns: Args

Methods

Protected composeTx

▸ composeTx(): SubmittableExtrinsic‹"promise", ISubmittableResult›

Overrides void

Returns: SubmittableExtrinsic‹"promise", ISubmittableResult›


getFees

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


getPayingAccount

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


Protected getProtocolFees

▸ getProtocolFees(): Promise‹BigNumber›

Overrides void

Returns: Promise‹BigNumber›


Protected ignoresSubsidy

▸ ignoresSubsidy(): boolean

Overrides void

Returns: boolean


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›


supportsSubsidy

▸ supportsSubsidy(): boolean

Returns: boolean

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

• error? :

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

• status: = TransactionStatus.Idle

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

Defined in

Defined in

▸ getFees(): Promise‹ | null›

Inherited from .

Defined in

Returns: Promise‹ | null›

▸ getPayingAccount(): Promise‹ | null›

Inherited from .

Defined in

Returns: Promise‹ | null›

Defined in

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Overrides .

Defined in

src/base/PolymeshTransactionBase.ts:47
src/base/PolymeshTransactionBase.ts:52
src/base/PolymeshTransactionBase.ts:105
PolymeshError
src/base/PolymeshTransactionBase.ts:32
src/base/PolymeshTransaction.ts:46
src/base/PolymeshTransactionBase.ts:57
src/base/PolymeshTransactionBase.ts:37
TransactionStatus
src/base/PolymeshTransactionBase.ts:27
src/base/PolymeshTransaction.ts:51
src/base/PolymeshTransactionBase.ts:42
src/base/PolymeshTransaction.ts:70
src/base/PolymeshTransaction.ts:79
Fees
src/base/PolymeshTransactionBase.ts:337
Fees
PayingAccount
src/base/PolymeshTransactionBase.ts:295
PayingAccount
src/base/PolymeshTransaction.ts:86
src/base/PolymeshTransaction.ts:94
src/base/PolymeshTransactionBase.ts:278
src/base/PolymeshTransactionBase.ts:130
src/base/PolymeshTransaction.ts:103
PolymeshTransactionBase
blockHash
blockNumber
context
error
inputArgs
isCritical
receipt
status
tag
txHash
args
composeTx
getFees
getPayingAccount
getProtocolFees
ignoresSubsidy
onStatusChange
run
supportsSubsidy
PolymeshTransaction
blockHash
PolymeshTransaction
blockNumber
PolymeshTransaction
context
PolymeshTransaction
error
PolymeshTransaction
isCritical
PolymeshTransaction
receipt
PolymeshTransaction
status
PolymeshTransaction
txHash
PolymeshTransaction
getFees
PolymeshTransaction
getPayingAccount
PolymeshTransaction
onStatusChange
PolymeshTransaction
run
PolymeshTransactionBase
supportsSubsidy