Skip to main content
Version: v28.0.x

Module: Procedures Types

Enumerations​

Interfaces​

Type Aliases​

AddAssetStatParams​

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

Defined in​

api/procedures/types.ts:423

AddClaimCountStatParams​

Ƭ AddClaimCountStatParams: ClaimCountStatInput & { type: ScopedCount }

Defined in​

api/procedures/types.ts:415

AddClaimPercentageStatParams​

Ƭ AddClaimPercentageStatParams: StatClaimIssuer & { type: ScopedBalance }

Defined in​

api/procedures/types.ts:419

AddCountStatParams​

Ƭ AddCountStatParams: AddCountStatInput & { type: Count }

Defined in​

api/procedures/types.ts:407

AddCountTransferRestrictionParams​

Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & { type: Count }

Defined in​

api/procedures/types.ts:540

AddInstructionParams​

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

Defined in​

api/procedures/types.ts:933

AddInstructionWithVenueIdParams​

Ƭ AddInstructionWithVenueIdParams: AddInstructionParams & { venueId?: BigNumber }

Defined in​

api/procedures/types.ts:984

AddPercentageStatParams​

Ƭ AddPercentageStatParams: Object

Type declaration​

NameType
typeBalance

Defined in​

api/procedures/types.ts:411

AffirmAsMediatorParams​

Ƭ AffirmAsMediatorParams: Object

Type declaration​

NameType
expiry?Date

Defined in​

api/procedures/types.ts:1071

AffirmInstructionParams​

Ƭ AffirmInstructionParams: Object

Type declaration​

NameTypeDescription
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:1055

AllowIdentityToCreatePortfoliosParams​

Ƭ AllowIdentityToCreatePortfoliosParams: Object

Type declaration​

NameType
didIdentity | string

Defined in​

api/procedures/types.ts:1746

CastBallotVoteParams​

Ƭ CastBallotVoteParams: Object

Type declaration​

NameTypeDescription
votesBallotVote[][]The votes to be cast. Note Votes for all motion choices must be provided.

Defined in​

api/procedures/types.ts:1866

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

CorporateBallotParams​

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

Defined in​

api/procedures/types.ts:1855

GenericPolymeshTransaction​

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

Type parameters​

Name
ProcedureReturnValue
ReturnValue

Defined in​

api/procedures/types.ts:243

InitiateCorporateActionParams​

Ƭ InitiateCorporateActionParams: Object

Type declaration​

NameTypeDescription
checkpointInputCaCheckpoint | nullThe checkpoint of the Corporate Action (the record date on which the Corporate Action is applied)
declarationDateDateThe date on which the Corporate Action is declared
defaultTaxWithholdingBigNumber | nullThe default tax withholding to be applied to the Corporate Action
descriptionstringThe description of the Corporate Action
kindCorporateActionKindThe kind of Corporate Action to initiate
targetsInputCorporateActionTargets | nullThe targets of the Corporate Action
taxWithholdingsInputTaxWithholding[]The tax withholdings to be applied to the Corporate Action

Defined in​

api/procedures/types.ts:1874

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

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

InstructionLeg​

Ƭ InstructionLeg: InstructionFungibleLeg | InstructionNftLeg | InstructionOffChainLeg

Defined in​

api/procedures/types.ts:931

IssueNftParams​

Ƭ IssueNftParams: Object

Type declaration​

NameTypeDescription
metadataNftMetadataInput[]-
portfolioId?BigNumberportfolio to which the NFTCollection will be issued (optional, default is the default portfolio)

Defined in​

api/procedures/types.ts:1191

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

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

ModifyClaimsParams​

Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams

Defined in​

api/procedures/types.ts:812

ModifyComplianceRequirementParams​

Ƭ ModifyComplianceRequirementParams: Object

Type declaration​

NameTypeDescription
conditionsInputCondition[]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
idBigNumberID of the Compliance Requirement

Defined in​

api/procedures/types.ts:1259

ModifyCorporateBallotParams​

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

Defined in​

api/procedures/types.ts:1860

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

ModifyOfferingTimesParams​

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

Defined in​

api/procedures/types.ts:1540

ModifyVenueParams​

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

Defined in​

api/procedures/types.ts:1488

MortalityProcedureOpt​

Ƭ MortalityProcedureOpt: ImmortalProcedureOptValue | MortalProcedureOptValue

Defined in​

api/procedures/types.ts:177

NftMetadataInput​

Ƭ NftMetadataInput: Object

Type declaration​

NameType
idBigNumber
typeMetadataType
valuestring

Defined in​

api/procedures/types.ts:1185

RegisterMetadataParams​

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

Defined in​

api/procedures/types.ts:1677

RejectInstructionParams​

Ƭ RejectInstructionParams: Object

Type declaration​

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

Defined in​

api/procedures/types.ts:1001

RevokeIdentityToCreatePortfoliosParams​

Ƭ RevokeIdentityToCreatePortfoliosParams: Object

Type declaration​

NameType
didIdentity | string

Defined in​

api/procedures/types.ts:1750

Role​

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

Defined in​

api/procedures/types.ts:308

RotatePrimaryKeyToSecondaryParams​

Ƭ RotatePrimaryKeyToSecondaryParams: Object

Type declaration​

NameTypeDescription
expiry?Date(optional) when the generated authorization should expire
permissionsPermissionsLike-
targetAccountstring | AccountThe 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:880

SetMetadataParams​

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

Defined in​

api/procedures/types.ts:1673

SetTransferRestrictionParams​

Ƭ SetTransferRestrictionParams: CountTransferRestrictionInput | PercentageTransferRestrictionInput | ClaimCountTransferRestrictionInput | ClaimPercentageTransferRestrictionInput

Defined in​

api/procedures/types.ts:401

SetTransferRestrictionStatParams​

Ƭ SetTransferRestrictionStatParams: Object

Type declaration​

NameType
stats(AddCountStatParams | AddPercentageStatParams | AddClaimCountStatParams | AddClaimPercentageStatParams)[]

Defined in​

api/procedures/types.ts:430

SetVenueFilteringParams​

Ƭ SetVenueFilteringParams: Object

Type declaration​

NameType
allowedVenues?BigNumber[]
disallowedVenues?BigNumber[]
enabled?boolean

Defined in​

api/procedures/types.ts:1689

TransactionArray​

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

Type parameters​

NameType
ReturnValuesextends readonly [...unknown[]]

Defined in​

api/procedures/types.ts:247

TransferRestriction​

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

Defined in​

api/procedures/types.ts:460

TransferRestrictionExemptionParams​

Ƭ TransferRestrictionExemptionParams: Object

Type declaration​

NameType
claim?ClaimType
identities(Identity | string)[]
typeStatType

Defined in​

api/procedures/types.ts:544

TransferRestrictionParams​

Ƭ TransferRestrictionParams: Object

Type declaration​

NameType
restrictions(TransferRestrictionInputCount | TransferRestrictionInputPercentage | TransferRestrictionClaimCountInput | TransferRestrictionInputClaimPercentage)[]

Defined in​

api/procedures/types.ts:531

WithdrawInstructionParams​

Ƭ WithdrawInstructionParams: Object

Type declaration​

NameTypeDescription
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:1008