@ethersphere/bee-js 6.0.0-pre.0 → 6.0.0-pre.1

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

@@ -1,59 +1,41 @@
-import * as connectivity from "./modules/debug/connectivity.js";
 import * as balance from "./modules/debug/balance.js";
 import * as chequebook from "./modules/debug/chequebook.js";
+import * as connectivity from "./modules/debug/connectivity.js";
 import * as settlements from "./modules/debug/settlements.js";
+import * as stake from "./modules/debug/stake.js";
+import * as states from "./modules/debug/states.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 { Objects, System } from 'cafe-utility';
+import * as stamps from "./modules/debug/stamps.js";
+import * as tag from "./modules/debug/tag.js";
+import { STAMPS_DEPTH_MAX, STAMPS_DEPTH_MIN } from "./types/index.js";
 import { BeeArgumentError, BeeError } from "./utils/error.js";
+import { assertAddress, assertBatchId, assertCashoutOptions, assertNonNegativeInteger, assertPositiveInteger, assertPostageBatchOptions, assertRequestOptions, assertTransactionHash, assertTransactionOptions, isTag } from "./utils/type.js";
 import { assertBeeUrl, stripLastSlash } from "./utils/url.js";
-import { assertAddress, assertBatchId, assertCashoutOptions, assertNonNegativeInteger, assertPositiveInteger, assertPostageBatchOptions, assertRequestOptions, assertTransactionHash, 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";
-import { makeDefaultKy, wrapRequestClosure, wrapResponseClosure } from "./utils/http.js";
-import { sleep } from "./utils/sleep.js";
 export class BeeDebug {
   constructor(url, options) {
-    assertBeeUrl(url); // Remove last slash if present, as our endpoint strings starts with `/...`
+    assertBeeUrl(url);
+    // Remove last slash if present, as our endpoint strings starts with `/...`
     // which could lead to double slash in URL to which Bee responds with
     // unnecessary redirects.
-
     this.url = stripLastSlash(url);
-    const kyOptions = {
-      prefixUrl: this.url,
-      timeout: options?.timeout ?? false,
-      retry: options?.retry,
-      fetch: options?.fetch,
-      hooks: {
-        beforeRequest: [],
-        afterResponse: []
-      }
+    const requestOptions = {
+      baseURL: this.url,
+      timeout: options?.timeout ?? false
     };
-
-    if (options?.defaultHeaders) {
-      kyOptions.headers = options.defaultHeaders;
-    }
-
-    if (options?.onRequest) {
-      kyOptions.hooks.beforeRequest.push(wrapRequestClosure(options.onRequest));
-    }
-
-    if (options?.onResponse) {
-      kyOptions.hooks.afterResponse.push(wrapResponseClosure(options.onResponse));
+    if (options?.headers) {
+      requestOptions.headers = options.headers;
     }
-
-    this.ky = makeDefaultKy(kyOptions);
+    this.requestOptions = requestOptions;
   }
-
   async getNodeAddresses(options) {
     assertRequestOptions(options);
-    return connectivity.getNodeAddresses(this.getKy(options));
+    return connectivity.getNodeAddresses(this.getRequestOptionsForCall(options));
   }
-
   async getBlocklist(options) {
     assertRequestOptions(options);
-    return connectivity.getBlocklist(this.getKy(options));
+    return connectivity.getBlocklist(this.getRequestOptionsForCall(options));
   }
   /**
    * Retrieve tag extended information from Bee node
@@ -65,11 +47,8 @@ export class BeeDebug {
    * @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/debug-api/#tag/Tag)
    *
    */
-
-
   async retrieveExtendedTag(tagUid, options) {
     assertRequestOptions(options);
-
     if (isTag(tagUid)) {
       tagUid = tagUid.uid;
     } else if (typeof tagUid === 'number') {
@@ -77,138 +56,112 @@ export class BeeDebug {
     } else {
       throw new TypeError('tagUid has to be either Tag or a number (UID)!');
     }
-
-    return tag.retrieveExtendedTag(this.getKy(options), tagUid);
+    return tag.retrieveExtendedTag(this.getRequestOptionsForCall(options), tagUid);
   }
   /**
    * Get list of peers for this node
    */
-
-
   async getPeers(options) {
     assertRequestOptions(options);
-    return connectivity.getPeers(this.getKy(options));
+    return connectivity.getPeers(this.getRequestOptionsForCall(options));
   }
-
   async removePeer(peer, options) {
     assertRequestOptions(options);
     assertAddress(peer);
-    return connectivity.removePeer(this.getKy(options), peer);
+    return connectivity.removePeer(this.getRequestOptionsForCall(options), peer);
   }
-
   async getTopology(options) {
     assertRequestOptions(options);
-    return connectivity.getTopology(this.getKy(options));
+    return connectivity.getTopology(this.getRequestOptionsForCall(options));
   }
-
   async pingPeer(peer, options) {
     assertRequestOptions(options);
     assertAddress(peer);
-    return connectivity.pingPeer(this.getKy(options), peer);
+    return connectivity.pingPeer(this.getRequestOptionsForCall(options), peer);
   }
   /*
    * Balance endpoints
    */
-
   /**
    * Get the balances with all known peers including prepaid services
    */
-
-
   async getAllBalances(options) {
     assertRequestOptions(options);
-    return balance.getAllBalances(this.getKy(options));
+    return balance.getAllBalances(this.getRequestOptionsForCall(options));
   }
   /**
    * Get the balances with a specific peer including prepaid services
    *
    * @param address Swarm address of peer
    */
-
-
   async getPeerBalance(address, options) {
     assertRequestOptions(options);
     assertAddress(address);
-    return balance.getPeerBalance(this.getKy(options), address);
+    return balance.getPeerBalance(this.getRequestOptionsForCall(options), address);
   }
   /**
    * Get the past due consumption balances with all known peers
    */
-
-
   async getPastDueConsumptionBalances(options) {
     assertRequestOptions(options);
-    return balance.getPastDueConsumptionBalances(this.getKy(options));
+    return balance.getPastDueConsumptionBalances(this.getRequestOptionsForCall(options));
   }
   /**
    * Get the past due consumption balance with a specific peer
    *
    * @param address Swarm address of peer
    */
-
-
   async getPastDueConsumptionPeerBalance(address, options) {
     assertRequestOptions(options);
     assertAddress(address);
-    return balance.getPastDueConsumptionPeerBalance(this.getKy(options), address);
+    return balance.getPastDueConsumptionPeerBalance(this.getRequestOptionsForCall(options), address);
   }
   /*
    * Chequebook endpoints
    */
-
   /**
    * Get the address of the chequebook contract used.
    *
    * **Warning:** The address is returned with 0x prefix unlike all other calls.
    * https://github.com/ethersphere/bee/issues/1443
    */
-
-
   async getChequebookAddress(options) {
     assertRequestOptions(options);
-    return chequebook.getChequebookAddress(this.getKy(options));
+    return chequebook.getChequebookAddress(this.getRequestOptionsForCall(options));
   }
   /**
    * Get the balance of the chequebook
    */
-
-
   async getChequebookBalance(options) {
     assertRequestOptions(options);
-    return chequebook.getChequebookBalance(this.getKy(options));
+    return chequebook.getChequebookBalance(this.getRequestOptionsForCall(options));
   }
   /**
    * Get last cheques for all peers
    */
-
-
   async getLastCheques(options) {
     assertRequestOptions(options);
-    return chequebook.getLastCheques(this.getKy(options));
+    return chequebook.getLastCheques(this.getRequestOptionsForCall(options));
   }
   /**
    * Get last cheques for the peer
    *
    * @param address  Swarm address of peer
    */
-
-
   async getLastChequesForPeer(address, options) {
     assertRequestOptions(options);
     assertAddress(address);
-    return chequebook.getLastChequesForPeer(this.getKy(options), address);
+    return chequebook.getLastChequesForPeer(this.getRequestOptionsForCall(options), address);
   }
   /**
    * Get last cashout action for the peer
    *
    * @param address  Swarm address of peer
    */
-
-
   async getLastCashoutAction(address, options) {
     assertRequestOptions(options);
     assertAddress(address);
-    return chequebook.getLastCashoutAction(this.getKy(options), address);
+    return chequebook.getLastCashoutAction(this.getRequestOptionsForCall(options), address);
   }
   /**
    * Cashout the last cheque for the peer
@@ -218,12 +171,10 @@ export class BeeDebug {
    * @param options.gasPrice Gas price for the cashout transaction in WEI
    * @param options.gasLimit Gas limit for the cashout transaction in WEI
    */
-
-
-  async cashoutLastCheque(address, options) {
+  async cashoutLastCheque(address, options, requestOptions) {
     assertCashoutOptions(options);
     assertAddress(address);
-    return chequebook.cashoutLastCheque(this.getKy(options), address, options);
+    return chequebook.cashoutLastCheque(this.getRequestOptionsForCall(requestOptions), address, options);
   }
   /**
    * Deposit tokens from overlay address into chequebook
@@ -232,17 +183,13 @@ export class BeeDebug {
    * @param gasPrice Gas Price in WEI for the transaction call
    * @return string  Hash of the transaction
    */
-
-
   async depositTokens(amount, gasPrice, options) {
     assertRequestOptions(options);
     assertNonNegativeInteger(amount);
-
     if (gasPrice) {
       assertNonNegativeInteger(gasPrice);
     }
-
-    return chequebook.depositTokens(this.getKy(options), amount, gasPrice);
+    return chequebook.depositTokens(this.getRequestOptionsForCall(options), amount, gasPrice);
   }
   /**
    * Withdraw tokens from the chequebook to the overlay address
@@ -251,60 +198,54 @@ export class BeeDebug {
    * @param gasPrice Gas Price in WEI for the transaction call
    * @return string  Hash of the transaction
    */
-
-
   async withdrawTokens(amount, gasPrice, options) {
     assertRequestOptions(options);
     assertNonNegativeInteger(amount);
-
     if (gasPrice) {
       assertNonNegativeInteger(gasPrice);
     }
-
-    return chequebook.withdrawTokens(this.getKy(options), amount, gasPrice);
+    return chequebook.withdrawTokens(this.getRequestOptionsForCall(options), amount, gasPrice);
   }
   /*
    * Settlements endpoint
    */
-
   /**
    * Get amount of sent and received from settlements with a peer
    *
    * @param address  Swarm address of peer
    */
-
-
   async getSettlements(address, options) {
     assertRequestOptions(options);
     assertAddress(address);
-    return settlements.getSettlements(this.getKy(options), address);
+    return settlements.getSettlements(this.getRequestOptionsForCall(options), address);
   }
   /**
    * Get settlements with all known peers and total amount sent or received
    */
-
-
   async getAllSettlements(options) {
     assertRequestOptions(options);
-    return settlements.getAllSettlements(this.getKy(options));
+    return settlements.getAllSettlements(this.getRequestOptionsForCall(options));
   }
   /**
    * Get health of node
    */
-
-
   async getHealth(options) {
     assertRequestOptions(options);
-    return status.getHealth(this.getKy(options));
+    return status.getHealth(this.getRequestOptionsForCall(options));
+  }
+  /**
+   * Get readiness of node
+   */
+  async getReadiness(options) {
+    assertRequestOptions(options);
+    return status.getReadiness(this.getRequestOptionsForCall(options));
   }
   /**
    * Get mode information of node
    */
-
-
   async getNodeInfo(options) {
     assertRequestOptions(options);
-    return status.getNodeInfo(this.getKy(options));
+    return status.getNodeInfo(this.getRequestOptionsForCall(options));
   }
   /**
    * Connnects to a node and checks if it is a supported Bee version by the bee-js
@@ -312,11 +253,9 @@ export class BeeDebug {
    * @returns true if the Bee node version is supported
    * @deprecated Use `BeeDebug.isSupportedExactVersion()` instead
    */
-
-
   async isSupportedVersion(options) {
     assertRequestOptions(options);
-    return status.isSupportedVersion(this.getKy(options));
+    return status.isSupportedVersion(this.getRequestOptionsForCall(options));
   }
   /**
    * Connects to a node and checks if its version matches with the one that bee-js supports.
@@ -328,11 +267,9 @@ export class BeeDebug {
    *
    * @param options
    */
-
-
   async isSupportedExactVersion(options) {
     assertRequestOptions(options);
-    return status.isSupportedExactVersion(this.getKy(options));
+    return status.isSupportedExactVersion(this.getRequestOptionsForCall(options));
   }
   /**
    * Connects to a node and checks if its main's API version matches with the one that bee-js supports.
@@ -342,11 +279,9 @@ export class BeeDebug {
    *
    * @param options
    */
-
-
   async isSupportedMainApiVersion(options) {
     assertRequestOptions(options);
-    return status.isSupportedMainApiVersion(this.getKy(options));
+    return status.isSupportedMainApiVersion(this.getRequestOptionsForCall(options));
   }
   /**
    * Connects to a node and checks if its Debug API version matches with the one that bee-js supports.
@@ -356,11 +291,9 @@ export class BeeDebug {
    *
    * @param options
    */
-
-
   async isSupportedDebugApiVersion(options) {
     assertRequestOptions(options);
-    return status.isSupportedDebugApiVersion(this.getKy(options));
+    return status.isSupportedDebugApiVersion(this.getRequestOptionsForCall(options));
   }
   /**
    *
@@ -370,11 +303,9 @@ export class BeeDebug {
    *
    * @param options
    */
-
-
   async isSupportedApiVersion(options) {
     assertRequestOptions(options);
-    return status.isSupportedDebugApiVersion(this.getKy(options));
+    return status.isSupportedDebugApiVersion(this.getRequestOptionsForCall(options));
   }
   /**
    * Returns object with all versions specified by the connected Bee node (properties prefixed with `bee*`)
@@ -382,40 +313,32 @@ export class BeeDebug {
    *
    * @param options
    */
-
-
   async getVersions(options) {
     assertRequestOptions(options);
-    return status.getVersions(this.getKy(options));
+    return status.getVersions(this.getRequestOptionsForCall(options));
   }
   /**
    * Get reserve state
    */
-
-
   async getReserveState(options) {
     assertRequestOptions(options);
-    return states.getReserveState(this.getKy(options));
+    return states.getReserveState(this.getRequestOptionsForCall(options));
   }
   /**
    * Get chain state
    */
-
-
   async getChainState(options) {
     assertRequestOptions(options);
-    return states.getChainState(this.getKy(options));
+    return states.getChainState(this.getRequestOptionsForCall(options));
   }
   /**
    * Get wallet balances for xDai and BZZ of the Bee node
    *
    * @param options
    */
-
-
   async getWalletBalance(options) {
     assertRequestOptions(options);
-    return states.getWalletBalance(this.getKy(options));
+    return states.getWalletBalance(this.getRequestOptionsForCall(options));
   }
   /**
    * Creates new postage batch from the funds that the node has available in its Ethereum account.
@@ -434,27 +357,20 @@ export class BeeDebug {
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
    * @see [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post)
    */
-
-
-  async createPostageBatch(amount, depth, options) {
+  async createPostageBatch(amount, depth, options, requestOptions) {
     assertPostageBatchOptions(options);
     assertPositiveInteger(amount);
     assertNonNegativeInteger(depth);
-
     if (depth < STAMPS_DEPTH_MIN) {
       throw new BeeArgumentError(`Depth has to be at least ${STAMPS_DEPTH_MIN}`, depth);
     }
-
     if (depth > STAMPS_DEPTH_MAX) {
       throw new BeeArgumentError(`Depth has to be at most ${STAMPS_DEPTH_MAX}`, depth);
     }
-
-    const stamp = await stamps.createPostageBatch(this.getKy(options), amount, depth, options);
-
+    const stamp = await stamps.createPostageBatch(this.getRequestOptionsForCall(requestOptions), amount, depth, options);
     if (options?.waitForUsable !== false) {
       await this.waitForUsablePostageStamp(stamp, options?.waitForUsableTimeout);
     }
-
     return stamp;
   }
   /**
@@ -472,13 +388,11 @@ export class BeeDebug {
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
    * @see [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{id}~1{amount}/patch)
    */
-
-
   async topUpBatch(postageBatchId, amount, options) {
     assertRequestOptions(options);
     assertNonNegativeInteger(amount, 'Amount');
     assertBatchId(postageBatchId);
-    await stamps.topUpBatch(this.getKy(options), postageBatchId, amount);
+    await stamps.topUpBatch(this.getRequestOptionsForCall(options), postageBatchId, amount);
   }
   /**
    * Dilute given Postage Batch with new depth (that has to be bigger then the original depth), which allows
@@ -496,13 +410,11 @@ export class BeeDebug {
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
    * @see [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{id}~1{amount}/patch)
    */
-
-
   async diluteBatch(postageBatchId, depth, options) {
     assertRequestOptions(options);
     assertNonNegativeInteger(depth, 'Depth');
     assertBatchId(postageBatchId);
-    await stamps.diluteBatch(this.getKy(options), postageBatchId, depth);
+    await stamps.diluteBatch(this.getRequestOptionsForCall(options), postageBatchId, depth);
   }
   /**
    * Return details for specific postage batch.
@@ -512,12 +424,10 @@ export class BeeDebug {
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
    * @see [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}/get)
    */
-
-
   async getPostageBatch(postageBatchId, options) {
     assertRequestOptions(options);
     assertBatchId(postageBatchId);
-    return stamps.getPostageBatch(this.getKy(options), postageBatchId);
+    return stamps.getPostageBatch(this.getRequestOptionsForCall(options), postageBatchId);
   }
   /**
    * Return detailed information related to buckets for specific postage batch.
@@ -527,12 +437,10 @@ export class BeeDebug {
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
    * @see [Bee Debug API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}~1buckets/get)
    */
-
-
   async getPostageBatchBuckets(postageBatchId, options) {
     assertRequestOptions(options);
     assertBatchId(postageBatchId);
-    return stamps.getPostageBatchBuckets(this.getKy(options), postageBatchId);
+    return stamps.getPostageBatchBuckets(this.getRequestOptionsForCall(options), postageBatchId);
   }
   /**
    * Return all postage batches that has the node available.
@@ -540,31 +448,25 @@ export class BeeDebug {
    * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
    * @see [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps/get)
    */
-
-
   async getAllPostageBatch(options) {
     assertRequestOptions(options);
-    return stamps.getAllPostageBatches(this.getKy(options));
+    return stamps.getAllPostageBatches(this.getRequestOptionsForCall(options));
   }
   /**
    * Return lists of all current pending transactions that the Bee made
    */
-
-
   async getAllPendingTransactions(options) {
     assertRequestOptions(options);
-    return transactions.getAllTransactions(this.getKy(options));
+    return transactions.getAllTransactions(this.getRequestOptionsForCall(options));
   }
   /**
    * Return transaction information for specific transaction
    * @param transactionHash
    */
-
-
   async getPendingTransaction(transactionHash, options) {
     assertRequestOptions(options);
     assertTransactionHash(transactionHash);
-    return transactions.getTransaction(this.getKy(options), transactionHash);
+    return transactions.getTransaction(this.getRequestOptionsForCall(options), transactionHash);
   }
   /**
    * Rebroadcast already created transaction.
@@ -572,53 +474,67 @@ export class BeeDebug {
    *
    * @param transactionHash
    */
-
-
   async rebroadcastPendingTransaction(transactionHash, options) {
     assertRequestOptions(options);
     assertTransactionHash(transactionHash);
-    return transactions.rebroadcastTransaction(this.getKy(options), transactionHash);
+    return transactions.rebroadcastTransaction(this.getRequestOptionsForCall(options), transactionHash);
   }
   /**
    * Cancel currently pending transaction
    * @param transactionHash
    * @param gasPrice
    */
-
-
   async cancelPendingTransaction(transactionHash, gasPrice, options) {
     assertRequestOptions(options);
     assertTransactionHash(transactionHash);
-
     if (gasPrice) {
       assertNonNegativeInteger(gasPrice);
     }
-
-    return transactions.cancelTransaction(this.getKy(options), transactionHash, gasPrice);
+    return transactions.cancelTransaction(this.getRequestOptionsForCall(options), transactionHash, gasPrice);
+  }
+  /**
+   * Gets the staked amount of BZZ (in PLUR unit) as number string.
+   *
+   * @param options
+   */
+  async getStake(options) {
+    assertRequestOptions(options);
+    return stake.getStake(this.getRequestOptionsForCall(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
+   */
+  async depositStake(amount, options, requestOptions) {
+    assertRequestOptions(options);
+    assertTransactionOptions(options);
+    await stake.stake(this.getRequestOptionsForCall(requestOptions), amount, options);
+  }
+  /**
+   * Get current status of node in redistribution game
+   *
+   * @param options
+   */
+  async getRedistributionState(options) {
+    assertRequestOptions(options);
+    return stake.getRedistributionState(this.getRequestOptionsForCall(options));
   }
-
   async waitForUsablePostageStamp(id, timeout = 120000) {
     const TIME_STEP = 1500;
-
     for (let time = 0; time < timeout; time += TIME_STEP) {
       const stamp = await this.getPostageBatch(id);
-
       if (stamp.usable) {
         return;
       }
-
-      await sleep(TIME_STEP);
+      await System.sleepMillis(TIME_STEP);
     }
-
     throw new BeeError('Timeout on waiting for postage stamp to become usable');
   }
-
-  getKy(options) {
-    if (!options) {
-      return this.ky;
-    }
-
-    return this.ky.extend(options);
+  getRequestOptionsForCall(options) {
+    return options ? Objects.deepMerge2(this.requestOptions, options) : this.requestOptions;
   }
-
 }