Globals

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

AddCountTransferRestrictionParams

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object

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

AddPercentageTransferRestrictionParams

Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object

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

AddRestrictionParams

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

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

Authorization

Ƭ Authorization: object | object | object | object

Defined in src/types/index.ts:232

Authorization request data corresponding to type

CddClaim

Ƭ CddClaim: object

Defined in src/types/index.ts:278

Type declaration:

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in src/types/index.ts:303

CommonKeyring

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

Defined in src/types/index.ts:487

Condition

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | PrimaryIssuanceAgentCondition

Defined in src/types/index.ts:389

ConditionBase

Ƭ ConditionBase: object

Defined in src/types/index.ts:368

Type declaration:

Ensured

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

Defined in src/types/index.ts:480

GetReturnType

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

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

IdentityCondition

Ƭ IdentityCondition: ConditionBase & object

Defined in src/types/index.ts:380

InstructionDetails

Ƭ InstructionDetails: object & object | object

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

InvestorUniquenessClaim

Ƭ InvestorUniquenessClaim: object

Defined in src/types/index.ts:280

Type declaration:

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

MultiClaimCondition

Ƭ MultiClaimCondition: ConditionBase & object

Defined in src/types/index.ts:375

Mutable

Ƭ Mutable: object

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

Type declaration:

NextKey

Ƭ NextKey: string | number | null

Defined in src/types/index.ts:516

PortfolioLike

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

Defined in src/types/index.ts:705

PrimaryIssuanceAgentCondition

Ƭ PrimaryIssuanceAgentCondition: ConditionBase & object

Defined in src/types/index.ts:385

Role

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

Defined in src/types/index.ts:159

ScopedClaim

Ƭ ScopedClaim: object | InvestorUniquenessClaim | object

Defined in src/types/index.ts:287

SetRestrictionsParams

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

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

SetTransferRestrictionsParams

Ƭ SetTransferRestrictionsParams: object & SetCountTransferRestrictionsParams | SetPercentageTransferRestrictionsParams

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

Signer

Ƭ Signer: Identity | Account

Defined in src/types/index.ts:615

SingleClaimCondition

Ƭ SingleClaimCondition: ConditionBase & object

Defined in src/types/index.ts:370

SubCallback

Ƭ SubCallback: function

Defined in src/types/index.ts:476

Type declaration:

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

Parameters:

Name

Type

result

T

TokenType

Ƭ TokenType: KnownTokenType | object

Defined in src/types/index.ts:182

Type of security that the token represents

TransactionArgument

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

Defined in src/types/index.ts:604

UnionOfProcedures

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

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

UnscopedClaim

Ƭ UnscopedClaim: object | CddClaim

Defined in src/types/index.ts:301

UnsubCallback

Ƭ UnsubCallback: function

Defined in src/types/index.ts:478

Type declaration:

▸ (): void

Functions

Const areSameClaimIssuers

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

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

Parameters:

Name

Type

currentClaimIssuers

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

type

ClaimTypeEnum

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

Returns: object

  • claimIssuersToAdd: [Ticker, TrustedIssuer][]

  • inputDids: string[]

createProcedureMethod

createProcedureMethodMethodArgs, ProcedureArgs, ReturnValue, Storage›(getProcedureAndArgs: function, context: Context): ProcedureMethod‹MethodArgs, ReturnValue›

Defined in src/utils/internal.ts:377

Create a method that prepares a procedure

Type parameters:

MethodArgs

ProcedureArgs: unknown

ReturnValue

Storage

Parameters:

getProcedureAndArgs: function

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

Parameters:

Name

Type

args

MethodArgs

context: Context

Returns: ProcedureMethod‹MethodArgs, ReturnValue›

Const findClaimsByOtherIssuers

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

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

Parameters:

Name

Type

claims

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

context

Returns: Promise‹Claim[]›

tickerToDid

tickerToDid(ticker: string): string

Defined in src/utils/conversion.ts:181

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

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

Retrieve every Transaction Tag associated to a Transaction Group

Parameters:

Name

Type

group

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

Last updated