@ethersphere/bee-js 5.0.0 → 5.1.1

package/dist/mjs/bee-debug.js

@@ -37,9 +37,10 @@ import * as settlements from "./modules/debug/settlements.js";
 import * as status from "./modules/debug/status.js";
 import * as transactions from "./modules/debug/transactions.js";
 import * as states from "./modules/debug/states.js";
+import * as stake from "./modules/debug/stake.js";
 import { BeeArgumentError, BeeError } from "./utils/error.js";
 import { assertBeeUrl, stripLastSlash } from "./utils/url.js";
-import { assertAddress, assertBatchId, assertCashoutOptions, assertNonNegativeInteger, assertPositiveInteger, assertPostageBatchOptions, assertRequestOptions, assertTransactionHash, isTag } from "./utils/type.js";
+import { assertAddress, assertBatchId, assertCashoutOptions, assertNonNegativeInteger, assertPositiveInteger, assertPostageBatchOptions, assertRequestOptions, assertTransactionHash, assertTransactionOptions, isTag } from "./utils/type.js";
 import { STAMPS_DEPTH_MAX, STAMPS_DEPTH_MIN } from "./types/index.js";
 import * as tag from "./modules/debug/tag.js";
 import * as stamps from "./modules/debug/stamps.js";
@@ -375,6 +376,17 @@ export class BeeDebug {
       return status.getHealth(this.getKy(options));
     });
   }
+  /**
+   * Get readiness of node
+   */
+
+
+  getReadiness(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+      assertRequestOptions(options);
+      return status.getReadiness(this.getKy(options));
+    });
+  }
   /**
    * Get mode information of node
    */
@@ -714,6 +726,36 @@ export 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* () {
+      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* () {
+      assertRequestOptions(options);
+      assertTransactionOptions(options);
+      yield stake.stake(this.getKy(options), amount, options);
+    });
+  }
 
   waitForUsablePostageStamp(id, timeout = 120000) {
     return __awaiter(this, void 0, void 0, function* () {

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

@@ -0,0 +1,78 @@
+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());
+  });
+};
+
+import { http } from "../../utils/http.js";
+const STAKE_ENDPOINT = 'stake';
+/**
+ * Gets the staked amount
+ *
+ * @param ky Ky instance for given Bee class instance
+ */
+
+export function getStake(ky) {
+  return __awaiter(this, void 0, void 0, function* () {
+    const response = yield http(ky, {
+      method: 'get',
+      responseType: 'json',
+      path: `${STAKE_ENDPOINT}`
+    });
+    return response.data.stakedAmount.toString();
+  });
+}
+/**
+ * Stake given amount of tokens.
+ *
+ * @param ky
+ * @param amount
+ * @param options
+ */
+
+export 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 http(ky, {
+      method: 'post',
+      responseType: 'json',
+      path: `${STAKE_ENDPOINT}/${amount}`,
+      headers
+    });
+  });
+}

package/dist/mjs/modules/debug/states.js

@@ -79,6 +79,21 @@ export function getWalletBalance(ky) {
       path: `${WALLET_ENDPOINT}`,
       responseType: 'json'
     });
-    return response.data;
+    return mapWalletProperties(response.data);
   });
+}
+/**
+ * TODO: Remove on next break
+ * @param data
+ */
+
+function mapWalletProperties(data) {
+  return Object.assign({
+    // @ts-ignore: Needed for backward compatibility mapping
+    bzz: data.bzzBalance,
+    // @ts-ignore: Needed for backward compatibility mapping
+    xDai: data.nativeTokenBalance,
+    // @ts-ignore: Needed for backward compatibility mapping
+    contractAddress: data.chequebookContractAddress
+  }, data);
 }

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

@@ -34,12 +34,13 @@ import { http } from "../../utils/http.js";
 import getMajorSemver from '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!
 
-export const SUPPORTED_BEE_VERSION_EXACT = '1.7.0-bbf13011';
-export const SUPPORTED_API_VERSION = '3.0.2';
-export const SUPPORTED_DEBUG_API_VERSION = '3.0.2';
+export const SUPPORTED_BEE_VERSION_EXACT = '1.10.0-904cbb08';
+export const SUPPORTED_API_VERSION = '4.0.0';
+export const SUPPORTED_DEBUG_API_VERSION = '4.0.0';
 export const SUPPORTED_BEE_VERSION = SUPPORTED_BEE_VERSION_EXACT.substring(0, SUPPORTED_BEE_VERSION_EXACT.indexOf('-'));
 const NODE_INFO_URL = 'node';
 const HEALTH_URL = 'health';
+const READINESS_URL = 'readiness';
 /**
  * Get health of node
  *
@@ -56,6 +57,25 @@ export function getHealth(ky) {
     return response.data;
   });
 }
+/**
+ * Get readiness of node
+ *
+ * @param ky Ky debug instance
+ */
+
+export function getReadiness(ky) {
+  return __awaiter(this, void 0, void 0, function* () {
+    try {
+      const response = yield http(ky, {
+        method: 'get',
+        path: READINESS_URL
+      });
+      return response.status === 200;
+    } catch (_a) {
+      return false;
+    }
+  });
+}
 /**
  * Get information about Bee node
  *
@@ -80,6 +100,7 @@ export function getNodeInfo(ky) {
  * @returns true if the Bee node version is supported
  * @deprecated Use `isSupportedExactVersion` instead
  */
+// TODO: Remove on break
 
 export function isSupportedVersion(ky) {
   return __awaiter(this, void 0, void 0, function* () {

package/dist/mjs/utils/type.js

@@ -329,22 +329,31 @@ export function assertPostageBatchOptions(value) {
     assertNonNegativeInteger(options.waitForUsableTimeout, 'options.waitForUsableTimeout');
   }
 }
-export function assertCashoutOptions(value) {
+export 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);
+  }
+}
+export function assertCashoutOptions(value) {
+  if (value === undefined) {
+    return;
   }
+
+  assertStrictlyObject(value);
+  const options = value;
+  assertRequestOptions(options, 'CashoutOptions');
+  assertTransactionOptions(options, 'CashoutOptions');
 }
 /**
  * Check whether the given parameter is valid data to upload

package/dist/types/bee-debug.d.ts

@@ -1,5 +1,5 @@
 import type { Address, Peer, BalanceResponse, PeerBalance, ChequebookAddressResponse, ChequebookBalanceResponse, LastChequesResponse, LastChequesForPeerResponse, LastCashoutActionResponse, Settlements, AllSettlements, RemovePeerResponse, Topology, PingResponse, Health, NodeAddresses, ReserveState, ChainState, NumberString, ExtendedTag, PostageBatchBuckets, PostageBatch, TransactionInfo, TransactionHash, NodeInfo, BeeVersions, WalletBalance } from './types';
-import { BatchId, BeeOptions, CashoutOptions, PostageBatchOptions, RequestOptions, Tag } from './types';
+import { BatchId, BeeOptions, CashoutOptions, PostageBatchOptions, RequestOptions, Tag, TransactionOptions } from './types';
 export declare class BeeDebug {
     /**
      * URL on which is the Debug API of Bee node exposed
@@ -117,6 +117,10 @@ export declare class BeeDebug {
      * Get health of node
      */
     getHealth(options?: RequestOptions): Promise<Health>;
+    /**
+     * Get readiness of node
+     */
+    getReadiness(options?: RequestOptions): Promise<boolean>;
     /**
      * Get mode information of node
      */
@@ -285,6 +289,21 @@ export declare class BeeDebug {
      * @param gasPrice
      */
     cancelPendingTransaction(transactionHash: TransactionHash | string, gasPrice?: NumberString, options?: RequestOptions): Promise<TransactionHash>;
+    /**
+     * Gets the staked amount of BZZ (in PLUR unit) as number string.
+     *
+     * @param options
+     */
+    getStake(options?: RequestOptions): Promise<NumberString>;
+    /**
+     * 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: NumberString, options?: RequestOptions & TransactionOptions): Promise<void>;
     private waitForUsablePostageStamp;
     private getKy;
 }

package/dist/types/modules/debug/stake.d.ts

@@ -0,0 +1,15 @@
+import { Ky, NumberString, TransactionOptions } from '../../types';
+/**
+ * Gets the staked amount
+ *
+ * @param ky Ky instance for given Bee class instance
+ */
+export declare function getStake(ky: Ky): Promise<NumberString>;
+/**
+ * Stake given amount of tokens.
+ *
+ * @param ky
+ * @param amount
+ * @param options
+ */
+export declare function stake(ky: Ky, amount: NumberString, options?: TransactionOptions): Promise<void>;

package/dist/types/modules/debug/status.d.ts

@@ -1,9 +1,9 @@
 import type { Health, NodeInfo } from '../../types/debug';
 import { Ky } from '../../types';
 import { BeeVersions } from '../../types/debug';
-export declare const SUPPORTED_BEE_VERSION_EXACT = "1.7.0-bbf13011";
-export declare const SUPPORTED_API_VERSION = "3.0.2";
-export declare const SUPPORTED_DEBUG_API_VERSION = "3.0.2";
+export declare const SUPPORTED_BEE_VERSION_EXACT = "1.10.0-904cbb08";
+export declare const SUPPORTED_API_VERSION = "4.0.0";
+export declare const SUPPORTED_DEBUG_API_VERSION = "4.0.0";
 export declare const SUPPORTED_BEE_VERSION: string;
 /**
  * Get health of node
@@ -11,6 +11,12 @@ export declare const SUPPORTED_BEE_VERSION: string;
  * @param ky Ky debug instance
  */
 export declare function getHealth(ky: Ky): Promise<Health>;
+/**
+ * Get readiness of node
+ *
+ * @param ky Ky debug instance
+ */
+export declare function getReadiness(ky: Ky): Promise<boolean>;
 /**
  * Get information about Bee node
  *

package/dist/types/types/debug.d.ts

@@ -70,7 +70,7 @@ export interface ChequebookBalanceResponse {
     totalBalance: NumberString;
     availableBalance: NumberString;
 }
-export interface CashoutOptions extends RequestOptions {
+export interface TransactionOptions {
     /**
      * Gas price for the cashout transaction in WEI
      */
@@ -80,6 +80,7 @@ export interface CashoutOptions extends RequestOptions {
      */
     gasLimit?: NumberString;
 }
+export declare type CashoutOptions = TransactionOptions & RequestOptions;
 export interface CashoutResult {
     recipient: string;
     lastPayout: NumberString;
@@ -213,18 +214,40 @@ export interface ChainState {
 export interface WalletBalance {
     /**
      * Balance of BZZ tokens
+     *
+     * @deprecated: Use bzzBalance property instead
      */
     bzz: NumberString;
+    /**
+     * Balance of BZZ tokens
+     */
+    bzzBalance: NumberString;
     /**
      * Balance of xDai
+     *
+     * @deprecated: Use nativeTokenBalance property instead
      */
     xDai: NumberString;
+    /**
+     * Balance of xDai
+     */
+    nativeTokenBalance: NumberString;
     /**
      * Chain network ID to which the Bee node is connected
      */
     chainID: number;
     /**
      * Chequebook contract address
+     *
+     * @deprecated: Use chequebookContractAddress property instead
      */
     contractAddress: string;
+    /**
+     * Chequebook contract address
+     */
+    chequebookContractAddress: string;
+    /**
+     * Node's wallet address
+     */
+    walletAddress: string;
 }

package/dist/types/utils/type.d.ts

@@ -1,4 +1,4 @@
-import { Address, AddressPrefix, AllTagsOptions, BatchId, CollectionUploadOptions, FileUploadOptions, NumberString, PssMessageHandler, PublicKey, Readable, Reference, Tag, UploadOptions, TransactionHash, RequestOptions, PostageBatchOptions, CashoutOptions, ReferenceOrEns } from '../types';
+import { Address, AddressPrefix, AllTagsOptions, BatchId, CollectionUploadOptions, FileUploadOptions, NumberString, PssMessageHandler, PublicKey, Readable, Reference, Tag, UploadOptions, TransactionHash, RequestOptions, PostageBatchOptions, CashoutOptions, ReferenceOrEns, TransactionOptions } from '../types';
 import { ReferenceType } from '@ethersphere/swarm-cid';
 export declare function isUint8Array(obj: unknown): obj is Uint8Array;
 export declare function isInteger(value: unknown): value is number | NumberString;
@@ -55,6 +55,7 @@ export declare function assertAddressPrefix(value: unknown): asserts value is Ad
 export declare function assertPssMessageHandler(value: unknown): asserts value is PssMessageHandler;
 export declare function assertPublicKey(value: unknown): asserts value is PublicKey;
 export declare function assertPostageBatchOptions(value: unknown): asserts value is PostageBatchOptions;
+export declare function assertTransactionOptions(value: unknown, name?: string): asserts value is TransactionOptions;
 export declare function assertCashoutOptions(value: unknown): asserts value is CashoutOptions;
 /**
  * Check whether the given parameter is valid data to upload

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -88,7 +88,7 @@
     "@babel/preset-typescript": "^7.14.5",
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^16.2.1",
-    "@ethersphere/bee-factory": "^0.4.1",
+    "@ethersphere/bee-factory": "^0.5.2",
     "@fluffy-spoon/substitute": "^1.208.0",
     "@jest/test-sequencer": "^27.5.0",
     "@jest/types": "^27.5.1",
@@ -135,8 +135,8 @@
   "engines": {
     "node": ">=14.0.0",
     "npm": ">=6.0.0",
-    "beeApiVersion": "3.0.2",
-    "beeDebugApiVersion": "3.0.2",
-    "bee": "1.7.0-bbf13011"
+    "beeApiVersion": "4.0.0",
+    "beeDebugApiVersion": "4.0.0",
+    "bee": "1.10.0-904cbb08"
   }
 }