Globals

Index

Enumerations

• 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

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

Interfaces

• 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

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

• caNotExistsMessage

• executedMessage

• notExistsMessage

Functions

• 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

Object literals

• defaultMessages

Type aliases

AccountBalance

Ƭ AccountBalance: Balance

Defined in src/types/index.ts:665

---

AddCountTransferRestrictionParams

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object

Defined in src/api/procedures/addTransferRestriction.ts:21

---

AddPercentageTransferRestrictionParams

Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object

Defined in src/api/procedures/addTransferRestriction.ts:25

---

AddRelayerPayingKeyAuthorizationData

Ƭ AddRelayerPayingKeyAuthorizationData: object

Defined in src/types/index.ts:1045

Type declaration:

• type: AddRelayerPayingKey

• value: SubsidyData

---

AddRestrictionParams

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

Defined in src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:35

---

ArgsType

Ƭ ArgsType: T extends function ? A : never

Defined in src/types/utils/index.ts:20

Less strict version of Parameters

---

Authorization

Ƭ Authorization: RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData

Defined in src/types/index.ts:1065

Authorization request data corresponding to type

---

BecomeAgentAuthorizationData

Ƭ BecomeAgentAuthorizationData: object

Defined in src/types/index.ts:1040

Type declaration:

• type: BecomeAgent

• value: KnownPermissionGroup | CustomPermissionGroup

---

CheckpointScheduleParams

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

Defined in src/api/entities/CheckpointSchedule/types.ts:10

---

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in src/types/index.ts:299

---

Condition

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase

Defined in src/types/index.ts:403

---

ConfigureDividendDistributionParams

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

Defined in src/api/procedures/configureDividendDistribution.ts:61

---

Ensured

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

Defined in src/types/utils/index.ts:65

Pick a single property from T and ensure it is defined

---

GenericAuthorizationData

Ƭ GenericAuthorizationData: object

Defined in src/types/index.ts:1050

Type declaration:

• type: Exclude‹AuthorizationType, RotatePrimaryKey | JoinIdentity | PortfolioCustody | BecomeAgent | AddRelayerPayingKey | RotatePrimaryKeyToSecondary›

• value: string

---

GetReturnType

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

Defined in src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:49

---

GroupPermissions

Ƭ GroupPermissions: Pick‹Permissions, "transactions" | "transactionGroups"›

Defined in src/types/index.ts:928

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

Defined in src/types/utils/index.ts:26

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

Ƭ InputCaCheckpoint: Checkpoint | CheckpointSchedule | Date | object | object

Defined in src/api/entities/Asset/Checkpoints/types.ts:10

---

InputCondition

Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify‹IdentityCondition, object› | ExternalAgentCondition & InputConditionBase

Defined in src/types/index.ts:411

---

InputConditionBase

Ƭ InputConditionBase: Modify‹ConditionBase, object›

Defined in src/types/index.ts:374

---

InputRequirement

Ƭ InputRequirement: Modify‹Requirement, object›

Defined in src/types/index.ts:437

---

InputTargets

Ƭ InputTargets: Modify‹CorporateActionTargets, object›

Defined in src/api/entities/CorporateActionBase/types.ts:21

---

InputTaxWithholding

Ƭ InputTaxWithholding: Modify‹TaxWithholding, object›

Defined in src/api/entities/CorporateActionBase/types.ts:28

---

InputTrustedClaimIssuer

Ƭ InputTrustedClaimIssuer: Modify‹TrustedClaimIssuer, object›

Defined in src/types/index.ts:350

---

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:57

---

JoinIdentityAuthorizationData

Ƭ JoinIdentityAuthorizationData: object

Defined in src/types/index.ts:1030

Type declaration:

• type: JoinIdentity

• value: Permissions

---

MapTxAndArgsArray

Ƭ MapTxAndArgsArray: object

Defined in src/utils/internal.ts:841

Type declaration:

---

Modify

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

Defined in src/types/utils/index.ts:55

Override T with the properties of R

---

ModifyAllowanceParams

Ƭ ModifyAllowanceParams: SetAllowanceParams | IncreaseAllowanceParams | DecreaseAllowanceParams & object

Defined in src/api/procedures/modifyAllowance.ts:32

---

ModifyAssetParams

Ƭ ModifyAssetParams: object | object | object | object

Defined in src/api/procedures/modifyAsset.ts:12

---

ModifyCaDefaultConfigParams

Ƭ ModifyCaDefaultConfigParams: object | object | object

Defined in src/api/procedures/modifyCaDefaultConfig.ts:23

---

ModifyClaimsParams

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

Defined in src/api/procedures/modifyClaims.ts:50

---

ModifyComplianceRequirementParams

Ƭ ModifyComplianceRequirementParams: object

Defined in src/api/procedures/modifyComplianceRequirement.ts:11

Type declaration:

• conditions: InputCondition[]

• id: BigNumber

---

ModifyOfferingTimesParams

Ƭ ModifyOfferingTimesParams: object | object | object

Defined in src/api/procedures/modifyOfferingTimes.ts:63

---

ModifyVenueParams

Ƭ ModifyVenueParams: object | object | object

Defined in src/api/procedures/modifyVenue.ts:7

---

Mutable

Ƭ Mutable: object

Defined in src/types/utils/index.ts:7

Type declaration:

---

NextKey

Ƭ NextKey: string | BigNumber | null

Defined in src/types/index.ts:672

---

PermissionsLike

Ƭ PermissionsLike: object & object | object

Defined in src/types/index.ts:1163

Permissions to grant to a Signer over an Identity

Permissions

note TxGroups in the transactionGroups array will be transformed into their corresponding TxTags

---

PortfolioCustodyAuthorizationData

Ƭ PortfolioCustodyAuthorizationData: object

Defined in src/types/index.ts:1035

Type declaration:

• type: PortfolioCustody

• value: NumberedPortfolio |