@ethersphere/bee-js 4.0.0 → 4.1.0

package/README.md

@@ -1,7 +1,6 @@
 # Bee-js
 
 [![Tests](https://github.com/ethersphere/bee-js/actions/workflows/tests.yaml/badge.svg)](https://github.com/ethersphere/bee-js/actions/workflows/tests.yaml)
-[![Dependency Status](https://david-dm.org/ethersphere/bee-js.svg?style=flat-square)](https://david-dm.org/ethersphere/bee-js)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fethersphere%2Fbee-js.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fbee-js?ref=badge_shield)
 [![](https://img.shields.io/badge/made%20by-Swarm-blue.svg?style=flat-square)](https://swarm.ethereum.org/)
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
@@ -110,25 +109,15 @@ npm i
 
 The tests run in both context: node and dom with Jest.
 
-To run the integration tests, you need to use our [`bee-factory`](https://github.com/ethersphere/bee-factory/) project. Clone the repo, you can use our prebuilt Docker images with setting env. variables like:
-
-```bash
-export BEE_VERSION="1.0.0-2572fa48"
-export BLOCKCHAIN_VERSION="1.2.0"
-export BEE_ENV_PREFIX="swarm-test"
-export BEE_IMAGE_PREFIX="docker.pkg.github.com/ethersphere/bee-factory"
-```
-
-Customize these values based on which Bee version you want to run. After the env. variables are set use the `./scripts/environment.sh` script with `start` parameter.
+To run the integration tests, you need to spin up local Bee cluster using our [`bee-factory`](https://github.com/ethersphere/bee-factory/) project.
+In order to do that you have to have locally Docker running on your machine, but afterwards you can just simply run `npm run bee`, which spins up the
+cluster and display Queen's logs. If you want to exit hit `CTRL+C`.
 
 If you want to skip creation of postage stamps every run of integration tests you can create stamps for both nodes and set them under env. variables `BEE_POSTAGE` and `BEE_PEER_POSTAGE`.
 
 By default, for integration tests two bee nodes are expected to run on localhost on addresses `http://localhost:1633` and `http://localhost:11633`. These are the default values for the `bee-factory` script.
 If you want to use custom setup, you can change the behavior of tests to different addresses using environment variables `BEE_API_URL`, `BEE_DEBUG_API_URL`, `BEE_PEER_DEBUG_API_URL` and `BEE_PEER_API_URL`.
 
-In Visual Studio environment, the tests have been set up to run against your local bee node on `http://localhost:1633`
-To run Jest tests, choose the `vscode-jest-tests` CI job under the Run tab.
-
 There are also browser tests by Puppeteer, which also provide integrity testing.
 ```sh
 npm run test:browser

package/dist/cjs/{bee-debug.js → src/bee-debug.js}

@@ -43,6 +43,7 @@ const types_1 = require("./types");
 const tag = __importStar(require("./modules/debug/tag"));
 const stamps = __importStar(require("./modules/debug/stamps"));
 const http_1 = require("./utils/http");
+const utils_1 = require("../test/utils");
 class BeeDebug {
     constructor(url, options) {
         var _a;
@@ -431,6 +432,17 @@ class BeeDebug {
             return states.getChainState(this.getKy(options));
         });
     }
+    /**
+     * Get wallet balances for xDai and BZZ of the Bee node
+     *
+     * @param options
+     */
+    getWalletBalance(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, type_1.assertRequestOptions)(options);
+            return states.getWalletBalance(this.getKy(options));
+        });
+    }
     /**
      * Creates new postage batch from the funds that the node has available in its Ethereum account.
      *
@@ -450,8 +462,8 @@ class BeeDebug {
      */
     createPostageBatch(amount, depth, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, type_1.assertRequestOptions)(options);
-            (0, type_1.assertNonNegativeInteger)(amount);
+            (0, type_1.assertPostageBatchOptions)(options);
+            (0, type_1.assertPositiveInteger)(amount);
             (0, type_1.assertNonNegativeInteger)(depth);
             if (depth < types_1.STAMPS_DEPTH_MIN) {
                 throw new error_1.BeeArgumentError(`Depth has to be at least ${types_1.STAMPS_DEPTH_MIN}`, depth);
@@ -459,13 +471,11 @@ class BeeDebug {
             if (depth > types_1.STAMPS_DEPTH_MAX) {
                 throw new error_1.BeeArgumentError(`Depth has to be at most ${types_1.STAMPS_DEPTH_MAX}`, depth);
             }
-            if (options === null || options === void 0 ? void 0 : options.gasPrice) {
-                (0, type_1.assertNonNegativeInteger)(options.gasPrice);
+            const stamp = yield stamps.createPostageBatch(this.getKy(options), amount, depth, options);
+            if (options === null || options === void 0 ? void 0 : options.waitForUsable) {
+                yield this.waitForUsablePostageStamp(stamp, options === null || options === void 0 ? void 0 : options.waitForUsableTimeout);
             }
-            if ((options === null || options === void 0 ? void 0 : options.immutableFlag) !== undefined) {
-                (0, type_1.assertBoolean)(options.immutableFlag);
-            }
-            return stamps.createPostageBatch(this.getKy(options), amount, depth, options);
+            return stamp;
         });
     }
     /**
@@ -605,6 +615,19 @@ class BeeDebug {
             return transactions.cancelTransaction(this.getKy(options), transactionHash, gasPrice);
         });
     }
+    waitForUsablePostageStamp(id, timeout = 120000) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const TIME_STEP = 1500;
+            for (let time = 0; time < timeout; time += TIME_STEP) {
+                const stamp = yield this.getPostageBatch(id);
+                if (stamp.usable) {
+                    return;
+                }
+                yield (0, utils_1.sleep)(TIME_STEP);
+            }
+            throw new error_1.BeeError('Timeout on waiting for postage stamp to become usable');
+        });
+    }
     getKy(options) {
         if (!options) {
             return this.ky;

package/dist/cjs/{bee.js → src/bee.js}

@@ -57,6 +57,7 @@ const types_1 = require("./types");
 const http_1 = require("./utils/http");
 const stream_1 = require("./utils/stream");
 const retrievable_1 = require("./feed/retrievable");
+const swarm_cid_1 = require("@ethersphere/swarm-cid");
 /**
  * The main component that abstracts operations available on the main Bee API.
  *
@@ -228,23 +229,23 @@ class Bee {
                 const fileName = name !== null && name !== void 0 ? name : data.name;
                 const contentType = data.type;
                 const fileOptions = Object.assign({ contentType }, options);
-                return bzz.uploadFile(this.getKy(options), fileData, postageBatchId, fileName, fileOptions);
+                return (0, type_2.addCidConversionFunction)(yield bzz.uploadFile(this.getKy(options), fileData, postageBatchId, fileName, fileOptions), swarm_cid_1.ReferenceType.MANIFEST);
             }
             else if ((0, stream_1.isReadable)(data) && (options === null || options === void 0 ? void 0 : options.tag) && !options.size) {
                 // TODO: Needed until https://github.com/ethersphere/bee/issues/2317 is resolved
                 const result = yield bzz.uploadFile(this.getKy(options), data, postageBatchId, name, options);
                 yield this.updateTag(options.tag, result.reference);
-                return result;
+                return (0, type_2.addCidConversionFunction)(result, swarm_cid_1.ReferenceType.MANIFEST);
             }
             else {
-                return bzz.uploadFile(this.getKy(options), data, postageBatchId, name, options);
+                return (0, type_2.addCidConversionFunction)(yield bzz.uploadFile(this.getKy(options), data, postageBatchId, name, options), swarm_cid_1.ReferenceType.MANIFEST);
             }
         });
     }
     /**
      * Download single file.
      *
-     * @param reference Bee file reference in hex string (either 64 or 128 chars long) or ENS domain.
+     * @param reference Bee file reference in hex string (either 64 or 128 chars long), ENS domain or Swarm CID.
      * @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
@@ -256,14 +257,14 @@ class Bee {
     downloadFile(reference, path = '', options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReferenceOrEns)(reference);
+            reference = (0, type_2.makeReferenceOrEns)(reference, swarm_cid_1.ReferenceType.MANIFEST);
             return bzz.downloadFile(this.getKy(options), reference, path);
         });
     }
     /**
      * Download single file as a readable stream
      *
-     * @param reference Bee file reference in hex string (either 64 or 128 chars long) or ENS domain.
+     * @param reference Bee file reference in hex string (either 64 or 128 chars long), ENS domain or Swarm CID.
      * @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
@@ -275,7 +276,7 @@ class Bee {
     downloadReadableFile(reference, path = '', options) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, type_2.assertRequestOptions)(options);
-            (0, type_2.assertReferenceOrEns)(reference);
+            reference = (0, type_2.makeReferenceOrEns)(reference, swarm_cid_1.ReferenceType.MANIFEST);
             return bzz.downloadFileReadable(this.getKy(options), reference, path);
         });
     }
@@ -301,7 +302,7 @@ class Bee {
             if (options)
                 (0, type_2.assertCollectionUploadOptions)(options);
             const data = yield (0, collection_1.makeCollectionFromFileList)(fileList);
-            return bzz.uploadCollection(this.getKy(options), data, postageBatchId, options);
+            return (0, type_2.addCidConversionFunction)(yield bzz.uploadCollection(this.getKy(options), data, postageBatchId, options), swarm_cid_1.ReferenceType.MANIFEST);
         });
     }
     /**
@@ -320,7 +321,7 @@ class Bee {
             (0, collection_1.assertCollection)(collection);
             if (options)
                 (0, type_2.assertCollectionUploadOptions)(options);
-            return bzz.uploadCollection(this.ky, collection, postageBatchId, options);
+            return (0, type_2.addCidConversionFunction)(yield bzz.uploadCollection(this.ky, collection, postageBatchId, options), swarm_cid_1.ReferenceType.MANIFEST);
         });
     }
     /**
@@ -345,7 +346,7 @@ class Bee {
             if (options)
                 (0, type_2.assertCollectionUploadOptions)(options);
             const data = yield (0, collection_node_1.makeCollectionFromFS)(dir);
-            return bzz.uploadCollection(this.getKy(options), data, postageBatchId, options);
+            return (0, type_2.addCidConversionFunction)(yield bzz.uploadCollection(this.getKy(options), data, postageBatchId, options), swarm_cid_1.ReferenceType.MANIFEST);
         });
     }
     /**
@@ -760,6 +761,7 @@ class Bee {
      *
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
      * @see [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post)
+     * TODO: Once breaking add support for Feed CID
      */
     createFeedManifest(postageBatchId, type, topic, owner, options) {
         return __awaiter(this, void 0, void 0, function* () {

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/{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/{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.assertReferenceOrEns = 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);
@@ -102,8 +109,22 @@ function assertReferenceOrEns(value) {
      * 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]{1,63}(?<!-)\.)+(?!-)[^.\/?:\s]{2,63}(?<!-)$/;
+    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.
@@ -112,6 +133,43 @@ function assertReferenceOrEns(value) {
     }
 }
 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');
 }
@@ -256,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) {