-
Notifications
You must be signed in to change notification settings - Fork 11
api.procedures.types
@polymeshassociation/polymesh-sdk / api/procedures/types
Defined in: api/procedures/types.ts:1728
Decrease:
"Decrease"
Defined in: api/procedures/types.ts:1731
Increase:
"Increase"
Defined in: api/procedures/types.ts:1730
Set:
"Set"
Defined in: api/procedures/types.ts:1729
Defined in: api/procedures/types.ts:936
Add:
"Add"
Defined in: api/procedures/types.ts:938
Edit:
"Edit"
Defined in: api/procedures/types.ts:939
Revoke:
"Revoke"
Defined in: api/procedures/types.ts:937
Defined in: api/procedures/types.ts:1146
Affirm:
"Affirm"
Defined in: api/procedures/types.ts:1147
AffirmAsMediator:
"AffirmAsMediator"
Defined in: api/procedures/types.ts:1153
Reject:
"Reject"
Defined in: api/procedures/types.ts:1152
RejectAsMediator:
"RejectAsMediator"
Defined in: api/procedures/types.ts:1158
Withdraw:
"Withdraw"
Defined in: api/procedures/types.ts:1151
withdrawing an affirmation is no longer supported in chain v8
WithdrawAsMediator:
"WithdrawAsMediator"
Defined in: api/procedures/types.ts:1157
withdrawing an affirmation as a mediator is no longer supported in chain v8
Defined in: api/procedures/types.ts:273
CddProvider:
"CddProvider"
Defined in: api/procedures/types.ts:278
CddProvider role has been deprecated in favor of DidRegistrar role for chain v8
CorporateActionsAgent:
"CorporateActionsAgent"
Defined in: api/procedures/types.ts:281
DidRegistrar:
"DidRegistrar"
Defined in: api/procedures/types.ts:284
Identity:
"Identity"
Defined in: api/procedures/types.ts:283
PortfolioCustodian:
"PortfolioCustodian"
Defined in: api/procedures/types.ts:280
TickerOwner:
"TickerOwner"
Defined in: api/procedures/types.ts:274
VenueOwner:
"VenueOwner"
Defined in: api/procedures/types.ts:279
Defined in: api/procedures/types.ts:1180
Ecdsa:
"Ecdsa"
Defined in: api/procedures/types.ts:1183
Ed25519:
"Ed25519"
Defined in: api/procedures/types.ts:1181
Sr25519:
"Sr25519"
Defined in: api/procedures/types.ts:1182
Defined in: api/procedures/types.ts:571
ClaimCount:
"ClaimCount"
Defined in: api/procedures/types.ts:574
ClaimPercentage:
"ClaimPercentage"
Defined in: api/procedures/types.ts:575
Count:
"Count"
Defined in: api/procedures/types.ts:572
Percentage:
"Percentage"
Defined in: api/procedures/types.ts:573
Defined in: api/procedures/types.ts:334
Transaction Groups (for secondary key permissions purposes) Includes all transactions that agents can perform plus secondary key specific transactions
AdvancedAssetManagement:
"AdvancedAssetManagement"
Defined in: api/procedures/types.ts:339
Advanced Asset Management operations
types/txGroupConstants!ADVANCED_ASSET_MANAGEMENT_TX_TAGS for the complete list of transactions
AssetDocumentManagement:
"AssetDocumentManagement"
Defined in: api/procedures/types.ts:351
Asset Document Management operations
types/txGroupConstants!ASSET_DOCUMENT_MANAGEMENT_TX_TAGS for the complete list of transactions
AssetManagement:
"AssetManagement"
Defined in: api/procedures/types.ts:345
Asset management operations
types/txGroupConstants!ASSET_MANAGEMENT_TX_TAGS for the complete list of transactions
AssetMetadataManagement:
"AssetMetadataManagement"
Defined in: api/procedures/types.ts:357
Asset Metadata Management operations
types/txGroupConstants!ASSET_METADATA_MANAGEMENT_TX_TAGS for the complete list of transactions
AssetRegistration:
"AssetRegistration"
Defined in: api/procedures/types.ts:363
Asset Registration operations
types/txGroupConstants!ASSET_REGISTRATION_TX_TAGS for the complete list of transactions
AuthorizationManagement:
"AuthorizationManagement"
Defined in: api/procedures/types.ts:369
Authorization Management operations
types/txGroupConstants!AUTHORIZATION_MANAGEMENT_TX_TAGS for the complete list of transactions
CapitalDistribution:
"CapitalDistribution"
Defined in: api/procedures/types.ts:375
Capital distribution management
types/txGroupConstants!CAPITAL_DISTRIBUTION_TX_TAGS for the complete list of transactions
CddRegistration:
"CddRegistration"
Defined in: api/procedures/types.ts:381
CDD Registration operations
types/txGroupConstants!CDD_REGISTRATION_TX_TAGS for the complete list of transactions
CheckpointManagement:
"CheckpointManagement"
Defined in: api/procedures/types.ts:387
Checkpoint management
types/txGroupConstants!CHECKPOINT_MANAGEMENT_TX_TAGS for the complete list of transactions
ClaimsManagement:
"ClaimsManagement"
Defined in: api/procedures/types.ts:393
Claims Management operations
types/txGroupConstants!CLAIMS_MANAGEMENT_TX_TAGS for the complete list of transactions
ComplianceManagement:
"ComplianceManagement"
Defined in: api/procedures/types.ts:399
Compliance management operations
types/txGroupConstants!COMPLIANCE_MANAGEMENT_TX_TAGS for the complete list of transactions
CorporateActionsManagement:
"CorporateActionsManagement"
Defined in: api/procedures/types.ts:405
Corporate actions management
types/txGroupConstants!CORPORATE_ACTIONS_MANAGEMENT_TX_TAGS for the complete list of transactions
CorporateBallotManagement:
"CorporateBallotManagement"
Defined in: api/procedures/types.ts:411
Corporate ballot management
types/txGroupConstants!CORPORATE_BALLOT_MANAGEMENT_TX_TAGS for the complete list of transactions
CorporateVoting:
"CorporateVoting"
Defined in: api/procedures/types.ts:417
Corporate voting operations
types/txGroupConstants!CORPORATE_VOTING_TX_TAGS for the complete list of transactions
ExternalAgentManagement:
"ExternalAgentManagement"
Defined in: api/procedures/types.ts:423
External Agent Management operations
types/txGroupConstants!EXTERNAL_AGENT_MANAGEMENT_TX_TAGS for the complete list of transactions
ExternalAgentParticipation:
"ExternalAgentParticipation"
Defined in: api/procedures/types.ts:429
External Agent Participation operations
types/txGroupConstants!EXTERNAL_AGENT_PARTICIPATION_TX_TAGS for the complete list of transactions
Issuance:
"Issuance"
Defined in: api/procedures/types.ts:435
Issuance operations
types/txGroupConstants!ISSUANCE_TX_TAGS for the complete list of transactions
MultiSigManagement:
"MultiSigManagement"
Defined in: api/procedures/types.ts:441
MultiSig account management
types/txGroupConstants!MULTISIG_MANAGEMENT_TX_TAGS for the complete list of transactions
PortfolioManagement:
"PortfolioManagement"
Defined in: api/procedures/types.ts:447
Portfolio management operations
types/txGroupConstants!PORTFOLIO_MANAGEMENT_TX_TAGS for the complete list of transactions
Redemption:
"Redemption"
Defined in: api/procedures/types.ts:459
Redemption operations
types/txGroupConstants!REDEMPTION_TX_TAGS for the complete list of transactions
RelayerManagement:
"RelayerManagement"
Defined in: api/procedures/types.ts:453
Relayer Management operations
types/txGroupConstants!RELAYER_MANAGEMENT_TX_TAGS for the complete list of transactions
SettlementManagement:
"SettlementManagement"
Defined in: api/procedures/types.ts:465
Settlement Management operations
types/txGroupConstants!SETTLEMENT_MANAGEMENT_TX_TAGS for the complete list of transactions
StoManagement:
"StoManagement"
Defined in: api/procedures/types.ts:471
STO Management operations
types/txGroupConstants!STO_MANAGEMENT_TX_TAGS for the complete list of transactions
TrustedClaimIssuersManagement:
"TrustedClaimIssuersManagement"
Defined in: api/procedures/types.ts:477
Trusted Claim Issuers Management operations
types/txGroupConstants!TRUSTED_CLAIM_ISSUERS_MANAGEMENT_TX_TAGS for the complete list of transactions
Defined in: api/procedures/types.ts:706
optionalcddAuth?:BigNumber|AuthorizationRequest
Defined in: api/procedures/types.ts:715
(optional) Authorization from a CDD service provider attesting the rotation of primary key
this value will be ignored from chain v8
ownerAuth:
BigNumber|AuthorizationRequest
Defined in: api/procedures/types.ts:710
Authorization from the owner who initiated the change
Defined in: api/procedures/types.ts:767
subsidizer:
string|Account
Defined in: api/procedures/types.ts:771
Account providing the subsidy
Defined in: api/procedures/types.ts:732
authSignature:
string
Defined in: api/procedures/types.ts:752
Off-chain authorization signature generated by secondaryAccount signing of the target Id authorization
Target Id authorization consists of the target Identity (to which the secondary account will be added),
off chain authorization nonce of the target Identity and expiry date (same as expiresAt value) until which the off chain authorization will be valid.
Signature has to be generated encoding the target Id authorization value in the specified order.
Nonce value can be fetched using Identity.getOffChainAuthorizationNonce Signature can also be generated using the method accountManagement.generateOffChainAuthSignature
secondaryAccount:
Modify<PermissionedAccount, {account:string|Account;permissions:PermissionsLike; }>
Defined in: api/procedures/types.ts:738
The secondary Account along with its permissions to be added
This account should not be linked to any other Identity
Defined in: api/procedures/types.ts:1590
documents:
AssetDocument[]
Defined in: api/procedures/types.ts:1594
documents to add to the asset
Defined in: api/procedures/types.ts:1454
conditions:
InputCondition[]
Defined in: api/procedures/types.ts:1460
array of conditions that form the requirement that must be added. 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
Defined in: api/procedures/types.ts:942
claims:
ClaimTarget[]
Defined in: api/procedures/types.ts:946
array of claims to be added
operation:
Add
Defined in: api/procedures/types.ts:947
Defined in: api/procedures/types.ts:1131
instructions:
AddInstructionParams[]
Defined in: api/procedures/types.ts:1135
array of Instructions to be added in the Venue
Defined in: api/procedures/types.ts:977
cddId:
string
Defined in: api/procedures/types.ts:979
optionalexpiry?:Date
Defined in: api/procedures/types.ts:982
proof:
string|ScopeClaimProof
Defined in: api/procedures/types.ts:980
scope:
Scope
Defined in: api/procedures/types.ts:978
scopeId:
string
Defined in: api/procedures/types.ts:981
Defined in: api/procedures/types.ts:755
accounts:
AccountWithSignature[]
Defined in: api/procedures/types.ts:764
List of accounts to be added as secondary accounts along with their off chain authorization signatures
expiresAt:
Date
Defined in: api/procedures/types.ts:759
Expiry date until which all the off chain authorizations received from each account is valid
Defined in: api/procedures/types.ts:2154
amount:
BigNumber
Defined in: api/procedures/types.ts:2163
Maximum amount the spender may transfer. Passing 0 will revoke the approval. Balance::MAX = unlimited.
spender:
AccountLike
Defined in: api/procedures/types.ts:2158
Account authorized to spend the Asset
Defined in: api/procedures/types.ts:1818
asset:
string|FungibleAsset
Defined in: api/procedures/types.ts:1822
Asset over which the Identity will be granted permissions
Defined in: api/procedures/types.ts:1976
mediators: (
string|Identity)[]
Defined in: api/procedures/types.ts:1977
Defined in: api/procedures/types.ts:1005
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1019
(optional) when the generated authorization should expire
identity:
string|Identity
Defined in: api/procedures/types.ts:1014
Identity or the DID of the Identity that is to be rotated
targetAccount:
string|Account
Defined in: api/procedures/types.ts:1009
The Account that will be attested to become the primary key of the identity. Can be ss58 encoded address or an instance of Account
Defined in: api/procedures/types.ts:1992
amount:
BigNumber
Defined in: api/procedures/types.ts:2016
The amount of POLYX to bond (up to 6 decimals of precision)
It is strongly recommended against bonding 100% an account's POLYX balance. At the minimum a stash account needs enough POLYX to sign the unbond extrinsic ()
autoStake:
boolean
Defined in: api/procedures/types.ts:2008
Can be set to true if rewardDestination is the signing account. Auto stake will stake all rewards so the balance will compound
controller:
string|Account
Defined in: api/procedures/types.ts:1998
The controller is the account responsible for managing staked POLYX. This can be the stash, but designating a different key can make it easier to update nomination preferences and maintain the POLYX in a more secure, but inconvenient, stash key.
payee:
string|Account
Defined in: api/procedures/types.ts:2003
The account that should receive the stashing rewards
Defined in: api/procedures/types.ts:292
type:
CddProvider
Defined in: api/procedures/types.ts:293
Defined in: api/procedures/types.ts:1936
authSignature:
`0x${string}`
Defined in: api/procedures/types.ts:1953
Off-chain authorization signature generated by key signing of the target Id authorization
Target Id authorization consists of the target Identity (which will become the parent of the child Identity),
off chain authorization nonce of the target Identity and expiry date (same as expiresAt value) until which the off chain authorization will be valid.
Signature has to be generated encoding the target Id authorization value in the specified order.
Nonce value can be fetched using Identity.getOffChainAuthorizationNonce Signature can also be generated using the method accountManagement.generateOffChainAuthSignature
key:
string|Account
Defined in: api/procedures/types.ts:1942
The key that will become the primary key of the new child Identity
This key should not be linked to any other Identity
Defined in: api/procedures/types.ts:578
claim:
InputStatClaim
Defined in: api/procedures/types.ts:582
issuer:
Identity
Defined in: api/procedures/types.ts:581
optionalmax?:BigNumber
Defined in: api/procedures/types.ts:580
min:
BigNumber
Defined in: api/procedures/types.ts:579
Defined in: api/procedures/types.ts:628
claim:
InputStatClaim
Defined in: api/procedures/types.ts:632
issuer:
Identity
Defined in: api/procedures/types.ts:631
optionalmax?:BigNumber
Defined in: api/procedures/types.ts:630
min:
BigNumber
Defined in: api/procedures/types.ts:629
type:
ClaimCount
Defined in: api/procedures/types.ts:633
Defined in: api/procedures/types.ts:585
claim:
InputStatClaim
Defined in: api/procedures/types.ts:589
issuer:
Identity
Defined in: api/procedures/types.ts:588
max:
BigNumber
Defined in: api/procedures/types.ts:587
min:
BigNumber
Defined in: api/procedures/types.ts:586
Defined in: api/procedures/types.ts:635
claim:
InputStatClaim
Defined in: api/procedures/types.ts:639
issuer:
Identity
Defined in: api/procedures/types.ts:638
max:
BigNumber
Defined in: api/procedures/types.ts:637
min:
BigNumber
Defined in: api/procedures/types.ts:636
type:
ClaimPercentage
Defined in: api/procedures/types.ts:640
Defined in: api/procedures/types.ts:1531
checkpoint:
InputCaCheckpoint
Defined in: api/procedures/types.ts:1556
checkpoint to be used to calculate Dividends. If a Schedule is passed, the next Checkpoint it creates will be used. If a Date is passed, a Checkpoint will be created at that date and used
currency:
string
Defined in: api/procedures/types.ts:1564
ticker of the currency in which Dividends will be distributed
optionaldeclarationDate?:Date
Defined in: api/procedures/types.ts:1535
date at which the issuer publicly declared the Dividend Distribution. Optional, defaults to the current date
optionaldefaultTaxWithholding?:BigNumber
Defined in: api/procedures/types.ts:1546
default percentage (0-100) of the Benefits to be held for tax purposes
description:
string
Defined in: api/procedures/types.ts:1536
optionalexpiryDate?:Date
Defined in: api/procedures/types.ts:1580
optional, defaults to never expiring
maxAmount:
BigNumber
Defined in: api/procedures/types.ts:1572
maximum amount of currency to distribute in total
optionaloriginPortfolio?:BigNumber|NumberedPortfolio
Defined in: api/procedures/types.ts:1560
portfolio from which the Dividends will be distributed. Optional, defaults to the Dividend Distributions Agent's Default Portfolio
paymentDate:
Date
Defined in: api/procedures/types.ts:1576
date from which Asset Holders can claim their Dividends
perShare:
BigNumber
Defined in: api/procedures/types.ts:1568
amount of currency to distribute per each share of the Asset that a target holds
optionaltargets?:InputCorporateActionTargets
Defined in: api/procedures/types.ts:1542
Asset Holder Identities to be included (or excluded) from the Dividend Distribution. Inclusion/exclusion is controlled by the treatment
property. When the value is Include, all Asset Holders not present in the array are excluded, and vice-versa. If no value is passed,
the default value for the Asset is used. If there is no default value, all Asset Holders will be part of the Dividend Distribution
optionaltaxWithholdings?:InputCorporateActionTaxWithholdings
Defined in: api/procedures/types.ts:1551
percentage (0-100) of the Benefits to be held for tax purposes from individual Asset Holder Identities.
This overrides the value of defaultTaxWithholding
Defined in: api/procedures/types.ts:1279
amount:
BigNumber
Defined in: api/procedures/types.ts:1287
amount of Asset tokens to transfer
optionaldestination?:AssetHolderLike
Defined in: api/procedures/types.ts:1292
(optional) portfolio (or portfolio ID) or account to which Assets will be transferred to. Defaults to default portfolio. If specified it must be one of the callers own portfolios or accounts
originPortfolio:
PortfolioLike
Defined in: api/procedures/types.ts:1283
portfolio (or portfolio ID) from which Assets will be transferred
Defined in: api/procedures/types.ts:612
count:
BigNumber
Defined in: api/procedures/types.ts:616
limit on the amount of different (unique) investors that can hold the Asset at once
type:
Count
Defined in: api/procedures/types.ts:617
Defined in: api/procedures/types.ts:792
assetType:
string|BigNumber
Defined in: api/procedures/types.ts:812
Type of security that the Asset represents (e.g., Equity, Debt, Commodity). Common values are included in the types!KnownAssetType enum, but custom values can be used as well. Custom values must be registered on-chain the first time they're used, requiring an additional transaction. They aren't tied to a specific Asset. If using a custom type, it can be provided as a string (representing name) or a BigNumber (representing the custom type ID).
optionaldocuments?:AssetDocument[]
Defined in: api/procedures/types.ts:821
optionalfundingRound?:string
Defined in: api/procedures/types.ts:820
(Optional) funding round in which the Asset currently is (e.g., Series A, Series B).
optionalinitialStatistics?:InputStatType[]
Defined in: api/procedures/types.ts:834
(Optional) type of statistics that should be enabled for the Asset.
Enabling statistics allows for TransferRestrictions to be made. For example, the SEC requires registration for a company that
has either more than 2000 investors or more than 500 non-accredited investors. To prevent crossing this limit, two restrictions are
needed: a Count of 2000, and a ScopedCount of non-accredited with a maximum of 500. source
These restrictions require a Count and ScopedCount statistic to be created. Although they can be created after the Asset is made, it is recommended to create statistics
before the Asset is circulated. Count statistics made after Asset creation need their initial value set, so it is simpler to create them before investors hold the Asset.
If you need to create a stat for an Asset after creation, you can use the TransferRestrictions.setStats method in the TransferRestrictions namespace.
optionalinitialSupply?:BigNumber
Defined in: api/procedures/types.ts:797
Amount of Asset tokens to be minted on creation (optional; by default, no tokens are minted).
isDivisible:
boolean
Defined in: api/procedures/types.ts:805
Whether a single Asset token can be divided into decimal parts.
name:
string
Defined in: api/procedures/types.ts:793
optionalportfolioId?:BigNumber
Defined in: api/procedures/types.ts:801
Portfolio to which the Asset tokens will be issued on creation (optional; defaults to the default portfolio).
optionalsecurityIdentifiers?:SecurityIdentifier[]
Defined in: api/procedures/types.ts:816
Array of domestic or international alphanumeric security identifiers for the Asset (e.g., ISIN, CUSIP, FIGI).
Defined in: api/procedures/types.ts:855
assetType:
string|BigNumber
Defined in: api/procedures/types.ts:812
Type of security that the Asset represents (e.g., Equity, Debt, Commodity). Common values are included in the types!KnownAssetType enum, but custom values can be used as well. Custom values must be registered on-chain the first time they're used, requiring an additional transaction. They aren't tied to a specific Asset. If using a custom type, it can be provided as a string (representing name) or a BigNumber (representing the custom type ID).
optionaldocuments?:AssetDocument[]
Defined in: api/procedures/types.ts:821
optionalfundingRound?:string
Defined in: api/procedures/types.ts:820
(Optional) funding round in which the Asset currently is (e.g., Series A, Series B).
CreateAssetParams.fundingRound
optionalinitialStatistics?:InputStatType[]
Defined in: api/procedures/types.ts:834
(Optional) type of statistics that should be enabled for the Asset.
Enabling statistics allows for TransferRestrictions to be made. For example, the SEC requires registration for a company that
has either more than 2000 investors or more than 500 non-accredited investors. To prevent crossing this limit, two restrictions are
needed: a Count of 2000, and a ScopedCount of non-accredited with a maximum of 500. source
These restrictions require a Count and ScopedCount statistic to be created. Although they can be created after the Asset is made, it is recommended to create statistics
before the Asset is circulated. Count statistics made after Asset creation need their initial value set, so it is simpler to create them before investors hold the Asset.
If you need to create a stat for an Asset after creation, you can use the TransferRestrictions.setStats method in the TransferRestrictions namespace.
CreateAssetParams.initialStatistics
optionalinitialSupply?:BigNumber
Defined in: api/procedures/types.ts:797
Amount of Asset tokens to be minted on creation (optional; by default, no tokens are minted).
CreateAssetParams.initialSupply
isDivisible:
boolean
Defined in: api/procedures/types.ts:805
Whether a single Asset token can be divided into decimal parts.
name:
string
Defined in: api/procedures/types.ts:793
optionalportfolioId?:BigNumber
Defined in: api/procedures/types.ts:801
Portfolio to which the Asset tokens will be issued on creation (optional; defaults to the default portfolio).
optionalsecurityIdentifiers?:SecurityIdentifier[]
Defined in: api/procedures/types.ts:816
Array of domestic or international alphanumeric security identifiers for the Asset (e.g., ISIN, CUSIP, FIGI).
CreateAssetParams.securityIdentifiers
optionalticker?:string
Defined in: api/procedures/types.ts:861
(optional) ticker to be linked with the Asset
from 7.x chain, ticker has been made optional. For 6.x chain, it is still mandatory.
Defined in: api/procedures/types.ts:2052
declarationDate:
Date
Defined in: api/procedures/types.ts:2083
Date on which the Corporate Action is declared
description:
string
Defined in: api/procedures/types.ts:2071
Description of the Corporate Action to which the Ballot is attached
endDate:
Date
Defined in: api/procedures/types.ts:2066
Date when Ballot voting ends
meta:
BallotMeta
Defined in: api/procedures/types.ts:2056
Title and motions of the Ballot
rcv:
boolean
Defined in: api/procedures/types.ts:2088
Specifies whether Ranked Choice Voting (RCV) is enabled for this ballot.
startDate:
Date
Defined in: api/procedures/types.ts:2061
Date when Ballot voting starts
optionaltargets?:InputCorporateActionTargets
Defined in: api/procedures/types.ts:2078
Asset Holder Identities to be included (or excluded) from the Ballot. Inclusion/exclusion is controlled by the treatment
property. When the value is Include, all Asset Holders not present in the array are excluded, and vice-versa. If no value is passed,
the default value for the Asset is used. If there is no default value, all Asset Holders will be part of the Ballot
Defined in: api/procedures/types.ts:1440
points:
Date[]
Defined in: api/procedures/types.ts:1444
The points in time in the future for which to create checkpoints for
Defined in: api/procedures/types.ts:1956
childKeyAuths:
ChildKeyWithAuth[]
Defined in: api/procedures/types.ts:1965
List of child keys along with their off chain authorization signatures
expiresAt:
Date
Defined in: api/procedures/types.ts:1960
Expiry date until which all the off chain authorizations received from each key will be valid
Defined in: api/procedures/types.ts:1929
secondaryKey:
string|Account
Defined in: api/procedures/types.ts:1933
The secondary key that will become the primary key of the new child Identity
Defined in: api/procedures/types.ts:1644
permissions: {
transactions:TransactionPermissions; } | {transactionGroups: (AdvancedAssetManagement|AssetManagement|AssetDocumentManagement|AssetMetadataManagement|CapitalDistribution|CheckpointManagement|ComplianceManagement|CorporateActionsManagement|CorporateBallotManagement|ExternalAgentManagement|Issuance|Redemption|StoManagement|TrustedClaimIssuersManagement)[]; }
Defined in: api/procedures/types.ts:1645
Defined in: api/procedures/types.ts:1873
optionalpermissions?:PermissionsLike
Defined in: api/procedures/types.ts:1882
Grants permissions to the MultiSig upon creation. The caller must be the primary key of the Identity for these to work
requiredSignatures:
BigNumber
Defined in: api/procedures/types.ts:1878
signers:
Signer[]
Defined in: api/procedures/types.ts:1877
Signer must be an Account as of v7
Defined in: api/procedures/types.ts:880
optionalassetId?:string
Defined in: api/procedures/types.ts:887
The ID of the asset to be used to create the collection.
If no assetId is provided, a new asset with NonFungible asset type will be created
for spec version before 7.x, this value is overwritten by ticker value
collectionKeys:
CollectionKeyInput[]
Defined in: api/procedures/types.ts:916
The required metadata values each NFT in the collection will have
Images — Most Polymesh networks (mainnet, testnet, etc.) have global metadata keys registered to help standardize displaying images
If imageUri is specified as a collection key, then each token will need to be issued with an image URI.
optionaldocuments?:AssetDocument[]
Defined in: api/procedures/types.ts:920
Links to off chain documents related to the NftCollection
optionalfundingRound?:string
Defined in: api/procedures/types.ts:925
A optional field that can be used to provide information about the funding state of the asset
optionalname?:string
Defined in: api/procedures/types.ts:900
The collection name. defaults to ticker
nftType:
string|BigNumber
Defined in: api/procedures/types.ts:905
if provided string that does not have a custom type
if provided a BigNumber that does not correspond to a custom type
optionalsecurityIdentifiers?:SecurityIdentifier[]
Defined in: api/procedures/types.ts:909
array of domestic or international alphanumeric security identifiers for the Asset (e.g. ISIN, CUSIP, FIGI)
optionalticker?:string
Defined in: api/procedures/types.ts:896
The primary identifier for the collection. The ticker must either be free, or the signer has appropriate permissions if reserved.
Since spec version 7.x, this value (if provided) is then linked to assetId asset
This value is mandatory for spec version before 7.x
Defined in: api/procedures/types.ts:1869
| Type Parameter |
|---|
ReturnValues extends readonly [...unknown[]] |
transactions:
Readonly<TransactionArray<ReturnValues>>
Defined in: api/procedures/types.ts:1870
Defined in: api/procedures/types.ts:183
CreateTransactionBatchProcedureMethod<
ReturnValues>(args,opts?):Promise<PolymeshTransactionBatch<ReturnValues,ReturnValues,unknown[][]>>
Defined in: api/procedures/types.ts:184
| Type Parameter |
|---|
ReturnValues extends readonly unknown[] |
| Parameter | Type |
|---|---|
args |
CreateTransactionBatchParams<ReturnValues> |
opts? |
ProcedureOpts |
Promise<PolymeshTransactionBatch<ReturnValues, ReturnValues, unknown[][]>>
checkAuthorization: <
ReturnValues>(args,opts?) =>Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:188
| Type Parameter |
|---|
ReturnValues extends unknown[] |
| Parameter | Type |
|---|---|
args |
CreateTransactionBatchParams<ReturnValues> |
opts? |
ProcedureOpts |
Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:1266
description:
string
Defined in: api/procedures/types.ts:1267
optionalsigners?: (string|Account)[]
Defined in: api/procedures/types.ts:1272
(optional) list of signers that are allowed to sign receipts for this venue
type:
VenueType
Defined in: api/procedures/types.ts:1268
Defined in: api/procedures/types.ts:1742
allowance:
BigNumber
Defined in: api/procedures/types.ts:1746
amount of POLYX to decrease the allowance by
operation:
Decrease
Defined in: api/procedures/types.ts:1747
Defined in: api/procedures/types.ts:296
type:
DidRegistrar
Defined in: api/procedures/types.ts:297
Defined in: api/procedures/types.ts:950
claims:
ClaimTarget[]
Defined in: api/procedures/types.ts:954
array of claims to be edited
operation:
Edit
Defined in: api/procedures/types.ts:955
Defined in: api/procedures/types.ts:2147
offChainTicker:
string
Defined in: api/procedures/types.ts:2151
The ticker of the off-chain asset
Defined in: api/procedures/types.ts:1259
optionalskipAffirmationCheck?:boolean
Defined in: api/procedures/types.ts:1263
(optional) Set to true to skip affirmation check, useful for batch transactions
Defined in: api/procedures/types.ts:864
id:
BigNumber
Defined in: api/procedures/types.ts:866
type:
Global
Defined in: api/procedures/types.ts:865
Defined in: api/procedures/types.ts:317
did:
string
Defined in: api/procedures/types.ts:319
type:
Identity
Defined in: api/procedures/types.ts:318
Defined in: api/procedures/types.ts:156
This transaction will never expire
readonlyimmortal:true
Defined in: api/procedures/types.ts:157
Defined in: api/procedures/types.ts:1734
allowance:
BigNumber
Defined in: api/procedures/types.ts:1738
amount of POLYX to increase the allowance by
operation:
Increase
Defined in: api/procedures/types.ts:1739
Defined in: api/procedures/types.ts:1061
amount:
BigNumber
Defined in: api/procedures/types.ts:1062
asset:
string|FungibleAsset
Defined in: api/procedures/types.ts:1065
from:
AssetHolderLike
Defined in: api/procedures/types.ts:1063
to:
AssetHolderLike
Defined in: api/procedures/types.ts:1064
Defined in: api/procedures/types.ts:1142
id:
BigNumber
Defined in: api/procedures/types.ts:1143
Defined in: api/procedures/types.ts:1068
asset:
string|NftCollection
Defined in: api/procedures/types.ts:1072
from:
AssetHolderLike
Defined in: api/procedures/types.ts:1070
nfts: (
BigNumber|Nft)[]
Defined in: api/procedures/types.ts:1069
to:
AssetHolderLike
Defined in: api/procedures/types.ts:1071
Defined in: api/procedures/types.ts:1075
asset:
string
Defined in: api/procedures/types.ts:1081
the ticker of the off chain asset
from:
string|Identity
Defined in: api/procedures/types.ts:1076
offChainAmount:
BigNumber
Defined in: api/procedures/types.ts:1082
to:
string|Identity
Defined in: api/procedures/types.ts:1077
Defined in: api/procedures/types.ts:700
optionalexpiry?:Date
Defined in: api/procedures/types.ts:703
optionalpermissions?:PermissionsLike
Defined in: api/procedures/types.ts:702
targetAccount:
string|Account
Defined in: api/procedures/types.ts:701
Defined in: api/procedures/types.ts:1654
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1671
date at which the authorization request for invitation expires (optional)
if expiry date is not set, the invitation will never expire
due to chain limitations, the expiry will be ignored if the passed permissions don't correspond to an existing Permission Group
permissions:
CustomPermissionGroup|KnownPermissionGroup| {transactions:TransactionPermissions|null; } | {transactionGroups: (AdvancedAssetManagement|AssetManagement|AssetDocumentManagement|AssetMetadataManagement|CapitalDistribution|CheckpointManagement|ComplianceManagement|CorporateActionsManagement|CorporateBallotManagement|ExternalAgentManagement|Issuance|Redemption|StoManagement|TrustedClaimIssuersManagement)[]; }
Defined in: api/procedures/types.ts:1656
target:
string|Identity
Defined in: api/procedures/types.ts:1655
Defined in: api/procedures/types.ts:837
optionalaccount?:string
Defined in: api/procedures/types.ts:852
(optional) Account to which the Asset tokens will be issued
only one of portfolioId or account can be provided. If both are not provided, assets are issued in default portfolio
amount:
BigNumber
Defined in: api/procedures/types.ts:841
amount of Asset tokens to be issued
optionalportfolioId?:BigNumber
Defined in: api/procedures/types.ts:845
portfolio to which the Asset tokens will be issued (optional, default is the default portfolio)
Defined in: api/procedures/types.ts:1604
optionalend?:Date
Defined in: api/procedures/types.ts:1632
end date of the Offering (optional, defaults to never)
minInvestment:
BigNumber
Defined in: api/procedures/types.ts:1641
minimum amount that can be spent on this offering
name:
string
Defined in: api/procedures/types.ts:1624
offeringPortfolio:
PortfolioLike
Defined in: api/procedures/types.ts:1608
portfolio in which the Asset tokens to be sold are stored
raisingCurrency:
string
Defined in: api/procedures/types.ts:1617
ticker symbol of the currency in which the funds are being raised (e.g. 'USD' or 'CAD'). Other Assets can be used as currency as well
raisingPortfolio:
PortfolioLike
Defined in: api/procedures/types.ts:1612
portfolio in which the raised funds will be stored
optionalstart?:Date
Defined in: api/procedures/types.ts:1628
start date of the Offering (optional, defaults to right now)
tiers:
OfferingTier[]
Defined in: api/procedures/types.ts:1637
array of sale tiers. Each tier consists of an amount of Assets to be sold at a certain price. Tokens in a tier can only be bought when all tokens in previous tiers have been bought
optionalvenue?:Venue
Defined in: api/procedures/types.ts:1623
venue through which all offering related trades will be settled
(optional, defaults to the first Sto type Venue owned by the owner of the Offering Portfolio.
If passed, it must be of type Sto)
Defined in: api/procedures/types.ts:1678
documents:
AssetDocument[]
Defined in: api/procedures/types.ts:1682
list of documents
Defined in: api/procedures/types.ts:1685
ticker:
string
Defined in: api/procedures/types.ts:1689
The ticker to attach
Defined in: api/procedures/types.ts:869
name:
string
Defined in: api/procedures/types.ts:871
spec:
MetadataSpec
Defined in: api/procedures/types.ts:872
type:
Local
Defined in: api/procedures/types.ts:870
Defined in: api/procedures/types.ts:1488
claimIssuers:
InputTrustedClaimIssuer[]
Defined in: api/procedures/types.ts:1489
Defined in: api/procedures/types.ts:1492
claimIssuers: (
string|Identity)[]
Defined in: api/procedures/types.ts:1496
array of Identities (or DIDs) of the default claim issuers
Defined in: api/procedures/types.ts:1692
checkpoint:
InputCaCheckpoint|null
Defined in: api/procedures/types.ts:1693
Defined in: api/procedures/types.ts:1503
optionalrequestExpiry?:Date
Defined in: api/procedures/types.ts:1511
date at which the authorization request to modify the Corporate Actions Agent expires (optional, never expires if a date is not provided)
target:
string|Identity
Defined in: api/procedures/types.ts:1507
Identity to be set as Corporate Actions Agent
Defined in: api/procedures/types.ts:1885
multiSig:
MultiSig
Defined in: api/procedures/types.ts:1889
The MultiSig to be modified
optionalrequiredSignatures?:BigNumber
Defined in: api/procedures/types.ts:1897
The required number of signatures for the MultiSig
optionalsigners?:Account[]
Defined in: api/procedures/types.ts:1893
The signer accounts to set for the MultiSig
Defined in: api/procedures/types.ts:1385
optionalrequestExpiry?:Date
Defined in: api/procedures/types.ts:1393
date at which the authorization request to modify the primary issuance agent expires (optional, never expires if a date is not provided)
target:
string|Identity
Defined in: api/procedures/types.ts:1389
Identity to be set as primary issuance agent
Defined in: api/procedures/types.ts:718
secondaryAccounts:
Modify<PermissionedAccount, {account:string|Account;permissions:PermissionsLike; }>[]
Defined in: api/procedures/types.ts:722
list of secondary Accounts
Defined in: api/procedures/types.ts:163
This transaction will be rejected if not included in a block after a while (default: ~5 minutes)
readonlyimmortal:false
Defined in: api/procedures/types.ts:164
readonlyoptionallifetime?:BigNumber
Defined in: api/procedures/types.ts:171
The number of blocks the for which the transaction remains valid. Target block time is 6 seconds. The default should suffice for most use cases
this value will get rounded up to the closest power of 2, e.g. 65 rounds up to 128
this value should not exceed 4096, which is the chain's BlockHashCount as the lesser of the two will be used.
Defined in: api/procedures/types.ts:1858
items:
PortfolioMovement[]
Defined in: api/procedures/types.ts:1866
list of Assets (and the corresponding token amounts) that will be moved
optionalto?:BigNumber|DefaultPortfolio|NumberedPortfolio
Defined in: api/procedures/types.ts:1862
portfolio (or portfolio ID) that will receive the funds. Optional, if no value is passed, the funds will be moved to the default Portfolio of this Portfolio's owner
Defined in: api/procedures/types.ts:174
optionalexpiry?:Date
Defined in: api/procedures/types.ts:178
The block number for which the proposal expires
Defined in: api/procedures/types.ts:1295
optionaldestination?:AssetHolderLike
Defined in: api/procedures/types.ts:1317
(optional) portfolio (or portfolio ID) or account to which Assets will be transferred to. Defaults to default portfolio. If specified it must be one of the callers own portfolios or accounts
this takes precedence over destinationPortfolio
optionaldestinationPortfolio?:PortfolioLike
Defined in: api/procedures/types.ts:1310
Optional portfolio (or portfolio ID) to which NFTs will be transferred to. Defaults to default portfolio. If specified it must be one of the callers own portfolios
in favour of destination. If both are passed destination will take precedence
nfts: (
BigNumber|Nft)[]
Defined in: api/procedures/types.ts:1303
The NFTs to transfer
originPortfolio:
PortfolioLike
Defined in: api/procedures/types.ts:1299
portfolio (or portfolio ID) from which NFTs will be transferred from
Defined in: api/procedures/types.ts:222
| Type Parameter | Default type |
|---|---|
ProcedureReturnValue |
- |
ReturnValue |
ProcedureReturnValue |
NoArgsProcedureMethod(
opts?):Promise<GenericPolymeshTransaction<ProcedureReturnValue,ReturnValue>>
Defined in: api/procedures/types.ts:223
| Parameter | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<ProcedureReturnValue, ReturnValue>>
checkAuthorization: (
opts?) =>Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:224
| Parameter | Type |
|---|---|
opts? |
ProcedureOpts |
Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:2048
validators: (
string|Account)[]
Defined in: api/procedures/types.ts:2049
Defined in: api/procedures/types.ts:1195
legId:
BigNumber
Defined in: api/procedures/types.ts:1203
Index of the off chain leg within the instruction to be affirmed
metadata:
string|undefined
Defined in: api/procedures/types.ts:1215
(optional) Metadata value that can be used to attach messages to the receipt
signature:
OffChainSignature
Defined in: api/procedures/types.ts:1211
Signature confirming the receipt details
signer:
string|Account
Defined in: api/procedures/types.ts:1207
Signer of this receipt
uid:
BigNumber
Defined in: api/procedures/types.ts:1199
Unique receipt number set by the signer for their receipts
Defined in: api/procedures/types.ts:1186
type:
SignerKeyRingType
Defined in: api/procedures/types.ts:1187
value:
`0x${string}`
Defined in: api/procedures/types.ts:1192
The off chain signature value.
NOTE: The off chain payload should be wrapped with bytes before signing. For e.g. <Bytes>Off chain payload</Bytes> should be signed to get the signature value
Defined in: api/procedures/types.ts:208
| Type Parameter | Default type |
|---|---|
MethodArgs |
- |
ProcedureReturnValue |
- |
ReturnValue |
ProcedureReturnValue |
OptionalArgsProcedureMethod(
args?,opts?):Promise<GenericPolymeshTransaction<ProcedureReturnValue,ReturnValue>>
Defined in: api/procedures/types.ts:213
| Parameter | Type |
|---|---|
args? |
MethodArgs |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<ProcedureReturnValue, ReturnValue>>
checkAuthorization: (
args?,opts?) =>Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:216
| Parameter | Type |
|---|---|
args? |
MethodArgs |
opts? |
ProcedureOpts |
Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:1849
targets: (
string|Identity)[]
Defined in: api/procedures/types.ts:1850
Defined in: api/procedures/types.ts:620
percentage:
BigNumber
Defined in: api/procedures/types.ts:624
maximum percentage (0-100) of the total supply of the Asset that can be held by a single investor at once
type:
Percentage
Defined in: api/procedures/types.ts:625
Defined in: api/procedures/types.ts:312
portfolioId:
PortfolioId
Defined in: api/procedures/types.ts:314
type:
PortfolioCustodian
Defined in: api/procedures/types.ts:313
Defined in: api/procedures/types.ts:305
did:
string
Defined in: api/procedures/types.ts:306
optionalnumber?:BigNumber
Defined in: api/procedures/types.ts:307
Defined in: api/procedures/types.ts:69
accountFrozen:
boolean
Defined in: api/procedures/types.ts:85
whether the Account is frozen (i.e. can't perform any transactions)
agentPermissions:
CheckPermissionsResult<Identity>
Defined in: api/procedures/types.ts:73
whether the Identity complies with all required Agent permissions
noIdentity:
boolean
Defined in: api/procedures/types.ts:90
true only if the Procedure requires an Identity but the signing Account doesn't have one associated
roles:
CheckRolesResult
Defined in: api/procedures/types.ts:81
whether the Identity complies with all required Roles
signerPermissions:
CheckPermissionsResult<Account>
Defined in: api/procedures/types.ts:77
whether the Account complies with all required Signer permissions
Defined in: api/procedures/types.ts:194
| Type Parameter | Default type |
|---|---|
MethodArgs |
- |
ProcedureReturnValue |
- |
ReturnValue |
ProcedureReturnValue |
ProcedureMethod(
args,opts?):Promise<GenericPolymeshTransaction<ProcedureReturnValue,ReturnValue>>
Defined in: api/procedures/types.ts:199
| Parameter | Type |
|---|---|
args |
MethodArgs |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<ProcedureReturnValue, ReturnValue>>
checkAuthorization: (
args,opts?) =>Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:202
| Parameter | Type |
|---|---|
args |
MethodArgs |
opts? |
ProcedureOpts |
Promise<ProcedureAuthorizationStatus>
Defined in: api/procedures/types.ts:116
optionalmortality?:MortalityProcedureOpt
Defined in: api/procedures/types.ts:136
This option allows for transactions that never expire, aka "immortal". By default, a transaction is only valid for approximately 5 minutes (250 blocks) after its construction. Allows for transaction construction to be decoupled from its submission, such as requiring manual approval for the signing or providing "at least once" guarantees.
More information can be found here. Note the Polymesh chain will never reap Accounts, so the risk of a replay attack is mitigated.
optionalmultiSigOpts?:MultiSigProcedureOpt
Defined in: api/procedures/types.ts:141
These options will only apply when the signingAccount is a MultiSig signer and the transaction is being wrapped as a proposal
optionalnonce?:BigNumber|Promise<BigNumber> | (() =>BigNumber|Promise<BigNumber>)
Defined in: api/procedures/types.ts:129
nonce value for signing the transaction
An api/entities/Account!Account can directly fetch its current nonce by calling account.getCurrentNonce. More information can be found at: https://polkadot.js.org/docs/api/cookbook/tx/#how-do-i-take-the-pending-tx-pool-into-account-in-my-nonce
the passed value can be either the nonce itself or a function that returns the nonce. This allows, for example, passing a closure that increases the returned value every time it's called, or a function that fetches the nonce from the chain or a different source
optionalsigningAccount?:string|Account
Defined in: api/procedures/types.ts:120
Account or address of a signing key to replace the current one (for this procedure only)
optionalskipChecks?:SkipChecksOpt
Defined in: api/procedures/types.ts:150
This option allows for skipping checks for the Procedure. By default, all checks are performed.
This can be useful while batching transactions which could have failed due to insufficient roles or permissions individually, but you don't want to fail the entire batch.
even if the checks are skipped from being validated on the SDK, they will still be validated on the chain
Defined in: api/procedures/types.ts:1416
optionalfrom?:BigNumber|DefaultPortfolio|NumberedPortfolio
Defined in: api/procedures/types.ts:1422
portfolio (or portfolio ID) from which Assets will be redeemed (optional, defaults to the default Portfolio)
either from or fromAccount must be provided
optionalfromAccount?:string|Account
Defined in: api/procedures/types.ts:1429
(optional) Account from which Assets will be redeemed
only one of from or fromAccount can be provided. If none are provided, defaults to the default Portfolio
Defined in: api/procedures/types.ts:1396
amount:
BigNumber
Defined in: api/procedures/types.ts:1400
amount of Asset tokens to be redeemed
optionalfrom?:BigNumber|DefaultPortfolio|NumberedPortfolio
Defined in: api/procedures/types.ts:1406
portfolio (or portfolio ID) from which Assets will be redeemed (optional, defaults to the default Portfolio)
either from or fromAccount must be provided
optionalfromAccount?:string|Account
Defined in: api/procedures/types.ts:1413
(optional) Account from which Assets will be redeemed
either from or fromAccount must be provided. fromAccount takes precedence over from
Defined in: api/procedures/types.ts:1988
name:
string
Defined in: api/procedures/types.ts:1989
Defined in: api/procedures/types.ts:1972
name:
string
Defined in: api/procedures/types.ts:1973
Defined in: api/procedures/types.ts:985
optionalcreateCdd?:boolean
Defined in: api/procedures/types.ts:998
(optional) also issue a CDD claim for the created DID, completing the onboarding process for the Account
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1002
(optional) when the generated CDD claim should expire, createCdd must be true if specified
optionalsecondaryAccounts?:Modify<PermissionedAccount, {permissions:PermissionsLike; }>[]
Defined in: api/procedures/types.ts:994
(optional) secondary accounts for the new Identity with their corresponding permissions.
Each Account will need to accept the generated authorizations before being linked to the Identity
targetAccount:
string|Account
Defined in: api/procedures/types.ts:989
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:1597
documentIds:
BigNumber[]
Defined in: api/procedures/types.ts:1601
IDs of documents to remove from the asset
Defined in: api/procedures/types.ts:1476
requirement:
BigNumber|Requirement
Defined in: api/procedures/types.ts:1477
Defined in: api/procedures/types.ts:1447
schedule:
BigNumber|CheckpointSchedule
Defined in: api/procedures/types.ts:1451
schedule (or ID) of the schedule to be removed
Defined in: api/procedures/types.ts:1499
corporateAction:
BigNumber|CorporateActionBase
Defined in: api/procedures/types.ts:1500
Defined in: api/procedures/types.ts:1674
target:
string|Identity
Defined in: api/procedures/types.ts:1675
Defined in: api/procedures/types.ts:728
accounts:
Account[]
Defined in: api/procedures/types.ts:729
Defined in: api/procedures/types.ts:1810
name:
string
Defined in: api/procedures/types.ts:1811
Defined in: api/procedures/types.ts:928
optionalextendPeriod?:boolean
Defined in: api/procedures/types.ts:933
ticker:
string
Defined in: api/procedures/types.ts:932
ticker symbol to reserve
Defined in: api/procedures/types.ts:958
claims:
Omit<ClaimTarget,"expiry">[]
Defined in: api/procedures/types.ts:962
array of claims to be revoked
operation:
Revoke
Defined in: api/procedures/types.ts:963
Defined in: api/procedures/types.ts:774
beneficiary:
string|Account
Defined in: api/procedures/types.ts:778
Account whose pending subsidy will be revoked
Defined in: api/procedures/types.ts:1022
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1031
(optional) when the generated authorization should expire
targetAccount:
string|Account
Defined in: api/procedures/types.ts:1026
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:968
proofScopeIdCddIdMatch:
object
Defined in: api/procedures/types.ts:970
blindedScopeDidHash:
string
challengeResponses: [
string,string]
subtractExpressionsRes:
string
proofScopeIdWellFormed:
string
Defined in: api/procedures/types.ts:969
Defined in: api/procedures/types.ts:1750
allowance:
BigNumber
Defined in: api/procedures/types.ts:1754
amount of POLYX to set the allowance to
operation:
Set
Defined in: api/procedures/types.ts:1755
Defined in: api/procedures/types.ts:1583
documents:
AssetDocument[]
Defined in: api/procedures/types.ts:1587
list of documents
Defined in: api/procedures/types.ts:1480
requirements:
InputCondition[][]
Defined in: api/procedures/types.ts:1485
array of array of conditions. For a transfer to be successful, it must comply with all the conditions of at least one of the arrays. In other words, higher level arrays are OR between them, while conditions inside each array are AND between them
Defined in: api/procedures/types.ts:690
restrictions:
ClaimCountTransferRestrictionInput[]
Defined in: api/procedures/types.ts:691
type:
ClaimCount
Defined in: api/procedures/types.ts:692
Defined in: api/procedures/types.ts:695
restrictions:
ClaimPercentageTransferRestrictionInput[]
Defined in: api/procedures/types.ts:696
type:
ClaimPercentage
Defined in: api/procedures/types.ts:697
Defined in: api/procedures/types.ts:682
restrictions:
CountTransferRestrictionInput[]
Defined in: api/procedures/types.ts:686
array of Count Transfer Restrictions with their corresponding exemptions (if applicable)
type:
Count
Defined in: api/procedures/types.ts:687
Defined in: api/procedures/types.ts:1853
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1855
targetIdentity:
string|Identity
Defined in: api/procedures/types.ts:1854
Defined in: api/procedures/types.ts:1696
permissions: {
transactions:TransactionPermissions; } | {transactionGroups: (AdvancedAssetManagement|AssetManagement|AssetDocumentManagement|AssetMetadataManagement|CapitalDistribution|CheckpointManagement|ComplianceManagement|CorporateActionsManagement|CorporateBallotManagement|ExternalAgentManagement|Issuance|Redemption|StoManagement|TrustedClaimIssuersManagement)[]; }
Defined in: api/procedures/types.ts:1697
Defined in: api/procedures/types.ts:1900
admin:
string|Identity|null
Defined in: api/procedures/types.ts:1904
The identity to become an admin for the MultiSig. null will remove the current admin
Defined in: api/procedures/types.ts:1845
This procedure can be called with:
- An Asset's existing Custom Permission Group. The Identity will be assigned as an Agent of that Group for that Asset
- A Known Permission Group and an Asset. The Identity will be assigned as an Agent of that Group for that Asset
- A set of Transaction Permissions and an Asset. If there is no Custom Permission Group with those permissions, a Custom Permission Group will be created for that Asset with those permissions, and the Identity will be assigned as an Agent of that Group for that Asset. Otherwise, the existing Group will be used
- An array of Agent Transaction Groups that represent a set of permissions. If there is no Custom Permission Group with those permissions, a Custom Permission Group will be created with those permissions, and the Identity will be assigned as an Agent of that Group for that Asset. Otherwise, the existing Group will be used
group:
CustomPermissionGroup|KnownPermissionGroup|TransactionsParams|TxGroupParams
Defined in: api/procedures/types.ts:1846
Defined in: api/procedures/types.ts:2019
controller:
string|Account
Defined in: api/procedures/types.ts:2025
The account responsible for managing the signing stash's staking preferences
Chain v8 will ignore this argument. Instead the stash will become its own controller
Defined in: api/procedures/types.ts:2028
autoStake:
boolean
Defined in: api/procedures/types.ts:2038
If set to true then rewards will be auto staked in order to compound
The payee must be the stash account in order to auto stake
payee:
string|Account
Defined in: api/procedures/types.ts:2032
The account who will receive the staking rewards
Defined in: api/procedures/types.ts:93
optionalaccountFrozen?:boolean
Defined in: api/procedures/types.ts:109
whether to skip the account frozen check
optionalagentPermissions?:boolean
Defined in: api/procedures/types.ts:105
whether to skip the agent permissions check
optionalidentity?:boolean
Defined in: api/procedures/types.ts:113
whether to skip the identity check (i.e. whether the signing Account has an associated Identity)
optionalroles?:boolean
Defined in: api/procedures/types.ts:97
whether to skip the roles check
optionalsignerPermissions?:boolean
Defined in: api/procedures/types.ts:101
whether to skip the signer permissions check
Defined in: api/procedures/types.ts:781
allowance:
BigNumber
Defined in: api/procedures/types.ts:789
amount of POLYX to be subsidized. This can be increased/decreased later on
beneficiary:
string|Account
Defined in: api/procedures/types.ts:785
Account to subsidize
Defined in: api/procedures/types.ts:287
ticker:
string
Defined in: api/procedures/types.ts:289
type:
TickerOwner
Defined in: api/procedures/types.ts:288
Defined in: api/procedures/types.ts:1825
asset:
string|FungibleAsset
Defined in: api/procedures/types.ts:1822
Asset over which the Identity will be granted permissions
transactions:
TransactionPermissions|null
Defined in: api/procedures/types.ts:1829
a null value means full permissions
Defined in: api/procedures/types.ts:1432
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1437
date at which the authorization request for transfer expires (optional)
target:
string|Identity
Defined in: api/procedures/types.ts:1433
Defined in: api/procedures/types.ts:1046
amount:
BigNumber
Defined in: api/procedures/types.ts:1054
amount of POLYX to be transferred
optionalmemo?:string
Defined in: api/procedures/types.ts:1058
identifier string to help differentiate transfers
to:
string|Account
Defined in: api/procedures/types.ts:1050
Account that will receive the POLYX
Defined in: api/procedures/types.ts:648
claim:
InputStatClaim
Defined in: api/procedures/types.ts:652
issuer:
Identity
Defined in: api/procedures/types.ts:651
optionalmax?:BigNumber
Defined in: api/procedures/types.ts:650
min:
BigNumber
Defined in: api/procedures/types.ts:649
type:
ClaimCount
Defined in: api/procedures/types.ts:653
Defined in: api/procedures/types.ts:655
claim:
InputStatClaim
Defined in: api/procedures/types.ts:659
issuer:
Identity
Defined in: api/procedures/types.ts:658
max:
BigNumber
Defined in: api/procedures/types.ts:657
min:
BigNumber
Defined in: api/procedures/types.ts:656
type:
ClaimPercentage
Defined in: api/procedures/types.ts:660
Defined in: api/procedures/types.ts:607
count:
BigNumber
Defined in: api/procedures/types.ts:608
type:
Count
Defined in: api/procedures/types.ts:609
Defined in: api/procedures/types.ts:643
percentage:
BigNumber
Defined in: api/procedures/types.ts:644
type:
Percentage
Defined in: api/procedures/types.ts:645
Defined in: api/procedures/types.ts:1720
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1725
date at which the authorization request for transfer expires (optional)
target:
string|Identity
Defined in: api/procedures/types.ts:1721
Defined in: api/procedures/types.ts:260
Transaction data for display purposes
| Type Parameter | Default type |
|---|---|
Args extends unknown[] |
unknown[] |
args:
Args
Defined in: api/procedures/types.ts:268
arguments with which the transaction will be called
tag:
TxTag
Defined in: api/procedures/types.ts:264
transaction string identifier
Defined in: api/procedures/types.ts:1832
asset:
string|FungibleAsset
Defined in: api/procedures/types.ts:1822
Asset over which the Identity will be granted permissions
transactionGroups: (
AdvancedAssetManagement|AssetManagement|AssetDocumentManagement|AssetMetadataManagement|CapitalDistribution|CheckpointManagement|ComplianceManagement|CorporateActionsManagement|CorporateBallotManagement|ExternalAgentManagement|Issuance|Redemption|StoManagement|TrustedClaimIssuersManagement)[]
Defined in: api/procedures/types.ts:1833
Defined in: api/procedures/types.ts:1968
child:
string|ChildIdentity
Defined in: api/procedures/types.ts:1969
Defined in: api/procedures/types.ts:2041
amount:
BigNumber
Defined in: api/procedures/types.ts:2045
The amount of POLYX to unbond from staking
Defined in: api/procedures/types.ts:1275
signers: (
string|Account)[]
Defined in: api/procedures/types.ts:1276
Defined in: api/procedures/types.ts:300
type:
VenueOwner
Defined in: api/procedures/types.ts:301
venueId:
BigNumber
Defined in: api/procedures/types.ts:302
Defined in: api/procedures/types.ts:1814
asset:
string|FungibleAsset
Defined in: api/procedures/types.ts:1815
AddAssetStatParams =
object&AddCountStatParams|AddBalanceStatParams|AddClaimCountStatParams|AddClaimBalanceStatParams
Defined in: api/procedures/types.ts:555
asset:
FungibleAsset
AddBalanceStatInput =
object
Defined in: api/procedures/types.ts:498
optionalbalance?:BigNumber
Defined in: api/procedures/types.ts:505
The total asset holder balance value for the stat
If not provided when enabling a stat, it will default to zero. If not provided when updating stats, the current value will remain unchanged
AddBalanceStatParams =
AddBalanceStatInput&object
Defined in: api/procedures/types.ts:508
type:
Balance
AddClaimBalanceStatParams =
ClaimBalanceStatInput&object
Defined in: api/procedures/types.ts:551
type:
ScopedBalance
AddClaimCountStatParams =
ClaimCountStatInput&object
Defined in: api/procedures/types.ts:512
type:
ScopedCount
AddCountStatParams =
AddCountStatInput&object
Defined in: api/procedures/types.ts:494
type:
Count
AddCountTransferRestrictionParams =
CountTransferRestrictionInput&object
Defined in: api/procedures/types.ts:672
type:
Count
AddInstructionParams =
object& {endBlock?:BigNumber; } | {endAfterBlock?:BigNumber; } | {endAfterLock?:true; }
Defined in: api/procedures/types.ts:1087
legs:
InstructionLeg[]
array of Asset movements
optionalmediators?: (string|Identity)[]
additional identities that must affirm the instruction
mediators are mandatory if settlement is to be locked for execution (providing endAfterLock)
optionalmemo?:string
identifier string to help differentiate instructions
optionaltradeDate?:Date
date at which the trade was agreed upon (optional, for off chain trades)
optionalvalueDate?:Date
date at which the trade was executed (optional, for off chain trades)
AddInstructionWithVenueIdParams =
AddInstructionParams&object
Defined in: api/procedures/types.ts:1138
venueId:
BigNumber|undefined
AffirmAsMediatorParams =
object
Defined in: api/procedures/types.ts:1234
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1235
AffirmInstructionParams =
object
Defined in: api/procedures/types.ts:1218
optionalholders?:AssetHolderLike[]
Defined in: api/procedures/types.ts:1224
(optional) Asset holders that the signer controls and wants to affirm the instruction
if empty, all the legs containing any custodied portfolios or accounts of of the signer will be affirmed
optionalreceipts?:OffChainAffirmationReceipt[]
Defined in: api/procedures/types.ts:1231
(optional) list of offchain receipts required for affirming offchain legs(if any) in the instruction
Receipt can be generated using generateOffChainAffirmationReceipt method
AgentTxGroup = typeof
AGENT_TX_GROUP_VALUES[number]
Defined in: api/procedures/types.ts:486
Type-level union of the TxGroup values that External Agents can use.
- Derived from types/txGroupConstants!AGENT_TX_GROUP_VALUES
- For iteration or runtime checks, prefer the types/txGroupConstants!AGENT_TX_GROUP_VALUES constant.
- All transactions in these groups are available to both Agents and Secondary Keys.
AllowIdentityToCreatePortfoliosParams =
object
Defined in: api/procedures/types.ts:1980
did:
Identity|string
Defined in: api/procedures/types.ts:1981
AssetHolderId =
string|PortfolioId
Defined in: api/procedures/types.ts:310
BatchIssueNftParams =
object
Defined in: api/procedures/types.ts:1374
metadataList:
NftMetadataInput[][]
Defined in: api/procedures/types.ts:1378
List of metadata for each NFT to be issued
optionalportfolioId?:BigNumber
Defined in: api/procedures/types.ts:1382
portfolio to which the NFTCollection will be issued (optional, default is the default portfolio)
CastBallotVoteParams =
object
Defined in: api/procedures/types.ts:2102
votes:
BallotVote[][]
Defined in: api/procedures/types.ts:2107
The votes to be cast.
Votes for all motion choices must be provided.
ClaimBalanceStatInput = {
claimType:Accredited;issuer:Identity;value?: {accredited:BigNumber;nonAccredited:BigNumber; }; } | {claimType:Affiliate;issuer:Identity;value?: {affiliate:BigNumber;nonAffiliate:BigNumber; }; } | {claimType:Jurisdiction;issuer:Identity;value?:object[]; }
Defined in: api/procedures/types.ts:516
{ claimType: Accredited; issuer: Identity; value?: { accredited: BigNumber; nonAccredited: BigNumber; }; }
claimType:
Accredited
issuer:
Identity
optionalvalue?:object
The total balance values for token holder with the accredited and non-accredited claim
If not provided when enabling a stat, values will default to zero. If not provided when updating stats, the current values will remain unchanged
accredited:
BigNumber
nonAccredited:
BigNumber
{ claimType: Affiliate; issuer: Identity; value?: { affiliate: BigNumber; nonAffiliate: BigNumber; }; }
claimType:
Affiliate
issuer:
Identity
optionalvalue?:object
The total balance values for token holder with the affiliate and non-affiliate claim
If not provided when enabling a stat, values will default to zero. If not provided when updating stats, the current values will remain unchanged
affiliate:
BigNumber
nonAffiliate:
BigNumber
{ claimType: Jurisdiction; issuer: Identity; value?: object[]; }
claimType:
Jurisdiction
issuer:
Identity
optionalvalue?:object[]
The total balance values for token holder per jurisdiction claim
If not provided when enabling a stat, values will default to zero. If not provided when updating stats, the current values will remain unchanged
CollectionKeyInput =
GlobalCollectionKeyInput|LocalCollectionKeyInput
Defined in: api/procedures/types.ts:878
Global key must be registered. local keys must provide a specification as they are created with the NftCollection
CorporateBallotParams =
Omit<CreateBallotParams,"declarationDate"|"rcv"> &object
Defined in: api/procedures/types.ts:2091
declarationDate:
Date
rcv:
boolean
GenericPolymeshTransaction<
ProcedureReturnValue,ReturnValue> =PolymeshTransaction<ProcedureReturnValue,ReturnValue> |PolymeshTransactionBatch<ProcedureReturnValue,ReturnValue>
Defined in: api/procedures/types.ts:247
| Type Parameter |
|---|
ProcedureReturnValue |
ReturnValue |
InitiateCorporateActionParams =
object
Defined in: api/procedures/types.ts:2110
checkpoint:
InputCaCheckpoint|null
Defined in: api/procedures/types.ts:2129
The checkpoint of the Corporate Action (the record date on which the Corporate Action is applied)
declarationDate:
Date
Defined in: api/procedures/types.ts:2119
The date on which the Corporate Action is declared
defaultTaxWithholding:
BigNumber|null
Defined in: api/procedures/types.ts:2144
The default tax withholding to be applied to the Corporate Action
description:
string
Defined in: api/procedures/types.ts:2124
The description of the Corporate Action
kind:
CorporateActionKind
Defined in: api/procedures/types.ts:2114
The kind of Corporate Action to initiate
targets:
InputCorporateActionTargets|null
Defined in: api/procedures/types.ts:2139
The targets of the Corporate Action
taxWithholdings:
InputTaxWithholding[]
Defined in: api/procedures/types.ts:2134
The tax withholdings to be applied to the Corporate Action
InputCorporateActionTargets =
Modify<CorporateActionTargets, {identities: (string|Identity)[]; }>
Defined in: api/procedures/types.ts:230
Targets of a corporate action in a flexible structure for input purposes
InputCorporateActionTaxWithholdings =
Modify<TaxWithholding, {identity:string|Identity; }>[]
Defined in: api/procedures/types.ts:240
Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes
InstructionLeg =
InstructionFungibleLeg|InstructionNftLeg|InstructionOffChainLeg
Defined in: api/procedures/types.ts:1085
InvestInOfferingParams =
object& {fundingPortfolio:PortfolioLike; } | {offChainFundingReceipt:OffChainFundingReceipt;offChainTicker:string; }
Defined in: api/procedures/types.ts:1775
IssueNftParams =
object
Defined in: api/procedures/types.ts:1366
metadata:
NftMetadataInput[]
Defined in: api/procedures/types.ts:1367
optionalportfolioId?:BigNumber
Defined in: api/procedures/types.ts:1371
portfolio to which the NFTCollection will be issued (optional, default is the default portfolio)
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:1320
{ assetType?: KnownAssetType | string | BigNumber; fundingRound?: string; identifiers?: SecurityIdentifier[]; makeDivisible?: true; name: string; }
optionalassetType?:KnownAssetType|string|BigNumber
optionalfundingRound?:string
optionalidentifiers?:SecurityIdentifier[]
optionalmakeDivisible?:true
makes an indivisible Asset divisible
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; }
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:1514
ModifyClaimsParams =
AddClaimsParams|EditClaimsParams|RevokeClaimsParams
Defined in: api/procedures/types.ts:966
ModifyComplianceRequirementParams =
object
Defined in: api/procedures/types.ts:1463
conditions:
InputCondition[]
Defined in: api/procedures/types.ts:1473
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
Defined in: api/procedures/types.ts:1467
ID of the Compliance Requirement
ModifyCorporateBallotParams =
Partial<Pick<CreateBallotParams,"meta"|"endDate"|"rcv">> &object
Defined in: api/procedures/types.ts:2096
ballot:
CorporateBallot|BigNumber
ModifyInstructionAffirmationParams =
InstructionIdParams&object&AffirmInstructionParams|object&WithdrawInstructionParams|object&RejectInstructionParams|object&AffirmAsMediatorParams| {operation:WithdrawAsMediator|RejectAsMediator; }
Defined in: api/procedures/types.ts:1238
ModifyOfferingTimesParams = {
end:Date|null;start?:Date; } | {end?:Date|null;start:Date; } | {end:Date|null;start:Date; }
Defined in: api/procedures/types.ts:1758
{ end: Date | null; start?: Date; }
end:
Date|null
new end time (optional, will be left th same if not passed). A null value means the Offering doesn't end
optionalstart?:Date
new start time (optional, will be left the same if not passed)
{ end?: Date | null; start: Date; }
{ end: Date | null; start: Date; }
ModifyVenueParams = {
description?:string;type:VenueType; } | {description:string;type?:VenueType; } | {description:string;type:VenueType; }
Defined in: api/procedures/types.ts:1706
MortalityProcedureOpt =
ImmortalProcedureOptValue|MortalProcedureOptValue
Defined in: api/procedures/types.ts:181
NftMetadataInput =
object
Defined in: api/procedures/types.ts:1360
id:
BigNumber
Defined in: api/procedures/types.ts:1362
type:
MetadataType
Defined in: api/procedures/types.ts:1361
value:
string
Defined in: api/procedures/types.ts:1363
RegisterMetadataParams = {
name:string;specs:MetadataSpec; } | {details?:MetadataValueDetails;name:string;specs:MetadataSpec;value:string; }
Defined in: api/procedures/types.ts:1911
RejectInstructionParams =
object
Defined in: api/procedures/types.ts:1161
optionalassetHolder?:AssetHolderLike
Defined in: api/procedures/types.ts:1165
(optional) Asset holder that the signer controls and wants to reject the instruction
RevokeIdentityToCreatePortfoliosParams =
object
Defined in: api/procedures/types.ts:1984
did:
Identity|string
Defined in: api/procedures/types.ts:1985
Role =
TickerOwnerRole|CddProviderRole|VenueOwnerRole|PortfolioCustodianRole|IdentityRole|DidRegistrarRole
Defined in: api/procedures/types.ts:322
RotatePrimaryKeyToSecondaryParams =
object
Defined in: api/procedures/types.ts:1034
optionalexpiry?:Date
Defined in: api/procedures/types.ts:1043
(optional) when the generated authorization should expire
permissions:
PermissionsLike
Defined in: api/procedures/types.ts:1035
targetAccount:
string|Account
Defined in: api/procedures/types.ts:1039
The Account that should function as the primary key of the newly created Identity. Can be ss58 encoded address or an instance of Account
SetMetadataParams = {
details?:MetadataValueDetails;value:string; } | {details:MetadataValueDetails; }
Defined in: api/procedures/types.ts:1907
SetTransferRestrictionParams =
CountTransferRestrictionInput|PercentageTransferRestrictionInput|ClaimCountTransferRestrictionInput|ClaimPercentageTransferRestrictionInput
Defined in: api/procedures/types.ts:488
SetTransferRestrictionStatParams =
object
Defined in: api/procedures/types.ts:562
stats: (
AddCountStatParams|AddBalanceStatParams|AddClaimCountStatParams|AddClaimBalanceStatParams)[]
Defined in: api/procedures/types.ts:563
SetVenueFilteringParams =
object
Defined in: api/procedures/types.ts:1923
optionalallowedVenues?:BigNumber[]
Defined in: api/procedures/types.ts:1925
optionaldisallowedVenues?:BigNumber[]
Defined in: api/procedures/types.ts:1926
optionalenabled?:boolean
Defined in: api/procedures/types.ts:1924
TransactionArray<
ReturnValues> ={ [K in keyof ReturnValues]: GenericPolymeshTransaction<any, ReturnValues[K]> }
Defined in: api/procedures/types.ts:251
| Type Parameter |
|---|
ReturnValues extends readonly [...unknown[]] |
TransferFundsParams =
InstructionFungibleLeg|InstructionNftLeg&object
Defined in: api/procedures/types.ts:2166
optionalmemo?:string
TransferRestriction = {
type:Count;value:BigNumber; } | {type:Percentage;value:BigNumber; } | {type:ClaimCount;value:ClaimCountRestrictionValue; } | {type:ClaimPercentage;value:ClaimPercentageRestrictionValue; }
Defined in: api/procedures/types.ts:592
TransferRestrictionExemptionParams =
object
Defined in: api/procedures/types.ts:676
optionalclaim?:ClaimType
Defined in: api/procedures/types.ts:679
identities: (
Identity|string)[]
Defined in: api/procedures/types.ts:678
type:
StatType
Defined in: api/procedures/types.ts:677
TransferRestrictionParams =
object
Defined in: api/procedures/types.ts:663
restrictions: (
TransferRestrictionInputCount|TransferRestrictionInputPercentage|TransferRestrictionClaimCountInput|TransferRestrictionInputClaimPercentage)[]
Defined in: api/procedures/types.ts:664
WithdrawInstructionParams =
object
Defined in: api/procedures/types.ts:1171
withdrawing affirmation is no longer supported in chain v8
optionalholders?:AssetHolderLike[]
Defined in: api/procedures/types.ts:1177
(optional) Asset holders that the signer controls and wants to affirm the instruction or withdraw affirmation
if empty, all the legs containing any custodied Asset Holders of the signer will be affirmed/affirmation will be withdrawn, based on the operation.