Polymesh SDK API Reference
v3.0.0
v3.0.0
  • Introduction
  • Globals
  • 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
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • VenueType
  • 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
Powered by GitBook
On this page
  • Index
  • Enumerations
  • Classes
  • Interfaces
  • Type aliases
  • Functions
  • Object literals
  • 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
  • Const tuple
  • 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

Authorization

Ƭ Authorization: object | object | object | object

Authorization request data corresponding to type

Claim

CommonKeyring

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

Condition

ConditionBase

Ƭ ConditionBase: object

Type declaration:

Ensured

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

IdentityCondition

InstructionDetails

Ƭ InstructionDetails: object & object | object

ModifyClaimsParams

ModifyTokenParams

Ƭ ModifyTokenParams: object | object | object

MultiClaimCondition

Mutable

Ƭ Mutable: object

Type declaration:

NextKey

Ƭ NextKey: string | number | null

PortfolioLike

PrimaryIssuanceAgentCondition

Role

ScopedClaim

Ƭ ScopedClaim: object | object | object

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

UnscopedClaim

Ƭ UnscopedClaim: object | object

UnsubCallback

Ƭ UnsubCallback: function

Type declaration:

â–¸ (): void

Functions

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

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"

Defined in

Ƭ Claim: |

Defined in

Defined in

Ƭ Condition: | | |

Defined in

Defined in

target:

trustedClaimIssuers? : []

Defined in

Ƭ IdentityCondition: & object

Defined in

Defined in

Ƭ ModifyClaimsParams: | |

Defined in

Defined in

Ƭ MultiClaimCondition: & object

Defined in

Defined in

Defined in

Ƭ PortfolioLike: string | | | | object

Defined in

Ƭ PrimaryIssuanceAgentCondition: & object

Defined in

Ƭ Role: | | | |

Defined in

Defined in

Ƭ Signer: |

Defined in

Ƭ SingleClaimCondition: & object

Defined in

Defined in

Ƭ TokenType: | object

Defined in

Ƭ TransactionArgument: object & | | |

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

AffirmationStatus
AuthorizationType
ClaimType
ConditionTarget
ConditionType
CountryCode
ErrorCode
InstructionStatus
InstructionType
KnownTokenType
ProposalStage
RoleType
ScopeType
TickerReservationStatus
TokenIdentifierType
TransactionArgumentType
TransactionQueueStatus
TransactionStatus
TransferStatus
VenueType
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
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
src/types/index.ts:216
src/types/index.ts:280
src/types/index.ts:456
src/types/index.ts:359
src/types/index.ts:338
ConditionTarget
TrustedClaimIssuer
src/types/index.ts:449
src/types/index.ts:350
src/api/entities/Instruction/types.ts:15
AddClaimsParams
EditClaimsParams
RevokeClaimsParams
src/api/procedures/modifyClaims.ts:44
src/api/procedures/modifyToken.ts:5
src/types/index.ts:345
src/types/utils/index.ts:1
src/types/index.ts:482
Identity
NumberedPortfolio
DefaultPortfolio
src/types/index.ts:590
src/types/index.ts:355
TickerOwnerRole
TokenOwnerRole
CddProviderRole
VenueOwnerRole
PortfolioCustodianRole
src/types/index.ts:144
src/types/index.ts:262
Identity
Account
src/types/index.ts:571
src/types/index.ts:340
src/types/index.ts:445
KnownTokenType
src/types/index.ts:166
PlainTransactionArgument
ArrayTransactionArgument
SimpleEnumTransactionArgument
ComplexTransactionArgument
src/types/index.ts:560
src/types/index.ts:276
src/types/index.ts:447
src/utils/conversion.ts:149
src/types/utils/index.ts:10
src/base/PolymeshError.ts:3
src/base/PolymeshError.ts:7
src/base/PolymeshError.ts:9
src/base/PolymeshError.ts:6
Authorization
Claim
CommonKeyring
Condition
ConditionBase
Ensured
IdentityCondition
InstructionDetails
ModifyClaimsParams
ModifyTokenParams
MultiClaimCondition
Mutable
NextKey
PortfolioLike
PrimaryIssuanceAgentCondition
Role
ScopedClaim
Signer
SingleClaimCondition
SubCallback
TokenType
TransactionArgument
UnscopedClaim
UnsubCallback
tickerToDid
tuple
ErrorMessagesPerCode
ScopedClaim
UnscopedClaim
SingleClaimCondition
MultiClaimCondition
IdentityCondition
PrimaryIssuanceAgentCondition
ConditionBase
ConditionBase
ConditionBase
ConditionBase