Globals

Index

Enumerations

• AffirmationStatus

• AuthorizationType

• ClaimType

• ConditionTarget

• ConditionType

• CountryCode

• ErrorCode

• InstructionStatus

• InstructionType

• KnownTokenType

• ProposalStage

• RoleType

• ScopeType

• TickerReservationStatus

• TokenIdentifierType

• TransactionArgumentType

• TransactionQueueStatus

• TransactionStatus

• TransferStatus

• VenueType

Classes

• Account

• AuthorizationRequest

• Authorizations

• Claims

• Compliance

• Context

• CurrentAccount

• CurrentIdentity

• DefaultPortfolio

• DefaultTrustedClaimIssuer

• Documents

• Entity

• Identity

• IdentityAuthorizations

• Instruction

• Issuance

• Middleware

• NumberedPortfolio

• Polymesh

• PolymeshError

• PolymeshTransaction

• PolymeshTransactionBase

• PolymeshTransactionBatch

• Portfolio

• Portfolios

• Requirements

• SecurityToken

• Settlements

• TickerReservation

• TokenHolders

• TransactionQueue

• TrustedClaimIssuers

• Venue

Interfaces

• AccountBalance

• AccountData

• AddBatchTransactionOpts

• AddClaimsParams

• AddInstructionParams

• AddTransactionOpts

• AddTransactionOptsBase

• ArrayTransactionArgument

• CddProviderRole

• ClaimData

• ClaimScope

• ClaimTarget

• ComplexTransactionArgument

• ConditionCompliance

• ConnectParamsBase

• ConstructorParams

• ConsumeParams

• CreateSecurityTokenParams

• CreateVenueParams

• DeletePortfolioParams

• EditClaimsParams

• EventIdentifier

• ExtrinsicData

• Fees

• IdentityBalance

• IdentityWithClaims

• InstructionAffirmation

• InviteAccountParams

• IssueTokensParams

• KeyringPair

• Leg

• MiddlewareConfig

• ModifyInstructionAffirmationParams

• ModifyPrimaryIssuanceAgentParams

• ModifySignerPermissionsParams

• ModifyTokenTrustedClaimIssuersAddSetParams

• ModifyTokenTrustedClaimIssuersRemoveParams

• MoveFundsParams

• NetworkProperties

• PaginationOptions

• Permissions

• PermissionsLike

• PlainTransactionArgument

• PortfolioBalance

• PortfolioCustodianRole

• PortfolioMovement

• ProposalDetails

• ProposalTimeFrames

• ProposalVote

• RegisterIdentityParams

• RemoveSecondaryKeysParams

• RenamePortfolioParams

• Requirement

• RequirementCompliance

• ReserveTickerParams

• ResultSet

• RevokeClaimsParams

• Scope

• SecondaryKey

• SecurityTokenDetails

• SetAssetRequirementsParams

• SetCustodianParams

• SetTokenDocumentsParams

• SimpleEnumTransactionArgument

• TickerOwnerRole

• TickerReservationDetails

• ToggleFreezeTransfersParams

• TogglePauseRequirementsParams

• TokenDocument

• TokenHolderOptions

• TokenHolderProperties

• TokenIdentifier

• TokenOwnerRole

• TransferPolyXParams

• TransferTokenOwnershipParams

• TrustedClaimIssuer

• UiKeyring

• UniqueIdentifiers

• VenueDetails

• VenueOwnerRole

Type aliases

• Authorization

• Claim

• CommonKeyring

• Condition

• ConditionBase

• Ensured

• IdentityCondition

• InstructionDetails

• ModifyClaimsParams

• ModifyTokenParams

• MultiClaimCondition

• Mutable

• NextKey

• PortfolioLike

• PrimaryIssuanceAgentCondition

• Role

• ScopedClaim

• Signer

• SingleClaimCondition

• SubCallback

• TokenType

• TransactionArgument

• UnscopedClaim

• UnsubCallback

Functions

• tickerToDid

• tuple

Object literals

• ErrorMessagesPerCode

Type aliases

Authorization

Ƭ Authorization: object | object | object | object

Defined in src/types/index.ts:216

Authorization request data corresponding to type

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in src/types/index.ts:280

CommonKeyring

Ƭ CommonKeyring: Pick‹Keyring, "getPair" | "getPairs" | "addFromSeed" | "addFromUri"›

Defined in src/types/index.ts:456

Condition

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | PrimaryIssuanceAgentCondition

Defined in src/types/index.ts:359

ConditionBase

Ƭ ConditionBase: object

Defined in src/types/index.ts:338

Type declaration:

• target: ConditionTarget

• trustedClaimIssuers? : TrustedClaimIssuer[]

Ensured

Ƭ Ensured: Required‹Pick‹T, K››

Defined in src/types/index.ts:449

IdentityCondition

Ƭ IdentityCondition: ConditionBase & object

Defined in src/types/index.ts:350

InstructionDetails

Ƭ InstructionDetails: object & object | object

Defined in src/api/entities/Instruction/types.ts:15

ModifyClaimsParams

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

Defined in src/api/procedures/modifyClaims.ts:44

ModifyTokenParams

Ƭ ModifyTokenParams: object | object | object

Defined in src/api/procedures/modifyToken.ts:5

MultiClaimCondition

Ƭ MultiClaimCondition: ConditionBase & object

Defined in src/types/index.ts:345

Mutable

Ƭ Mutable: object

Defined in src/types/utils/index.ts:1

Type declaration:

NextKey

Ƭ NextKey: string | number | null

Defined in src/types/index.ts:482

PortfolioLike

Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | object

Defined in src/types/index.ts:590

PrimaryIssuanceAgentCondition

Ƭ PrimaryIssuanceAgentCondition: ConditionBase & object

Defined in src/types/index.ts:355

Role

Ƭ Role: TickerOwnerRole | TokenOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole

Defined in src/types/index.ts:144

ScopedClaim

Ƭ ScopedClaim: object | object | object

Defined in src/types/index.ts:262

Signer

Ƭ Signer: Identity | Account

Defined in src/types/index.ts:571

SingleClaimCondition

Ƭ SingleClaimCondition: ConditionBase & object

Defined in src/types/index.ts:340

SubCallback

Ƭ SubCallback: function

Defined in src/types/index.ts:445

Type declaration:

▸ (result: T): void | Promise‹void›

Parameters:

Name	Type
result	T

TokenType

Ƭ TokenType: KnownTokenType | object

Defined in src/types/index.ts:166

Type of security that the token represents

TransactionArgument

Ƭ TransactionArgument: object & PlainTransactionArgument | ArrayTransactionArgument | SimpleEnumTransactionArgument | ComplexTransactionArgument

Defined in src/types/index.ts:560

UnscopedClaim

Ƭ UnscopedClaim: object | object

Defined in src/types/index.ts:276

UnsubCallback

Ƭ UnsubCallback: function

Defined in src/types/index.ts:447

Type declaration:

▸ (): void

Functions

tickerToDid

▸ tickerToDid(ticker: string): string

Defined in src/utils/conversion.ts:149

Generate a Security Token's DID from a ticker

Parameters:

Name	Type
ticker	string

Returns: string

Const tuple

▸ tuple‹T›(...args: T): T

Defined in src/types/utils/index.ts:10

Create a literal tuple type from a list of arguments

Type parameters:

▪ T: unknown[]

Parameters:

Name	Type	Description
...args	T	values to turn into a tuple

Returns: T

Object literals

Const ErrorMessagesPerCode

▪ ErrorMessagesPerCode: object

Defined in src/base/PolymeshError.ts:3

[ErrorCode.TransactionAborted]

• [ErrorCode.TransactionAborted]: string = "The transaction was removed from the transaction pool. This might mean that it was malformed (nonce too large/nonce too small/duplicated or invalid transaction)"

Defined in src/base/PolymeshError.ts:7

[ErrorCode.TransactionRejectedByUser]

• [ErrorCode.TransactionRejectedByUser]: string = "The user canceled the transaction signature"

Defined in src/base/PolymeshError.ts:9

[ErrorCode.TransactionReverted]

• [ErrorCode.TransactionReverted]: string = "The transaction execution reverted due to an error"

Defined in src/base/PolymeshError.ts:6