Globals
Last updated
Was this helpful?
Last updated
Was this helpful?
Ƭ AddRelayerPayingKeyAuthorizationData: object
Ƭ AddRestrictionParams: Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›
Ƭ ArgsType: T extends function ? A : never
Less strict version of Parameters
Authorization request data corresponding to type
Ƭ BecomeAgentAuthorizationData: object
Ƭ ConfigureDividendDistributionParams: Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object
Ƭ Ensured: Required‹Pick‹T, K››
Pick a single property from T and ensure it is defined
Ƭ EnsuredV2: Required‹Pick‹T, K›› & object
Ƭ GenericAuthorizationData: object
value: string
Asset 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 .toHuman had been called on all of them)
Ƭ InstructionDetails: object & object | object
Ƭ InstructionStatusResult: object | object
Ƭ JoinIdentityAuthorizationData: object
Ƭ MapTxAndArgsArray: object
Ƭ Modify: Omit‹T, keyof R› & R
Override T with the properties of R
Ƭ ModifyAssetParams: object | object | object | object
Ƭ ModifyCaDefaultConfigParams: object | object | object
Ƭ ModifyComplianceRequirementParams: object
id: BigNumber
Ƭ ModifyOfferingTimesParams: object | object | object
Ƭ ModifyVenueParams: object | object | object
Ƭ Mutable: object
Ƭ NextKey: string | BigNumber | null
Ƭ PaginatedQueryArgs: T & object
Ƭ 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
Ƭ PortfolioCustodyAuthorizationData: object
Ƭ PrivateKey: object | object | object
URI|mnemonic|hex representation of a private key
Ƭ ProcedureFunc: function
▸ (): Procedure‹Args, ReturnValue, Storage›
Ƭ QueryArgs: object
Ƭ QueryReturnType: T extends AugmentedQuery‹"promise", infer Fun› ? ReturnType‹Fun› extends Observable‹infer R› ? R : never : never
Extract the return type of a polkadot.js query function
example QueryReturnType<typeof identity.authorizations> returns Option<Authorization>
Ƭ RotatePrimaryKeyAuthorizationData: object
Ƭ RotatePrimaryKeyToSecondaryData: object
Ƭ SetRestrictionsParams: Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›
Ƭ SubCallback: function
▸ (result: T): void | Promise‹void›
Parameters:
result
T
Ƭ UnionOfProcedureFuncs: Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never
Ƭ UnsubCallback: function
â–¸ (): void
Ƭ WithRequired: T & object
Ensure a specific property of T is defined
Const caNotExistsMessage• caNotExistsMessage: "The Corporate Action doesn't exist" = "The Corporate Action doesn't exist"
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 Portfolio doesn't exist or was removed by its owner" = "The Portfolio doesn't exist or was removed by its owner"
Const areSameClaimIssuersParameters:
currentClaimIssuers
claimIssuers
ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]
Returns: boolean
Const areSameClaimsParameters:
â–ª __namedParameters: object
scope
type
ClaimTypeEnum
Returns: boolean
Const areSameTargetsParameters:
targets
newTargets
Returns: boolean
Assemble the transactions array that has to be passed to addBatchTransaction from a set of parameter arrays with their respective transaction
Type parameters:
â–ª ArgsArray: unknown[][]
Parameters:
txsAndArgs
Returns: MapTxWithArgs‹unknown[][]›
Const convertArgsToRawâ–¸ convertArgsToRaw(claimIssuers: ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: Context): object
Parameters:
claimIssuers
ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]
rawTicker
Ticker
context
Context
Returns: object
claimIssuersToAdd: [][]
inputDids: string[]
Create a method that prepares a procedure
Type parameters:
â–ª ProcedureArgs
â–ª ProcedureReturnValue
â–ª Storage
Parameters:
â–ª args: object
getProcedureAndArgs
function
voidArgs
true
â–ª context: Context
Type parameters:
â–ª ProcedureArgs
â–ª ProcedureReturnValue
â–ª ReturnValue
â–ª Storage
Parameters:
â–ª args: object
getProcedureAndArgs
function
transformer
function
voidArgs
true
â–ª context: Context
Type parameters:
â–ª MethodArgs: object
â–ª ProcedureArgs
â–ª ProcedureReturnValue
â–ª Storage
Parameters:
â–ª args: object
getProcedureAndArgs
function
â–ª context: Context
Type parameters:
â–ª MethodArgs: object
â–ª ProcedureArgs
â–ª ProcedureReturnValue
â–ª ReturnValue
â–ª Storage
Parameters:
â–ª args: object
getProcedureAndArgs
function
transformer
function
â–ª context: Context
Const findClaimsByOtherIssuersParameters:
claims
claimsByDid
Record‹string, MiddlewareClaim[]›
Const findPositiveBalanceIuClaimsParameters:
claims
context
Context
â–¸ isAccount(value: unknown): value is Account
Return whether value is an Account
Parameters:
value
unknown
Returns: value is Account
Return whether Claim is an AccreditedClaim
Parameters:
claim
Returns: claim is AccreditedClaim
Return whether Claim is an AffiliateClaim
Parameters:
claim
Returns: claim is AffiliateClaim
â–¸ isAsset(value: unknown): value is Asset
Return whether value is an Asset
Parameters:
value
unknown
Returns: value is Asset
â–¸ isAuthorizationRequest(value: unknown): value is AuthorizationRequest
Return whether value is an AuthorizationRequest
Parameters:
value
unknown
Returns: value is AuthorizationRequest
Return whether Claim is a BlockedClaim
Parameters:
claim
Returns: claim is BlockedClaim
Return whether Claim is a BuyLockupClaim
Parameters:
claim
Returns: claim is BuyLockupClaim
Return whether Claim is a CddClaim
Parameters:
claim
Returns: claim is CddClaim
Return whether Role is CddProviderRole
Parameters:
role
Returns: role is CddProviderRole
â–¸ isCheckpoint(value: unknown): value is Checkpoint
Return whether value is a Checkpoint
Parameters:
value
unknown
Returns: value is Checkpoint
â–¸ isCheckpointSchedule(value: unknown): value is CheckpointSchedule
Return whether value is a CheckpointSchedule
Parameters:
value
unknown
Returns: value is CheckpointSchedule
â–¸ isCorporateAction(value: unknown): value is CorporateAction
Return whether value is a CorporateAction
Parameters:
value
unknown
Returns: value is CorporateAction
â–¸ isCustomPermissionGroup(value: unknown): value is CustomPermissionGroup
Return whether value is a CustomPermissionGroup
Parameters:
value
unknown
Returns: value is CustomPermissionGroup
â–¸ isDefaultPortfolio(value: unknown): value is DefaultPortfolio
Return whether value is a DefaultPortfolio
Parameters:
value
unknown
Returns: value is DefaultPortfolio
â–¸ isDefaultTrustedClaimIssuer(value: unknown): value is DefaultTrustedClaimIssuer
Return whether value is a DefaultTrustedClaimIssuer
Parameters:
value
unknown
Returns: value is DefaultTrustedClaimIssuer
â–¸ isDividendDistribution(value: unknown): value is DividendDistribution
Return whether value is a DividendDistribution
Parameters:
value
unknown
Returns: value is DividendDistribution
▸ isEntity‹Identifiers, HumanReadable›(value: unknown): value is Entity‹Identifiers, HumanReadable›
Return whether value is an Entity
Type parameters:
â–ª Identifiers
â–ª HumanReadable
Parameters:
value
unknown
Returns: value is Entity‹Identifiers, HumanReadable›
Return whether Claim is an ExemptedClaim
Parameters:
claim
Returns: claim is ExemptedClaim
â–¸ isIdentity(value: unknown): value is Identity
Return whether value is an Identity
Parameters:
value
unknown
Returns: value is Identity
Return whether Condition has multiple Claims
Parameters:
condition
Returns: condition is InputConditionBase & IdentityCondition
Return whether Role is IdentityRole
Parameters:
role
Returns: role is IdentityRole
â–¸ isInstruction(value: unknown): value is Instruction
Return whether value is an Instruction
Parameters:
value
unknown
Returns: value is Instruction
Return whether a Claim is an InvestorUniquenessClaim
Parameters:
claim
Returns: claim is InvestorUniquenessClaim
Return whether a Claim is an InvestorUniquenessV2Claim
Parameters:
claim
Returns: claim is InvestorUniquenessV2Claim
Return whether Claim is a JurisdictionClaim
Parameters:
claim
Returns: claim is JurisdictionClaim
â–¸ isKnownPermissionGroup(value: unknown): value is KnownPermissionGroup
Return whether value is a KnownPermissionGroup
Parameters:
value
unknown
Returns: value is KnownPermissionGroup
Return whether Claim is a KycClaim
Parameters:
claim
Returns: claim is KycClaim
Return whether Condition has multiple Claims
Parameters:
condition
Returns: condition is InputConditionBase & MultiClaimCondition
Return whether Claim is a NoDataClaim
Parameters:
claim
Returns: claim is NoDataClaim
â–¸ isNumberedPortfolio(value: unknown): value is NumberedPortfolio
Return whether value is a NumberedPortfolio
Parameters:
value
unknown
Returns: value is NumberedPortfolio
â–¸ isOffering(value: unknown): value is Offering
Return whether value is an Offering
Parameters:
value
unknown
Returns: value is Offering
â–¸ isPolymeshError(value: unknown): value is PolymeshError
Return whether value is a PolymeshError
Parameters:
value
unknown
Returns: value is PolymeshError
â–¸ isPolymeshTransaction(value: unknown): value is PolymeshTransaction
Return whether value is a PolymeshTransaction
Parameters:
value
unknown
Returns: value is PolymeshTransaction
â–¸ isPolymeshTransactionBatch(value: unknown): value is PolymeshTransactionBatch
Return whether value is a PolymeshTransactionBatch
Parameters:
value
unknown
Returns: value is PolymeshTransactionBatch
Return whether Role is PortfolioCustodianRole
Parameters:
role
Returns: role is PortfolioCustodianRole
Return whether a Claim is a ScopedClaim
Parameters:
claim
Returns: claim is ScopedClaim
Return whether Claim is a SellLockupClaim
Parameters:
claim
Returns: claim is SellLockupClaim
Return whether Condition has a single Claim
Parameters:
condition
Returns: condition is InputConditionBase & SingleClaimCondition
Return whether Role is TickerOwnerRole
Parameters:
role
Returns: role is TickerOwnerRole
â–¸ isTickerReservation(value: unknown): value is TickerReservation
Return whether value is a TickerReservation
Parameters:
value
unknown
Returns: value is TickerReservation
Return whether a Claim is an UnscopedClaim
Parameters:
claim
Returns: claim is UnscopedClaim
â–¸ isVenue(value: unknown): value is Venue
Return whether value is a Venue
Parameters:
value
unknown
Returns: value is Venue
Return whether Role is VenueOwnerRole
Parameters:
role
Returns: role is VenueOwnerRole
â–¸ tickerToDid(ticker: string): string
Generate an Asset's DID from a ticker
Parameters:
ticker
string
Returns: string
Const tuple▸ tuple‹T›(...args: T): T
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
Retrieve every Transaction Tag associated to a Transaction Group
Parameters:
group
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
Ƭ AddPercentageTransferRestrictionParams: & object
Defined in
Defined in
type:
value:
Defined in
Defined in
Ƭ Authorization: | | | | | |
Defined in
Defined in
type:
value: |
Ƭ CheckpointScheduleParams: Omit‹ & Params, "ticker"›
Defined in
Ƭ Claim: |
Defined in
Ƭ Condition: | | | &
Defined in
Defined in
Defined in
Defined in
Defined in
type: ‹, | | | | | ›
Ƭ GetReturnType: ‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›
Defined in
Ƭ GroupPermissions: Pick‹, "transactions" | "transactionGroups"›
Defined in
Defined in
Ƭ InputCaCheckpoint: | | Date | object | object
Defined in
Ƭ InputCondition: | | ‹, object› | &
Defined in
Ƭ InputConditionBase: ‹, object›
Defined in
Ƭ InputRequirement: ‹, object›
Defined in
Ƭ InputTargets: ‹, object›
Defined in
Ƭ InputTaxWithholding: ‹, object›
Defined in
Ƭ InputTrustedClaimIssuer: ‹, object›
Defined in
Defined in
Defined in
Defined in
type:
value:
Defined in
Defined in
Ƭ ModifyAllowanceParams: | | & object
Defined in
Defined in
Defined in
Ƭ ModifyClaimsParams: | |
Defined in
Defined in
conditions: []
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
type:
value: |
Ƭ PortfolioLike: string | | | | object
Defined in
Defined in
Defined in
Defined in
Defined in
Ƭ Role: | | | |
Defined in
Defined in
type:
Defined in
type:
value:
Ƭ ScopedClaim: | | | | | | | |
Defined in
Defined in
Ƭ SetTransferRestrictionsParams: object & |
Defined in
Ƭ Signer: |
Defined in
Defined in
Ƭ TransactionArgument: object & | | |
Defined in
Defined in
Ƭ UnscopedClaim: | |
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
â–¸ areSameClaimIssuers(currentClaimIssuers: [], claimIssuers: ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean
Defined in
[]
â–¸ areSameClaims(claim: , __namedParameters: object): boolean
Defined in
â–ª claim:
undefined | null |
â–¸ areSameTargets(targets: , newTargets: ): boolean
Defined in
▸ assembleBatchTransactions‹ArgsArray›(txsAndArgs: ‹ArgsArray›): MapTxWithArgs‹unknown[][]›
Defined in
‹ArgsArray›
Defined in
▸ createProcedureMethod‹ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): ‹ProcedureReturnValue, ProcedureReturnValue›
Defined in
Returns: ‹ProcedureReturnValue, ProcedureReturnValue›
▸ createProcedureMethod‹ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): ‹ProcedureReturnValue, ReturnValue›
Defined in
Returns: ‹ProcedureReturnValue, ReturnValue›
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): ‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
Defined in
Returns: ‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): ‹MethodArgs, ProcedureReturnValue, ReturnValue›
Defined in
Returns: ‹MethodArgs, ProcedureReturnValue, ReturnValue›
▸ findClaimsByOtherIssuers(claims: [], claimsByDid: Record‹string, MiddlewareClaim[]›): []
Defined in
[]
Returns: []
▸ findPositiveBalanceIuClaims(claims: [], context: Context): Promise‹[]›
Defined in
[]
Returns: Promise‹[]›
Defined in
â–¸ isAccreditedClaim(claim: ): claim is AccreditedClaim
Defined in
â–¸ isAffiliateClaim(claim: ): claim is AffiliateClaim
Defined in
Defined in
Defined in
â–¸ isBlockedClaim(claim: ): claim is BlockedClaim
Defined in
â–¸ isBuyLockupClaim(claim: ): claim is BuyLockupClaim
Defined in
â–¸ isCddClaim(claim: ): claim is CddClaim
Defined in
â–¸ isCddProviderRole(role: ): role is CddProviderRole
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
â–¸ isExemptedClaim(claim: ): claim is ExemptedClaim
Defined in
Defined in
â–¸ isIdentityCondition(condition: ): condition is InputConditionBase & IdentityCondition
Defined in
â–¸ isIdentityRole(role: ): role is IdentityRole
Defined in
Defined in
â–¸ isInvestorUniquenessClaim(claim: ): claim is InvestorUniquenessClaim
Defined in
â–¸ isInvestorUniquenessV2Claim(claim: ): claim is InvestorUniquenessV2Claim
Defined in
â–¸ isJurisdictionClaim(claim: ): claim is JurisdictionClaim
Defined in
Defined in
â–¸ isKycClaim(claim: ): claim is KycClaim
Defined in
â–¸ isMultiClaimCondition(condition: ): condition is InputConditionBase & MultiClaimCondition
Defined in
â–¸ isNoDataClaim(claim: ): claim is NoDataClaim
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
â–¸ isPortfolioCustodianRole(role: ): role is PortfolioCustodianRole
Defined in
â–¸ isScopedClaim(claim: ): claim is ScopedClaim
Defined in
â–¸ isSellLockupClaim(claim: ): claim is SellLockupClaim
Defined in
â–¸ isSingleClaimCondition(condition: ): condition is InputConditionBase & SingleClaimCondition
Defined in
â–¸ isTickerOwnerRole(role: ): role is TickerOwnerRole
Defined in
Defined in
â–¸ isUnscopedClaim(claim: ): claim is UnscopedClaim
Defined in
Defined in
â–¸ isVenueOwnerRole(role: ): role is VenueOwnerRole
Defined in
Defined in
Defined in
â–¸ txGroupToTxTags(group: ): TxTag[]
Defined in
Defined in
Defined in
Defined in
Defined in