@upcoming/bee-js 9.4.1 → 9.7.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";
@@ -695,7 +695,8 @@ export class Bee {
     for (let i = 0n; i < 0xffffn; i++) {
       const signer = new PrivateKey(Binary.numberToUint256(start + i, 'BE'));
       const socAddress = makeSOCAddress(identifier, signer.publicKey().address());
-      const actualProximity = 256 - Binary.proximity(socAddress.toUint8Array(), targetOverlay.toUint8Array(), 256);
+      // TODO: test the significance of the hardcoded 256
+      const actualProximity = 256 - Binary.proximity(socAddress.toUint8Array(), targetOverlay.toUint8Array());
       if (actualProximity <= 256 - proximity) {
         return signer;
       }
@@ -867,6 +868,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 +994,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 +1026,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 +1058,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 +1151,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
    */
@@ -1153,24 +1197,24 @@ export class Bee {
     }
     return stamp;
   }
-  async buyStorage(size, duration, options, requestOptions) {
+  async buyStorage(size, duration, options, requestOptions, encryption, erasureCodeLevel) {
     const chainState = await this.getChainState(requestOptions);
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
-    const depth = getDepthForSize(size);
+    const depth = getDepthForSize(size, encryption, erasureCodeLevel);
     if (options) {
       options = preparePostageBatchOptions(options);
     }
     return this.createPostageBatch(amount, depth, options, requestOptions);
   }
-  async getStorageCost(size, duration, options) {
+  async getStorageCost(size, duration, options, encryption, erasureCodeLevel) {
     const chainState = await this.getChainState(options);
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
-    const depth = getDepthForSize(size);
+    const depth = getDepthForSize(size, encryption, erasureCodeLevel);
     return getStampCost(depth, amount);
   }
-  async extendStorageSize(postageBatchId, size, options) {
+  async extendStorageSize(postageBatchId, size, options, encryption, erasureCodeLevel) {
     const batch = await this.getPostageBatch(postageBatchId, options);
-    const depth = getDepthForSize(size);
+    const depth = getDepthForSize(size, encryption, erasureCodeLevel);
     const delta = depth - batch.depth;
     if (delta <= 0) {
       throw new BeeArgumentError('New depth has to be greater than the original depth', depth);
@@ -1184,18 +1228,18 @@ export class Bee {
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
     return this.topUpBatch(batch.batchID, amount, options);
   }
-  async getExtensionCost(postageBatchId, size, duration, options) {
+  async getExtensionCost(postageBatchId, size, duration, options, encryption, erasureCodeLevel) {
     const batch = await this.getPostageBatch(postageBatchId, options);
     const chainState = await this.getChainState(options);
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
-    const depth = getDepthForSize(size);
+    const depth = getDepthForSize(size, encryption, erasureCodeLevel);
     const currentValue = getStampCost(batch.depth, batch.amount);
     const newValue = getStampCost(depth, amount);
     return newValue.minus(currentValue);
   }
-  async getSizeExtensionCost(postageBatchId, size, options) {
+  async getSizeExtensionCost(postageBatchId, size, options, encryption, erasureCodeLevel) {
     const batch = await this.getPostageBatch(postageBatchId, options);
-    const depth = getDepthForSize(size);
+    const depth = getDepthForSize(size, encryption, erasureCodeLevel);
     const delta = depth - batch.depth;
     if (delta <= 0) {
       throw new BeeArgumentError('New depth has to be greater than the original depth', depth);
@@ -1335,7 +1379,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 +1395,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 +1449,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/manifest/manifest.js

@@ -68,12 +68,12 @@ export class Fork {
     }
     return Binary.concatBytes(...data);
   }
-  static unmarshal(reader) {
+  static unmarshal(reader, addressLength) {
     const type = Binary.uint8ToNumber(reader.read(1));
     const prefixLength = Binary.uint8ToNumber(reader.read(1));
     const prefix = reader.read(prefixLength);
     reader.read(30 - prefixLength);
-    const selfAddress = reader.read(32);
+    const selfAddress = reader.read(addressLength);
     let metadata = undefined;
     if (isType(type, TYPE_WITH_METADATA)) {
       const metadataLength = Binary.uint16ToNumber(reader.read(2), 'BE');
@@ -219,7 +219,7 @@ export class MantarayNode {
     const forkBitmap = reader.read(32);
     for (let i = 0; i < 256; i++) {
       if (Binary.getBit(forkBitmap, i, 'LE')) {
-        const newFork = Fork.unmarshal(reader);
+        const newFork = Fork.unmarshal(reader, targetAddressLength);
         node.forks.set(i, newFork);
         newFork.node.parent = node;
       }

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/debug/status.js

@@ -2,9 +2,9 @@ import { Types } from 'cafe-utility';
 import getMajorSemver from 'semver/functions/major.js';
 import { toBeeMode } from "../../types/debug.js";
 import { http } from "../../utils/http.js";
-export const SUPPORTED_BEE_VERSION_EXACT = '2.4.0-390a402e';
+export const SUPPORTED_BEE_VERSION_EXACT = '2.6.0-d0aa8b93';
 export const SUPPORTED_BEE_VERSION = SUPPORTED_BEE_VERSION_EXACT.split('-')[0];
-export const SUPPORTED_API_VERSION = '7.2.0';
+export const SUPPORTED_API_VERSION = '7.3.0';
 const NODE_INFO_URL = 'node';
 const STATUS_URL = 'status';
 const HEALTH_URL = 'health';
@@ -57,6 +57,9 @@ export async function getDebugStatus(requestOptions) {
     }),
     committedDepth: Types.asNumber(body.committedDepth, {
       name: 'committedDepth'
+    }),
+    isWarmingUp: Types.asBoolean(body.isWarmingUp, {
+      name: 'isWarmingUp'
     })
   };
 }

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;
+  }
 }