@upcoming/bee-js 11.1.0 → 12.0.0

package/dist/mjs/bee.js

@@ -34,7 +34,7 @@ import { prepareWebsocketData } from "./utils/data.js";
 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 { getAmountForDuration, getDepthForSize, getStampCost, getStampDuration } from "./utils/stamps.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, Signature, Span, Topic, TransactionId } from "./utils/typed-bytes.js";
@@ -1730,6 +1730,25 @@ export class Bee {
     const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15);
     return getStampCost(batch.depth, amount);
   }
+  /**
+   * Calculates the `amount` and expected duration extension for topping up a postage batch with a given BZZ value.
+   *
+   * @param postageBatchId
+   * @param bzz The amount of BZZ to spend on the top-up.
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   * @returns An object with `amount` (to pass to {@link topUpBatch}) and `duration` (the expected TTL extension).
+   */
+  async calculateTopUpForBzz(postageBatchId, bzz, requestOptions) {
+    const batch = await this.getPostageBatch(postageBatchId, requestOptions);
+    const chainState = await this.getChainState(requestOptions);
+    const blockTime = this.network === 'gnosis' ? 5 : 15;
+    const amount = bzz.toPLURBigInt() / 2n ** BigInt(batch.depth);
+    const duration = getStampDuration(amount, chainState.currentPrice, blockTime);
+    return {
+      amount,
+      duration
+    };
+  }
   /**
    * Increases the duration of a postage batch by increasing its amount.
    *

package/dist/types/bee.d.ts

@@ -1154,6 +1154,18 @@ export declare class Bee {
      * @returns
      */
     getDurationExtensionCost(postageBatchId: BatchId | Uint8Array | string, duration: Duration, requestOptions?: BeeRequestOptions): Promise<BZZ>;
+    /**
+     * Calculates the `amount` and expected duration extension for topping up a postage batch with a given BZZ value.
+     *
+     * @param postageBatchId
+     * @param bzz The amount of BZZ to spend on the top-up.
+     * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+     * @returns An object with `amount` (to pass to {@link topUpBatch}) and `duration` (the expected TTL extension).
+     */
+    calculateTopUpForBzz(postageBatchId: BatchId | Uint8Array | string, bzz: BZZ, requestOptions?: BeeRequestOptions): Promise<{
+        amount: bigint;
+        duration: Duration;
+    }>;
     /**
      * Increases the duration of a postage batch by increasing its amount.
      *

package/dist/types/utils/tar-uploader.browser.d.ts

@@ -1,3 +1,3 @@
 import { BeeRequestOptions, Collection, CollectionUploadOptions } from '..';
 import { BatchId } from './typed-bytes';
-export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<import("axios").AxiosResponse<unknown, any>>;
+export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<import("axios").AxiosResponse<unknown, any, {}>>;

package/dist/types/utils/tar-uploader.d.ts

@@ -1,3 +1,3 @@
 import { BeeRequestOptions, Collection, CollectionUploadOptions } from '..';
 import { BatchId } from './typed-bytes';
-export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<import("axios").AxiosResponse<unknown, any>>;
+export declare function uploadTar(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions): Promise<import("axios").AxiosResponse<unknown, any, {}>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upcoming/bee-js",
-  "version": "11.1.0",
+  "version": "12.0.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -61,7 +61,7 @@
     "depcheck": "depcheck ."
   },
   "dependencies": {
-    "axios": "^0.30.2",
+    "axios": "^1.15.1",
     "cafe-utility": "^33.6.1",
     "debug": "^4.4.1",
     "isomorphic-ws": "^4.0.1",