@ethersphere/bee-js 9.4.1 → 9.6.0

package/dist/mjs/bee.js

@@ -35,7 +35,7 @@ import { BeeArgumentError, BeeError } from "./utils/error.js";
 import { fileArrayBuffer, isFile } from "./utils/file.js";
 import { ResourceLocator } from "./utils/resource-locator.js";
 import { getAmountForDuration, getDepthForSize, getStampCost } from "./utils/stamps.js";
-import { BZZ } from "./utils/tokens.js";
+import { BZZ, DAI } from "./utils/tokens.js";
 import { asNumberString, assertData, assertFileData, makeTagUid, prepareAllTagsOptions, prepareBeeRequestOptions, prepareCollectionUploadOptions, prepareDownloadOptions, prepareFileUploadOptions, prepareGsocMessageHandler, preparePostageBatchOptions, preparePssMessageHandler, prepareRedundantUploadOptions, prepareTransactionOptions, prepareUploadOptions } from "./utils/type.js";
 import { BatchId, EthAddress, Identifier, PeerAddress, PrivateKey, PublicKey, Reference, Span, Topic, TransactionId } from "./utils/typed-bytes.js";
 import { assertBeeUrl, stripLastSlash } from "./utils/url.js";
@@ -867,6 +867,17 @@ export class Bee {
     }
     return true;
   }
+  /**
+   * Checks the `/gateway` endpoint to see if the remote API is a gateway.
+   *
+   * Do note that this is not a standard way to check for gateway nodes,
+   * but some of the gateway tooling expose this endpoint.
+   *
+   * @param options
+   */
+  async isGateway(options) {
+    return status.isGateway(this.getRequestOptionsForCall(options));
+  }
   // Legacy debug API
   async getNodeAddresses(options) {
     return connectivity.getNodeAddresses(this.getRequestOptionsForCall(options));
@@ -982,13 +993,24 @@ export class Bee {
     return chequebook.cashoutLastCheque(this.getRequestOptionsForCall(requestOptions), address, options);
   }
   /**
-   * 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, gasPrice, options) {
+    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, gasPrice, options) {
     const amountString = amount instanceof BZZ ? amount.toPLURString() : asNumberString(amount, {
       min: 1n,
       name: 'amount'
@@ -1003,13 +1025,24 @@ export class Bee {
     return chequebook.depositTokens(this.getRequestOptionsForCall(options), amountString, gasPriceString);
   }
   /**
-   * 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, gasPrice, options) {
+    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, gasPrice, options) {
     // TODO: check BZZ in tests
     const amountString = amount instanceof BZZ ? amount.toPLURString() : asNumberString(amount, {
       min: 1n,
@@ -1024,6 +1057,16 @@ export class Bee {
     }
     return chequebook.withdrawTokens(this.getRequestOptionsForCall(options), amountString, gasPriceString);
   }
+  async withdrawBZZToExternalWallet(amount, address, options) {
+    amount = amount instanceof BZZ ? amount : BZZ.fromPLUR(amount);
+    address = new EthAddress(address);
+    return states.withdrawBZZ(this.getRequestOptionsForCall(options), amount, address);
+  }
+  async withdrawDAIToExternalWallet(amount, address, options) {
+    amount = amount instanceof DAI ? amount : DAI.fromWei(amount);
+    address = new EthAddress(address);
+    return states.withdrawDAI(this.getRequestOptionsForCall(options), amount, address);
+  }
   /*
    * Settlements endpoint
    */
@@ -1107,7 +1150,7 @@ export class Bee {
     return states.getChainState(this.getRequestOptionsForCall(options));
   }
   /**
-   * Get wallet balances for xDai and BZZ of the Bee node
+   * Get wallet balances for DAI and BZZ of the Bee node
    *
    * @param options
    */
@@ -1335,7 +1378,7 @@ export class Bee {
     return transactions.rebroadcastTransaction(this.getRequestOptionsForCall(options), transactionHash);
   }
   /**
-   * Cancel currently pending transaction
+   * Cancels a currently pending transaction
    * @param transactionHash
    * @param gasPrice
    */
@@ -1351,20 +1394,48 @@ export class Bee {
     return transactions.cancelTransaction(this.getRequestOptionsForCall(options), transactionHash, gasPriceString);
   }
   /**
-   * 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) {
     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) {
+    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) {
+    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) {
+    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, options, requestOptions) {
     const amountString = amount instanceof BZZ ? amount.toPLURString() : asNumberString(amount, {
@@ -1377,9 +1448,9 @@ export class Bee {
     return stake.stake(this.getRequestOptionsForCall(requestOptions), amountString, options);
   }
   /**
-   * 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) {
     return stake.getRedistributionState(this.getRequestOptionsForCall(options));

package/dist/mjs/modules/debug/stake.js

@@ -7,7 +7,7 @@ import { TransactionId } from "../../utils/typed-bytes.js";
 const STAKE_ENDPOINT = 'stake';
 const REDISTRIBUTION_ENDPOINT = 'redistributionstate';
 /**
- * Gets the staked amount
+ * Gets the amount of staked BZZ
  *
  * @param requestOptions Options for making requests
  */
@@ -24,12 +24,55 @@ export async function getStake(requestOptions) {
     name: 'stakedAmount'
   }));
 }
+/**
+ * Gets the amount of withdrawable staked BZZ
+ *
+ * @param requestOptions Options for making requests
+ */
+export async function getWithdrawableStake(requestOptions) {
+  const response = await http(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) {
+  const response = await http(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) {
+  const response = await http(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, amount, options) {
   const repsonse = await http(requestOptions, {

package/dist/mjs/modules/debug/states.js

@@ -2,6 +2,7 @@ import { Types } from 'cafe-utility';
 import { http } from "../../utils/http.js";
 import { BZZ, DAI } from "../../utils/tokens.js";
 import { asNumberString } from "../../utils/type.js";
+import { TransactionId } from "../../utils/typed-bytes.js";
 import { normalizeCurrentPrice } from "../../utils/workaround.js";
 const RESERVE_STATE_ENDPOINT = 'reservestate';
 const WALLET_ENDPOINT = 'wallet';
@@ -92,4 +93,38 @@ export async function getWalletBalance(requestOptions) {
       name: 'walletAddress'
     })
   };
+}
+export async function withdrawBZZ(requestOptions, amount, address) {
+  const response = await http(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, amount, address) {
+  const response = await http(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'
+  }));
 }

package/dist/mjs/modules/status.js

@@ -1,3 +1,4 @@
+import { Types } from 'cafe-utility';
 import { http } from "../utils/http.js";
 /**
  * Ping the base bee URL. If connection was not successful throw error
@@ -8,4 +9,15 @@ export async function checkConnection(requestOptions) {
   await http(requestOptions, {
     url: ''
   });
+}
+export async function isGateway(requestOptions) {
+  try {
+    const response = await http(requestOptions, {
+      url: '/gateway'
+    });
+    const data = Types.asObject(response.data);
+    return Types.asBoolean(data.gateway);
+  } catch (error) {
+    return false;
+  }
 }

package/dist/types/bee.d.ts

@@ -7,7 +7,7 @@ import { AllTagsOptions, Collection, PostageBatchOptions, TransactionOptions, Up
 import { Bytes } from './utils/bytes';
 import { Duration } from './utils/duration';
 import { Size } from './utils/size';
-import { BZZ } from './utils/tokens';
+import { BZZ, DAI } from './utils/tokens';
 import { BatchId, EthAddress, FeedIndex, Identifier, PeerAddress, PrivateKey, PublicKey, Reference, Topic, TransactionId } from './utils/typed-bytes';
 import { UploadProgress } from './utils/upload-progress';
 /**
@@ -497,6 +497,15 @@ export declare class Bee {
      * @returns true if successful, false on error
      */
     isConnected(options?: BeeRequestOptions): Promise<boolean>;
+    /**
+     * Checks the `/gateway` endpoint to see if the remote API is a gateway.
+     *
+     * Do note that this is not a standard way to check for gateway nodes,
+     * but some of the gateway tooling expose this endpoint.
+     *
+     * @param options
+     */
+    isGateway(options?: BeeRequestOptions): Promise<boolean>;
     getNodeAddresses(options?: BeeRequestOptions): Promise<NodeAddresses>;
     getBlocklist(options?: BeeRequestOptions): Promise<Peer[]>;
     /**
@@ -563,21 +572,41 @@ export declare class Bee {
      */
     cashoutLastCheque(address: PeerAddress | string, options?: TransactionOptions, requestOptions?: BeeRequestOptions): Promise<TransactionId>;
     /**
-     * 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.
      */
     depositTokens(amount: BZZ | NumberString | string | bigint, gasPrice?: NumberString | string | bigint, options?: BeeRequestOptions): Promise<TransactionId>;
     /**
-     * Withdraw tokens from the chequebook to the overlay address
+     * 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
+     */
+    depositBZZToChequebook(amount: BZZ | NumberString | string | bigint, gasPrice?: NumberString | string | bigint, options?: BeeRequestOptions): Promise<TransactionId>;
+    /**
+     * 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.
      */
     withdrawTokens(amount: BZZ | NumberString | string | bigint, gasPrice?: NumberString | string | bigint, options?: BeeRequestOptions): Promise<TransactionId>;
+    /**
+     * 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
+     */
+    withdrawBZZFromChequebook(amount: BZZ | NumberString | string | bigint, gasPrice?: NumberString | string | bigint, options?: BeeRequestOptions): Promise<TransactionId>;
+    withdrawBZZToExternalWallet(amount: BZZ | NumberString | string | bigint, address: EthAddress | Uint8Array | string, options?: BeeRequestOptions): Promise<TransactionId>;
+    withdrawDAIToExternalWallet(amount: DAI | NumberString | string | bigint, address: EthAddress | Uint8Array | string, options?: BeeRequestOptions): Promise<TransactionId>;
     /**
      * Get amount of sent and received from settlements with a peer
      *
@@ -635,7 +664,7 @@ export declare class Bee {
      */
     getChainState(options?: BeeRequestOptions): Promise<ChainState>;
     /**
-     * Get wallet balances for xDai and BZZ of the Bee node
+     * Get wallet balances for DAI and BZZ of the Bee node
      *
      * @param options
      */
@@ -753,30 +782,52 @@ export declare class Bee {
      */
     rebroadcastPendingTransaction(transactionHash: TransactionId | Uint8Array | string, options?: BeeRequestOptions): Promise<TransactionId>;
     /**
-     * Cancel currently pending transaction
+     * Cancels a currently pending transaction
      * @param transactionHash
      * @param gasPrice
      */
     cancelPendingTransaction(transactionHash: TransactionId | Uint8Array | string, gasPrice?: NumberString | string | bigint, options?: BeeRequestOptions): Promise<TransactionId>;
     /**
-     * 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`
      */
     getStake(options?: BeeRequestOptions): Promise<BZZ>;
     /**
-     * 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`
+     */
+    getWithdrawableStake(options?: BeeRequestOptions): Promise<BZZ>;
+    /**
+     * 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`
+     */
+    withdrawSurplusStake(options?: BeeRequestOptions): Promise<TransactionId>;
+    /**
+     * 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`
+     */
+    migrateStake(options?: BeeRequestOptions): Promise<TransactionId>;
+    /**
+     * 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`
      */
     depositStake(amount: BZZ | NumberString | string | bigint, options?: TransactionOptions, requestOptions?: BeeRequestOptions): Promise<TransactionId>;
     /**
-     * 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`
      */
     getRedistributionState(options?: BeeRequestOptions): Promise<RedistributionState>;
     private waitForUsablePostageStamp;

package/dist/types/modules/debug/stake.d.ts

@@ -2,17 +2,24 @@ import { BeeRequestOptions, NumberString, RedistributionState, TransactionOption
 import { BZZ } from '../../utils/tokens';
 import { TransactionId } from '../../utils/typed-bytes';
 /**
- * Gets the staked amount
+ * Gets the amount of staked BZZ
  *
  * @param requestOptions Options for making requests
  */
 export declare function getStake(requestOptions: BeeRequestOptions): Promise<BZZ>;
+/**
+ * Gets the amount of withdrawable staked BZZ
+ *
+ * @param requestOptions Options for making requests
+ */
+export declare function getWithdrawableStake(requestOptions: BeeRequestOptions): Promise<BZZ>;
+export declare function withdrawSurplusStake(requestOptions: BeeRequestOptions): Promise<TransactionId>;
+export declare function migrateStake(requestOptions: BeeRequestOptions): Promise<TransactionId>;
 /**
  * Stake given amount of tokens.
  *
  * @param requestOptions Options for making requests
  * @param amount
- * @param options
  */
 export declare function stake(requestOptions: BeeRequestOptions, amount: NumberString | string | bigint, options?: TransactionOptions): Promise<TransactionId>;
 /**

package/dist/types/modules/debug/states.d.ts

@@ -1,4 +1,6 @@
 import { BeeRequestOptions, ChainState, ReserveState, WalletBalance } from '../../types';
+import { BZZ, DAI } from '../../utils/tokens';
+import { EthAddress, TransactionId } from '../../utils/typed-bytes';
 /**
  * Get state of reserve
  *
@@ -17,3 +19,5 @@ export declare function getChainState(requestOptions: BeeRequestOptions): Promis
  * @param requestOptions Options for making requests
  */
 export declare function getWalletBalance(requestOptions: BeeRequestOptions): Promise<WalletBalance>;
+export declare function withdrawBZZ(requestOptions: BeeRequestOptions, amount: BZZ, address: EthAddress): Promise<TransactionId>;
+export declare function withdrawDAI(requestOptions: BeeRequestOptions, amount: DAI, address: EthAddress): Promise<TransactionId>;

package/dist/types/modules/status.d.ts

@@ -5,3 +5,4 @@ import { BeeRequestOptions } from '../index';
  * @param requestOptions Options for making requests
  */
 export declare function checkConnection(requestOptions: BeeRequestOptions): Promise<void> | never;
+export declare function isGateway(requestOptions: BeeRequestOptions): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "9.4.1",
+  "version": "9.6.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",