Last updated
Was this helpful?
Last updated
Was this helpful?
Ƭ AddPairParams: object
accountMnemonic? : undefined | string
accountSeed? : undefined | string
accountUri? : undefined | string
Ƭ AddRestrictionParams: Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›
Ƭ ArgsType: T extends function ? A : never
Less strict version of Parameters
Ƭ Authorization: object | object | object | object | object
Authorization request data corresponding to type
Ƭ CddClaim: object
id: string
Ƭ CheckpointScheduleParams: Omit‹UniqueIdentifiers & Params, "ticker"›
Ƭ CommonKeyring: Pick‹Keyring, "getPair" | "getPairs" | "addFromSeed" | "addFromUri" | "addFromMnemonic" | "addPair" | "encodeAddress"›
Ƭ ConditionBase: object
Ƭ ConfigureDividendDistributionParams: Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object
Ƭ Ensured: Required‹Pick‹T, K››
Ƭ GroupPermissions: Pick‹Permissions, "transactions" | "transactionGroups"›
Security Token permissions shared by agents in a group
Ƭ 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)
Ƭ InstructionDetails: object & object | object
Ƭ InstructionStatusResult: object | object
Ƭ InvestorUniquenessClaim: object
cddId: string
scopeId: string
Ƭ InvestorUniquenessV2Claim: object
cddId: string
Ƭ ModifyCaDefaultsParams: object | object | object
Ƭ ModifyStoTimesParams: object | object | object
Ƭ ModifyTokenParams: object | object | object | object
Ƭ ModifyVenueParams: object | object | object
Ƭ Mutable: object
Ƭ NextKey: string | number | null
Ƭ PermissionsLike: object & object | object
Permissions to grant to a Signer over an Identity
note TxGroups in the transactionGroups array will be transformed into their corresponding TxTags
Ƭ ProcedureFunc: function
▸ (): Procedure‹Args, ReturnValue, Storage›
Ƭ SetRestrictionsParams: Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›
Ƭ SubCallback: function
▸ (result: T): void | Promise‹void›
Parameters:
Type of security that the token represents
Ƭ UnionOfProcedureFuncs: Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never
Ƭ UnsubCallback: function
▸ (): void
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: "Schedule no longer exists. It was either removed or it expired" = "Schedule no longer exists. It was either removed or it expired"
Const areSameClaimIssuersParameters:
Returns: boolean
Const areSameClaimsParameters:
▪ __namedParameters: object
Returns: boolean
Const areSameTargetsParameters:
Returns: boolean
Const convertArgsToRawParameters:
Returns: object
claimIssuersToAdd: [][]
inputDids: string[]
Create a method that prepares a procedure
Type parameters:
▪ MethodArgs
▪ ProcedureArgs: unknown
▪ ProcedureReturnValue
▪ Storage
Parameters:
▪ args: object
Type parameters:
▪ MethodArgs
▪ ProcedureArgs: unknown
▪ ProcedureReturnValue
▪ ReturnValue
▪ Storage
Parameters:
▪ args: object
Const findClaimsByOtherIssuersParameters:
Const findPositiveBalanceIuClaimsParameters:
▸ tickerToDid(ticker: string): string
Generate a Security Token's DID from a ticker
Parameters:
Returns: string
Recursively convert a value into a human readable (JSON compliant) version:
Entities are converted via their .toJson method
Dates are converted to ISO strings
BigNumbers are converted to numerical strings
Type parameters:
▪ T
Parameters:
Const tuple▸ tuple‹T›(...args: T): T
Create a literal tuple type from a list of arguments
Type parameters:
▪ T: unknown[]
Parameters:
Returns: T
Retrieve every Transaction Tag associated to a Transaction Group
Parameters:
Returns: TxTag[]
Const defaultMessages• [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)"
• [ErrorCode.TransactionRejectedByUser]: string = "The user canceled the transaction signature"
• [ErrorCode.TransactionReverted]: string = "The transaction execution reverted due to an error"
Ƭ AccountBalance:
Defined in
Ƭ AddCountTransferRestrictionParams: & object
Defined in
Defined in
pair? :
Ƭ AddPercentageTransferRestrictionParams: & object
Defined in
Defined in
Defined in
Defined in
Defined in
type:
Defined in
Ƭ Claim: |
Defined in
Defined in
Ƭ Condition: | | |
Defined in
Defined in
target:
trustedClaimIssuers? : []
Defined in
Defined in
Ƭ ExternalAgentCondition: & object
Defined in
Ƭ GetReturnType: ‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›
Defined in
Defined in
Defined in
Ƭ IdentityCondition: & object
Defined in
Ƭ InputTargets: Omit‹, "identities"› & object
Defined in
Ƭ InputTaxWithholding: Omit‹, "identity"› & object
Defined in
Defined in
Defined in
Defined in
scope:
type:
Defined in
type:
Defined in
Ƭ ModifyClaimsParams: | |
Defined in
Defined in
Defined in
Defined in
Ƭ MultiClaimCondition: & object
Defined in
Defined in
Defined in
Defined in
link
Ƭ PortfolioLike: string | | | | object
Defined in
Defined in
Ƭ Role: | | |
Defined in
Ƭ ScopedClaim: object | | object
Defined in
Defined in
Ƭ SetTransferRestrictionsParams: object & |
Defined in
Ƭ Signer: |
Defined in
Ƭ SingleClaimCondition: & object
Defined in
Defined in
Ƭ TokenType: | object
Defined in
Ƭ TransactionArgument: object & | | |
Defined in
Defined in
Ƭ UnscopedClaim: object | |
Defined in
Defined in
Defined in
Defined in
▸ areSameClaimIssuers(currentClaimIssuers: [], claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean
Defined in
▸ areSameClaims(claim: , __namedParameters: object): boolean
Defined in
▪ claim:
▸ areSameTargets(targets: , newTargets: ): boolean
Defined in
▸ convertArgsToRaw(claimIssuers: ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: ): object
Defined in
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: ): ‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
Defined in
▪ context:
Returns: ‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: ): ‹MethodArgs, ProcedureReturnValue, ReturnValue›
Defined in
▪ context:
Returns: ‹MethodArgs, ProcedureReturnValue, ReturnValue›
▸ findClaimsByOtherIssuers(claims: [], claimsByDid: Record‹string, MiddlewareClaim[]›): []
Defined in
Returns: []
▸ findPositiveBalanceIuClaims(claims: [], context: ): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ toHumanReadable‹T›(obj: T): ‹T›
Defined in
Returns: ‹T›
Defined in
▸ txGroupToTxTags(group: ): TxTag[]
Defined in
Defined in
Defined in
Defined in
Defined in
Name
Type
result
T
Name
Type
getProcedureAndArgs
function
Name
Type
getProcedureAndArgs
function
transformer
function
Name
Type
ticker
string
Name
Type
obj
T
Name
Type
Description
...args
T
values to turn into a tuple
Name
Type
currentClaimIssuers
claimIssuers
ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]
Name
Type
scope
type
ClaimTypeEnum
Name
Type
targets
newTargets
Name
Type
claimIssuers
ModifyTokenTrustedClaimIssuersAddSetParams["claimIssuers"]
rawTicker
Ticker
context
Name
Type
claims
claimsByDid
Record‹string, MiddlewareClaim[]›
Name
Type
claims
context
Name
Type
group
[]
undefined | null |
[]
[]