Globals

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccountBalance

Ƭ AccountBalance: Balance

AddCountTransferRestrictionParams

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object

AddPairParams

Ƭ AddPairParams: object

Type declaration:

  • accountMnemonic? : undefined | string
  • accountSeed? : undefined | string
  • accountUri? : undefined | string
  • pair? : KeyringPair

AddPercentageTransferRestrictionParams

Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object

AddRestrictionParams

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

ArgsType

Ƭ ArgsType: T extends function ? A : never
Less strict version of Parameters

Authorization

Ƭ Authorization: object | object | object | object | object | object
Authorization request data corresponding to type

CddClaim

Ƭ CddClaim: object

Type declaration:

CheckpointScheduleParams

Ƭ CheckpointScheduleParams: Omit‹UniqueIdentifiers & Params, "ticker"›

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

CommonKeyring

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

Condition

ConditionBase

Ƭ ConditionBase: object

Type declaration:

ConfigureDividendDistributionParams

Ƭ ConfigureDividendDistributionParams: Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object

Ensured

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

ExternalAgentCondition

Ƭ ExternalAgentCondition: ConditionBase & object

GetReturnType

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

GroupPermissions

Ƭ GroupPermissions: Pick‹Permissions, "transactions" | "transactionGroups"›
Security Token permissions shared by agents in a group

HumanReadableType

Ƭ HumanReadableType: T extends Entity‹unknown, infer H› ? HumanReadableType‹H› : T extends BigNumber ? string : T extends Date ? string : T extends object ? object : T
Recursively traverse a type and transform its Entity properties into their human readable version (as if .toJson had been called on all of them)

IdentityCondition

Ƭ IdentityCondition: ConditionBase & object

InputTargets

Ƭ InputTargets: Omit‹CorporateActionTargets, "identities"› & object

InputTaxWithholding

Ƭ InputTaxWithholding: Omit‹TaxWithholding, "identity"› & object

InstructionDetails

Ƭ InstructionDetails: object & object | object

InstructionStatusResult

Ƭ InstructionStatusResult: object | object

InvestorUniquenessClaim

Ƭ InvestorUniquenessClaim: object

Type declaration:

InvestorUniquenessV2Claim

Ƭ InvestorUniquenessV2Claim: object

Type declaration:

ModifyCaDefaultsParams

Ƭ ModifyCaDefaultsParams: object | object | object

ModifyClaimsParams

ModifyStoTimesParams

Ƭ ModifyStoTimesParams: object | object | object

ModifyTokenParams

Ƭ ModifyTokenParams: object | object | object | object

ModifyVenueParams

Ƭ ModifyVenueParams: object | object | object

MultiClaimCondition

Ƭ MultiClaimCondition: ConditionBase & object

Mutable

Ƭ Mutable: object

Type declaration:

NextKey

Ƭ NextKey: string | number | null

PermissionsLike

Ƭ PermissionsLike: object & object | object
Permissions to grant to a Signer over an Identity
link Permissions
note TxGroups in the transactionGroups array will be transformed into their corresponding TxTags

PortfolioLike

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

ProcedureFunc

Ƭ ProcedureFunc: function

Type declaration:

▸ (): Procedure‹Args, ReturnValue, Storage›

Role

ScopedClaim

Ƭ ScopedClaim: object | InvestorUniquenessClaim | object

SetRestrictionsParams

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

SetTransferRestrictionsParams

Ƭ SetTransferRestrictionsParams: object & SetCountTransferRestrictionsParams | SetPercentageTransferRestrictionsParams

Signer

Ƭ Signer: Identity | Account

SingleClaimCondition

Ƭ SingleClaimCondition: ConditionBase & object

SubCallback

Ƭ SubCallback: function

Type declaration:

▸ (result: T): void | Promise‹void›
Parameters:
Name
Type
result
T

TransactionArgument

UnionOfProcedureFuncs

Ƭ UnionOfProcedureFuncs: Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never

UnscopedClaim

Ƭ UnscopedClaim: object | CddClaim | InvestorUniquenessV2Claim

UnsubCallback

Ƭ UnsubCallback: function

Type declaration:

▸ (): void

Variables

Const executedMessage

executedMessage: "Instruction has already been executed/rejected and it was purged from chain" = "Instruction has already been executed/rejected and it was purged from chain"

Const notExistsMessage

notExistsMessage: "The Dividend Distribution no longer exists" = "The Dividend Distribution no longer exists"

Functions

Const areSameClaimIssuers

areSameClaimIssuers(currentClaimIssuers: TrustedClaimIssuer[], claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean
Parameters:
Name
Type
currentClaimIssuers
claimIssuers
ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]
Returns: boolean

Const areSameClaims

areSameClaims(claim: Claim, __namedParameters: object): boolean
Parameters:
claim: Claim
__namedParameters: object
Name
Type
scope
undefined | null | Scope
type
ClaimTypeEnum
Returns: boolean

Const areSameTargets

areSameTargets(targets: CorporateActionTargets, newTargets: InputTargets): boolean
Parameters:
Name
Type
newTargets
Returns: boolean

Const convertArgsToRaw

convertArgsToRaw(claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: Context): object
Parameters:
Name
Type
claimIssuers
ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]
rawTicker
Ticker
context
Context
Returns: object
  • claimIssuersToAdd: [][]
  • inputDids: string[]

createProcedureMethod

createProcedureMethodMethodArgs, ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
Create a method that prepares a procedure
Type parameters:
MethodArgs
ProcedureArgs: unknown
ProcedureReturnValue
Storage
Parameters:
args: object
Name
Type
getProcedureAndArgs
function
context: Context
Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
createProcedureMethodMethodArgs, ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›
Type parameters:
MethodArgs
ProcedureArgs: unknown
ProcedureReturnValue
ReturnValue
Storage
Parameters:
args: object
Name
Type
getProcedureAndArgs
function
transformer
function
context: Context
Returns: