Polymesh SDK API Reference
v4.0.0
v4.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Claims
    • Compliance
    • Context
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoStatus
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountBalance
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • CddProviderRole
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • MiddlewareConfig
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoTier
    • StoWithDetails
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenHolderOptions
    • TokenHolderProperties
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferPolyXParams
    • TransferRestrictionInputBase
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Index
  • Enumerations
  • Classes
  • Interfaces
  • Type aliases
  • Functions
  • Object literals
  • Type aliases
  • AddCountTransferRestrictionParams
  • AddPercentageTransferRestrictionParams
  • AddRestrictionParams
  • Authorization
  • CddClaim
  • Claim
  • CommonKeyring
  • Condition
  • ConditionBase
  • Ensured
  • GetReturnType
  • IdentityCondition
  • InstructionDetails
  • InvestorUniquenessClaim
  • ModifyClaimsParams
  • ModifyStoTimesParams
  • ModifyTokenParams
  • MultiClaimCondition
  • Mutable
  • NextKey
  • PortfolioLike
  • PrimaryIssuanceAgentCondition
  • Role
  • ScopedClaim
  • SetRestrictionsParams
  • SetTransferRestrictionsParams
  • Signer
  • SingleClaimCondition
  • SubCallback
  • TokenType
  • TransactionArgument
  • UnionOfProcedures
  • UnscopedClaim
  • UnsubCallback
  • Functions
  • Const areSameClaimIssuers
  • Const areSameClaims
  • Const convertArgsToRaw
  • createProcedureMethod
  • Const findClaimsByOtherIssuers
  • Const findPositiveBalanceIuClaims
  • tickerToDid
  • Const tuple
  • txGroupToTxTags
  • Object literals
  • Const ErrorMessagesPerCode
  • â–ª ErrorMessagesPerCode: object
  • [ErrorCode.TransactionAborted]
  • [ErrorCode.TransactionRejectedByUser]
  • [ErrorCode.TransactionReverted]

Was this helpful?

Globals

PreviousIntroductionNextClasses

Last updated 4 years ago

Was this helpful?

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

AddCountTransferRestrictionParams

AddPercentageTransferRestrictionParams

AddRestrictionParams

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

Authorization

Ƭ Authorization: object | object | object | object

Authorization request data corresponding to type

CddClaim

Ƭ CddClaim: object

Type declaration:

  • id: string

Claim

CommonKeyring

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

Condition

ConditionBase

Ƭ ConditionBase: object

Type declaration:

Ensured

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

GetReturnType

IdentityCondition

InstructionDetails

Ƭ InstructionDetails: object & object | object

InvestorUniquenessClaim

Ƭ InvestorUniquenessClaim: object

Type declaration:

  • cddId: string

  • scopeId: string

ModifyClaimsParams

ModifyStoTimesParams

Ƭ ModifyStoTimesParams: object | object | object

ModifyTokenParams

Ƭ ModifyTokenParams: object | object | object | object

MultiClaimCondition

Mutable

Ƭ Mutable: object

Type declaration:

NextKey

Ƭ NextKey: string | number | null

PortfolioLike

PrimaryIssuanceAgentCondition

Role

ScopedClaim

SetRestrictionsParams

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

SetTransferRestrictionsParams

Signer

SingleClaimCondition

SubCallback

Ƭ SubCallback: function

Type declaration:

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

Parameters:

Name

Type

result

T

TokenType

Type of security that the token represents

TransactionArgument

UnionOfProcedures

Ƭ UnionOfProcedures: Args extends unknown ? Procedure‹Args, ReturnValue, Storage› : never

UnscopedClaim

UnsubCallback

Ƭ UnsubCallback: function

Type declaration:

â–¸ (): void

Functions

Const areSameClaimIssuers

Parameters:

Name

Type

currentClaimIssuers

claimIssuers

ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]

Returns: boolean

Const areSameClaims

Parameters:

â–ª __namedParameters: object

Name

Type

scope

type

ClaimTypeEnum

Returns: boolean

Const convertArgsToRaw

Parameters:

Name

Type

claimIssuers

ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]

rawTicker

Ticker

context

Returns: object

  • claimIssuersToAdd: [Ticker, TrustedIssuer][]

  • inputDids: string[]

createProcedureMethod

Create a method that prepares a procedure

Type parameters:

â–ª MethodArgs

â–ª ProcedureArgs: unknown

â–ª ReturnValue

â–ª Storage

Parameters:

â–ª getProcedureAndArgs: function

Parameters:

Name

Type

args

MethodArgs

Returns: ProcedureMethod‹MethodArgs, ReturnValue›

Const findClaimsByOtherIssuers

Parameters:

Name

Type

claims

claimsByDid

Record‹string, MiddlewareClaim[]›

Const findPositiveBalanceIuClaims

Parameters:

Name

Type

claims

context

tickerToDid

â–¸ tickerToDid(ticker: string): string

Generate a Security Token's DID from a ticker

Parameters:

Name

Type

ticker

string

Returns: string

Const tuple

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

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

Retrieve every Transaction Tag associated to a Transaction Group

Parameters:

Name

Type

group

Returns: TxTag[]

Object literals

Const ErrorMessagesPerCode

â–ª ErrorMessagesPerCode: object

[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)"

[ErrorCode.TransactionRejectedByUser]

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

[ErrorCode.TransactionReverted]

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

Ƭ AddCountTransferRestrictionParams: & object

Defined in

Ƭ AddPercentageTransferRestrictionParams: & object

Defined in

Defined in

Defined in

Defined in

type:

Ƭ Claim: |

Defined in

Defined in

Ƭ Condition: | | |

Defined in

Defined in

target:

trustedClaimIssuers? : []

Defined in

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

Defined in

Ƭ IdentityCondition: & object

Defined in

Defined in

Defined in

scope:

type:

Ƭ ModifyClaimsParams: | |

Defined in

Defined in

Defined in

Ƭ MultiClaimCondition: & object

Defined in

Defined in

Defined in

Ƭ PortfolioLike: string | | | | object

Defined in

Ƭ PrimaryIssuanceAgentCondition: & object

Defined in

Ƭ Role: | | | | |

Defined in

Ƭ ScopedClaim: object | | object

Defined in

Defined in

Ƭ SetTransferRestrictionsParams: object & |

Defined in

Ƭ Signer: |

Defined in

Ƭ SingleClaimCondition: & object

Defined in

Defined in

Ƭ TokenType: | object

Defined in

Ƭ TransactionArgument: object & | | |

Defined in

Defined in

Ƭ UnscopedClaim: object |

Defined in

Defined in

â–¸ areSameClaimIssuers(currentClaimIssuers: [], claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean

Defined in

[]

â–¸ areSameClaims(claim: , __namedParameters: object): boolean

Defined in

â–ª claim:

Falsyable‹›

â–¸ convertArgsToRaw(claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: ): object

Defined in

▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ReturnValue, Storage›(getProcedureAndArgs: function, context: ): ProcedureMethod‹MethodArgs, ReturnValue›

Defined in

▸ (args: MethodArgs): [‹ProcedureArgs, ReturnValue, Storage› | Procedure‹ProcedureArgs, ReturnValue, Storage›, ProcedureArgs]

â–ª context:

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

Defined in

[]

Returns: []

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

Defined in

[]

Returns: Promise‹[]›

Defined in

Defined in

â–¸ txGroupToTxTags(group: ): TxTag[]

Defined in

Defined in

Defined in

Defined in

Defined in

AffirmationStatus
AuthorizationType
ClaimType
ConditionTarget
ConditionType
CountryCode
ErrorCode
InstructionStatus
InstructionType
KnownTokenType
ProposalStage
RoleType
ScopeType
StoStatus
TickerReservationStatus
TokenIdentifierType
TransactionArgumentType
TransactionQueueStatus
TransactionStatus
TransferStatus
TxGroup
VenueType
Account
AuthorizationRequest
Authorizations
Claims
Compliance
Context
Count
CurrentAccount
CurrentIdentity
DefaultPortfolio
DefaultTrustedClaimIssuer
Documents
Entity
Identity
IdentityAuthorizations
Instruction
Issuance
Middleware
NumberedPortfolio
Offerings
Percentage
Polymesh
PolymeshError
PolymeshTransaction
PolymeshTransactionBase
PolymeshTransactionBatch
Portfolio
Portfolios
Requirements
SecurityToken
Settlements
Sto
TickerReservation
TokenHolders
TransactionQueue
TransferRestrictionBase
TransferRestrictions
TrustedClaimIssuers
Venue
AccountBalance
AccountData
ActiveTransferRestrictions
AddBatchTransactionOpts
AddClaimsParams
AddInstructionParams
AddInvestorUniquenessClaimParams
AddTransactionOpts
AddTransactionOptsBase
ArrayTransactionArgument
CddProviderRole
ClaimData
ClaimScope
ClaimTarget
ComplexTransactionArgument
ConditionCompliance
ConnectParamsBase
ConstructorParams
ConsumeParams
CountTransferRestriction
CountTransferRestrictionInput
CreateSecurityTokenParams
CreateVenueParams
DeletePortfolioParams
EditClaimsParams
EventIdentifier
ExtrinsicData
Fees
HistoricSettlement
IdentityBalance
IdentityWithClaims
InstructionAffirmation
Investment
InviteAccountParams
IssueTokensParams
KeyringPair
Leg
MiddlewareConfig
ModifyInstructionAffirmationParams
ModifyPrimaryIssuanceAgentParams
ModifySignerPermissionsParams
ModifyTokenTrustedClaimIssuersAddSetParams
ModifyTokenTrustedClaimIssuersRemoveParams
MoveFundsParams
NetworkProperties
PaginationOptions
PercentageTransferRestriction
PercentageTransferRestrictionInput
Permissions
PermissionsLike
PlainTransactionArgument
PortfolioBalance
PortfolioCustodianRole
PortfolioMovement
ProcedureAuthorizationStatus
ProposalDetails
ProposalTimeFrames
ProposalVote
RedeemTokenParams
RegisterIdentityParams
RemoveSecondaryKeysParams
RenamePortfolioParams
Requirement
RequirementCompliance
ReserveTickerParams
ResultSet
RevokeClaimsParams
Scope
SecondaryKey
SecurityTokenDetails
SetAssetRequirementsParams
SetCountTransferRestrictionsParams
SetCustodianParams
SetPercentageTransferRestrictionsParams
SetTokenDocumentsParams
SettlementLeg
SimpleEnumTransactionArgument
StoDetails
StoTier
StoWithDetails
TickerOwnerRole
TickerReservationDetails
Tier
ToggleFreezeStoParams
ToggleFreezeTransfersParams
TogglePauseRequirementsParams
TokenDocument
TokenHolderOptions
TokenHolderProperties
TokenIdentifier
TokenOwnerRole
TokenPiaRole
TransferPolyXParams
TransferRestrictionInputBase
TransferTokenOwnershipParams
TrustedClaimIssuer
UiKeyring
UniqueIdentifiers
VenueDetails
VenueOwnerRole
CountTransferRestrictionInput
src/api/procedures/addTransferRestriction.ts:24
PercentageTransferRestrictionInput
src/api/procedures/addTransferRestriction.ts:28
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:29
src/types/index.ts:232
src/types/index.ts:278
src/types/index.ts:303
src/types/index.ts:487
src/types/index.ts:389
src/types/index.ts:368
ConditionTarget
TrustedClaimIssuer
src/types/index.ts:480
ActiveTransferRestrictions
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:43
src/types/index.ts:380
src/api/entities/Instruction/types.ts:15
src/types/index.ts:280
Scope
AddClaimsParams
EditClaimsParams
RevokeClaimsParams
src/api/procedures/modifyClaims.ts:54
src/api/procedures/modifyStoTimes.ts:9
src/api/procedures/modifyToken.ts:13
src/types/index.ts:375
src/types/utils/index.ts:3
src/types/index.ts:516
Identity
NumberedPortfolio
DefaultPortfolio
src/types/index.ts:705
src/types/index.ts:385
TickerOwnerRole
TokenOwnerRole
TokenPiaRole
CddProviderRole
VenueOwnerRole
PortfolioCustodianRole
src/types/index.ts:159
src/types/index.ts:287
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:36
SetCountTransferRestrictionsParams
SetPercentageTransferRestrictionsParams
src/api/procedures/setTransferRestrictions.ts:36
Identity
Account
src/types/index.ts:615
src/types/index.ts:370
src/types/index.ts:476
KnownTokenType
src/types/index.ts:182
PlainTransactionArgument
ArrayTransactionArgument
SimpleEnumTransactionArgument
ComplexTransactionArgument
src/types/index.ts:604
src/types/utils/index.ts:7
src/types/index.ts:301
src/types/index.ts:478
TrustedClaimIssuer
src/api/procedures/modifyTokenTrustedClaimIssuers.ts:65
src/api/procedures/modifyClaims.ts:65
Context
src/api/procedures/modifyTokenTrustedClaimIssuers.ts:36
Context
src/utils/internal.ts:377
Context
src/api/procedures/modifyClaims.ts:75
src/api/procedures/modifyClaims.ts:91
src/utils/conversion.ts:181
src/types/utils/index.ts:16
TxGroup
src/utils/conversion.ts:525
src/base/PolymeshError.ts:3
src/base/PolymeshError.ts:7
src/base/PolymeshError.ts:9
src/base/PolymeshError.ts:6
AddCountTransferRestrictionParams
AddPercentageTransferRestrictionParams
AddRestrictionParams
Authorization
CddClaim
Claim
CommonKeyring
Condition
ConditionBase
Ensured
GetReturnType
IdentityCondition
InstructionDetails
InvestorUniquenessClaim
ModifyClaimsParams
ModifyStoTimesParams
ModifyTokenParams
MultiClaimCondition
Mutable
NextKey
PortfolioLike
PrimaryIssuanceAgentCondition
Role
ScopedClaim
SetRestrictionsParams
SetTransferRestrictionsParams
Signer
SingleClaimCondition
SubCallback
TokenType
TransactionArgument
UnionOfProcedures
UnscopedClaim
UnsubCallback
areSameClaimIssuers
areSameClaims
convertArgsToRaw
createProcedureMethod
findClaimsByOtherIssuers
findPositiveBalanceIuClaims
tickerToDid
tuple
txGroupToTxTags
ErrorMessagesPerCode
ScopedClaim
UnscopedClaim
SingleClaimCondition
MultiClaimCondition
IdentityCondition
PrimaryIssuanceAgentCondition
ConditionBase
ConditionBase
ConditionBase
InvestorUniquenessClaim
ConditionBase
CddClaim
Claim
Claim
UnionOfProcedures
ClaimTarget
Claim
Claim
ClaimTarget
Context
Claim
Claim
TrustedClaimIssuer
Scope
Context
ClaimTarget
ClaimTarget
Context
TxGroup
CustomerDueDiligence
InvestorUniqueness