@ethersphere/bee-js 6.9.0 → 7.0.0

package/dist/mjs/utils/uint64.js

@@ -1,22 +0,0 @@
-import { makeBytes } from "./bytes.js"; // TODO handle bigger values than 32 bit
-// For now it's good enough because we only use these functions
-// sequential feed indexes.
-export function writeUint64LittleEndian(value, bytes = makeBytes(8)) {
-  const dataView = new DataView(bytes.buffer);
-  const valueLower32 = value & 0xffffffff;
-  const littleEndian = true;
-  dataView.setUint32(0, valueLower32, littleEndian);
-  dataView.setUint32(4, 0, littleEndian);
-  return bytes;
-}
-export function writeUint64BigEndian(value, bytes = makeBytes(8)) {
-  const dataView = new DataView(bytes.buffer);
-  const valueLower32 = value & 0xffffffff;
-  dataView.setUint32(0, 0);
-  dataView.setUint32(4, valueLower32);
-  return bytes;
-}
-export function readUint64BigEndian(bytes) {
-  const dataView = new DataView(bytes.buffer);
-  return dataView.getUint32(4);
-}

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

@@ -1,323 +0,0 @@
-import type { Address, AllSettlements, BalanceResponse, BeeRequestOptions, BeeVersions, ChainState, ChequebookAddressResponse, ChequebookBalanceResponse, DebugStatus, ExtendedTag, Health, LastCashoutActionResponse, LastChequesForPeerResponse, LastChequesResponse, NodeAddresses, NodeInfo, NumberString, Peer, PeerBalance, PingResponse, PostageBatch, PostageBatchBuckets, RedistributionState, RemovePeerResponse, ReserveState, Settlements, Topology, TransactionHash, TransactionInfo, WalletBalance } from './types';
-import { BatchId, BeeOptions, CashoutOptions, PostageBatchOptions, Tag, TransactionOptions } from './types';
-export declare class BeeDebug {
-    /**
-     * URL on which is the Debug API of Bee node exposed
-     */
-    readonly url: string;
-    /**
-     * Ky instance that defines connection to Bee node
-     * @private
-     */
-    private readonly requestOptions;
-    constructor(url: string, options?: BeeOptions);
-    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 Debug API version matches with the one that bee-js supports.
-     *
-     * This is useful if you are not using `Bee` class in your application and want to make sure
-     * about compatibility.
-     *
-     * @param options
-     */
-    isSupportedDebugApiVersion(options?: BeeRequestOptions): Promise<boolean> | never;
-    /**
-     *
-     * Connects to a node and checks if its Main and Debug API versions 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;
-    private getRequestOptionsForCall;
-}

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

@@ -1,6 +0,0 @@
-/**
- * Helper function for serialize byte arrays
- *
- * @param arrays Any number of byte array arguments
- */
-export declare function serializeBytes(...arrays: Uint8Array[]): Uint8Array;

package/dist/types/utils/stream.d.ts

@@ -1,40 +0,0 @@
-/// <reference types="node" />
-import { Readable as NodeReadableNative, ReadableOptions as NodeReadableOptions } from 'stream';
-import { ReadableStream } from 'web-streams-polyfill';
-import { Readable } from '../types';
-/**
- * Validates if passed object is either browser's ReadableStream
- * or Node's Readable.
- *
- * @param entry
- */
-export declare function isReadable(entry: unknown): entry is Readable;
-export declare function isReadableStream(entry: unknown): entry is ReadableStream;
-export declare function isNodeReadable(entry: unknown): entry is NodeReadableNative;
-/**
- * Function that converts Node's Readable into WHATWG ReadableStream
- *
- * Taken over from https://github.com/gwicke/node-web-streams/blob/master/lib/conversions.js
- * Because it uses forked web-streams-polyfill that are outdated.
- *
- * @author https://github.com/gwicke
- * @licence Apache License 2.0 https://github.com/gwicke/node-web-streams/blob/master/LICENSE
- * @param nodeStream
- */
-export declare function readableNodeToWeb(nodeStream: NodeReadableNative): ReadableStream<Uint8Array>;
-/**
- * Function that converts WHATWG ReadableStream into Node's Readable
- *
- * Taken over from https://github.com/gwicke/node-web-streams/blob/master/lib/conversions.js
- * Because it uses forked web-streams-polyfill that is outdated.
- *
- * **Warning!**
- * If you want to use this function in browser you have to polyfill `stream` package with your bundler.
- *
- * @author https://github.com/gwicke
- * @licence Apache License 2.0 https://github.com/gwicke/node-web-streams/blob/master/LICENSE
- * @param webStream
- * @param options
- */
-export declare function readableWebToNode(webStream: ReadableStream<unknown>, options?: NodeReadableOptions): NodeReadableNative;
-export declare function normalizeToReadableStream(stream: Readable): ReadableStream;

package/dist/types/utils/uint64.d.ts

@@ -1,4 +0,0 @@
-import { Bytes } from './bytes';
-export declare function writeUint64LittleEndian(value: number, bytes?: Bytes<8>): Bytes<8>;
-export declare function writeUint64BigEndian(value: number, bytes?: Bytes<8>): Bytes<8>;
-export declare function readUint64BigEndian(bytes: Bytes<8>): number;