Globals
Index
Enumerations
Classes
Interfaces
Type aliases
Variables
Functions
Object literals
Type aliases
AccountBalance
Ƭ AccountBalance: Balance
Defined in src/types/index.ts:593
AddCountTransferRestrictionParams
Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object
Defined in src/api/procedures/addTransferRestriction.ts:23
AddPairParams
Ƭ AddPairParams: object
Defined in src/base/Context.ts:91
Type declaration:
accountMnemonic? : undefined | string
accountSeed? : undefined | string
accountUri? : undefined | string
pair? : KeyringPair
AddPercentageTransferRestrictionParams
Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object
Defined in src/api/procedures/addTransferRestriction.ts:27
AddRestrictionParams
Ƭ AddRestrictionParams: Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:32
ArgsType
Ƭ ArgsType: T extends function ? A : never
Defined in src/types/utils/index.ts:22
Less strict version of Parameters
Authorization
Ƭ Authorization: object | object | object | object | object | object
Defined in src/types/index.ts:880
Authorization request data corresponding to type
CddClaim
Ƭ CddClaim: object
Defined in src/types/index.ts:271
Type declaration:
id: string
type: CustomerDueDiligence
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:302
CommonKeyring
Ƭ CommonKeyring: Pick‹Keyring, "getPair" | "getPairs" | "addFromSeed" | "addFromUri" | "addFromMnemonic" | "addPair" | "encodeAddress"›
Defined in src/types/index.ts:562
Condition
Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition
Defined in src/types/index.ts:392
ConditionBase
Ƭ ConditionBase: object
Defined in src/types/index.ts:371
Type declaration:
target: ConditionTarget
trustedClaimIssuers? : TrustedClaimIssuer[]
ConfigureDividendDistributionParams
Ƭ ConfigureDividendDistributionParams: Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object
Defined in src/api/procedures/configureDividendDistribution.ts:62
Ensured
Ƭ Ensured: Required‹Pick‹T, K››
Defined in src/types/index.ts:555
ExternalAgentCondition
Ƭ ExternalAgentCondition: ConditionBase & object
Defined in src/types/index.ts:388
GetReturnType
Ƭ GetReturnType: ActiveTransferRestrictions‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:46
GroupPermissions
Ƭ GroupPermissions: Pick‹Permissions, "transactions" | "transactionGroups"›
Defined in src/types/index.ts:815
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
Defined in src/types/utils/index.ts:28
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
Defined in src/types/index.ts:383
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:17
InstructionStatusResult
Ƭ InstructionStatusResult: object | object
Defined in src/api/entities/Instruction/types.ts:58
InvestorUniquenessClaim
Ƭ InvestorUniquenessClaim: object
Defined in src/types/index.ts:273
Type declaration:
cddId: string
scope: Scope
scopeId: string
type: InvestorUniqueness
InvestorUniquenessV2Claim
Ƭ InvestorUniquenessV2Claim: object
Defined in src/types/index.ts:280
Type declaration:
cddId: string
type: InvestorUniquenessV2
ModifyCaDefaultsParams
Ƭ ModifyCaDefaultsParams: object | object | object
Defined in src/api/procedures/modifyCaDefaults.ts:23
ModifyClaimsParams
Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams
Defined in src/api/procedures/modifyClaims.ts:63
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:8
MultiClaimCondition
Ƭ MultiClaimCondition: ConditionBase & object
Defined in src/types/index.ts:378
Mutable
Ƭ Mutable: object
Defined in src/types/utils/index.ts:5
Type declaration:
NextKey
Ƭ NextKey: string | number | null
Defined in src/types/index.ts:600
PermissionsLike
Ƭ PermissionsLike: object & object | object
Defined in src/types/index.ts:995
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
Defined in src/types/index.ts:981
ProcedureFunc
Ƭ ProcedureFunc: function
Defined in src/types/utils/index.ts:9
Type declaration:
▸ (): Procedure‹Args, ReturnValue, Storage›
Role
Ƭ Role: TickerOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole | IdentityRole
Defined in src/types/index.ts:120
ScopedClaim
Ƭ ScopedClaim: object | InvestorUniquenessClaim | object
Defined in src/types/index.ts:285
SetRestrictionsParams
Ƭ SetRestrictionsParams: Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:39
SetTransferRestrictionsParams
Ƭ SetTransferRestrictionsParams: object & SetCountTransferRestrictionsParams | SetPercentageTransferRestrictionsParams
Defined in src/api/procedures/setTransferRestrictions.ts:39
Signer
Defined in src/types/index.ts:957
SingleClaimCondition
Ƭ SingleClaimCondition: ConditionBase & object
Defined in src/types/index.ts:373
SubCallback
Ƭ SubCallback: function
Defined in src/types/index.ts:551
Type declaration:
▸ (result: T): void | Promise‹void›
Parameters:
result
T
TransactionArgument
Ƭ TransactionArgument: object & PlainTransactionArgument | ArrayTransactionArgument | SimpleEnumTransactionArgument | ComplexTransactionArgument
Defined in src/types/index.ts:946
UnionOfProcedureFuncs
Ƭ UnionOfProcedureFuncs: Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never
Defined in src/types/utils/index.ts:15
UnscopedClaim
Ƭ UnscopedClaim: object | CddClaim | InvestorUniquenessV2Claim
Defined in src/types/index.ts:300
UnsubCallback
Ƭ UnsubCallback: function
Defined in src/types/index.ts:553
Type declaration:
▸ (): void
Variables
Const executedMessage
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"
Defined in src/api/entities/Instruction/index.ts:57
Const notExistsMessage
Const notExistsMessage• notExistsMessage: "The Dividend Distribution no longer exists" = "The Dividend Distribution no longer exists"
Defined in src/api/entities/Portfolio/index.ts:51
Defined in src/api/entities/CheckpointSchedule/index.ts:36
Defined in src/api/entities/DividendDistribution/index.ts:81
Functions
Const areSameClaimIssuers
Const areSameClaimIssuers▸ areSameClaimIssuers(currentClaimIssuers: TrustedClaimIssuer[], claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean
Defined in src/api/procedures/modifyTokenTrustedClaimIssuers.ts:71
Parameters:
currentClaimIssuers
claimIssuers
ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]
Returns: boolean
Const areSameClaims
Const areSameClaims▸ areSameClaims(claim: Claim, __namedParameters: object): boolean
Defined in src/api/procedures/modifyClaims.ts:74
Parameters:
▪ claim: Claim
▪ __namedParameters: object
scope
undefined | null | Scope
type
ClaimTypeEnum
Returns: boolean
Const areSameTargets
Const areSameTargets▸ areSameTargets(targets: CorporateActionTargets, newTargets: InputTargets): boolean
Defined in src/api/procedures/modifyCaDefaults.ts:45
Parameters:
targets
newTargets
Returns: boolean
Const convertArgsToRaw
Const convertArgsToRaw▸ convertArgsToRaw(claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: Context): object
Defined in src/api/procedures/modifyTokenTrustedClaimIssuers.ts:42
Parameters:
Returns: object
claimIssuersToAdd: [][]
inputDids: string[]
createProcedureMethod
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
Defined in src/utils/internal.ts:411
Create a method that prepares a procedure
Type parameters:
▪ MethodArgs
▪ ProcedureArgs: unknown
▪ ProcedureReturnValue
▪ Storage
Parameters:
▪ args: object
getProcedureAndArgs
function
▪ context: Context
Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›
Defined in src/utils/internal.ts:430
Type parameters:
▪ MethodArgs
▪ ProcedureArgs: unknown
▪ ProcedureReturnValue
▪ ReturnValue
▪ Storage
Parameters:
▪ args: object
getProcedureAndArgs
function
transformer
function
▪ context: Context
Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›
Const findClaimsByOtherIssuers
Const findClaimsByOtherIssuers▸ findClaimsByOtherIssuers(claims: ClaimTarget[], claimsByDid: Record‹string, MiddlewareClaim[]›): Claim[]
Defined in src/api/procedures/modifyClaims.ts:84
Parameters:
claims
claimsByDid
Record‹string, MiddlewareClaim[]›
Returns: Claim[]
Const findPositiveBalanceIuClaims
Const findPositiveBalanceIuClaims▸ findPositiveBalanceIuClaims(claims: ClaimTarget[], context: Context): Promise‹Claim[]›
Defined in src/api/procedures/modifyClaims.ts:100
Parameters:
claims
context
Returns: Promise‹Claim[]›
tickerToDid
▸ tickerToDid(ticker: string): string
Defined in src/utils/conversion.ts:230
Generate a Security Token's DID from a ticker
Parameters:
ticker
string
Returns: string
toHumanReadable
▸ toHumanReadable‹T›(obj: T): HumanReadableType‹T›
Defined in src/utils/internal.ts:689
Recursively convert a value into a human readable (JSON compliant) version:
Entities are converted via their
.toJsonmethodDates are converted to ISO strings
BigNumbers are converted to numerical strings
Type parameters:
▪ T
Parameters:
obj
T
Returns: HumanReadableType‹T›
Const tuple
Const tuple▸ tuple‹T›(...args: T): T
Defined in src/types/utils/index.ts:48
Create a literal tuple type from a list of arguments
Type parameters:
▪ T: unknown[]
Parameters:
...args
T
values to turn into a tuple
Returns: T
txGroupToTxTags
▸ txGroupToTxTags(group: TxGroup): TxTag[]
Defined in src/utils/conversion.ts:595
Retrieve every Transaction Tag associated to a Transaction Group
Parameters:
group
Returns: TxTag[]
Object literals
Const defaultMessages
Const defaultMessages▪ defaultMessages: 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
Was this helpful?