Polymesh SDK API Reference
v14.1.0
v14.1.0
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Index
  • Enumerations
  • Classes
  • Interfaces
  • Type aliases
  • Variables
  • Functions
  • Object literals
  • Type aliases
  • AccountBalance
  • AddCountTransferRestrictionParams
  • AddPercentageTransferRestrictionParams
  • AddRelayerPayingKeyAuthorizationData
  • AddRestrictionParams
  • ArgsType
  • Authorization
  • BecomeAgentAuthorizationData
  • CheckpointScheduleParams
  • Claim
  • Condition
  • ConfigureDividendDistributionParams
  • Ensured
  • GenericAuthorizationData
  • GetReturnType
  • GroupPermissions
  • HumanReadableType
  • InputCaCheckpoint
  • InputCondition
  • InputConditionBase
  • InputRequirement
  • InputTargets
  • InputTaxWithholding
  • InputTrustedClaimIssuer
  • InstructionDetails
  • InstructionStatusResult
  • JoinIdentityAuthorizationData
  • MapTxAndArgsArray
  • Modify
  • ModifyAllowanceParams
  • ModifyAssetParams
  • ModifyCaDefaultConfigParams
  • ModifyClaimsParams
  • ModifyComplianceRequirementParams
  • ModifyOfferingTimesParams
  • ModifyVenueParams
  • Mutable
  • NextKey
  • PermissionsLike
  • PortfolioCustodyAuthorizationData
  • PortfolioLike
  • PrivateKey
  • ProcedureFunc
  • QueryReturnType
  • Role
  • RotatePrimaryKeyAuthorizationData
  • RotatePrimaryKeyToSecondaryData
  • ScopedClaim
  • SetRestrictionsParams
  • SetTransferRestrictionsParams
  • Signer
  • SubCallback
  • TransactionArgument
  • UnionOfProcedureFuncs
  • UnscopedClaim
  • UnsubCallback
  • WithRequired
  • Variables
  • Const caNotExistsMessage
  • Const executedMessage
  • Const notExistsMessage
  • Functions
  • Const areSameClaimIssuers
  • Const areSameClaims
  • Const areSameTargets
  • assembleBatchTransactions
  • Const convertArgsToRaw
  • createProcedureMethod
  • Const findClaimsByOtherIssuers
  • Const findPositiveBalanceIuClaims
  • isAccount
  • isAccreditedClaim
  • isAffiliateClaim
  • isAsset
  • isAuthorizationRequest
  • isBlockedClaim
  • isBuyLockupClaim
  • isCddClaim
  • isCddProviderRole
  • isCheckpoint
  • isCheckpointSchedule
  • isCorporateAction
  • isCustomPermissionGroup
  • isDefaultPortfolio
  • isDefaultTrustedClaimIssuer
  • isDividendDistribution
  • isEntity
  • isExemptedClaim
  • isIdentity
  • isIdentityCondition
  • isIdentityRole
  • isInstruction
  • isInvestorUniquenessClaim
  • isInvestorUniquenessV2Claim
  • isJurisdictionClaim
  • isKnownPermissionGroup
  • isKycClaim
  • isMultiClaimCondition
  • isNoDataClaim
  • isNumberedPortfolio
  • isOffering
  • isPolymeshError
  • isPolymeshTransaction
  • isPolymeshTransactionBatch
  • isPortfolioCustodianRole
  • isScopedClaim
  • isSellLockupClaim
  • isSingleClaimCondition
  • isTickerOwnerRole
  • isTickerReservation
  • isUnscopedClaim
  • isVenue
  • isVenueOwnerRole
  • tickerToDid
  • Const tuple
  • txGroupToTxTags
  • Object literals
  • Const defaultMessages
  • â–ª defaultMessages: object
  • [ErrorCode.TransactionAborted]
  • [ErrorCode.TransactionRejectedByUser]
  • [ErrorCode.TransactionReverted]

Was this helpful?

Globals

NextClasses

Last updated 2 years ago

Was this helpful?

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccountBalance


AddCountTransferRestrictionParams


AddPercentageTransferRestrictionParams


AddRelayerPayingKeyAuthorizationData

Ƭ AddRelayerPayingKeyAuthorizationData: object

Type declaration:


AddRestrictionParams

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


ArgsType

Ƭ ArgsType: T extends function ? A : never

Less strict version of Parameters


Authorization

Authorization request data corresponding to type


BecomeAgentAuthorizationData

Ƭ BecomeAgentAuthorizationData: object

Type declaration:


CheckpointScheduleParams


Claim


Condition


ConfigureDividendDistributionParams

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


Ensured

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

Pick a single property from T and ensure it is defined


GenericAuthorizationData

Ƭ GenericAuthorizationData: object

Type declaration:

  • value: string


GetReturnType


GroupPermissions

Asset 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)


InputCaCheckpoint


InputCondition


InputConditionBase


InputRequirement


InputTargets


InputTaxWithholding


InputTrustedClaimIssuer


InstructionDetails

Ƭ InstructionDetails: object & object | object


InstructionStatusResult

Ƭ InstructionStatusResult: object | object


JoinIdentityAuthorizationData

Ƭ JoinIdentityAuthorizationData: object

Type declaration:


MapTxAndArgsArray

Ƭ MapTxAndArgsArray: object

Type declaration:


Modify

Ƭ Modify: Omit‹T, keyof R› & R

Override T with the properties of R


ModifyAllowanceParams


ModifyAssetParams

Ƭ ModifyAssetParams: object | object | object | object


ModifyCaDefaultConfigParams

Ƭ ModifyCaDefaultConfigParams: object | object | object


ModifyClaimsParams


ModifyComplianceRequirementParams

Ƭ ModifyComplianceRequirementParams: object

Type declaration:

  • id: BigNumber


ModifyOfferingTimesParams

Ƭ ModifyOfferingTimesParams: object | object | object


ModifyVenueParams

Ƭ ModifyVenueParams: object | object | object


Mutable

Ƭ Mutable: object

Type declaration:


NextKey

Ƭ NextKey: string | BigNumber | null


PermissionsLike

Ƭ 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

Ƭ PortfolioCustodyAuthorizationData: object

Type declaration:


PortfolioLike


PrivateKey

Ƭ PrivateKey: object | object | object

URI|mnemonic|hex representation of a private key


ProcedureFunc

Ƭ ProcedureFunc: function

Type declaration:

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


QueryReturnType

Ƭ 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>


Role


RotatePrimaryKeyAuthorizationData

Ƭ RotatePrimaryKeyAuthorizationData: object

Type declaration:


RotatePrimaryKeyToSecondaryData

Ƭ RotatePrimaryKeyToSecondaryData: object

Type declaration:


ScopedClaim


SetRestrictionsParams

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


SetTransferRestrictionsParams


Signer


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


UnsubCallback

Ƭ UnsubCallback: function

Type declaration:

â–¸ (): void


WithRequired

Ƭ WithRequired: T & object

Ensure a specific property of T is defined

Variables

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"

Functions

Const areSameClaimIssuers

Parameters:

Name
Type

currentClaimIssuers

claimIssuers

ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]

Returns: boolean


Const areSameClaims

Parameters:

â–ª __namedParameters: object

Name
Type

scope

type

ClaimTypeEnum

Returns: boolean


Const areSameTargets

Parameters:

Name
Type

targets

newTargets

Returns: boolean


assembleBatchTransactions

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:

Name
Type

txsAndArgs

Returns: MapTxWithArgs‹unknown[][]›


Const convertArgsToRaw

â–¸ convertArgsToRaw(claimIssuers: ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: Context): object

Parameters:

Name
Type

claimIssuers

ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]

rawTicker

Ticker

context

Context

Returns: object

  • claimIssuersToAdd: [][]

  • inputDids: string[]


createProcedureMethod

Create a method that prepares a procedure

Type parameters:

â–ª ProcedureArgs

â–ª ProcedureReturnValue

â–ª Storage

Parameters:

â–ª args: object

Name
Type

getProcedureAndArgs

function

voidArgs

true

â–ª context: Context

Type parameters:

â–ª ProcedureArgs

â–ª ProcedureReturnValue

â–ª ReturnValue

â–ª Storage

Parameters:

â–ª args: object

Name
Type

getProcedureAndArgs

function

transformer

function

voidArgs

true

â–ª context: Context

Type parameters:

â–ª MethodArgs: object

â–ª ProcedureArgs

â–ª ProcedureReturnValue

â–ª Storage

Parameters:

â–ª args: object

Name
Type

getProcedureAndArgs

function

â–ª context: Context

Type parameters:

â–ª MethodArgs: object

â–ª ProcedureArgs

â–ª ProcedureReturnValue

â–ª ReturnValue

â–ª Storage

Parameters:

â–ª args: object

Name
Type

getProcedureAndArgs

function

transformer

function

â–ª context: Context


Const findClaimsByOtherIssuers

Parameters:

Name
Type

claims

claimsByDid

Record‹string, MiddlewareClaim[]›


Const findPositiveBalanceIuClaims

Parameters:

Name
Type

claims

context

Context


isAccount

â–¸ isAccount(value: unknown): value is Account

Return whether value is an Account

Parameters:

Name
Type

value

unknown

Returns: value is Account


isAccreditedClaim

Return whether Claim is an AccreditedClaim

Parameters:

Name
Type

claim

Returns: claim is AccreditedClaim


isAffiliateClaim

Return whether Claim is an AffiliateClaim

Parameters:

Name
Type

claim

Returns: claim is AffiliateClaim


isAsset

â–¸ isAsset(value: unknown): value is Asset

Return whether value is an Asset

Parameters:

Name
Type

value

unknown

Returns: value is Asset


isAuthorizationRequest

â–¸ isAuthorizationRequest(value: unknown): value is AuthorizationRequest

Return whether value is an AuthorizationRequest

Parameters:

Name
Type

value

unknown

Returns: value is AuthorizationRequest


isBlockedClaim

Return whether Claim is a BlockedClaim

Parameters:

Name
Type

claim

Returns: claim is BlockedClaim


isBuyLockupClaim

Return whether Claim is a BuyLockupClaim

Parameters:

Name
Type

claim

Returns: claim is BuyLockupClaim


isCddClaim

Return whether Claim is a CddClaim

Parameters:

Name
Type

claim

Returns: claim is CddClaim


isCddProviderRole

Return whether Role is CddProviderRole

Parameters:

Name
Type

role

Returns: role is CddProviderRole


isCheckpoint

â–¸ isCheckpoint(value: unknown): value is Checkpoint

Return whether value is a Checkpoint

Parameters:

Name
Type

value

unknown

Returns: value is Checkpoint


isCheckpointSchedule

â–¸ isCheckpointSchedule(value: unknown): value is CheckpointSchedule

Return whether value is a CheckpointSchedule

Parameters:

Name
Type

value

unknown

Returns: value is CheckpointSchedule


isCorporateAction

â–¸ isCorporateAction(value: unknown): value is CorporateAction

Return whether value is a CorporateAction

Parameters:

Name
Type

value

unknown

Returns: value is CorporateAction


isCustomPermissionGroup

â–¸ isCustomPermissionGroup(value: unknown): value is CustomPermissionGroup

Return whether value is a CustomPermissionGroup

Parameters:

Name
Type

value

unknown

Returns: value is CustomPermissionGroup


isDefaultPortfolio

â–¸ isDefaultPortfolio(value: unknown): value is DefaultPortfolio

Return whether value is a DefaultPortfolio

Parameters:

Name
Type

value

unknown

Returns: value is DefaultPortfolio


isDefaultTrustedClaimIssuer

â–¸ isDefaultTrustedClaimIssuer(value: unknown): value is DefaultTrustedClaimIssuer

Return whether value is a DefaultTrustedClaimIssuer

Parameters:

Name
Type

value

unknown

Returns: value is DefaultTrustedClaimIssuer


isDividendDistribution

â–¸ isDividendDistribution(value: unknown): value is DividendDistribution

Return whether value is a DividendDistribution

Parameters:

Name
Type

value

unknown

Returns: value is DividendDistribution


isEntity

▸ isEntity‹Identifiers, HumanReadable›(value: unknown): value is Entity‹Identifiers, HumanReadable›

Return whether value is an Entity

Type parameters:

â–ª Identifiers

â–ª HumanReadable

Parameters:

Name
Type

value

unknown

Returns: value is Entity‹Identifiers, HumanReadable›


isExemptedClaim

Return whether Claim is an ExemptedClaim

Parameters:

Name
Type

claim

Returns: claim is ExemptedClaim


isIdentity

â–¸ isIdentity(value: unknown): value is Identity

Return whether value is an Identity

Parameters:

Name
Type

value

unknown

Returns: value is Identity


isIdentityCondition

Return whether Condition has multiple Claims

Parameters:

Name
Type

condition

Returns: condition is InputConditionBase & IdentityCondition


isIdentityRole

Return whether Role is IdentityRole

Parameters:

Name
Type

role

Returns: role is IdentityRole


isInstruction

â–¸ isInstruction(value: unknown): value is Instruction

Return whether value is an Instruction

Parameters:

Name
Type

value

unknown

Returns: value is Instruction


isInvestorUniquenessClaim

Return whether a Claim is an InvestorUniquenessClaim

Parameters:

Name
Type

claim

Returns: claim is InvestorUniquenessClaim


isInvestorUniquenessV2Claim

Return whether a Claim is an InvestorUniquenessV2Claim

Parameters:

Name
Type

claim

Returns: claim is InvestorUniquenessV2Claim


isJurisdictionClaim

Return whether Claim is a JurisdictionClaim

Parameters:

Name
Type

claim

Returns: claim is JurisdictionClaim


isKnownPermissionGroup

â–¸ isKnownPermissionGroup(value: unknown): value is KnownPermissionGroup

Return whether value is a KnownPermissionGroup

Parameters:

Name
Type

value

unknown

Returns: value is KnownPermissionGroup


isKycClaim

Return whether Claim is a KycClaim

Parameters:

Name
Type

claim

Returns: claim is KycClaim


isMultiClaimCondition

Return whether Condition has multiple Claims

Parameters:

Name
Type

condition

Returns: condition is InputConditionBase & MultiClaimCondition


isNoDataClaim

Return whether Claim is a NoDataClaim

Parameters:

Name
Type

claim

Returns: claim is NoDataClaim


isNumberedPortfolio

â–¸ isNumberedPortfolio(value: unknown): value is NumberedPortfolio

Return whether value is a NumberedPortfolio

Parameters:

Name
Type

value

unknown

Returns: value is NumberedPortfolio


isOffering

â–¸ isOffering(value: unknown): value is Offering

Return whether value is an Offering

Parameters:

Name
Type

value

unknown

Returns: value is Offering


isPolymeshError

â–¸ isPolymeshError(value: unknown): value is PolymeshError

Return whether value is a PolymeshError

Parameters:

Name
Type

value

unknown

Returns: value is PolymeshError


isPolymeshTransaction

â–¸ isPolymeshTransaction(value: unknown): value is PolymeshTransaction

Return whether value is a PolymeshTransaction

Parameters:

Name
Type

value

unknown

Returns: value is PolymeshTransaction


isPolymeshTransactionBatch

â–¸ isPolymeshTransactionBatch(value: unknown): value is PolymeshTransactionBatch

Return whether value is a PolymeshTransactionBatch

Parameters:

Name
Type

value

unknown

Returns: value is PolymeshTransactionBatch


isPortfolioCustodianRole

Return whether Role is PortfolioCustodianRole

Parameters:

Name
Type

role

Returns: role is PortfolioCustodianRole


isScopedClaim

Return whether a Claim is a ScopedClaim

Parameters:

Name
Type

claim

Returns: claim is ScopedClaim


isSellLockupClaim

Return whether Claim is a SellLockupClaim

Parameters:

Name
Type

claim

Returns: claim is SellLockupClaim


isSingleClaimCondition

Return whether Condition has a single Claim

Parameters:

Name
Type

condition

Returns: condition is InputConditionBase & SingleClaimCondition


isTickerOwnerRole

Return whether Role is TickerOwnerRole

Parameters:

Name
Type

role

Returns: role is TickerOwnerRole


isTickerReservation

â–¸ isTickerReservation(value: unknown): value is TickerReservation

Return whether value is a TickerReservation

Parameters:

Name
Type

value

unknown

Returns: value is TickerReservation


isUnscopedClaim

Return whether a Claim is an UnscopedClaim

Parameters:

Name
Type

claim

Returns: claim is UnscopedClaim


isVenue

â–¸ isVenue(value: unknown): value is Venue

Return whether value is a Venue

Parameters:

Name
Type

value

unknown

Returns: value is Venue


isVenueOwnerRole

Return whether Role is VenueOwnerRole

Parameters:

Name
Type

role

Returns: role is VenueOwnerRole


tickerToDid

â–¸ tickerToDid(ticker: string): string

Generate an Asset's DID from a ticker

Parameters:

Name
Type

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:

Name
Type
Description

...args

T

values to turn into a tuple

Returns: T


txGroupToTxTags

Retrieve every Transaction Tag associated to a Transaction Group

Parameters:

Name
Type

group

Returns: TxTag[]

Object literals

Const defaultMessages

â–ª defaultMessages: object

[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)"

[ErrorCode.TransactionRejectedByUser]

• [ErrorCode.TransactionRejectedByUser]: string = "The user canceled the transaction signature"

[ErrorCode.TransactionReverted]

• [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

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

type:

value: |

Ƭ PortfolioLike: string | | | | object

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

AffirmationStatus
AuthorizationType
CaCheckpointType
CalendarUnit
ClaimType
ConditionTarget
ConditionType
CorporateActionKind
CountryCode
ErrorCode
InstructionStatus
InstructionType
KnownAssetType
OfferingBalanceStatus
OfferingSaleStatus
OfferingTimingStatus
PayingAccountType
PermissionGroupType
PermissionType
RoleType
ScopeType
SecurityIdentifierType
SignerType
TargetTreatment
TickerReservationStatus
TransactionArgumentType
TransactionQueueStatus
TransactionStatus
TransferError
TransferRestrictionType
TransferStatus
TxGroup
VenueType
Account
AccountManagement
Asset
AssetHolders
AssetPermissions
Assets
AuthorizationRequest
Authorizations
Checkpoint
CheckpointSchedule
Checkpoints
Claims
Compliance
CorporateAction
CorporateActionBase
CorporateActions
Count
CustomPermissionGroup
DefaultPortfolio
DefaultTrustedClaimIssuer
Distributions
DividendDistribution
Documents
Entity
Identities
Identity
IdentityAuthorizations
Instruction
Issuance
KnownPermissionGroup
Network
NumberedPortfolio
Offering
Offerings
Percentage
PermissionGroup
Permissions
Polymesh
PolymeshError
PolymeshTransaction
PolymeshTransactionBase
PolymeshTransactionBatch
Portfolio
Portfolios
Requirements
Schedules
Settlements
Subsidy
TickerReservation
TransactionQueue
TransferRestrictionBase
TransferRestrictions
TrustedClaimIssuers
Venue
AccreditedClaim
ActiveTransferRestrictions
AddAssetRequirementParams
AddClaimsParams
AddInstructionParams
AddInstructionWithVenueIdParams
AddInstructionsParams
AddInvestorUniquenessClaimParams
AffiliateClaim
AffirmInstructionParams
AgentWithGroup
ArrayTransactionArgument
AssetBase
AssetDetails
AssetDocument
AssetWithGroup
Balance
BlockedClaim
BuyLockupClaim
CalendarPeriod
CalendarPeriodHumanReadable
CddClaim
CddProviderRole
CheckPermissionsResult
CheckRolesResult
CheckpointWithData
ClaimClassicTickerParams
ClaimData
ClaimScope
ClaimTarget
ComplexTransactionArgument
ComplianceRequirements
ConditionBase
ConditionCompliance
ConnectParams
ConstructorParams
ConsumeParams
ControllerTransferParams
CorporateActionDefaultConfig
CorporateActionTargets
CountTransferRestriction
CountTransferRestrictionInput
CreateAssetParams
CreateAssetWithTickerParams
CreateCheckpointScheduleParams
CreateGroupParams
CreateVenueParams
DecreaseAllowanceParams
DeletePortfolioParams
DistributionParticipant
DistributionPayment
DistributionWithDetails
DividendDistributionDetails
DividendDistributionParams
EditClaimsParams
EventIdentifier
ExemptedClaim
ExternalAgentCondition
ExtrinsicData
Fees
FeesBreakdown
GroupedInstructions
HistoricAgentOperation
HistoricSettlement
HumanReadable
IdentityBalance
IdentityCondition
IdentityRole
IdentityWithClaims
IncreaseAllowanceParams
InstructionAffirmation
InvestInOfferingParams
Investment
InvestorUniquenessClaim
InvestorUniquenessV2Claim
InviteAccountParams
InviteExternalAgentParams
IssueTokensParams
JurisdictionClaim
KycClaim
Leg
LinkCaDocsParams
MiddlewareConfig
ModifyAssetTrustedClaimIssuersAddSetParams
ModifyAssetTrustedClaimIssuersRemoveParams
ModifyCorporateActionsAgentParams
ModifyInstructionAffirmationParams
ModifyPrimaryIssuanceAgentParams
ModifySignerPermissionsParams
MoveFundsParams
MultiClaimCondition
NetworkProperties
NoArgsProcedureMethod
NoDataClaim
OfferingDetails
OfferingStatus
OfferingTier
OfferingWithDetails
PaginationOptions
PayDividendsParams
PayingAccount
PercentageTransferRestriction
PercentageTransferRestrictionInput
PermissionGroups
PermissionedAccount
PlainTransactionArgument
PortfolioBalance
PortfolioCustodianRole
PortfolioMovement
ProcedureAuthorizationStatus
ProcedureMethod
ProcedureOpts
QuitSubsidyParams
RedeemTokensParams
RegisterIdentityParams
RemoveAssetRequirementParams
RemoveCheckpointScheduleParams
RemoveCorporateActionParams
RemoveExternalAgentParams
RemoveSecondaryAccountsParams
RenamePortfolioParams
Requirement
RequirementCompliance
ReserveTickerParams
ResultSet
RevokeClaimsParams
ScheduleDetails
ScheduleWithDetails
Scope
SectionPermissions
SecurityIdentifier
SellLockupClaim
SetAllowanceParams
SetAssetDocumentsParams
SetAssetRequirementsParams
SetCountTransferRestrictionsParams
SetCustodianParams
SetGroupPermissionsParams
SetPercentageTransferRestrictionsParams
SetPermissionGroupParams
SettlementLeg
SignerValue
SimpleEnumTransactionArgument
SimplePermissions
SingleClaimCondition
SubsidizeAccountParams
SubsidyData
SubsidyWithAllowance
TaxWithholding
ThirdPartyFees
TickerOwnerRole
TickerReservationDetails
Tier
ToggleFreezeOfferingParams
ToggleFreezeSecondaryAccountsParams
ToggleFreezeTransfersParams
TogglePauseRequirementsParams
TransactionPermissions
TransactionsParams
TransferAssetOwnershipParams
TransferBreakdown
TransferPolyxParams
TransferRestriction
TransferRestrictionInputBase
TransferRestrictionResult
TransferTickerOwnershipParams
TrustedClaimIssuer
TxAndArgsArray
TxGroupParams
UniqueIdentifiers
VenueDetails
VenueOwnerRole
WaivePermissionsParams
Balance
src/types/index.ts:665
CountTransferRestrictionInput
src/api/procedures/addTransferRestriction.ts:21
PercentageTransferRestrictionInput
src/api/procedures/addTransferRestriction.ts:25
src/types/index.ts:1045
AddRelayerPayingKey
SubsidyData
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:35
src/types/utils/index.ts:20
src/types/index.ts:1065
src/types/index.ts:1040
BecomeAgent
KnownPermissionGroup
CustomPermissionGroup
UniqueIdentifiers
src/api/entities/CheckpointSchedule/types.ts:10
src/types/index.ts:299
SingleClaimCondition
MultiClaimCondition
IdentityCondition
ExternalAgentCondition
ConditionBase
src/types/index.ts:403
src/api/procedures/configureDividendDistribution.ts:61
src/types/utils/index.ts:65
src/types/index.ts:1050
Exclude
AuthorizationType
RotatePrimaryKey
JoinIdentity
PortfolioCustody
BecomeAgent
AddRelayerPayingKey
RotatePrimaryKeyToSecondary
ActiveTransferRestrictions
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:49
Permissions
src/types/index.ts:928
src/types/utils/index.ts:26
Checkpoint
CheckpointSchedule
src/api/entities/Asset/Checkpoints/types.ts:10
src/types/index.ts:411
src/types/index.ts:374
src/types/index.ts:437
src/api/entities/CorporateActionBase/types.ts:21
src/api/entities/CorporateActionBase/types.ts:28
src/types/index.ts:350
src/api/entities/Instruction/types.ts:17
src/api/entities/Instruction/types.ts:57
src/types/index.ts:1030
JoinIdentity
Permissions
src/utils/internal.ts:841
src/types/utils/index.ts:55
SetAllowanceParams
IncreaseAllowanceParams
DecreaseAllowanceParams
src/api/procedures/modifyAllowance.ts:32
src/api/procedures/modifyAsset.ts:12
src/api/procedures/modifyCaDefaultConfig.ts:23
AddClaimsParams
EditClaimsParams
RevokeClaimsParams
src/api/procedures/modifyClaims.ts:50
src/api/procedures/modifyComplianceRequirement.ts:11
src/api/procedures/modifyOfferingTimes.ts:63
src/api/procedures/modifyVenue.ts:7
src/types/utils/index.ts:7
src/types/index.ts:672
src/types/index.ts:1163
Permissions
src/types/index.ts:1035
PortfolioCustody
NumberedPortfolio
DefaultPortfolio
Identity
NumberedPortfolio
DefaultPortfolio
src/types/index.ts:1149
src/types/index.ts:1385
src/types/utils/index.ts:11
src/types/utils/index.ts:46
TickerOwnerRole
CddProviderRole
VenueOwnerRole
PortfolioCustodianRole
IdentityRole
src/types/index.ts:123
src/types/index.ts:1021
RotatePrimaryKey
src/types/index.ts:1025
RotatePrimaryKeyToSecondary
Permissions
JurisdictionClaim
InvestorUniquenessClaim
AccreditedClaim
AffiliateClaim
BuyLockupClaim
SellLockupClaim
KycClaim
ExemptedClaim
BlockedClaim
src/types/index.ts:286
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:42
SetCountTransferRestrictionsParams
SetPercentageTransferRestrictionsParams
src/api/procedures/setTransferRestrictions.ts:42
Identity
Account
src/types/index.ts:1131
src/types/index.ts:634
PlainTransactionArgument
ArrayTransactionArgument
SimpleEnumTransactionArgument
ComplexTransactionArgument
src/types/index.ts:1120
src/types/utils/index.ts:13
NoDataClaim
CddClaim
InvestorUniquenessV2Claim
src/types/index.ts:297
src/types/index.ts:636
src/types/utils/index.ts:60
src/api/procedures/removeCorporateAction.ts:33
src/api/entities/Instruction/index.ts:57
src/api/entities/CheckpointSchedule/index.ts:41
src/api/entities/DividendDistribution/index.ts:85
src/api/entities/Portfolio/index.ts:56
TrustedClaimIssuer
src/api/procedures/modifyAssetTrustedClaimIssuers.ts:65
src/api/procedures/modifyClaims.ts:52
src/api/procedures/modifyCaDefaultConfig.ts:45
src/utils/internal.ts:864
src/api/procedures/modifyAssetTrustedClaimIssuers.ts:40
NoArgsProcedureMethod
src/utils/internal.ts:414
NoArgsProcedureMethod
NoArgsProcedureMethod
src/utils/internal.ts:431
NoArgsProcedureMethod
ProcedureMethod
src/utils/internal.ts:450
ProcedureMethod
ProcedureMethod
src/utils/internal.ts:470
ProcedureMethod
src/api/procedures/modifyClaims.ts:62
src/api/procedures/modifyClaims.ts:78
src/utils/typeguards.ts:70
src/utils/typeguards.ts:214
src/utils/typeguards.ts:221
src/utils/typeguards.ts:161
src/utils/typeguards.ts:77
src/utils/typeguards.ts:270
src/utils/typeguards.ts:228
src/utils/typeguards.ts:242
src/utils/typeguards.ts:339
src/utils/typeguards.ts:84
src/utils/typeguards.ts:91
src/utils/typeguards.ts:98
src/utils/typeguards.ts:105
src/utils/typeguards.ts:112
src/utils/typeguards.ts:119
src/utils/typeguards.ts:126
src/utils/typeguards.ts:61
src/utils/typeguards.ts:263
src/utils/typeguards.ts:133
src/utils/typeguards.ts:316
src/utils/typeguards.ts:353
src/utils/typeguards.ts:140
src/utils/typeguards.ts:277
src/utils/typeguards.ts:291
src/utils/typeguards.ts:256
src/utils/typeguards.ts:147
src/utils/typeguards.ts:249
src/utils/typeguards.ts:307
src/utils/typeguards.ts:284
src/utils/typeguards.ts:154
src/utils/typeguards.ts:168
src/utils/typeguards.ts:189
src/utils/typeguards.ts:359
src/utils/typeguards.ts:366
src/utils/typeguards.ts:325
src/utils/typeguards.ts:207
src/utils/typeguards.ts:235
src/utils/typeguards.ts:298
src/utils/typeguards.ts:346
src/utils/typeguards.ts:175
src/utils/typeguards.ts:196
src/utils/typeguards.ts:182
src/utils/typeguards.ts:332
src/utils/conversion.ts:234
src/types/utils/index.ts:72
TxGroup
src/utils/conversion.ts:624
src/base/PolymeshError.ts:3
src/base/PolymeshError.ts:7
src/base/PolymeshError.ts:9
src/base/PolymeshError.ts:6
AccountBalance
AddCountTransferRestrictionParams
AddPercentageTransferRestrictionParams
AddRelayerPayingKeyAuthorizationData
AddRestrictionParams
ArgsType
Authorization
BecomeAgentAuthorizationData
CheckpointScheduleParams
Claim
Condition
ConfigureDividendDistributionParams
Ensured
GenericAuthorizationData
GetReturnType
GroupPermissions
HumanReadableType
InputCaCheckpoint
InputCondition
InputConditionBase
InputRequirement
InputTargets
InputTaxWithholding
InputTrustedClaimIssuer
InstructionDetails
InstructionStatusResult
JoinIdentityAuthorizationData
MapTxAndArgsArray
Modify
ModifyAllowanceParams
ModifyAssetParams
ModifyCaDefaultConfigParams
ModifyClaimsParams
ModifyComplianceRequirementParams
ModifyOfferingTimesParams
ModifyVenueParams
Mutable
NextKey
PermissionsLike
PortfolioCustodyAuthorizationData
PortfolioLike
PrivateKey
ProcedureFunc
QueryReturnType
Role
RotatePrimaryKeyAuthorizationData
RotatePrimaryKeyToSecondaryData
ScopedClaim
SetRestrictionsParams
SetTransferRestrictionsParams
Signer
SubCallback
TransactionArgument
UnionOfProcedureFuncs
UnscopedClaim
UnsubCallback
WithRequired
caNotExistsMessage
executedMessage
notExistsMessage
areSameClaimIssuers
areSameClaims
areSameTargets
assembleBatchTransactions
convertArgsToRaw
createProcedureMethod
findClaimsByOtherIssuers
findPositiveBalanceIuClaims
isAccount
isAccreditedClaim
isAffiliateClaim
isAsset
isAuthorizationRequest
isBlockedClaim
isBuyLockupClaim
isCddClaim
isCddProviderRole
isCheckpoint
isCheckpointSchedule
isCorporateAction
isCustomPermissionGroup
isDefaultPortfolio
isDefaultTrustedClaimIssuer
isDividendDistribution
isEntity
isExemptedClaim
isIdentity
isIdentityCondition
isIdentityRole
isInstruction
isInvestorUniquenessClaim
isInvestorUniquenessV2Claim
isJurisdictionClaim
isKnownPermissionGroup
isKycClaim
isMultiClaimCondition
isNoDataClaim
isNumberedPortfolio
isOffering
isPolymeshError
isPolymeshTransaction
isPolymeshTransactionBatch
isPortfolioCustodianRole
isScopedClaim
isSellLockupClaim
isSingleClaimCondition
isTickerOwnerRole
isTickerReservation
isUnscopedClaim
isVenue
isVenueOwnerRole
tickerToDid
tuple
txGroupToTxTags
defaultMessages
RotatePrimaryKeyAuthorizationData
JoinIdentityAuthorizationData
PortfolioCustodyAuthorizationData
BecomeAgentAuthorizationData
AddRelayerPayingKeyAuthorizationData
RotatePrimaryKeyToSecondaryData
GenericAuthorizationData
ScopedClaim
UnscopedClaim
SingleClaimCondition
MultiClaimCondition
IdentityCondition
ExternalAgentCondition
Modify
InputConditionBase
ConditionBase
Modify
Requirement
Modify
CorporateActionTargets
Modify
TaxWithholding
Modify
TrustedClaimIssuer
Modify
InputCondition
Claim
Claim
CorporateActionTargets
InputTargets
MapTxAndArgsArray
ClaimTarget
Claim
Claim
ClaimTarget
Claim
Claim
Claim
Claim
Claim
Claim
Claim
Role
Claim
InputCondition
Role
Claim
Claim
Claim
Claim
InputCondition
Claim
Role
Claim
Claim
InputCondition
Role
Claim
Role
TrustedClaimIssuer
Scope
CorporateActionTargets
ClaimTarget
ClaimTarget
TxGroup
InputTargets
MapTxAndArgsArray
Claim
Claim
Claim
Claim
Claim
Role
Claim
InputCondition
Role
Claim
Claim
Claim
Claim
InputCondition
Claim
Role
Claim
Claim
InputCondition
Role
Claim
Role