@ethersphere/bee-js 8.3.1 → 9.0.2

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

@@ -1,9 +1,9 @@
 import { BeeRequestOptions } from '../../index';
-import type { DebugStatus, Health, NodeInfo } from '../../types/debug';
+import type { DebugStatus, Health, NodeInfo, Readiness } from '../../types/debug';
 import { BeeVersions } from '../../types/debug';
-export declare const SUPPORTED_BEE_VERSION_EXACT = "2.2.0-06a0aca7";
-export declare const SUPPORTED_API_VERSION = "7.1.0";
+export declare const SUPPORTED_BEE_VERSION_EXACT = "2.4.0-390a402e";
 export declare const SUPPORTED_BEE_VERSION: string;
+export declare const SUPPORTED_API_VERSION = "7.2.0";
 export declare function getDebugStatus(requestOptions: BeeRequestOptions): Promise<DebugStatus>;
 /**
  * Get health of node
@@ -16,41 +16,22 @@ export declare function getHealth(requestOptions: BeeRequestOptions): Promise<He
  *
  * @param requestOptions Options for making requests
  */
-export declare function getReadiness(requestOptions: BeeRequestOptions): Promise<boolean>;
+export declare function getReadiness(requestOptions: BeeRequestOptions): Promise<Readiness>;
 /**
  * Get information about Bee node
  *
  * @param requestOptions Options for making requests
  */
 export declare function getNodeInfo(requestOptions: BeeRequestOptions): Promise<NodeInfo>;
-/**
- * Connects to a node and checks if it is a supported Bee version by the bee-js
- *
- * @param requestOptions Options for making requests
- * @returns true if the Bee node version is supported
- * @deprecated Use `isSupportedExactVersion` instead
- */
-export declare function isSupportedVersion(requestOptions: BeeRequestOptions): Promise<boolean>;
 /**
  * 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
- * `isSupportedApiVersion`, `isSupportedMainApiVersion` or `isSupportedDebugApiVersion`
- * based on your use-case.
+ * This is the most strict version check and most probably you will
+ * want to use the relaxed API-versions check `isSupportedApiVersion`.
  *
  * @param requestOptions Options for making requests
  */
 export declare function isSupportedExactVersion(requestOptions: BeeRequestOptions): Promise<boolean>;
-/**
- * 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 `Bee` class (for anything else then this check)
- * and want to make sure about compatibility.
- *
- * @param requestOptions Options for making requests
- */
-export declare function isSupportedMainApiVersion(requestOptions: BeeRequestOptions): Promise<boolean>;
 /**
  * Connects to a node and checks if its Main API versions matches with the one that bee-js supports.
  *

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

@@ -1,4 +1,5 @@
-import { BeeRequestOptions, NumberString, TransactionHash, TransactionInfo } from '../../types';
+import { BeeRequestOptions, NumberString, TransactionInfo } from '../../types';
+import { TransactionId } from '../../utils/typed-bytes';
 /**
  * Get list of all pending transactions
  *
@@ -11,14 +12,14 @@ export declare function getAllTransactions(requestOptions: BeeRequestOptions): P
  * @param requestOptions Options for making requests
  * @param transactionHash Hash of the transaction
  */
-export declare function getTransaction(requestOptions: BeeRequestOptions, transactionHash: TransactionHash): Promise<TransactionInfo>;
+export declare function getTransaction(requestOptions: BeeRequestOptions, transactionHash: TransactionId): Promise<TransactionInfo>;
 /**
  * Rebroadcast existing transaction
  *
  * @param requestOptions Options for making requests
  * @param transactionHash Hash of the transaction
  */
-export declare function rebroadcastTransaction(requestOptions: BeeRequestOptions, transactionHash: TransactionHash): Promise<TransactionHash>;
+export declare function rebroadcastTransaction(requestOptions: BeeRequestOptions, transactionHash: TransactionId): Promise<TransactionId>;
 /**
  * Cancel existing transaction
  *
@@ -26,4 +27,4 @@ export declare function rebroadcastTransaction(requestOptions: BeeRequestOptions
  * @param transactionHash Hash of the transaction
  * @param gasPrice Optional gas price
  */
-export declare function cancelTransaction(requestOptions: BeeRequestOptions, transactionHash: TransactionHash, gasPrice?: NumberString): Promise<TransactionHash>;
+export declare function cancelTransaction(requestOptions: BeeRequestOptions, transactionHash: TransactionId, gasPrice?: NumberString | string | bigint): Promise<TransactionId>;

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

@@ -1,2 +1,3 @@
-import type { BatchId, BeeRequestOptions, Envelope, Reference } from '../types';
-export declare function postEnvelope(requestOptions: BeeRequestOptions, postageBatchId: BatchId, reference: Reference): Promise<Envelope>;
+import type { BeeRequestOptions, EnvelopeWithBatchId } from '../types';
+import { BatchId, Reference } from '../utils/typed-bytes';
+export declare function postEnvelope(requestOptions: BeeRequestOptions, postageBatchId: BatchId, reference: Reference): Promise<EnvelopeWithBatchId>;

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

@@ -1,33 +1,36 @@
-import { Index } from '../feed';
-import { FeedType } from '../feed/type';
-import { BatchId, BeeRequestOptions, Reference, ReferenceResponse, Topic } from '../types';
-import { HexEthAddress } from '../utils/eth';
-export interface CreateFeedOptions {
-    type?: FeedType;
-}
+import { BeeRequestOptions, UploadOptions } from '../types';
+import { Bytes } from '../utils/bytes';
+import { BatchId, EthAddress, FeedIndex, Reference, Topic } from '../utils/typed-bytes';
 export interface FeedUpdateOptions {
     /**
      * Specifies the start date as unix time stamp
      */
     at?: number;
-    type?: FeedType;
     /**
      * Fetch specific previous Feed's update (default fetches latest update)
      */
-    index?: Index;
+    index?: FeedIndex | number;
+    /**
+     * Whether the first 8 bytes of the payload are a timestamp
+     */
+    hasTimestamp?: boolean;
 }
 interface FeedUpdateHeaders {
     /**
      * The current feed's index
      */
-    feedIndex: Index;
+    feedIndex: FeedIndex;
     /**
      * The feed's index for next update.
      * Only set for the latest update. If update is fetched using previous index, then this is an empty string.
      */
-    feedIndexNext: string;
+    feedIndexNext?: FeedIndex;
+}
+export interface FeedPayloadResult extends FeedUpdateHeaders {
+    payload: Bytes;
 }
-export interface FetchFeedUpdateResponse extends ReferenceResponse, FeedUpdateHeaders {
+export interface FeedReferenceResult extends FeedUpdateHeaders {
+    reference: Reference;
 }
 /**
  * Create an initial feed root manifest
@@ -38,7 +41,7 @@ export interface FetchFeedUpdateResponse extends ReferenceResponse, FeedUpdateHe
  * @param postageBatchId  Postage BatchId to be used to create the Feed Manifest
  * @param options         Additional options, like type (default: 'sequence')
  */
-export declare function createFeedManifest(requestOptions: BeeRequestOptions, owner: HexEthAddress, topic: Topic, stamp: BatchId | Uint8Array | string): Promise<Reference>;
+export declare function createFeedManifest(requestOptions: BeeRequestOptions, owner: EthAddress, topic: Topic, stamp: BatchId | Uint8Array | string, options?: UploadOptions): Promise<Reference>;
 /**
  * Find and retrieve feed update
  *
@@ -48,9 +51,10 @@ export declare function createFeedManifest(requestOptions: BeeRequestOptions, ow
  * index of the subsequent update.
  *
  * @param requestOptions Options for making requests
- * @param owner          Owner's ethereum address in hex
- * @param topic          Topic in hex
+ * @param owner          Owner's ethereum address
+ * @param topic          Topic
  * @param options        Additional options, like index, at, type
  */
-export declare function fetchLatestFeedUpdate(requestOptions: BeeRequestOptions, owner: HexEthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<FetchFeedUpdateResponse>;
+export declare function fetchLatestFeedUpdate(requestOptions: BeeRequestOptions, owner: EthAddress, topic: Topic, options?: FeedUpdateOptions): Promise<FeedPayloadResult>;
+export declare function probeFeed(requestOptions: BeeRequestOptions, owner: EthAddress, topic: Topic): Promise<FeedUpdateHeaders>;
 export {};

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

@@ -1,7 +1,8 @@
-import { BatchId, BeeRequestOptions, GetGranteesResult, GranteesResult } from '../types';
-export declare function getGrantees(reference: string, requestOptions: BeeRequestOptions): Promise<GetGranteesResult>;
-export declare function createGrantees(requestOptions: BeeRequestOptions, postageBatchId: BatchId, grantees: string[]): Promise<GranteesResult>;
-export declare function patchGrantees(postageBatchId: BatchId, reference: string, historyRef: string, grantees: {
-    add?: string[];
-    revoke?: string[];
+import { BeeRequestOptions, GetGranteesResult, GranteesResult } from '../types';
+import { BatchId, PublicKey, Reference } from '../utils/typed-bytes';
+export declare function getGrantees(reference: Reference, requestOptions: BeeRequestOptions): Promise<GetGranteesResult>;
+export declare function createGrantees(requestOptions: BeeRequestOptions, postageBatchId: BatchId, grantees: PublicKey[]): Promise<GranteesResult>;
+export declare function patchGrantees(postageBatchId: BatchId, reference: Reference, historyRef: Reference, grantees: {
+    add?: PublicKey[];
+    revoke?: PublicKey[];
 }, requestOptions: BeeRequestOptions): Promise<GranteesResult>;

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

@@ -0,0 +1,7 @@
+/// <reference types="ws" />
+import WebSocket from 'isomorphic-ws';
+import { BeeRequestOptions, UploadOptions } from '..';
+import { SingleOwnerChunk } from '../chunk/soc';
+import { BatchId, Reference } from '../utils/typed-bytes';
+export declare function send(requestOptions: BeeRequestOptions, soc: SingleOwnerChunk, stamp: BatchId, options?: UploadOptions): Promise<import("..").UploadResult>;
+export declare function subscribe(url: string, reference: Reference, headers?: Record<string, string>): WebSocket;

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

@@ -1,7 +1,5 @@
-import type { BeeRequestOptions, Pin, Reference } from '../types';
-export interface GetAllPinResponse {
-    references: Reference[];
-}
+import type { BeeRequestOptions, Pin } from '../types';
+import { Reference } from '../utils/typed-bytes';
 /**
  * Pin data with given reference
  *

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

@@ -1,6 +1,7 @@
 /// <reference types="ws" />
 import WebSocket from 'isomorphic-ws';
-import type { BatchId, BeeRequestOptions, PublicKey } from '../types';
+import type { BeeRequestOptions } from '../types';
+import { BatchId, PublicKey, Topic } from '../utils/typed-bytes';
 /**
  * Send to recipient or target with Postal Service for Swarm
  *
@@ -12,11 +13,11 @@ import type { BatchId, BeeRequestOptions, PublicKey } from '../types';
  * @param recipient Recipient public key
  *
  */
-export declare function send(requestOptions: BeeRequestOptions, topic: string, target: string, data: string | Uint8Array, postageBatchId: BatchId, recipient?: PublicKey): Promise<void>;
+export declare function send(requestOptions: BeeRequestOptions, topic: Topic, 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;
+export declare function subscribe(url: string, topic: Topic, headers?: Record<string, string>): WebSocket;

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

@@ -1,4 +1,5 @@
-import { BatchId, BeeRequestOptions, UploadOptions, UploadResult } from '../types';
+import { BeeRequestOptions, UploadOptions, UploadResult } from '../types';
+import { BatchId, EthAddress, Identifier, Signature } from '../utils/typed-bytes';
 /**
  * Upload single owner chunk (SOC) to a Bee node
  *
@@ -10,4 +11,4 @@ import { BatchId, BeeRequestOptions, UploadOptions, UploadResult } from '../type
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-export declare function upload(requestOptions: BeeRequestOptions, owner: string, identifier: string, signature: string, data: Uint8Array, stamp: BatchId | Uint8Array | string, options?: UploadOptions): Promise<UploadResult>;
+export declare function upload(requestOptions: BeeRequestOptions, owner: EthAddress, identifier: Identifier, signature: Signature, data: Uint8Array, stamp: BatchId | Uint8Array | string, options?: UploadOptions): Promise<UploadResult>;

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

@@ -1,10 +1,10 @@
-import type { BeeRequestOptions, ReferenceOrEns } from '../types';
+import type { BeeRequestOptions } from '../types';
+import { BatchId, Reference } from '../utils/typed-bytes';
 /**
  * Reupload locally pinned data
  * @param requestOptions Options for making requests
  * @param reference
- * @param options
  * @throws BeeResponseError if not locally pinned or invalid data
  */
-export declare function reupload(requestOptions: BeeRequestOptions, reference: ReferenceOrEns): Promise<void>;
-export declare function isRetrievable(requestOptions: BeeRequestOptions, reference: ReferenceOrEns): Promise<boolean>;
+export declare function reupload(requestOptions: BeeRequestOptions, stamp: BatchId, reference: Reference): Promise<void>;
+export declare function isRetrievable(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string): Promise<boolean>;

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

@@ -1,4 +1,5 @@
-import { BeeRequestOptions, Reference, Tag } from '../types';
+import { BeeRequestOptions, Tag } from '../types';
+import { Reference } from '../utils/typed-bytes';
 /**
  * Create new tag on the Bee node
  *

package/dist/types/stamper/stamper.d.ts

@@ -0,0 +1,15 @@
+import { Chunk } from 'cafe-utility';
+import { EnvelopeWithBatchId } from '../types';
+import { BatchId, PrivateKey } from '../utils/typed-bytes';
+export declare class Stamper {
+    signer: PrivateKey;
+    batchId: BatchId;
+    buckets: Uint32Array;
+    depth: number;
+    maxSlot: number;
+    private constructor();
+    static fromBlank(signer: PrivateKey | Uint8Array | string, batchId: BatchId | Uint8Array | string, depth: number): Stamper;
+    static fromState(signer: PrivateKey | Uint8Array | string, batchId: BatchId | Uint8Array | string, buckets: Uint32Array, depth: number): Stamper;
+    stamp(chunk: Chunk): EnvelopeWithBatchId;
+    getState(): Uint32Array;
+}

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

@@ -1,138 +1,104 @@
-import { HexEthAddress } from '../utils/eth';
-import { NumberString, PublicKey, Reference, TransactionHash } from './index';
-/**
- * Object that contains information about progress of upload of data to network.
- *
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
- */
-export interface ExtendedTag {
-    /**
-     * Number of all chunks that the data will be split into.
-     */
-    total: number;
-    /**
-     * Number of chunks already processed by splitter for hashing
-     */
-    split: number;
-    /**
-     * Number of chunks already seen
-     */
-    seen: number;
-    /**
-     * Number of chunks already stored locally
-     */
-    stored: number;
-    /**
-     * Number of chunks sent for push syncing
-     */
-    sent: number;
-    /**
-     * Number of chunks synced with proof
-     */
-    synced: number;
-    /**
-     * Unique identifier
-     */
-    uid: number;
-    /**
-     * The associated swarm hash for this tag
-     */
-    address: Reference;
-    /**
-     * When the upload process started
-     */
-    startedAt: string;
-}
+import { BZZ, DAI } from '../utils/tokens';
+import { EthAddress, PeerAddress, PublicKey, TransactionId } from '../utils/typed-bytes';
+import { NumberString } from './index';
 export interface Settlements {
     peer: string;
-    received: NumberString;
-    sent: NumberString;
+    received: BZZ;
+    sent: BZZ;
 }
 export interface AllSettlements {
-    totalReceived: NumberString;
-    totalSent: NumberString;
+    totalReceived: BZZ;
+    totalSent: BZZ;
     settlements: Settlements[];
 }
 export interface NodeAddresses {
-    overlay: string;
+    overlay: PeerAddress;
     underlay: string[];
-    ethereum: HexEthAddress;
+    ethereum: EthAddress;
     publicKey: PublicKey;
     pssPublicKey: PublicKey;
 }
 export interface Peer {
     address: string;
+    fullNode?: boolean;
 }
 export interface ChequebookAddressResponse {
     chequebookAddress: string;
 }
 export interface ChequebookBalanceResponse {
-    totalBalance: NumberString;
-    availableBalance: NumberString;
+    totalBalance: BZZ;
+    availableBalance: BZZ;
 }
 export interface TransactionOptions {
     /**
      * Gas price for the cashout transaction in WEI
      */
-    gasPrice?: NumberString;
+    gasPrice?: NumberString | string | bigint;
     /**
      * Gas limit for the cashout transaction in WEI
      */
-    gasLimit?: NumberString;
+    gasLimit?: NumberString | string | bigint;
 }
-export type CashoutOptions = TransactionOptions;
 export interface CashoutResult {
     recipient: string;
-    lastPayout: NumberString;
+    lastPayout: BZZ;
     bounced: boolean;
 }
 export interface LastCashoutActionResponse {
     peer: string;
-    uncashedAmount: NumberString;
+    uncashedAmount: BZZ;
     transactionHash: string | null;
     lastCashedCheque: Cheque | null;
     result: CashoutResult | null;
 }
 export interface TransactionResponse {
-    transactionHash: TransactionHash;
+    transactionHash: TransactionId;
 }
 export interface Cheque {
-    beneficiary: string;
-    chequebook: string;
-    payout: NumberString;
+    beneficiary: EthAddress;
+    chequebook: EthAddress;
+    payout: BZZ;
 }
 export interface LastChequesForPeerResponse {
     peer: string;
-    lastreceived: Cheque;
-    lastsent: Cheque;
+    lastreceived: Cheque | null;
+    lastsent: Cheque | null;
 }
 export interface LastChequesResponse {
     lastcheques: LastChequesForPeerResponse[];
 }
 export interface PeerBalance {
     peer: string;
-    balance: NumberString;
+    balance: BZZ;
 }
 export interface BalanceResponse {
     balances: PeerBalance[];
 }
 export interface DebugStatus {
-    peer: string;
+    overlay: string;
     proximity: number;
     beeMode: BeeModes;
     reserveSize: number;
+    reserveSizeWithinRadius: number;
     pullsyncRate: number;
     storageRadius: number;
     connectedPeers: number;
     neighborhoodSize: number;
     batchCommitment: number;
     isReachable: boolean;
+    lastSyncedBlock: number;
+    committedDepth: number;
 }
 export interface Health {
     status: 'ok';
     version: string;
     apiVersion: string;
 }
+export interface Readiness {
+    status: 'ready' | string;
+    version: string;
+    apiVersion: string;
+}
 export interface BeeVersions {
     supportedBeeVersion: string;
     supportedBeeApiVersion: string;
@@ -145,8 +111,9 @@ export declare enum BeeModes {
     ULTRA_LIGHT = "ultra-light",
     DEV = "dev"
 }
+export declare function toBeeMode(value: string): BeeModes;
 export interface RedistributionState {
-    minimumGasFunds: NumberString;
+    minimumGasFunds: DAI;
     hasSufficientFunds: boolean;
     isFrozen: boolean;
     isFullySynced: boolean;
@@ -156,20 +123,16 @@ export interface RedistributionState {
     lastPlayedRound: number;
     lastFrozenRound: number;
     lastSelectedRound: number;
-    lastSampleDuration: string;
+    lastSampleDurationSeconds: number;
     block: number;
-    reward: NumberString;
-    fees: NumberString;
+    reward: BZZ;
+    fees: DAI;
+    isHealthy: boolean;
 }
 /**
  * Information about Bee node and its configuration
  */
 export interface NodeInfo {
-    /**
-     * Indicates whether the node is in a Gateway mode.
-     * Gateway mode is a restricted mode where some features are not available.
-     */
-    gatewayMode: boolean;
     /**
      * Indicates in what mode Bee is running.
      */
@@ -177,13 +140,13 @@ export interface NodeInfo {
     /**
      * Indicates whether the Bee node has its own deployed chequebook.
      *
-     * @see [Bee docs - Chequebook](https://docs.ethswarm.org/docs/learn/glossary#cheques--chequebook)
+     * @see [Bee docs - Chequebook](https://docs.ethswarm.org/docs/references/glossary/#cheques--chequebook)
      */
     chequebookEnabled: boolean;
     /**
      * Indicates whether SWAP is enabled for the Bee node.
      *
-     * @see [Bee docs - SWAP](https://docs.ethswarm.org/docs/learn/glossary#swap)
+     * @see [Bee docs - SWAP](https://docs.ethswarm.org/docs/references/glossary/#swap)
      */
     swapEnabled: boolean;
 }
@@ -204,6 +167,8 @@ export interface Topology {
     timestamp: string;
     nnLowWatermark: number;
     depth: number;
+    reachability: string;
+    networkAvailability: string;
     bins: {
         bin_0: Bin;
         bin_1: Bin;
@@ -221,6 +186,22 @@ export interface Topology {
         bin_13: Bin;
         bin_14: Bin;
         bin_15: Bin;
+        bin_16: Bin;
+        bin_17: Bin;
+        bin_18: Bin;
+        bin_19: Bin;
+        bin_20: Bin;
+        bin_21: Bin;
+        bin_22: Bin;
+        bin_23: Bin;
+        bin_24: Bin;
+        bin_25: Bin;
+        bin_26: Bin;
+        bin_27: Bin;
+        bin_28: Bin;
+        bin_29: Bin;
+        bin_30: Bin;
+        bin_31: Bin;
     };
 }
 export interface PingResponse {
@@ -228,52 +209,19 @@ export interface PingResponse {
 }
 export interface ReserveState {
     radius: number;
-    commitment: number;
     storageRadius: number;
+    commitment: number;
 }
 export interface ChainState {
-    block: number;
     chainTip: number;
+    block: number;
     totalAmount: NumberString;
-    currentPrice: NumberString;
+    currentPrice: number;
 }
 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
-     */
+    bzzBalance: BZZ;
+    nativeTokenBalance: DAI;
     chainID: number;
-    /**
-     * Chequebook contract address
-     *
-     * @deprecated: Use chequebookContractAddress property instead
-     */
-    contractAddress: string;
-    /**
-     * Chequebook contract address
-     */
     chequebookContractAddress: string;
-    /**
-     * Node's wallet address
-     */
     walletAddress: string;
 }