Skip to content

api.procedures.types

Jump to bottom
polymesh-bot edited this page Jun 19, 2025 · 87 revisions

Module: api/procedures/types

Table of contents

Enumerations

Interfaces

Type Aliases

Type Aliases

AddAssetStatParams

Ƭ AddAssetStatParams: { asset: FungibleAsset } & AddCountStatParams | AddPercentageStatParams | AddClaimCountStatParams | AddClaimPercentageStatParams

Defined in

api/procedures/types.ts:460

AddClaimCountStatParams

Ƭ AddClaimCountStatParams: ClaimCountStatInput & { type: ScopedCount }

Defined in

api/procedures/types.ts:452

AddClaimCountTransferRestrictionParams

Ƭ AddClaimCountTransferRestrictionParams: ClaimCountTransferRestrictionInput & { type: ClaimCount }

Defined in

api/procedures/types.ts:576

AddClaimPercentageStatParams

Ƭ AddClaimPercentageStatParams: StatClaimIssuer & { type: ScopedBalance }

Defined in

api/procedures/types.ts:456

AddClaimPercentageTransferRestrictionParams

Ƭ AddClaimPercentageTransferRestrictionParams: ClaimPercentageTransferRestrictionInput & { type: ClaimPercentage }

Defined in

api/procedures/types.ts:580

AddCountStatParams

Ƭ AddCountStatParams: AddCountStatInput & { type: Count }

Defined in

api/procedures/types.ts:444

AddCountTransferRestrictionParams

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & { type: Count }

Defined in

api/procedures/types.ts:568

AddInstructionParams

Ƭ AddInstructionParams: { legs: InstructionLeg[] ; mediators?: (string | Identity)[] ; memo?: string ; tradeDate?: Date ; valueDate?: Date } & { endBlock?: BigNumber } | { endAfterBlock?: BigNumber }

Defined in

api/procedures/types.ts:977

AddInstructionWithVenueIdParams

Ƭ AddInstructionWithVenueIdParams: AddInstructionParams & { venueId?: BigNumber }

Defined in

api/procedures/types.ts:1020

AddPercentageStatParams

Ƭ AddPercentageStatParams: Object

Type declaration

Name Type
type Balance

Defined in

api/procedures/types.ts:448

AddPercentageTransferRestrictionParams

Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & { type: Percentage }

Defined in

api/procedures/types.ts:572

AddRestrictionParams

Ƭ AddRestrictionParams<T>: Omit<T extends Count ? AddCountTransferRestrictionParams : T extends Percentage ? AddPercentageTransferRestrictionParams : T extends ClaimCount ? AddClaimCountTransferRestrictionParams : AddClaimPercentageTransferRestrictionParams, "type">

Type parameters

Name
T

Defined in

api/procedures/types.ts:405

AffirmAsMediatorParams

Ƭ AffirmAsMediatorParams: Object

Type declaration

Name Type
expiry? Date

Defined in

api/procedures/types.ts:1103

AffirmInstructionParams

Ƭ AffirmInstructionParams: Object

Type declaration

Name Type Description
portfolios? PortfolioLike[] (optional) Portfolios that the signer controls and wants to affirm the instruction Note if empty, all the legs containing any custodied Portfolios of the signer will be affirmed
receipts? OffChainAffirmationReceipt[] (optional) list of offchain receipts required for affirming offchain legs(if any) in the instruction Receipt can be generated using generateOffChainAffirmationReceipt method

Defined in

api/procedures/types.ts:1087

AllowIdentityToCreatePortfoliosParams

Ƭ AllowIdentityToCreatePortfoliosParams: Object

Type declaration

Name Type
did Identity | string

Defined in

api/procedures/types.ts:1778

CastBallotVoteParams

Ƭ CastBallotVoteParams: Object

Type declaration

Name Type Description
votes BallotVote[][] The votes to be cast. Note Votes for all motion choices must be provided.

Defined in

api/procedures/types.ts:1898

CollectionKeyInput

Ƭ CollectionKeyInput: GlobalCollectionKeyInput | LocalCollectionKeyInput

Global key must be registered. local keys must provide a specification as they are created with the NftCollection

Defined in

api/procedures/types.ts:768

CorporateBallotParams

Ƭ CorporateBallotParams: Omit<CreateBallotParams, "declarationDate" | "rcv"> & { declarationDate: Date ; rcv: boolean }

Defined in

api/procedures/types.ts:1887

GenericPolymeshTransaction

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

Type parameters

Name
ProcedureReturnValue
ReturnValue

Defined in

api/procedures/types.ts:247

GetTransferRestrictionReturnType

Ƭ GetTransferRestrictionReturnType<T>: ActiveTransferRestrictions<T extends Count ? CountTransferRestriction : T extends Percentage ? PercentageTransferRestriction : T extends ClaimCount ? ClaimCountTransferRestriction : ClaimPercentageTransferRestriction>

Type parameters

Name
T

Defined in

api/procedures/types.ts:427

InitiateCorporateActionParams

Ƭ InitiateCorporateActionParams: Object

Type declaration

Name Type Description
checkpoint InputCaCheckpoint | null The checkpoint of the Corporate Action (the record date on which the Corporate Action is applied)
declarationDate Date The date on which the Corporate Action is declared
defaultTaxWithholding BigNumber | null The default tax withholding to be applied to the Corporate Action
description string The description of the Corporate Action
kind CorporateActionKind The kind of Corporate Action to initiate
targets InputCorporateActionTargets | null The targets of the Corporate Action
taxWithholdings InputTaxWithholding[] The tax withholdings to be applied to the Corporate Action

Defined in

api/procedures/types.ts:1906

InputCorporateActionTargets

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

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

Defined in

api/procedures/types.ts:230

InputCorporateActionTaxWithholdings

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

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

Defined in

api/procedures/types.ts:240

InstructionLeg

Ƭ InstructionLeg: InstructionFungibleLeg | InstructionNftLeg | InstructionOffChainLeg

Defined in

api/procedures/types.ts:975

IssueNftParams

Ƭ IssueNftParams: Object

Type declaration

Name Type Description
metadata NftMetadataInput[] -
portfolioId? BigNumber portfolio to which the NFTCollection will be issued (optional, default is the default portfolio)

Defined in

api/procedures/types.ts:1223

ModifyAssetParams

Ƭ ModifyAssetParams: { assetType?: KnownAssetType | string | BigNumber ; fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name: string } | { assetType?: KnownAssetType | string | BigNumber ; fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible: true ; name?: string } | { assetType?: KnownAssetType | string | BigNumber ; fundingRound: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name?: string } | { assetType?: KnownAssetType | string | BigNumber ; fundingRound?: string ; identifiers: SecurityIdentifier[] ; makeDivisible?: true ; name?: string } | { assetType: KnownAssetType | string | BigNumber ; fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name?: string }

Defined in

api/procedures/types.ts:1177

ModifyCaDefaultConfigParams

Ƭ ModifyCaDefaultConfigParams: { defaultTaxWithholding: BigNumber ; targets?: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets?: InputTargets ; taxWithholdings: InputTaxWithholding[] }

Defined in

api/procedures/types.ts:1342

ModifyClaimsParams

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

Defined in

api/procedures/types.ts:856

ModifyComplianceRequirementParams

Ƭ ModifyComplianceRequirementParams: Object

Type declaration

Name Type Description
conditions InputCondition[] array of conditions to replace the existing array of conditions for the requirement (identified by id). Conditions within a requirement are AND between them. This means that in order for a transfer to comply with this requirement, it must fulfill ALL conditions
id BigNumber ID of the Compliance Requirement

Defined in

api/procedures/types.ts:1291

ModifyCorporateBallotParams

Ƭ ModifyCorporateBallotParams: Partial<Pick<CreateBallotParams, "meta" | "endDate" | "rcv">> & { ballot: CorporateBallot | BigNumber }

Defined in

api/procedures/types.ts:1892

ModifyInstructionAffirmationParams

Ƭ ModifyInstructionAffirmationParams: InstructionIdParams & { operation: Affirm } & AffirmInstructionParams | { operation: Withdraw } & WithdrawInstructionParams | { operation: Reject | RejectAsMediator } & RejectInstructionParams | { operation: AffirmAsMediator } & AffirmAsMediatorParams | { operation: WithdrawAsMediator | RejectAsMediator }

Defined in

api/procedures/types.ts:1107

ModifyOfferingTimesParams

Ƭ ModifyOfferingTimesParams: { end: Date | null ; start?: Date } | { end?: Date | null ; start: Date } | { end: Date | null ; start: Date }

Defined in

api/procedures/types.ts:1572

ModifyVenueParams

Ƭ ModifyVenueParams: { description?: string ; type: VenueType } | { description: string ; type?: VenueType } | { description: string ; type: VenueType }

Defined in

api/procedures/types.ts:1520

MortalityProcedureOpt

Ƭ MortalityProcedureOpt: ImmortalProcedureOptValue | MortalProcedureOptValue

Defined in

api/procedures/types.ts:181

NftMetadataInput

Ƭ NftMetadataInput: Object

Type declaration

Name Type
id BigNumber
type MetadataType
value string

Defined in

api/procedures/types.ts:1217

RegisterMetadataParams

Ƭ RegisterMetadataParams: { name: string ; specs: MetadataSpec } | { details?: MetadataValueDetails ; name: string ; specs: MetadataSpec ; value: string }

Defined in

api/procedures/types.ts:1709

RejectInstructionParams

Ƭ RejectInstructionParams: Object

Type declaration

Name Type Description
portfolio? PortfolioLike (optional) Portfolio that the signer controls and wants to reject the instruction

Defined in

api/procedures/types.ts:1037

RemoveAssetStatParams

Ƭ RemoveAssetStatParams: { asset: FungibleAsset } & RemoveCountStatParams | RemoveBalanceStatParams | RemoveScopedCountParams | RemoveScopedBalanceParams

Defined in

api/procedures/types.ts:437

RemoveBalanceStatParams

Ƭ RemoveBalanceStatParams: Object

Type declaration

Name Type
type Balance

Defined in

api/procedures/types.ts:471

RemoveCountStatParams

Ƭ RemoveCountStatParams: Object

Type declaration

Name Type
type Count

Defined in

api/procedures/types.ts:467

RemoveScopedBalanceParams

Ƭ RemoveScopedBalanceParams: StatClaimIssuer & { type: ScopedBalance }

Defined in

api/procedures/types.ts:479

RemoveScopedCountParams

Ƭ RemoveScopedCountParams: StatClaimIssuer & { type: ScopedCount }

Defined in

api/procedures/types.ts:475

RevokeIdentityToCreatePortfoliosParams

Ƭ RevokeIdentityToCreatePortfoliosParams: Object

Type declaration

Name Type
did Identity | string

Defined in

api/procedures/types.ts:1782

Role

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

Defined in

api/procedures/types.ts:312

RotatePrimaryKeyToSecondaryParams

Ƭ RotatePrimaryKeyToSecondaryParams: Object

Type declaration

Name Type Description
expiry? Date (optional) when the generated authorization should expire
permissions PermissionsLike -
targetAccount string | Account The Account that should function as the primary key of the newly created Identity. Can be ss58 encoded address or an instance of Account

Defined in

api/procedures/types.ts:924

SetAssetStatParams

Ƭ SetAssetStatParams<T>: Omit<T extends Count ? AddCountStatParams : T extends Percentage ? AddPercentageStatParams : T extends ClaimCount ? AddClaimCountStatParams : AddClaimPercentageStatParams, "type">

Type parameters

Name
T

Defined in

api/procedures/types.ts:483

SetMetadataParams

Ƭ SetMetadataParams: { details?: MetadataValueDetails ; value: string } | { details: MetadataValueDetails }

Defined in

api/procedures/types.ts:1705

SetRestrictionsParams

Ƭ SetRestrictionsParams<T>: Omit<T extends Count ? SetCountTransferRestrictionsParams : T extends Percentage ? SetPercentageTransferRestrictionsParams : T extends ClaimCount ? SetClaimCountTransferRestrictionsParams : SetClaimPercentageTransferRestrictionsParams, "type">

Type parameters

Name
T

Defined in

api/procedures/types.ts:416

SetVenueFilteringParams

Ƭ SetVenueFilteringParams: Object

Type declaration

Name Type
allowedVenues? BigNumber[]
disallowedVenues? BigNumber[]
enabled? boolean

Defined in

api/procedures/types.ts:1721

TransactionArray

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

Type parameters

Name Type
ReturnValues extends readonly [...unknown[]]

Defined in

api/procedures/types.ts:251

TransferRestriction

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

Defined in

api/procedures/types.ts:515

WithdrawInstructionParams

Ƭ WithdrawInstructionParams: Object

Type declaration

Name Type Description
portfolios? PortfolioLike[] (optional) Portfolios that the signer controls and wants to affirm the instruction or withdraw affirmation Note if empty, all the legs containing any custodied Portfolios of the signer will be affirmed/affirmation will be withdrawn, based on the operation.

Defined in

api/procedures/types.ts:1044

@polymeshassociation/polymesh-sdk

Modules

Client
Entities
Procedures
Base
Generated
Types

Clone this wiki locally