@ethersphere/bee-js 10.0.1 → 10.1.1

package/dist/cjs/bee.js

@@ -1743,13 +1743,15 @@ class Bee {
      *
      * @param postageBatchId Batch ID
      * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+     * @param encryption Assume that uploads with this postage batch are encrypted, which skews the capacity.
+     * @param erasureCodeLevel Assume that uploads with this postage batch are erasure coded, which skews the capacity.
      *
      * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
      * @see [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get)
      */
-    async getPostageBatch(postageBatchId, requestOptions) {
+    async getPostageBatch(postageBatchId, requestOptions, encryption, erasureCodeLevel) {
         postageBatchId = new typed_bytes_1.BatchId(postageBatchId);
-        return stamps.getPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId);
+        return stamps.getPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId, encryption, erasureCodeLevel);
     }
     /**
      * Return detailed information related to buckets for specific postage batch.

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

@@ -46,6 +46,7 @@ async function getAllPostageBatches(requestOptions) {
         const usage = (0, stamps_1.getStampUsage)(utilization, depth, bucketDepth);
         const batchTTL = (0, workaround_1.normalizeBatchTTL)(cafe_utility_1.Types.asNumber(x.batchTTL, { name: 'batchTTL' }));
         const duration = duration_1.Duration.fromSeconds(batchTTL);
+        const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth);
         return {
             batchID: new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(x.batchID, { name: 'batchID' })),
             utilization,
@@ -58,15 +59,23 @@ async function getAllPostageBatches(requestOptions) {
             immutableFlag: cafe_utility_1.Types.asBoolean(x.immutableFlag, { name: 'immutableFlag' }),
             usage,
             usageText: `${Math.round(usage * 100)}%`,
-            size: size_1.Size.fromBytes((0, stamps_1.getStampEffectiveBytes)(depth)),
-            remainingSize: size_1.Size.fromBytes(Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage))),
+            size: size_1.Size.fromBytes(effectiveBytes),
+            remainingSize: size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
             theoreticalSize: size_1.Size.fromBytes((0, stamps_1.getStampTheoreticalBytes)(depth)),
             duration,
+            calculateSize(encryption, redundancyLevel) {
+                const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(this.depth, encryption, redundancyLevel);
+                return size_1.Size.fromBytes(effectiveBytes);
+            },
+            calculateRemainingSize(encryption, redundancyLevel) {
+                const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(this.depth, encryption, redundancyLevel);
+                return size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)));
+            },
         };
     });
 }
 exports.getAllPostageBatches = getAllPostageBatches;
-async function getPostageBatch(requestOptions, postageBatchId) {
+async function getPostageBatch(requestOptions, postageBatchId, encryption, erasureCodeLevel) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'get',
         url: `${STAMPS_ENDPOINT}/${postageBatchId}`,
@@ -79,6 +88,7 @@ async function getPostageBatch(requestOptions, postageBatchId) {
     const usage = (0, stamps_1.getStampUsage)(utilization, depth, bucketDepth);
     const batchTTL = (0, workaround_1.normalizeBatchTTL)(cafe_utility_1.Types.asNumber(body.batchTTL, { name: 'batchTTL' }));
     const duration = duration_1.Duration.fromSeconds(batchTTL);
+    const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth, encryption, erasureCodeLevel);
     return {
         batchID: new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(body.batchID, { name: 'batchID' })),
         utilization,
@@ -91,10 +101,18 @@ async function getPostageBatch(requestOptions, postageBatchId) {
         immutableFlag: cafe_utility_1.Types.asBoolean(body.immutableFlag, { name: 'immutableFlag' }),
         usage,
         usageText: `${Math.round(usage * 100)}%`,
-        size: size_1.Size.fromBytes((0, stamps_1.getStampEffectiveBytes)(depth)),
-        remainingSize: size_1.Size.fromBytes(Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage))),
+        size: size_1.Size.fromBytes(effectiveBytes),
+        remainingSize: size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
         theoreticalSize: size_1.Size.fromBytes((0, stamps_1.getStampTheoreticalBytes)(depth)),
         duration,
+        calculateSize(encryption, redundancyLevel) {
+            const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth, encryption, redundancyLevel);
+            return size_1.Size.fromBytes(effectiveBytes);
+        },
+        calculateRemainingSize(encryption, redundancyLevel) {
+            const effectiveBytes = (0, stamps_1.getStampEffectiveBytes)(depth, encryption, redundancyLevel);
+            return size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage)));
+        },
     };
 }
 exports.getPostageBatch = getPostageBatch;

package/dist/cjs/utils/duration.js

@@ -30,6 +30,32 @@ class Duration {
     static fromEndDate(endDate, startDate) {
         return new Duration((endDate.getTime() - (startDate ?? new Date()).getTime()) / 1000);
     }
+    /**
+     * Parses a duration string and returns a `Duration` instance.
+     *
+     * Case insensitive. E.g. both `"28h"` and `"1D"` are valid.
+     *
+     * Whitespaces are ignored. E.g. both `"5 d"` and `"2weeks"` are valid.
+     *
+     * Decimal numbers are supported. E.g. `"1.5h"` is valid.
+     *
+     * Supported units:
+     *
+     * - ms, milli, millis, millisecond, milliseconds
+     * - s, sec, second, seconds
+     * - m, min, minute, minutes
+     * - h, hour, hours
+     * - d, day, days
+     * - w, week, weeks
+     * - month, months
+     * - y, year, years
+     *
+     * @param duration - A string representing a duration
+     * @returns a `Duration` instance
+     */
+    static parseFromString(duration) {
+        return Duration.fromSeconds(cafe_utility_1.Dates.make(duration) / 1000);
+    }
     toSeconds() {
         return this.seconds;
     }

package/dist/cjs/utils/size.js

@@ -28,6 +28,31 @@ class Size {
     static fromGigabytes(gigabytes) {
         return new Size(gigabytes * 1000 * 1000 * 1000);
     }
+    /**
+     * Parses a size string and returns a `Size` instance.
+     *
+     * Case insensitive. E.g. both `"28MB"` and `"1gb"` are valid.
+     *
+     * Whitespaces are ignored. E.g. both `"512 kb"` and `"2megabytes"` are valid.
+     *
+     * Decimal numbers are supported. E.g. `"1.5gb"` is valid.
+     *
+     * Uses 1000 as the base for conversions. E.g. 1kb = 1000 bytes.
+     * This is consistent with the effective stamp utilization table.
+     *
+     * Supported units:
+     * - b, byte, bytes
+     * - kb, kilobyte, kilobytes
+     * - mb, megabyte, megabytes
+     * - gb, gigabyte, gigabytes
+     * - tb, terabyte, terabytes
+     *
+     * @param size - A string representing a size
+     * @returns a `Size` instance
+     */
+    static parseFromString(size) {
+        return Size.fromBytes(cafe_utility_1.Numbers.makeStorage(size, 1000));
+    }
     toBytes() {
         return this.bytes;
     }