@ethersphere/bee-js 1.2.1 → 3.0.0

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

@@ -1,27 +1,27 @@
-import { PeerBalance, BalanceResponse } from '../../types';
+import type { PeerBalance, BalanceResponse, Ky } from '../../types';
 /**
  * Get the balances with all known peers including prepaid services
  *
- * @param url Bee debug url
+ * @param ky Ky debug instance
  */
-export declare function getAllBalances(url: string): Promise<BalanceResponse>;
+export declare function getAllBalances(ky: Ky): Promise<BalanceResponse>;
 /**
  * Get the balances with a specific peer including prepaid services
  *
- * @param url     Bee debug url
+ * @param ky Ky debug instance
  * @param address Swarm address of peer
  */
-export declare function getPeerBalance(url: string, address: string): Promise<PeerBalance>;
+export declare function getPeerBalance(ky: Ky, address: string): Promise<PeerBalance>;
 /**
  * Get the past due consumption balances with all known peers
  *
- * @param url Bee debug url
+ * @param ky Ky debug instance
  */
-export declare function getPastDueConsumptionBalances(url: string): Promise<BalanceResponse>;
+export declare function getPastDueConsumptionBalances(ky: Ky): Promise<BalanceResponse>;
 /**
  * Get the past due consumption balance with a specific peer
  *
- * @param url     Bee debug url
+ * @param ky Ky debug instance
  * @param address Swarm address of peer
  */
-export declare function getPastDueConsumptionPeerBalance(url: string, address: string): Promise<PeerBalance>;
+export declare function getPastDueConsumptionPeerBalance(ky: Ky, address: string): Promise<PeerBalance>;

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

@@ -1,60 +1,59 @@
-import type { ChequebookAddressResponse, ChequebookBalanceResponse, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NumberString, TransactionHash } from '../../types';
-import { CashoutOptions } from '../../types';
+import type { ChequebookAddressResponse, ChequebookBalanceResponse, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NumberString, Ky, CashoutOptions, TransactionHash } from '../../types';
 /**
  * Get the address of the chequebook contract used
  *
- * @param url Bee debug url
+ * @param ky Ky debug instance
  */
-export declare function getChequebookAddress(url: string): Promise<ChequebookAddressResponse>;
+export declare function getChequebookAddress(ky: Ky): Promise<ChequebookAddressResponse>;
 /**
  * Get the balance of the chequebook
  *
- * @param url Bee debug url
+ * @param ky Ky debug instance
  */
-export declare function getChequebookBalance(url: string): Promise<ChequebookBalanceResponse>;
+export declare function getChequebookBalance(ky: Ky): Promise<ChequebookBalanceResponse>;
 /**
  * Get last cashout action for the peer
  *
- * @param url   Bee debug url
+ * @param ky Ky debug instance
  * @param peer  Swarm address of peer
  */
-export declare function getLastCashoutAction(url: string, peer: string): Promise<LastCashoutActionResponse>;
+export declare function getLastCashoutAction(ky: Ky, peer: string): Promise<LastCashoutActionResponse>;
 /**
  * Cashout the last cheque for the peer
  *
- * @param url   Bee debug url
+ * @param ky Ky debug instance
  * @param peer  Swarm address of peer
  * @param options
  */
-export declare function cashoutLastCheque(url: string, peer: string, options?: CashoutOptions): Promise<TransactionHash>;
+export declare function cashoutLastCheque(ky: Ky, peer: string, options?: CashoutOptions): Promise<TransactionHash>;
 /**
  * Get last cheques for the peer
  *
- * @param url   Bee debug url
+ * @param ky Ky debug instance
  * @param peer  Swarm address of peer
  */
-export declare function getLastChequesForPeer(url: string, peer: string): Promise<LastChequesForPeerResponse>;
+export declare function getLastChequesForPeer(ky: Ky, peer: string): Promise<LastChequesForPeerResponse>;
 /**
  * Get last cheques for all peers
  *
- * @param url   Bee debug url
+ * @param ky Ky debug instance
  */
-export declare function getLastCheques(url: string): Promise<LastChequesResponse>;
+export declare function getLastCheques(ky: Ky): Promise<LastChequesResponse>;
 /**
  * Deposit tokens from overlay address into chequebook
  *
- * @param url      Bee debug url
+ * @param ky Ky debug instance
  * @param amount   Amount of tokens to deposit
  * @param gasPrice Gas Price in WEI for the transaction call
  * @return string  Hash of the transaction
  */
-export declare function depositTokens(url: string, amount: number | NumberString, gasPrice?: NumberString): Promise<TransactionHash>;
+export declare function depositTokens(ky: Ky, amount: number | NumberString, gasPrice?: NumberString): Promise<TransactionHash>;
 /**
  * Withdraw tokens from the chequebook to the overlay address
  *
- * @param url      Bee debug url
+ * @param ky Ky debug instance
  * @param amount   Amount of tokens to withdraw
  * @param gasPrice Gas Price in WEI for the transaction call
  * @return string  Hash of the transaction
  */
-export declare function withdrawTokens(url: string, amount: number | NumberString, gasPrice?: NumberString): Promise<TransactionHash>;
+export declare function withdrawTokens(ky: Ky, amount: number | NumberString, gasPrice?: NumberString): Promise<TransactionHash>;

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

@@ -1,19 +1,19 @@
-import { BeeGenericResponse } from '../../types';
+import type { BeeGenericResponse, Ky } from '../../types';
 /**
  * Check if chunk at address exists locally
  *
- * @param url      Bee debug url
+ * @param ky Ky debug instance
  * @param address  Swarm address of chunk
  *
  * @returns BeeGenericResponse if chunk is found or throws an exception
  */
-export declare function checkIfChunkExistsLocally(url: string, address: string): Promise<BeeGenericResponse>;
+export declare function checkIfChunkExistsLocally(ky: Ky, address: string): Promise<BeeGenericResponse>;
 /**
  * Delete a chunk from local storage
  *
- * @param url      Bee debug url
+ * @param ky Ky debug instance
  * @param address  Swarm address of chunk
  *
  * @returns BeeGenericResponse if chunk was deleted or throws an exception
  */
-export declare function deleteChunkFromLocalStorage(url: string, address: string): Promise<BeeGenericResponse>;
+export declare function deleteChunkFromLocalStorage(ky: Ky, address: string): Promise<BeeGenericResponse>;

package/dist/src/modules/debug/connectivity.d.ts

@@ -1,7 +1,7 @@
-import type { NodeAddresses, Peer, PingResponse, RemovePeerResponse, Topology } from '../../types';
-export declare function getNodeAddresses(url: string): Promise<NodeAddresses>;
-export declare function getPeers(url: string): Promise<Peer[]>;
-export declare function getBlocklist(url: string): Promise<Peer[]>;
-export declare function removePeer(url: string, peer: string): Promise<RemovePeerResponse>;
-export declare function getTopology(url: string): Promise<Topology>;
-export declare function pingPeer(url: string, peer: string): Promise<PingResponse>;
+import type { Ky, NodeAddresses, Peer, PingResponse, RemovePeerResponse, Topology } from '../../types';
+export declare function getNodeAddresses(ky: Ky): Promise<NodeAddresses>;
+export declare function getPeers(ky: Ky): Promise<Peer[]>;
+export declare function getBlocklist(ky: Ky): Promise<Peer[]>;
+export declare function removePeer(ky: Ky, peer: string): Promise<RemovePeerResponse>;
+export declare function getTopology(ky: Ky): Promise<Topology>;
+export declare function pingPeer(ky: Ky, peer: string): Promise<PingResponse>;

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

@@ -1,14 +1,14 @@
-import { Settlements, AllSettlements } from '../../types';
+import type { Settlements, AllSettlements, Ky } from '../../types';
 /**
  * Get amount of sent and received from settlements with a peer
  *
- * @param url   Bee debug url
+ * @param ky Ky debug instance
  * @param peer  Swarm address of peer
  */
-export declare function getSettlements(url: string, peer: string): Promise<Settlements>;
+export declare function getSettlements(ky: Ky, peer: string): Promise<Settlements>;
 /**
  * Get settlements with all known peers and total amount sent or received
  *
- * @param url   Bee debug url
+ * @param ky Ky debug instance
  */
-export declare function getAllSettlements(url: string): Promise<AllSettlements>;
+export declare function getAllSettlements(ky: Ky): Promise<AllSettlements>;

package/dist/src/modules/debug/stamps.d.ts

@@ -1,5 +1,7 @@
-import { BatchId, DebugPostageBatch, NumberString, PostageBatchBuckets, PostageBatchOptions } from '../../types';
-export declare function getAllPostageBatches(url: string): Promise<DebugPostageBatch[]>;
-export declare function getPostageBatch(url: string, postageBatchId: BatchId): Promise<DebugPostageBatch>;
-export declare function getPostageBatchBuckets(url: string, postageBatchId: BatchId): Promise<PostageBatchBuckets>;
-export declare function createPostageBatch(url: string, amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId>;
+import type { BatchId, DebugPostageBatch, Ky, NumberString, PostageBatchBuckets, PostageBatchOptions } from '../../types';
+export declare function getAllPostageBatches(ky: Ky): Promise<DebugPostageBatch[]>;
+export declare function getPostageBatch(ky: Ky, postageBatchId: BatchId): Promise<DebugPostageBatch>;
+export declare function getPostageBatchBuckets(ky: Ky, postageBatchId: BatchId): Promise<PostageBatchBuckets>;
+export declare function createPostageBatch(ky: Ky, amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId>;
+export declare function topUpBatch(ky: Ky, id: string, amount: NumberString): Promise<BatchId>;
+export declare function diluteBatch(ky: Ky, id: string, depth: number): Promise<BatchId>;

package/dist/src/modules/debug/states.d.ts

@@ -1,13 +1,13 @@
-import { ChainState, ReserveState } from '../../types';
+import { ChainState, Ky, ReserveState } from '../../types';
 /**
  * Get state of reserve
  *
- * @param url Bee debug URL
+ * @param ky Ky debug instance
  */
-export declare function getReserveState(url: string): Promise<ReserveState>;
+export declare function getReserveState(ky: Ky): Promise<ReserveState>;
 /**
  * Get state of reserve
  *
- * @param url Bee debug URL
+ * @param ky Ky debug instance
  */
-export declare function getChainState(url: string): Promise<ChainState>;
+export declare function getChainState(ky: Ky): Promise<ChainState>;

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

@@ -1,17 +1,18 @@
 import type { Health } from '../../types/debug';
+import { Ky } from '../../types';
 export declare const SUPPORTED_BEE_VERSION_EXACT: string;
 export declare const SUPPORTED_BEE_VERSION: string;
 /**
  * Get health of node
  *
- * @param url Bee debug URL
+ * @param ky Ky debug instance
  */
-export declare function getHealth(url: string): Promise<Health> | never;
+export declare function getHealth(ky: Ky): Promise<Health> | never;
 /**
  * Connnects to a node and checks if it is a supported Bee version by the bee-js
  *
- * @param url Bee debug URL
+ * @param ky Ky debug instance
  *
  * @returns true if the Bee node version is supported
  */
-export declare function isSupportedVersion(url: string): Promise<boolean> | never;
+export declare function isSupportedVersion(ky: Ky): Promise<boolean> | never;

package/dist/src/modules/debug/tag.d.ts

@@ -1,8 +1,8 @@
-import { ExtendedTag } from '../../types';
+import { ExtendedTag, Ky } from '../../types';
 /**
  * Retrieve tag with extended information from Bee node
  *
- * @param url Bee tag URL
+ * @param ky Ky debug instance
  * @param uid UID of tag to be retrieved
  */
-export declare function retrieveExtendedTag(url: string, uid: number): Promise<ExtendedTag>;
+export declare function retrieveExtendedTag(ky: Ky, uid: number): Promise<ExtendedTag>;

package/dist/src/modules/debug/transactions.d.ts

@@ -1,29 +1,29 @@
-import { NumberString, TransactionHash, TransactionInfo } from '../../types';
+import { Ky, NumberString, TransactionHash, TransactionInfo } from '../../types';
 /**
  * Get list of all pending transactions
  *
- * @param url   Bee debug url
+ * @param ky   Debug Ky instance
  */
-export declare function getAllTransactions(url: string): Promise<TransactionInfo[]>;
+export declare function getAllTransactions(ky: Ky): Promise<TransactionInfo[]>;
 /**
  * Get information for specific pending transactions
  *
- * @param url   Bee debug url
+ * @param ky   Debug Ky instance
  * @param transactionHash Hash of the transaction
  */
-export declare function getTransaction(url: string, transactionHash: TransactionHash): Promise<TransactionInfo>;
+export declare function getTransaction(ky: Ky, transactionHash: TransactionHash): Promise<TransactionInfo>;
 /**
  * Rebroadcast existing transaction
  *
- * @param url   Bee debug url
+ * @param ky   Debug Ky instance
  * @param transactionHash Hash of the transaction
  */
-export declare function rebroadcastTransaction(url: string, transactionHash: TransactionHash): Promise<TransactionHash>;
+export declare function rebroadcastTransaction(ky: Ky, transactionHash: TransactionHash): Promise<TransactionHash>;
 /**
  * Cancel existing transaction
  *
- * @param url   Bee debug url
+ * @param ky   Debug Ky instance
  * @param transactionHash Hash of the transaction
  * @param gasPrice Optional gas price
  */
-export declare function cancelTransaction(url: string, transactionHash: TransactionHash, gasPrice?: NumberString): Promise<TransactionHash>;
+export declare function cancelTransaction(ky: Ky, transactionHash: TransactionHash, gasPrice?: NumberString): Promise<TransactionHash>;

package/dist/src/modules/feed.d.ts

@@ -1,4 +1,4 @@
-import { BatchId, Reference, ReferenceResponse, Topic } from '../types';
+import { BatchId, Ky, Reference, ReferenceResponse, Topic } from '../types';
 import { FeedType } from '../feed/type';
 import { HexEthAddress } from '../utils/eth';
 export interface CreateFeedOptions {
@@ -23,13 +23,13 @@ export interface FetchFeedUpdateResponse extends ReferenceResponse, FeedUpdateHe
 /**
  * Create an initial feed root manifest
  *
- * @param url             Bee URL
+ * @param ky Ky instance
  * @param owner           Owner's ethereum address in hex
  * @param topic           Topic in hex
  * @param postageBatchId  Postage BatchId to be used to create the Feed Manifest
  * @param options         Additional options, like type (default: 'sequence')
  */
-export declare function createFeedManifest(url: string, owner: HexEthAddress, topic: Topic, postageBatchId: BatchId, options?: CreateFeedOptions): Promise<Reference>;
+export declare function createFeedManifest(ky: Ky, owner: HexEthAddress, topic: Topic, postageBatchId: BatchId, options?: CreateFeedOptions): Promise<Reference>;
 /**
  * Find and retrieve feed update
  *
@@ -38,10 +38,10 @@ export declare function createFeedManifest(url: string, owner: HexEthAddress, to
  * the reference it contains along with its index and the
  * index of the subsequent update.
  *
- * @param url         Bee URL
+ * @param ky Ky instance
  * @param owner       Owner's ethereum address in hex
  * @param topic       Topic in hex
  * @param options     Additional options, like index, at, type
  */
-export declare function fetchFeedUpdate(url: string, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<FetchFeedUpdateResponse>;
+export declare function fetchFeedUpdate(ky: Ky, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<FetchFeedUpdateResponse>;
 export {};

package/dist/src/modules/pinning.d.ts

@@ -1,32 +1,32 @@
-import type { Pin, Reference } from '../types';
+import type { Ky, Pin, Reference } from '../types';
 export interface GetAllPinResponse {
     references: Reference[] | null;
 }
 /**
  * Pin data with given reference
  *
- * @param url  Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param reference Bee data reference
  */
-export declare function pin(url: string, reference: Reference): Promise<void>;
+export declare function pin(ky: Ky, reference: Reference): Promise<void>;
 /**
  * Unpin data with given reference
  *
- * @param url  Bee URL
+ * @param ky Ky instance for given Bee class instance
  * @param reference Bee data reference
  */
-export declare function unpin(url: string, reference: Reference): Promise<void>;
+export declare function unpin(ky: Ky, reference: Reference): Promise<void>;
 /**
  * Get pin status for specific address.
  *
- * @param url     Bee URL
+ * @param ky Ky instance
  * @param reference
  * @throws Error if given address is not pinned
  */
-export declare function getPin(url: string, reference: Reference): Promise<Pin>;
+export declare function getPin(ky: Ky, reference: Reference): Promise<Pin>;
 /**
  * Get list of all pins
  *
- * @param url     Bee URL
+ * @param ky Ky instance
  */
-export declare function getAllPins(url: string): Promise<Reference[]>;
+export declare function getAllPins(ky: Ky): Promise<Reference[]>;

package/dist/src/modules/pss.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="ws" />
 import WebSocket from 'isomorphic-ws';
-import type { BatchId, PublicKey } from '../types';
+import type { BatchId, Ky, PublicKey } from '../types';
 /**
  * Send to recipient or target with Postal Service for Swarm
  *
- * @param url Bee url
+ * @param ky Ky instance for given Bee class instance
  * @param topic Topic name
  * @param target Target message address prefix
  * @param data
@@ -12,10 +12,11 @@ import type { BatchId, PublicKey } from '../types';
  * @param recipient Recipient public key
  *
  */
-export declare function send(url: string, topic: string, target: string, data: string | Uint8Array, postageBatchId: BatchId, recipient?: PublicKey): Promise<void>;
+export declare function send(ky: Ky, topic: string, target: string, data: string | Uint8Array, postageBatchId: BatchId, recipient?: PublicKey): Promise<void>;
 /**
  * Subscribe for messages on the given topic
  *
+ * @param url Bee node URL
  * @param topic Topic name
  */
 export declare function subscribe(url: string, topic: string): WebSocket;

package/dist/src/modules/soc.d.ts

@@ -1,8 +1,8 @@
-import { BatchId, Reference, UploadOptions } from '../types';
+import { BatchId, Ky, Reference, UploadOptions } from '../types';
 /**
  * Upload single owner chunk (SOC) to a Bee node
  *
- * @param url             Bee URL
+ * @param ky Ky instance
  * @param owner           Owner's ethereum address in hex
  * @param identifier      Arbitrary identifier in hex
  * @param signature       Signature in hex
@@ -10,4 +10,4 @@ import { BatchId, Reference, UploadOptions } from '../types';
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-export declare function upload(url: string, owner: string, identifier: string, signature: string, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;
+export declare function upload(ky: Ky, owner: string, identifier: string, signature: string, data: Uint8Array, postageBatchId: BatchId, options?: UploadOptions): Promise<Reference>;

package/dist/src/modules/status.d.ts

@@ -1,6 +1,7 @@
+import { Ky } from '../types';
 /**
  * Ping the base bee URL. If connection was not successful throw error
  *
- * @param url Bee URL
+ * @param ky Ky instance for given Bee class instance
  */
-export declare function checkConnection(url: string): Promise<void> | never;
+export declare function checkConnection(ky: Ky): Promise<void> | never;

package/dist/src/modules/stewardship.d.ts

@@ -1,10 +1,10 @@
-import { Reference } from '../types';
-import { AxiosRequestConfig } from 'axios';
+import type { Ky, Reference } from '../types';
 /**
  * Reupload locally pinned data
- * @param url
+ * @param ky Ky instance
  * @param reference
  * @param options
  * @throws BeeResponseError if not locally pinned or invalid data
  */
-export declare function reupload(url: string, reference: Reference, options?: AxiosRequestConfig): Promise<void>;
+export declare function reupload(ky: Ky, reference: Reference): Promise<void>;
+export declare function isRetrievable(ky: Ky, reference: Reference): Promise<boolean>;

package/dist/src/modules/tag.d.ts

@@ -1,17 +1,17 @@
-import { Reference, Tag } from '../types';
+import { Ky, Reference, Tag } from '../types';
 /**
  * Create new tag on the Bee node
  *
  * @param url Bee tag URL
  */
-export declare function createTag(url: string): Promise<Tag>;
+export declare function createTag(ky: Ky): Promise<Tag>;
 /**
  * Retrieve tag information from Bee node
  *
  * @param url Bee tag URL
  * @param uid UID of tag to be retrieved
  */
-export declare function retrieveTag(url: string, uid: number): Promise<Tag>;
+export declare function retrieveTag(ky: Ky, uid: number): Promise<Tag>;
 /**
  * Get limited listing of all tags.
  *
@@ -19,17 +19,17 @@ export declare function retrieveTag(url: string, uid: number): Promise<Tag>;
  * @param offset
  * @param limit
  */
-export declare function getAllTags(url: string, offset?: number, limit?: number): Promise<Tag[]>;
+export declare function getAllTags(ky: Ky, offset?: number, limit?: number): Promise<Tag[]>;
 /**
  * Removes tag from the Bee node.
  * @param url
  * @param uid
  */
-export declare function deleteTag(url: string, uid: number): Promise<void>;
+export declare function deleteTag(ky: Ky, uid: number): Promise<void>;
 /**
  * Updates tag
  * @param url
  * @param uid
  * @param reference
  */
-export declare function updateTag(url: string, uid: number, reference: Reference): Promise<void>;
+export declare function updateTag(ky: Ky, uid: number, reference: Reference): Promise<void>;

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

@@ -1,4 +1,4 @@
-import { PublicKey, NumberString, Reference, TransactionHash } from './index';
+import { PublicKey, NumberString, Reference, TransactionHash, RequestOptions } from './index';
 import { HexEthAddress } from '../utils/eth';
 /**
  * Object that contains information about progress of upload of data to network.
@@ -70,7 +70,7 @@ export interface ChequebookBalanceResponse {
     totalBalance: NumberString;
     availableBalance: NumberString;
 }
-export interface CashoutOptions {
+export interface CashoutOptions extends RequestOptions {
     /**
      * Gas price for the cashout transaction in WEI
      */
@@ -118,6 +118,8 @@ export interface BalanceResponse {
 export interface Health {
     status: 'ok';
     version: string;
+    apiVersion: string;
+    debugApiVersion: string;
 }
 export interface RemovePeerResponse {
     message: string;