Skip to main content
Version: 22.1.x

Module: Types

Enumerations​

Interfaces​

References​

AcceptPrimaryKeyRotationParams​

Re-exports AcceptPrimaryKeyRotationParams

AddAssetRequirementParams​

Re-exports AddAssetRequirementParams

AddAssetStatParams​

Re-exports AddAssetStatParams

AddClaimCountStatParams​

Re-exports AddClaimCountStatParams

AddClaimCountTransferRestrictionParams​

Re-exports AddClaimCountTransferRestrictionParams

AddClaimPercentageStatParams​

Re-exports AddClaimPercentageStatParams

AddClaimPercentageTransferRestrictionParams​

Re-exports AddClaimPercentageTransferRestrictionParams

AddClaimsParams​

Re-exports AddClaimsParams

AddCountStatParams​

Re-exports AddCountStatParams

AddCountTransferRestrictionParams​

Re-exports AddCountTransferRestrictionParams

AddInstructionParams​

Re-exports AddInstructionParams

AddInstructionWithVenueIdParams​

Re-exports AddInstructionWithVenueIdParams

AddInstructionsParams​

Re-exports AddInstructionsParams

AddInvestorUniquenessClaimParams​

Re-exports AddInvestorUniquenessClaimParams

AddPercentageStatParams​

Re-exports AddPercentageStatParams

AddPercentageTransferRestrictionParams​

Re-exports AddPercentageTransferRestrictionParams

AddRestrictionParams​

Re-exports AddRestrictionParams

AffirmOrWithdrawInstructionParams​

Re-exports AffirmOrWithdrawInstructionParams

AffirmationStatus​

Re-exports AffirmationStatus

AgentWithGroup​

Re-exports AgentWithGroup

AllowanceOperation​

Re-exports AllowanceOperation

AssetBase​

Re-exports AssetBase

AssetDetails​

Re-exports AssetDetails

AssetTx​

Re-exports AssetTx

AttestPrimaryKeyRotationParams​

Re-exports AttestPrimaryKeyRotationParams

AuthorshipTx​

Re-exports AuthorshipTx

BabeTx​

Re-exports BabeTx

BalancesTx​

Re-exports BalancesTx

BridgeTx​

Re-exports BridgeTx

CaCheckpointType​

Re-exports CaCheckpointType

CapitalDistributionTx​

Re-exports CapitalDistributionTx

CddServiceProvidersTx​

Re-exports CddServiceProvidersTx

CheckpointScheduleParams​

Re-exports CheckpointScheduleParams

CheckpointTx​

Re-exports CheckpointTx

ClaimCountTransferRestrictionInput​

Re-exports ClaimCountTransferRestrictionInput

ClaimOperation​

Re-exports ClaimOperation

ClaimPercentageTransferRestrictionInput​

Re-exports ClaimPercentageTransferRestrictionInput

CommitteeMembershipTx​

Re-exports CommitteeMembershipTx

ComplianceManagerTx​

Re-exports ComplianceManagerTx

ConfigureDividendDistributionParams​

Re-exports ConfigureDividendDistributionParams

ConnectParams​

Re-exports ConnectParams

ContractsTx​

Re-exports ContractsTx

ControllerTransferParams​

Re-exports ControllerTransferParams

CorporateActionDefaultConfig​

Re-exports CorporateActionDefaultConfig

CorporateActionKind​

Re-exports CorporateActionKind

CorporateActionParams​

Renames and re-exports Params

CorporateActionTargets​

Re-exports CorporateActionTargets

CorporateActionTx​

Re-exports CorporateActionTx

CorporateBallotTx​

Re-exports CorporateBallotTx

CountTransferRestrictionInput​

Re-exports CountTransferRestrictionInput

CountryCode​

Re-exports CountryCode

CreateAssetParams​

Re-exports CreateAssetParams

CreateAssetWithTickerParams​

Re-exports CreateAssetWithTickerParams

CreateCheckpointScheduleParams​

Re-exports CreateCheckpointScheduleParams

CreateGroupParams​

Re-exports CreateGroupParams

CreateMultiSigParams​

Re-exports CreateMultiSigParams

CreateTransactionBatchParams​

Re-exports CreateTransactionBatchParams

CreateVenueParams​

Re-exports CreateVenueParams

DecreaseAllowanceParams​

Re-exports DecreaseAllowanceParams

DistributionParticipant​

Re-exports DistributionParticipant

DividendDistributionDetails​

Re-exports DividendDistributionDetails

DividendDistributionParams​

Re-exports DividendDistributionParams

EditClaimsParams​

Re-exports EditClaimsParams

ExecuteManualInstructionParams​

Re-exports ExecuteManualInstructionParams

ExternalAgentsTx​

Re-exports ExternalAgentsTx

GetTransferRestrictionReturnType​

Re-exports GetTransferRestrictionReturnType

GlobalMetadataKey​

Re-exports GlobalMetadataKey

GrandpaTx​

Re-exports GrandpaTx

HistoricAssetTransaction​

Re-exports HistoricAssetTransaction

HistoricInstruction​

Re-exports HistoricInstruction

HistoricSettlement​

Re-exports HistoricSettlement

IdentityBalance​

Re-exports IdentityBalance

IdentityTx​

Re-exports IdentityTx

ImOnlineTx​

Re-exports ImOnlineTx

IncreaseAllowanceParams​

Re-exports IncreaseAllowanceParams

IndicesTx​

Re-exports IndicesTx

InputCaCheckpoint​

Re-exports InputCaCheckpoint

InputTargets​

Re-exports InputTargets

InputTaxWithholding​

Re-exports InputTaxWithholding

InstructionAffirmation​

Re-exports InstructionAffirmation

InstructionAffirmationOperation​

Re-exports InstructionAffirmationOperation

InstructionDetails​

Re-exports InstructionDetails

InstructionEndCondition​

Re-exports InstructionEndCondition

InstructionIdParams​

Re-exports InstructionIdParams

InstructionStatus​

Re-exports InstructionStatus

InstructionStatusResult​

Re-exports InstructionStatusResult

InstructionType​

Re-exports InstructionType

InvestInOfferingParams​

Re-exports InvestInOfferingParams

Investment​

Re-exports Investment

InviteAccountParams​

Re-exports InviteAccountParams

InviteExternalAgentParams​

Re-exports InviteExternalAgentParams

LaunchOfferingParams​

Re-exports LaunchOfferingParams

Leg​

Re-exports Leg

LinkCaDocsParams​

Re-exports LinkCaDocsParams

MetadataDetails​

Re-exports MetadataDetails

MetadataLockStatus​

Re-exports MetadataLockStatus

MetadataSpec​

Re-exports MetadataSpec

MetadataType​

Re-exports MetadataType

MetadataValue​

Re-exports MetadataValue

MetadataValueDetails​

Re-exports MetadataValueDetails

ModifyAssetParams​

Re-exports ModifyAssetParams

ModifyAssetTrustedClaimIssuersAddSetParams​

Re-exports ModifyAssetTrustedClaimIssuersAddSetParams

ModifyAssetTrustedClaimIssuersRemoveParams​

Re-exports ModifyAssetTrustedClaimIssuersRemoveParams

ModifyCaCheckpointParams​

Re-exports ModifyCaCheckpointParams

ModifyCaDefaultConfigParams​

Re-exports ModifyCaDefaultConfigParams

ModifyClaimsParams​

Re-exports ModifyClaimsParams

ModifyComplianceRequirementParams​

Re-exports ModifyComplianceRequirementParams

ModifyCorporateActionsAgentParams​

Re-exports ModifyCorporateActionsAgentParams

ModifyInstructionAffirmationParams​

Re-exports ModifyInstructionAffirmationParams

ModifyMultiSigParams​

Re-exports ModifyMultiSigParams

ModifyOfferingTimesParams​

Re-exports ModifyOfferingTimesParams

ModifyPrimaryIssuanceAgentParams​

Re-exports ModifyPrimaryIssuanceAgentParams

ModifySignerPermissionsParams​

Re-exports ModifySignerPermissionsParams

ModifyVenueParams​

Re-exports ModifyVenueParams

ModuleName​

Re-exports ModuleName

MoveFundsParams​

Re-exports MoveFundsParams

MultiSigDetails​

Re-exports MultiSigDetails

MultiSigProposalDetails​

Re-exports MultiSigProposalDetails

MultiSigTx​

Re-exports MultiSigTx

NftTx​

Re-exports NftTx

OfferingBalanceStatus​

Re-exports OfferingBalanceStatus

OfferingDetails​

Re-exports OfferingDetails

OfferingSaleStatus​

Re-exports OfferingSaleStatus

OfferingStatus​

Re-exports OfferingStatus

OfferingTier​

Re-exports OfferingTier

OfferingTimingStatus​

Re-exports OfferingTimingStatus

PayDividendsParams​

Re-exports PayDividendsParams

PercentageTransferRestrictionInput​

Re-exports PercentageTransferRestrictionInput

PipsTx​

Re-exports PipsTx

PolymeshCommitteeTx​

Re-exports PolymeshCommitteeTx

PolymeshContractsTx​

Re-exports PolymeshContractsTx

PolymeshError​

Re-exports PolymeshError

PolymeshTransaction​

Re-exports PolymeshTransaction

PolymeshTransactionBatch​

Re-exports PolymeshTransactionBatch

PortfolioBalance​

Re-exports PortfolioBalance

PortfolioTx​

Re-exports PortfolioTx

PreimageTx​

Re-exports PreimageTx

ProposalStatus​

Re-exports ProposalStatus

ProtocolFeeTx​

Re-exports ProtocolFeeTx

RedeemTokensParams​

Re-exports RedeemTokensParams

RegisterIdentityParams​

Re-exports RegisterIdentityParams

RegisterMetadataParams​

Re-exports RegisterMetadataParams

RejectInstructionParams​

Re-exports RejectInstructionParams

RelayerTx​

Re-exports RelayerTx

RemoveAssetRequirementParams​

Re-exports RemoveAssetRequirementParams

RemoveAssetStatParams​

Re-exports RemoveAssetStatParams

RemoveBalanceStatParams​

Re-exports RemoveBalanceStatParams

RemoveCheckpointScheduleParams​

Re-exports RemoveCheckpointScheduleParams

RemoveCorporateActionParams​

Re-exports RemoveCorporateActionParams

RemoveCountStatParams​

Re-exports RemoveCountStatParams

RemoveExternalAgentParams​

Re-exports RemoveExternalAgentParams

RemoveScopedBalanceParams​

Re-exports RemoveScopedBalanceParams

RemoveScopedCountParams​

Re-exports RemoveScopedCountParams

RemoveSecondaryAccountsParams​

Re-exports RemoveSecondaryAccountsParams

RenamePortfolioParams​

Re-exports RenamePortfolioParams

ReserveTickerParams​

Re-exports ReserveTickerParams

RevokeClaimsParams​

Re-exports RevokeClaimsParams

RewardsTx​

Re-exports RewardsTx

RotatePrimaryKeyParams​

Re-exports RotatePrimaryKeyParams

ScheduleDetails​

Re-exports ScheduleDetails

SchedulerTx​

Re-exports SchedulerTx

ScopeClaimProof​

Re-exports ScopeClaimProof

SessionTx​

Re-exports SessionTx

SetAllowanceParams​

Re-exports SetAllowanceParams

SetAssetDocumentsParams​

Re-exports SetAssetDocumentsParams

SetAssetRequirementsParams​

Re-exports SetAssetRequirementsParams

SetAssetStatParams​

Re-exports SetAssetStatParams

SetClaimCountTransferRestrictionsParams​

Re-exports SetClaimCountTransferRestrictionsParams

SetClaimPercentageTransferRestrictionsParams​

Re-exports SetClaimPercentageTransferRestrictionsParams

SetCountTransferRestrictionsParams​

Re-exports SetCountTransferRestrictionsParams

SetCustodianParams​

Re-exports SetCustodianParams

SetGroupPermissionsParams​

Re-exports SetGroupPermissionsParams

SetMetadataParams​

Re-exports SetMetadataParams

SetPercentageTransferRestrictionsParams​

Re-exports SetPercentageTransferRestrictionsParams

SetPermissionGroupParams​

Re-exports SetPermissionGroupParams

SetRestrictionsParams​

Re-exports SetRestrictionsParams

SetVenueFilteringParams​

Re-exports SetVenueFilteringParams

SettlementLeg​

Re-exports SettlementLeg

SettlementTx​

Re-exports SettlementTx

StakingTx​

Re-exports StakingTx

StatisticsTx​

Re-exports StatisticsTx

StoTx​

Re-exports StoTx

SubsidizeAccountParams​

Re-exports SubsidizeAccountParams

SubsidyData​

Re-exports SubsidyData

SubsidyWithAllowance​

Re-exports SubsidyWithAllowance

SudoTx​

Re-exports SudoTx

SystemTx​

Re-exports SystemTx

TargetTreatment​

Re-exports TargetTreatment

TaxWithholding​

Re-exports TaxWithholding

TechnicalCommitteeMembershipTx​

Re-exports TechnicalCommitteeMembershipTx

TechnicalCommitteeTx​

Re-exports TechnicalCommitteeTx

TestUtilsTx​

Re-exports TestUtilsTx

TickerReservationDetails​

Re-exports TickerReservationDetails

TickerReservationStatus​

Re-exports TickerReservationStatus

Tier​

Re-exports Tier

TimestampTx​

Re-exports TimestampTx

TransactionsParams​

Re-exports TransactionsParams

TransferAssetOwnershipParams​

Re-exports TransferAssetOwnershipParams

TransferBreakdown​

Re-exports TransferBreakdown

TransferPolyxParams​

Re-exports TransferPolyxParams

TransferRestrictionResult​

Re-exports TransferRestrictionResult

TransferTickerOwnershipParams​

Re-exports TransferTickerOwnershipParams

TreasuryTx​

Re-exports TreasuryTx

TxGroupParams​

Re-exports TxGroupParams

TxTag​

Re-exports TxTag

TxTags​

Re-exports TxTags

UpgradeCommitteeMembershipTx​

Re-exports UpgradeCommitteeMembershipTx

UpgradeCommitteeTx​

Re-exports UpgradeCommitteeTx

UtilityTx​

Re-exports UtilityTx

VenueDetails​

Re-exports VenueDetails

VenueType​

Re-exports VenueType

WaivePermissionsParams​

Re-exports WaivePermissionsParams

Type Aliases​

AccountBalance​

Ƭ AccountBalance: Balance

Defined in​

types/index.ts:736

AddRelayerPayingKeyAuthorizationData​

Ƭ AddRelayerPayingKeyAuthorizationData: Object

Type declaration​

NameType
typeAddRelayerPayingKey
valueSubsidyData

Defined in​

types/index.ts:1123

AttestPrimaryKeyRotationAuthorizationData​

Ƭ AttestPrimaryKeyRotationAuthorizationData: Object

Type declaration​

NameType
typeAttestPrimaryKeyRotation
valueIdentity

Defined in​

types/index.ts:1094

Authorization​

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

Authorization request data corresponding to type

Defined in​

types/index.ts:1144

BecomeAgentAuthorizationData​

Ƭ BecomeAgentAuthorizationData: Object

Type declaration​

NameType
typeBecomeAgent
valueKnownPermissionGroup | CustomPermissionGroup

Defined in​

types/index.ts:1118

Claim​

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in​

types/index.ts:278

ClaimCountStatInput​

Ƭ ClaimCountStatInput: { claimType: Accredited ; issuer: Identity ; value: { accredited: BigNumber ; nonAccredited: BigNumber } } | { claimType: Affiliate ; issuer: Identity ; value: { affiliate: BigNumber ; nonAffiliate: BigNumber } } | { claimType: Jurisdiction ; issuer: Identity ; value: { count: BigNumber ; countryCode: CountryCode }[] }

Defined in​

types/index.ts:1410

Condition​

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

Defined in​

types/index.ts:440

GenericAuthorizationData​

Ƭ GenericAuthorizationData: Object

Type declaration​

NameType
typeExclude<AuthorizationType, RotatePrimaryKey | JoinIdentity | PortfolioCustody | BecomeAgent | AddRelayerPayingKey | RotatePrimaryKeyToSecondary | AttestPrimaryKeyRotation>
valuestring

Defined in​

types/index.ts:1128

GenericPolymeshTransaction​

Ƭ GenericPolymeshTransaction<ProcedureReturnValue, ReturnValue>: PolymeshTransaction<ProcedureReturnValue, ReturnValue> | PolymeshTransactionBatch<ProcedureReturnValue, ReturnValue>

Type parameters​

Name
ProcedureReturnValue
ReturnValue

Defined in​

types/index.ts:1630

GroupPermissions​

Ƭ GroupPermissions: Pick<Permissions, "transactions" | "transactionGroups">

Asset permissions shared by agents in a group

Defined in​

types/index.ts:1001

InputCondition​

Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify <IdentityCondition, { identity: string | Identity }> | ExternalAgentCondition & InputConditionBase

Defined in​

types/index.ts:448

InputConditionBase​

Ƭ InputConditionBase: Modify <ConditionBase, { trustedClaimIssuers?: InputTrustedClaimIssuer[] }>

Defined in​

types/index.ts:411

InputCorporateActionTargets​

Ƭ InputCorporateActionTargets: Modify <CorporateActionTargets, { identities: (string | Identity)[] }>

Targets of a corporate action in a flexible structure for input purposes

Defined in​

types/index.ts:1613

InputCorporateActionTaxWithholdings​

Ƭ InputCorporateActionTaxWithholdings: Modify <TaxWithholding, { identity: string | Identity }>[]

Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes

Defined in​

types/index.ts:1623

InputRequirement​

Ƭ InputRequirement: Modify <Requirement, { conditions: InputCondition[] }>

Defined in​

types/index.ts:474

InputStatClaim​

Ƭ InputStatClaim: StatJurisdictionClaimInput | StatAccreditedClaimInput | StatAffiliateClaimInput

Defined in​

types/index.ts:306

InputStatType​

Ƭ InputStatType: { type: Count | Balance } | { claimIssuer: StatClaimIssuer ; type: ScopedCount | ScopedBalance }

Defined in​

types/index.ts:311

InputTrustedClaimIssuer​

Ƭ InputTrustedClaimIssuer: Modify <TrustedClaimIssuer, { identity: string | Identity }>

Defined in​

types/index.ts:387

InstructionsByStatus​

Ƭ InstructionsByStatus: GroupedInstructions & { partiallyAffirmed: Instruction[] }

Defined in​

types/index.ts:1556

JoinIdentityAuthorizationData​

Ƭ JoinIdentityAuthorizationData: Object

Type declaration​

NameType
typeJoinIdentity
valuePermissions

Defined in​

types/index.ts:1108

MapTxData​

Ƭ MapTxData<ArgsArray>: { [K in keyof ArgsArray]: ArgsArray[K] extends unknown[] ? TxData<ArgsArray[K]> : never }

Apply the TxData type to all args in an array

Type parameters​

NameType
ArgsArrayextends unknown[][]

Defined in​

types/index.ts:1667

MiddlewareScope​

Ƭ MiddlewareScope: Scalars["JSON"]

Defined in​

middleware/typesV1.ts:9

MortalityProcedureOpt​

Ƭ MortalityProcedureOpt: ImmortalProcedureOptValue | MortalProcedureOptValue

Defined in​

types/index.ts:1493

NextKey​

Ƭ NextKey: string | BigNumber | null

Defined in​

types/index.ts:743

PayingAccount​

Ƭ PayingAccount: { account: Account ; allowance: BigNumber ; type: Subsidy } | { account: Account ; type: Caller | Other }

Data representing the Account responsible for paying fees for a transaction

Defined in​

types/index.ts:797

PermissionsLike​

Ƭ PermissionsLike: { assets?: SectionPermissions<string | Asset> | null ; portfolios?: SectionPermissions <PortfolioLike> | null } & { transactions?: TransactionPermissions | null } | { transactionGroups?: TxGroup[] }

Permissions to grant to a Signer over an Identity

Permissions

Note

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

Defined in​

types/index.ts:1243

PortfolioCustodyAuthorizationData​

Ƭ PortfolioCustodyAuthorizationData: Object

Type declaration​

NameType
typePortfolioCustody
valueNumberedPortfolio | DefaultPortfolio

Defined in​

types/index.ts:1113

PortfolioLike​

Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | { id: BigNumber ; identity: string | Identity }

Defined in​

types/index.ts:1229

PrivateKey​

Ƭ PrivateKey: { uri: string } | { mnemonic: string } | { seed: string }

URI|mnemonic|hex representation of a private key

Defined in​

types/index.ts:1599

Role​

Ƭ Role: TickerOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole | IdentityRole

Defined in​

types/index.ts:121

RotatePrimaryKeyAuthorizationData​

Ƭ RotatePrimaryKeyAuthorizationData: Object

Type declaration​

NameType
typeRotatePrimaryKey

Defined in​

types/index.ts:1099

RotatePrimaryKeyToSecondaryData​

Ƭ RotatePrimaryKeyToSecondaryData: Object

Type declaration​

NameType
typeRotatePrimaryKeyToSecondary
valuePermissions

Defined in​

types/index.ts:1103

Scalars​

Ƭ Scalars: Object

All built-in and custom scalars, mapped to their actual values

Type declaration​

NameType
BigFloatany
Booleanboolean
Cursorany
Dateany
Datetimeany
Floatnumber
IDstring
Intnumber
JSONany
Stringstring

Defined in​

middleware/types.ts:7

ScopedClaim​

Ƭ ScopedClaim: JurisdictionClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim

Defined in​

types/index.ts:266

Signer​

Ƭ Signer: Identity | Account

Defined in​

types/index.ts:1211

StatClaimType​

Ƭ StatClaimType: Accredited | Affiliate | Jurisdiction

Defined in​

types/index.ts:289

SubCallback​

Ƭ SubCallback<T>: (result: T) => void | Promise<void>

Type parameters​

Name
T

Type declaration​

▸ (result): void | Promise<void>

Parameters​
NameType
resultT
Returns​

void | Promise<void>

Defined in​

types/index.ts:671

TransactionArgument​

Ƭ TransactionArgument: { _rawType: TypeDef ; name: string ; optional: boolean } & PlainTransactionArgument | ArrayTransactionArgument | SimpleEnumTransactionArgument | ComplexTransactionArgument

Defined in​

types/index.ts:1200

TransactionArray​

Ƭ TransactionArray<ReturnValues>: { [K in keyof ReturnValues]: GenericPolymeshTransaction<any, ReturnValues[K]> }

Type parameters​

NameType
ReturnValuesextends readonly [...unknown[]]

Defined in​

types/index.ts:1634

TransferRestriction​

Ƭ TransferRestriction: { type: Count ; value: BigNumber } | { type: Percentage ; value: BigNumber } | { type: ClaimCount ; value: ClaimCountRestrictionValue } | { type: ClaimPercentage ; value: ClaimPercentageRestrictionValue }

Defined in​

types/index.ts:1372

UnscopedClaim​

Ƭ UnscopedClaim: CddClaim

Defined in​

types/index.ts:276

UnsubCallback​

Ƭ UnsubCallback: () => void

Type declaration​

▸ (): void

Returns​

void

Defined in​

types/index.ts:673

Variables​

middlewareEnumMap​

• Const middlewareEnumMap: Record<string, string>

Defined in​

middleware/enums.ts:21