@ethersphere/bee-js 6.5.1 → 6.7.0

package/dist/cjs/utils/data.js

@@ -1,33 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareWebsocketData = exports.prepareData = void 0;
-const fetch_blob_1 = __importDefault(require("fetch-blob"));
-const stream_1 = require("./stream");
-/**
- * Prepare data for valid input for node-fetch.
- *
- * node-fetch is not using WHATWG ReadableStream but NodeJS Readable so we need to convert in case of ReadableStream,
- * but the typings are set to use ReadableStream so hence why type conversion here.
- *
- * @param data any string, ArrayBuffer, Uint8Array or Readable
- */
-async function prepareData(data) {
-    if (typeof data === 'string')
-        return new fetch_blob_1.default([data], { type: 'text/plain' });
-    if (data instanceof Uint8Array || data instanceof ArrayBuffer) {
-        return new fetch_blob_1.default([data], { type: 'application/octet-stream' });
-    }
-    if (data instanceof fetch_blob_1.default || (0, stream_1.isNodeReadable)(data))
-        return data;
-    if ((0, stream_1.isReadableStream)(data)) {
-        return (0, stream_1.readableWebToNode)(data);
-    }
-    throw new TypeError('unknown data type');
-}
-exports.prepareData = prepareData;
+exports.prepareWebsocketData = void 0;
 function isBufferArray(buffer) {
     return Array.isArray(buffer) && buffer.length > 0 && buffer.every(data => data instanceof Buffer);
 }

package/dist/cjs/utils/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BeeArgumentError = exports.BeeError = void 0;
+exports.BeeResponseError = exports.BeeArgumentError = exports.BeeError = void 0;
 class BeeError extends Error {
     constructor(message) {
         super(message);
@@ -14,3 +14,15 @@ class BeeArgumentError extends BeeError {
     }
 }
 exports.BeeArgumentError = BeeArgumentError;
+class BeeResponseError extends BeeError {
+    constructor(message, code, axiosStatus, status, config, request, response) {
+        super(message);
+        this.code = code;
+        this.axiosStatus = axiosStatus;
+        this.status = status;
+        this.config = config;
+        this.request = request;
+        this.response = response;
+    }
+}
+exports.BeeResponseError = BeeResponseError;

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.getStampCostInPlur = exports.getStampCostInBzz = exports.makeMaxTarget = exports.keccak256Hash = exports.readableWebToNode = exports.readableNodeToWeb = exports.normalizeToReadableStream = exports.isReadableStream = exports.isReadable = exports.isNodeReadable = exports.toLittleEndian = exports.makeHexEthAddress = exports.makeEthereumWalletSigner = exports.makeEthAddress = exports.isHexEthAddress = exports.fromLittleEndian = exports.ethToSwarmAddress = exports.makeHexString = exports.isHexString = exports.intToHex = exports.hexToBytes = exports.bytesToHex = exports.assertPrefixedHexString = exports.assertHexString = exports.isFlexBytes = exports.isBytes = exports.flexBytesAtOffset = exports.bytesEqual = exports.bytesAtOffset = exports.assertFlexBytes = exports.assertBytes = exports.getFolderSize = exports.getCollectionSize = void 0;
+exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampEffectiveBytes = exports.getStampMaximumCapacityBytes = exports.getStampCostInPlur = exports.getStampCostInBzz = exports.getDepthForCapacity = exports.getAmountForTtl = exports.makeMaxTarget = exports.keccak256Hash = exports.readableWebToNode = exports.readableNodeToWeb = exports.normalizeToReadableStream = exports.isReadableStream = exports.isReadable = exports.isNodeReadable = exports.toLittleEndian = exports.makeHexEthAddress = exports.makeEthereumWalletSigner = exports.makeEthAddress = exports.isHexEthAddress = exports.fromLittleEndian = exports.ethToSwarmAddress = exports.makeHexString = exports.isHexString = exports.intToHex = exports.hexToBytes = exports.bytesToHex = exports.assertPrefixedHexString = exports.assertHexString = exports.isFlexBytes = exports.isBytes = exports.flexBytesAtOffset = exports.bytesEqual = exports.bytesAtOffset = exports.assertFlexBytes = exports.assertBytes = exports.getFolderSize = exports.getCollectionSize = void 0;
 var collection_1 = require("./collection");
 Object.defineProperty(exports, "getCollectionSize", { enumerable: true, get: function () { return collection_1.getCollectionSize; } });
 var collection_node_1 = require("./collection.node");
@@ -41,8 +41,11 @@ Object.defineProperty(exports, "keccak256Hash", { enumerable: true, get: functio
 var pss_1 = require("./pss");
 Object.defineProperty(exports, "makeMaxTarget", { enumerable: true, get: function () { return pss_1.makeMaxTarget; } });
 var stamps_1 = require("./stamps");
+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, "getStampCostInBzz", { enumerable: true, get: function () { return stamps_1.getStampCostInBzz; } });
 Object.defineProperty(exports, "getStampCostInPlur", { enumerable: true, get: function () { return stamps_1.getStampCostInPlur; } });
 Object.defineProperty(exports, "getStampMaximumCapacityBytes", { enumerable: true, get: function () { return stamps_1.getStampMaximumCapacityBytes; } });
+Object.defineProperty(exports, "getStampEffectiveBytes", { enumerable: true, get: function () { return stamps_1.getStampEffectiveBytes; } });
 Object.defineProperty(exports, "getStampTtlSeconds", { enumerable: true, get: function () { return stamps_1.getStampTtlSeconds; } });
 Object.defineProperty(exports, "getStampUsage", { enumerable: true, get: function () { return stamps_1.getStampUsage; } });

package/dist/cjs/utils/http.js

@@ -1,11 +1,32 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.http = exports.DEFAULT_HTTP_CONFIG = void 0;
-const axios_1 = __importDefault(require("axios"));
+const axios_1 = __importStar(require("axios"));
 const cafe_utility_1 = require("cafe-utility");
+const index_1 = require("../index");
 exports.DEFAULT_HTTP_CONFIG = {
     headers: {
         accept: 'application/json, text/plain, */*',
@@ -26,6 +47,9 @@ async function http(options, config) {
         return response;
     }
     catch (e) {
+        if (e instanceof axios_1.AxiosError) {
+            throw new index_1.BeeResponseError(e.message, e.code, e.status, e.response?.status, e.config, e.request, e.response);
+        }
         throw e;
     }
 }

package/dist/cjs/utils/stamps.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStampTtlSeconds = exports.getStampCostInBzz = exports.getStampCostInPlur = exports.getStampMaximumCapacityBytes = exports.getStampUsage = void 0;
+exports.getDepthForCapacity = exports.getAmountForTtl = exports.getStampTtlSeconds = exports.getStampCostInBzz = exports.getStampCostInPlur = exports.getStampEffectiveBytes = exports.getStampMaximumCapacityBytes = exports.getStampUsage = void 0;
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
  *
@@ -23,6 +23,40 @@ function getStampMaximumCapacityBytes(depth) {
     return 2 ** depth * 4096;
 }
 exports.getStampMaximumCapacityBytes = getStampMaximumCapacityBytes;
+/**
+ * Based on https://docs.ethswarm.org/docs/learn/technology/contracts/postage-stamp/#effective-utilisation-table
+ */
+const utilisationRateMap = {
+    22: 0.2867,
+    23: 0.4956,
+    24: 0.6433,
+    25: 0.7478,
+    26: 0.8217,
+    27: 0.8739,
+    28: 0.9108,
+    29: 0.9369,
+    30: 0.9554,
+    31: 0.9685,
+    32: 0.9777,
+    33: 0.9842,
+    34: 0.9889,
+};
+/**
+ * Utility function that calculates the effective volume of a postage batch based on its depth.
+ *
+ * Below 22 depth the effective volume is 0
+ * Above 34 it's always > 99%
+ *
+ * @returns {number} The effective volume of the postage batch in bytes.
+ */
+function getStampEffectiveBytes(depth) {
+    if (depth < 22) {
+        return 0;
+    }
+    const utilRate = utilisationRateMap[depth] ?? 0.99;
+    return getStampMaximumCapacityBytes(depth) * utilRate;
+}
+exports.getStampEffectiveBytes = getStampEffectiveBytes;
 /**
  * Utility function that calculates the cost of a postage batch based on its depth and amount.
  *
@@ -53,3 +87,28 @@ function getStampTtlSeconds(amount, pricePerBlock = 24000, blockTime = 5) {
     return (amount * blockTime) / 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.
+ *
+ * @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) {
+    // 414720000 = (24 * 60 * 60 * 24_000) / 5
+    return ((days <= 0 ? 1 : days) * 414720000).toString();
+}
+exports.getAmountForTtl = getAmountForTtl;
+/**
+ * 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.
+ *
+ * @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;