Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Type parameters
  • Hierarchy
  • Index
  • Properties
  • Accessors
  • Methods
  • Properties
  • Optional blockHash
  • Protected context
  • Optional error
  • inputArgs
  • isCritical
  • paidByThirdParty
  • Optional receipt
  • status
  • Optional txHash
  • Accessors
  • args
  • tag
  • Methods
  • getFees
  • 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 tx failing makes the entire tx queue fail or not

paidByThirdParty

• paidByThirdParty: boolean

whether the fees for this tx are paid by a third party. For example, when accepting/rejecting a request to join an Identity, fees are paid by the Identity that sent the request

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)

Accessors

args

• get args(): Args

Arguments for the transaction

Returns: Args

tag

• get tag(): TxTag

type of transaction represented by this instance for display purposes. If the transaction isn't defined at design time, the tag won't be set (will be empty string) until the transaction is about to be run

Returns: TxTag

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)

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 poly transaction and update the transaction 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

Inherited from .

Defined in

• status: = TransactionStatus.Idle

Inherited from .

Defined in

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

▸ getFees(): Promise‹ | null›

Inherited from .

Defined in

Returns: Promise‹ | null›

Inherited from .

Defined in

Inherited from .

Defined in

src/base/PolymeshTransactionBase.ts:55
Context
src/base/PolymeshTransactionBase.ts:119
PolymeshError
src/base/PolymeshTransactionBase.ts:40
src/base/PolymeshTransaction.ts:26
src/base/PolymeshTransactionBase.ts:60
src/base/PolymeshTransactionBase.ts:66
src/base/PolymeshTransactionBase.ts:45
TransactionStatus
src/base/PolymeshTransactionBase.ts:35
src/base/PolymeshTransactionBase.ts:50
src/base/PolymeshTransaction.ts:43
src/base/PolymeshTransactionBase.ts:314
Fees
src/base/PolymeshTransactionBase.ts:281
Fees
src/base/PolymeshTransactionBase.ts:268
src/base/PolymeshTransactionBase.ts:153
PolymeshTransactionBase
blockHash
context
error
inputArgs
isCritical
paidByThirdParty
receipt
status
txHash
args
tag
getFees
onStatusChange
run
PolymeshTransaction
blockHash
PolymeshTransaction
context
PolymeshTransaction
error
PolymeshTransaction
isCritical
PolymeshTransaction
paidByThirdParty
PolymeshTransaction
receipt
PolymeshTransaction
status
PolymeshTransaction
txHash
PolymeshTransaction
tag
PolymeshTransaction
getFees
PolymeshTransaction
onStatusChange
PolymeshTransaction
run