Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Type parameters
  • Hierarchy
  • Index
  • Properties
  • Accessors
  • Methods
  • Properties
  • Optional blockHash
  • Protected context
  • Optional error
  • inputArgs
  • isCritical
  • Optional receipt
  • status
  • tag
  • Optional txHash
  • Accessors
  • args
  • Methods
  • getFees
  • getPayingAccount
  • onStatusChange
  • run

Was this helpful?

  1. Classes

PolymeshTransaction

PreviousPolymeshErrorNextPolymeshTransactionBase

Last updated 3 years ago

Was this helpful?

Wrapper class for a Polymesh Transaction

Type parameters

â–ª Args: unknown[]

â–ª Values: unknown[]

Hierarchy

  • ‹Args, Values›

    ↳ PolymeshTransaction

Index

Properties

Accessors

Methods

Properties

Optional blockHash

• blockHash? : undefined | string

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

Protected 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

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

▸ getPayingAccount(): Promise‹object | null›

Retrieve the Account that would pay for the transaction fees if it was run at this moment, as well as the maximum amount that can be charged to it. A null allowance means that there is no limit to that amount

A null return value signifies that the current Account will pay for the fees

note this value might change if, before running the transaction, the current Account enters (or leaves) a subsidizer relationship

Returns: Promise‹object | null›

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›

Inherited from .

Defined in

• context:

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

Inherited from .

Defined in

Inherited from .

Defined in

Defined in

▸ getFees(): Promise‹ | null›

Inherited from .

Defined in

Returns: Promise‹ | null›

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

src/base/PolymeshTransactionBase.ts:50
Context
src/base/PolymeshTransactionBase.ts:113
PolymeshError
src/base/PolymeshTransactionBase.ts:35
src/base/PolymeshTransaction.ts:26
src/base/PolymeshTransactionBase.ts:55
src/base/PolymeshTransactionBase.ts:40
TransactionStatus
src/base/PolymeshTransactionBase.ts:30
src/base/PolymeshTransactionBase.ts:60
src/base/PolymeshTransactionBase.ts:45
src/base/PolymeshTransaction.ts:43
Fees
src/base/PolymeshTransactionBase.ts:306
Fees
src/base/PolymeshTransactionBase.ts:269
src/base/PolymeshTransactionBase.ts:252
src/base/PolymeshTransactionBase.ts:139
PolymeshTransactionBase
blockHash
context
error
inputArgs
isCritical
receipt
status
tag
txHash
args
getFees
getPayingAccount
onStatusChange
run
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
PolymeshTransactionBase
blockHash
context
error
isCritical
receipt
status
tag
txHash
getFees
getPayingAccount
onStatusChange
run