@ethersphere/bee-js 6.9.0 → 7.0.0

package/dist/types/bee.d.ts

@@ -1,7 +1,9 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
 import { Index, IndexBytes } from './feed';
 import { FeedType } from './feed/type';
-import type { AddressPrefix, AnyJson, BatchId, BeeOptions, BeeRequestOptions, CollectionUploadOptions, Data, FeedReader, FeedWriter, FileData, FileUploadOptions, JsonFeedOptions, Pin, PssMessageHandler, PssSubscription, PublicKey, Reference, SOCReader, SOCWriter, Signer, Tag, Topic, UploadOptions, UploadRedundancyOptions, UploadResultWithCid } from './types';
-import { AllTagsOptions, Collection, FeedManifestResult, Readable, ReferenceCidOrEns, ReferenceOrEns, UploadResult } from './types';
+import type { Address, AddressPrefix, AllSettlements, AnyJson, BalanceResponse, BatchId, BeeOptions, BeeRequestOptions, BeeVersions, ChainState, ChequebookAddressResponse, ChequebookBalanceResponse, CollectionUploadOptions, Data, DebugStatus, ExtendedTag, FeedReader, FeedWriter, FileData, FileUploadOptions, Health, JsonFeedOptions, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NodeAddresses, NodeInfo, NumberString, Peer, PeerBalance, Pin, PingResponse, PostageBatch, PostageBatchBuckets, PssMessageHandler, PssSubscription, PublicKey, RedistributionState, Reference, RemovePeerResponse, ReserveState, SOCReader, SOCWriter, Settlements, Signer, Tag, Topic, Topology, TransactionHash, TransactionInfo, UploadOptions, UploadRedundancyOptions, UploadResultWithCid, WalletBalance } from './types';
+import { AllTagsOptions, CashoutOptions, Collection, FeedManifestResult, PostageBatchOptions, ReferenceCidOrEns, ReferenceOrEns, TransactionOptions, UploadResult } from './types';
 import { EthAddress } from './utils/eth';
 /**
  * The main component that abstracts operations available on the main Bee API.
@@ -19,7 +21,7 @@ export declare class Bee {
      */
     readonly signer?: Signer;
     /**
-     * Ky instance that defines connection to Bee node
+     * Options for making requests
      * @private
      */
     private readonly requestOptions;
@@ -155,7 +157,7 @@ export declare class Bee {
      * @param collection
      * @param options Collections and request options
      */
-    uploadCollection(postageBatchId: string | BatchId, collection: Collection<Uint8Array | Readable>, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<UploadResultWithCid>;
+    uploadCollection(postageBatchId: string | BatchId, collection: Collection, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<UploadResultWithCid>;
     /**
      * Upload collection of files.
      *
@@ -489,6 +491,305 @@ export declare class Bee {
      * @returns true if successful, false on error
      */
     isConnected(options?: BeeRequestOptions): Promise<boolean>;
+    getNodeAddresses(options?: BeeRequestOptions): Promise<NodeAddresses>;
+    getBlocklist(options?: BeeRequestOptions): Promise<Peer[]>;
+    /**
+     * Retrieve tag extended information from Bee node
+     *
+     * @param tagUid UID or tag object to be retrieved
+     * @throws TypeError if tagUid is in not correct format
+     *
+     * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
+     * @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/debug-api/#tag/Tag)
+     *
+     */
+    retrieveExtendedTag(tagUid: number | Tag, options?: BeeRequestOptions): Promise<ExtendedTag>;
+    /**
+     * Get list of peers for this node
+     */
+    getPeers(options?: BeeRequestOptions): Promise<Peer[]>;
+    removePeer(peer: string | Address, options?: BeeRequestOptions): Promise<RemovePeerResponse>;
+    getTopology(options?: BeeRequestOptions): Promise<Topology>;
+    pingPeer(peer: string | Address, options?: BeeRequestOptions): Promise<PingResponse>;
+    /**
+     * Get the balances with all known peers including prepaid services
+     */
+    getAllBalances(options?: BeeRequestOptions): Promise<BalanceResponse>;
+    /**
+     * Get the balances with a specific peer including prepaid services
+     *
+     * @param address Swarm address of peer
+     */
+    getPeerBalance(address: Address | string, options?: BeeRequestOptions): Promise<PeerBalance>;
+    /**
+     * Get the past due consumption balances with all known peers
+     */
+    getPastDueConsumptionBalances(options?: BeeRequestOptions): Promise<BalanceResponse>;
+    /**
+     * Get the past due consumption balance with a specific peer
+     *
+     * @param address Swarm address of peer
+     */
+    getPastDueConsumptionPeerBalance(address: Address | string, options?: BeeRequestOptions): 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(options?: BeeRequestOptions): Promise<ChequebookAddressResponse>;
+    /**
+     * Get the balance of the chequebook
+     */
+    getChequebookBalance(options?: BeeRequestOptions): Promise<ChequebookBalanceResponse>;
+    /**
+     * Get last cheques for all peers
+     */
+    getLastCheques(options?: BeeRequestOptions): Promise<LastChequesResponse>;
+    /**
+     * Get last cheques for the peer
+     *
+     * @param address  Swarm address of peer
+     */
+    getLastChequesForPeer(address: Address | string, options?: BeeRequestOptions): Promise<LastChequesForPeerResponse>;
+    /**
+     * Get last cashout action for the peer
+     *
+     * @param address  Swarm address of peer
+     */
+    getLastCashoutAction(address: Address | string, options?: BeeRequestOptions): Promise<LastCashoutActionResponse>;
+    /**
+     * Cashout the last cheque for the peer
+     *
+     * @param address  Swarm address of peer
+     * @param options
+     * @param options.gasPrice Gas price for the cashout transaction in WEI
+     * @param options.gasLimit Gas limit for the cashout transaction in WEI
+     */
+    cashoutLastCheque(address: string | Address, options?: CashoutOptions, requestOptions?: BeeRequestOptions): Promise<string>;
+    /**
+     * Deposit tokens from overlay address into chequebook
+     *
+     * @param amount  Amount of tokens to deposit (must be positive integer)
+     * @param gasPrice Gas Price in WEI for the transaction call
+     * @return string  Hash of the transaction
+     */
+    depositTokens(amount: number | NumberString, gasPrice?: NumberString, options?: BeeRequestOptions): Promise<string>;
+    /**
+     * Withdraw tokens from the chequebook to the overlay address
+     *
+     * @param amount  Amount of tokens to withdraw (must be positive integer)
+     * @param gasPrice Gas Price in WEI for the transaction call
+     * @return string  Hash of the transaction
+     */
+    withdrawTokens(amount: number | NumberString, gasPrice?: NumberString, options?: BeeRequestOptions): Promise<string>;
+    /**
+     * Get amount of sent and received from settlements with a peer
+     *
+     * @param address  Swarm address of peer
+     */
+    getSettlements(address: Address | string, options?: BeeRequestOptions): Promise<Settlements>;
+    /**
+     * Get settlements with all known peers and total amount sent or received
+     */
+    getAllSettlements(options?: BeeRequestOptions): Promise<AllSettlements>;
+    /**
+     * Get status of node
+     */
+    getStatus(options?: BeeRequestOptions): Promise<DebugStatus>;
+    /**
+     * Get health of node
+     */
+    getHealth(options?: BeeRequestOptions): Promise<Health>;
+    /**
+     * Get readiness of node
+     */
+    getReadiness(options?: BeeRequestOptions): Promise<boolean>;
+    /**
+     * Get mode information of node
+     */
+    getNodeInfo(options?: BeeRequestOptions): Promise<NodeInfo>;
+    /**
+     * 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
+     * @deprecated Use `BeeDebug.isSupportedExactVersion()` instead
+     */
+    isSupportedVersion(options?: BeeRequestOptions): Promise<boolean> | never;
+    /**
+     * Connects to a node and checks if its version matches with the one that bee-js supports.
+     *
+     * Be aware that this is the most strict version check and most probably
+     * you will want to use more relaxed API-versions based checks like
+     * `BeeDebug.isSupportedApiVersion()`, `BeeDebug.isSupportedMainApiVersion()` or `BeeDebug.isSupportedDebugApiVersion()`
+     * based on your use-case.
+     *
+     * @param options
+     */
+    isSupportedExactVersion(options?: BeeRequestOptions): Promise<boolean> | never;
+    /**
+     * Connects to a node and checks if its main's API version matches with the one that bee-js supports.
+     *
+     * This is useful if you are not using `BeeDebug` class (for anything else then this check)
+     * and want to make sure about compatibility.
+     *
+     * @param options
+     */
+    isSupportedMainApiVersion(options?: BeeRequestOptions): Promise<boolean> | never;
+    /**
+     *
+     * Connects to a node and checks if its Main API version matches with the one that bee-js supports.
+     *
+     * This should be the main way how to check compatibility for your app and Bee node.
+     *
+     * @param options
+     */
+    isSupportedApiVersion(options?: BeeRequestOptions): Promise<boolean> | never;
+    /**
+     * Returns object with all versions specified by the connected Bee node (properties prefixed with `bee*`)
+     * and versions that bee-js supports (properties prefixed with `supported*`).
+     *
+     * @param options
+     */
+    getVersions(options?: BeeRequestOptions): Promise<BeeVersions> | never;
+    /**
+     * Get reserve state
+     */
+    getReserveState(options?: BeeRequestOptions): Promise<ReserveState>;
+    /**
+     * Get chain state
+     */
+    getChainState(options?: BeeRequestOptions): Promise<ChainState>;
+    /**
+     * Get wallet balances for xDai and BZZ of the Bee node
+     *
+     * @param options
+     */
+    getWalletBalance(options?: BeeRequestOptions): Promise<WalletBalance>;
+    /**
+     * Creates new postage batch from the funds that the node has available in its Ethereum account.
+     *
+     * 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 amount Amount that represents the value per chunk, has to be greater or equal zero.
+     * @param depth Logarithm of the number of chunks that can be stamped with the batch.
+     * @param options Options for creation of postage batch
+     * @throws BeeArgumentError when negative amount or depth is specified
+     * @throws TypeError if non-integer value is passed to amount or depth
+     *
+     * @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)
+     */
+    createPostageBatch(amount: NumberString, depth: number, options?: PostageBatchOptions, requestOptions?: BeeRequestOptions): 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?: BeeRequestOptions): 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?: BeeRequestOptions): Promise<void>;
+    /**
+     * Return details for specific postage batch.
+     *
+     * @param postageBatchId Batch ID
+     *
+     * @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, options?: BeeRequestOptions): Promise<PostageBatch>;
+    /**
+     * Return detailed information related to buckets for specific postage batch.
+     *
+     * @param postageBatchId Batch ID
+     *
+     * @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, options?: BeeRequestOptions): 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(options?: BeeRequestOptions): Promise<PostageBatch[]>;
+    /**
+     * Return all globally available postage batches.
+     */
+    getAllGlobalPostageBatch(options?: BeeRequestOptions): Promise<PostageBatch[]>;
+    /**
+     * Return lists of all current pending transactions that the Bee made
+     */
+    getAllPendingTransactions(options?: BeeRequestOptions): Promise<TransactionInfo[]>;
+    /**
+     * Return transaction information for specific transaction
+     * @param transactionHash
+     */
+    getPendingTransaction(transactionHash: TransactionHash | string, options?: BeeRequestOptions): 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, options?: BeeRequestOptions): Promise<TransactionHash>;
+    /**
+     * Cancel currently pending transaction
+     * @param transactionHash
+     * @param gasPrice
+     */
+    cancelPendingTransaction(transactionHash: TransactionHash | string, gasPrice?: NumberString, options?: BeeRequestOptions): Promise<TransactionHash>;
+    /**
+     * Gets the staked amount of BZZ (in PLUR unit) as number string.
+     *
+     * @param options
+     */
+    getStake(options?: BeeRequestOptions): 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?: TransactionOptions, requestOptions?: BeeRequestOptions): Promise<void>;
+    /**
+     * Get current status of node in redistribution game
+     *
+     * @param options
+     */
+    getRedistributionState(options?: BeeRequestOptions): Promise<RedistributionState>;
+    private waitForUsablePostageStamp;
     /**
      * @param signer
      * @private

package/dist/types/chunk/soc.d.ts

@@ -39,7 +39,7 @@ export declare function makeSingleOwnerChunk(chunk: Chunk, identifier: Identifie
  *
  * It uses the Chunk API and calculates the address before uploading.
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions  Options for making requests
  * @param chunk           A chunk object
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Upload options
@@ -48,7 +48,7 @@ export declare function uploadSingleOwnerChunk(requestOptions: BeeRequestOptions
 /**
  * Helper function to create and upload SOC.
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions  Options for making requests
  * @param signer          The singer interface for signing the chunk
  * @param postageBatchId
  * @param identifier      The identifier of the chunk

package/dist/types/feed/identifier.d.ts

@@ -1,4 +1,4 @@
-import { Topic } from '../types';
 import { Identifier } from '../chunk/soc';
+import { Topic } from '../types';
 import { Index } from './index';
 export declare function makeFeedIdentifier(topic: Topic, index: Index): Identifier;

package/dist/types/feed/index.d.ts

@@ -21,7 +21,7 @@ export interface FeedUpdate {
     reference: BytesReference;
 }
 export declare function findNextIndex(requestOptions: BeeRequestOptions, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<HexString<typeof FEED_INDEX_HEX_LENGTH>>;
-export declare function updateFeed(requestOptions: BeeRequestOptions, signer: Signer, topic: Topic, reference: BytesReference, postageBatchId: BatchId, options?: FeedUploadOptions, index?: Index): Promise<Reference>;
+export declare function updateFeed(requestOptions: BeeRequestOptions, signer: Signer, topic: Topic, reference: BytesReference, postageBatchId: BatchId, options?: FeedUploadOptions): Promise<Reference>;
 export declare function getFeedUpdateChunkReference(owner: EthAddress, topic: Topic, index: Index): PlainBytesReference;
 export declare function downloadFeedUpdate(requestOptions: BeeRequestOptions, owner: EthAddress, topic: Topic, index: Index): Promise<FeedUpdate>;
 export declare function makeFeedReader(requestOptions: BeeRequestOptions, type: FeedType, topic: Topic, owner: HexEthAddress): FeedReader;

package/dist/types/index.d.ts

@@ -1,15 +1,13 @@
 import { Bee } from './bee';
-import { BeeDebug } from './bee-debug';
 export { SUPPORTED_BEE_VERSION, SUPPORTED_BEE_VERSION_EXACT } from './modules/debug/status';
 export * from './types';
 export * from './utils/error';
 export * as Utils from './utils/expose';
-export { Bee, BeeDebug };
+export { Bee };
 declare global {
     interface Window {
         BeeJs: {
             Bee: typeof import('./bee').Bee;
-            BeeDebug: typeof import('./bee-debug').BeeDebug;
             Utils: typeof import('./utils/expose');
             BeeError: typeof import('./utils/error').BeeError;
             BeeArgumentError: typeof import('./utils/error').BeeArgumentError;

package/dist/types/modules/bytes.d.ts

@@ -3,7 +3,7 @@ import { UploadResult } from '../types';
 /**
  * Upload data to a Bee node
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param data            Data to be uploaded
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
@@ -12,14 +12,14 @@ export declare function upload(requestOptions: BeeRequestOptions, data: string |
 /**
  * Download data as a byte array
  *
- * @param ky
+ * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
 export declare function download(requestOptions: BeeRequestOptions, hash: ReferenceOrEns, options?: DownloadRedundancyOptions): Promise<Data>;
 /**
  * Download data as a readable stream
  *
- * @param ky
+ * @param requestOptions Options for making requests
  * @param hash Bee content reference
  */
 export declare function downloadReadable(requestOptions: BeeRequestOptions, hash: ReferenceOrEns, options?: DownloadRedundancyOptions): Promise<ReadableStream<Uint8Array>>;

package/dist/types/modules/bzz.d.ts

@@ -1,8 +1,10 @@
-import { BatchId, BeeRequestOptions, Collection, CollectionUploadOptions, Data, DownloadRedundancyOptions, FileData, FileUploadOptions, Readable, ReferenceOrEns, UploadRedundancyOptions, UploadResult } from '../types';
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { BatchId, BeeRequestOptions, Collection, CollectionUploadOptions, Data, DownloadRedundancyOptions, FileData, FileUploadOptions, ReferenceOrEns, UploadHeaders, UploadRedundancyOptions, UploadResult } from '../types';
 /**
  * Upload single file
  *
- * @param ky
+ * @param requestOptions Options for making requests
  * @param data Files data
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param name Name that will be attached to the uploaded file. Wraps the data into manifest with set index document.
@@ -12,7 +14,7 @@ export declare function uploadFile(requestOptions: BeeRequestOptions, data: stri
 /**
  * Download single file as a buffer
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
@@ -20,16 +22,22 @@ export declare function downloadFile(requestOptions: BeeRequestOptions, hash: Re
 /**
  * Download single file as a readable stream
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param hash Bee file or collection hash
  * @param path If hash is collection then this defines path to a single file in the collection
  */
 export declare function downloadFileReadable(requestOptions: BeeRequestOptions, hash: ReferenceOrEns, path?: string, options?: DownloadRedundancyOptions): Promise<FileData<ReadableStream<Uint8Array>>>;
+/*******************************************************************************************************************/
+export interface CollectionUploadHeaders extends UploadHeaders {
+    'swarm-index-document'?: string;
+    'swarm-error-document'?: string;
+}
+export declare function extractCollectionUploadHeaders(postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): CollectionUploadHeaders & UploadRedundancyOptions;
 /**
  * Upload collection
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param collection Collection of Uint8Array buffers to upload
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options
  */
-export declare function uploadCollection(requestOptions: BeeRequestOptions, collection: Collection<Uint8Array>, postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<UploadResult>;
+export declare function uploadCollection(requestOptions: BeeRequestOptions, collection: Collection, postageBatchId: BatchId, options?: CollectionUploadOptions & UploadRedundancyOptions): Promise<UploadResult>;

package/dist/types/modules/chunk.d.ts

@@ -6,7 +6,7 @@ import type { BatchId, BeeRequestOptions, Data, Reference, ReferenceOrEns, Uploa
  * The span stores the length of the payload in uint64 little endian encoding.
  * Upload expects the chuck data to be set accordingly.
  *
- * @param ky Ky instance
+ * @param requestOptions Options for making requests
  * @param data    Chunk data to be uploaded
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options Additional options like tag, encryption, pinning
@@ -15,7 +15,7 @@ export declare function upload(requestOptions: BeeRequestOptions, data: Uint8Arr
 /**
  * Download chunk data as a byte array
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param hash Bee content reference
  *
  */

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

@@ -2,26 +2,26 @@ import type { BalanceResponse, BeeRequestOptions, PeerBalance } from '../../type
 /**
  * Get the balances with all known peers including prepaid services
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getAllBalances(requestOptions: BeeRequestOptions): Promise<BalanceResponse>;
 /**
  * Get the balances with a specific peer including prepaid services
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param address Swarm address of peer
  */
 export declare function getPeerBalance(requestOptions: BeeRequestOptions, address: string): Promise<PeerBalance>;
 /**
  * Get the past due consumption balances with all known peers
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getPastDueConsumptionBalances(requestOptions: BeeRequestOptions): Promise<BalanceResponse>;
 /**
  * Get the past due consumption balance with a specific peer
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param address Swarm address of peer
  */
 export declare function getPastDueConsumptionPeerBalance(requestOptions: BeeRequestOptions, address: string): Promise<PeerBalance>;

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

@@ -2,26 +2,26 @@ import type { BeeRequestOptions, CashoutOptions, ChequebookAddressResponse, Cheq
 /**
  * Get the address of the chequebook contract used
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getChequebookAddress(requestOptions: BeeRequestOptions): Promise<ChequebookAddressResponse>;
 /**
  * Get the balance of the chequebook
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getChequebookBalance(requestOptions: BeeRequestOptions): Promise<ChequebookBalanceResponse>;
 /**
  * Get last cashout action for the peer
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param peer  Swarm address of peer
  */
 export declare function getLastCashoutAction(requestOptions: BeeRequestOptions, peer: string): Promise<LastCashoutActionResponse>;
 /**
  * Cashout the last cheque for the peer
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param peer  Swarm address of peer
  * @param options
  */
@@ -29,20 +29,20 @@ export declare function cashoutLastCheque(requestOptions: BeeRequestOptions, pee
 /**
  * Get last cheques for the peer
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param peer  Swarm address of peer
  */
 export declare function getLastChequesForPeer(requestOptions: BeeRequestOptions, peer: string): Promise<LastChequesForPeerResponse>;
 /**
  * Get last cheques for all peers
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getLastCheques(requestOptions: BeeRequestOptions): Promise<LastChequesResponse>;
 /**
  * Deposit tokens from overlay address into chequebook
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param amount   Amount of tokens to deposit
  * @param gasPrice Gas Price in WEI for the transaction call
  * @return string  Hash of the transaction
@@ -51,7 +51,7 @@ export declare function depositTokens(requestOptions: BeeRequestOptions, amount:
 /**
  * Withdraw tokens from the chequebook to the overlay address
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param amount   Amount of tokens to withdraw
  * @param gasPrice Gas Price in WEI for the transaction call
  * @return string  Hash of the transaction

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

@@ -2,18 +2,9 @@ import type { BeeGenericResponse, BeeRequestOptions } from '../../types';
 /**
  * Check if chunk at address exists locally
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param address  Swarm address of chunk
  *
  * @returns BeeGenericResponse if chunk is found or throws an exception
  */
 export declare function checkIfChunkExistsLocally(requestOptions: BeeRequestOptions, address: string): Promise<BeeGenericResponse>;
-/**
- * Delete a chunk from local storage
- *
- * @param kyOptions Ky Options for making requests
- * @param address  Swarm address of chunk
- *
- * @returns BeeGenericResponse if chunk was deleted or throws an exception
- */
-export declare function deleteChunkFromLocalStorage(requestOptions: BeeRequestOptions, address: string): Promise<BeeGenericResponse>;

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

@@ -2,13 +2,13 @@ import type { AllSettlements, BeeRequestOptions, Settlements } from '../../types
 /**
  * Get amount of sent and received from settlements with a peer
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  * @param peer  Swarm address of peer
  */
 export declare function getSettlements(requestOptions: BeeRequestOptions, peer: string): Promise<Settlements>;
 /**
  * Get settlements with all known peers and total amount sent or received
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getAllSettlements(requestOptions: BeeRequestOptions): Promise<AllSettlements>;

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

@@ -2,13 +2,13 @@ import { BeeRequestOptions, NumberString, RedistributionState, TransactionOption
 /**
  * Gets the staked amount
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getStake(requestOptions: BeeRequestOptions): Promise<NumberString>;
 /**
  * Stake given amount of tokens.
  *
- * @param ky
+ * @param requestOptions Options for making requests
  * @param amount
  * @param options
  */
@@ -16,6 +16,6 @@ export declare function stake(requestOptions: BeeRequestOptions, amount: NumberS
 /**
  * Get current status of node in redistribution game
  *
- * @param kyOptions Ky Options for making requests
+ * @param requestOptions Options for making requests
  */
 export declare function getRedistributionState(requestOptions: BeeRequestOptions): Promise<RedistributionState>;