@ethersphere/bee-js 6.8.1 → 6.9.1

package/dist/cjs/feed/index.js

@@ -53,9 +53,9 @@ async function findNextIndex(requestOptions, owner, topic, options) {
     }
 }
 exports.findNextIndex = findNextIndex;
-async function updateFeed(requestOptions, signer, topic, reference, postageBatchId, options, index = 'latest') {
+async function updateFeed(requestOptions, signer, topic, reference, postageBatchId, options) {
     const ownerHex = (0, eth_1.makeHexEthAddress)(signer.address);
-    const nextIndex = index === 'latest' ? await findNextIndex(requestOptions, ownerHex, topic, options) : index;
+    const nextIndex = options?.index || (await findNextIndex(requestOptions, ownerHex, topic, options));
     const identifier = (0, identifier_1.makeFeedIdentifier)(topic, nextIndex);
     const at = options?.at ?? Date.now() / 1000.0;
     const timestamp = (0, uint64_1.writeUint64BigEndian)(at);

package/dist/cjs/modules/bytes.js

@@ -22,7 +22,7 @@ async function upload(requestOptions, data, postageBatchId, options) {
         data,
         headers: {
             'content-type': 'application/octet-stream',
-            ...(0, headers_1.extractUploadHeaders)(postageBatchId, options),
+            ...(0, headers_1.extractRedundantUploadHeaders)(postageBatchId, options),
         },
     });
     return {
@@ -37,10 +37,11 @@ exports.upload = upload;
  * @param ky
  * @param hash Bee content reference
  */
-async function download(requestOptions, hash) {
+async function download(requestOptions, hash, options) {
     const response = await (0, http_1.http)(requestOptions, {
         responseType: 'arraybuffer',
         url: `${endpoint}/${hash}`,
+        headers: (0, headers_1.extractDownloadHeaders)(options),
     });
     return (0, bytes_1.wrapBytesWithHelpers)(new Uint8Array(response.data));
 }
@@ -51,10 +52,11 @@ exports.download = download;
  * @param ky
  * @param hash Bee content reference
  */
-async function downloadReadable(requestOptions, hash) {
+async function downloadReadable(requestOptions, hash, options) {
     const response = await (0, http_1.http)(requestOptions, {
         responseType: 'stream',
         url: `${endpoint}/${hash}`,
+        headers: (0, headers_1.extractDownloadHeaders)(options),
     });
     return response.data;
 }

package/dist/cjs/modules/bzz.js

@@ -10,7 +10,7 @@ const tar_1 = require("../utils/tar");
 const type_1 = require("../utils/type");
 const bzzEndpoint = 'bzz';
 function extractFileUploadHeaders(postageBatchId, options) {
-    const headers = (0, headers_1.extractUploadHeaders)(postageBatchId, options);
+    const headers = (0, headers_1.extractRedundantUploadHeaders)(postageBatchId, options);
     if (options?.size)
         headers['content-length'] = String(options.size);
     if (options?.contentType)
@@ -28,8 +28,9 @@ function extractFileUploadHeaders(postageBatchId, options) {
  */
 async function uploadFile(requestOptions, data, postageBatchId, name, options) {
     if ((0, stream_1.isReadable)(data) && !options?.contentType) {
-        if (!options)
+        if (!options) {
             options = {};
+        }
         options.contentType = 'application/octet-stream';
     }
     const response = await (0, http_1.http)(requestOptions, {
@@ -55,11 +56,12 @@ exports.uploadFile = uploadFile;
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
-async function downloadFile(requestOptions, hash, path = '') {
+async function downloadFile(requestOptions, hash, path = '', options) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'GET',
         responseType: 'arraybuffer',
         url: `${bzzEndpoint}/${hash}/${path}`,
+        headers: (0, headers_1.extractDownloadHeaders)(options),
     });
     const file = {
         ...(0, headers_1.readFileHeaders)(response.headers),
@@ -75,11 +77,12 @@ exports.downloadFile = downloadFile;
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
-async function downloadFileReadable(requestOptions, hash, path = '') {
+async function downloadFileReadable(requestOptions, hash, path = '', options) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'GET',
         responseType: 'stream',
         url: `${bzzEndpoint}/${hash}/${path}`,
+        headers: (0, headers_1.extractDownloadHeaders)(options),
     });
     const file = {
         ...(0, headers_1.readFileHeaders)(response.headers),
@@ -89,11 +92,13 @@ async function downloadFileReadable(requestOptions, hash, path = '') {
 }
 exports.downloadFileReadable = downloadFileReadable;
 function extractCollectionUploadHeaders(postageBatchId, options) {
-    const headers = (0, headers_1.extractUploadHeaders)(postageBatchId, options);
-    if (options?.indexDocument)
+    const headers = (0, headers_1.extractRedundantUploadHeaders)(postageBatchId, options);
+    if (options?.indexDocument) {
         headers['swarm-index-document'] = options.indexDocument;
-    if (options?.errorDocument)
+    }
+    if (options?.errorDocument) {
         headers['swarm-error-document'] = options.errorDocument;
+    }
     return headers;
 }
 /**

package/dist/cjs/types/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SIGNATURE_BYTES_LENGTH = exports.SIGNATURE_HEX_LENGTH = exports.TOPIC_HEX_LENGTH = exports.TOPIC_BYTES_LENGTH = exports.FEED_INDEX_HEX_LENGTH = exports.TAGS_LIMIT_MAX = exports.TAGS_LIMIT_MIN = exports.STAMPS_DEPTH_MAX = exports.STAMPS_DEPTH_MIN = exports.ENCRYPTED_REFERENCE_BYTES_LENGTH = exports.REFERENCE_BYTES_LENGTH = exports.ENCRYPTED_REFERENCE_HEX_LENGTH = exports.REFERENCE_HEX_LENGTH = exports.BATCH_ID_HEX_LENGTH = exports.PUBKEY_HEX_LENGTH = exports.PSS_TARGET_HEX_LENGTH_MAX = exports.ADDRESS_HEX_LENGTH = exports.CHUNK_SIZE = exports.BRANCHES = exports.SECTION_SIZE = exports.SPAN_SIZE = void 0;
+exports.SIGNATURE_BYTES_LENGTH = exports.SIGNATURE_HEX_LENGTH = exports.TOPIC_HEX_LENGTH = exports.TOPIC_BYTES_LENGTH = exports.RedundancyStrategy = exports.RedundancyLevel = exports.FEED_INDEX_HEX_LENGTH = exports.TAGS_LIMIT_MAX = exports.TAGS_LIMIT_MIN = exports.STAMPS_DEPTH_MAX = exports.STAMPS_DEPTH_MIN = exports.ENCRYPTED_REFERENCE_BYTES_LENGTH = exports.REFERENCE_BYTES_LENGTH = exports.ENCRYPTED_REFERENCE_HEX_LENGTH = exports.REFERENCE_HEX_LENGTH = exports.BATCH_ID_HEX_LENGTH = exports.PUBKEY_HEX_LENGTH = exports.PSS_TARGET_HEX_LENGTH_MAX = exports.ADDRESS_HEX_LENGTH = exports.CHUNK_SIZE = exports.BRANCHES = exports.SECTION_SIZE = exports.SPAN_SIZE = void 0;
 __exportStar(require("./debug"), exports);
 exports.SPAN_SIZE = 8;
 exports.SECTION_SIZE = 32;
@@ -39,6 +39,35 @@ exports.STAMPS_DEPTH_MAX = 255;
 exports.TAGS_LIMIT_MIN = 1;
 exports.TAGS_LIMIT_MAX = 1000;
 exports.FEED_INDEX_HEX_LENGTH = 16;
+/**
+ * Add redundancy to the data being uploaded so that downloaders can download it with better UX.
+ * 0 value is default and does not add any redundancy to the file.
+ */
+var RedundancyLevel;
+(function (RedundancyLevel) {
+    RedundancyLevel[RedundancyLevel["OFF"] = 0] = "OFF";
+    RedundancyLevel[RedundancyLevel["MEDIUM"] = 1] = "MEDIUM";
+    RedundancyLevel[RedundancyLevel["STRONG"] = 2] = "STRONG";
+    RedundancyLevel[RedundancyLevel["INSANE"] = 3] = "INSANE";
+    RedundancyLevel[RedundancyLevel["PARANOID"] = 4] = "PARANOID";
+})(RedundancyLevel = exports.RedundancyLevel || (exports.RedundancyLevel = {}));
+/**
+ * Specify the retrieve strategy on redundant data.
+ * The possible values are NONE, DATA, PROX and RACE.
+ * Strategy NONE means no prefetching takes place.
+ * Strategy DATA means only data chunks are prefetched.
+ * Strategy PROX means only chunks that are close to the node are prefetched.
+ * Strategy RACE means all chunks are prefetched: n data chunks and k parity chunks. The first n chunks to arrive are used to reconstruct the file.
+ * Multiple strategies can be used in a fallback cascade if the swarm redundancy fallback mode is set to true.
+ * The default strategy is NONE, DATA, falling back to PROX, falling back to RACE
+ */
+var RedundancyStrategy;
+(function (RedundancyStrategy) {
+    RedundancyStrategy[RedundancyStrategy["NONE"] = 0] = "NONE";
+    RedundancyStrategy[RedundancyStrategy["DATA"] = 1] = "DATA";
+    RedundancyStrategy[RedundancyStrategy["PROX"] = 2] = "PROX";
+    RedundancyStrategy[RedundancyStrategy["RACE"] = 3] = "RACE";
+})(RedundancyStrategy = exports.RedundancyStrategy || (exports.RedundancyStrategy = {}));
 /*********************************************************
  * Writers and Readers interfaces
  */

package/dist/cjs/utils/expose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampMaximumCapacityBytes = exports.getStampEffectiveBytes = 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");
@@ -45,7 +45,11 @@ Object.defineProperty(exports, "getAmountForTtl", { enumerable: true, get: funct
 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, "getStampMaximumCapacityBytes", { enumerable: true, get: function () { return stamps_1.getStampMaximumCapacityBytes; } });
 Object.defineProperty(exports, "getStampTtlSeconds", { enumerable: true, get: function () { return stamps_1.getStampTtlSeconds; } });
 Object.defineProperty(exports, "getStampUsage", { enumerable: true, get: function () { return stamps_1.getStampUsage; } });
+var redundancy_1 = require("./redundancy");
+Object.defineProperty(exports, "approximateOverheadForRedundancyLevel", { enumerable: true, get: function () { return redundancy_1.approximateOverheadForRedundancyLevel; } });
+Object.defineProperty(exports, "getRedundancyStat", { enumerable: true, get: function () { return redundancy_1.getRedundancyStat; } });
+Object.defineProperty(exports, "getRedundancyStats", { enumerable: true, get: function () { return redundancy_1.getRedundancyStats; } });

package/dist/cjs/utils/headers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractUploadHeaders = exports.readFileHeaders = void 0;
+exports.extractDownloadHeaders = exports.extractRedundantUploadHeaders = exports.extractUploadHeaders = exports.readFileHeaders = void 0;
 const error_1 = require("./error");
 /**
  * Read the filename from the content-disposition header
@@ -46,14 +46,40 @@ function extractUploadHeaders(postageBatchId, options) {
     const headers = {
         'swarm-postage-batch-id': postageBatchId,
     };
-    if (options?.pin)
+    if (options?.pin) {
         headers['swarm-pin'] = String(options.pin);
-    if (options?.encrypt)
+    }
+    if (options?.encrypt) {
         headers['swarm-encrypt'] = String(options.encrypt);
-    if (options?.tag)
+    }
+    if (options?.tag) {
         headers['swarm-tag'] = String(options.tag);
-    if (typeof options?.deferred === 'boolean')
+    }
+    if (typeof options?.deferred === 'boolean') {
         headers['swarm-deferred-upload'] = options.deferred.toString();
+    }
     return headers;
 }
 exports.extractUploadHeaders = extractUploadHeaders;
+function extractRedundantUploadHeaders(postageBatchId, options) {
+    const headers = extractUploadHeaders(postageBatchId, options);
+    if (options?.redundancyLevel) {
+        headers['swarm-redundancy-level'] = String(options.redundancyLevel);
+    }
+    return headers;
+}
+exports.extractRedundantUploadHeaders = extractRedundantUploadHeaders;
+function extractDownloadHeaders(options) {
+    const headers = {};
+    if (options?.redundancyStrategy) {
+        headers['swarm-redundancy-strategy'] = String(options.redundancyStrategy);
+    }
+    if (options?.fallback === false) {
+        headers['swarm-redundancy-fallback-mode'] = 'false';
+    }
+    if (options?.timeoutMs !== undefined) {
+        headers['swarm-chunk-retrieval-timeout'] = String(options.timeoutMs);
+    }
+    return headers;
+}
+exports.extractDownloadHeaders = extractDownloadHeaders;

package/dist/cjs/utils/redundancy.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRedundancyStat = exports.getRedundancyStats = exports.approximateOverheadForRedundancyLevel = void 0;
+const __1 = require("..");
+const mediumTable = [
+    [94, 68, 46, 28, 14, 5, 1],
+    [9, 8, 7, 6, 5, 4, 3],
+];
+const encMediumTable = [
+    [47, 34, 23, 14, 7, 2],
+    [9, 8, 7, 6, 5, 4],
+];
+const strongTable = [
+    [104, 95, 86, 77, 69, 61, 53, 46, 39, 32, 26, 20, 15, 10, 6, 3, 1],
+    [21, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5],
+];
+const encStrongTable = [
+    [52, 47, 43, 38, 34, 30, 26, 23, 19, 16, 13, 10, 7, 5, 3, 1],
+    [21, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6],
+];
+const insaneTable = [
+    [92, 87, 82, 77, 73, 68, 63, 59, 54, 50, 45, 41, 37, 33, 29, 26, 22, 19, 16, 13, 10, 8, 5, 3, 2, 1],
+    [31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6],
+];
+const encInsaneTable = [
+    [46, 43, 41, 38, 36, 34, 31, 29, 27, 25, 22, 20, 18, 16, 14, 13, 11, 9, 8, 6, 5, 4, 2, 1],
+    [31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 7],
+];
+const paranoidTable = [
+    [
+        37, 36, 35, 34, 33, 32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9,
+        8, 7, 6, 5, 4, 3, 2, 1,
+    ],
+    [
+        90, 88, 87, 85, 84, 82, 81, 79, 77, 76, 74, 72, 71, 69, 67, 66, 64, 62, 60, 59, 57, 55, 53, 51, 49, 48, 46, 44, 41,
+        39, 37, 35, 32, 30, 27, 24, 20,
+    ],
+];
+const encParanoidTable = [
+    [18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+    [88, 85, 82, 79, 76, 72, 69, 66, 62, 59, 55, 51, 48, 44, 39, 35, 30, 24],
+];
+const tables = {
+    [__1.RedundancyLevel.MEDIUM]: [mediumTable, encMediumTable],
+    [__1.RedundancyLevel.STRONG]: [strongTable, encStrongTable],
+    [__1.RedundancyLevel.INSANE]: [insaneTable, encInsaneTable],
+    [__1.RedundancyLevel.PARANOID]: [paranoidTable, encParanoidTable],
+};
+/**
+ * Returns an approximate multiplier for the overhead of a given redundancy level.
+ * Redundancy level is a tradeoff between storage overhead and fault tolerance.
+ * Use this number to estimate the amount of chunks that will be stored for a given
+ * redundancy level.
+ */
+function approximateOverheadForRedundancyLevel(chunks, level, encrypted) {
+    const tableType = level === __1.RedundancyLevel.MEDIUM
+        ? tables[__1.RedundancyLevel.MEDIUM]
+        : level === __1.RedundancyLevel.STRONG
+            ? tables[__1.RedundancyLevel.STRONG]
+            : level === __1.RedundancyLevel.INSANE
+                ? tables[__1.RedundancyLevel.INSANE]
+                : tables[__1.RedundancyLevel.PARANOID];
+    const table = encrypted ? tableType[1] : tableType[0];
+    const [supportedChunks, parities] = table;
+    for (let i = 0; i < supportedChunks.length; i++) {
+        if (chunks >= supportedChunks[i]) {
+            return parities[i] / supportedChunks[i];
+        }
+    }
+    return parities[parities.length - 1] / supportedChunks[supportedChunks.length - 1];
+}
+exports.approximateOverheadForRedundancyLevel = approximateOverheadForRedundancyLevel;
+const medium = {
+    label: 'medium',
+    value: __1.RedundancyLevel.MEDIUM,
+    errorTolerance: 0.01,
+};
+const strong = {
+    label: 'strong',
+    value: __1.RedundancyLevel.STRONG,
+    errorTolerance: 0.05,
+};
+const insane = {
+    label: 'insane',
+    value: __1.RedundancyLevel.INSANE,
+    errorTolerance: 0.1,
+};
+const paranoid = {
+    label: 'paranoid',
+    value: __1.RedundancyLevel.PARANOID,
+    errorTolerance: 0.5,
+};
+function getRedundancyStats() {
+    return {
+        medium,
+        strong,
+        insane,
+        paranoid,
+    };
+}
+exports.getRedundancyStats = getRedundancyStats;
+function getRedundancyStat(level) {
+    if (typeof level === 'string') {
+        switch (level.toLowerCase()) {
+            case 'medium':
+                return medium;
+            case 'strong':
+                return strong;
+            case 'insane':
+                return insane;
+            case 'paranoid':
+                return paranoid;
+            default:
+                throw new Error(`Unknown redundancy level '${level}'`);
+        }
+    }
+    switch (level) {
+        case __1.RedundancyLevel.MEDIUM:
+            return medium;
+        case __1.RedundancyLevel.STRONG:
+            return strong;
+        case __1.RedundancyLevel.INSANE:
+            return insane;
+        case __1.RedundancyLevel.PARANOID:
+            return paranoid;
+        default:
+            throw new Error(`Unknown redundancy level '${level}'`);
+    }
+}
+exports.getRedundancyStat = getRedundancyStat;