Globals

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

Authorization

Ƭ Authorization: object | object | object | object

Defined in src/types/index.ts:214

Authorization request data corresponding to type

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in src/types/index.ts:267

CommonKeyring

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

Defined in src/types/index.ts:434

Condition

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | PrimaryIssuanceAgentCondition

Defined in src/types/index.ts:338

ConditionBase

Ƭ ConditionBase: object

Defined in src/types/index.ts:317

Type declaration:

Ensured

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

Defined in src/types/index.ts:427

IdentityCondition

Ƭ IdentityCondition: ConditionBase & object

Defined in src/types/index.ts:329

InstructionDetails

Ƭ InstructionDetails: object & object | object

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

ModifyClaimsParams

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

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

ModifyTokenParams

Ƭ ModifyTokenParams: object | object | object

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

MultiClaimCondition

Ƭ MultiClaimCondition: ConditionBase & object

Defined in src/types/index.ts:324

Mutable

Ƭ Mutable: object

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

Type declaration:

NextKey

Ƭ NextKey: string | number | null

Defined in src/types/index.ts:460

PortfolioLike

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

Defined in src/types/index.ts:555

PrimaryIssuanceAgentCondition

Ƭ PrimaryIssuanceAgentCondition: ConditionBase & object

Defined in src/types/index.ts:334

Role

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

Defined in src/types/index.ts:144

ScopedClaim

Ƭ ScopedClaim: object | object

Defined in src/types/index.ts:259

Signer

Ƭ Signer: Identity | Account

Defined in src/types/index.ts:542

SingleClaimCondition

Ƭ SingleClaimCondition: ConditionBase & object

Defined in src/types/index.ts:319

SubCallback

Ƭ SubCallback: function

Defined in src/types/index.ts:423

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

TransactionSpecArray

Ƭ TransactionSpecArray: object

Defined in src/base/TransactionQueue.ts:31

Type declaration:

UnscopedClaim

Ƭ UnscopedClaim: object | object

Defined in src/types/index.ts:263

UnsubCallback

Ƭ UnsubCallback: function

Defined in src/types/index.ts:425

Type declaration:

▸ (): void

Functions

tickerToDid

tickerToDid(ticker: string): string

Defined in src/utils/conversion.ts:132

Generate a Security Token's DID from a ticker

Parameters:

Name

Type

ticker

string

Returns: string

Const tuple

tupleT›(...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

Last updated