Globals

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

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:

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:

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:

InvestorUniquenessV2Claim

Ƭ InvestorUniquenessV2Claim: object

Defined in src/types/index.ts:308

Type declaration:

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:

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:

Returns: boolean

Const areSameClaims

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

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

Parameters:

claim: Claim

__namedParameters: object

Returns: boolean

Const areSameTargets

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

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

Parameters:

Returns: boolean

Const convertArgsToRaw

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

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

Parameters:

Returns: object

  • claimIssuersToAdd: [Ticker, TrustedIssuer][]

  • inputDids: string[]

createProcedureMethod

createProcedureMethodMethodArgs, 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

context: Context

Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›

createProcedureMethodMethodArgs, 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

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:

Returns: Claim[]

Const findPositiveBalanceIuClaims

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

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

Parameters:

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:

Returns: string

Const tuple

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

Returns: T

txGroupToTxTags

txGroupToTxTags(group: TxGroup): TxTag[]

Defined in src/utils/conversion.ts:568

Retrieve every Transaction Tag associated to a Transaction Group

Parameters:

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