@polymeshassociation/polymesh-sdk 27.5.0 → 27.6.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/api/entities/Asset/Fungible/CorporateActions/Ballots.d.ts +30 -0
  3. package/api/entities/Asset/Fungible/CorporateActions/Ballots.d.ts.map +1 -0
  4. package/api/entities/Asset/Fungible/CorporateActions/Ballots.js +80 -0
  5. package/api/entities/Asset/Fungible/CorporateActions/Ballots.js.map +1 -0
  6. package/api/entities/Asset/Fungible/CorporateActions/index.d.ts +5 -2
  7. package/api/entities/Asset/Fungible/CorporateActions/index.d.ts.map +1 -1
  8. package/api/entities/Asset/Fungible/CorporateActions/index.js +4 -0
  9. package/api/entities/Asset/Fungible/CorporateActions/index.js.map +1 -1
  10. package/api/entities/CorporateBallot/index.d.ts +84 -0
  11. package/api/entities/CorporateBallot/index.d.ts.map +1 -0
  12. package/api/entities/CorporateBallot/index.js +190 -0
  13. package/api/entities/CorporateBallot/index.js.map +1 -0
  14. package/api/entities/CorporateBallot/types.d.ts +119 -0
  15. package/api/entities/CorporateBallot/types.d.ts.map +1 -0
  16. package/api/entities/CorporateBallot/types.js +10 -0
  17. package/api/entities/CorporateBallot/types.js.map +1 -0
  18. package/api/entities/types.d.ts +6 -1
  19. package/api/entities/types.d.ts.map +1 -1
  20. package/api/entities/types.js.map +1 -1
  21. package/api/procedures/castBallotVote.d.ts +46 -0
  22. package/api/procedures/castBallotVote.d.ts.map +1 -0
  23. package/api/procedures/castBallotVote.js +151 -0
  24. package/api/procedures/castBallotVote.js.map +1 -0
  25. package/api/procedures/createBallot.d.ts +33 -0
  26. package/api/procedures/createBallot.d.ts.map +1 -0
  27. package/api/procedures/createBallot.js +92 -0
  28. package/api/procedures/createBallot.js.map +1 -0
  29. package/api/procedures/initiateCorporateAction.d.ts +31 -0
  30. package/api/procedures/initiateCorporateAction.d.ts.map +1 -0
  31. package/api/procedures/initiateCorporateAction.js +137 -0
  32. package/api/procedures/initiateCorporateAction.js.map +1 -0
  33. package/api/procedures/modifyBallot.d.ts +40 -0
  34. package/api/procedures/modifyBallot.d.ts.map +1 -0
  35. package/api/procedures/modifyBallot.js +157 -0
  36. package/api/procedures/modifyBallot.js.map +1 -0
  37. package/api/procedures/modifyCaCheckpoint.d.ts.map +1 -1
  38. package/api/procedures/modifyCaCheckpoint.js +16 -1
  39. package/api/procedures/modifyCaCheckpoint.js.map +1 -1
  40. package/api/procedures/removeBallot.d.ts +23 -0
  41. package/api/procedures/removeBallot.d.ts.map +1 -0
  42. package/api/procedures/removeBallot.js +53 -0
  43. package/api/procedures/removeBallot.js.map +1 -0
  44. package/api/procedures/types.d.ts +79 -2
  45. package/api/procedures/types.d.ts.map +1 -1
  46. package/api/procedures/types.js.map +1 -1
  47. package/api/procedures/utils.d.ts +4 -6
  48. package/api/procedures/utils.d.ts.map +1 -1
  49. package/api/procedures/utils.js +43 -19
  50. package/api/procedures/utils.js.map +1 -1
  51. package/generated/types.d.ts +11 -4
  52. package/generated/types.d.ts.map +1 -1
  53. package/generated/types.js +9 -1
  54. package/generated/types.js.map +1 -1
  55. package/internal.d.ts +1 -0
  56. package/internal.d.ts.map +1 -1
  57. package/internal.js +3 -1
  58. package/internal.js.map +1 -1
  59. package/npm-package/polymeshassociation-polymesh-sdk-27.6.0-beta.1.tgz +0 -0
  60. package/package.json +9 -5
  61. package/polkadot/augment-api-consts.d.ts +85 -1
  62. package/polkadot/augment-api-consts.d.ts.map +1 -1
  63. package/polkadot/augment-api-errors.d.ts +44 -12
  64. package/polkadot/augment-api-errors.d.ts.map +1 -1
  65. package/polkadot/augment-api-events.d.ts +179 -51
  66. package/polkadot/augment-api-events.d.ts.map +1 -1
  67. package/polkadot/augment-api-query.d.ts +49 -59
  68. package/polkadot/augment-api-query.d.ts.map +1 -1
  69. package/polkadot/augment-api-runtime.d.ts +144 -3
  70. package/polkadot/augment-api-runtime.d.ts.map +1 -1
  71. package/polkadot/augment-api-tx.d.ts +663 -284
  72. package/polkadot/augment-api-tx.d.ts.map +1 -1
  73. package/polkadot/lookup.d.ts +388 -509
  74. package/polkadot/lookup.d.ts.map +1 -1
  75. package/polkadot/lookup.js +408 -521
  76. package/polkadot/lookup.js.map +1 -1
  77. package/polkadot/polymesh/definitions.d.ts +307 -1
  78. package/polkadot/polymesh/definitions.d.ts.map +1 -1
  79. package/polkadot/polymesh/definitions.js +571 -1
  80. package/polkadot/polymesh/definitions.js.map +1 -1
  81. package/polkadot/registry.d.ts +36 -53
  82. package/polkadot/registry.d.ts.map +1 -1
  83. package/polkadot/types-lookup.d.ts +431 -582
  84. package/polkadot/types-lookup.d.ts.map +1 -1
  85. package/utils/constants.d.ts +1 -0
  86. package/utils/constants.d.ts.map +1 -1
  87. package/utils/constants.js +2 -1
  88. package/utils/constants.js.map +1 -1
  89. package/utils/conversion.d.ts +41 -3
  90. package/utils/conversion.d.ts.map +1 -1
  91. package/utils/conversion.js +561 -412
  92. package/utils/conversion.js.map +1 -1
  93. package/utils/internal.d.ts +29 -1
  94. package/utils/internal.d.ts.map +1 -1
  95. package/utils/internal.js +106 -1
  96. package/utils/internal.js.map +1 -1
@@ -3,7 +3,7 @@ import type { ApiTypes, AugmentedSubmittable, SubmittableExtrinsic, SubmittableE
3
3
  import type { BTreeSet, Bytes, Compact, Option, U8aFixed, Vec, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
4
4
  import type { AnyNumber, IMethod, ITuple } from '@polkadot/types-codec/types';
5
5
  import type { AccountId32, Call, H256, MultiAddress, Perbill, Percent, Permill } from '@polkadot/types/interfaces/runtime';
6
- import type { PalletContractsWasmDeterminism, PalletCorporateActionsBallotBallotMeta, PalletCorporateActionsBallotBallotTimeRange, PalletCorporateActionsBallotBallotVote, PalletCorporateActionsCaId, PalletCorporateActionsCaKind, PalletCorporateActionsInitiateCorporateActionArgs, PalletCorporateActionsRecordDateSpec, PalletCorporateActionsTargetIdentities, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletPipsSnapshotResult, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingSlashingSwitch, PalletStakingValidatorPrefs, PalletStoPriceTier, PalletUtilityUniqueCall, PolymeshCommonUtilitiesCheckpointScheduleCheckpoints, PolymeshCommonUtilitiesIdentityCreateChildIdentityWithAuth, PolymeshCommonUtilitiesIdentitySecondaryKeyWithAuth, PolymeshCommonUtilitiesMaybeBlock, PolymeshCommonUtilitiesProtocolFeeProtocolOp, PolymeshContractsApi, PolymeshContractsChainExtensionExtrinsicId, PolymeshContractsNextUpgrade, PolymeshPrimitivesAgentAgentGroup, PolymeshPrimitivesAssetAssetId, PolymeshPrimitivesAssetAssetType, PolymeshPrimitivesAssetIdentifier, PolymeshPrimitivesAssetMetadataAssetMetadataKey, PolymeshPrimitivesAssetMetadataAssetMetadataSpec, PolymeshPrimitivesAssetMetadataAssetMetadataValueDetail, PolymeshPrimitivesAssetNonFungibleType, PolymeshPrimitivesAuthorizationAuthorizationData, PolymeshPrimitivesBeneficiary, PolymeshPrimitivesComplianceManagerComplianceRequirement, PolymeshPrimitivesCondition, PolymeshPrimitivesConditionTrustedIssuer, PolymeshPrimitivesDocument, PolymeshPrimitivesIdentityClaimClaim, PolymeshPrimitivesIdentityClaimClaimType, PolymeshPrimitivesIdentityClaimScope, PolymeshPrimitivesIdentityId, PolymeshPrimitivesIdentityIdPortfolioId, PolymeshPrimitivesIdentityIdPortfolioKind, PolymeshPrimitivesMemo, PolymeshPrimitivesNftNfTs, PolymeshPrimitivesNftNftCollectionKeys, PolymeshPrimitivesNftNftMetadataAttribute, PolymeshPrimitivesPortfolioFund, PolymeshPrimitivesPosRatio, PolymeshPrimitivesSecondaryKey, PolymeshPrimitivesSecondaryKeyExtrinsicPermissions, PolymeshPrimitivesSecondaryKeyPermissions, PolymeshPrimitivesSecondaryKeySignatory, PolymeshPrimitivesSettlementAffirmationCount, PolymeshPrimitivesSettlementAssetCount, PolymeshPrimitivesSettlementLeg, PolymeshPrimitivesSettlementReceiptDetails, PolymeshPrimitivesSettlementSettlementType, PolymeshPrimitivesSettlementVenueType, PolymeshPrimitivesStatisticsStatType, PolymeshPrimitivesStatisticsStatUpdate, PolymeshPrimitivesTicker, PolymeshPrimitivesTransferComplianceTransferCondition, PolymeshPrimitivesTransferComplianceTransferConditionExemptKey, PolymeshRuntimeDevelopRuntimeOriginCaller, PolymeshRuntimeDevelopRuntimeSessionKeys, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeMultiSignature, SpSessionMembershipProof, SpWeightsWeightV2Weight } from "./types-lookup.ts";
6
+ import type { PalletContractsWasmDeterminism, PalletCorporateActionsBallotBallotMeta, PalletCorporateActionsBallotBallotTimeRange, PalletCorporateActionsBallotBallotVote, PalletCorporateActionsCaId, PalletCorporateActionsCaKind, PalletCorporateActionsInitiateCorporateActionArgs, PalletCorporateActionsRecordDateSpec, PalletCorporateActionsTargetIdentities, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletPipsSnapshotResult, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingSlashingSwitch, PalletStakingValidatorPrefs, PalletStoPriceTier, PalletUtilityUniqueCall, PolymeshCommonUtilitiesCheckpointScheduleCheckpoints, PolymeshCommonUtilitiesIdentityCreateChildIdentityWithAuth, PolymeshCommonUtilitiesIdentitySecondaryKeyWithAuth, PolymeshCommonUtilitiesProtocolFeeProtocolOp, PolymeshContractsApi, PolymeshContractsChainExtensionExtrinsicId, PolymeshContractsNextUpgrade, PolymeshPrimitivesAgentAgentGroup, PolymeshPrimitivesAssetAssetId, PolymeshPrimitivesAssetAssetType, PolymeshPrimitivesAssetIdentifier, PolymeshPrimitivesAssetMetadataAssetMetadataKey, PolymeshPrimitivesAssetMetadataAssetMetadataSpec, PolymeshPrimitivesAssetMetadataAssetMetadataValueDetail, PolymeshPrimitivesAssetNonFungibleType, PolymeshPrimitivesAuthorizationAuthorizationData, PolymeshPrimitivesBeneficiary, PolymeshPrimitivesComplianceManagerComplianceRequirement, PolymeshPrimitivesCondition, PolymeshPrimitivesConditionTrustedIssuer, PolymeshPrimitivesDocument, PolymeshPrimitivesIdentityClaimClaim, PolymeshPrimitivesIdentityClaimClaimType, PolymeshPrimitivesIdentityClaimScope, PolymeshPrimitivesIdentityId, PolymeshPrimitivesIdentityIdPortfolioId, PolymeshPrimitivesIdentityIdPortfolioKind, PolymeshPrimitivesMaybeBlock, PolymeshPrimitivesMemo, PolymeshPrimitivesNftNfTs, PolymeshPrimitivesNftNftCollectionKeys, PolymeshPrimitivesNftNftMetadataAttribute, PolymeshPrimitivesPortfolioFund, PolymeshPrimitivesPosRatio, PolymeshPrimitivesSecondaryKey, PolymeshPrimitivesSecondaryKeyExtrinsicPermissions, PolymeshPrimitivesSecondaryKeyPermissions, PolymeshPrimitivesSecondaryKeySignatory, PolymeshPrimitivesSettlementAffirmationCount, PolymeshPrimitivesSettlementAssetCount, PolymeshPrimitivesSettlementLeg, PolymeshPrimitivesSettlementReceiptDetails, PolymeshPrimitivesSettlementSettlementType, PolymeshPrimitivesSettlementVenueType, PolymeshPrimitivesStatisticsStatType, PolymeshPrimitivesStatisticsStatUpdate, PolymeshPrimitivesTicker, PolymeshPrimitivesTransferComplianceTransferCondition, PolymeshPrimitivesTransferComplianceTransferConditionExemptKey, PolymeshRuntimeDevelopRuntimeOriginCaller, PolymeshRuntimeDevelopRuntimeSessionKeys, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeMultiSignature, SpSessionMembershipProof, SpWeightsWeightV2Weight } from "./types-lookup.ts";
7
7
  export declare type __AugmentedSubmittable = AugmentedSubmittable<() => unknown>;
8
8
  export declare type __SubmittableExtrinsic<ApiType extends ApiTypes> = SubmittableExtrinsic<ApiType>;
9
9
  export declare type __SubmittableExtrinsicFunction<ApiType extends ApiTypes> = SubmittableExtrinsicFunction<ApiType>;
@@ -11,12 +11,21 @@ declare module '@polkadot/api-base/types/submittable' {
11
11
  interface AugmentedSubmittables<ApiType extends ApiTypes> {
12
12
  asset: {
13
13
  /**
14
- * This function is used to accept a token ownership transfer.
14
+ * Accepts an asset ownership transfer.
15
+ *
16
+ * Consumes the authorization `auth_id` (see `pallet_identity::consume_auth`).
15
17
  * NB: To reject the transfer, call remove auth function in identity module.
16
18
  *
17
19
  * # Arguments
18
- * * `origin`: it contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
19
- * * `auth_id`: authorization ID of the token ownership transfer authorization.
20
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
21
+ * * `auth_id` - Authorization ID of the asset ownership transfer authorization.
22
+ *
23
+ * # Events
24
+ * * `AssetOwnershipTransferred` - When a asset ownership is successfully transferred.
25
+ *
26
+ * # Errors
27
+ * * `TickerRegistrationNotFound` - If the ticker registration is not found.
28
+ * * `TickerIsAlreadyLinkedToAnAsset` - If the ticker is already linked to an asset.
20
29
  **/
21
30
  acceptAssetOwnershipTransfer: AugmentedSubmittable<(authId: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
22
31
  u64
@@ -28,22 +37,37 @@ declare module '@polkadot/api-base/types/submittable' {
28
37
  * NB: To reject the transfer, call remove auth function in identity module.
29
38
  *
30
39
  * # Arguments
31
- * * `origin`: it contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
32
- * * `auth_id`: authorization ID of ticker transfer authorization.
40
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
41
+ * * `auth_id` - Authorization ID of ticker transfer authorization.
42
+ *
43
+ * # Events
44
+ * * `TickerTransferred` - When a ticker is successfully transferred.
45
+ *
46
+ * # Errors
47
+ * * `TickerRegistrationNotFound` - If the ticker registration is not found.
48
+ * * `TickerIsAlreadyLinkedToAnAsset` - If the ticker is already linked to an asset.
33
49
  **/
34
50
  acceptTickerTransfer: AugmentedSubmittable<(authId: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
35
51
  u64
36
52
  ]>;
37
53
  /**
38
- * Add documents for a given token.
54
+ * Add documents for a given asset.
55
+ *
56
+ * This function allows the asset issuer or an external agent to add documents to an asset.
39
57
  *
40
58
  * # Arguments
41
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
42
- * * `asset_id`: the [`AssetId`] associated to the token.
43
- * * `docs`: documents to be attached to the token.
59
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
60
+ * * `asset_id` - The [`AssetId`] associated to the asset.
61
+ * * `docs` - Documents to be attached to the asset.
44
62
  *
45
63
  * # Permissions
46
64
  * * Asset
65
+ *
66
+ * # Events
67
+ * * `DocumentAdded` - When a document is successfully added to an asset.
68
+ *
69
+ * # Errors
70
+ * * `CounterOverflow` - If the document ID counter overflows.
47
71
  **/
48
72
  addDocuments: AugmentedSubmittable<(docs: Vec<PolymeshPrimitivesDocument> | (PolymeshPrimitivesDocument | {
49
73
  uri?: any;
@@ -56,32 +80,50 @@ declare module '@polkadot/api-base/types/submittable' {
56
80
  PolymeshPrimitivesAssetAssetId
57
81
  ]>;
58
82
  /**
59
- * Sets all identities in the `mediators` set as mandatory mediators for any instruction transfering `asset_id`.
83
+ * Sets all identities in the `mediators` set as mandatory mediators for any instruction transferring `asset_id`.
84
+ *
85
+ * This function allows the asset issuer or an external agent to add mandatory mediators for an asset.
60
86
  *
61
87
  * # Arguments
62
- * * `origin`: The secondary key of the sender.
63
- * * `asset_id`: the [`AssetId`] of the asset that will require the mediators.
64
- * * `mediators`: A set of [`IdentityId`] of all the mandatory mediators for the given ticker.
88
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
89
+ * * `asset_id` - The [`AssetId`] of the asset that will require the mediators.
90
+ * * `mediators` - A set of [`IdentityId`] of all the mandatory mediators for the given ticker.
65
91
  *
66
92
  * # Permissions
67
93
  * * Asset
94
+ *
95
+ * # Events
96
+ * * `AssetMediatorsAdded` - When the mandatory mediators are successfully added.
97
+ *
98
+ * # Errors
99
+ * * `NumberOfAssetMediatorsExceeded` - If the number of mandatory mediators exceeds the maximum allowed limit.
68
100
  **/
69
101
  addMandatoryMediators: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, mediators: BTreeSet<PolymeshPrimitivesIdentityId>) => SubmittableExtrinsic<ApiType>, [
70
102
  PolymeshPrimitivesAssetAssetId,
71
103
  BTreeSet<PolymeshPrimitivesIdentityId>
72
104
  ]>;
73
105
  /**
74
- * Forces a transfer of token from `from_portfolio` to the caller's default portfolio.
106
+ * Forces a transfer of tokens from `from_portfolio` to the caller's default portfolio.
107
+ *
108
+ * This function allows the asset issuer or an external agent to force a transfer of tokens from one portfolio to another.
75
109
  *
76
110
  * # Arguments
77
- * * `origin`: a signer that has permissions to act as an agent of `asset_id`.
78
- * * `asset_id`: the [`AssetId`] associated to the token.
79
- * * `value`: the [`Balance`] of tokens that will be transferred.
80
- * * `from_portfolio`: the [`PortfolioId`] that will have its balance reduced.
111
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
112
+ * * `asset_id` - The [`AssetId`] associated to the asset.
113
+ * * `value` - The [`Balance`] of tokens that will be transferred.
114
+ * * `from_portfolio` - The [`PortfolioId`] that will have its balance reduced.
81
115
  *
82
116
  * # Permissions
83
117
  * * Asset
84
118
  * * Portfolio
119
+ *
120
+ * # Events
121
+ * * `ControllerTransfer` - When tokens are successfully transferred.
122
+ *
123
+ * # Errors
124
+ * * `UnexpectedNonFungibleToken` - If the asset is a non-fungible token.
125
+ * * `InvalidGranularity` - If the amount to transfer does not meet the granularity requirements.
126
+ * * `TotalSupplyOverflow` - If the total supply exceeds the maximum allowed limit.
85
127
  **/
86
128
  controllerTransfer: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, value: u128 | AnyNumber | Uint8Array, fromPortfolio: PolymeshPrimitivesIdentityIdPortfolioId | {
87
129
  did?: any;
@@ -92,19 +134,25 @@ declare module '@polkadot/api-base/types/submittable' {
92
134
  PolymeshPrimitivesIdentityIdPortfolioId
93
135
  ]>;
94
136
  /**
95
- * Initializes a new [`AssetDetails`], with the initiating account as its owner.
96
- * The total supply will initially be zero. To mint tokens, use [`Module::issue`].
137
+ * Creates a new asset.
138
+ *
139
+ * The total supply will initially be zero. To mint tokens, use [`Pallet::issue`].
97
140
  *
98
141
  * # Arguments
99
- * * `origin`: contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
100
- * * `asset_name`: the [`AssetName`] associated to the security token.
101
- * * `divisible`: sets [`AssetDetails::divisible`], where `true` means the token is divisible.
102
- * * `asset_type`: the [`AssetType`] that represents the security type of the [`AssetDetails`].
103
- * * `asset_identifiers`: a vector of [`AssetIdentifier`].
104
- * * `funding_round_name`: the name of the funding round ([`FundingRoundName`]).
142
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
143
+ * * `asset_name` - The [`AssetName`] of the new asset.
144
+ * * `divisible` - Sets [`AssetDetails::divisible`], where `true` means the asset is divisible.
145
+ * * `asset_type` - The [`AssetType`] of the new asset.
146
+ * * `asset_identifiers` - A vector of [`AssetIdentifier`].
147
+ * * `funding_round_name` - The name of the funding round ([`FundingRoundName`]).
105
148
  *
106
- * ## Permissions
107
- * * Portfolio
149
+ * # Events
150
+ * * `AssetCreated` - When a new asset is successfully created.
151
+ *
152
+ * # Errors
153
+ * * `MaxLengthOfAssetNameExceeded` - If the asset name length exceeds the maximum allowed length.
154
+ * * `InvalidCustomAssetTypeId` - If the custom asset type ID is invalid.
155
+ * * `InvalidAssetIdentifier` - If any of the asset identifiers are invalid.
108
156
  **/
109
157
  createAsset: AugmentedSubmittable<(assetName: Bytes | string | Uint8Array, divisible: bool | boolean | Uint8Array, assetType: PolymeshPrimitivesAssetAssetType | {
110
158
  EquityCommon: any;
@@ -148,20 +196,28 @@ declare module '@polkadot/api-base/types/submittable' {
148
196
  Option<Bytes>
149
197
  ]>;
150
198
  /**
151
- * Initializes a new [`AssetDetails`], with the initiating account as its owner.
152
- * The total supply will initially be zero. To mint tokens, use [`Module::issue`].
153
- * Note: Utility extrinsic to batch [`Module::create_asset`] and [`Module::register_custom_asset_type`].
199
+ * Creates a new asset with a new custom asset type.
200
+ *
201
+ * The total supply will initially be zero. To mint tokens, use [`Pallet::issue`].
154
202
  *
155
203
  * # Arguments
156
- * * `origin`: contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
157
- * * `asset_name`: the [`AssetName`] associated to the security token.
158
- * * `divisible`: sets [`AssetDetails::divisible`], where `true` means the token is divisible.
159
- * * `custom_asset_type`: the custom asset type of the token.
160
- * * `asset_identifiers`: a vector of [`AssetIdentifier`].
161
- * * `funding_round_name`: the name of the funding round ([`FundingRoundName`]).
204
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
205
+ * * `asset_name` - The [`AssetName`] of the new asset.
206
+ * * `divisible` - Sets [`AssetDetails::divisible`], where `true` means the asset is divisible.
207
+ * * `custom_asset_type` - The custom asset type of the asset.
208
+ * * `asset_identifiers` - A vector of [`AssetIdentifier`].
209
+ * * `funding_round_name` - The name of the funding round ([`FundingRoundName`]).
162
210
  *
163
- * ## Permissions
164
- * * Portfolio
211
+ * # Events
212
+ * * `AssetCreated` - When a new asset is successfully created.
213
+ * * `CustomAssetTypeRegistered` - When a new custom asset type is successfully registered.
214
+ * * `CustomAssetTypeAlreadyRegistered` - When the custom asset type is already registered.
215
+ *
216
+ * # Errors
217
+ * * `MaxLengthOfAssetNameExceeded` - If the asset name length exceeds the maximum allowed length.
218
+ * * `InvalidCustomAssetTypeId` - If the custom asset type ID is invalid.
219
+ * * `InvalidAssetIdentifier` - If any of the asset identifiers are invalid.
220
+ * * `TooLong` - If the custom asset type length exceeds the maximum allowed length.
165
221
  **/
166
222
  createAssetWithCustomType: AugmentedSubmittable<(assetName: Bytes | string | Uint8Array, divisible: bool | boolean | Uint8Array, customAssetType: Bytes | string | Uint8Array, assetIdentifiers: Vec<PolymeshPrimitivesAssetIdentifier> | (PolymeshPrimitivesAssetIdentifier | {
167
223
  CUSIP: any;
@@ -183,25 +239,36 @@ declare module '@polkadot/api-base/types/submittable' {
183
239
  /**
184
240
  * Pre-approves the receivement of the asset for all identities.
185
241
  *
242
+ * This function allows the root origin to pre-approve the receivement of an asset for all identities.
243
+ *
186
244
  * # Arguments
187
- * * `origin`: the secondary key of the sender.
188
- * * `asset_id`: the [`AssetId`] that will be exempt from affirmation.
245
+ * * `origin` - The root origin.
246
+ * * `asset_id` - The [`AssetId`] that will be exempt from affirmation.
189
247
  *
190
- * # Permissions
191
- * * Root
248
+ * # Events
249
+ * * `AssetAffirmationExemption` - When the asset is successfully exempted from affirmation.
192
250
  **/
193
251
  exemptAssetAffirmation: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
194
252
  PolymeshPrimitivesAssetAssetId
195
253
  ]>;
196
254
  /**
197
- * Freezes transfers of a given token.
255
+ * Freezes transfers of a given asset.
256
+ *
257
+ * This function allows the asset issuer or an external agent to freeze transfers of a given asset.
198
258
  *
199
259
  * # Arguments
200
- * * `origin`: the secondary key of the sender.
201
- * * `asset_id`: the [`AssetId`] associated to the token.
260
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
261
+ * * `asset_id` - The asset to freeze.
202
262
  *
203
263
  * # Permissions
204
264
  * * Asset
265
+ *
266
+ * # Events
267
+ * * `AssetFrozen` - When an asset is successfully frozen.
268
+ *
269
+ * # Errors
270
+ * * `NoSuchAsset` - If the asset does not exist.
271
+ * * `AlreadyFrozen` - If the asset is already frozen.
205
272
  **/
206
273
  freeze: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
207
274
  PolymeshPrimitivesAssetAssetId
@@ -209,15 +276,25 @@ declare module '@polkadot/api-base/types/submittable' {
209
276
  /**
210
277
  * Issue (i.e mint) new tokens to the caller, which must be an authorized external agent.
211
278
  *
279
+ * This function allows the asset issuer or an external agent to mint new tokens for a given asset.
280
+ *
212
281
  * # Arguments
213
282
  * * `origin`: A signer that has permissions to act as an agent of `ticker`.
214
- * * `asset_id`: the [`AssetId`] associated to the token.
283
+ * * `asset_id`: the [`AssetId`] associated to the asset.
215
284
  * * `amount`: The amount of tokens that will be issued.
216
285
  * * `portfolio_kind`: The [`PortfolioKind`] of the portfolio that will receive the minted tokens.
217
286
  *
218
287
  * # Permissions
219
288
  * * Asset
220
289
  * * Portfolio
290
+ *
291
+ * # Events
292
+ * * `AssetBalanceUpdated` - When the asset balance is successfully updated.
293
+ *
294
+ * # Errors
295
+ * * `UnexpectedNonFungibleToken` - If the asset is a non-fungible token.
296
+ * * `InvalidGranularity` - If the amount to issue does not meet the granularity requirements.
297
+ * * `TotalSupplyOverflow` - If the total supply exceeds the maximum allowed limit.
221
298
  **/
222
299
  issue: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, amount: u128 | AnyNumber | Uint8Array, portfolioKind: PolymeshPrimitivesIdentityIdPortfolioKind | {
223
300
  Default: any;
@@ -231,27 +308,49 @@ declare module '@polkadot/api-base/types/submittable' {
231
308
  /**
232
309
  * Establishes a connection between a ticker and an AssetId.
233
310
  *
311
+ * This function allows the asset issuer or an external agent to link a ticker to an asset.
312
+ *
234
313
  * # Arguments
235
- * * `origin`: the secondary key of the sender.
236
- * * `ticker`: the [`Ticker`] that will be linked to the given `asset_id`.
237
- * * `asset_id`: the [`AssetId`] that will be connected to `ticker`.
314
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
315
+ * * `ticker` - The [`Ticker`] that will be linked to the given `asset_id`.
316
+ * * `asset_id` - The [`AssetId`] that will be connected to `ticker`.
238
317
  *
239
318
  * # Permissions
240
319
  * * Asset
320
+ *
321
+ * # Events
322
+ * * `TickerLinkedToAsset` - When the ticker is successfully linked to the asset.
323
+ *
324
+ * # Errors
325
+ * * `TickerNotRegisteredToCaller` - If the ticker is not registered to the caller.
326
+ * * `TickerRegistrationExpired` - If the ticker registration has expired.
327
+ * * `TickerRegistrationNotFound` - If the ticker registration is not found.
328
+ * * `TickerIsAlreadyLinkedToAnAsset` - If the ticker is already linked to an asset.
329
+ * * `AssetIsAlreadyLinkedToATicker` - If the asset is already linked to a ticker.
241
330
  **/
242
331
  linkTickerToAssetId: AugmentedSubmittable<(ticker: PolymeshPrimitivesTicker | string | Uint8Array, assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
243
332
  PolymeshPrimitivesTicker,
244
333
  PolymeshPrimitivesAssetAssetId
245
334
  ]>;
246
335
  /**
247
- * If the token associated to `asset_id` is indivisible, sets [`AssetDetails::divisible`] to true.
336
+ * If the asset associated to `asset_id` is indivisible, sets [`AssetDetails::divisible`] to true.
337
+ *
338
+ * This function allows the asset issuer or an external agent to make an indivisible asset divisible.
248
339
  *
249
340
  * # Arguments
250
- * * `origin`: is a signer that has permissions to act as an agent of `ticker`.
251
- * * `asset_id`: the [`AssetId`] associated to the token.
341
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
342
+ * * `asset_id` - The [`AssetId`] associated to the asset.
252
343
  *
253
344
  * # Permissions
254
345
  * * Asset
346
+ *
347
+ * # Events
348
+ * * `DivisibilityChanged` - When the divisibility of an asset is successfully changed.
349
+ *
350
+ * # Errors
351
+ * * `NoSuchAsset` - If the asset does not exist.
352
+ * * `UnexpectedNonFungibleToken` - If the asset is a non-fungible token.
353
+ * * `AssetAlreadyDivisible` - If the asset is already divisible.
255
354
  **/
256
355
  makeDivisible: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
257
356
  PolymeshPrimitivesAssetAssetId
@@ -260,27 +359,40 @@ declare module '@polkadot/api-base/types/submittable' {
260
359
  * Pre-approves the receivement of an asset.
261
360
  *
262
361
  * # Arguments
263
- * * `origin`: the secondary key of the sender.
264
- * * `asset_id`: the [`AssetId`] that will be exempt from affirmation.
362
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
363
+ * * `asset_id` - The [`AssetId`] that will be exempt from affirmation.
265
364
  *
266
365
  * # Permissions
267
366
  * * Asset
367
+ *
368
+ * # Events
369
+ * * `PreApprovedAsset` - When the asset is successfully pre-approved for receivement.
268
370
  **/
269
371
  preApproveAsset: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
270
372
  PolymeshPrimitivesAssetAssetId
271
373
  ]>;
272
374
  /**
273
- * Redeems (i.e burns) existing tokens by reducing the balance of the caller's portfolio and the total supply of the token.
375
+ * Redeems (i.e burns) existing tokens by reducing the balance of the caller's portfolio and the total supply of the asset.
376
+ *
377
+ * This function allows the asset issuer or an external agent to redeem tokens from a given asset.
274
378
  *
275
379
  * # Arguments
276
380
  * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
277
- * * `asset_id`: the [`AssetId`] associated to the token.
381
+ * * `asset_id`: the [`AssetId`] associated to the asset.
278
382
  * * `value`: amount of tokens to redeem.
279
383
  * * `portfolio_kind`: the [`PortfolioKind`] that will have its balance reduced.
280
384
  *
281
385
  * # Permissions
282
386
  * * Asset
283
387
  * * Portfolio
388
+ *
389
+ * # Events
390
+ * * `AssetBalanceUpdated` - When the asset balance is successfully updated.
391
+ *
392
+ * # Errors
393
+ * * `UnexpectedNonFungibleToken` - If the asset is a non-fungible token.
394
+ * * `InvalidGranularity` - If the value to redeem does not meet the granularity requirements.
395
+ * * `TotalSupplyOverflow` - If the total supply exceeds the maximum allowed limit.
284
396
  **/
285
397
  redeem: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, value: u128 | AnyNumber | Uint8Array, portfolioKind: PolymeshPrimitivesIdentityIdPortfolioKind | {
286
398
  Default: any;
@@ -294,17 +406,27 @@ declare module '@polkadot/api-base/types/submittable' {
294
406
  /**
295
407
  * Registers and set local asset metadata.
296
408
  *
409
+ * This function allows the asset issuer or an external agent to register and set local metadata for an asset.
410
+ *
297
411
  * # Arguments
298
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
299
- * * `asset_id`: the [`AssetId`] associated to the token.
300
- * * `name`: the [`AssetMetadataName`].
301
- * * `spec`: the asset metadata specifications ([`AssetMetadataSpec`]).
302
- * * `value`: the [`AssetMetadataValue`] of the given metadata key.
303
- * * `details`: optional [`AssetMetadataValueDetail`] (expire, lock status).
412
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
413
+ * * `asset_id` - The [`AssetId`] associated to the asset.
414
+ * * `name` - The [`AssetMetadataName`].
415
+ * * `spec` - The asset metadata specifications ([`AssetMetadataSpec`]).
416
+ * * `value` - The [`AssetMetadataValue`] of the given metadata key.
417
+ * * `details` - Optional [`AssetMetadataValueDetail`] (expire, lock status).
304
418
  *
305
419
  * # Permissions
306
- * * Agent
307
420
  * * Asset
421
+ *
422
+ * # Events
423
+ * * `RegisterAssetMetadataLocalType` - When the local asset metadata type is successfully registered.
424
+ * * `SetAssetMetadataValue` - When the asset metadata value is successfully set.
425
+ *
426
+ * # Errors
427
+ * * `AssetMetadataLocalKeyAlreadyExists` - If the local metadata key already exists.
428
+ * * `AssetMetadataValueIsLocked` - If the metadata value is locked.
429
+ * * `AssetMetadataValueMaxLengthExceeded` - If the metadata value length exceeds the maximum allowed length.
308
430
  **/
309
431
  registerAndSetLocalAssetMetadata: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, name: Bytes | string | Uint8Array, spec: PolymeshPrimitivesAssetMetadataAssetMetadataSpec | {
310
432
  url?: any;
@@ -323,10 +445,20 @@ declare module '@polkadot/api-base/types/submittable' {
323
445
  /**
324
446
  * Registers asset metadata global type.
325
447
  *
448
+ * This function allows the root origin to register a global metadata type.
449
+ *
326
450
  * # Arguments
327
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
328
- * * `name`: the [`AssetMetadataName`].
329
- * * `spec`: the asset metadata specifications ([`AssetMetadataSpec`]).
451
+ * * `origin` - The root origin.
452
+ * * `name` - The [`AssetMetadataName`].
453
+ * * `spec` - The asset metadata specifications ([`AssetMetadataSpec`]).
454
+ *
455
+ * # Events
456
+ * * `RegisterAssetMetadataGlobalType` - When the global asset metadata type is successfully registered.
457
+ *
458
+ * # Errors
459
+ * * `AssetMetadataGlobalKeyAlreadyExists` - If the global metadata key already exists.
460
+ * * `AssetMetadataNameMaxLengthExceeded` - If the metadata name length exceeds the maximum allowed length.
461
+ * * `AssetMetadataTypeDefMaxLengthExceeded` - If the metadata type definition length exceeds the maximum allowed length.
330
462
  **/
331
463
  registerAssetMetadataGlobalType: AugmentedSubmittable<(name: Bytes | string | Uint8Array, spec: PolymeshPrimitivesAssetMetadataAssetMetadataSpec | {
332
464
  url?: any;
@@ -339,15 +471,24 @@ declare module '@polkadot/api-base/types/submittable' {
339
471
  /**
340
472
  * Registers asset metadata local type.
341
473
  *
474
+ * This function allows the asset issuer or an external agent to register a local metadata type for an asset.
475
+ *
342
476
  * # Arguments
343
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
344
- * * `asset_id`: the [`AssetId`] associated to the token.
345
- * * `name`: the [`AssetMetadataName`].
346
- * * `spec`: the asset metadata specifications ([`AssetMetadataSpec`]).
477
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
478
+ * * `asset_id` - The [`AssetId`] associated to the asset.
479
+ * * `name` - The [`AssetMetadataName`].
480
+ * * `spec` - The asset metadata specifications ([`AssetMetadataSpec`]).
347
481
  *
348
482
  * # Permissions
349
- * * Agent
350
483
  * * Asset
484
+ *
485
+ * # Events
486
+ * * `RegisterAssetMetadataLocalType` - When the local asset metadata type is successfully registered.
487
+ *
488
+ * # Errors
489
+ * * `AssetMetadataLocalKeyAlreadyExists` - If the local metadata key already exists.
490
+ * * `AssetMetadataNameMaxLengthExceeded` - If the metadata name length exceeds the maximum allowed length.
491
+ * * `AssetMetadataTypeDefMaxLengthExceeded` - If the metadata type definition length exceeds the maximum allowed length.
351
492
  **/
352
493
  registerAssetMetadataLocalType: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, name: Bytes | string | Uint8Array, spec: PolymeshPrimitivesAssetMetadataAssetMetadataSpec | {
353
494
  url?: any;
@@ -361,27 +502,37 @@ declare module '@polkadot/api-base/types/submittable' {
361
502
  /**
362
503
  * Registers a custom asset type.
363
504
  *
364
- * The provided `ty` will be bound to an ID in storage.
365
- * The ID can then be used in `AssetType::Custom`.
366
- * Should the `ty` already exist in storage, no second ID is assigned to it.
367
- *
368
505
  * # Arguments
369
- * * `origin`: who called the extrinsic.
370
- * * `ty`: contains the string representation of the asset type.
506
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
507
+ * * `ty` - Contains the string representation of the asset type.
508
+ *
509
+ * # Events
510
+ * * `CustomAssetTypeRegistered` - When a new custom asset type is successfully registered.
511
+ * * `CustomAssetTypeAlreadyRegistered` - When the custom asset type is already registered.
512
+ *
513
+ * # Errors
514
+ * * `TooLong` - If the custom asset type length exceeds the maximum allowed length.
371
515
  **/
372
516
  registerCustomAssetType: AugmentedSubmittable<(ty: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
373
517
  Bytes
374
518
  ]>;
375
519
  /**
376
- * Registers a unique ticker or extends validity of an existing ticker.
377
- * NB: Ticker validity does not get carry forward when renewing ticker.
520
+ * Registers a unique ticker or extends the validity of an existing ticker.
521
+ *
522
+ * This function allows the caller to register a new ticker or extend the registration
523
+ * of an existing ticker. The ticker validity does not carry forward when renewing.
378
524
  *
379
525
  * # Arguments
380
- * * `origin`: it contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
381
- * * `ticker`: [`Ticker`] to register.
526
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
527
+ * * `ticker` - The ticker to register.
382
528
  *
383
- * # Permissions
384
- * * Asset
529
+ * # Events
530
+ * * `TickerRegistered` - When a ticker is successfully registered.
531
+ *
532
+ * # Errors
533
+ * * `TickerAlreadyRegistered` - If the ticker is already registered.
534
+ * * `TickerTooLong` - If the ticker length exceeds the maximum allowed length.
535
+ * * `InvalidTickerCharacter` - If the ticker contains invalid characters.
385
536
  **/
386
537
  registerUniqueTicker: AugmentedSubmittable<(ticker: PolymeshPrimitivesTicker | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
387
538
  PolymeshPrimitivesTicker
@@ -389,39 +540,49 @@ declare module '@polkadot/api-base/types/submittable' {
389
540
  /**
390
541
  * Removes the pre-approval of the asset for all identities.
391
542
  *
543
+ * This function allows the root origin to remove the pre-approval of an asset for all identities.
544
+ *
392
545
  * # Arguments
393
- * * `origin`: the secondary key of the sender.
394
- * * `asset_id`: the [`AssetId`] that will have its exemption removed.
546
+ * * `origin` - The root origin.
547
+ * * `asset_id` - The [`AssetId`] that will have its exemption removed.
395
548
  *
396
- * # Permissions
397
- * * Root
549
+ * # Events
550
+ * * `RemoveAssetAffirmationExemption` - When the asset's affirmation exemption is successfully removed.
398
551
  **/
399
552
  removeAssetAffirmationExemption: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
400
553
  PolymeshPrimitivesAssetAssetId
401
554
  ]>;
402
555
  /**
403
- * Removes the pre approval of an asset.
556
+ * Removes the pre-approval of an asset.
404
557
  *
405
558
  * # Arguments
406
- * * `origin` - the secondary key of the sender.
407
- * * `asset_id`: the [`AssetId`] that will have its exemption removed.
559
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
560
+ * * `asset_id` - The [`AssetId`] that will have its exemption removed.
408
561
  *
409
562
  * # Permissions
410
563
  * * Asset
564
+ *
565
+ * # Events
566
+ * * `RemovePreApprovedAsset` - When the asset's pre-approval is successfully removed.
411
567
  **/
412
568
  removeAssetPreApproval: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
413
569
  PolymeshPrimitivesAssetAssetId
414
570
  ]>;
415
571
  /**
416
- * Remove documents for a given token.
572
+ * Remove documents for a given asset.
573
+ *
574
+ * This function allows the asset issuer or an external agent to remove documents from an asset.
417
575
  *
418
576
  * # Arguments
419
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
420
- * * `asset_id`: the [`AssetId`] associated to the token.
421
- * * `docs_id`: a vector of all [`DocumentId`] that will be removed from the token.
577
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
578
+ * * `asset_id` - The [`AssetId`] associated to the asset.
579
+ * * `docs_id` - A vector of all [`DocumentId`] that will be removed from the asset.
422
580
  *
423
581
  * # Permissions
424
582
  * * Asset
583
+ *
584
+ * # Events
585
+ * * `DocumentRemoved` - When a document is successfully removed from an asset.
425
586
  **/
426
587
  removeDocuments: AugmentedSubmittable<(docsId: Vec<u32> | (u32 | AnyNumber | Uint8Array)[], assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
427
588
  Vec<u32>,
@@ -430,13 +591,23 @@ declare module '@polkadot/api-base/types/submittable' {
430
591
  /**
431
592
  * Removes the asset metadata key and value of a local key.
432
593
  *
594
+ * This function allows the asset issuer or an external agent to remove a local metadata key and its value for an asset.
595
+ *
433
596
  * # Arguments
434
- * * `origin`: the secondary key of the sender.
435
- * * `asset_id`: the [`AssetId`] associated to the local metadata key.
436
- * * `local_key`: the [`AssetMetadataLocalKey`] that will be removed.
597
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
598
+ * * `asset_id` - The [`AssetId`] associated to the local metadata key.
599
+ * * `local_key` - The [`AssetMetadataLocalKey`] that will be removed.
437
600
  *
438
601
  * # Permissions
439
602
  * * Asset
603
+ *
604
+ * # Events
605
+ * * `LocalMetadataKeyDeleted` - When the local metadata key is successfully deleted.
606
+ *
607
+ * # Errors
608
+ * * `AssetMetadataKeyIsMissing` - If the local metadata key is missing.
609
+ * * `AssetMetadataValueIsLocked` - If the metadata value is locked.
610
+ * * `AssetMetadataKeyBelongsToNFTCollection` - If the metadata key belongs to an NFT collection.
440
611
  **/
441
612
  removeLocalMetadataKey: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, localKey: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
442
613
  PolymeshPrimitivesAssetAssetId,
@@ -445,13 +616,18 @@ declare module '@polkadot/api-base/types/submittable' {
445
616
  /**
446
617
  * Removes all identities in the `mediators` set from the mandatory mediators list for the given `asset_id`.
447
618
  *
619
+ * This function allows the asset issuer or an external agent to remove mandatory mediators for an asset.
620
+ *
448
621
  * # Arguments
449
- * * `origin`: the secondary key of the sender.
450
- * * `asset_id`: the [`AssetId`] of the asset that will have mediators removed.
451
- * * `mediators`: A set of [`IdentityId`] of all the mediators that will be removed from the mandatory mediators list.
622
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
623
+ * * `asset_id` - The [`AssetId`] of the asset that will have mediators removed.
624
+ * * `mediators` - A set of [`IdentityId`] of all the mediators that will be removed from the mandatory mediators list.
452
625
  *
453
626
  * # Permissions
454
627
  * * Asset
628
+ *
629
+ * # Events
630
+ * * `AssetMediatorsRemoved` - When the mandatory mediators are successfully removed.
455
631
  **/
456
632
  removeMandatoryMediators: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, mediators: BTreeSet<PolymeshPrimitivesIdentityId>) => SubmittableExtrinsic<ApiType>, [
457
633
  PolymeshPrimitivesAssetAssetId,
@@ -460,13 +636,22 @@ declare module '@polkadot/api-base/types/submittable' {
460
636
  /**
461
637
  * Removes the asset metadata value of a metadata key.
462
638
  *
639
+ * This function allows the asset issuer or an external agent to remove a metadata value for an asset.
640
+ *
463
641
  * # Arguments
464
- * * `origin`: the secondary key of the sender.
465
- * * `asset_id`: the [`AssetId`] associated to the metadata key.
466
- * * `metadata_key`: the [`AssetMetadataKey`] that will have its value deleted.
642
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
643
+ * * `asset_id` - The [`AssetId`] associated to the metadata key.
644
+ * * `metadata_key` - The [`AssetMetadataKey`] that will have its value deleted.
467
645
  *
468
646
  * # Permissions
469
647
  * * Asset
648
+ *
649
+ * # Events
650
+ * * `MetadataValueDeleted` - When the metadata value is successfully deleted.
651
+ *
652
+ * # Errors
653
+ * * `AssetMetadataKeyIsMissing` - If the metadata key is missing.
654
+ * * `AssetMetadataValueIsLocked` - If the metadata value is locked.
470
655
  **/
471
656
  removeMetadataValue: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, metadataKey: PolymeshPrimitivesAssetMetadataAssetMetadataKey | {
472
657
  Global: any;
@@ -477,15 +662,24 @@ declare module '@polkadot/api-base/types/submittable' {
477
662
  PolymeshPrimitivesAssetMetadataAssetMetadataKey
478
663
  ]>;
479
664
  /**
480
- * Updates the [`AssetName`] associated to a security token.
665
+ * Updates the [`AssetName`] associated to an asset.
666
+ *
667
+ * This function allows the asset issuer or an external agent to update the name of an asset.
481
668
  *
482
669
  * # Arguments
483
- * * `origin`: the secondary key of the sender.
484
- * * `asset_id`: the [`AssetId`] associated to the token.
485
- * * `asset_name`: the [`AssetName`] that will be associated to the token.
670
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
671
+ * * `asset_id` - The [`AssetId`] associated to the asset.
672
+ * * `asset_name` - The new [`AssetName`] that will be associated to the asset.
486
673
  *
487
674
  * # Permissions
488
675
  * * Asset
676
+ *
677
+ * # Events
678
+ * * `AssetRenamed` - When an asset is successfully renamed.
679
+ *
680
+ * # Errors
681
+ * * `MaxLengthOfAssetNameExceeded` - If the asset name length exceeds the maximum allowed length.
682
+ * * `NoSuchAsset` - If the asset does not exist.
489
683
  **/
490
684
  renameAsset: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, assetName: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
491
685
  PolymeshPrimitivesAssetAssetId,
@@ -494,16 +688,25 @@ declare module '@polkadot/api-base/types/submittable' {
494
688
  /**
495
689
  * Set asset metadata value.
496
690
  *
691
+ * This function allows the asset issuer or an external agent to set metadata for an asset.
692
+ *
497
693
  * # Arguments
498
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
499
- * * `asset_id`: the [`AssetId`] associated to the token.
500
- * * `key`: the [`AssetMetadataKey`] associated to the token.
501
- * * `value`: the [`AssetMetadataValue`] of the given metadata key.
502
- * * `details`: optional [`AssetMetadataValueDetail`] (expire, lock status).
694
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
695
+ * * `asset_id` - The [`AssetId`] associated to the asset.
696
+ * * `key` - The [`AssetMetadataKey`] associated to the asset.
697
+ * * `value` - The [`AssetMetadataValue`] of the given metadata key.
698
+ * * `details` - Optional [`AssetMetadataValueDetail`] (expire, lock status).
503
699
  *
504
700
  * # Permissions
505
- * * Agent
506
701
  * * Asset
702
+ *
703
+ * # Events
704
+ * * `SetAssetMetadataValue` - When the asset metadata value is successfully set.
705
+ *
706
+ * # Errors
707
+ * * `AssetMetadataKeyIsMissing` - If the metadata key is missing.
708
+ * * `AssetMetadataValueIsLocked` - If the metadata value is locked.
709
+ * * `AssetMetadataValueMaxLengthExceeded` - If the metadata value length exceeds the maximum allowed length.
507
710
  **/
508
711
  setAssetMetadata: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, key: PolymeshPrimitivesAssetMetadataAssetMetadataKey | {
509
712
  Global: any;
@@ -521,15 +724,24 @@ declare module '@polkadot/api-base/types/submittable' {
521
724
  /**
522
725
  * Set asset metadata value details (expire, lock status).
523
726
  *
727
+ * This function allows the asset issuer or an external agent to set metadata details for an asset.
728
+ *
524
729
  * # Arguments
525
- * * `origin`: is a signer that has permissions to act as an agent of `asset_id`.
526
- * * `asset_id`: the [`AssetId`] associated to the token.
527
- * * `key`: the [`AssetMetadataKey`] associated to the token.
528
- * * `details`: the [`AssetMetadataValueDetail`] (expire, lock status) that will be associated to the token.
730
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
731
+ * * `asset_id` - The [`AssetId`] associated to the asset.
732
+ * * `key` - The [`AssetMetadataKey`] associated to the asset.
733
+ * * `details` - The [`AssetMetadataValueDetail`] (expire, lock status) that will be associated to the asset.
529
734
  *
530
735
  * # Permissions
531
- * * Agent
532
736
  * * Asset
737
+ *
738
+ * # Events
739
+ * * `SetAssetMetadataValueDetails` - When the asset metadata value details are successfully set.
740
+ *
741
+ * # Errors
742
+ * * `AssetMetadataKeyIsMissing` - If the metadata key is missing.
743
+ * * `AssetMetadataValueIsLocked` - If the metadata value is locked.
744
+ * * `AssetMetadataValueIsEmpty` - If the metadata value is empty.
533
745
  **/
534
746
  setAssetMetadataDetails: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, key: PolymeshPrimitivesAssetMetadataAssetMetadataKey | {
535
747
  Global: any;
@@ -546,27 +758,44 @@ declare module '@polkadot/api-base/types/submittable' {
546
758
  /**
547
759
  * Sets the name of the current funding round.
548
760
  *
761
+ * This function allows the asset issuer or an external agent to set the name of the current funding round for an asset.
762
+ *
549
763
  * # Arguments
550
- * * `origin`: a signer that has permissions to act as an agent of `asset_id`.
551
- * * `asset_id`: the [`AssetId`] associated to the token.
552
- * * `founding_round_name`: the [`FoundingRoundName`] of the current funding round.
764
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
765
+ * * `asset_id` - The [`AssetId`] associated to the asset.
766
+ * * `funding_round_name` - The [`FundingRoundName`] of the current funding round.
553
767
  *
554
768
  * # Permissions
555
769
  * * Asset
770
+ *
771
+ * # Events
772
+ * * `FundingRoundSet` - When the funding round name is successfully set.
773
+ *
774
+ * # Errors
775
+ * * `FundingRoundNameMaxLengthExceeded` - If the funding round name length exceeds the maximum allowed length.
556
776
  **/
557
- setFundingRound: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, foundingRoundName: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
777
+ setFundingRound: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, fundingRoundName: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
558
778
  PolymeshPrimitivesAssetAssetId,
559
779
  Bytes
560
780
  ]>;
561
781
  /**
562
- * Unfreezes transfers of a given token.
782
+ * Unfreezes transfers of a given asset.
783
+ *
784
+ * This function allows the asset issuer or an external agent to unfreeze transfers of a given asset.
563
785
  *
564
786
  * # Arguments
565
- * * `origin`: the secondary key of the sender.
566
- * * `asset_id`: the [`AssetId`] associated to the token.
787
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
788
+ * * `asset_id` - The asset to unfreeze.
567
789
  *
568
790
  * # Permissions
569
791
  * * Asset
792
+ *
793
+ * # Events
794
+ * * `AssetUnfrozen` - When an asset is successfully unfrozen.
795
+ *
796
+ * # Errors
797
+ * * `NoSuchAsset` - If the asset does not exist.
798
+ * * `NotFrozen` - If the asset is not frozen.
570
799
  **/
571
800
  unfreeze: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
572
801
  PolymeshPrimitivesAssetAssetId
@@ -574,13 +803,23 @@ declare module '@polkadot/api-base/types/submittable' {
574
803
  /**
575
804
  * Removes the link between a ticker and an asset.
576
805
  *
806
+ * This function allows the asset issuer or an external agent to unlink a ticker from an asset.
807
+ *
577
808
  * # Arguments
578
- * * `origin`: the secondary key of the sender.
579
- * * `ticker`: the [`Ticker`] that will be unlinked from the given `asset_id`.
580
- * * `asset_id`: the [`AssetId`] that will be unlink from `ticker`.
809
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
810
+ * * `ticker` - The [`Ticker`] that will be unlinked from the given `asset_id`.
811
+ * * `asset_id` - The [`AssetId`] that will be unlinked from `ticker`.
581
812
  *
582
813
  * # Permissions
583
814
  * * Asset
815
+ *
816
+ * # Events
817
+ * * `TickerUnlinkedFromAsset` - When the ticker is successfully unlinked from the asset.
818
+ *
819
+ * # Errors
820
+ * * `TickerNotRegisteredToCaller` - If the ticker is not registered to the caller.
821
+ * * `TickerRegistrationNotFound` - If the ticker registration is not found.
822
+ * * `TickerIsNotLinkedToTheAsset` - If the ticker is not linked to the asset.
584
823
  **/
585
824
  unlinkTickerFromAssetId: AugmentedSubmittable<(ticker: PolymeshPrimitivesTicker | string | Uint8Array, assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
586
825
  PolymeshPrimitivesTicker,
@@ -589,13 +828,23 @@ declare module '@polkadot/api-base/types/submittable' {
589
828
  /**
590
829
  * Updates the type of an asset.
591
830
  *
831
+ * This function allows the asset issuer or an external agent to update the type of an asset.
832
+ *
592
833
  * # Arguments
593
- * * `origin`: it contains the secondary key of the sender
594
- * * `asset_id`: the [`AssetId`] associated to the token.
595
- * * `asset_type`: the new [`AssetType`] of the token.
834
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
835
+ * * `asset_id` - The [`AssetId`] associated to the asset.
836
+ * * `asset_type` - The new [`AssetType`] of the asset.
596
837
  *
597
838
  * # Permissions
598
839
  * * Asset
840
+ *
841
+ * # Events
842
+ * * `AssetTypeChanged` - When the asset type is successfully changed.
843
+ *
844
+ * # Errors
845
+ * * `NoSuchAsset` - If the asset does not exist.
846
+ * * `InvalidCustomAssetTypeId` - If the custom asset type ID is invalid.
847
+ * * `IncompatibleAssetTypeUpdate` - If the new asset type is incompatible with the existing asset type.
599
848
  **/
600
849
  updateAssetType: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, assetType: PolymeshPrimitivesAssetAssetType | {
601
850
  EquityCommon: any;
@@ -626,15 +875,47 @@ declare module '@polkadot/api-base/types/submittable' {
626
875
  PolymeshPrimitivesAssetAssetType
627
876
  ]>;
628
877
  /**
629
- * Updates the asset identifiers associated to the token.
878
+ * Updates the global metadata specification.
630
879
  *
631
880
  * # Arguments
632
- * * `origin`: a signer that has permissions to act as an agent of `asset_id`.
633
- * * `asset_id`: the [`AssetId`] associated to the token.
634
- * * `asset_identifiers`: a vector of [`AssetIdentifier`] that will be associated to the token.
881
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
882
+ * * `asset_metadata_name` - The [`AssetMetadataName`] associated with the global metadata.
883
+ * * `asset_metadata_spec` - The new [`AssetMetadataSpec`] that will be associated with the global metadata.
884
+ *
885
+ * # Events
886
+ * * `GlobalMetadataSpecUpdated` - When the global metadata specification is successfully updated.
887
+ *
888
+ * # Errors
889
+ * * `BadOrigin` - If the origin is not authorized.
890
+ * * `TooLong` - If the metadata url or description length exceeds the maximum allowed length.
891
+ * * `AssetMetadataTypeDefMaxLengthExceeded` - If the metadata type definition length exceeds the maximum allowed length.
892
+ **/
893
+ updateGlobalMetadataSpec: AugmentedSubmittable<(assetMetadataName: Bytes | string | Uint8Array, assetMetadataSpec: PolymeshPrimitivesAssetMetadataAssetMetadataSpec | {
894
+ url?: any;
895
+ description?: any;
896
+ typeDef?: any;
897
+ } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
898
+ Bytes,
899
+ PolymeshPrimitivesAssetMetadataAssetMetadataSpec
900
+ ]>;
901
+ /**
902
+ * Updates the asset identifiers associated to the asset.
903
+ *
904
+ * This function allows the asset issuer or an external agent to update the asset identifiers for an asset.
905
+ *
906
+ * # Arguments
907
+ * * `origin` - The origin of the call, which can be the primary or secondary key of an identity.
908
+ * * `asset_id` - The [`AssetId`] associated to the asset.
909
+ * * `asset_identifiers` - A vector of [`AssetIdentifier`] that will be associated to the asset.
635
910
  *
636
911
  * # Permissions
637
912
  * * Asset
913
+ *
914
+ * # Events
915
+ * * `IdentifiersUpdated` - When the asset identifiers are successfully updated.
916
+ *
917
+ * # Errors
918
+ * * `InvalidAssetIdentifier` - If any of the asset identifiers are invalid.
638
919
  **/
639
920
  updateIdentifiers: AugmentedSubmittable<(assetId: PolymeshPrimitivesAssetAssetId | string | Uint8Array, assetIdentifiers: Vec<PolymeshPrimitivesAssetIdentifier> | (PolymeshPrimitivesAssetIdentifier | {
640
921
  CUSIP: any;
@@ -1714,6 +1995,27 @@ declare module '@polkadot/api-base/types/submittable' {
1714
1995
  Option<Permill>,
1715
1996
  Option<Vec<ITuple<[PolymeshPrimitivesIdentityId, Permill]>>>
1716
1997
  ]>;
1998
+ initiateCorporateActionAndBallot: AugmentedSubmittable<(caArgs: PalletCorporateActionsInitiateCorporateActionArgs | {
1999
+ assetId?: any;
2000
+ kind?: any;
2001
+ declDate?: any;
2002
+ recordDate?: any;
2003
+ details?: any;
2004
+ targets?: any;
2005
+ defaultWithholdingTax?: any;
2006
+ withholdingTax?: any;
2007
+ } | string | Uint8Array, ballotTimeRange: PalletCorporateActionsBallotBallotTimeRange | {
2008
+ start?: any;
2009
+ end?: any;
2010
+ } | string | Uint8Array, ballotMeta: PalletCorporateActionsBallotBallotMeta | {
2011
+ title?: any;
2012
+ motions?: any;
2013
+ } | string | Uint8Array, rcv: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [
2014
+ PalletCorporateActionsInitiateCorporateActionArgs,
2015
+ PalletCorporateActionsBallotBallotTimeRange,
2016
+ PalletCorporateActionsBallotBallotMeta,
2017
+ bool
2018
+ ]>;
1717
2019
  /**
1718
2020
  * Utility extrinsic to batch `initiate_corporate_action` and `distribute`
1719
2021
  **/
@@ -2132,9 +2434,9 @@ declare module '@polkadot/api-base/types/submittable' {
2132
2434
  * - `auth_id` identifying the authorization to accept.
2133
2435
  *
2134
2436
  * # Errors
2135
- * - `AuthorizationError::Invalid` if `auth_id` does not exist for the given caller.
2136
- * - `AuthorizationError::Expired` if `auth_id` is for an auth that has expired.
2137
- * - `AuthorizationError::BadType` if `auth_id` was not for a `BecomeAgent` auth type.
2437
+ * - `Error::InvalidAuthorization` if `auth_id` does not exist for the given caller.
2438
+ * - `Error::AuthorizationExpired` if `auth_id` is for an auth that has expired.
2439
+ * - `Error::BadAuthorizationType` if `auth_id` was not for a `BecomeAgent` auth type.
2138
2440
  * - `UnauthorizedAgent` if "Alice" is not permissioned to provide the auth.
2139
2441
  * - `NoSuchAG` if the group referred to a custom that does not exist.
2140
2442
  * - `AlreadyAnAgent` if the caller is already an agent of the asset.
@@ -2596,7 +2898,7 @@ declare module '@polkadot/api-base/types/submittable' {
2596
2898
  ]>;
2597
2899
  /**
2598
2900
  * Removes an authorization.
2599
- * _auth_issuer_pays determines whether the issuer of the authorisation pays the transaction fee
2901
+ * `_auth_issuer_pays` determines whether the issuer of the authorisation pays the transaction fee
2600
2902
  **/
2601
2903
  removeAuthorization: AugmentedSubmittable<(target: PolymeshPrimitivesSecondaryKeySignatory | {
2602
2904
  Identity: any;
@@ -3172,11 +3474,20 @@ declare module '@polkadot/api-base/types/submittable' {
3172
3474
  /**
3173
3475
  * Approves the pending committee PIP given by the `id`.
3174
3476
  *
3477
+ * This function can only be called by a Governance Committee (GC) voting majority.
3478
+ *
3479
+ * # Arguments
3480
+ * * `origin` - The origin of the call, which must be a GC voting majority.
3481
+ * * `id` - The proposal ID of the PIP to be approved.
3482
+ *
3175
3483
  * # Errors
3176
- * * `BadOrigin` unless a GC voting majority executes this function.
3177
- * * `NoSuchProposal` if the PIP with `id` doesn't exist.
3178
- * * `IncorrectProposalState` if the proposal isn't pending.
3179
- * * `NotByCommittee` if the proposal isn't by a committee.
3484
+ * * `BadOrigin` - If the call is not made by a GC voting majority.
3485
+ * * `NoSuchProposal` - If the PIP with the given `id` does not exist.
3486
+ * * `IncorrectProposalState` - If the proposal is not in a pending state.
3487
+ * * `NotByCommittee` - If the proposal was not made by a committee.
3488
+ *
3489
+ * # Notes
3490
+ * This function schedules the PIP for execution if all checks pass.
3180
3491
  **/
3181
3492
  approveCommitteeProposal: AugmentedSubmittable<(id: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3182
3493
  u32
@@ -3184,28 +3495,45 @@ declare module '@polkadot/api-base/types/submittable' {
3184
3495
  /**
3185
3496
  * Clears the snapshot and emits the event `SnapshotCleared`.
3186
3497
  *
3498
+ * This function can only be called by a Governance Committee (GC) member.
3499
+ *
3500
+ * # Arguments
3501
+ * * `origin` - The origin of the call, which must be a GC member.
3502
+ *
3503
+ * # Events
3504
+ * * `SnapshotCleared` - Emitted when the snapshot is successfully cleared, containing the ID of the cleared snapshot.
3505
+ *
3187
3506
  * # Errors
3188
- * * `NotACommitteeMember` - triggered when a non-GC-member executes the function.
3507
+ * * `NotACommitteeMember` - If the call is not made by a GC member.
3189
3508
  **/
3190
3509
  clearSnapshot: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
3191
3510
  /**
3192
- * Enacts `results` for the PIPs in the snapshot queue.
3511
+ * Enacts the results for the PIPs in the snapshot queue.
3512
+ *
3193
3513
  * The snapshot will be available for further enactments until it is cleared.
3194
3514
  *
3195
- * The `results` are encoded a list of `(id, result)` where `result` is applied to `id`.
3515
+ * The `results` parameter is a list of `(id, result)` tuples where `result` is applied to the PIP with the given `id`.
3196
3516
  * Note that the snapshot priority queue is encoded with the *lowest priority first*.
3197
- * so `results = [(id, Approve)]` will approve `SnapshotQueue[SnapshotQueue.len() - 1]`.
3517
+ * For example, `results = [(id, Approve)]` will approve `SnapshotQueue[SnapshotQueue.len() - 1]`.
3518
+ *
3519
+ * # Arguments
3520
+ * * `origin` - The origin of the call, which must be a GC voting majority.
3521
+ * * `results` - A vector of tuples where each tuple contains a PIP ID and a `SnapshotResult` (either `Approve`, `Reject`, or `Skip`).
3522
+ *
3523
+ * # Events
3524
+ * * `SnapshotResultsEnacted` - Emitted when the snapshot results are successfully enacted, containing the ID of the snapshot and the actions taken.
3198
3525
  *
3199
3526
  * # Errors
3200
- * * `BadOrigin` - unless a GC voting majority executes this function.
3201
- * * `CannotSkipPip` - a given PIP has already been skipped too many times.
3202
- * * `SnapshotResultTooLarge` - on len(results) > len(snapshot_queue).
3203
- * * `SnapshotIdMismatch` - if:
3204
- * ```text
3205
- * (i ∈ 0..SnapshotQueue.len()).
3206
- * results[i].0 SnapshotQueue[SnapshotQueue.len() - i].id
3207
- * ```
3208
- * This is protects against clearing queue while GC is voting.
3527
+ * * `BadOrigin` - If the call is not made by a GC voting majority.
3528
+ * * `CannotSkipPip` - If a given PIP has already been skipped too many times.
3529
+ * * `SnapshotResultTooLarge` - If the length of `results` is greater than the length of the snapshot queue.
3530
+ * * `SnapshotIdMismatch` - If there is a mismatch between the PIP IDs in `results` and the snapshot queue.
3531
+ *
3532
+ * # Notes
3533
+ * This function will:
3534
+ * - Update the skip counts for PIPs that are skipped.
3535
+ * - Reject PIPs that are marked for rejection and refund any bonded funds.
3536
+ * - Approve PIPs that are marked for approval and schedule them for execution.
3209
3537
  **/
3210
3538
  enactSnapshotResults: AugmentedSubmittable<(results: Vec<ITuple<[u32, PalletPipsSnapshotResult]>> | [
3211
3539
  u32 | AnyNumber | Uint8Array,
@@ -3214,28 +3542,60 @@ declare module '@polkadot/api-base/types/submittable' {
3214
3542
  Vec<ITuple<[u32, PalletPipsSnapshotResult]>>
3215
3543
  ]>;
3216
3544
  /**
3217
- * Internal dispatchable that handles execution of a PIP.
3545
+ * Executes a scheduled PIP (Polymesh Improvement Proposal).
3546
+ *
3547
+ * # Arguments
3548
+ * * `origin` - The origin of the call, which must be the root.
3549
+ * * `id` - The unique identifier of the PIP to be executed.
3550
+ *
3551
+ * # Errors
3552
+ * * `BadOrigin` - If the call is not made by the root origin.
3553
+ *
3554
+ * # Notes
3555
+ * This function will:
3556
+ * - Remove the PIP from the scheduling queue.
3557
+ * - Execute the proposal associated with the PIP.
3218
3558
  **/
3219
3559
  executeScheduledPip: AugmentedSubmittable<(id: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3220
3560
  u32
3221
3561
  ]>;
3222
3562
  /**
3223
- * Internal dispatchable that handles expiration of a PIP.
3563
+ * Expires a scheduled PIP (Polymesh Improvement Proposal).
3564
+ *
3565
+ * # Arguments
3566
+ * * `origin` - The origin of the call, which must be the root.
3567
+ * * `did` - The identity ID of the entity initiating the expiration.
3568
+ * * `id` - The unique identifier of the PIP to be expired.
3569
+ *
3570
+ * # Errors
3571
+ * * `BadOrigin` - If the call is not made by the root origin.
3572
+ *
3573
+ * # Notes
3574
+ * This function will:
3575
+ * - Check if the PIP is in a pending state.
3576
+ * - Unsnapshot the PIP if it was part of a snapshot.
3577
+ * - Prune the PIP data if it is in an expired state.
3224
3578
  **/
3225
3579
  expireScheduledPip: AugmentedSubmittable<(did: PolymeshPrimitivesIdentityId | string | Uint8Array, id: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3226
3580
  PolymeshPrimitivesIdentityId,
3227
3581
  u32
3228
3582
  ]>;
3229
3583
  /**
3230
- * A network member creates a PIP by submitting a dispatchable which
3231
- * changes the network in someway. A minimum deposit is required to open a new proposal.
3584
+ * Proposes a new PIP by submitting a dispatchable which changes the network.
3232
3585
  *
3233
3586
  * # Arguments
3234
- * * `proposer` is either a signing key or committee.
3235
- * Used to understand whether this is a committee proposal and verified against `origin`.
3236
- * * `proposal` a dispatchable call
3237
- * * `deposit` minimum deposit value, which is ignored if `proposer` is a committee.
3238
- * * `url` a link to a website for proposal discussion
3587
+ * * `origin` - The origin of the call.
3588
+ * * `proposal` - The dispatchable call.
3589
+ * * `deposit` - The deposit amount for the proposal.
3590
+ * * `url` - A link to a website for proposal discussion.
3591
+ * * `description` - A short description of the proposal.
3592
+ *
3593
+ * # Events
3594
+ * * `ProposalCreated`.
3595
+ *
3596
+ * # Errors
3597
+ * * `IncorrectDeposit` - If the deposit amount is less than the required minimum.
3598
+ * * `TooManyActivePips` - If the number of active PIPs exceeds the maximum.
3239
3599
  **/
3240
3600
  propose: AugmentedSubmittable<(proposal: Call | IMethod | string | Uint8Array, deposit: u128 | AnyNumber | Uint8Array, url: Option<Bytes> | null | Uint8Array | Bytes | string, description: Option<Bytes> | null | Uint8Array | Bytes | string) => SubmittableExtrinsic<ApiType>, [
3241
3601
  Call,
@@ -3244,123 +3604,186 @@ declare module '@polkadot/api-base/types/submittable' {
3244
3604
  Option<Bytes>
3245
3605
  ]>;
3246
3606
  /**
3247
- * Prune the PIP given by the `id`, refunding any funds not already refunded.
3248
- * The PIP may not be active
3607
+ * Prunes the PIP given by the `id`. The PIP must not be active.
3249
3608
  *
3250
- * This function is intended for storage garbage collection purposes.
3609
+ * This function is intended for storage garbage collection purposes and can only be called by a Governance Committee (GC) voting majority.
3610
+ *
3611
+ * # Arguments
3612
+ * * `origin` - The origin of the call, which must be a GC voting majority.
3613
+ * * `id` - The proposal ID of the PIP to be pruned.
3251
3614
  *
3252
3615
  * # Errors
3253
- * * `BadOrigin` unless a GC voting majority executes this function.
3254
- * * `NoSuchProposal` if the PIP with `id` doesn't exist.
3255
- * * `IncorrectProposalState` if the proposal is active.
3616
+ * * `BadOrigin` - If the call is not made by a GC voting majority.
3617
+ * * `NoSuchProposal` - If the PIP with the given `id` does not exist.
3618
+ * * `IncorrectProposalState` - If the proposal is active.
3619
+ *
3620
+ * # Notes
3621
+ * This function will remove the PIP from storage and refund any remaining bonded funds.
3256
3622
  **/
3257
3623
  pruneProposal: AugmentedSubmittable<(id: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3258
3624
  u32
3259
3625
  ]>;
3260
3626
  /**
3261
- * Rejects the PIP given by the `id`, refunding any bonded funds,
3262
- * assuming it hasn't been cancelled or executed.
3263
- * Note that proposals scheduled-for-execution can also be rejected.
3627
+ * Rejects the PIP given by the `id`. Bonded funds will be refunded, assuming it hasn't
3628
+ * been cancelled or executed.
3629
+ *
3630
+ * This function can only be called by a Governance Committee (GC) voting majority.
3631
+ *
3632
+ * # Arguments
3633
+ * * `origin` - The origin of the call, which must be a GC voting majority.
3634
+ * * `id` - The proposal ID of the PIP to be rejected.
3264
3635
  *
3265
3636
  * # Errors
3266
- * * `BadOrigin` unless a GC voting majority executes this function.
3267
- * * `NoSuchProposal` if the PIP with `id` doesn't exist.
3268
- * * `IncorrectProposalState` if the proposal was cancelled or executed.
3637
+ * * `BadOrigin` - If the call is not made by a GC voting majority.
3638
+ * * `NoSuchProposal` - If the PIP with the given `id` does not exist.
3639
+ * * `IncorrectProposalState` - If the proposal was cancelled or executed.
3640
+ *
3641
+ * # Notes
3642
+ * This function will unschedule the PIP if it was scheduled for execution and will
3643
+ * unsnapshot the PIP if it was part of a snapshot. It will also handle the rejection
3644
+ * of the proposal and refund any bonded funds.
3269
3645
  **/
3270
3646
  rejectProposal: AugmentedSubmittable<(id: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3271
3647
  u32
3272
3648
  ]>;
3273
3649
  /**
3274
3650
  * Updates the execution schedule of the PIP given by `id`.
3651
+ * This function can only be called by the release coordinator.
3275
3652
  *
3276
3653
  * # Arguments
3277
- * * `until` defines the future block where the enactment period will finished.
3278
- * `None` value means that enactment period is going to finish in the next block.
3654
+ * * `origin` - The origin of the call, which must be the release coordinator.
3655
+ * * `id` - The proposal ID of the PIP to be rescheduled.
3656
+ * * `until` - An optional future block number where the enactment period will finish.
3657
+ * If `None`, the enactment period will finish in the next block.
3279
3658
  *
3280
3659
  * # Errors
3281
- * * `RescheduleNotByReleaseCoordinator` unless triggered by release coordinator.
3282
- * * `IncorrectProposalState` unless the proposal was in a scheduled state.
3660
+ * * `RescheduleNotByReleaseCoordinator` - If the call is not made by the release coordinator.
3661
+ * * `IncorrectProposalState` - If the proposal is not in a scheduled state.
3662
+ * * `InvalidFutureBlockNumber` - If the provided block number is not a valid future block number.
3283
3663
  **/
3284
3664
  rescheduleExecution: AugmentedSubmittable<(id: u32 | AnyNumber | Uint8Array, until: Option<u32> | null | Uint8Array | u32 | AnyNumber) => SubmittableExtrinsic<ApiType>, [
3285
3665
  u32,
3286
3666
  Option<u32>
3287
3667
  ]>;
3288
3668
  /**
3289
- * Change the maximum number of active PIPs before community members cannot propose anything.
3290
- * Can only be called by root.
3669
+ * Sets the limit on the number of active PIPs. This function can only be called by the root origin.
3291
3670
  *
3292
3671
  * # Arguments
3293
- * * `limit` of concurrent active PIPs.
3672
+ * * `origin` - The origin of the call, which must be the root.
3673
+ * * `limit` - The new limit on the number of active PIPs.
3674
+ *
3675
+ * # Events
3676
+ * * `ActivePipLimitChanged` - Emitted when the active PIP limit is changed, containing the old and new values.
3677
+ *
3678
+ * # Errors
3679
+ * * `BadOrigin` - If the call is not made by the root origin.
3294
3680
  **/
3295
3681
  setActivePipLimit: AugmentedSubmittable<(limit: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3296
3682
  u32
3297
3683
  ]>;
3298
3684
  /**
3299
- * Change the default enactment period.
3300
- * Can only be called by root.
3685
+ * Changes the default enactment period. This function can only be called by the root origin.
3301
3686
  *
3302
3687
  * # Arguments
3303
- * * `duration` the new default enactment period it takes for a scheduled PIP to be executed.
3688
+ * * `origin` - The origin of the call, which must be the root.
3689
+ * * `period` - The new default enactment period.
3690
+ *
3691
+ * # Events
3692
+ * * `DefaultEnactmentPeriodChanged` - Emitted when the default enactment period is changed, containing the old and new values.
3693
+ *
3694
+ * # Errors
3695
+ * * `BadOrigin` - If the call is not made by the root origin.
3304
3696
  **/
3305
3697
  setDefaultEnactmentPeriod: AugmentedSubmittable<(duration: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3306
3698
  u32
3307
3699
  ]>;
3308
3700
  /**
3309
- * Change the maximum skip count (`max_pip_skip_count`).
3310
- * Can only be called by root.
3701
+ * Sets the maximum number of times a PIP can be skipped. This function can only be called by the root origin.
3311
3702
  *
3312
3703
  * # Arguments
3313
- * * `max` skips before a PIP cannot be skipped by GC anymore.
3704
+ * * `origin` - The origin of the call, which must be the root.
3705
+ * * `max` - The new maximum skip count for PIPs.
3706
+ *
3707
+ * # Events
3708
+ * * `MaxPipSkipCountChanged` - Emitted when the maximum PIP skip count is changed, containing the old and new values.
3709
+ *
3710
+ * # Errors
3711
+ * * `BadOrigin` - If the call is not made by the root origin.
3314
3712
  **/
3315
3713
  setMaxPipSkipCount: AugmentedSubmittable<(max: u8 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3316
3714
  u8
3317
3715
  ]>;
3318
3716
  /**
3319
- * Change the minimum proposal deposit amount required to start a proposal.
3320
- * Can only be called by root.
3717
+ * Changes the minimum proposal deposit amount required to start a proposal. This function can only be called by the root origin.
3321
3718
  *
3322
3719
  * # Arguments
3323
- * * `deposit` the new min deposit required to start a proposal
3720
+ * * `origin` - The origin of the call, which must be the root.
3721
+ * * `deposit` - The new minimum deposit required to start a proposal.
3722
+ *
3723
+ * # Events
3724
+ * * `MinimumProposalDepositChanged` - Emitted when the minimum proposal deposit is changed, containing the old and new values.
3725
+ *
3726
+ * # Errors
3727
+ * * `BadOrigin` - If the call is not made by the root origin.
3324
3728
  **/
3325
3729
  setMinProposalDeposit: AugmentedSubmittable<(deposit: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3326
3730
  u128
3327
3731
  ]>;
3328
3732
  /**
3329
- * Change the amount of blocks after which a pending PIP is expired.
3330
- * If `expiry` is `None` then PIPs never expire.
3331
- * Can only be called by root.
3733
+ * Sets the expiry duration (in blocks) for pending PIPs. This function can only be called by the root origin.
3332
3734
  *
3333
3735
  * # Arguments
3334
- * * `expiry` the block-time it takes for a still-`Pending` PIP to expire.
3736
+ * * `origin` - The origin of the call, which must be the root.
3737
+ * * `expiry` - The new expiry duration for pending PIPs. If `None`, PIPs never expire.
3738
+ *
3739
+ * # Events
3740
+ * * `PendingPipExpiryChanged` - Emitted when the pending PIP expiry duration is changed, containing the old and new values.
3741
+ *
3742
+ * # Errors
3743
+ * * `BadOrigin` - If the call is not made by the root origin.
3335
3744
  **/
3336
- setPendingPipExpiry: AugmentedSubmittable<(expiry: PolymeshCommonUtilitiesMaybeBlock | {
3745
+ setPendingPipExpiry: AugmentedSubmittable<(expiry: PolymeshPrimitivesMaybeBlock | {
3337
3746
  Some: any;
3338
3747
  } | {
3339
3748
  None: any;
3340
3749
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3341
- PolymeshCommonUtilitiesMaybeBlock
3750
+ PolymeshPrimitivesMaybeBlock
3342
3751
  ]>;
3343
3752
  /**
3344
- * Change whether completed PIPs are pruned.
3345
- * Can only be called by root.
3753
+ * Sets the pruning setting for historical PIPs. This function can only be called by the root origin.
3346
3754
  *
3347
3755
  * # Arguments
3348
- * * `prune` specifies whether completed PIPs should be pruned.
3756
+ * * `origin` - The origin of the call, which must be the root.
3757
+ * * `prune` - A boolean flag indicating whether completed PIPs should be pruned (`true`) or retained (`false`).
3758
+ *
3759
+ * # Events
3760
+ * * `HistoricalPipsPruned` - Emitted when the pruning setting is changed, containing the old and new values.
3761
+ *
3762
+ * # Errors
3763
+ * * `BadOrigin` - If the call is not made by the root origin.
3349
3764
  **/
3350
3765
  setPruneHistoricalPips: AugmentedSubmittable<(prune: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3351
3766
  bool
3352
3767
  ]>;
3353
3768
  /**
3354
- * Takes a new snapshot of the current list of active && pending PIPs.
3769
+ * Takes a new snapshot of the current list of active and pending PIPs.
3355
3770
  * The PIPs are then sorted into a priority queue based on each PIP's weight.
3356
3771
  *
3772
+ * This function can only be called by a Governance Committee (GC) member.
3773
+ *
3774
+ * # Arguments
3775
+ * * `origin` - The origin of the call, which must be a GC member.
3776
+ *
3777
+ * # Events
3778
+ * * `SnapshotTaken` - Emitted when a snapshot is successfully taken, containing the ID of the snapshot and the queue of PIPs.
3779
+ *
3357
3780
  * # Errors
3358
- * * `NotACommitteeMember` - triggered when a non-GC-member executes the function.
3781
+ * * `NotACommitteeMember` - If the call is not made by a GC member.
3359
3782
  **/
3360
3783
  snapshot: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
3361
3784
  /**
3362
- * Vote either in favor (`aye_or_nay` == true) or against a PIP with `id`.
3363
- * The "convinction" or strength of the vote is given by `deposit`, which is reserved.
3785
+ * Casts a vote either in favor or against a PIP with `id`.
3786
+ * The "conviction" or strength of the vote is given by `deposit`, which is reserved.
3364
3787
  *
3365
3788
  * Note that `vote` is *not* additive.
3366
3789
  * That is, `vote(id, true, 50)` followed by `vote(id, true, 40)`
@@ -3368,15 +3791,20 @@ declare module '@polkadot/api-base/types/submittable' {
3368
3791
  * To add atop of existing votes, you'll need `existing_deposit + addition`.
3369
3792
  *
3370
3793
  * # Arguments
3371
- * * `id`, proposal id
3372
- * * `aye_or_nay`, a bool representing for or against vote
3373
- * * `deposit`, the "conviction" with which the vote is made.
3794
+ * * `origin` - The origin of the call.
3795
+ * * `id` - The proposal ID to vote on.
3796
+ * * `aye_or_nay` - A boolean representing a vote in favor (`true`) or against (`false`).
3797
+ * * `deposit` - The "conviction" or strength of the vote, represented by the amount of deposit.
3798
+ *
3799
+ * # Events
3800
+ * * `Voted` - Emitted when a vote is successfully cast.
3374
3801
  *
3375
3802
  * # Errors
3376
- * * `NoSuchProposal` if `id` doesn't reference a valid PIP.
3377
- * * `NotFromCommunity` if proposal was made by a committee.
3378
- * * `IncorrectProposalState` if PIP isn't pending.
3379
- * * `InsufficientDeposit` if `origin` cannot reserve `deposit - old_deposit`.
3803
+ * * `NoSuchProposal` - If the `id` does not reference a valid PIP.
3804
+ * * `NotFromCommunity` - If the proposal was made by a committee.
3805
+ * * `IncorrectProposalState` - If the PIP is not in a pending state.
3806
+ * * `InsufficientDeposit` - If the `origin` cannot reserve the required deposit.
3807
+ * * `IncorrectDeposit` - If the deposit amount is less than the required minimum.
3380
3808
  **/
3381
3809
  vote: AugmentedSubmittable<(id: u32 | AnyNumber | Uint8Array, ayeOrNay: bool | boolean | Uint8Array, deposit: u128 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3382
3810
  u32,
@@ -3391,12 +3819,12 @@ declare module '@polkadot/api-base/types/submittable' {
3391
3819
  * # Arguments
3392
3820
  * * `expiry` - The new expiry time.
3393
3821
  **/
3394
- setExpiresAfter: AugmentedSubmittable<(expiry: PolymeshCommonUtilitiesMaybeBlock | {
3822
+ setExpiresAfter: AugmentedSubmittable<(expiry: PolymeshPrimitivesMaybeBlock | {
3395
3823
  Some: any;
3396
3824
  } | {
3397
3825
  None: any;
3398
3826
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
3399
- PolymeshCommonUtilitiesMaybeBlock
3827
+ PolymeshPrimitivesMaybeBlock
3400
3828
  ]>;
3401
3829
  /**
3402
3830
  * Changes the release coordinator.
@@ -3847,9 +4275,9 @@ declare module '@polkadot/api-base/types/submittable' {
3847
4275
  * - `auth_id` the authorization id to accept a `paying_key`.
3848
4276
  *
3849
4277
  * # Errors
3850
- * - `AuthorizationError::Invalid` if `auth_id` does not exist for the given caller.
3851
- * - `AuthorizationError::Expired` if `auth_id` the authorization has expired.
3852
- * - `AuthorizationError::BadType` if `auth_id` was not a `AddRelayerPayingKey` authorization.
4278
+ * - `Error::InvalidAuthorization` if `auth_id` does not exist for the given caller.
4279
+ * - `Error::AuthorizationExpired` if `auth_id` the authorization has expired.
4280
+ * - `Error::BadAuthorizationType` if `auth_id` was not a `AddRelayerPayingKey` authorization.
3853
4281
  * - `NotAuthorizedForUserKey` if `origin` is not authorized to accept the authorization for the `user_key`.
3854
4282
  * - `NotAuthorizedForPayingKey` if the authorization was created an identity different from the `paying_key`'s identity.
3855
4283
  * - `UserKeyCddMissing` if the `user_key` is not attached to a CDD'd identity.
@@ -5296,15 +5724,13 @@ declare module '@polkadot/api-base/types/submittable' {
5296
5724
  };
5297
5725
  sudo: {
5298
5726
  /**
5299
- * Authenticates the current sudo key and sets the given AccountId (`new`) as the new sudo key.
5727
+ * Authenticates the current sudo key and sets the given AccountId (`new`) as the new sudo
5728
+ * key.
5300
5729
  *
5301
5730
  * The dispatch origin for this call must be _Signed_.
5302
5731
  *
5303
- * # <weight>
5732
+ * ## Complexity
5304
5733
  * - O(1).
5305
- * - Limited storage reads.
5306
- * - One DB change.
5307
- * # </weight>
5308
5734
  **/
5309
5735
  setKey: AugmentedSubmittable<(updated: MultiAddress | {
5310
5736
  Id: any;
@@ -5324,12 +5750,8 @@ declare module '@polkadot/api-base/types/submittable' {
5324
5750
  *
5325
5751
  * The dispatch origin for this call must be _Signed_.
5326
5752
  *
5327
- * # <weight>
5753
+ * ## Complexity
5328
5754
  * - O(1).
5329
- * - Limited storage reads.
5330
- * - One DB write (event).
5331
- * - Weight of derivative `call` execution + 10,000.
5332
- * # </weight>
5333
5755
  **/
5334
5756
  sudo: AugmentedSubmittable<(call: Call | IMethod | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
5335
5757
  Call
@@ -5340,12 +5762,8 @@ declare module '@polkadot/api-base/types/submittable' {
5340
5762
  *
5341
5763
  * The dispatch origin for this call must be _Signed_.
5342
5764
  *
5343
- * # <weight>
5765
+ * ## Complexity
5344
5766
  * - O(1).
5345
- * - Limited storage reads.
5346
- * - One DB write (event).
5347
- * - Weight of derivative `call` execution + 10,000.
5348
- * # </weight>
5349
5767
  **/
5350
5768
  sudoAs: AugmentedSubmittable<(who: MultiAddress | {
5351
5769
  Id: any;
@@ -5368,10 +5786,8 @@ declare module '@polkadot/api-base/types/submittable' {
5368
5786
  *
5369
5787
  * The dispatch origin for this call must be _Signed_.
5370
5788
  *
5371
- * # <weight>
5789
+ * ## Complexity
5372
5790
  * - O(1).
5373
- * - The weight of this call is defined by the caller.
5374
- * # </weight>
5375
5791
  **/
5376
5792
  sudoUncheckedWeight: AugmentedSubmittable<(call: Call | IMethod | string | Uint8Array, weight: SpWeightsWeightV2Weight | {
5377
5793
  refTime?: any;
@@ -5451,12 +5867,12 @@ declare module '@polkadot/api-base/types/submittable' {
5451
5867
  * # Arguments
5452
5868
  * * `expiry` - The new expiry time.
5453
5869
  **/
5454
- setExpiresAfter: AugmentedSubmittable<(expiry: PolymeshCommonUtilitiesMaybeBlock | {
5870
+ setExpiresAfter: AugmentedSubmittable<(expiry: PolymeshPrimitivesMaybeBlock | {
5455
5871
  Some: any;
5456
5872
  } | {
5457
5873
  None: any;
5458
5874
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
5459
- PolymeshCommonUtilitiesMaybeBlock
5875
+ PolymeshPrimitivesMaybeBlock
5460
5876
  ]>;
5461
5877
  /**
5462
5878
  * Changes the release coordinator.
@@ -5620,48 +6036,6 @@ declare module '@polkadot/api-base/types/submittable' {
5620
6036
  PolymeshPrimitivesIdentityId
5621
6037
  ]>;
5622
6038
  };
5623
- testUtils: {
5624
- /**
5625
- * Emits an event with caller's identity and CDD status.
5626
- **/
5627
- getCddOf: AugmentedSubmittable<(of: AccountId32 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
5628
- AccountId32
5629
- ]>;
5630
- /**
5631
- * Emits an event with caller's identity.
5632
- **/
5633
- getMyDid: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
5634
- /**
5635
- * Registers a new Identity for the `target_account` and issues a CDD claim to it.
5636
- *
5637
- * # Failure
5638
- * - `origin` has to be an active CDD provider. Inactive CDD providers cannot add new
5639
- * claims.
5640
- * - `target_account` (primary key of the new Identity) can be linked to just one and only
5641
- * one identity.
5642
- **/
5643
- mockCddRegisterDid: AugmentedSubmittable<(targetAccount: AccountId32 | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
5644
- AccountId32
5645
- ]>;
5646
- /**
5647
- * Generates a new `IdentityID` for the caller, and issues a self-generated CDD claim.
5648
- *
5649
- * The caller account will be the primary key of that identity.
5650
- * For each account of `secondary_keys`, a new `JoinIdentity` authorization is created, so
5651
- * each of them will need to accept it before become part of this new `IdentityID`.
5652
- *
5653
- * # Errors
5654
- * - `AlreadyLinked` if the caller account or if any of the given `secondary_keys` has already linked to an `IdentityID`
5655
- * - `SecondaryKeysContainPrimaryKey` if `secondary_keys` contains the caller account.
5656
- * - `DidAlreadyExists` if auto-generated DID already exists.
5657
- **/
5658
- registerDid: AugmentedSubmittable<(secondaryKeys: Vec<PolymeshPrimitivesSecondaryKey> | (PolymeshPrimitivesSecondaryKey | {
5659
- key?: any;
5660
- permissions?: any;
5661
- } | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [
5662
- Vec<PolymeshPrimitivesSecondaryKey>
5663
- ]>;
5664
- };
5665
6039
  timestamp: {
5666
6040
  /**
5667
6041
  * Set the current time.
@@ -5684,6 +6058,11 @@ declare module '@polkadot/api-base/types/submittable' {
5684
6058
  Compact<u64>
5685
6059
  ]>;
5686
6060
  };
6061
+ transactionPayment: {
6062
+ setDisableFees: AugmentedSubmittable<(value: bool | boolean | Uint8Array) => SubmittableExtrinsic<ApiType>, [
6063
+ bool
6064
+ ]>;
6065
+ };
5687
6066
  treasury: {
5688
6067
  /**
5689
6068
  * It transfers balances from treasury to each of beneficiaries and the specific amount
@@ -5716,12 +6095,12 @@ declare module '@polkadot/api-base/types/submittable' {
5716
6095
  * # Arguments
5717
6096
  * * `expiry` - The new expiry time.
5718
6097
  **/
5719
- setExpiresAfter: AugmentedSubmittable<(expiry: PolymeshCommonUtilitiesMaybeBlock | {
6098
+ setExpiresAfter: AugmentedSubmittable<(expiry: PolymeshPrimitivesMaybeBlock | {
5720
6099
  Some: any;
5721
6100
  } | {
5722
6101
  None: any;
5723
6102
  } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [
5724
- PolymeshCommonUtilitiesMaybeBlock
6103
+ PolymeshPrimitivesMaybeBlock
5725
6104
  ]>;
5726
6105
  /**
5727
6106
  * Changes the release coordinator.