@polkadot/api-augment 9.4.1 → 9.4.3

package/substrate/tx.d.ts

@@ -1055,56 +1055,6 @@ declare module '@polkadot/api-base/types/submittable' {
              **/
             [key: string]: SubmittableExtrinsicFunction<ApiType>;
         };
-        bagsList: {
-            /**
-             * Move the caller's Id directly in front of `lighter`.
-             *
-             * The dispatch origin for this call must be _Signed_ and can only be called by the Id of
-             * the account going in front of `lighter`.
-             *
-             * Only works if
-             * - both nodes are within the same bag,
-             * - and `origin` has a greater `Score` than `lighter`.
-             **/
-            putInFrontOf: AugmentedSubmittable<(lighter: MultiAddress | {
-                Id: any;
-            } | {
-                Index: any;
-            } | {
-                Raw: any;
-            } | {
-                Address32: any;
-            } | {
-                Address20: any;
-            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress]>;
-            /**
-             * Declare that some `dislocated` account has, through rewards or penalties, sufficiently
-             * changed its score that it should properly fall into a different bag than its current
-             * one.
-             *
-             * Anyone can call this function about any potentially dislocated account.
-             *
-             * Will always update the stored score of `dislocated` to the correct score, based on
-             * `ScoreProvider`.
-             *
-             * If `dislocated` does not exists, it returns an error.
-             **/
-            rebag: AugmentedSubmittable<(dislocated: MultiAddress | {
-                Id: any;
-            } | {
-                Index: any;
-            } | {
-                Raw: any;
-            } | {
-                Address32: any;
-            } | {
-                Address20: any;
-            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress]>;
-            /**
-             * Generic tx
-             **/
-            [key: string]: SubmittableExtrinsicFunction<ApiType>;
-        };
         balances: {
             /**
              * Exactly as `transfer`, except the origin must be root and the source account may be
@@ -2612,6 +2562,50 @@ declare module '@polkadot/api-base/types/submittable' {
              **/
             [key: string]: SubmittableExtrinsicFunction<ApiType>;
         };
+        fastUnstake: {
+            /**
+             * Control the operation of this pallet.
+             *
+             * Dispatch origin must be signed by the [`Config::ControlOrigin`].
+             **/
+            control: AugmentedSubmittable<(uncheckedErasToCheck: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
+            /**
+             * Deregister oneself from the fast-unstake (also cancels joining the pool if that was
+             * supplied on `register_fast_unstake` .
+             *
+             * This is useful if one is registered, they are still waiting, and they change their mind.
+             *
+             * Note that the associated stash is still fully unbonded and chilled as a consequence of
+             * calling `register_fast_unstake`. This should probably be followed by a call to
+             * `Staking::rebond`.
+             **/
+            deregister: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
+            /**
+             * Register oneself for fast-unstake.
+             *
+             * The dispatch origin of this call must be signed by the controller account, similar to
+             * `staking::unbond`.
+             *
+             * The stash associated with the origin must have no ongoing unlocking chunks. If
+             * successful, this will fully unbond and chill the stash. Then, it will enqueue the stash
+             * to be checked in further blocks.
+             *
+             * If by the time this is called, the stash is actually eligible for fast-unstake, then
+             * they are guaranteed to remain eligible, because the call will chill them as well.
+             *
+             * If the check works, the entire staking data is removed, i.e. the stash is fully
+             * unstaked, and they potentially join a pool with their entire bonded stake.
+             *
+             * If the check fails, the stash remains chilled and waiting for being unbonded as in with
+             * the normal staking system, but they lose part of their unbonding chunks due to consuming
+             * the chain's resources.
+             **/
+            registerFastUnstake: AugmentedSubmittable<(maybePoolId: Option<u32> | null | Uint8Array | u32 | AnyNumber) => SubmittableExtrinsic<ApiType>, [Option<u32>]>;
+            /**
+             * Generic tx
+             **/
+            [key: string]: SubmittableExtrinsicFunction<ApiType>;
+        };
         gilt: {
             /**
              * Place a bid for a gilt to be issued.
@@ -3798,10 +3792,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * - `proxy_type`: The permissions allowed for this proxy account.
              * - `delay`: The announcement period required of the initial proxy. Will generally be
              * zero.
-             *
-             * # <weight>
-             * Weight is a function of the number of proxies the user has (P).
-             * # </weight>
              **/
             addProxy: AugmentedSubmittable<(delegate: MultiAddress | {
                 Id: any;
@@ -3830,12 +3820,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * Parameters:
              * - `real`: The account that the proxy will make a call on behalf of.
              * - `call_hash`: The hash of the call to be made by the `real` account.
-             *
-             * # <weight>
-             * Weight is a function of:
-             * - A: the number of announcements made.
-             * - P: the number of proxies the user has.
-             * # </weight>
              **/
             announce: AugmentedSubmittable<(real: MultiAddress | {
                 Id: any;
@@ -3867,36 +3851,27 @@ declare module '@polkadot/api-base/types/submittable' {
              * same sender, with the same parameters.
              *
              * Fails if there are insufficient funds to pay for deposit.
-             *
-             * # <weight>
-             * Weight is a function of the number of proxies the user has (P).
-             * # </weight>
-             * TODO: Might be over counting 1 read
              **/
-            anonymous: AugmentedSubmittable<(proxyType: KitchensinkRuntimeProxyType | 'Any' | 'NonTransfer' | 'Governance' | 'Staking' | number | Uint8Array, delay: u32 | AnyNumber | Uint8Array, index: u16 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [KitchensinkRuntimeProxyType, u32, u16]>;
+            createPure: AugmentedSubmittable<(proxyType: KitchensinkRuntimeProxyType | 'Any' | 'NonTransfer' | 'Governance' | 'Staking' | number | Uint8Array, delay: u32 | AnyNumber | Uint8Array, index: u16 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [KitchensinkRuntimeProxyType, u32, u16]>;
             /**
-             * Removes a previously spawned anonymous proxy.
+             * Removes a previously spawned pure proxy.
              *
              * WARNING: **All access to this account will be lost.** Any funds held in it will be
              * inaccessible.
              *
              * Requires a `Signed` origin, and the sender account must have been created by a call to
-             * `anonymous` with corresponding parameters.
-             *
-             * - `spawner`: The account that originally called `anonymous` to create this account.
-             * - `index`: The disambiguation index originally passed to `anonymous`. Probably `0`.
-             * - `proxy_type`: The proxy type originally passed to `anonymous`.
-             * - `height`: The height of the chain when the call to `anonymous` was processed.
-             * - `ext_index`: The extrinsic index in which the call to `anonymous` was processed.
+             * `pure` with corresponding parameters.
              *
-             * Fails with `NoPermission` in case the caller is not a previously created anonymous
-             * account whose `anonymous` call has corresponding parameters.
+             * - `spawner`: The account that originally called `pure` to create this account.
+             * - `index`: The disambiguation index originally passed to `pure`. Probably `0`.
+             * - `proxy_type`: The proxy type originally passed to `pure`.
+             * - `height`: The height of the chain when the call to `pure` was processed.
+             * - `ext_index`: The extrinsic index in which the call to `pure` was processed.
              *
-             * # <weight>
-             * Weight is a function of the number of proxies the user has (P).
-             * # </weight>
+             * Fails with `NoPermission` in case the caller is not a previously created pure
+             * account whose `pure` call has corresponding parameters.
              **/
-            killAnonymous: AugmentedSubmittable<(spawner: MultiAddress | {
+            killPure: AugmentedSubmittable<(spawner: MultiAddress | {
                 Id: any;
             } | {
                 Index: any;
@@ -3919,10 +3894,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * - `real`: The account that the proxy will make a call on behalf of.
              * - `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
              * - `call`: The call to be made by the `real` account.
-             *
-             * # <weight>
-             * Weight is a function of the number of proxies the user has (P).
-             * # </weight>
              **/
             proxy: AugmentedSubmittable<(real: MultiAddress | {
                 Id: any;
@@ -3947,12 +3918,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * - `real`: The account that the proxy will make a call on behalf of.
              * - `force_proxy_type`: Specify the exact proxy type to be used and checked for this call.
              * - `call`: The call to be made by the `real` account.
-             *
-             * # <weight>
-             * Weight is a function of:
-             * - A: the number of announcements made.
-             * - P: the number of proxies the user has.
-             * # </weight>
              **/
             proxyAnnounced: AugmentedSubmittable<(delegate: MultiAddress | {
                 Id: any;
@@ -3986,12 +3951,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * Parameters:
              * - `delegate`: The account that previously announced the call.
              * - `call_hash`: The hash of the call to be made.
-             *
-             * # <weight>
-             * Weight is a function of:
-             * - A: the number of announcements made.
-             * - P: the number of proxies the user has.
-             * # </weight>
              **/
             rejectAnnouncement: AugmentedSubmittable<(delegate: MultiAddress | {
                 Id: any;
@@ -4015,12 +3974,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * Parameters:
              * - `real`: The account that the proxy will make a call on behalf of.
              * - `call_hash`: The hash of the call to be made by the `real` account.
-             *
-             * # <weight>
-             * Weight is a function of:
-             * - A: the number of announcements made.
-             * - P: the number of proxies the user has.
-             * # </weight>
              **/
             removeAnnouncement: AugmentedSubmittable<(real: MultiAddress | {
                 Id: any;
@@ -4038,12 +3991,8 @@ declare module '@polkadot/api-base/types/submittable' {
              *
              * The dispatch origin for this call must be _Signed_.
              *
-             * WARNING: This may be called on accounts created by `anonymous`, however if done, then
+             * WARNING: This may be called on accounts created by `pure`, however if done, then
              * the unreserved fees will be inaccessible. **All access to this account will be lost.**
-             *
-             * # <weight>
-             * Weight is a function of the number of proxies the user has (P).
-             * # </weight>
              **/
             removeProxies: AugmentedSubmittable<() => SubmittableExtrinsic<ApiType>, []>;
             /**
@@ -4054,10 +4003,6 @@ declare module '@polkadot/api-base/types/submittable' {
              * Parameters:
              * - `proxy`: The account that the `caller` would like to remove as a proxy.
              * - `proxy_type`: The permissions currently enabled for the removed proxy account.
-             *
-             * # <weight>
-             * Weight is a function of the number of proxies the user has (P).
-             * # </weight>
              **/
             removeProxy: AugmentedSubmittable<(delegate: MultiAddress | {
                 Id: any;
@@ -5390,31 +5335,6 @@ declare module '@polkadot/api-base/types/submittable' {
             } | {
                 Address20: any;
             } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress]>;
-            /**
-             * Set `HistoryDepth` value. This function will delete any history information
-             * when `HistoryDepth` is reduced.
-             *
-             * Parameters:
-             * - `new_history_depth`: The new history depth you would like to set.
-             * - `era_items_deleted`: The number of items that will be deleted by this dispatch. This
-             * should report all the storage items that will be deleted by clearing old era history.
-             * Needed to report an accurate weight for the dispatch. Trusted by `Root` to report an
-             * accurate number.
-             *
-             * Origin must be root.
-             *
-             * # <weight>
-             * - E: Number of history depths removed, i.e. 10 -> 7 = 3
-             * - Weight: O(E)
-             * - DB Weight:
-             * - Reads: Current Era, History Depth
-             * - Writes: History Depth
-             * - Clear Prefix Each: Era Stakers, EraStakersClipped, ErasValidatorPrefs
-             * - Writes Each: ErasValidatorReward, ErasRewardPoints, ErasTotalStake,
-             * ErasStartSessionIndex
-             * # </weight>
-             **/
-            setHistoryDepth: AugmentedSubmittable<(newHistoryDepth: Compact<u32> | AnyNumber | Uint8Array, eraItemsDeleted: Compact<u32> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u32>, Compact<u32>]>;
             /**
              * Set the validators who cannot be slashed (if any).
              *
@@ -5464,7 +5384,7 @@ declare module '@polkadot/api-base/types/submittable' {
              * * `min_commission`: The minimum amount of commission that each validators must maintain.
              * This is checked only upon calling `validate`. Existing validators are not affected.
              *
-             * Origin must be Root to call this function.
+             * RuntimeOrigin must be Root to call this function.
              *
              * NOTE: Existing nominators and validators will not be affected by this update.
              * to kick people under the new limits, `chill_other` should be called.
@@ -7240,6 +7160,56 @@ declare module '@polkadot/api-base/types/submittable' {
              **/
             [key: string]: SubmittableExtrinsicFunction<ApiType>;
         };
+        voterBagsList: {
+            /**
+             * Move the caller's Id directly in front of `lighter`.
+             *
+             * The dispatch origin for this call must be _Signed_ and can only be called by the Id of
+             * the account going in front of `lighter`.
+             *
+             * Only works if
+             * - both nodes are within the same bag,
+             * - and `origin` has a greater `Score` than `lighter`.
+             **/
+            putInFrontOf: AugmentedSubmittable<(lighter: MultiAddress | {
+                Id: any;
+            } | {
+                Index: any;
+            } | {
+                Raw: any;
+            } | {
+                Address32: any;
+            } | {
+                Address20: any;
+            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress]>;
+            /**
+             * Declare that some `dislocated` account has, through rewards or penalties, sufficiently
+             * changed its score that it should properly fall into a different bag than its current
+             * one.
+             *
+             * Anyone can call this function about any potentially dislocated account.
+             *
+             * Will always update the stored score of `dislocated` to the correct score, based on
+             * `ScoreProvider`.
+             *
+             * If `dislocated` does not exists, it returns an error.
+             **/
+            rebag: AugmentedSubmittable<(dislocated: MultiAddress | {
+                Id: any;
+            } | {
+                Index: any;
+            } | {
+                Raw: any;
+            } | {
+                Address32: any;
+            } | {
+                Address20: any;
+            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress]>;
+            /**
+             * Generic tx
+             **/
+            [key: string]: SubmittableExtrinsicFunction<ApiType>;
+        };
         whitelist: {
             dispatchWhitelistedCall: AugmentedSubmittable<(callHash: H256 | string | Uint8Array, callWeightWitness: Weight | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [H256, Weight]>;
             dispatchWhitelistedCallWithPreimage: AugmentedSubmittable<(call: Call | IMethod | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Call]>;