@ethersphere/bee-js 3.3.4 → 4.1.0

package/dist/cjs/src/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 → src/modules}/debug/states.js

@@ -9,9 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getChainState = exports.getReserveState = void 0;
+exports.getWalletBalance = exports.getChainState = exports.getReserveState = void 0;
 const http_1 = require("../../utils/http");
 const RESERVE_STATE_ENDPOINT = 'reservestate';
+const WALLET_ENDPOINT = 'wallet';
 const CHAIN_STATE_ENDPOINT = 'chainstate';
 /**
  * Get state of reserve
@@ -45,3 +46,19 @@ function getChainState(ky) {
     });
 }
 exports.getChainState = getChainState;
+/**
+ * Get wallet balances for xDai and BZZ of the node
+ *
+ * @param ky Ky debug instance
+ */
+function getWalletBalance(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: `${WALLET_ENDPOINT}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getWalletBalance = getWalletBalance;

package/dist/cjs/{modules → src/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.1-d0a77598';
-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 → src/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 → src/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 → src/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
  *

package/dist/cjs/{utils → src/utils}/http.js

@@ -154,6 +154,12 @@ function http(ky, config) {
                 throw new error_1.BeeRequestError(e.message, config);
             }
             else {
+                // Node 18 has native `fetch` implementation called Undici. Errors from this implementation have top level generic
+                // message "fetch failed" with the more specific error placed into `cause` property. Instead of "fetch failed" we
+                // expose the underlying problem.
+                if (e.cause) {
+                    throw new error_1.BeeError(e.cause.message);
+                }
                 throw new error_1.BeeError(e.message);
             }
         }

package/dist/cjs/src/utils/reference.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBytesReference = void 0;
+const types_1 = require("../types");
+const bytes_1 = require("./bytes");
+const hex_1 = require("./hex");
+function makeBytesReference(reference, offset = 0) {
+    if (typeof reference === 'string') {
+        if (offset) {
+            throw new Error('Offset property can be set only for UintArray reference!');
+        }
+        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) {
+        if ((0, bytes_1.hasBytesAtOffset)(reference, offset, types_1.ENCRYPTED_REFERENCE_BYTES_LENGTH)) {
+            return (0, bytes_1.bytesAtOffset)(reference, offset, types_1.ENCRYPTED_REFERENCE_BYTES_LENGTH);
+        }
+        else if ((0, bytes_1.hasBytesAtOffset)(reference, offset, types_1.REFERENCE_BYTES_LENGTH)) {
+            return (0, bytes_1.bytesAtOffset)(reference, offset, types_1.REFERENCE_BYTES_LENGTH);
+        }
+    }
+    throw new TypeError('invalid chunk reference');
+}
+exports.makeBytesReference = makeBytesReference;

package/dist/cjs/{utils → src/utils}/type.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertTransactionHash = exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertPostageBatchOptions = exports.assertPublicKey = exports.assertPssMessageHandler = exports.assertAddressPrefix = exports.assertTag = exports.isTag = exports.assertCollectionUploadOptions = exports.assertFileUploadOptions = exports.assertUploadOptions = exports.assertRequestOptions = exports.assertBatchId = exports.assertAddress = exports.assertReference = exports.assertNonNegativeInteger = exports.assertInteger = exports.assertBoolean = exports.assertStrictlyObject = exports.isError = exports.isStrictlyObject = exports.isObject = exports.isInteger = exports.isUint8Array = void 0;
+exports.assertTransactionHash = exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertPostageBatchOptions = exports.assertPublicKey = exports.assertPssMessageHandler = exports.assertAddressPrefix = exports.assertTag = exports.isTag = exports.assertCollectionUploadOptions = exports.assertFileUploadOptions = exports.assertUploadOptions = exports.assertRequestOptions = exports.assertBatchId = exports.assertAddress = exports.addCidConversionFunction = exports.makeReferenceOrEns = exports.assertReferenceOrEns = exports.assertReference = exports.assertPositiveInteger = exports.assertNonNegativeInteger = exports.assertInteger = exports.assertBoolean = exports.assertStrictlyObject = exports.isError = exports.isStrictlyObject = exports.isObject = exports.isInteger = exports.isUint8Array = void 0;
 const types_1 = require("../types");
 const error_1 = require("./error");
 const file_1 = require("./file");
 const hex_1 = require("./hex");
 const stream_1 = require("./stream");
+const swarm_cid_1 = require("@ethersphere/swarm-cid");
 function isUint8Array(obj) {
     return obj instanceof Uint8Array;
 }
@@ -68,6 +69,12 @@ function assertNonNegativeInteger(value, name = 'Value') {
         throw new error_1.BeeArgumentError(`${name} has to be bigger or equal to zero`, value);
 }
 exports.assertNonNegativeInteger = assertNonNegativeInteger;
+function assertPositiveInteger(value, name = 'Value') {
+    assertInteger(value, name);
+    if (Number(value) <= 0)
+        throw new error_1.BeeArgumentError(`${name} has to be bigger then zero`, value);
+}
+exports.assertPositiveInteger = assertPositiveInteger;
 function assertReference(value) {
     try {
         (0, hex_1.assertHexString)(value, types_1.REFERENCE_HEX_LENGTH);
@@ -77,6 +84,92 @@ function assertReference(value) {
     }
 }
 exports.assertReference = assertReference;
+function assertReferenceOrEns(value) {
+    if (typeof value !== 'string') {
+        throw new TypeError('ReferenceOrEns has to be a string!');
+    }
+    if ((0, hex_1.isHexString)(value)) {
+        assertReference(value);
+        return;
+    }
+    /**
+     * a.asdf - VALID
+     * test.eth - VALID
+     * ADAM.ETH - VALID
+     * ADAM UHLIR.ETH - INVALID
+     * test.whatever.eth - VALID
+     * -adg.ets - INVALID
+     * adg-.ets - INVALID
+     * as-a.com - VALID
+     * ethswarm.org - VALID
+     * http://asdf.asf - INVALID
+     * řš+ýí.šě+ř.čě - VALID
+     * tsg.asg?asg - INVALID
+     * tsg.asg:1599 - INVALID
+     * ethswarm.something- - INVALID
+     * ethswarm.-something - INVALID
+     * ethswarm.some-thing - VALID
+     *
+     * The idea of this regex is to match strings that are 1 to 63 characters long and do not start or end with dash character
+     *
+     * This part matches 2-63 character string that does not start or end with -
+     * [^-.\/?:\s][^.\/?:\s]{0,61}[^-.\/?:\s]   <regexp1>
+     *
+     * For 1 character long string we use the part after |
+     * [^-.\/?:\s]   <regexp2>
+     *
+     * This is terminated in a group with . character an repeated at least once
+     * (<regexp1>|<regexp2>\.)+
+     *
+     * This covers everything but top level domain which is 2 to 63 characters long so we can just use the <regexp2> again
+     * ^(<regexp1>|<regexp2>\.)+<regexp1>$
+     */
+    const DOMAIN_REGEX = /^(?:(?:[^-.\/?:\s][^.\/?:\s]{0,61}[^-.\/?:\s]|[^-.\/?:\s]{1,2})\.)+[^-.\/?:\s][^.\/?:\s]{0,61}[^-.\/?:\s]$/;
+    // We are doing best-effort validation of domain here. The proper way would be to do validation using IDNA UTS64 standard
+    // but that would give us high penalty to our dependencies as the library (idna-uts46-hx) that does this validation and translation
+    // adds 160kB minified size which is significant. We expects that full validation will be done on Bee side.
+    if (!DOMAIN_REGEX.test(value)) {
+        throw new TypeError('ReferenceOrEns is not valid Reference, but also not valid ENS domain.');
+    }
+}
+exports.assertReferenceOrEns = assertReferenceOrEns;
+/**
+ * Function that mainly converts Swarm CID into hex encoded Swarm Reference
+ *
+ * @param value
+ * @param expectedCidType
+ */
+function makeReferenceOrEns(value, expectedCidType) {
+    var _a;
+    if (typeof value !== 'string') {
+        throw new TypeError('ReferenceCidOrEns has to be a string!');
+    }
+    try {
+        const result = (0, swarm_cid_1.decodeCid)(value);
+        if (result.type !== expectedCidType) {
+            throw new error_1.BeeError(`CID was expected to be of type ${expectedCidType}, but got instead ${(_a = result.type) !== null && _a !== void 0 ? _a : 'non-Swarm CID'}`);
+        }
+        return result.reference;
+    }
+    catch (e) {
+        if (e instanceof error_1.BeeError)
+            throw e;
+    }
+    assertReferenceOrEns(value);
+    return value;
+}
+exports.makeReferenceOrEns = makeReferenceOrEns;
+/**
+ * Function that adds getter which converts the reference into CID base32 encoded string.
+ * @param result
+ * @param cidType Type as described in the @ethersphere/swarm-cids-js -> ReferenceType
+ */
+function addCidConversionFunction(result, cidType) {
+    return Object.assign(Object.assign({}, result), { get cid() {
+            return (0, swarm_cid_1.encodeReference)(result.reference, cidType).toString();
+        } });
+}
+exports.addCidConversionFunction = addCidConversionFunction;
 function assertAddress(value) {
     (0, hex_1.assertHexString)(value, types_1.ADDRESS_HEX_LENGTH, 'Address');
 }
@@ -221,6 +314,12 @@ function assertPostageBatchOptions(value) {
     if ((options === null || options === void 0 ? void 0 : options.immutableFlag) !== undefined) {
         assertBoolean(options.immutableFlag);
     }
+    if ((options === null || options === void 0 ? void 0 : options.waitForUsable) !== undefined) {
+        assertBoolean(options.waitForUsable);
+    }
+    if ((options === null || options === void 0 ? void 0 : options.waitForUsableTimeout) !== undefined) {
+        assertNonNegativeInteger(options.waitForUsableTimeout, 'options.waitForUsableTimeout');
+    }
 }
 exports.assertPostageBatchOptions = assertPostageBatchOptions;
 function assertCashoutOptions(value) {