@dedot/chaintypes 0.62.0 → 0.63.0

package/westend/tx.d.ts

@@ -1236,7 +1236,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
 
     /**
      * Increments the ideal number of validators up to maximum of
-     * `ElectionProviderBase::MaxWinners`.
+     * `T::MaxValidatorSet`.
      *
      * The dispatch origin must be Root.
      *
@@ -1261,7 +1261,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
 
     /**
      * Scale up the ideal number of validators by a factor up to maximum of
-     * `ElectionProviderBase::MaxWinners`.
+     * `T::MaxValidatorSet`.
      *
      * The dispatch origin must be Root.
      *
@@ -1420,27 +1420,31 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
     >;
 
     /**
-     * Cancel enactment of a deferred slash.
+     * Cancels scheduled slashes for a given era before they are applied.
      *
-     * Can be called by the `T::AdminOrigin`.
+     * This function allows `T::AdminOrigin` to selectively remove pending slashes from
+     * the `UnappliedSlashes` storage, preventing their enactment.
      *
-     * Parameters: era and indices of the slashes for that era to kill.
+     * ## Parameters
+     * - `era`: The staking era for which slashes were deferred.
+     * - `slash_keys`: A list of slash keys identifying the slashes to remove. This is a tuple
+     * of `(stash, slash_fraction, page_index)`.
      *
      * @param {number} era
-     * @param {Array<number>} slashIndices
+     * @param {Array<[AccountId32Like, Perbill, number]>} slashKeys
      **/
     cancelDeferredSlash: GenericTxCall<
       Rv,
       (
         era: number,
-        slashIndices: Array<number>,
+        slashKeys: Array<[AccountId32Like, Perbill, number]>,
       ) => ChainSubmittableExtrinsic<
         Rv,
         {
           pallet: 'Staking';
           palletCall: {
             name: 'CancelDeferredSlash';
-            params: { era: number; slashIndices: Array<number> };
+            params: { era: number; slashKeys: Array<[AccountId32Like, Perbill, number]> };
           };
         }
       >
@@ -1851,6 +1855,99 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
       >
     >;
 
+    /**
+     * Migrates permissionlessly a stash from locks to holds.
+     *
+     * This removes the old lock on the stake and creates a hold on it atomically. If all
+     * stake cannot be held, the best effort is made to hold as much as possible. The remaining
+     * stake is removed from the ledger.
+     *
+     * The fee is waived if the migration is successful.
+     *
+     * @param {AccountId32Like} stash
+     **/
+    migrateCurrency: GenericTxCall<
+      Rv,
+      (stash: AccountId32Like) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'Staking';
+          palletCall: {
+            name: 'MigrateCurrency';
+            params: { stash: AccountId32Like };
+          };
+        }
+      >
+    >;
+
+    /**
+     * Manually applies a deferred slash for a given era.
+     *
+     * Normally, slashes are automatically applied shortly after the start of the `slash_era`.
+     * This function exists as a **fallback mechanism** in case slashes were not applied due to
+     * unexpected reasons. It allows anyone to manually apply an unapplied slash.
+     *
+     * ## Parameters
+     * - `slash_era`: The staking era in which the slash was originally scheduled.
+     * - `slash_key`: A unique identifier for the slash, represented as a tuple:
+     * - `stash`: The stash account of the validator being slashed.
+     * - `slash_fraction`: The fraction of the stake that was slashed.
+     * - `page_index`: The index of the exposure page being processed.
+     *
+     * ## Behavior
+     * - The function is **permissionless**—anyone can call it.
+     * - The `slash_era` **must be the current era or a past era**. If it is in the future, the
+     * call fails with `EraNotStarted`.
+     * - The fee is waived if the slash is successfully applied.
+     *
+     * ## TODO: Future Improvement
+     * - Implement an **off-chain worker (OCW) task** to automatically apply slashes when there
+     * is unused block space, improving efficiency.
+     *
+     * @param {number} slashEra
+     * @param {[AccountId32Like, Perbill, number]} slashKey
+     **/
+    applySlash: GenericTxCall<
+      Rv,
+      (
+        slashEra: number,
+        slashKey: [AccountId32Like, Perbill, number],
+      ) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'Staking';
+          palletCall: {
+            name: 'ApplySlash';
+            params: { slashEra: number; slashKey: [AccountId32Like, Perbill, number] };
+          };
+        }
+      >
+    >;
+
+    /**
+     * Adjusts the staking ledger by withdrawing any excess staked amount.
+     *
+     * This function corrects cases where a user's recorded stake in the ledger
+     * exceeds their actual staked funds. This situation can arise due to cases such as
+     * external slashing by another pallet, leading to an inconsistency between the ledger
+     * and the actual stake.
+     *
+     * @param {AccountId32Like} stash
+     **/
+    withdrawOverstake: GenericTxCall<
+      Rv,
+      (stash: AccountId32Like) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'Staking';
+          palletCall: {
+            name: 'WithdrawOverstake';
+            params: { stash: AccountId32Like };
+          };
+        }
+      >
+    >;
+
     /**
      * Generic pallet tx call
      **/
@@ -2248,6 +2345,78 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
       >
     >;
 
+    /**
+     * Dispatch a fallback call in the event the main call fails to execute.
+     * May be called from any origin except `None`.
+     *
+     * This function first attempts to dispatch the `main` call.
+     * If the `main` call fails, the `fallback` is attemted.
+     * if the fallback is successfully dispatched, the weights of both calls
+     * are accumulated and an event containing the main call error is deposited.
+     *
+     * In the event of a fallback failure the whole call fails
+     * with the weights returned.
+     *
+     * - `main`: The main call to be dispatched. This is the primary action to execute.
+     * - `fallback`: The fallback call to be dispatched in case the `main` call fails.
+     *
+     * ## Dispatch Logic
+     * - If the origin is `root`, both the main and fallback calls are executed without
+     * applying any origin filters.
+     * - If the origin is not `root`, the origin filter is applied to both the `main` and
+     * `fallback` calls.
+     *
+     * ## Use Case
+     * - Some use cases might involve submitting a `batch` type call in either main, fallback
+     * or both.
+     *
+     * @param {WestendRuntimeRuntimeCallLike} main
+     * @param {WestendRuntimeRuntimeCallLike} fallback
+     **/
+    ifElse: GenericTxCall<
+      Rv,
+      (
+        main: WestendRuntimeRuntimeCallLike,
+        fallback: WestendRuntimeRuntimeCallLike,
+      ) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'Utility';
+          palletCall: {
+            name: 'IfElse';
+            params: { main: WestendRuntimeRuntimeCallLike; fallback: WestendRuntimeRuntimeCallLike };
+          };
+        }
+      >
+    >;
+
+    /**
+     * Dispatches a function call with a provided origin.
+     *
+     * Almost the same as [`Pallet::dispatch_as`] but forwards any error of the inner call.
+     *
+     * The dispatch origin for this call must be _Root_.
+     *
+     * @param {WestendRuntimeOriginCaller} asOrigin
+     * @param {WestendRuntimeRuntimeCallLike} call
+     **/
+    dispatchAsFallible: GenericTxCall<
+      Rv,
+      (
+        asOrigin: WestendRuntimeOriginCaller,
+        call: WestendRuntimeRuntimeCallLike,
+      ) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'Utility';
+          palletCall: {
+            name: 'DispatchAsFallible';
+            params: { asOrigin: WestendRuntimeOriginCaller; call: WestendRuntimeRuntimeCallLike };
+          };
+        }
+      >
+    >;
+
     /**
      * Generic pallet tx call
      **/
@@ -2948,7 +3117,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
     >;
 
     /**
-     * Allow ROOT to bypass the recovery process and set an a rescuer account
+     * Allow ROOT to bypass the recovery process and set a rescuer account
      * for a lost account directly.
      *
      * The dispatch origin for this call must be _ROOT_.
@@ -3789,7 +3958,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
     >;
 
     /**
-     * Ensure that the a bulk of pre-images is upgraded.
+     * Ensure that the bulk of pre-images is upgraded.
      *
      * The caller pays no fee if at least 90% of pre-images were successfully updated.
      *
@@ -4658,21 +4827,15 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      * This can only be called when [`Phase::Emergency`] is enabled, as an alternative to
      * calling [`Call::set_emergency_election_result`].
      *
-     * @param {number | undefined} maybeMaxVoters
-     * @param {number | undefined} maybeMaxTargets
      **/
     governanceFallback: GenericTxCall<
       Rv,
-      (
-        maybeMaxVoters: number | undefined,
-        maybeMaxTargets: number | undefined,
-      ) => ChainSubmittableExtrinsic<
+      () => ChainSubmittableExtrinsic<
         Rv,
         {
           pallet: 'ElectionProviderMultiPhase';
           palletCall: {
             name: 'GovernanceFallback';
-            params: { maybeMaxVoters: number | undefined; maybeMaxTargets: number | undefined };
           };
         }
       >
@@ -4778,8 +4941,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
    **/
   nominationPools: {
     /**
-     * Stake funds with a pool. The amount to bond is transferred from the member to the pool
-     * account and immediately increases the pools bond.
+     * Stake funds with a pool. The amount to bond is delegated (or transferred based on
+     * [`adapter::StakeStrategyType`]) from the member to the pool account and immediately
+     * increases the pool's bond.
      *
      * The method of transferring the amount to the pool account is determined by
      * [`adapter::StakeStrategyType`]. If the pool is configured to use
@@ -5077,13 +5241,13 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      * The dispatch origin of this call must be signed by the pool nominator or the pool
      * root role.
      *
-     * This directly forward the call to the staking pallet, on behalf of the pool bonded
-     * account.
+     * This directly forwards the call to an implementation of `StakingInterface` (e.g.,
+     * `pallet-staking`) through [`Config::StakeAdapter`], on behalf of the bonded pool.
      *
      * # Note
      *
-     * In addition to a `root` or `nominator` role of `origin`, pool's depositor needs to have
-     * at least `depositor_min_bond` in the pool to start nominating.
+     * In addition to a `root` or `nominator` role of `origin`, the pool's depositor needs to
+     * have at least `depositor_min_bond` in the pool to start nominating.
      *
      * @param {number} poolId
      * @param {Array<AccountId32Like>} validators
@@ -5255,6 +5419,9 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      * The dispatch origin of this call can be signed by the pool nominator or the pool
      * root role, same as [`Pallet::nominate`].
      *
+     * This directly forwards the call to an implementation of `StakingInterface` (e.g.,
+     * `pallet-staking`) through [`Config::StakeAdapter`], on behalf of the bonded pool.
+     *
      * Under certain conditions, this call can be dispatched permissionlessly (i.e. by any
      * account).
      *
@@ -5263,9 +5430,7 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      * are unable to unbond.
      *
      * # Conditions for permissioned dispatch:
-     * * The caller has a nominator or root role of the pool.
-     * This directly forward the call to the staking pallet, on behalf of the pool bonded
-     * account.
+     * * The caller is the pool's nominator or root.
      *
      * @param {number} poolId
      **/
@@ -5444,9 +5609,20 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
     /**
      * Claim pending commission.
      *
-     * The dispatch origin of this call must be signed by the `root` role of the pool. Pending
-     * commission is paid out and added to total claimed commission`. Total pending commission
-     * is reset to zero. the current.
+     * The `root` role of the pool is _always_ allowed to claim the pool's commission.
+     *
+     * If the pool has set `CommissionClaimPermission::Permissionless`, then any account can
+     * trigger the process of claiming the pool's commission.
+     *
+     * If the pool has set its `CommissionClaimPermission` to `Account(acc)`, then only
+     * accounts
+     * * `acc`, and
+     * * the pool's root account
+     *
+     * may call this extrinsic on behalf of the pool.
+     *
+     * Pending commissions are paid out and added to the total claimed commission.
+     * The total pending commission is reset to zero.
      *
      * @param {number} poolId
      **/
@@ -5521,8 +5697,10 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
      * Fails unless [`crate::pallet::Config::StakeAdapter`] is of strategy type:
      * [`adapter::StakeStrategyType::Delegate`].
      *
-     * This call can be dispatched permissionlessly (i.e. by any account). If the member has
-     * slash to be applied, caller may be rewarded with the part of the slash.
+     * The pending slash amount of the member must be equal or more than `ExistentialDeposit`.
+     * This call can be dispatched permissionlessly (i.e. by any account). If the execution
+     * is successful, fee is refunded and caller may be rewarded with a part of the slash
+     * based on the [`crate::pallet::Config::StakeAdapter`] configuration.
      *
      * @param {MultiAddressLike} memberAccount
      **/
@@ -8235,6 +8413,45 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
       >
     >;
 
+    /**
+     * Create a single on demand core order with credits.
+     * Will charge the owner's on-demand credit account the spot price for the current block.
+     *
+     * Parameters:
+     * - `origin`: The sender of the call, on-demand credits will be withdrawn from this
+     * account.
+     * - `max_amount`: The maximum number of credits to spend from the origin to place an
+     * order.
+     * - `para_id`: A `ParaId` the origin wants to provide blockspace for.
+     *
+     * Errors:
+     * - `InsufficientCredits`
+     * - `QueueFull`
+     * - `SpotPriceHigherThanMaxAmount`
+     *
+     * Events:
+     * - `OnDemandOrderPlaced`
+     *
+     * @param {bigint} maxAmount
+     * @param {PolkadotParachainPrimitivesPrimitivesId} paraId
+     **/
+    placeOrderWithCredits: GenericTxCall<
+      Rv,
+      (
+        maxAmount: bigint,
+        paraId: PolkadotParachainPrimitivesPrimitivesId,
+      ) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'OnDemandAssignmentProvider';
+          palletCall: {
+            name: 'PlaceOrderWithCredits';
+            params: { maxAmount: bigint; paraId: PolkadotParachainPrimitivesPrimitivesId };
+          };
+        }
+      >
+    >;
+
     /**
      * Generic pallet tx call
      **/
@@ -9327,6 +9544,28 @@ export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCal
       >
     >;
 
+    /**
+     *
+     * @param {AccountId32Like} who
+     * @param {bigint} amount
+     **/
+    creditAccount: GenericTxCall<
+      Rv,
+      (
+        who: AccountId32Like,
+        amount: bigint,
+      ) => ChainSubmittableExtrinsic<
+        Rv,
+        {
+          pallet: 'Coretime';
+          palletCall: {
+            name: 'CreditAccount';
+            params: { who: AccountId32Like; amount: bigint };
+          };
+        }
+      >
+    >;
+
     /**
      * Receive instructions from the `ExternalBrokerOrigin`, detailing how a specific core is
      * to be used.