@ethersphere/bee-js 4.1.1 → 5.1.0

package/README.md

@@ -6,14 +6,14 @@
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 ![](https://img.shields.io/badge/npm-%3E%3D6.9.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D12.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D14.0.0-orange.svg?style=flat-square)
 ![](https://img.shields.io/badge/runs%20in-browser%20%7C%20node%20%7C%20webworker%20%7C%20electron-orange)
 
 > Client library for connecting to Bee decentralised storage
 
 **Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**
 
-This project is intended to be used with **Bee version 1.3.0**. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the [releases tab](https://github.com/ethersphere/bee-js/releases).
+This project is intended to be used with **Bee version <!-- SUPPORTED_BEE_START -->1.7.0<!-- SUPPORTED_BEE_END -->**. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the [releases tab](https://github.com/ethersphere/bee-js/releases).
 
 ## Table of Contents
 
@@ -71,14 +71,15 @@ Loading this module through a script tag will make the `BeeJs` object available
 ## Usage
 
 ```js
-import { Bee } from "@ethersphere/bee-js"
+import { Bee, BeeDebug } from '@ethersphere/bee-js'
 
-bee = new Bee("http://localhost:1633")
+const bee = new Bee('http://localhost:1633')
+const beeDebug = new BeeDebug('http://localhost:1635')
 
 // Be aware, this creates on-chain transactions that spend Eth and BZZ!
-const batchId = await bee.createPostageBatch('100', 17)
-const fileHash = await bee.uploadData(batchId, "Bee is awesome!")
-const data = await bee.downloadData(fileHash)
+const batchId = await beeDebug.createPostageBatch('2000', 20)
+const { reference } = await bee.uploadData(batchId, 'Bee is awesome!')
+const data = await bee.downloadData(reference)
 
 console.log(data.text()) // prints 'Bee is awesome!'
 ```

package/dist/cjs/bee-debug.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -36,6 +40,7 @@ const settlements = __importStar(require("./modules/debug/settlements"));
 const status = __importStar(require("./modules/debug/status"));
 const transactions = __importStar(require("./modules/debug/transactions"));
 const states = __importStar(require("./modules/debug/states"));
+const stake = __importStar(require("./modules/debug/stake"));
 const error_1 = require("./utils/error");
 const url_1 = require("./utils/url");
 const type_1 = require("./utils/type");
@@ -323,6 +328,15 @@ class BeeDebug {
             return status.getHealth(this.getKy(options));
         });
     }
+    /**
+     * Get readiness of node
+     */
+    getReadiness(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, type_1.assertRequestOptions)(options);
+            return status.getReadiness(this.getKy(options));
+        });
+    }
     /**
      * Get mode information of node
      */
@@ -472,7 +486,7 @@ class BeeDebug {
                 throw new error_1.BeeArgumentError(`Depth has to be at most ${types_1.STAMPS_DEPTH_MAX}`, depth);
             }
             const stamp = yield stamps.createPostageBatch(this.getKy(options), amount, depth, options);
-            if (options === null || options === void 0 ? void 0 : options.waitForUsable) {
+            if ((options === null || options === void 0 ? void 0 : options.waitForUsable) !== false) {
                 yield this.waitForUsablePostageStamp(stamp, options === null || options === void 0 ? void 0 : options.waitForUsableTimeout);
             }
             return stamp;
@@ -615,6 +629,32 @@ class BeeDebug {
             return transactions.cancelTransaction(this.getKy(options), transactionHash, gasPrice);
         });
     }
+    /**
+     * Gets the staked amount of BZZ (in PLUR unit) as number string.
+     *
+     * @param options
+     */
+    getStake(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, type_1.assertRequestOptions)(options);
+            return stake.getStake(this.getKy(options));
+        });
+    }
+    /**
+     * Deposits given amount of BZZ token (in PLUR unit).
+     *
+     * Be aware that staked BZZ tokens can **not** be withdrawn.
+     *
+     * @param amount Amount of BZZ token (in PLUR unit) to be staked. Minimum is 100_000_000_000_000_000 PLUR (10 BZZ).
+     * @param options
+     */
+    depositStake(amount, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, type_1.assertRequestOptions)(options);
+            (0, type_1.assertTransactionOptions)(options);
+            yield stake.stake(this.getKy(options), amount, options);
+        });
+    }
     waitForUsablePostageStamp(id, timeout = 120000) {
         return __awaiter(this, void 0, void 0, function* () {
             const TIME_STEP = 1500;

package/dist/cjs/bee.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -761,7 +765,6 @@ 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* () {
@@ -770,7 +773,10 @@ class Bee {
             (0, type_2.assertBatchId)(postageBatchId);
             const canonicalTopic = (0, topic_1.makeTopic)(topic);
             const canonicalOwner = (0, eth_1.makeHexEthAddress)(owner);
-            return (0, feed_2.createFeedManifest)(this.getKy(options), canonicalOwner, canonicalTopic, postageBatchId, { type });
+            const reference = yield (0, feed_2.createFeedManifest)(this.getKy(options), canonicalOwner, canonicalTopic, postageBatchId, {
+                type,
+            });
+            return (0, type_2.addCidConversionFunction)({ reference }, swarm_cid_1.ReferenceType.FEED);
         });
     }
     /**

package/dist/cjs/chunk/soc.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/cjs/feed/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/cjs/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -27,7 +27,7 @@ function getPeers(ky) {
             path: 'peers',
             responseType: 'json',
         });
-        return response.data.peers || [];
+        return response.data.peers;
     });
 }
 exports.getPeers = getPeers;
@@ -37,7 +37,7 @@ function getBlocklist(ky) {
             path: 'blocklist',
             responseType: 'json',
         });
-        return response.data.peers || [];
+        return response.data.peers;
     });
 }
 exports.getBlocklist = getBlocklist;

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

@@ -0,0 +1,55 @@
+"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.stake = exports.getStake = void 0;
+const http_1 = require("../../utils/http");
+const STAKE_ENDPOINT = 'stake';
+/**
+ * Gets the staked amount
+ *
+ * @param ky Ky instance for given Bee class instance
+ */
+function getStake(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            responseType: 'json',
+            path: `${STAKE_ENDPOINT}`,
+        });
+        return response.data.stakedAmount.toString();
+    });
+}
+exports.getStake = getStake;
+/**
+ * Stake given amount of tokens.
+ *
+ * @param ky
+ * @param amount
+ * @param options
+ */
+function stake(ky, amount, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const headers = {};
+        if (options === null || options === void 0 ? void 0 : options.gasPrice) {
+            headers['gas-price'] = options.gasPrice.toString();
+        }
+        if (options === null || options === void 0 ? void 0 : options.gasLimit) {
+            headers['gas-limit'] = options.gasLimit.toString();
+        }
+        yield (0, http_1.http)(ky, {
+            method: 'post',
+            responseType: 'json',
+            path: `${STAKE_ENDPOINT}/deposit/${amount}`,
+            headers,
+        });
+    });
+}
+exports.stake = stake;

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

@@ -19,7 +19,7 @@ function getAllPostageBatches(ky) {
             path: `${STAMPS_ENDPOINT}`,
             responseType: 'json',
         });
-        return response.data.stamps || [];
+        return response.data.stamps;
     });
 }
 exports.getAllPostageBatches = getAllPostageBatches;

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

@@ -12,17 +12,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVersions = exports.isSupportedApiVersion = exports.isSupportedDebugApiVersion = exports.isSupportedMainApiVersion = exports.isSupportedExactVersion = exports.isSupportedVersion = exports.getNodeInfo = exports.getHealth = exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_DEBUG_API_VERSION = exports.SUPPORTED_API_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT = void 0;
+exports.getVersions = exports.isSupportedApiVersion = exports.isSupportedDebugApiVersion = exports.isSupportedMainApiVersion = exports.isSupportedExactVersion = exports.isSupportedVersion = exports.getNodeInfo = exports.getReadiness = exports.getHealth = exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_DEBUG_API_VERSION = exports.SUPPORTED_API_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT = void 0;
 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.6.0-6ceadd35';
-exports.SUPPORTED_API_VERSION = '3.0.1';
-exports.SUPPORTED_DEBUG_API_VERSION = '2.0.1';
+exports.SUPPORTED_BEE_VERSION_EXACT = '1.9.0-13a47043';
+exports.SUPPORTED_API_VERSION = '3.2.0';
+exports.SUPPORTED_DEBUG_API_VERSION = '3.2.0';
 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';
+const READINESS_URL = 'readiness';
 /**
  * Get health of node
  *
@@ -39,6 +40,26 @@ function getHealth(ky) {
     });
 }
 exports.getHealth = getHealth;
+/**
+ * Get readiness of node
+ *
+ * @param ky Ky debug instance
+ */
+function getReadiness(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const response = yield (0, http_1.http)(ky, {
+                method: 'get',
+                path: READINESS_URL,
+            });
+            return response.status === 200;
+        }
+        catch (_a) {
+            return false;
+        }
+    });
+}
+exports.getReadiness = getReadiness;
 /**
  * Get information about Bee node
  *
@@ -63,6 +84,7 @@ exports.getNodeInfo = getNodeInfo;
  * @returns true if the Bee node version is supported
  * @deprecated Use `isSupportedExactVersion` instead
  */
+// TODO: Remove on break
 function isSupportedVersion(ky) {
     return __awaiter(this, void 0, void 0, function* () {
         return isSupportedExactVersion(ky);

package/dist/cjs/modules/pinning.js

@@ -74,11 +74,7 @@ function getAllPins(ky) {
             responseType: 'json',
             path: `${PINNING_ENDPOINT}`,
         });
-        const result = response.data.references;
-        if (result === null) {
-            return [];
-        }
-        return result;
+        return response.data.references;
     });
 }
 exports.getAllPins = getAllPins;

package/dist/cjs/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/cjs/utils/type.js

@@ -1,6 +1,6 @@
 "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.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;
+exports.assertTransactionHash = exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertTransactionOptions = 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");
@@ -165,7 +165,7 @@ exports.makeReferenceOrEns = makeReferenceOrEns;
  * @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 Object.assign(Object.assign({}, result), { cid() {
             return (0, swarm_cid_1.encodeReference)(result.reference, cidType).toString();
         } });
 }
@@ -322,20 +322,29 @@ function assertPostageBatchOptions(value) {
     }
 }
 exports.assertPostageBatchOptions = assertPostageBatchOptions;
-function assertCashoutOptions(value) {
+function assertTransactionOptions(value, name = 'TransactionOptions') {
     if (value === undefined) {
         return;
     }
-    assertStrictlyObject(value);
+    assertStrictlyObject(value, name);
     const options = value;
-    assertRequestOptions(options, 'PostageBatchOptions');
     if (options === null || options === void 0 ? void 0 : options.gasLimit) {
-        assertNonNegativeInteger(options.gasLimit);
+        assertNonNegativeInteger(options.gasLimit, name);
     }
     if (options === null || options === void 0 ? void 0 : options.gasPrice) {
-        assertNonNegativeInteger(options.gasPrice);
+        assertNonNegativeInteger(options.gasPrice, name);
     }
 }
+exports.assertTransactionOptions = assertTransactionOptions;
+function assertCashoutOptions(value) {
+    if (value === undefined) {
+        return;
+    }
+    assertStrictlyObject(value);
+    const options = value;
+    assertRequestOptions(options, 'CashoutOptions');
+    assertTransactionOptions(options, 'CashoutOptions');
+}
 exports.assertCashoutOptions = assertCashoutOptions;
 /**
  * Check whether the given parameter is valid data to upload