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
  • Hierarchy
  • Index
  • Properties
  • Accessors
  • Methods
  • Properties
  • Optional currentPair
  • isArchiveNode
  • polymeshApi
  • ss58Format
  • Accessors
  • middlewareApi
  • Methods
  • accountBalance
  • accountSubsidy
  • addPair
  • clone
  • disconnect
  • getAccounts
  • getCurrentAccount
  • getCurrentIdentity
  • getCurrentPair
  • getInvalidDids
  • getLatestBlock
  • getNetworkVersion
  • getSigner
  • getTransactionArguments
  • getTransactionFees
  • isMiddlewareAvailable
  • isMiddlewareEnabled
  • issuedClaims
  • queryMiddleware
  • setPair
  • Static create

Was this helpful?

  1. Classes

Context

PreviousComplianceNextCorporateAction

Last updated 3 years ago

Was this helpful?

Context in which the SDK is being used

  • Holds the current low level API

  • Holds the current keyring pair

  • Holds the current Identity

Hierarchy

  • Context

Index

Properties

Accessors

Methods

Properties

Optional currentPair

isArchiveNode

• isArchiveNode: boolean = false

Whether the current node is an archive node (contains a full history from genesis onward) or not

polymeshApi

• polymeshApi: ApiPromise

ss58Format

• ss58Format: number

Accessors

middlewareApi

• get middlewareApi(): ApolloClient‹NormalizedCacheObject›

Retrieve the middleware client

throws if the middleware is not enabled

Returns: ApolloClient‹NormalizedCacheObject›

Methods

accountBalance

Retrieve the account level POLYX balance

note can be subscribed to

Parameters:

Name
Type

account?

Parameters:

Name
Type

account

callback

accountSubsidy

Retrieve the account level subsidizer relationship. If there is no such relationship, return null

note can be subscribed to

Parameters:

Name
Type

account?

Parameters:

Name
Type

account

callback

addPair

Add a signing pair to the Keyring

Parameters:

Name
Type

params

clone

Returns a (shallow) clone of this instance. Useful for providing a separate Context to Procedures with different signers

disconnect

▸ disconnect(): Promise‹void›

Disconnect the Polkadot API, middleware, and render this instance unusable

note after disconnecting, trying to access any property in this objecct will result in an error

Returns: Promise‹void›

getAccounts

Retrieve a list of Accounts that can act as signers. The first Account in the array is the current Account (default signer)

getCurrentAccount

Retrieve current Account

throws if there is no current account associated to the SDK instance

getCurrentIdentity

Retrieve current Identity

throws if there is no Identity associated to the current Account (or there is no current Account associated to the SDK instance)

getCurrentPair

Retrieve current Keyring Pair

throws if there is no Account associated to the SDK instance

getInvalidDids

Check whether Identities exist

Parameters:

Name
Type

identities

Returns: Promise‹string[]›

getLatestBlock

▸ getLatestBlock(): Promise‹BigNumber›

Retrieve the latest block number

Returns: Promise‹BigNumber›

getNetworkVersion

▸ getNetworkVersion(): Promise‹string›

Retrieve the network version

Returns: Promise‹string›

getSigner

â–¸ getSigner(): AddressOrPair

Retrieve the signer address (or keyring pair)

Returns: AddressOrPair

getTransactionArguments

Retrieve the types of arguments that a certain transaction requires to be run

Parameters:

â–ª args: object

Name
Type
Description

tag

TxTag

tag associated with the transaction that will be executed if the proposal passes

getTransactionFees

▸ getTransactionFees(tag: TxTag): Promise‹BigNumber›

Retrieve the protocol fees associated with running a specific transaction

Parameters:

Name
Type
Description

tag

TxTag

transaction tag (i.e. TxTags.asset.CreateAsset or "asset.createAsset")

Returns: Promise‹BigNumber›

isMiddlewareAvailable

▸ isMiddlewareAvailable(): Promise‹boolean›

Return whether the middleware is enabled and online

Returns: Promise‹boolean›

isMiddlewareEnabled

â–¸ isMiddlewareEnabled(): boolean

Return whether the middleware was enabled at startup

Returns: boolean

issuedClaims

Retrieve a list of claims. Can be filtered using parameters

note uses the middleware (optional)

Parameters:

â–ªDefault value opts: object= {}

Name
Type
Description

claimTypes?

types of the claims to fetch. Defaults to any type

includeExpired?

undefined | false | true

whether to include expired claims. Defaults to true

size?

undefined | number

page size

start?

undefined | number

page offset

targets?

identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets

trustedClaimIssuers?

identity IDs of claim issuers. Defaults to all claim issuers

queryMiddleware

▸ queryMiddleware‹Result›(query: GraphqlQuery‹unknown›): Promise‹ApolloQueryResult‹Result››

Make a query to the middleware server using the apollo client

Type parameters:

▪ Result: Partial‹Query›

Parameters:

Name
Type

query

GraphqlQuery‹unknown›

Returns: Promise‹ApolloQueryResult‹Result››

setPair

â–¸ setPair(address: string): void

Set a pair as the current Account keyring pair

Parameters:

Name
Type

address

string

Returns: void

Static create

Create the Context instance

Parameters:

â–ª params: object

Name
Type

accountMnemonic?

undefined | string

accountSeed?

undefined | string

accountUri?

undefined | string

keyring?

middlewareApi

ApolloClient‹NormalizedCacheObject› | null

polymeshApi

ApiPromise

• currentPair? :

Defined in

Defined in

Defined in

Defined in

Defined in

▸ accountBalance(account?: string | ): Promise‹›

Defined in

string |

Returns: Promise‹›

▸ accountBalance(account: string | | undefined, callback: ‹›): Promise‹›

Defined in

string | | undefined

‹›

Returns: Promise‹›

▸ accountSubsidy(account?: string | ): Promise‹Omit‹, "beneficiary"› | null›

Defined in

string |

Returns: Promise‹Omit‹, "beneficiary"› | null›

▸ accountSubsidy(account: string | | undefined, callback: ‹Omit‹, "beneficiary"› | null›): Promise‹›

Defined in

string | | undefined

‹Omit‹, "beneficiary"› | null›

Returns: Promise‹›

â–¸ addPair(params: ):

Defined in

Returns:

â–¸ clone():

Defined in

Returns:

Defined in

â–¸ getAccounts(): []

Defined in

Returns: []

â–¸ getCurrentAccount():

Defined in

Returns:

▸ getCurrentIdentity(): Promise‹›

Defined in

Returns: Promise‹›

â–¸ getCurrentPair():

Defined in

Returns:

▸ getInvalidDids(identities: (string | ‹›)[]): Promise‹string[]›

Defined in

(string | ‹›)[]

Defined in

Defined in

Defined in

â–¸ getTransactionArguments(args: object): []

Defined in

Returns: []

Defined in

Defined in

Defined in

▸ issuedClaims(opts: object): Promise‹‹››

Defined in

‹, ›[]

(string | ‹›)[]

(string | ‹›)[]

Returns: Promise‹‹››

Defined in

Defined in

▸ create(params: object): Promise‹›

Defined in

|

Returns: Promise‹›

KeyringPair
src/base/Context.ts:111
src/base/Context.ts:116
src/base/Context.ts:109
src/base/Context.ts:118
src/base/Context.ts:1003
src/base/Context.ts:342
src/base/Context.ts:343
Account
Subsidy
src/base/Context.ts:396
Subsidy
src/base/Context.ts:397
src/base/Context.ts:277
KeyringPair
Context
src/base/Context.ts:1100
Context
src/base/Context.ts:1082
Account
src/base/Context.ts:254
Account
Account
src/base/Context.ts:452
Account
Identity
src/base/Context.ts:463
Identity
KeyringPair
src/base/Context.ts:483
KeyringPair
Identity
src/base/Context.ts:512
src/base/Context.ts:1061
src/base/Context.ts:1070
src/base/Context.ts:499
src/base/Context.ts:562
src/base/Context.ts:535
src/base/Context.ts:1048
src/base/Context.ts:1041
ResultSet
ClaimData
src/base/Context.ts:952
ResultSet
ClaimData
src/base/Context.ts:1019
src/base/Context.ts:319
Context
src/base/Context.ts:179
Context
currentPair
isArchiveNode
polymeshApi
ss58Format
middlewareApi
accountBalance
accountSubsidy
addPair
clone
disconnect
getAccounts
getCurrentAccount
getCurrentIdentity
getCurrentPair
getInvalidDids
getLatestBlock
getNetworkVersion
getSigner
getTransactionArguments
getTransactionFees
isMiddlewareAvailable
isMiddlewareEnabled
issuedClaims
queryMiddleware
setPair
create
Account
Account
Account
Account
Identity
Identity
Identity
Account
Account
Account
Subsidy
KeyringPair
Subsidy
ClaimType
UiKeyring
InvestorUniquenessV2
Exclude
AccountBalance
AccountBalance
SubCallback
AccountBalance
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
AddPairParams
TransactionArgument
TransactionArgument
SubCallback
AccountBalance
SubCallback
AddPairParams
CommonKeyring