Module: Procedures Types
Enumerations
- AllowanceOperation
- ClaimOperation
- InstructionAffirmationOperation
- RoleType
- TransferRestrictionType
- TxGroup
Interfaces
- AcceptPrimaryKeyRotationParams
- AddAssetRequirementParams
- AddClaimsParams
- AddInstructionsParams
- AddInvestorUniquenessClaimParams
- AssetBase
- AssetMediatorParams
- AttestPrimaryKeyRotationParams
- CddProviderRole
- ClaimCountRestrictionValue
- ClaimCountTransferRestrictionInput
- ClaimPercentageRestrictionValue
- ClaimPercentageTransferRestrictionInput
- ConfigureDividendDistributionParams
- ControllerTransferParams
- CountTransferRestrictionInput
- CreateAssetParams
- CreateAssetWithTickerParams
- CreateCheckpointScheduleParams
- CreateChildIdentitiesParams
- CreateChildIdentityParams
- CreateGroupParams
- CreateMultiSigParams
- CreateNftCollectionParams
- CreateTransactionBatchParams
- CreateTransactionBatchProcedureMethod
- CreateVenueParams
- DecreaseAllowanceParams
- EditClaimsParams
- ExecuteManualInstructionParams
- GlobalCollectionKeyInput
- IdentityRole
- ImmortalProcedureOptValue
- IncreaseAllowanceParams
- InstructionFungibleLeg
- InstructionIdParams
- InstructionNftLeg
- InvestInOfferingParams
- InviteAccountParams
- InviteExternalAgentParams
- LaunchOfferingParams
- LinkCaDocsParams
- LocalCollectionKeyInput
- ModifyAssetTrustedClaimIssuersAddSetParams
- ModifyAssetTrustedClaimIssuersRemoveParams
- ModifyCaCheckpointParams
- ModifyCorporateActionsAgentParams
- ModifyMultiSigParams
- ModifyPrimaryIssuanceAgentParams
- ModifySignerPermissionsParams
- MortalProcedureOptValue
- MoveFundsParams
- NftControllerTransferParams
- NoArgsProcedureMethod
- OptionalArgsProcedureMethod
- PayDividendsParams
- PercentageTransferRestrictionInput
- PortfolioCustodianRole
- PortfolioId
- ProcedureAuthorizationStatus
- ProcedureMethod
- ProcedureOpts
- RedeemNftParams
- RedeemTokensParams
- RegisterCustomClaimTypeParams
- RegisterIdentityParams
- RemoveAssetRequirementParams
- RemoveCheckpointScheduleParams
- RemoveCorporateActionParams
- RemoveExternalAgentParams
- RemoveSecondaryAccountsParams
- RenamePortfolioParams
- ReserveTickerParams
- RevokeClaimsParams
- RotatePrimaryKeyParams
- ScopeClaimProof
- SetAllowanceParams
- SetAssetDocumentsParams
- SetAssetRequirementsParams
- SetClaimCountTransferRestrictionsParams
- SetClaimPercentageTransferRestrictionsParams
- SetCountTransferRestrictionsParams
- SetCustodianParams
- SetGroupPermissionsParams
- SetPercentageTransferRestrictionsParams
- SetPermissionGroupParams
- SubsidizeAccountParams
- TickerOwnerRole
- TransactionsParams
- TransferAssetOwnershipParams
- TransferPolyxParams
- TransferTickerOwnershipParams
- TxData
- TxGroupParams
- UnlinkChildParams
- VenueOwnerRole
- WaivePermissionsParams
Type Aliases
AddAssetStatParams
Ƭ AddAssetStatParams: { ticker: string } & AddCountStatParams | AddPercentageStatParams | AddClaimCountStatParams | AddClaimPercentageStatParams
Defined in
AddClaimCountStatParams
Ƭ AddClaimCountStatParams: ClaimCountStatInput & { type: ScopedCount }
Defined in
AddClaimCountTransferRestrictionParams
Ƭ AddClaimCountTransferRestrictionParams: ClaimCountTransferRestrictionInput & { type: ClaimCount }
Defined in
AddClaimPercentageStatParams
Ƭ AddClaimPercentageStatParams: StatClaimIssuer & { type: ScopedBalance }
Defined in
AddClaimPercentageTransferRestrictionParams
Ƭ AddClaimPercentageTransferRestrictionParams: ClaimPercentageTransferRestrictionInput & { type: ClaimPercentage }
Defined in
AddCountStatParams
Ƭ AddCountStatParams: AddCountStatInput & { type: Count }
Defined in
AddCountTransferRestrictionParams
Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & { type: Count }
Defined in
AddInstructionParams
Ƭ AddInstructionParams: { legs: InstructionLeg[] ; mediators?: (string | Identity)[] ; memo?: string ; tradeDate?: Date ; valueDate?: Date } & { endBlock?: BigNumber } | { endAfterBlock?: BigNumber }
Defined in
AddInstructionWithVenueIdParams
Ƭ AddInstructionWithVenueIdParams: AddInstructionParams & { venueId: BigNumber }
Defined in
AddPercentageStatParams
Ƭ AddPercentageStatParams: Object
Type declaration
| Name | Type |
|---|---|
type | Balance |
Defined in
AddPercentageTransferRestrictionParams
Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & { type: Percentage }
Defined in
AddRestrictionParams
Ƭ AddRestrictionParams<T>: Omit<T extends Count ? AddCountTransferRestrictionParams : T extends Percentage ? AddPercentageTransferRestrictionParams : T extends ClaimCount ? AddClaimCountTransferRestrictionParams : AddClaimPercentageTransferRestrictionParams, "type">
Type parameters
| Name |
|---|
T |
Defined in
AffirmAsMediatorParams
Ƭ AffirmAsMediatorParams: Object
Type declaration
| Name | Type |
|---|---|
expiry? | Date |
Defined in
AffirmOrWithdrawInstructionParams
Ƭ AffirmOrWithdrawInstructionParams: 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
AllowIdentityToCreatePortfoliosParams
Ƭ AllowIdentityToCreatePortfoliosParams: Object
Type declaration
| Name | Type |
|---|---|
did | Identity | string |
Defined in
CollectionKeyInput
Ƭ CollectionKeyInput: GlobalCollectionKeyInput | LocalCollectionKeyInput
Global key must be registered. local keys must provide a specification as they are created with the NftCollection
Defined in
GenericPolymeshTransaction
Ƭ GenericPolymeshTransaction<ProcedureReturnValue, ReturnValue>: PolymeshTransaction<ProcedureReturnValue, ReturnValue> | PolymeshTransactionBatch<ProcedureReturnValue, ReturnValue>
Type parameters
| Name |
|---|
ProcedureReturnValue |
ReturnValue |
Defined in
GetTransferRestrictionReturnType
Ƭ GetTransferRestrictionReturnType<T>: ActiveTransferRestrictions<T extends Count ? CountTransferRestriction : T extends Percentage ? PercentageTransferRestriction : T extends ClaimCount ? ClaimCountTransferRestriction : ClaimPercentageTransferRestriction>
Type parameters
| Name |
|---|
T |
Defined in
InputCorporateActionTargets
Ƭ InputCorporateActionTargets: Modify <CorporateActionTargets, { identities: (string | Identity)[] }>
Targets of a corporate action in a flexible structure for input purposes
Defined in
InputCorporateActionTaxWithholdings
Ƭ InputCorporateActionTaxWithholdings: Modify <TaxWithholding, { identity: string | Identity }>[]
Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes
Defined in
InstructionLeg
Ƭ InstructionLeg: InstructionFungibleLeg | InstructionNftLeg
Defined in
IssueNftParams
Ƭ IssueNftParams: Object
Type declaration
| Name | Type |
|---|---|
metadata | NftMetadataInput[] |
portfolio? | PortfolioLike |
Defined in
ModifyAssetParams
Ƭ ModifyAssetParams: { fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name: string } | { fundingRound?: string ; identifiers?: SecurityIdentifier[] ; makeDivisible: true ; name?: string } | { fundingRound: string ; identifiers?: SecurityIdentifier[] ; makeDivisible?: true ; name?: string } | { fundingRound?: string ; identifiers: SecurityIdentifier[] ; makeDivisible?: true ; name?: string }
Defined in
ModifyCaDefaultConfigParams
Ƭ ModifyCaDefaultConfigParams: { defaultTaxWithholding: BigNumber ; targets?: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets: InputTargets ; taxWithholdings?: InputTaxWithholding[] } | { defaultTaxWithholding?: BigNumber ; targets?: InputTargets ; taxWithholdings: InputTaxWithholding[] }
Defined in
ModifyClaimsParams
Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams
Defined in
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
ModifyInstructionAffirmationParams
Ƭ ModifyInstructionAffirmationParams: InstructionIdParams & { operation: Affirm | Withdraw } & AffirmOrWithdrawInstructionParams | { operation: Reject | RejectAsMediator } & RejectInstructionParams | { operation: AffirmAsMediator } & AffirmAsMediatorParams | { operation: WithdrawAsMediator | RejectAsMediator }
Defined in
ModifyOfferingTimesParams
Ƭ ModifyOfferingTimesParams: { end: Date | null ; start?: Date } | { end?: Date | null ; start: Date } | { end: Date | null ; start: Date }
Defined in
ModifyVenueParams
Ƭ ModifyVenueParams: { description?: string ; type: VenueType } | { description: string ; type?: VenueType } | { description: string ; type: VenueType }
Defined in
MortalityProcedureOpt
Ƭ MortalityProcedureOpt: ImmortalProcedureOptValue | MortalProcedureOptValue
Defined in
NftMetadataInput
Ƭ NftMetadataInput: Object
Type declaration
| Name | Type |
|---|---|
id | BigNumber |
type | MetadataType |
value | string |
Defined in
RegisterMetadataParams
Ƭ RegisterMetadataParams: { name: string ; specs: MetadataSpec } | { details?: MetadataValueDetails ; name: string ; specs: MetadataSpec ; value: string }
Defined in
RejectInstructionParams
Ƭ RejectInstructionParams: Object
Type declaration
| Name | Type | Description |
|---|---|---|
portfolio? | PortfolioLike | (optional) Portfolio that the signer controls and wants to reject the instruction |
Defined in
RemoveAssetStatParams
Ƭ RemoveAssetStatParams: { ticker: string } & RemoveCountStatParams | RemoveBalanceStatParams | RemoveScopedCountParams | RemoveScopedBalanceParams
Defined in
RemoveBalanceStatParams
Ƭ RemoveBalanceStatParams: Object
Type declaration
| Name | Type |
|---|---|
type | Balance |
Defined in
RemoveCountStatParams
Ƭ RemoveCountStatParams: Object
Type declaration
| Name | Type |
|---|---|
type | Count |
Defined in
RemoveScopedBalanceParams
Ƭ RemoveScopedBalanceParams: StatClaimIssuer & { type: ScopedBalance }
Defined in
RemoveScopedCountParams
Ƭ RemoveScopedCountParams: StatClaimIssuer & { type: ScopedCount }
Defined in
RevokeIdentityToCreatePortfoliosParams
Ƭ RevokeIdentityToCreatePortfoliosParams: Object
Type declaration
| Name | Type |
|---|---|
did | Identity | string |
Defined in
Role
Ƭ Role: TickerOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole | IdentityRole
Defined in
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
SetAssetStatParams
Ƭ SetAssetStatParams<T>: Omit<T extends Count ? AddCountStatParams : T extends Percentage ? AddPercentageStatParams : T extends ClaimCount ? AddClaimCountStatParams : AddClaimPercentageStatParams, "type">
Type parameters
| Name |
|---|
T |
Defined in
SetMetadataParams
Ƭ SetMetadataParams: { details?: MetadataValueDetails ; value: string } | { details: MetadataValueDetails }
Defined in
SetRestrictionsParams
Ƭ SetRestrictionsParams<T>: Omit<T extends Count ? SetCountTransferRestrictionsParams : T extends Percentage ? SetPercentageTransferRestrictionsParams : T extends ClaimCount ? SetClaimCountTransferRestrictionsParams : SetClaimPercentageTransferRestrictionsParams, "type">
Type parameters
| Name |
|---|
T |
Defined in
SetVenueFilteringParams
Ƭ SetVenueFilteringParams: Object
Type declaration
| Name | Type |
|---|---|
allowedVenues? | BigNumber[] |
disallowedVenues? | BigNumber[] |
enabled? | boolean |
Defined in
TransactionArray
Ƭ TransactionArray<ReturnValues>: { [K in keyof ReturnValues]: GenericPolymeshTransaction<any, ReturnValues[K]> }
Type parameters
| Name | Type |
|---|---|
ReturnValues | extends readonly [...unknown[]] |
Defined in
TransferRestriction
Ƭ TransferRestriction: { type: Count ; value: BigNumber } | { type: Percentage ; value: BigNumber } | { type: ClaimCount ; value: ClaimCountRestrictionValue } | { type: ClaimPercentage ; value: ClaimPercentageRestrictionValue }