feat: add withdrawable stake related methods (#1044)

* feat: add withdrawable stake related methods

* chore: typo

* ci: change order of code linting

Author: Cafe137

.github/workflows/check.yaml

@@ -31,11 +31,6 @@ jobs:
       - name: Commit linting
         uses: wagoid/commitlint-github-action@v2
 
-      - name: Code linting
-        run: npm run lint
-        env:
-          CI: true
-
       - name: Dependency check
         run: npm run depcheck
 
@@ -45,6 +40,11 @@ jobs:
       - name: Check build
         run: npm run build
 
+      - name: Code linting
+        run: npm run lint
+        env:
+          CI: true
+
       - name: Trigger API Docs update PR
         uses: peter-evans/repository-dispatch@v1
         if: github.ref == 'refs/heads/master'

src/bee.ts

@@ -1954,7 +1954,7 @@ export class Bee {
   }
 
   /**
-   * Cancel currently pending transaction
+   * Cancels a currently pending transaction
    * @param transactionHash
    * @param gasPrice
    */
@@ -1975,21 +1975,52 @@ export class Bee {
   }
 
   /**
-   * Gets the staked amount of BZZ (in PLUR unit) as number string.
+   * Gets the amount of staked BZZ
    *
-   * @param options
+   * @param options HTTP request options, such as `headers` or `timeout`
    */
   async getStake(options?: BeeRequestOptions): Promise<BZZ> {
     return stake.getStake(this.getRequestOptionsForCall(options))
   }
 
   /**
-   * Deposits given amount of BZZ token (in PLUR unit).
+   * Gets the amount of withdrawable staked BZZ.
+   *
+   * @param options HTTP request options, such as `headers` or `timeout`
+   */
+  async getWithdrawableStake(options?: BeeRequestOptions): Promise<BZZ> {
+    return stake.getWithdrawableStake(this.getRequestOptionsForCall(options))
+  }
+
+  /**
+   * Withdraws ALL surplus staked BZZ to the node wallet.
+   *
+   * Use the `getWithdrawableStake` method to check how much surplus stake is available.
+   *
+   * @param options HTTP request options, such as `headers` or `timeout`
+   */
+  async withdrawSurplusStake(options?: BeeRequestOptions): Promise<TransactionId> {
+    return stake.withdrawSurplusStake(this.getRequestOptionsForCall(options))
+  }
+
+  /**
+   * Withdraws all staked BZZ to the node wallet.
+   *
+   * **Only available when the staking contract is paused and is in the process of being migrated to a new contract!**
+   *
+   * @param options HTTP request options, such as `headers` or `timeout`
+   */
+  async migrateStake(options?: BeeRequestOptions): Promise<TransactionId> {
+    return stake.migrateStake(this.getRequestOptionsForCall(options))
+  }
+
+  /**
+   * Stakes the given amount of BZZ. Initial deposit must be at least 10 BZZ.
    *
    * Be aware that staked BZZ tokens can **not** be withdrawn.
    *
-   * @param amount Amount of BZZ token (in PLUR unit) to be staked. Minimum is 100_000_000_000_000_000 PLUR (10 BZZ).
-   * @param options
+   * @param amount Amount of BZZ tokens to be staked. If not providing a `BZZ` instance, the amount is denoted in PLUR.
+   * @param options HTTP request options, such as `headers` or `timeout`
    */
   async depositStake(
     amount: BZZ | NumberString | string | bigint,
@@ -2007,9 +2038,9 @@ export class Bee {
   }
 
   /**
-   * Get current status of node in redistribution game
+   * Gets current status of node in redistribution game
    *
-   * @param options
+   * @param options HTTP request options, such as `headers` or `timeout`
    */
   async getRedistributionState(options?: BeeRequestOptions): Promise<RedistributionState> {
     return stake.getRedistributionState(this.getRequestOptionsForCall(options))

src/modules/debug/stake.ts

@@ -10,7 +10,7 @@ const STAKE_ENDPOINT = 'stake'
 const REDISTRIBUTION_ENDPOINT = 'redistributionstate'
 
 /**
- * Gets the staked amount
+ * Gets the amount of staked BZZ
  *
  * @param requestOptions Options for making requests
  */
@@ -26,12 +26,52 @@ export async function getStake(requestOptions: BeeRequestOptions): Promise<BZZ>
   return BZZ.fromPLUR(asNumberString(body.stakedAmount, { name: 'stakedAmount' }))
 }
 
+/**
+ * Gets the amount of withdrawable staked BZZ
+ *
+ * @param requestOptions Options for making requests
+ */
+export async function getWithdrawableStake(requestOptions: BeeRequestOptions): Promise<BZZ> {
+  const response = await http<unknown>(requestOptions, {
+    method: 'get',
+    responseType: 'json',
+    url: `${STAKE_ENDPOINT}/withdrawable`,
+  })
+
+  const body = Types.asObject(response.data, { name: 'response.data' })
+
+  return BZZ.fromPLUR(asNumberString(body.withdrawableAmount, { name: 'withdrawableAmount' }))
+}
+
+export async function withdrawSurplusStake(requestOptions: BeeRequestOptions): Promise<TransactionId> {
+  const response = await http<unknown>(requestOptions, {
+    method: 'delete',
+    responseType: 'json',
+    url: `${STAKE_ENDPOINT}/withdrawable`,
+  })
+
+  const body = Types.asObject(response.data, { name: 'response.data' })
+
+  return new TransactionId(Types.asHexString(body.txHash, { name: 'txHash' }))
+}
+
+export async function migrateStake(requestOptions: BeeRequestOptions): Promise<TransactionId> {
+  const response = await http<unknown>(requestOptions, {
+    method: 'delete',
+    responseType: 'json',
+    url: STAKE_ENDPOINT,
+  })
+
+  const body = Types.asObject(response.data, { name: 'response.data' })
+
+  return new TransactionId(Types.asHexString(body.txHash, { name: 'txHash' }))
+}
+
 /**
  * Stake given amount of tokens.
  *
  * @param requestOptions Options for making requests
  * @param amount
- * @param options
  */
 export async function stake(
   requestOptions: BeeRequestOptions,