@upcoming/bee-js 0.9.0 → 0.10.1

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

@@ -7,6 +7,7 @@ const http_1 = require("../../utils/http");
 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) {
@@ -42,7 +43,7 @@ async function getAllPostageBatches(requestOptions) {
         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 = cafe_utility_1.Types.asNumber(x.batchTTL, { name: 'batchTTL' });
+        const batchTTL = (0, workaround_1.normalizeBatchTTL)(cafe_utility_1.Types.asNumber(x.batchTTL, { name: 'batchTTL' }));
         const duration = duration_1.Duration.fromSeconds(batchTTL);
         return {
             batchID: new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(x.batchID, { name: 'batchID' })),
@@ -54,12 +55,10 @@ async function getAllPostageBatches(requestOptions) {
             bucketDepth,
             blockNumber: cafe_utility_1.Types.asNumber(x.blockNumber, { name: 'blockNumber' }),
             immutableFlag: cafe_utility_1.Types.asBoolean(x.immutableFlag, { name: 'immutableFlag' }),
-            exists: cafe_utility_1.Types.asBoolean(x.exists, { name: 'exists' }),
-            batchTTL,
             usage,
             size: (0, stamps_1.getStampEffectiveBytes)(depth),
             remainingSize: Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage)),
-            theoreticalSize: (0, stamps_1.getStampMaximumCapacityBytes)(depth),
+            theoreticalSize: (0, stamps_1.getStampTheoreticalBytes)(depth),
             duration,
         };
     });
@@ -76,7 +75,7 @@ async function getPostageBatch(requestOptions, postageBatchId) {
     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 = cafe_utility_1.Types.asNumber(body.batchTTL, { name: 'batchTTL' });
+    const batchTTL = (0, workaround_1.normalizeBatchTTL)(cafe_utility_1.Types.asNumber(body.batchTTL, { name: 'batchTTL' }));
     const duration = duration_1.Duration.fromSeconds(batchTTL);
     return {
         batchID: new typed_bytes_1.BatchId(cafe_utility_1.Types.asString(body.batchID, { name: 'batchID' })),
@@ -88,12 +87,10 @@ async function getPostageBatch(requestOptions, postageBatchId) {
         bucketDepth,
         blockNumber: cafe_utility_1.Types.asNumber(body.blockNumber, { name: 'blockNumber' }),
         immutableFlag: cafe_utility_1.Types.asBoolean(body.immutableFlag, { name: 'immutableFlag' }),
-        exists: cafe_utility_1.Types.asBoolean(body.exists, { name: 'exists' }),
-        batchTTL,
         usage,
         size: (0, stamps_1.getStampEffectiveBytes)(depth),
         remainingSize: Math.ceil((0, stamps_1.getStampEffectiveBytes)(depth) * (1 - usage)),
-        theoreticalSize: (0, stamps_1.getStampMaximumCapacityBytes)(depth),
+        theoreticalSize: (0, stamps_1.getStampTheoreticalBytes)(depth),
         duration,
     };
 }

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

@@ -5,6 +5,7 @@ const cafe_utility_1 = require("cafe-utility");
 const http_1 = require("../../utils/http");
 const tokens_1 = require("../../utils/tokens");
 const type_1 = require("../../utils/type");
+const workaround_1 = require("../../utils/workaround");
 const RESERVE_STATE_ENDPOINT = 'reservestate';
 const WALLET_ENDPOINT = 'wallet';
 const CHAIN_STATE_ENDPOINT = 'chainstate';
@@ -43,7 +44,7 @@ async function getChainState(requestOptions) {
         block: cafe_utility_1.Types.asNumber(body.block, { name: 'block' }),
         chainTip: cafe_utility_1.Types.asNumber(body.chainTip, { name: 'chainTip' }),
         totalAmount: (0, type_1.asNumberString)(body.totalAmount, { name: 'totalAmount' }),
-        currentPrice: cafe_utility_1.Types.asNumber(body.currentPrice, { name: 'currentPrice' }),
+        currentPrice: (0, workaround_1.normalizeCurrentPrice)(cafe_utility_1.Types.asNumber(body.currentPrice, { name: 'currentPrice' })),
     };
 }
 exports.getChainState = getChainState;

package/dist/cjs/utils/expose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampMaximumCapacityBytes = exports.getStampEffectiveBytes = exports.getStampCost = exports.getDepthForSize = exports.getDepthForCapacity = exports.getAmountForTtl = exports.getAmountForDuration = exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.makeMaxTarget = exports.getFolderSize = exports.makeCollectionFromFileList = exports.getCollectionSize = void 0;
+exports.getStampUsage = exports.getStampTheoreticalBytes = 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; } });
@@ -14,11 +14,9 @@ Object.defineProperty(exports, "getRedundancyStat", { enumerable: true, get: fun
 Object.defineProperty(exports, "getRedundancyStats", { enumerable: true, get: function () { return redundancy_1.getRedundancyStats; } });
 var stamps_1 = require("./stamps");
 Object.defineProperty(exports, "getAmountForDuration", { enumerable: true, get: function () { return stamps_1.getAmountForDuration; } });
-Object.defineProperty(exports, "getAmountForTtl", { enumerable: true, get: function () { return stamps_1.getAmountForTtl; } });
-Object.defineProperty(exports, "getDepthForCapacity", { enumerable: true, get: function () { return stamps_1.getDepthForCapacity; } });
 Object.defineProperty(exports, "getDepthForSize", { enumerable: true, get: function () { return stamps_1.getDepthForSize; } });
 Object.defineProperty(exports, "getStampCost", { enumerable: true, get: function () { return stamps_1.getStampCost; } });
+Object.defineProperty(exports, "getStampDuration", { enumerable: true, get: function () { return stamps_1.getStampDuration; } });
 Object.defineProperty(exports, "getStampEffectiveBytes", { enumerable: true, get: function () { return stamps_1.getStampEffectiveBytes; } });
-Object.defineProperty(exports, "getStampMaximumCapacityBytes", { enumerable: true, get: function () { return stamps_1.getStampMaximumCapacityBytes; } });
-Object.defineProperty(exports, "getStampTtlSeconds", { enumerable: true, get: function () { return stamps_1.getStampTtlSeconds; } });
+Object.defineProperty(exports, "getStampTheoreticalBytes", { enumerable: true, get: function () { return stamps_1.getStampTheoreticalBytes; } });
 Object.defineProperty(exports, "getStampUsage", { enumerable: true, get: function () { return stamps_1.getStampUsage; } });

package/dist/cjs/utils/stamps.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.marshalStamp = exports.convertEnvelopeToMarshaledStamp = exports.getDepthForSize = exports.getDepthForCapacity = exports.getAmountForDuration = exports.getAmountForTtl = exports.getStampTtlSeconds = exports.getStampCost = exports.getStampEffectiveBytes = exports.getStampTheoreticalBytes = exports.getStampMaximumCapacityBytes = exports.getStampUsage = void 0;
+exports.marshalStamp = exports.convertEnvelopeToMarshaledStamp = exports.getDepthForSize = exports.getAmountForDuration = exports.getStampDuration = exports.getStampCost = exports.getStampEffectiveBytes = exports.getStampTheoreticalBytes = exports.getStampUsage = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const bytes_1 = require("./bytes");
+const duration_1 = require("./duration");
 const tokens_1 = require("./tokens");
 const type_1 = require("./type");
 /**
@@ -17,20 +18,14 @@ function getStampUsage(utilization, depth, bucketDepth) {
 }
 exports.getStampUsage = getStampUsage;
 /**
- * Utility function that calculates the theoritical maximum capacity of a postage batch based on its depth.
+ * Utility function that calculates the theoritical maximum size of a postage batch based on its depth.
  *
- * For smaller depths (up to 20), this may provide less accurate results.
- *
- * @deprecated Use `getStampTheoreticalBytes` instead.
+ * For smaller depths (up to 22), this may provide less accurate results.
  *
- * @returns {number} The maximum capacity of the postage batch in bytes.
+ * @returns {number} The maximum theoretical size of the postage batch in bytes.
  */
-function getStampMaximumCapacityBytes(depth) {
-    return 2 ** depth * 4096;
-}
-exports.getStampMaximumCapacityBytes = getStampMaximumCapacityBytes;
 function getStampTheoreticalBytes(depth) {
-    return 4096n * 2n ** BigInt(depth);
+    return 4096 * 2 ** depth;
 }
 exports.getStampTheoreticalBytes = getStampTheoreticalBytes;
 /**
@@ -78,15 +73,14 @@ function getStampEffectiveBytes(depth) {
         return 0;
     }
     const utilRate = utilisationRateMap[depth] ?? 0.99;
-    return Math.ceil(getStampMaximumCapacityBytes(depth) * utilRate);
+    return Math.ceil(getStampTheoreticalBytes(depth) * utilRate);
 }
 exports.getStampEffectiveBytes = getStampEffectiveBytes;
 /**
  * Utility function that calculates the cost of a postage batch based on its depth and amount.
  */
 function getStampCost(depth, amount) {
-    const amountBigInt = BigInt((0, type_1.asNumberString)(amount));
-    return tokens_1.BZZ.fromPLUR(2n ** BigInt(depth) * amountBigInt);
+    return tokens_1.BZZ.fromPLUR(2n ** BigInt(depth) * BigInt(amount));
 }
 exports.getStampCost = getStampCost;
 /**
@@ -94,27 +88,13 @@ exports.getStampCost = getStampCost;
  *
  * For more accurate results, get the price per block and block time from the Bee node or the blockchain.
  *
- * @returns {number} The TTL of the postage batch in seconds.
+ * @returns {number} The TTL of the postage batch.
  */
-function getStampTtlSeconds(amount, pricePerBlock = 24000, blockTime = 5) {
+function getStampDuration(amount, pricePerBlock, blockTime = 5) {
     const amountBigInt = BigInt((0, type_1.asNumberString)(amount));
-    return (amountBigInt * BigInt(blockTime)) / BigInt(pricePerBlock);
-}
-exports.getStampTtlSeconds = getStampTtlSeconds;
-/**
- * Utility function that calculates the amount of tokens required to maintain a given Time To Live (TTL) for a postage batch.
- *
- * This function estimates the required amount based on the provided TTL in days.
- *
- * @deprecated Use `getAmountForDuration` instead.
- *
- * @param {number} days - The Time To Live (TTL) in days.
- * @returns {NumberString} The estimated amount of tokens needed for the specified TTL.
- */
-function getAmountForTtl(days, pricePerBlock = 24000, blockTime = 5) {
-    return (days <= 0 ? 1n : BigInt(days)) * ((24n * 60n * 60n * BigInt(pricePerBlock)) / BigInt(blockTime));
+    return duration_1.Duration.fromSeconds(Number((amountBigInt * BigInt(blockTime)) / BigInt(pricePerBlock)));
 }
-exports.getAmountForTtl = getAmountForTtl;
+exports.getStampDuration = getStampDuration;
 /**
  * Get the postage batch `amount` required for a given `duration`.
  *
@@ -126,20 +106,6 @@ function getAmountForDuration(duration, pricePerBlock, blockTime = 5) {
     return (BigInt(duration.toSeconds()) / BigInt(blockTime)) * BigInt(pricePerBlock);
 }
 exports.getAmountForDuration = getAmountForDuration;
-/**
- * Utility function that calculates the depth required for a postage batch to achieve the specified capacity in gigabytes.
- *
- * The depth is determined based on the given gigabytes, and the result is adjusted to a minimum depth of 18.
- *
- * @deprecated Use `getDepthForSize` instead.
- *
- * @param {number} gigabytes - The desired capacity of the postage batch in gigabytes.
- * @returns {number} The calculated depth necessary to achieve the specified capacity.
- */
-function getDepthForCapacity(gigabytes) {
-    return gigabytes <= 1 ? 18 : Math.ceil(Math.log2(Math.ceil(gigabytes)) + 18);
-}
-exports.getDepthForCapacity = getDepthForCapacity;
 /**
  * Utility function that calculates the depth required for a postage batch to achieve the specified effective size in gigabytes.
  *

package/dist/cjs/utils/workaround.js

@@ -0,0 +1,27 @@
+"use strict";
+// TODO: Remove this file after the issue is fixed
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeCurrentPrice = exports.normalizeBatchTTL = void 0;
+function normalizeBatchTTL(batchTTL) {
+    if (!Number.isInteger(batchTTL)) {
+        return 1;
+    }
+    if (batchTTL < 1) {
+        return 1;
+    }
+    if (batchTTL > 315569260) {
+        return 315569260;
+    }
+    return batchTTL;
+}
+exports.normalizeBatchTTL = normalizeBatchTTL;
+function normalizeCurrentPrice(currentPrice) {
+    if (!Number.isInteger(currentPrice)) {
+        return 24000;
+    }
+    if (currentPrice < 24000) {
+        return 24000;
+    }
+    return currentPrice;
+}
+exports.normalizeCurrentPrice = normalizeCurrentPrice;