@ethersphere/bee-js 9.4.1 → 9.6.0

package/dist/cjs/bee.js

@@ -896,6 +896,17 @@ 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));
@@ -1011,13 +1022,24 @@ 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 tokens_1.BZZ ? amount.toPLURString() : (0, type_1.asNumberString)(amount, { min: 1n, name: 'amount' });
         let gasPriceString;
         if (gasPrice) {
@@ -1026,13 +1048,24 @@ 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 tokens_1.BZZ ? amount.toPLURString() : (0, type_1.asNumberString)(amount, { min: 1n, name: 'amount' });
         let gasPriceString;
@@ -1041,6 +1074,16 @@ class Bee {
         }
         return chequebook.withdrawTokens(this.getRequestOptionsForCall(options), amountString, gasPriceString);
     }
+    async withdrawBZZToExternalWallet(amount, address, options) {
+        amount = amount instanceof tokens_1.BZZ ? amount : tokens_1.BZZ.fromPLUR(amount);
+        address = new typed_bytes_1.EthAddress(address);
+        return states.withdrawBZZ(this.getRequestOptionsForCall(options), amount, address);
+    }
+    async withdrawDAIToExternalWallet(amount, address, options) {
+        amount = amount instanceof tokens_1.DAI ? amount : tokens_1.DAI.fromWei(amount);
+        address = new typed_bytes_1.EthAddress(address);
+        return states.withdrawDAI(this.getRequestOptionsForCall(options), amount, address);
+    }
     /*
      * Settlements endpoint
      */
@@ -1124,7 +1167,7 @@ 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
      */
@@ -1342,7 +1385,7 @@ class Bee {
         return transactions.rebroadcastTransaction(this.getRequestOptionsForCall(options), transactionHash);
     }
     /**
-     * Cancel currently pending transaction
+     * Cancels a currently pending transaction
      * @param transactionHash
      * @param gasPrice
      */
@@ -1355,20 +1398,48 @@ 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 tokens_1.BZZ ? amount.toPLURString() : (0, type_1.asNumberString)(amount, { min: 1n, name: 'amount' });
@@ -1378,9 +1449,9 @@ 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/cjs/modules/debug/stake.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRedistributionState = exports.stake = exports.getStake = void 0;
+exports.getRedistributionState = exports.stake = exports.migrateStake = exports.withdrawSurplusStake = exports.getWithdrawableStake = exports.getStake = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const headers_1 = require("../../utils/headers");
 const http_1 = require("../../utils/http");
@@ -10,7 +10,7 @@ const typed_bytes_1 = require("../../utils/typed-bytes");
 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,46 @@ async function getStake(requestOptions) {
     return tokens_1.BZZ.fromPLUR((0, type_1.asNumberString)(body.stakedAmount, { name: 'stakedAmount' }));
 }
 exports.getStake = getStake;
+/**
+ * Gets the amount of withdrawable staked BZZ
+ *
+ * @param requestOptions Options for making requests
+ */
+async function getWithdrawableStake(requestOptions) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'get',
+        responseType: 'json',
+        url: `${STAKE_ENDPOINT}/withdrawable`,
+    });
+    const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+    return tokens_1.BZZ.fromPLUR((0, type_1.asNumberString)(body.withdrawableAmount, { name: 'withdrawableAmount' }));
+}
+exports.getWithdrawableStake = getWithdrawableStake;
+async function withdrawSurplusStake(requestOptions) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'delete',
+        responseType: 'json',
+        url: `${STAKE_ENDPOINT}/withdrawable`,
+    });
+    const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+    return new typed_bytes_1.TransactionId(cafe_utility_1.Types.asHexString(body.txHash, { name: 'txHash' }));
+}
+exports.withdrawSurplusStake = withdrawSurplusStake;
+async function migrateStake(requestOptions) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'delete',
+        responseType: 'json',
+        url: STAKE_ENDPOINT,
+    });
+    const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+    return new typed_bytes_1.TransactionId(cafe_utility_1.Types.asHexString(body.txHash, { name: 'txHash' }));
+}
+exports.migrateStake = migrateStake;
 /**
  * Stake given amount of tokens.
  *
  * @param requestOptions Options for making requests
  * @param amount
- * @param options
  */
 async function stake(requestOptions, amount, options) {
     const repsonse = await (0, http_1.http)(requestOptions, {

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

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWalletBalance = exports.getChainState = exports.getReserveState = void 0;
+exports.withdrawDAI = exports.withdrawBZZ = exports.getWalletBalance = exports.getChainState = exports.getReserveState = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const http_1 = require("../../utils/http");
 const tokens_1 = require("../../utils/tokens");
 const type_1 = require("../../utils/type");
+const typed_bytes_1 = require("../../utils/typed-bytes");
 const workaround_1 = require("../../utils/workaround");
 const RESERVE_STATE_ENDPOINT = 'reservestate';
 const WALLET_ENDPOINT = 'wallet';
@@ -69,3 +70,25 @@ async function getWalletBalance(requestOptions) {
     };
 }
 exports.getWalletBalance = getWalletBalance;
+async function withdrawBZZ(requestOptions, amount, address) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'post',
+        url: `${WALLET_ENDPOINT}/withdraw/bzz`,
+        responseType: 'json',
+        params: { amount: amount.toPLURString(), address: address.toHex() },
+    });
+    const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+    return new typed_bytes_1.TransactionId(cafe_utility_1.Types.asString(body.transactionHash, { name: 'transactionHash' }));
+}
+exports.withdrawBZZ = withdrawBZZ;
+async function withdrawDAI(requestOptions, amount, address) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'post',
+        url: `${WALLET_ENDPOINT}/withdraw/nativetoken`,
+        responseType: 'json',
+        params: { amount: amount.toWeiString(), address: address.toHex() },
+    });
+    const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+    return new typed_bytes_1.TransactionId(cafe_utility_1.Types.asString(body.transactionHash, { name: 'transactionHash' }));
+}
+exports.withdrawDAI = withdrawDAI;

package/dist/cjs/modules/status.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkConnection = void 0;
+exports.isGateway = exports.checkConnection = void 0;
+const cafe_utility_1 = require("cafe-utility");
 const http_1 = require("../utils/http");
 /**
  * Ping the base bee URL. If connection was not successful throw error
@@ -13,3 +14,16 @@ async function checkConnection(requestOptions) {
     });
 }
 exports.checkConnection = checkConnection;
+async function isGateway(requestOptions) {
+    try {
+        const response = await (0, http_1.http)(requestOptions, {
+            url: '/gateway',
+        });
+        const data = cafe_utility_1.Types.asObject(response.data);
+        return cafe_utility_1.Types.asBoolean(data.gateway);
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.isGateway = isGateway;