@ethersphere/bee-js 1.2.1 → 3.0.0

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

@@ -1,15 +1,18 @@
 import type { Address, Peer, BalanceResponse, PeerBalance, ChequebookAddressResponse, ChequebookBalanceResponse, LastChequesResponse, LastChequesForPeerResponse, LastCashoutActionResponse, Settlements, AllSettlements, RemovePeerResponse, Topology, PingResponse, Health, NodeAddresses, ReserveState, ChainState, NumberString, ExtendedTag, PostageBatchBuckets, DebugPostageBatch, TransactionInfo, TransactionHash } from './types';
-import { BatchId, CashoutOptions, PostageBatchOptions, Tag } from './types';
-/**
- * The BeeDebug class provides a way of interacting with the Bee debug APIs based on the provided url
- *
- * @param url URL of a running Bee node
- */
+import { BatchId, BeeOptions, CashoutOptions, PostageBatchOptions, RequestOptions, Tag } from './types';
 export declare class BeeDebug {
+    /**
+     * URL on which is the Debug API of Bee node exposed
+     */
     readonly url: string;
-    constructor(url: string);
-    getNodeAddresses(): Promise<NodeAddresses>;
-    getBlocklist(): Promise<Peer[]>;
+    /**
+     * Ky instance that defines connection to Bee node
+     * @private
+     */
+    private readonly ky;
+    constructor(url: string, options?: BeeOptions);
+    getNodeAddresses(options?: RequestOptions): Promise<NodeAddresses>;
+    getBlocklist(options?: RequestOptions): Promise<Peer[]>;
     /**
      * Retrieve tag extended information from Bee node
      *
@@ -20,61 +23,61 @@ export declare class BeeDebug {
      * @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/debug-api/#tag/Tag)
      *
      */
-    retrieveExtendedTag(tagUid: number | Tag): Promise<ExtendedTag>;
+    retrieveExtendedTag(tagUid: number | Tag, options?: RequestOptions): Promise<ExtendedTag>;
     /**
      * Get list of peers for this node
      */
-    getPeers(): Promise<Peer[]>;
-    removePeer(peer: string | Address): Promise<RemovePeerResponse>;
-    getTopology(): Promise<Topology>;
-    pingPeer(peer: string | Address): Promise<PingResponse>;
+    getPeers(options?: RequestOptions): Promise<Peer[]>;
+    removePeer(peer: string | Address, options?: RequestOptions): Promise<RemovePeerResponse>;
+    getTopology(options?: RequestOptions): Promise<Topology>;
+    pingPeer(peer: string | Address, options?: RequestOptions): Promise<PingResponse>;
     /**
      * Get the balances with all known peers including prepaid services
      */
-    getAllBalances(): Promise<BalanceResponse>;
+    getAllBalances(options?: RequestOptions): Promise<BalanceResponse>;
     /**
      * Get the balances with a specific peer including prepaid services
      *
      * @param address Swarm address of peer
      */
-    getPeerBalance(address: Address | string): Promise<PeerBalance>;
+    getPeerBalance(address: Address | string, options?: RequestOptions): Promise<PeerBalance>;
     /**
      * Get the past due consumption balances with all known peers
      */
-    getPastDueConsumptionBalances(): Promise<BalanceResponse>;
+    getPastDueConsumptionBalances(options?: RequestOptions): Promise<BalanceResponse>;
     /**
      * Get the past due consumption balance with a specific peer
      *
      * @param address Swarm address of peer
      */
-    getPastDueConsumptionPeerBalance(address: Address | string): Promise<PeerBalance>;
+    getPastDueConsumptionPeerBalance(address: Address | string, options?: RequestOptions): Promise<PeerBalance>;
     /**
      * 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
      */
-    getChequebookAddress(): Promise<ChequebookAddressResponse>;
+    getChequebookAddress(options?: RequestOptions): Promise<ChequebookAddressResponse>;
     /**
      * Get the balance of the chequebook
      */
-    getChequebookBalance(): Promise<ChequebookBalanceResponse>;
+    getChequebookBalance(options?: RequestOptions): Promise<ChequebookBalanceResponse>;
     /**
      * Get last cheques for all peers
      */
-    getLastCheques(): Promise<LastChequesResponse>;
+    getLastCheques(options?: RequestOptions): Promise<LastChequesResponse>;
     /**
      * Get last cheques for the peer
      *
      * @param address  Swarm address of peer
      */
-    getLastChequesForPeer(address: Address | string): Promise<LastChequesForPeerResponse>;
+    getLastChequesForPeer(address: Address | string, options?: RequestOptions): Promise<LastChequesForPeerResponse>;
     /**
      * Get last cashout action for the peer
      *
      * @param address  Swarm address of peer
      */
-    getLastCashoutAction(address: Address | string): Promise<LastCashoutActionResponse>;
+    getLastCashoutAction(address: Address | string, options?: RequestOptions): Promise<LastCashoutActionResponse>;
     /**
      * Cashout the last cheque for the peer
      *
@@ -91,7 +94,7 @@ export declare class BeeDebug {
      * @param gasPrice Gas Price in WEI for the transaction call
      * @return string  Hash of the transaction
      */
-    depositTokens(amount: number | NumberString, gasPrice?: NumberString): Promise<string>;
+    depositTokens(amount: number | NumberString, gasPrice?: NumberString, options?: RequestOptions): Promise<string>;
     /**
      * Withdraw tokens from the chequebook to the overlay address
      *
@@ -99,35 +102,35 @@ export declare class BeeDebug {
      * @param gasPrice Gas Price in WEI for the transaction call
      * @return string  Hash of the transaction
      */
-    withdrawTokens(amount: number | NumberString, gasPrice?: NumberString): Promise<string>;
+    withdrawTokens(amount: number | NumberString, gasPrice?: NumberString, options?: RequestOptions): Promise<string>;
     /**
      * Get amount of sent and received from settlements with a peer
      *
      * @param address  Swarm address of peer
      */
-    getSettlements(address: Address | string): Promise<Settlements>;
+    getSettlements(address: Address | string, options?: RequestOptions): Promise<Settlements>;
     /**
      * Get settlements with all known peers and total amount sent or received
      */
-    getAllSettlements(): Promise<AllSettlements>;
+    getAllSettlements(options?: RequestOptions): Promise<AllSettlements>;
     /**
      * Get health of node
      */
-    getHealth(): Promise<Health>;
+    getHealth(options?: RequestOptions): Promise<Health>;
     /**
      * Connnects to a node and checks if it is a supported Bee version by the bee-js
      *
      * @returns true if the Bee node version is supported
      */
-    isSupportedVersion(): Promise<boolean> | never;
+    isSupportedVersion(options?: RequestOptions): Promise<boolean> | never;
     /**
      * Get reserve state
      */
-    getReserveState(): Promise<ReserveState>;
+    getReserveState(options?: RequestOptions): Promise<ReserveState>;
     /**
      * Get chain state
      */
-    getChainState(): Promise<ChainState>;
+    getChainState(options?: RequestOptions): Promise<ChainState>;
     /**
      * Creates new postage batch from the funds that the node has available in its Ethereum account.
      *
@@ -146,6 +149,39 @@ export declare class BeeDebug {
      * @see [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post)
      */
     createPostageBatch(amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId>;
+    /**
+     * Topup a fresh amount of BZZ to given Postage Batch.
+     *
+     * For better understanding what each parameter means and what are the optimal values please see
+     * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive).
+     *
+     * **WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY**
+     *
+     * @param postageBatchId Batch ID
+     * @param amount Amount to be added to the batch
+     * @param options Request options
+     *
+     * @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)
+     */
+    topUpBatch(postageBatchId: BatchId | string, amount: NumberString, options?: RequestOptions): Promise<void>;
+    /**
+     * Dilute given Postage Batch with new depth (that has to be bigger then the original depth), which allows
+     * the Postage Batch to be used for more chunks.
+     *
+     * For better understanding what each parameter means and what are the optimal values please see
+     * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive).
+     *
+     * **WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY**
+     *
+     * @param postageBatchId Batch ID
+     * @param depth Amount to be added to the batch
+     * @param options Request options
+     *
+     * @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)
+     */
+    diluteBatch(postageBatchId: BatchId | string, depth: number, options?: RequestOptions): Promise<void>;
     /**
      * Return details for specific postage batch.
      *
@@ -154,7 +190,7 @@ export declare 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)
      */
-    getPostageBatch(postageBatchId: BatchId | string): Promise<DebugPostageBatch>;
+    getPostageBatch(postageBatchId: BatchId | string, options?: RequestOptions): Promise<DebugPostageBatch>;
     /**
      * Return detailed information related to buckets for specific postage batch.
      *
@@ -163,34 +199,35 @@ export declare 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)
      */
-    getPostageBatchBuckets(postageBatchId: BatchId | string): Promise<PostageBatchBuckets>;
+    getPostageBatchBuckets(postageBatchId: BatchId | string, options?: RequestOptions): Promise<PostageBatchBuckets>;
     /**
      * Return all postage batches that has the node available.
      *
      * @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)
      */
-    getAllPostageBatch(): Promise<DebugPostageBatch[]>;
+    getAllPostageBatch(options?: RequestOptions): Promise<DebugPostageBatch[]>;
     /**
      * Return lists of all current pending transactions that the Bee made
      */
-    getAllPendingTransactions(): Promise<TransactionInfo[]>;
+    getAllPendingTransactions(options?: RequestOptions): Promise<TransactionInfo[]>;
     /**
      * Return transaction information for specific transaction
      * @param transactionHash
      */
-    getPendingTransaction(transactionHash: TransactionHash | string): Promise<TransactionInfo>;
+    getPendingTransaction(transactionHash: TransactionHash | string, options?: RequestOptions): Promise<TransactionInfo>;
     /**
      * Rebroadcast already created transaction.
      * This is mainly needed when your transaction fall off mempool from other reason is not incorporated into block.
      *
      * @param transactionHash
      */
-    rebroadcastPendingTransaction(transactionHash: TransactionHash | string): Promise<TransactionHash>;
+    rebroadcastPendingTransaction(transactionHash: TransactionHash | string, options?: RequestOptions): Promise<TransactionHash>;
     /**
      * Cancel currently pending transaction
      * @param transactionHash
      * @param gasPrice
      */
-    cancelPendingTransaction(transactionHash: TransactionHash | string, gasPrice?: NumberString): Promise<TransactionHash>;
+    cancelPendingTransaction(transactionHash: TransactionHash | string, gasPrice?: NumberString, options?: RequestOptions): Promise<TransactionHash>;
+    private getKy;
 }