@ethersphere/bee-js 2.0.0 → 3.1.0

package/src/bee-debug.ts

@@ -1,559 +0,0 @@
-import * as connectivity from './modules/debug/connectivity'
-import * as balance from './modules/debug/balance'
-import * as chequebook from './modules/debug/chequebook'
-import * as settlements from './modules/debug/settlements'
-import * as status from './modules/debug/status'
-import * as transactions from './modules/debug/transactions'
-import * as states from './modules/debug/states'
-import type {
-  Address,
-  Peer,
-  BalanceResponse,
-  PeerBalance,
-  ChequebookAddressResponse,
-  ChequebookBalanceResponse,
-  LastChequesResponse,
-  LastChequesForPeerResponse,
-  LastCashoutActionResponse,
-  Settlements,
-  AllSettlements,
-  RemovePeerResponse,
-  Topology,
-  PingResponse,
-  Health,
-  NodeAddresses,
-  ReserveState,
-  ChainState,
-  NumberString,
-  ExtendedTag,
-  PostageBatchBuckets,
-  DebugPostageBatch,
-  Ky,
-  TransactionInfo,
-  TransactionHash,
-} from './types'
-import { BeeArgumentError } from './utils/error'
-import { assertBeeUrl, stripLastSlash } from './utils/url'
-import {
-  assertAddress,
-  assertBatchId,
-  assertBoolean,
-  assertCashoutOptions,
-  assertNonNegativeInteger,
-  assertRequestOptions,
-  assertTransactionHash,
-  isTag,
-} from './utils/type'
-import {
-  BatchId,
-  BeeOptions,
-  CashoutOptions,
-  PostageBatchOptions,
-  RequestOptions,
-  STAMPS_DEPTH_MAX,
-  STAMPS_DEPTH_MIN,
-  Tag,
-} from './types'
-import * as tag from './modules/debug/tag'
-import * as stamps from './modules/debug/stamps'
-import type { Options as KyOptions } from 'ky-universal'
-import { makeDefaultKy, wrapRequestClosure, wrapResponseClosure } from './utils/http'
-
-/**
- * The BeeDebug class provides a way of interacting with the Bee debug APIs based on the provided url
- *
- * @param url URL of a running Bee node
- */
-export class BeeDebug {
-  /**
-   * URL on which is the Debug API of Bee node exposed
-   */
-  public readonly url: string
-
-  /**
-   * Ky instance that defines connection to Bee node
-   * @private
-   */
-  private readonly ky: Ky
-
-  constructor(url: string, options?: BeeOptions) {
-    assertBeeUrl(url)
-
-    // Remove last slash if present, as our endpoint strings starts with `/...`
-    // which could lead to double slash in URL to which Bee responds with
-    // unnecessary redirects.
-    this.url = stripLastSlash(url)
-
-    const kyOptions: KyOptions = {
-      prefixUrl: this.url,
-      timeout: options?.timeout ?? false,
-      retry: options?.retry,
-      fetch: options?.fetch,
-      hooks: {
-        beforeRequest: [],
-        afterResponse: [],
-      },
-    }
-
-    if (options?.defaultHeaders) {
-      kyOptions.headers = options.defaultHeaders
-    }
-
-    if (options?.onRequest) {
-      kyOptions.hooks!.beforeRequest!.push(wrapRequestClosure(options.onRequest))
-    }
-
-    if (options?.onResponse) {
-      kyOptions.hooks!.afterResponse!.push(wrapResponseClosure(options.onResponse))
-    }
-
-    this.ky = makeDefaultKy(kyOptions)
-  }
-
-  async getNodeAddresses(options?: RequestOptions): Promise<NodeAddresses> {
-    assertRequestOptions(options)
-
-    return connectivity.getNodeAddresses(this.getKy(options))
-  }
-
-  async getBlocklist(options?: RequestOptions): Promise<Peer[]> {
-    assertRequestOptions(options)
-
-    return connectivity.getBlocklist(this.getKy(options))
-  }
-
-  /**
-   * 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)
-   *
-   */
-  async retrieveExtendedTag(tagUid: number | Tag, options?: RequestOptions): Promise<ExtendedTag> {
-    assertRequestOptions(options)
-
-    if (isTag(tagUid)) {
-      tagUid = tagUid.uid
-    } else if (typeof tagUid === 'number') {
-      assertNonNegativeInteger(tagUid, 'UID')
-    } else {
-      throw new TypeError('tagUid has to be either Tag or a number (UID)!')
-    }
-
-    return tag.retrieveExtendedTag(this.getKy(options), tagUid)
-  }
-
-  /**
-   * Get list of peers for this node
-   */
-  async getPeers(options?: RequestOptions): Promise<Peer[]> {
-    assertRequestOptions(options)
-
-    return connectivity.getPeers(this.getKy(options))
-  }
-
-  async removePeer(peer: string | Address, options?: RequestOptions): Promise<RemovePeerResponse> {
-    assertRequestOptions(options)
-    assertAddress(peer)
-
-    return connectivity.removePeer(this.getKy(options), peer)
-  }
-
-  async getTopology(options?: RequestOptions): Promise<Topology> {
-    assertRequestOptions(options)
-
-    return connectivity.getTopology(this.getKy(options))
-  }
-
-  async pingPeer(peer: string | Address, options?: RequestOptions): Promise<PingResponse> {
-    assertRequestOptions(options)
-    assertAddress(peer)
-
-    return connectivity.pingPeer(this.getKy(options), peer)
-  }
-
-  /*
-   * Balance endpoints
-   */
-
-  /**
-   * Get the balances with all known peers including prepaid services
-   */
-  async getAllBalances(options?: RequestOptions): Promise<BalanceResponse> {
-    assertRequestOptions(options)
-
-    return balance.getAllBalances(this.getKy(options))
-  }
-
-  /**
-   * Get the balances with a specific peer including prepaid services
-   *
-   * @param address Swarm address of peer
-   */
-  async getPeerBalance(address: Address | string, options?: RequestOptions): Promise<PeerBalance> {
-    assertRequestOptions(options)
-    assertAddress(address)
-
-    return balance.getPeerBalance(this.getKy(options), address)
-  }
-
-  /**
-   * Get the past due consumption balances with all known peers
-   */
-  async getPastDueConsumptionBalances(options?: RequestOptions): Promise<BalanceResponse> {
-    assertRequestOptions(options)
-
-    return balance.getPastDueConsumptionBalances(this.getKy(options))
-  }
-
-  /**
-   * Get the past due consumption balance with a specific peer
-   *
-   * @param address Swarm address of peer
-   */
-  async getPastDueConsumptionPeerBalance(address: Address | string, options?: RequestOptions): Promise<PeerBalance> {
-    assertRequestOptions(options)
-    assertAddress(address)
-
-    return balance.getPastDueConsumptionPeerBalance(this.getKy(options), address)
-  }
-
-  /*
-   * Chequebook endpoints
-   */
-
-  /**
-   * 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
-   */
-  async getChequebookAddress(options?: RequestOptions): Promise<ChequebookAddressResponse> {
-    assertRequestOptions(options)
-
-    return chequebook.getChequebookAddress(this.getKy(options))
-  }
-
-  /**
-   * Get the balance of the chequebook
-   */
-  async getChequebookBalance(options?: RequestOptions): Promise<ChequebookBalanceResponse> {
-    assertRequestOptions(options)
-
-    return chequebook.getChequebookBalance(this.getKy(options))
-  }
-
-  /**
-   * Get last cheques for all peers
-   */
-  async getLastCheques(options?: RequestOptions): Promise<LastChequesResponse> {
-    assertRequestOptions(options)
-
-    return chequebook.getLastCheques(this.getKy(options))
-  }
-
-  /**
-   * Get last cheques for the peer
-   *
-   * @param address  Swarm address of peer
-   */
-  async getLastChequesForPeer(
-    address: Address | string,
-    options?: RequestOptions,
-  ): Promise<LastChequesForPeerResponse> {
-    assertRequestOptions(options)
-    assertAddress(address)
-
-    return chequebook.getLastChequesForPeer(this.getKy(options), address)
-  }
-
-  /**
-   * Get last cashout action for the peer
-   *
-   * @param address  Swarm address of peer
-   */
-  async getLastCashoutAction(address: Address | string, options?: RequestOptions): Promise<LastCashoutActionResponse> {
-    assertRequestOptions(options)
-    assertAddress(address)
-
-    return chequebook.getLastCashoutAction(this.getKy(options), address)
-  }
-
-  /**
-   * 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
-   */
-  async cashoutLastCheque(address: string | Address, options?: CashoutOptions): Promise<string> {
-    assertCashoutOptions(options)
-    assertAddress(address)
-
-    return chequebook.cashoutLastCheque(this.getKy(options), address, options)
-  }
-
-  /**
-   * 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
-   */
-  async depositTokens(
-    amount: number | NumberString,
-    gasPrice?: NumberString,
-    options?: RequestOptions,
-  ): Promise<string> {
-    assertRequestOptions(options)
-    assertNonNegativeInteger(amount)
-
-    if (gasPrice) {
-      assertNonNegativeInteger(gasPrice)
-    }
-
-    return chequebook.depositTokens(this.getKy(options), amount, gasPrice)
-  }
-
-  /**
-   * 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
-   */
-  async withdrawTokens(
-    amount: number | NumberString,
-    gasPrice?: NumberString,
-    options?: RequestOptions,
-  ): Promise<string> {
-    assertRequestOptions(options)
-    assertNonNegativeInteger(amount)
-
-    if (gasPrice) {
-      assertNonNegativeInteger(gasPrice)
-    }
-
-    return chequebook.withdrawTokens(this.getKy(options), amount, gasPrice)
-  }
-
-  /*
-   * Settlements endpoint
-   */
-
-  /**
-   * Get amount of sent and received from settlements with a peer
-   *
-   * @param address  Swarm address of peer
-   */
-  async getSettlements(address: Address | string, options?: RequestOptions): Promise<Settlements> {
-    assertRequestOptions(options)
-    assertAddress(address)
-
-    return settlements.getSettlements(this.getKy(options), address)
-  }
-
-  /**
-   * Get settlements with all known peers and total amount sent or received
-   */
-  async getAllSettlements(options?: RequestOptions): Promise<AllSettlements> {
-    assertRequestOptions(options)
-
-    return settlements.getAllSettlements(this.getKy(options))
-  }
-
-  /**
-   * Get health of node
-   */
-  async getHealth(options?: RequestOptions): Promise<Health> {
-    assertRequestOptions(options)
-
-    return status.getHealth(this.getKy(options))
-  }
-
-  /**
-   * 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
-   */
-  async isSupportedVersion(options?: RequestOptions): Promise<boolean> | never {
-    assertRequestOptions(options)
-
-    return status.isSupportedVersion(this.getKy(options))
-  }
-
-  /**
-   * Get reserve state
-   */
-  async getReserveState(options?: RequestOptions): Promise<ReserveState> {
-    assertRequestOptions(options)
-
-    return states.getReserveState(this.getKy(options))
-  }
-
-  /**
-   * Get chain state
-   */
-  async getChainState(options?: RequestOptions): Promise<ChainState> {
-    assertRequestOptions(options)
-
-    return states.getChainState(this.getKy(options))
-  }
-
-  /**
-   * 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)
-   */
-  async createPostageBatch(amount: NumberString, depth: number, options?: PostageBatchOptions): Promise<BatchId> {
-    assertRequestOptions(options)
-    assertNonNegativeInteger(amount)
-    assertNonNegativeInteger(depth)
-
-    if (depth < STAMPS_DEPTH_MIN) {
-      throw new BeeArgumentError(`Depth has to be at least ${STAMPS_DEPTH_MIN}`, depth)
-    }
-
-    if (depth > STAMPS_DEPTH_MAX) {
-      throw new BeeArgumentError(`Depth has to be at most ${STAMPS_DEPTH_MAX}`, depth)
-    }
-
-    if (options?.gasPrice) {
-      assertNonNegativeInteger(options.gasPrice)
-    }
-
-    if (options?.immutableFlag !== undefined) {
-      assertBoolean(options.immutableFlag)
-    }
-
-    return stamps.createPostageBatch(this.getKy(options), amount, depth, options)
-  }
-
-  /**
-   * 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)
-   */
-  async getPostageBatch(postageBatchId: BatchId | string, options?: RequestOptions): Promise<DebugPostageBatch> {
-    assertRequestOptions(options)
-    assertBatchId(postageBatchId)
-
-    return stamps.getPostageBatch(this.getKy(options), postageBatchId)
-  }
-
-  /**
-   * 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)
-   */
-  async getPostageBatchBuckets(
-    postageBatchId: BatchId | string,
-    options?: RequestOptions,
-  ): Promise<PostageBatchBuckets> {
-    assertRequestOptions(options)
-    assertBatchId(postageBatchId)
-
-    return stamps.getPostageBatchBuckets(this.getKy(options), postageBatchId)
-  }
-
-  /**
-   * 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)
-   */
-  async getAllPostageBatch(options?: RequestOptions): Promise<DebugPostageBatch[]> {
-    assertRequestOptions(options)
-
-    return stamps.getAllPostageBatches(this.getKy(options))
-  }
-
-  /**
-   * Return lists of all current pending transactions that the Bee made
-   */
-  async getAllPendingTransactions(options?: RequestOptions): Promise<TransactionInfo[]> {
-    assertRequestOptions(options)
-
-    return transactions.getAllTransactions(this.getKy(options))
-  }
-
-  /**
-   * Return transaction information for specific transaction
-   * @param transactionHash
-   */
-  async getPendingTransaction(
-    transactionHash: TransactionHash | string,
-    options?: RequestOptions,
-  ): Promise<TransactionInfo> {
-    assertRequestOptions(options)
-    assertTransactionHash(transactionHash)
-
-    return transactions.getTransaction(this.getKy(options), transactionHash)
-  }
-
-  /**
-   * Rebroadcast already created transaction.
-   * This is mainly needed when your transaction fall off mempool from other reason is not incorporated into block.
-   *
-   * @param transactionHash
-   */
-  async rebroadcastPendingTransaction(
-    transactionHash: TransactionHash | string,
-    options?: RequestOptions,
-  ): Promise<TransactionHash> {
-    assertRequestOptions(options)
-    assertTransactionHash(transactionHash)
-
-    return transactions.rebroadcastTransaction(this.getKy(options), transactionHash)
-  }
-
-  /**
-   * Cancel currently pending transaction
-   * @param transactionHash
-   * @param gasPrice
-   */
-  async cancelPendingTransaction(
-    transactionHash: TransactionHash | string,
-    gasPrice?: NumberString,
-    options?: RequestOptions,
-  ): Promise<TransactionHash> {
-    assertRequestOptions(options)
-    assertTransactionHash(transactionHash)
-
-    if (gasPrice) {
-      assertNonNegativeInteger(gasPrice)
-    }
-
-    return transactions.cancelTransaction(this.getKy(options), transactionHash, gasPrice)
-  }
-
-  private getKy(options?: RequestOptions): Ky {
-    if (!options) {
-      return this.ky
-    }
-
-    return this.ky.extend(options)
-  }
-}