@upcoming/bee-js 0.15.1 → 0.16.0

package/dist/cjs/bee.js

@@ -1159,24 +1159,24 @@ class Bee {
         }
         return stamp;
     }
-    async buyStorage(gigabytes, duration, options, requestOptions) {
+    async buyStorage(size, duration, options, requestOptions) {
         const chainState = await this.getChainState(requestOptions);
         const amount = (0, stamps_1.getAmountForDuration)(duration, chainState.currentPrice);
-        const depth = (0, stamps_1.getDepthForSize)(gigabytes);
+        const depth = (0, stamps_1.getDepthForSize)(size);
         if (options) {
             options = (0, type_1.preparePostageBatchOptions)(options);
         }
         return this.createPostageBatch(amount, depth, options, requestOptions);
     }
-    async getStorageCost(gigabytes, duration, options) {
+    async getStorageCost(size, duration, options) {
         const chainState = await this.getChainState(options);
         const amount = (0, stamps_1.getAmountForDuration)(duration, chainState.currentPrice);
-        const depth = (0, stamps_1.getDepthForSize)(gigabytes);
+        const depth = (0, stamps_1.getDepthForSize)(size);
         return (0, stamps_1.getStampCost)(depth, amount);
     }
-    async extendStorageSize(postageBatchId, gigabytes, options) {
+    async extendStorageSize(postageBatchId, size, options) {
         const batch = await this.getPostageBatch(postageBatchId, options);
-        const depth = (0, stamps_1.getDepthForSize)(gigabytes);
+        const depth = (0, stamps_1.getDepthForSize)(size);
         const delta = depth - batch.depth;
         if (delta <= 0) {
             throw new error_1.BeeArgumentError('New depth has to be greater than the original depth', depth);
@@ -1190,18 +1190,18 @@ class Bee {
         const amount = (0, stamps_1.getAmountForDuration)(duration, chainState.currentPrice);
         return this.topUpBatch(batch.batchID, amount, options);
     }
-    async getExtensionCost(postageBatchId, gigabytes, duration, options) {
+    async getExtensionCost(postageBatchId, size, duration, options) {
         const batch = await this.getPostageBatch(postageBatchId, options);
         const chainState = await this.getChainState(options);
         const amount = (0, stamps_1.getAmountForDuration)(duration, chainState.currentPrice);
-        const depth = (0, stamps_1.getDepthForSize)(gigabytes);
+        const depth = (0, stamps_1.getDepthForSize)(size);
         const currentValue = (0, stamps_1.getStampCost)(batch.depth, batch.amount);
         const newValue = (0, stamps_1.getStampCost)(depth, amount);
         return newValue.minus(currentValue);
     }
-    async getSizeExtensionCost(postageBatchId, gigabytes, options) {
+    async getSizeExtensionCost(postageBatchId, size, options) {
         const batch = await this.getPostageBatch(postageBatchId, options);
-        const depth = (0, stamps_1.getDepthForSize)(gigabytes);
+        const depth = (0, stamps_1.getDepthForSize)(size);
         const delta = depth - batch.depth;
         if (delta <= 0) {
             throw new error_1.BeeArgumentError('New depth has to be greater than the original depth', depth);

package/dist/cjs/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Stamper = exports.BeeDev = exports.Bee = exports.Utils = exports.Duration = exports.Bytes = exports.SUPPORTED_BEE_VERSION_EXACT = exports.SUPPORTED_BEE_VERSION = exports.MantarayNode = exports.MerkleTree = void 0;
+exports.Stamper = exports.BeeDev = exports.Bee = exports.Size = exports.Utils = exports.Duration = exports.Bytes = exports.SUPPORTED_BEE_VERSION_EXACT = exports.SUPPORTED_BEE_VERSION = exports.MantarayNode = exports.MerkleTree = void 0;
 const bee_1 = require("./bee");
 Object.defineProperty(exports, "Bee", { enumerable: true, get: function () { return bee_1.Bee; } });
 const bee_dev_1 = require("./bee-dev");
@@ -48,5 +48,7 @@ var duration_1 = require("./utils/duration");
 Object.defineProperty(exports, "Duration", { enumerable: true, get: function () { return duration_1.Duration; } });
 __exportStar(require("./utils/error"), exports);
 exports.Utils = __importStar(require("./utils/expose"));
+var size_1 = require("./utils/size");
+Object.defineProperty(exports, "Size", { enumerable: true, get: function () { return size_1.Size; } });
 __exportStar(require("./utils/tokens"), exports);
 __exportStar(require("./utils/typed-bytes"), exports);

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

@@ -4,6 +4,7 @@ exports.diluteBatch = exports.topUpBatch = exports.createPostageBatch = exports.
 const cafe_utility_1 = require("cafe-utility");
 const duration_1 = require("../../utils/duration");
 const http_1 = require("../../utils/http");
+const size_1 = require("../../utils/size");
 const stamps_1 = require("../../utils/stamps");
 const type_1 = require("../../utils/type");
 const typed_bytes_1 = require("../../utils/typed-bytes");
@@ -56,9 +57,10 @@ async function getAllPostageBatches(requestOptions) {
             blockNumber: cafe_utility_1.Types.asNumber(x.blockNumber, { name: 'blockNumber' }),
             immutableFlag: cafe_utility_1.Types.asBoolean(x.immutableFlag, { name: 'immutableFlag' }),
             usage,
-            size: (0, stamps_1.getStampEffectiveBytes)(depth),
-            remainingSize: Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage)),
-            theoreticalSize: (0, stamps_1.getStampTheoreticalBytes)(depth),
+            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))),
+            theoreticalSize: size_1.Size.fromBytes((0, stamps_1.getStampTheoreticalBytes)(depth)),
             duration,
         };
     });
@@ -88,9 +90,10 @@ async function getPostageBatch(requestOptions, postageBatchId) {
         blockNumber: cafe_utility_1.Types.asNumber(body.blockNumber, { name: 'blockNumber' }),
         immutableFlag: cafe_utility_1.Types.asBoolean(body.immutableFlag, { name: 'immutableFlag' }),
         usage,
-        size: (0, stamps_1.getStampEffectiveBytes)(depth),
-        remainingSize: Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage)),
-        theoreticalSize: (0, stamps_1.getStampTheoreticalBytes)(depth),
+        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))),
+        theoreticalSize: size_1.Size.fromBytes((0, stamps_1.getStampTheoreticalBytes)(depth)),
         duration,
     };
 }

package/dist/cjs/utils/size.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Size = void 0;
+const cafe_utility_1 = require("cafe-utility");
+/**
+ * Represents a size in bytes.
+ *
+ * Uses 1000 instead of 1024 for converting between units.
+ * This is to stay consistent with the Swarm papers
+ * on theoretical and effective storage capacity.
+ */
+class Size {
+    constructor(bytes) {
+        this.bytes = Math.ceil(bytes);
+        if (bytes < 0) {
+            throw Error('Size must be at least 0');
+        }
+    }
+    static fromBytes(bytes) {
+        return new Size(bytes);
+    }
+    static fromGigabytes(gigabytes) {
+        return new Size(gigabytes * 1000 * 1000 * 1000);
+    }
+    toBytes() {
+        return this.bytes;
+    }
+    toGigabytes() {
+        return this.bytes / 1000 / 1000 / 1000;
+    }
+    toFormattedString() {
+        return cafe_utility_1.Numbers.convertBytes(this.bytes, 1000);
+    }
+}
+exports.Size = Size;

package/dist/cjs/utils/stamps.js

@@ -115,14 +115,14 @@ function getAmountForDuration(duration, pricePerBlock, blockTime = 5) {
 }
 exports.getAmountForDuration = getAmountForDuration;
 /**
- * Utility function that calculates the depth required for a postage batch to achieve the specified effective size in gigabytes.
+ * Utility function that calculates the depth required for a postage batch to achieve the specified effective size
  *
- * @param gigabytes
+ * @param size The effective size of the postage batch
  * @returns
  */
-function getDepthForSize(gigabytes) {
-    for (const [depth, size] of effectiveSizeBreakpoints) {
-        if (gigabytes <= size) {
+function getDepthForSize(size) {
+    for (const [depth, sizeBreakpoint] of effectiveSizeBreakpoints) {
+        if (size.toGigabytes() <= sizeBreakpoint) {
             return depth;
         }
     }