Globals

Index

Enumerations

• 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

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

Interfaces

• AccountData

• ActiveTransferRestrictions

• AddBatchTransactionOpts

• AddClaimsParams

• AddInstructionParams

• AddInstructionsParams

• AddInvestorUniquenessClaimParams

• AddTransactionOpts

• AddTransactionOptsBase

• ArrayTransactionArgument

• Balance

• CalendarPeriod

• CddProviderRole

• CheckpointWithData

• ClaimData

• ClaimScope

• ClaimTarget

• ComplexTransactionArgument

• ConditionCompliance

• ConnectParamsBase

• ConstructorParams

• ConsumeParams

• ControllerTransferParams

• CorporateActionDefaults

• CorporateActionTargets

• CountTransferRestriction

• CountTransferRestrictionInput

• CreateCheckpointScheduleParams

• CreateSecurityTokenParams

• CreateVenueParams

• DeletePortfolioParams

• DistributionParticipant

• DistributionWithDetails

• DividendDistributionDetails

• DividendDistributionParams

• EditClaimsParams

• EventIdentifier

• ExtrinsicData

• Fees

• HistoricSettlement

• IdentityBalance

• IdentityWithClaims

• InstructionAffirmation

• InvestInStoParams

• Investment

• InviteAccountParams

• IssueTokensParams

• KeyringPair

• Leg

• LinkCaDocsParams

• MiddlewareConfig

• ModifyCorporateActionsAgentParams

• ModifyInstructionAffirmationParams

• ModifyPrimaryIssuanceAgentParams

• ModifySignerPermissionsParams

• ModifyTokenTrustedClaimIssuersAddSetParams

• ModifyTokenTrustedClaimIssuersRemoveParams

• MoveFundsParams

• NetworkProperties

• PaginationOptions

• PayDividendsParams

• PercentageTransferRestriction

• PercentageTransferRestrictionInput

• Permissions

• PermissionsLike

• PlainTransactionArgument

• PortfolioBalance

• PortfolioCustodianRole

• PortfolioMovement

• ProcedureAuthorizationStatus

• 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

• TransferTokenOwnershipParams

• TrustedClaimIssuer

• UiKeyring

• UniqueIdentifiers

• VenueDetails

• VenueOwnerRole

Type aliases

• AccountBalance

• AddCountTransferRestrictionParams

• AddPercentageTransferRestrictionParams

• AddRestrictionParams

• Authorization

• CddClaim

• CheckpointScheduleParams

• Claim

• CommonKeyring

• Condition

• ConditionBase

• ConfigureDividendDistributionParams

• Ensured

• GetReturnType

• IdentityCondition

• InputTargets

• InputTaxWithholding

• InstructionDetails

• InvestorUniquenessClaim

• InvestorUniquenessV2Claim

• ModifyCaDefaultsParams

• ModifyClaimsParams

• ModifyStoTimesParams

• ModifyTokenParams

• ModifyVenueParams

• MultiClaimCondition

• Mutable

• NextKey

• PortfolioLike

• PrimaryIssuanceAgentCondition

• ProcedureFunc

• Role

• ScopedClaim

• SetRestrictionsParams

• SetTransferRestrictionsParams

• Signer

• SingleClaimCondition

• SubCallback

• TokenType

• TransactionArgument

• UnionOfProcedureFuncs

• UnscopedClaim

• UnsubCallback

Variables

• notExistsMessage

Functions

• areSameClaimIssuers

• areSameClaims

• areSameTargets

• convertArgsToRaw

• createProcedureMethod

• findClaimsByOtherIssuers

• findPositiveBalanceIuClaims

• tickerToDid

• tuple

• txGroupToTxTags

Object literals

• ErrorMessagesPerCode

Type aliases

AccountBalance

Ƭ AccountBalance: Balance

Defined in src/types/index.ts:615

AddCountTransferRestrictionParams

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object

Defined in src/api/procedures/addTransferRestriction.ts:25

AddPercentageTransferRestrictionParams

Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object

Defined in src/api/procedures/addTransferRestriction.ts:29

AddRestrictionParams

Ƭ AddRestrictionParams: Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:30

Authorization

Ƭ Authorization: object | object | object | object

Defined in src/types/index.ts:252

Authorization request data corresponding to type

CddClaim

Ƭ CddClaim: object

Defined in src/types/index.ts:299

Type declaration:

• id: string

• type: CustomerDueDiligence

CheckpointScheduleParams

Ƭ CheckpointScheduleParams: Omit‹UniqueIdentifiers & Params, "ticker"›

Defined in src/api/entities/CheckpointSchedule/types.ts:8

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in src/types/index.ts:330

CommonKeyring

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

Defined in src/types/index.ts:590

Condition

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | PrimaryIssuanceAgentCondition

Defined in src/types/index.ts:420

ConditionBase

Ƭ ConditionBase: object

Defined in src/types/index.ts:399

Type declaration:

• target: ConditionTarget

• trustedClaimIssuers? : TrustedClaimIssuer[]

ConfigureDividendDistributionParams

Ƭ ConfigureDividendDistributionParams: Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object

Defined in src/api/procedures/configureDividendDistribution.ts:58

Ensured

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

Defined in src/types/index.ts:583

GetReturnType

Ƭ GetReturnType: ActiveTransferRestrictions‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:44

IdentityCondition

Ƭ IdentityCondition: ConditionBase & object

Defined in src/types/index.ts:411

InputTargets

Ƭ InputTargets: Omit‹CorporateActionTargets, "identities"› & object

Defined in src/api/entities/CorporateAction/types.ts:20

InputTaxWithholding

Ƭ InputTaxWithholding: Omit‹TaxWithholding, "identity"› & object

Defined in src/api/entities/CorporateAction/types.ts:24

InstructionDetails

Ƭ InstructionDetails: object & object | object

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

InvestorUniquenessClaim

Ƭ InvestorUniquenessClaim: object

Defined in src/types/index.ts:301

Type declaration:

• cddId: string

• scope: Scope

• scopeId: string

• type: InvestorUniqueness

InvestorUniquenessV2Claim

Ƭ InvestorUniquenessV2Claim: object

Defined in src/types/index.ts:308

Type declaration:

• cddId: string

• type: InvestorUniquenessV2

ModifyCaDefaultsParams

Ƭ ModifyCaDefaultsParams: object | object | object

Defined in src/api/procedures/modifyCaDefaults.ts:24

ModifyClaimsParams

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

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

ModifyStoTimesParams

Ƭ ModifyStoTimesParams: object | object | object

Defined in src/api/procedures/modifyStoTimes.ts:9

ModifyTokenParams

Ƭ ModifyTokenParams: object | object | object | object

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

ModifyVenueParams

Ƭ ModifyVenueParams: object | object | object

Defined in src/api/procedures/modifyVenue.ts:9

MultiClaimCondition

Ƭ MultiClaimCondition: ConditionBase & object

Defined in src/types/index.ts:406

Mutable

Ƭ Mutable: object

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

Type declaration:

NextKey

Ƭ NextKey: string | number | null

Defined in src/types/index.ts:622

PortfolioLike

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

Defined in src/types/index.ts:840

PrimaryIssuanceAgentCondition

Ƭ PrimaryIssuanceAgentCondition: ConditionBase & object

Defined in src/types/index.ts:416

ProcedureFunc

Ƭ ProcedureFunc: function

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

Type declaration:

▸ (): Procedure‹Args, ReturnValue, Storage›

Role

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

Defined in src/types/index.ts:176

ScopedClaim

Ƭ ScopedClaim: object | InvestorUniquenessClaim | object

Defined in src/types/index.ts:313

SetRestrictionsParams

Ƭ SetRestrictionsParams: Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:37

SetTransferRestrictionsParams

Ƭ SetTransferRestrictionsParams: object & SetCountTransferRestrictionsParams | SetPercentageTransferRestrictionsParams

Defined in src/api/procedures/setTransferRestrictions.ts:34

Signer

Ƭ Signer: Identity | Account

Defined in src/types/index.ts:721

SingleClaimCondition

Ƭ SingleClaimCondition: ConditionBase & object

Defined in src/types/index.ts:401

SubCallback

Ƭ SubCallback: function

Defined in src/types/index.ts:579

Type declaration:

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

Parameters:

Name	Type
result	T

TokenType

Ƭ TokenType: KnownTokenType | object

Defined in src/types/index.ts:201

Type of security that the token represents

TransactionArgument

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

Defined in src/types/index.ts:710

UnionOfProcedureFuncs

Ƭ UnionOfProcedureFuncs: Args extends object ? ProcedureFunc‹Args, ReturnValue, Storage› : never

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

UnscopedClaim

Ƭ UnscopedClaim: object | CddClaim | InvestorUniquenessV2Claim

Defined in src/types/index.ts:328

UnsubCallback

Ƭ UnsubCallback: function

Defined in src/types/index.ts:581

Type declaration:

▸ (): void

Variables

Const notExistsMessage

• notExistsMessage: "Instruction no longer exists. This means it was already executed/rejected (execution might have failed)" = "Instruction no longer exists. This means it was already executed/rejected (execution might have failed)"

Defined in src/api/entities/CheckpointSchedule/index.ts:27

Defined in src/api/entities/Instruction/index.ts:40

Functions

Const areSameClaimIssuers

▸ areSameClaimIssuers(currentClaimIssuers: TrustedClaimIssuer[], claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean

Defined in src/api/procedures/modifyTokenTrustedClaimIssuers.ts:65

Parameters:

Name	Type
currentClaimIssuers	TrustedClaimIssuer[]
claimIssuers	ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]

Returns: boolean

Const areSameClaims

▸ areSameClaims(claim: Claim, __namedParameters: object): boolean

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

Parameters:

▪ claim: Claim

▪ __namedParameters: object

Name	Type
scope	Falsyable‹Scope›
type	ClaimTypeEnum

Returns: boolean

Const areSameTargets

▸ areSameTargets(targets: CorporateActionTargets, newTargets: InputTargets): boolean

Defined in src/api/procedures/modifyCaDefaults.ts:46

Parameters:

Name	Type
targets	CorporateActionTargets
newTargets	InputTargets

Returns: boolean

Const convertArgsToRaw

▸ convertArgsToRaw(claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: Context): object

Defined in src/api/procedures/modifyTokenTrustedClaimIssuers.ts:36

Parameters:

Name	Type
claimIssuers	ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]
rawTicker	Ticker
context	Context

Returns: object

• claimIssuersToAdd: [Ticker, TrustedIssuer][]

• inputDids: string[]

createProcedureMethod

▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›

Defined in src/utils/internal.ts:401

Create a method that prepares a procedure

Type parameters:

▪ MethodArgs

▪ ProcedureArgs: unknown

▪ ProcedureReturnValue

▪ Storage

Parameters:

▪ args: object

Name	Type
getProcedureAndArgs	function

▪ context: Context

Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›

▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›

Defined in src/utils/internal.ts:420

Type parameters:

▪ MethodArgs

▪ ProcedureArgs: unknown

▪ ProcedureReturnValue

▪ ReturnValue

▪ Storage

Parameters:

▪ args: object

Name	Type
getProcedureAndArgs	function
transformer	function

▪ context: Context

Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›

Const findClaimsByOtherIssuers

▸ findClaimsByOtherIssuers(claims: ClaimTarget[], claimsByDid: Record‹string, MiddlewareClaim[]›): Claim[]

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

Parameters:

Name	Type
claims	ClaimTarget[]
claimsByDid	Record‹string, MiddlewareClaim[]›

Returns: Claim[]

Const findPositiveBalanceIuClaims

▸ findPositiveBalanceIuClaims(claims: ClaimTarget[], context: Context): Promise‹Claim[]›

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

Parameters:

Name	Type
claims	ClaimTarget[]
context	Context

Returns: Promise‹Claim[]›

tickerToDid

▸ tickerToDid(ticker: string): string

Defined in src/utils/conversion.ts:213

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:22

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

txGroupToTxTags

▸ txGroupToTxTags(group: TxGroup): TxTag[]

Defined in src/utils/conversion.ts:568

Retrieve every Transaction Tag associated to a Transaction Group

Parameters:

Name	Type
group	TxGroup

Returns: TxTag[]

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