@polkadot/api-augment 9.13.5 → 9.14.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.
package/substrate/tx.d.ts CHANGED
@@ -4,7 +4,7 @@ import type { Data } from '@polkadot/types';
4
4
  import type { Bytes, Compact, Option, U8aFixed, Vec, bool, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
5
5
  import type { AnyNumber, IMethod, ITuple } from '@polkadot/types-codec/types';
6
6
  import type { AccountId32, Call, H256, MultiAddress, Perbill, Percent, Perquintill } from '@polkadot/types/interfaces/runtime';
7
- import type { FrameSupportPreimagesBounded, FrameSupportScheduleDispatchTime, FrameSupportTokensMiscAttributeNamespace, KitchensinkRuntimeOriginCaller, KitchensinkRuntimeProxyType, KitchensinkRuntimeSessionKeys, PalletAllianceCid, PalletAllianceDisbandWitness, PalletAllianceUnscrupulousItem, PalletContractsWasmDeterminism, PalletConvictionVotingConviction, PalletConvictionVotingVoteAccountVote, PalletDemocracyConviction, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityBitFlags, PalletIdentityIdentityInfo, PalletIdentityJudgement, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletMessageQueueMockHelpersMessageOrigin, PalletMultisigTimepoint, PalletNftsCancelAttributesApprovalWitness, PalletNftsCollectionConfig, PalletNftsDestroyWitness, PalletNftsItemConfig, PalletNftsItemTip, PalletNftsMintSettings, PalletNftsMintWitness, PalletNftsPriceWithDirection, PalletNominationPoolsBondExtra, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpU128, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletSocietyJudgement, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingValidatorPrefs, PalletStateTrieMigrationMigrationLimits, PalletStateTrieMigrationMigrationTask, PalletStateTrieMigrationProgress, PalletUniquesDestroyWitness, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusSlotsEquivocationProof, SpFinalityGrandpaEquivocationProof, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeHeader, SpSessionMembershipProof, SpTransactionStorageProofTransactionStorageProof, SpWeightsWeightV2Weight } from '@polkadot/types/lookup';
7
+ import type { FrameSupportPreimagesBounded, FrameSupportScheduleDispatchTime, FrameSupportTokensMiscAttributeNamespace, KitchensinkRuntimeOriginCaller, KitchensinkRuntimeProxyType, KitchensinkRuntimeSessionKeys, PalletAllianceCid, PalletAllianceDisbandWitness, PalletAllianceUnscrupulousItem, PalletContractsWasmDeterminism, PalletConvictionVotingConviction, PalletConvictionVotingVoteAccountVote, PalletDemocracyConviction, PalletDemocracyMetadataOwner, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityBitFlags, PalletIdentityIdentityInfo, PalletIdentityJudgement, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletMessageQueueMockHelpersMessageOrigin, PalletMultisigTimepoint, PalletNftsCancelAttributesApprovalWitness, PalletNftsCollectionConfig, PalletNftsDestroyWitness, PalletNftsItemConfig, PalletNftsItemTip, PalletNftsMintSettings, PalletNftsMintWitness, PalletNftsPriceWithDirection, PalletNominationPoolsBondExtra, PalletNominationPoolsConfigOpAccountId32, PalletNominationPoolsConfigOpU128, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletSocietyJudgement, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU128, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingValidatorPrefs, PalletStateTrieMigrationMigrationLimits, PalletStateTrieMigrationMigrationTask, PalletStateTrieMigrationProgress, PalletUniquesDestroyWitness, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusSlotsEquivocationProof, SpFinalityGrandpaEquivocationProof, SpNposElectionsElectionScore, SpNposElectionsSupport, SpSessionMembershipProof, SpTransactionStorageProofTransactionStorageProof, SpWeightsWeightV2Weight } from '@polkadot/types/lookup';
8
8
  export type __AugmentedSubmittable = AugmentedSubmittable<() => unknown>;
9
9
  export type __SubmittableExtrinsic<ApiType extends ApiTypes> = SubmittableExtrinsic<ApiType>;
10
10
  export type __SubmittableExtrinsicFunction<ApiType extends ApiTypes> = SubmittableExtrinsicFunction<ApiType>;
@@ -308,7 +308,7 @@ declare module '@polkadot/api-base/types/submittable' {
308
308
  * - `old_count`: The upper bound for the previous number of members in storage. Used for
309
309
  * weight estimation.
310
310
  *
311
- * Requires root origin.
311
+ * The dispatch of this call must be `SetMembersOrigin`.
312
312
  *
313
313
  * NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
314
314
  * the weight estimations rely on it to estimate dispatchable weight.
@@ -1068,22 +1068,6 @@ declare module '@polkadot/api-base/types/submittable' {
1068
1068
  **/
1069
1069
  [key: string]: SubmittableExtrinsicFunction<ApiType>;
1070
1070
  };
1071
- authorship: {
1072
- /**
1073
- * Provide a set of uncles.
1074
- **/
1075
- setUncles: AugmentedSubmittable<(newUncles: Vec<SpRuntimeHeader> | (SpRuntimeHeader | {
1076
- parentHash?: any;
1077
- number?: any;
1078
- stateRoot?: any;
1079
- extrinsicsRoot?: any;
1080
- digest?: any;
1081
- } | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [Vec<SpRuntimeHeader>]>;
1082
- /**
1083
- * Generic tx
1084
- **/
1085
- [key: string]: SubmittableExtrinsicFunction<ApiType>;
1086
- };
1087
1071
  babe: {
1088
1072
  /**
1089
1073
  * Plan an epoch config change. The epoch config change is recorded and will be enacted on
@@ -2088,7 +2072,7 @@ declare module '@polkadot/api-base/types/submittable' {
2088
2072
  * - `old_count`: The upper bound for the previous number of members in storage. Used for
2089
2073
  * weight estimation.
2090
2074
  *
2091
- * Requires root origin.
2075
+ * The dispatch of this call must be `SetMembersOrigin`.
2092
2076
  *
2093
2077
  * NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
2094
2078
  * the weight estimations rely on it to estimate dispatchable weight.
@@ -2388,6 +2372,30 @@ declare module '@polkadot/api-base/types/submittable' {
2388
2372
  * - `proposal`: The index of the proposal to second.
2389
2373
  **/
2390
2374
  second: AugmentedSubmittable<(proposal: Compact<u32> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u32>]>;
2375
+ /**
2376
+ * Set or clear a metadata of a proposal or a referendum.
2377
+ *
2378
+ * Parameters:
2379
+ * - `origin`: Must correspond to the `MetadataOwner`.
2380
+ * - `ExternalOrigin` for an external proposal with the `SuperMajorityApprove`
2381
+ * threshold.
2382
+ * - `ExternalDefaultOrigin` for an external proposal with the `SuperMajorityAgainst`
2383
+ * threshold.
2384
+ * - `ExternalMajorityOrigin` for an external proposal with the `SimpleMajority`
2385
+ * threshold.
2386
+ * - `Signed` by a creator for a public proposal.
2387
+ * - `Signed` to clear a metadata for a finished referendum.
2388
+ * - `Root` to set a metadata for an ongoing referendum.
2389
+ * - `owner`: an identifier of a metadata owner.
2390
+ * - `maybe_hash`: The hash of an on-chain stored preimage. `None` to clear a metadata.
2391
+ **/
2392
+ setMetadata: AugmentedSubmittable<(owner: PalletDemocracyMetadataOwner | {
2393
+ External: any;
2394
+ } | {
2395
+ Proposal: any;
2396
+ } | {
2397
+ Referendum: any;
2398
+ } | string | Uint8Array, maybeHash: Option<H256> | null | Uint8Array | H256 | string) => SubmittableExtrinsic<ApiType>, [PalletDemocracyMetadataOwner, Option<H256>]>;
2391
2399
  /**
2392
2400
  * Undelegate the voting power of the sending account.
2393
2401
  *
@@ -2651,10 +2659,6 @@ declare module '@polkadot/api-base/types/submittable' {
2651
2659
  *
2652
2660
  * It is the responsibility of the caller to **NOT** place all of their balance into the
2653
2661
  * lock and keep some for further operations.
2654
- *
2655
- * # <weight>
2656
- * We assume the maximum weight among all 3 cases: vote_equal, vote_more and vote_less.
2657
- * # </weight>
2658
2662
  **/
2659
2663
  vote: AugmentedSubmittable<(votes: Vec<AccountId32> | (AccountId32 | string | Uint8Array)[], value: Compact<u128> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [Vec<AccountId32>, Compact<u128>]>;
2660
2664
  /**
@@ -4913,8 +4917,6 @@ declare module '@polkadot/api-base/types/submittable' {
4913
4917
  * Dispatch the given `call` from an account that the sender is authorised for through
4914
4918
  * `add_proxy`.
4915
4919
  *
4916
- * Removes any corresponding announcement(s).
4917
- *
4918
4920
  * The dispatch origin for this call must be _Signed_.
4919
4921
  *
4920
4922
  * Parameters:
@@ -5228,6 +5230,16 @@ declare module '@polkadot/api-base/types/submittable' {
5228
5230
  * Emits `SubmissionDepositRefunded`.
5229
5231
  **/
5230
5232
  refundSubmissionDeposit: AugmentedSubmittable<(index: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5233
+ /**
5234
+ * Set or clear metadata of a referendum.
5235
+ *
5236
+ * Parameters:
5237
+ * - `origin`: Must be `Signed` by a creator of a referendum or by anyone to clear a
5238
+ * metadata of a finished referendum.
5239
+ * - `index`: The index of a referendum to set or clear metadata for.
5240
+ * - `maybe_hash`: The hash of an on-chain stored preimage. `None` to clear a metadata.
5241
+ **/
5242
+ setMetadata: AugmentedSubmittable<(index: u32 | AnyNumber | Uint8Array, maybeHash: Option<H256> | null | Uint8Array | H256 | string) => SubmittableExtrinsic<ApiType>, [u32, Option<H256>]>;
5231
5243
  /**
5232
5244
  * Propose a referendum on a privileged action.
5233
5245
  *
@@ -5550,6 +5562,16 @@ declare module '@polkadot/api-base/types/submittable' {
5550
5562
  * Emits `SubmissionDepositRefunded`.
5551
5563
  **/
5552
5564
  refundSubmissionDeposit: AugmentedSubmittable<(index: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
5565
+ /**
5566
+ * Set or clear metadata of a referendum.
5567
+ *
5568
+ * Parameters:
5569
+ * - `origin`: Must be `Signed` by a creator of a referendum or by anyone to clear a
5570
+ * metadata of a finished referendum.
5571
+ * - `index`: The index of a referendum to set or clear metadata for.
5572
+ * - `maybe_hash`: The hash of an on-chain stored preimage. `None` to clear a metadata.
5573
+ **/
5574
+ setMetadata: AugmentedSubmittable<(index: u32 | AnyNumber | Uint8Array, maybeHash: Option<H256> | null | Uint8Array | H256 | string) => SubmittableExtrinsic<ApiType>, [u32, Option<H256>]>;
5553
5575
  /**
5554
5576
  * Propose a referendum on a privileged action.
5555
5577
  *
@@ -6939,7 +6961,7 @@ declare module '@polkadot/api-base/types/submittable' {
6939
6961
  * - `old_count`: The upper bound for the previous number of members in storage. Used for
6940
6962
  * weight estimation.
6941
6963
  *
6942
- * Requires root origin.
6964
+ * The dispatch of this call must be `SetMembersOrigin`.
6943
6965
  *
6944
6966
  * NOTE: Does not enforce the expected `MaxMembers` limit on the amount of members, but
6945
6967
  * the weight estimations rely on it to estimate dispatchable weight.