@ethersphere/bee-js 10.3.0 → 10.4.0

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

@@ -2,13 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.diluteBatch = exports.topUpBatch = exports.createPostageBatch = exports.getPostageBatchBuckets = exports.getPostageBatch = exports.getAllPostageBatches = exports.getGlobalPostageBatches = void 0;
 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");
-const workaround_1 = require("../../utils/workaround");
 const STAMPS_ENDPOINT = 'stamps';
 const BATCHES_ENDPOINT = 'batches';
 async function getGlobalPostageBatches(requestOptions) {
@@ -39,40 +36,7 @@ async function getAllPostageBatches(requestOptions) {
     });
     const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
     const stamps = cafe_utility_1.Types.asArray(body.stamps, { name: 'stamps' }).map(x => cafe_utility_1.Types.asObject(x, { name: 'stamp' }));
-    return stamps.map(x => {
-        const utilization = cafe_utility_1.Types.asNumber(x.utilization, { name: 'utilization' });
-        const depth = cafe_utility_1.Types.asNumber(x.depth, { name: 'depth' });
-        const bucketDepth = cafe_utility_1.Types.asNumber(x.bucketDepth, { name: 'bucketDepth' });
-        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,
-            usable: cafe_utility_1.Types.asBoolean(x.usable, { name: 'usable' }),
-            label: cafe_utility_1.Types.asEmptiableString(x.label, { name: 'label' }),
-            depth,
-            amount: (0, type_1.asNumberString)(x.amount, { name: 'amount' }),
-            bucketDepth,
-            blockNumber: cafe_utility_1.Types.asNumber(x.blockNumber, { name: 'blockNumber' }),
-            immutableFlag: cafe_utility_1.Types.asBoolean(x.immutableFlag, { name: 'immutableFlag' }),
-            usage,
-            usageText: `${Math.round(usage * 100)}%`,
-            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)));
-            },
-        };
-    });
+    return stamps.map(x => (0, stamps_1.mapPostageBatch)(validateRawPostageBatch(x)));
 }
 exports.getAllPostageBatches = getAllPostageBatches;
 async function getPostageBatch(requestOptions, postageBatchId, encryption, erasureCodeLevel) {
@@ -82,38 +46,7 @@ async function getPostageBatch(requestOptions, postageBatchId, encryption, erasu
         responseType: 'json',
     });
     const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
-    const utilization = cafe_utility_1.Types.asNumber(body.utilization, { name: 'utilization' });
-    const depth = cafe_utility_1.Types.asNumber(body.depth, { name: 'depth' });
-    const bucketDepth = cafe_utility_1.Types.asNumber(body.bucketDepth, { name: 'bucketDepth' });
-    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,
-        usable: cafe_utility_1.Types.asBoolean(body.usable, { name: 'usable' }),
-        label: cafe_utility_1.Types.asEmptiableString(body.label, { name: 'label' }),
-        depth,
-        amount: (0, type_1.asNumberString)(body.amount, { name: 'amount' }),
-        bucketDepth,
-        blockNumber: cafe_utility_1.Types.asNumber(body.blockNumber, { name: 'blockNumber' }),
-        immutableFlag: cafe_utility_1.Types.asBoolean(body.immutableFlag, { name: 'immutableFlag' }),
-        usage,
-        usageText: `${Math.round(usage * 100)}%`,
-        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)));
-        },
-    };
+    return (0, stamps_1.mapPostageBatch)(validateRawPostageBatch(body), encryption, erasureCodeLevel);
 }
 exports.getPostageBatch = getPostageBatch;
 async function getPostageBatchBuckets(requestOptions, postageBatchId) {
@@ -175,3 +108,17 @@ async function diluteBatch(requestOptions, id, depth) {
     return new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(body.batchID, { name: 'batchID' }));
 }
 exports.diluteBatch = diluteBatch;
+function validateRawPostageBatch(raw) {
+    return {
+        amount: (0, type_1.asNumberString)(raw.amount, { name: 'amount' }),
+        batchID: cafe_utility_1.Types.asString(raw.batchID, { name: 'batchID' }),
+        batchTTL: cafe_utility_1.Types.asNumber(raw.batchTTL, { name: 'batchTTL' }),
+        bucketDepth: cafe_utility_1.Types.asNumber(raw.bucketDepth, { name: 'bucketDepth' }),
+        blockNumber: cafe_utility_1.Types.asNumber(raw.blockNumber, { name: 'blockNumber' }),
+        depth: cafe_utility_1.Types.asNumber(raw.depth, { name: 'depth' }),
+        immutableFlag: cafe_utility_1.Types.asBoolean(raw.immutableFlag, { name: 'immutableFlag' }),
+        label: cafe_utility_1.Types.asEmptiableString(raw.label, { name: 'label' }),
+        usable: cafe_utility_1.Types.asBoolean(raw.usable, { name: 'usable' }),
+        utilization: cafe_utility_1.Types.asNumber(raw.utilization, { name: 'utilization' }),
+    };
+}

package/dist/cjs/utils/expose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStampUsage = exports.getStampTheoreticalBytes = exports.getStampEffectiveBytesBreakpoints = exports.getStampEffectiveBytes = exports.getStampDuration = exports.getStampCost = exports.getDepthForSize = exports.getAmountForDuration = exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.makeMaxTarget = exports.getFolderSize = exports.makeCollectionFromFileList = exports.getCollectionSize = void 0;
+exports.unmapPostageBatch = exports.mapPostageBatch = exports.getStampUsage = exports.getStampTheoreticalBytes = exports.getStampEffectiveBytesBreakpoints = exports.getStampEffectiveBytes = exports.getStampDuration = exports.getStampCost = exports.getDepthForSize = exports.getAmountForDuration = exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.makeMaxTarget = exports.getFolderSize = exports.makeCollectionFromFileList = exports.getCollectionSize = void 0;
 var collection_1 = require("./collection");
 Object.defineProperty(exports, "getCollectionSize", { enumerable: true, get: function () { return collection_1.getCollectionSize; } });
 Object.defineProperty(exports, "makeCollectionFromFileList", { enumerable: true, get: function () { return collection_1.makeCollectionFromFileList; } });
@@ -21,3 +21,5 @@ Object.defineProperty(exports, "getStampEffectiveBytes", { enumerable: true, get
 Object.defineProperty(exports, "getStampEffectiveBytesBreakpoints", { enumerable: true, get: function () { return stamps_1.getStampEffectiveBytesBreakpoints; } });
 Object.defineProperty(exports, "getStampTheoreticalBytes", { enumerable: true, get: function () { return stamps_1.getStampTheoreticalBytes; } });
 Object.defineProperty(exports, "getStampUsage", { enumerable: true, get: function () { return stamps_1.getStampUsage; } });
+Object.defineProperty(exports, "mapPostageBatch", { enumerable: true, get: function () { return stamps_1.mapPostageBatch; } });
+Object.defineProperty(exports, "unmapPostageBatch", { enumerable: true, get: function () { return stamps_1.unmapPostageBatch; } });

package/dist/cjs/utils/stamps.js

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.marshalStamp = exports.convertEnvelopeToMarshaledStamp = exports.getDepthForSize = exports.getAmountForDuration = exports.getStampDuration = exports.getStampCost = exports.getStampEffectiveBytesBreakpoints = exports.getStampEffectiveBytes = exports.getStampTheoreticalBytes = exports.getStampUsage = void 0;
+exports.unmapPostageBatch = exports.mapPostageBatch = exports.marshalStamp = exports.convertEnvelopeToMarshaledStamp = exports.getDepthForSize = exports.getAmountForDuration = exports.getStampDuration = exports.getStampCost = exports.getStampEffectiveBytesBreakpoints = exports.getStampEffectiveBytes = exports.getStampTheoreticalBytes = exports.getStampUsage = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const types_1 = require("../types");
 const bytes_1 = require("./bytes");
 const duration_1 = require("./duration");
+const size_1 = require("./size");
 const tokens_1 = require("./tokens");
 const type_1 = require("./type");
+const typed_bytes_1 = require("./typed-bytes");
+const workaround_1 = require("./workaround");
 const MAX_UTILIZATION = 0.9;
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
@@ -172,3 +175,50 @@ function marshalStamp(signature, batchId, timestamp, index) {
     return new bytes_1.Bytes(cafe_utility_1.Binary.concatBytes(batchId, index, timestamp, signature));
 }
 exports.marshalStamp = marshalStamp;
+function mapPostageBatch(raw, encryption, erasureCodeLevel) {
+    const usage = getStampUsage(raw.utilization, raw.depth, raw.bucketDepth);
+    const batchTTL = (0, workaround_1.normalizeBatchTTL)(raw.batchTTL);
+    const duration = duration_1.Duration.fromSeconds(batchTTL);
+    const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, erasureCodeLevel);
+    return {
+        batchID: new typed_bytes_1.BatchId(raw.batchID),
+        utilization: raw.utilization,
+        usable: raw.usable,
+        label: raw.label,
+        depth: raw.depth,
+        amount: (0, type_1.asNumberString)(raw.amount),
+        bucketDepth: raw.bucketDepth,
+        blockNumber: raw.blockNumber,
+        immutableFlag: raw.immutableFlag,
+        usage,
+        usageText: `${Math.round(usage * 100)}%`,
+        size: size_1.Size.fromBytes(effectiveBytes),
+        remainingSize: size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
+        theoreticalSize: size_1.Size.fromBytes(getStampTheoreticalBytes(raw.depth)),
+        duration,
+        calculateSize(encryption, redundancyLevel) {
+            const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, redundancyLevel);
+            return size_1.Size.fromBytes(effectiveBytes);
+        },
+        calculateRemainingSize(encryption, redundancyLevel) {
+            const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, redundancyLevel);
+            return size_1.Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)));
+        },
+    };
+}
+exports.mapPostageBatch = mapPostageBatch;
+function unmapPostageBatch(batch) {
+    return {
+        batchID: batch.batchID.toHex(),
+        utilization: batch.utilization,
+        usable: batch.usable,
+        label: batch.label,
+        depth: batch.depth,
+        amount: batch.amount,
+        bucketDepth: batch.bucketDepth,
+        blockNumber: batch.blockNumber,
+        immutableFlag: batch.immutableFlag,
+        batchTTL: batch.duration.toSeconds(),
+    };
+}
+exports.unmapPostageBatch = unmapPostageBatch;

package/dist/cjs/utils/workaround.js

@@ -9,8 +9,11 @@ function normalizeBatchTTL(batchTTL) {
     if (batchTTL < 1) {
         return 1;
     }
-    if (batchTTL > 315569260) {
-        return 315569260;
+    // Cap `batchTTL` (represents seconds) to 100 years.
+    // We can assume `storagePrice` is invalid (e.g. 1).
+    // This is needed to prevent Date objects breaking.
+    if (batchTTL > 3155695200) {
+        return 3155695200;
     }
     return batchTTL;
 }