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
  • Methods
  • Properties
  • Optional blockHash
  • Optional blockNumber
  • Protected context
  • Optional error
  • isCritical
  • Optional receipt
  • status
  • Optional txHash
  • Methods
  • getFees
  • getPayingAccount
  • onStatusChange
  • run
  • Abstract supportsSubsidy

Was this helpful?

  1. Classes

PolymeshTransactionBase

PreviousPolymeshTransactionNextPolymeshTransactionBatch

Last updated 2 years ago

Was this helpful?

Wrapper class for a Polymesh Transaction

Type parameters

▪ Values: unknown[]

Hierarchy

  • PolymeshTransactionBase

    ↳

    ↳

Index

Properties

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)


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


Optional txHash

• txHash? : undefined | string

transaction hash (status: Running, Succeeded, Failed)

Methods

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


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›


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

src/base/PolymeshTransactionBase.ts:47
src/base/PolymeshTransactionBase.ts:52
src/base/PolymeshTransactionBase.ts:105
PolymeshError
src/base/PolymeshTransactionBase.ts:32
src/base/PolymeshTransactionBase.ts:57
src/base/PolymeshTransactionBase.ts:37
TransactionStatus
src/base/PolymeshTransactionBase.ts:27
src/base/PolymeshTransactionBase.ts:42
Fees
src/base/PolymeshTransactionBase.ts:337
Fees
PayingAccount
src/base/PolymeshTransactionBase.ts:295
PayingAccount
src/base/PolymeshTransactionBase.ts:278
src/base/PolymeshTransactionBase.ts:130
src/base/PolymeshTransactionBase.ts:393
PolymeshTransaction
PolymeshTransactionBatch
blockHash
blockNumber
context
error
isCritical
receipt
status
txHash
getFees
getPayingAccount
onStatusChange
run
supportsSubsidy