feat: add withdrawal to external wallets (#1042)

Author: Cafe137

src/bee.ts

@@ -99,7 +99,7 @@ import { fileArrayBuffer, isFile } from './utils/file'
 import { ResourceLocator } from './utils/resource-locator'
 import { Size } from './utils/size'
 import { getAmountForDuration, getDepthForSize, getStampCost } from './utils/stamps'
-import { BZZ } from './utils/tokens'
+import { BZZ, DAI } from './utils/tokens'
 import {
   asNumberString,
   assertData,
@@ -1437,16 +1437,32 @@ export class Bee {
   }
 
   /**
-   * Deposit tokens from overlay address into chequebook
+   * Deposit tokens from node wallet into chequebook
    *
    * @param amount  Amount of tokens to deposit (must be positive integer)
    * @param gasPrice Gas Price in WEI for the transaction call
    * @return string  Hash of the transaction
+   * @deprecated Use `depositBZZToChequebook` instead.
    */
   async depositTokens(
     amount: BZZ | NumberString | string | bigint,
     gasPrice?: NumberString | string | bigint,
     options?: BeeRequestOptions,
+  ): Promise<TransactionId> {
+    return this.depositBZZToChequebook(amount, gasPrice, options)
+  }
+
+  /**
+   * Deposit tokens from node wallet into chequebook
+   *
+   * @param amount  Amount of tokens to deposit (must be positive integer)
+   * @param gasPrice Gas Price in WEI for the transaction call
+   * @return string  Hash of the transaction
+   */
+  async depositBZZToChequebook(
+    amount: BZZ | NumberString | string | bigint,
+    gasPrice?: NumberString | string | bigint,
+    options?: BeeRequestOptions,
   ): Promise<TransactionId> {
     const amountString =
       amount instanceof BZZ ? amount.toPLURString() : asNumberString(amount, { min: 1n, name: 'amount' })
@@ -1461,16 +1477,32 @@ export class Bee {
   }
 
   /**
-   * Withdraw tokens from the chequebook to the overlay address
+   * Withdraw tokens from the chequebook to the node wallet
    *
    * @param amount  Amount of tokens to withdraw (must be positive integer)
    * @param gasPrice Gas Price in WEI for the transaction call
    * @return string  Hash of the transaction
+   * @deprecated Use `withdrawBZZFromChequebook` instead.
    */
   async withdrawTokens(
     amount: BZZ | NumberString | string | bigint,
     gasPrice?: NumberString | string | bigint,
     options?: BeeRequestOptions,
+  ): Promise<TransactionId> {
+    return this.withdrawBZZFromChequebook(amount, gasPrice, options)
+  }
+
+  /**
+   * Withdraw tokens from the chequebook to the node wallet
+   *
+   * @param amount  Amount of tokens to withdraw (must be positive integer)
+   * @param gasPrice Gas Price in WEI for the transaction call
+   * @return string  Hash of the transaction
+   */
+  async withdrawBZZFromChequebook(
+    amount: BZZ | NumberString | string | bigint,
+    gasPrice?: NumberString | string | bigint,
+    options?: BeeRequestOptions,
   ): Promise<TransactionId> {
     // TODO: check BZZ in tests
     const amountString =
@@ -1485,6 +1517,28 @@ export class Bee {
     return chequebook.withdrawTokens(this.getRequestOptionsForCall(options), amountString, gasPriceString)
   }
 
+  async withdrawBZZToExternalWallet(
+    amount: BZZ | NumberString | string | bigint,
+    address: EthAddress | Uint8Array | string,
+    options?: BeeRequestOptions,
+  ): Promise<TransactionId> {
+    amount = amount instanceof BZZ ? amount : BZZ.fromPLUR(amount)
+    address = new EthAddress(address)
+
+    return states.withdrawBZZ(this.getRequestOptionsForCall(options), amount, address)
+  }
+
+  async withdrawDAIToExternalWallet(
+    amount: DAI | NumberString | string | bigint,
+    address: EthAddress | Uint8Array | string,
+    options?: BeeRequestOptions,
+  ): Promise<TransactionId> {
+    amount = amount instanceof DAI ? amount : DAI.fromWei(amount)
+    address = new EthAddress(address)
+
+    return states.withdrawDAI(this.getRequestOptionsForCall(options), amount, address)
+  }
+
   /*
    * Settlements endpoint
    */
@@ -1581,7 +1635,7 @@ export class Bee {
   }
 
   /**
-   * Get wallet balances for xDai and BZZ of the Bee node
+   * Get wallet balances for DAI and BZZ of the Bee node
    *
    * @param options
    */

src/modules/debug/states.ts

@@ -3,6 +3,7 @@ import { BeeRequestOptions, ChainState, ReserveState, WalletBalance } from '../.
 import { http } from '../../utils/http'
 import { BZZ, DAI } from '../../utils/tokens'
 import { asNumberString } from '../../utils/type'
+import { EthAddress, TransactionId } from '../../utils/typed-bytes'
 import { normalizeCurrentPrice } from '../../utils/workaround'
 
 const RESERVE_STATE_ENDPOINT = 'reservestate'
@@ -74,3 +75,37 @@ export async function getWalletBalance(requestOptions: BeeRequestOptions): Promi
     walletAddress: Types.asString(body.walletAddress, { name: 'walletAddress' }),
   }
 }
+
+export async function withdrawBZZ(
+  requestOptions: BeeRequestOptions,
+  amount: BZZ,
+  address: EthAddress,
+): Promise<TransactionId> {
+  const response = await http<unknown>(requestOptions, {
+    method: 'post',
+    url: `${WALLET_ENDPOINT}/withdraw/bzz`,
+    responseType: 'json',
+    params: { amount: amount.toPLURString(), address: address.toHex() },
+  })
+
+  const body = Types.asObject(response.data, { name: 'response.data' })
+
+  return new TransactionId(Types.asString(body.transactionHash, { name: 'transactionHash' }))
+}
+
+export async function withdrawDAI(
+  requestOptions: BeeRequestOptions,
+  amount: DAI,
+  address: EthAddress,
+): Promise<TransactionId> {
+  const response = await http<unknown>(requestOptions, {
+    method: 'post',
+    url: `${WALLET_ENDPOINT}/withdraw/nativetoken`,
+    responseType: 'json',
+    params: { amount: amount.toWeiString(), address: address.toHex() },
+  })
+
+  const body = Types.asObject(response.data, { name: 'response.data' })
+
+  return new TransactionId(Types.asString(body.transactionHash, { name: 'transactionHash' }))
+}

test/integration/status.spec.ts

@@ -69,7 +69,7 @@ test('GET wallet', async () => {
   }
 
   const wallet = await bee.getWalletBalance()
-  expect(parseFloat(wallet.bzzBalance.toDecimalString())).toBeGreaterThan(50)
+  expect(parseFloat(wallet.bzzBalance.toDecimalString())).toBeGreaterThan(20)
   expect(parseFloat(wallet.bzzBalance.toDecimalString())).toBeLessThan(200)
   expect(parseFloat(wallet.nativeTokenBalance.toDecimalString())).toBeGreaterThan(4)
   expect(parseFloat(wallet.nativeTokenBalance.toDecimalString())).toBeLessThan(5)

test/integration/withdraw.spec.ts

@@ -0,0 +1,33 @@
+import { Dates, System } from 'cafe-utility'
+import { makeBee } from '../utils'
+
+const bee = makeBee()
+
+test('withdraw to external wallet', async () => {
+  const walletBefore = await bee.getWalletBalance()
+
+  await bee.withdrawBZZToExternalWallet('1', process.env.JEST_WITHDRAW_ADDRESS!)
+  await System.waitFor(
+    async () => {
+      const pendingTransactions = await bee.getAllPendingTransactions()
+      return pendingTransactions.length === 0
+    },
+    Dates.seconds(1),
+    60,
+  )
+
+  await bee.withdrawDAIToExternalWallet('1', process.env.JEST_WITHDRAW_ADDRESS!)
+  await System.waitFor(
+    async () => {
+      const pendingTransactions = await bee.getAllPendingTransactions()
+      return pendingTransactions.length === 0
+    },
+    Dates.seconds(1),
+    60,
+  )
+
+  const walletAfter = await bee.getWalletBalance()
+
+  expect(walletAfter.bzzBalance.toPLURBigInt()).toBeLessThan(walletBefore.bzzBalance.toPLURBigInt())
+  expect(walletAfter.nativeTokenBalance.toWeiBigInt()).toBeLessThan(walletBefore.nativeTokenBalance.toWeiBigInt())
+})

test/regression/bee-js-986.spec.ts

@@ -32,7 +32,7 @@ test('bee-js/986 - Headers not merging properly', async () => {
       host: 'localhost:11633',
       'swarm-act': 'true',
       'swarm-encrypt': 'true',
-      'swarm-postage-batch-id': 'f8b2ad296d64824a8fe51a33ff15fe8668df13a20ad3d4eea4bb97ca600029aa',
+      'swarm-postage-batch-id': 'b961413232c96eedae48947a71c99e454e51c4b5bf93a77c59f958af1229a932',
       'swarm-tag': '1337',
       'user-agent': 'axios/0.30.0',
     },