@ethersphere/bee-js 3.3.3 → 4.0.0

package/LICENSE

@@ -1,27 +1,29 @@
-Copyright (c) 2020 The Swarm Authors. All rights reserved.
+BSD 3-Clause License
+
+Copyright (c) 2022, The Swarm Authors
+All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
 
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Swarm nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -90,14 +90,6 @@ console.log(data.text()) // prints 'Bee is awesome!'
 
 You can find the full documentation [here](https://bee-js.ethswarm.org/docs). The API reference documentation can be found [here](https://bee-js.ethswarm.org/docs/api).
 
-You can generate API docs locally with:
-
-```sh
-npm run docs
-```
-
-The generated docs can be viewed in browser by opening `./docs/index.html`
-
 ## Contribute
 
 There are some ways you can make this module better:

package/dist/cjs/bee.js

@@ -56,6 +56,7 @@ const collection_node_1 = require("./utils/collection.node");
 const types_1 = require("./types");
 const http_1 = require("./utils/http");
 const stream_1 = require("./utils/stream");
+const retrievable_1 = require("./feed/retrievable");
 /**
  * The main component that abstracts operations available on the main Bee API.
  *
@@ -121,30 +122,34 @@ class Bee {
     /**
      * Download data as a byte array
      *
-     * @param reference Bee data reference
+     * @param reference Bee data reference in hex string (either 64 or 128 chars long) or ENS domain.
      * @param options Options that affects the request behavior
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
     downloadData(reference, options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             return bytes.download(this.getKy(options), reference);
         });
     }
     /**
      * Download data as a Readable stream
      *
-     * @param reference Bee data reference
+     * @param reference Bee data reference in hex string (either 64 or 128 chars long) or ENS domain.
      * @param options Options that affects the request behavior
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
      */
     downloadReadableData(reference, options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             return bytes.downloadReadable(this.getKy(options), reference);
         });
     }
@@ -179,15 +184,17 @@ class Bee {
     /**
      * Download chunk as a byte array
      *
-     * @param reference Bee chunk reference
+     * @param reference Bee chunk reference in hex string (either 64 or 128 chars long) or ENS domain.
      * @param options Options that affects the request behavior
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{reference}/get)
      */
     downloadChunk(reference, options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             return chunk.download(this.getKy(options), reference);
         });
     }
@@ -237,10 +244,11 @@ class Bee {
     /**
      * Download single file.
      *
-     * @param reference Bee file reference
+     * @param reference Bee file reference in hex string (either 64 or 128 chars long) or ENS domain.
      * @param path If reference points to manifest, then this parameter defines path to the file
      * @param options Options that affects the request behavior
-     *
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      * @see Data
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz~1{reference}~1{path}/get)
@@ -248,16 +256,18 @@ class Bee {
     downloadFile(reference, path = '', options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             return bzz.downloadFile(this.getKy(options), reference, path);
         });
     }
     /**
      * Download single file as a readable stream
      *
-     * @param reference Hash reference to file
+     * @param reference Bee file reference in hex string (either 64 or 128 chars long) or ENS domain.
      * @param path If reference points to manifest / collections, then this parameter defines path to the file
      * @param options Options that affects the request behavior
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      *
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz~1{reference}~1{path}/get)
@@ -265,7 +275,7 @@ class Bee {
     downloadReadableFile(reference, path = '', options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             return bzz.downloadFileReadable(this.getKy(options), reference, path);
         });
     }
@@ -494,9 +504,10 @@ class Bee {
      *
      * **Warning! Not allowed when node is in Gateway mode!**
      *
-     * @param reference Bee data reference
+     * @param reference Bee data reference in hex string (either 64 or 128 chars long) or ENS domain.
      * @param options Options that affects the request behavior
-     * @throws TypeError if reference is in not correct format
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      *
      * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
      */
@@ -510,35 +521,77 @@ class Bee {
     /**
      * Instructs the Bee node to reupload a locally pinned data into the network.
      *
-     * @param reference
+     * @param reference Bee data reference to be re-uploaded in hex string (either 64 or 128 chars long) or ENS domain.
      * @param options Options that affects the request behavior
      * @throws BeeArgumentError if the reference is not locally pinned
-     * @throws TypeError if reference is in not correct format
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      *
      * @see [Bee API reference - `PUT /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/put)
      */
     reuploadPinnedData(reference, options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             yield stewardship.reupload(this.getKy(options), reference);
         });
     }
     /**
      * Checks if content specified by reference is retrievable from the network.
      *
-     * @param reference The checked content
+     * @param reference Bee data reference to be checked in hex string (either 64 or 128 chars long) or ENS domain.
      * @param options Options that affects the request behavior
+     * @throws TypeError if some of the input parameters is not expected type
+     * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
      *
      * @see [Bee API reference - `GET /stewardship`](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1{reference}/get)
      */
     isReferenceRetrievable(reference, options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReference)(reference);
+            (0, type_2.assertReferenceOrEns)(reference);
             return stewardship.isRetrievable(this.getKy(options), reference);
         });
     }
+    /**
+     * Functions that validates if feed is retrievable in the network.
+     *
+     * If no index is passed then it check for "latest" update, which is a weaker guarantee as nobody can be really
+     * sure what is the "latest" update.
+     *
+     * If index is passed then it validates all previous sequence index chunks if they are available as they are required
+     * to correctly resolve the feed upto the given index update.
+     *
+     * @param type
+     * @param owner
+     * @param topic
+     * @param index
+     * @param options
+     */
+    isFeedRetrievable(type, owner, topic, index, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const canonicalOwner = (0, eth_1.makeEthAddress)(owner);
+            const canonicalTopic = (0, topic_1.makeTopic)(topic);
+            if (!index) {
+                try {
+                    yield this.makeFeedReader(type, canonicalTopic, canonicalOwner).download();
+                    return true;
+                }
+                catch (e) {
+                    const err = e;
+                    // Only if the error is "not-found" then we return false otherwise we re-throw the error
+                    if ((err === null || err === void 0 ? void 0 : err.status) === 404) {
+                        return false;
+                    }
+                    throw e;
+                }
+            }
+            if (type !== 'sequence') {
+                throw new error_1.BeeError('Only Sequence type of Feeds is supported at the moment');
+            }
+            return (0, retrievable_1.areAllSequentialFeedsUpdateRetrievable)(this, canonicalOwner, canonicalTopic, index, options);
+        });
+    }
     /**
      * Send data to recipient or target with Postal Service for Swarm.
      *

package/dist/cjs/feed/identifier.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeFeedIdentifier = void 0;
+const types_1 = require("../types");
+const hash_1 = require("../utils/hash");
+const hex_1 = require("../utils/hex");
+const uint64_1 = require("../utils/uint64");
+function isEpoch(epoch) {
+    return typeof epoch === 'object' && epoch !== null && 'time' in epoch && 'level' in epoch;
+}
+function hashFeedIdentifier(topic, index) {
+    return (0, hash_1.keccak256Hash)((0, hex_1.hexToBytes)(topic), index);
+}
+function makeSequentialFeedIdentifier(topic, index) {
+    const indexBytes = (0, uint64_1.writeUint64BigEndian)(index);
+    return hashFeedIdentifier(topic, indexBytes);
+}
+function makeFeedIndexBytes(s) {
+    const hex = (0, hex_1.makeHexString)(s, types_1.FEED_INDEX_HEX_LENGTH);
+    return (0, hex_1.hexToBytes)(hex);
+}
+function makeFeedIdentifier(topic, index) {
+    if (typeof index === 'number') {
+        return makeSequentialFeedIdentifier(topic, index);
+    }
+    else if (typeof index === 'string') {
+        const indexBytes = makeFeedIndexBytes(index);
+        return hashFeedIdentifier(topic, indexBytes);
+    }
+    else if (isEpoch(index)) {
+        throw new TypeError('epoch is not yet implemented');
+    }
+    return hashFeedIdentifier(topic, index);
+}
+exports.makeFeedIdentifier = makeFeedIdentifier;

package/dist/cjs/feed/index.js

@@ -28,11 +28,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeFeedWriter = exports.makeFeedReader = exports.downloadFeedUpdate = exports.verifyChunkReference = exports.updateFeed = exports.findNextIndex = exports.uploadFeedUpdate = exports.makeFeedIdentifier = exports.makeFeedIndexBytes = exports.makeSequentialFeedIdentifier = exports.isEpoch = void 0;
+exports.makeFeedWriter = exports.makeFeedReader = exports.downloadFeedUpdate = exports.getFeedUpdateChunkReference = exports.updateFeed = exports.findNextIndex = void 0;
 const hash_1 = require("../utils/hash");
 const serialize_1 = require("../chunk/serialize");
-const soc_1 = require("../chunk/soc");
 const feed_1 = require("../modules/feed");
+const soc_1 = require("../chunk/soc");
 const types_1 = require("../types");
 const bytes_1 = require("../utils/bytes");
 const error_1 = require("../utils/error");
@@ -41,59 +41,16 @@ const uint64_1 = require("../utils/uint64");
 const chunkAPI = __importStar(require("../modules/chunk"));
 const eth_1 = require("../utils/eth");
 const type_1 = require("../utils/type");
+const identifier_1 = require("./identifier");
+const reference_1 = require("../utils/reference");
 const TIMESTAMP_PAYLOAD_OFFSET = 0;
 const TIMESTAMP_PAYLOAD_SIZE = 8;
 const REFERENCE_PAYLOAD_OFFSET = TIMESTAMP_PAYLOAD_SIZE;
-const REFERENCE_PAYLOAD_MIN_SIZE = 32;
-const REFERENCE_PAYLOAD_MAX_SIZE = 64;
-const INDEX_HEX_LENGTH = 16;
-function isEpoch(epoch) {
-    return typeof epoch === 'object' && epoch !== null && 'time' in epoch && 'level' in epoch;
-}
-exports.isEpoch = isEpoch;
-function hashFeedIdentifier(topic, index) {
-    return (0, hash_1.keccak256Hash)((0, hex_1.hexToBytes)(topic), index);
-}
-function makeSequentialFeedIdentifier(topic, index) {
-    const indexBytes = (0, uint64_1.writeUint64BigEndian)(index);
-    return hashFeedIdentifier(topic, indexBytes);
-}
-exports.makeSequentialFeedIdentifier = makeSequentialFeedIdentifier;
-function makeFeedIndexBytes(s) {
-    const hex = (0, hex_1.makeHexString)(s, INDEX_HEX_LENGTH);
-    return (0, hex_1.hexToBytes)(hex);
-}
-exports.makeFeedIndexBytes = makeFeedIndexBytes;
-function makeFeedIdentifier(topic, index) {
-    if (typeof index === 'number') {
-        return makeSequentialFeedIdentifier(topic, index);
-    }
-    else if (typeof index === 'string') {
-        const indexBytes = makeFeedIndexBytes(index);
-        return hashFeedIdentifier(topic, indexBytes);
-    }
-    else if (isEpoch(index)) {
-        throw new TypeError('epoch is not yet implemented');
-    }
-    return hashFeedIdentifier(topic, index);
-}
-exports.makeFeedIdentifier = makeFeedIdentifier;
-function uploadFeedUpdate(ky, signer, topic, index, reference, postageBatchId, options) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        const identifier = makeFeedIdentifier(topic, index);
-        const at = (_a = options === null || options === void 0 ? void 0 : options.at) !== null && _a !== void 0 ? _a : Date.now() / 1000.0;
-        const timestamp = (0, uint64_1.writeUint64BigEndian)(at);
-        const payloadBytes = (0, serialize_1.serializeBytes)(timestamp, reference);
-        return (0, soc_1.uploadSingleOwnerChunkData)(ky, signer, postageBatchId, identifier, payloadBytes, options);
-    });
-}
-exports.uploadFeedUpdate = uploadFeedUpdate;
 function findNextIndex(ky, owner, topic, options) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const feedUpdate = yield (0, feed_1.fetchFeedUpdate)(ky, owner, topic, options);
-            return (0, hex_1.makeHexString)(feedUpdate.feedIndexNext, INDEX_HEX_LENGTH);
+            const feedUpdate = yield (0, feed_1.fetchLatestFeedUpdate)(ky, owner, topic, options);
+            return (0, hex_1.makeHexString)(feedUpdate.feedIndexNext, types_1.FEED_INDEX_HEX_LENGTH);
         }
         catch (e) {
             if (e instanceof error_1.BeeResponseError && e.status === 404) {
@@ -104,37 +61,34 @@ function findNextIndex(ky, owner, topic, options) {
     });
 }
 exports.findNextIndex = findNextIndex;
-function updateFeed(ky, signer, topic, reference, postageBatchId, options) {
+function updateFeed(ky, signer, topic, reference, postageBatchId, options, index = 'latest') {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const ownerHex = (0, eth_1.makeHexEthAddress)(signer.address);
-        const nextIndex = yield findNextIndex(ky, ownerHex, topic, options);
-        return uploadFeedUpdate(ky, signer, topic, nextIndex, reference, postageBatchId, options);
+        const nextIndex = index === 'latest' ? yield findNextIndex(ky, ownerHex, topic, options) : index;
+        const identifier = (0, identifier_1.makeFeedIdentifier)(topic, nextIndex);
+        const at = (_a = options === null || options === void 0 ? void 0 : options.at) !== null && _a !== void 0 ? _a : Date.now() / 1000.0;
+        const timestamp = (0, uint64_1.writeUint64BigEndian)(at);
+        const payloadBytes = (0, serialize_1.serializeBytes)(timestamp, reference);
+        return (0, soc_1.uploadSingleOwnerChunkData)(ky, signer, postageBatchId, identifier, payloadBytes, options);
     });
 }
 exports.updateFeed = updateFeed;
-function verifyChunkReferenceAtOffset(offset, data) {
-    try {
-        return (0, bytes_1.bytesAtOffset)(data, offset, REFERENCE_PAYLOAD_MAX_SIZE);
-    }
-    catch (e) {
-        return (0, bytes_1.bytesAtOffset)(data, offset, REFERENCE_PAYLOAD_MIN_SIZE);
-    }
-}
-function verifyChunkReference(data) {
-    return verifyChunkReferenceAtOffset(0, data);
+function getFeedUpdateChunkReference(owner, topic, index) {
+    const identifier = (0, identifier_1.makeFeedIdentifier)(topic, index);
+    return (0, hash_1.keccak256Hash)(identifier, owner);
 }
-exports.verifyChunkReference = verifyChunkReference;
+exports.getFeedUpdateChunkReference = getFeedUpdateChunkReference;
 function downloadFeedUpdate(ky, owner, topic, index) {
     return __awaiter(this, void 0, void 0, function* () {
-        const identifier = makeFeedIdentifier(topic, index);
-        const address = (0, hash_1.keccak256Hash)(identifier, owner);
+        const address = getFeedUpdateChunkReference(owner, topic, index);
         const addressHex = (0, hex_1.bytesToHex)(address);
         const data = yield chunkAPI.download(ky, addressHex);
         const soc = (0, soc_1.makeSingleOwnerChunkFromData)(data, address);
         const payload = soc.payload();
         const timestampBytes = (0, bytes_1.bytesAtOffset)(payload, TIMESTAMP_PAYLOAD_OFFSET, TIMESTAMP_PAYLOAD_SIZE);
         const timestamp = (0, uint64_1.readUint64BigEndian)(timestampBytes);
-        const reference = verifyChunkReferenceAtOffset(REFERENCE_PAYLOAD_OFFSET, payload);
+        const reference = (0, reference_1.makeBytesReference)(payload, REFERENCE_PAYLOAD_OFFSET);
         return {
             timestamp,
             reference,
@@ -143,40 +97,30 @@ function downloadFeedUpdate(ky, owner, topic, index) {
 }
 exports.downloadFeedUpdate = downloadFeedUpdate;
 function makeFeedReader(ky, type, topic, owner) {
-    const download = (options) => __awaiter(this, void 0, void 0, function* () { return (0, feed_1.fetchFeedUpdate)(ky, owner, topic, Object.assign(Object.assign({}, options), { type })); });
     return {
         type,
         owner,
         topic,
-        download,
+        download(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (!(options === null || options === void 0 ? void 0 : options.index)) {
+                    return (0, feed_1.fetchLatestFeedUpdate)(ky, owner, topic, Object.assign(Object.assign({}, options), { type }));
+                }
+                const update = yield downloadFeedUpdate(ky, (0, hex_1.hexToBytes)(owner), topic, options.index);
+                return {
+                    reference: (0, hex_1.bytesToHex)(update.reference),
+                    feedIndex: options.index,
+                    feedIndexNext: '',
+                };
+            });
+        },
     };
 }
 exports.makeFeedReader = makeFeedReader;
-function makeChunkReference(reference) {
-    if (typeof reference === 'string') {
-        try {
-            // Non-encrypted chunk hex string reference
-            const hexReference = (0, hex_1.makeHexString)(reference, types_1.REFERENCE_HEX_LENGTH);
-            return (0, hex_1.hexToBytes)(hexReference);
-        }
-        catch (e) {
-            if (!(e instanceof TypeError)) {
-                throw e;
-            }
-            // Encrypted chunk hex string reference
-            const hexReference = (0, hex_1.makeHexString)(reference, types_1.ENCRYPTED_REFERENCE_HEX_LENGTH);
-            return (0, hex_1.hexToBytes)(hexReference);
-        }
-    }
-    else if (reference instanceof Uint8Array) {
-        return verifyChunkReference(reference);
-    }
-    throw new TypeError('invalid chunk reference');
-}
 function makeFeedWriter(ky, type, topic, signer) {
     const upload = (postageBatchId, reference, options) => __awaiter(this, void 0, void 0, function* () {
         (0, type_1.assertAddress)(postageBatchId);
-        const canonicalReference = makeChunkReference(reference);
+        const canonicalReference = (0, reference_1.makeBytesReference)(reference);
         return updateFeed(ky, signer, topic, canonicalReference, postageBatchId, Object.assign(Object.assign({}, options), { type }));
     });
     return Object.assign(Object.assign({}, makeFeedReader(ky, type, topic, (0, eth_1.makeHexEthAddress)(signer.address))), { upload });

package/dist/cjs/feed/retrievable.js

@@ -0,0 +1,72 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areAllSequentialFeedsUpdateRetrievable = void 0;
+const index_1 = require("./index");
+const uint64_1 = require("../utils/uint64");
+const hex_1 = require("../utils/hex");
+function makeNumericIndex(index) {
+    if (index instanceof Uint8Array) {
+        return (0, uint64_1.readUint64BigEndian)(index);
+    }
+    if (typeof index === 'string') {
+        return parseInt(index);
+    }
+    if (typeof index === 'number') {
+        return index;
+    }
+    throw new TypeError('Unknown type of index!');
+}
+/**
+ * Function that checks if a chunk is retrievable by actually downloading it.
+ * The /stewardship/{reference} endpoint does not support verification of chunks, but only manifest's references.
+ *
+ * @param bee
+ * @param ref
+ * @param options
+ */
+function isChunkRetrievable(bee, ref, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield bee.downloadChunk(ref, options);
+            return true;
+        }
+        catch (e) {
+            const err = e;
+            if (err.status === 404) {
+                return false;
+            }
+            throw e;
+        }
+    });
+}
+/**
+ * Creates array of references for all sequence updates chunk up to the given index.
+ *
+ * @param owner
+ * @param topic
+ * @param index
+ */
+function getAllSequenceUpdateReferences(owner, topic, index) {
+    const numIndex = makeNumericIndex(index);
+    const updateReferences = new Array(numIndex + 1);
+    for (let i = 0; i <= numIndex; i++) {
+        updateReferences[i] = (0, hex_1.bytesToHex)((0, index_1.getFeedUpdateChunkReference)(owner, topic, i));
+    }
+    return updateReferences;
+}
+function areAllSequentialFeedsUpdateRetrievable(bee, owner, topic, index, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const chunkRetrievablePromises = getAllSequenceUpdateReferences(owner, topic, index).map((ref) => __awaiter(this, void 0, void 0, function* () { return isChunkRetrievable(bee, ref, options); }));
+        return (yield Promise.all(chunkRetrievablePromises)).every(result => result);
+    });
+}
+exports.areAllSequentialFeedsUpdateRetrievable = areAllSequentialFeedsUpdateRetrievable;

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

@@ -17,9 +17,9 @@ const http_1 = require("../../utils/http");
 const major_js_1 = __importDefault(require("semver/functions/major.js"));
 // Following lines bellow are automatically updated with GitHub Action when Bee version is updated
 // so if you are changing anything about them change the `update_bee` action accordingly!
-exports.SUPPORTED_BEE_VERSION_EXACT = '1.5.0-dda5606e';
-exports.SUPPORTED_API_VERSION = '3.0.0';
-exports.SUPPORTED_DEBUG_API_VERSION = '2.0.0';
+exports.SUPPORTED_BEE_VERSION_EXACT = '1.6.0-6ceadd35';
+exports.SUPPORTED_API_VERSION = '3.0.1';
+exports.SUPPORTED_DEBUG_API_VERSION = '2.0.1';
 exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT.substring(0, exports.SUPPORTED_BEE_VERSION_EXACT.indexOf('-'));
 const NODE_INFO_URL = 'node';
 const HEALTH_URL = 'health';

package/dist/cjs/modules/feed.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchFeedUpdate = exports.createFeedManifest = void 0;
+exports.fetchLatestFeedUpdate = exports.createFeedManifest = void 0;
 const http_1 = require("../utils/http");
 const headers_1 = require("../utils/headers");
 const error_1 = require("../utils/error");
@@ -63,7 +63,7 @@ function readFeedUpdateHeaders(headers) {
  * @param topic       Topic in hex
  * @param options     Additional options, like index, at, type
  */
-function fetchFeedUpdate(ky, owner, topic, options) {
+function fetchLatestFeedUpdate(ky, owner, topic, options) {
     return __awaiter(this, void 0, void 0, function* () {
         const response = yield (0, http_1.http)(ky, {
             responseType: 'json',
@@ -73,4 +73,4 @@ function fetchFeedUpdate(ky, owner, topic, options) {
         return Object.assign(Object.assign({}, response.data), readFeedUpdateHeaders(response.headers));
     });
 }
-exports.fetchFeedUpdate = fetchFeedUpdate;
+exports.fetchLatestFeedUpdate = fetchLatestFeedUpdate;

package/dist/cjs/types/index.js

@@ -10,7 +10,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.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.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;
@@ -34,6 +34,7 @@ exports.STAMPS_DEPTH_MIN = 17;
 exports.STAMPS_DEPTH_MAX = 255;
 exports.TAGS_LIMIT_MIN = 1;
 exports.TAGS_LIMIT_MAX = 1000;
+exports.FEED_INDEX_HEX_LENGTH = 16;
 /*********************************************************
  * Writers and Readers interfaces
  */

package/dist/cjs/utils/bytes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapBytesWithHelpers = exports.makeBytes = exports.bytesEqual = exports.flexBytesAtOffset = exports.bytesAtOffset = exports.assertFlexBytes = exports.isFlexBytes = exports.assertBytes = exports.isBytes = void 0;
+exports.wrapBytesWithHelpers = exports.makeBytes = exports.bytesEqual = exports.flexBytesAtOffset = exports.bytesAtOffset = exports.assertFlexBytes = exports.isFlexBytes = exports.assertBytes = exports.hasBytesAtOffset = exports.isBytes = void 0;
 const hex_1 = require("./hex");
 /**
  * Type guard for `Bytes<T>` type
@@ -12,6 +12,20 @@ function isBytes(b, length) {
     return b instanceof Uint8Array && b.length === length;
 }
 exports.isBytes = isBytes;
+/**
+ * Function that verifies if passed data are Bytes and if the array has "length" number of bytes under given offset.
+ * @param data
+ * @param offset
+ * @param length
+ */
+function hasBytesAtOffset(data, offset, length) {
+    if (!(data instanceof Uint8Array)) {
+        throw new TypeError('Data has to an Uint8Array!');
+    }
+    const offsetBytes = data.slice(offset, offset + length);
+    return isBytes(offsetBytes, length);
+}
+exports.hasBytesAtOffset = hasBytesAtOffset;
 /**
  * Verifies if a byte array has a certain length
  *