@ethersphere/bee-js 6.0.0-pre.0 → 6.0.0-pre.10

package/dist/src/modules/debug/balance.js

@@ -1,57 +0,0 @@
-import { http } from "../../utils/http.js";
-const balancesEndpoint = 'balances';
-const consumedEndpoint = 'consumed';
-/**
- * Get the balances with all known peers including prepaid services
- *
- * @param ky Ky debug instance
- */
-
-export async function getAllBalances(ky) {
-  const response = await http(ky, {
-    path: balancesEndpoint,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get the balances with a specific peer including prepaid services
- *
- * @param ky Ky debug instance
- * @param address Swarm address of peer
- */
-
-export async function getPeerBalance(ky, address) {
-  const response = await http(ky, {
-    path: `${balancesEndpoint}/${address}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get the past due consumption balances with all known peers
- *
- * @param ky Ky debug instance
- */
-
-export async function getPastDueConsumptionBalances(ky) {
-  const response = await http(ky, {
-    path: consumedEndpoint,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get the past due consumption balance with a specific peer
- *
- * @param ky Ky debug instance
- * @param address Swarm address of peer
- */
-
-export async function getPastDueConsumptionPeerBalance(ky, address) {
-  const response = await http(ky, {
-    path: `${consumedEndpoint}/${address}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}

package/dist/src/modules/debug/chequebook.js

@@ -1,150 +0,0 @@
-import { http } from "../../utils/http.js";
-const chequebookEndpoint = 'chequebook';
-/**
- * Get the address of the chequebook contract used
- *
- * @param ky Ky debug instance
- */
-
-export async function getChequebookAddress(ky) {
-  const response = await http(ky, {
-    path: chequebookEndpoint + '/address',
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get the balance of the chequebook
- *
- * @param ky Ky debug instance
- */
-
-export async function getChequebookBalance(ky) {
-  const response = await http(ky, {
-    path: chequebookEndpoint + '/balance',
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get last cashout action for the peer
- *
- * @param ky Ky debug instance
- * @param peer  Swarm address of peer
- */
-
-export async function getLastCashoutAction(ky, peer) {
-  const response = await http(ky, {
-    path: chequebookEndpoint + `/cashout/${peer}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Cashout the last cheque for the peer
- *
- * @param ky Ky debug instance
- * @param peer  Swarm address of peer
- * @param options
- */
-
-export async function cashoutLastCheque(ky, peer, options) {
-  const headers = {};
-
-  if (options?.gasPrice) {
-    headers['gas-price'] = options.gasPrice.toString();
-  }
-
-  if (options?.gasLimit) {
-    headers['gas-limit'] = options.gasLimit.toString();
-  }
-
-  const response = await http(ky, {
-    method: 'post',
-    path: chequebookEndpoint + `/cashout/${peer}`,
-    responseType: 'json',
-    headers
-  });
-  return response.parsedData.transactionHash;
-}
-/**
- * Get last cheques for the peer
- *
- * @param ky Ky debug instance
- * @param peer  Swarm address of peer
- */
-
-export async function getLastChequesForPeer(ky, peer) {
-  const response = await http(ky, {
-    path: chequebookEndpoint + `/cheque/${peer}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get last cheques for all peers
- *
- * @param ky Ky debug instance
- */
-
-export async function getLastCheques(ky) {
-  const response = await http(ky, {
-    path: chequebookEndpoint + '/cheque',
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Deposit tokens from overlay address into chequebook
- *
- * @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 async function depositTokens(ky, amount, gasPrice) {
-  const headers = {};
-
-  if (gasPrice) {
-    headers['gas-price'] = gasPrice.toString();
-  }
-
-  const response = await http(ky, {
-    method: 'post',
-    path: chequebookEndpoint + '/deposit',
-    responseType: 'json',
-    searchParams: {
-      amount: amount.toString(10)
-    },
-    headers
-  });
-  return response.parsedData.transactionHash;
-}
-/**
- * Withdraw tokens from the chequebook to the overlay address
- *
- * @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 async function withdrawTokens(ky, amount, gasPrice) {
-  const headers = {};
-
-  if (gasPrice) {
-    headers['gas-price'] = gasPrice.toString();
-  }
-
-  const response = await http(ky, {
-    method: 'post',
-    path: chequebookEndpoint + '/withdraw',
-    responseType: 'json',
-    searchParams: {
-      amount: amount.toString(10)
-    },
-    headers
-  });
-  return response.parsedData.transactionHash;
-}

package/dist/src/modules/debug/connectivity.js

@@ -1,45 +0,0 @@
-import { http } from "../../utils/http.js";
-export async function getNodeAddresses(ky) {
-  const response = await http(ky, {
-    path: 'addresses',
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-export async function getPeers(ky) {
-  const response = await http(ky, {
-    path: 'peers',
-    responseType: 'json'
-  });
-  return response.parsedData.peers;
-}
-export async function getBlocklist(ky) {
-  const response = await http(ky, {
-    path: 'blocklist',
-    responseType: 'json'
-  });
-  return response.parsedData.peers;
-}
-export async function removePeer(ky, peer) {
-  const response = await http(ky, {
-    path: `peers/${peer}`,
-    responseType: 'json',
-    method: 'DELETE'
-  });
-  return response.parsedData;
-}
-export async function getTopology(ky) {
-  const response = await http(ky, {
-    path: `topology`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-export async function pingPeer(ky, peer) {
-  const response = await http(ky, {
-    path: `pingpong/${peer}`,
-    responseType: 'json',
-    method: 'POST'
-  });
-  return response.parsedData;
-}

package/dist/src/modules/debug/settlements.js

@@ -1,29 +0,0 @@
-import { http } from "../../utils/http.js";
-const settlementsEndpoint = 'settlements';
-/**
- * Get amount of sent and received from settlements with a peer
- *
- * @param ky Ky debug instance
- * @param peer  Swarm address of peer
- */
-
-export async function getSettlements(ky, peer) {
-  const response = await http(ky, {
-    path: `${settlementsEndpoint}/${peer}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get settlements with all known peers and total amount sent or received
- *
- * @param ky Ky debug instance
- */
-
-export async function getAllSettlements(ky) {
-  const response = await http(ky, {
-    path: settlementsEndpoint,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}

package/dist/src/modules/debug/stamps.js

@@ -1,64 +0,0 @@
-import { http } from "../../utils/http.js";
-const STAMPS_ENDPOINT = 'stamps';
-export async function getAllPostageBatches(ky) {
-  const response = await http(ky, {
-    method: 'get',
-    path: `${STAMPS_ENDPOINT}`,
-    responseType: 'json'
-  });
-  return response.parsedData.stamps;
-}
-export async function getPostageBatch(ky, postageBatchId) {
-  const response = await http(ky, {
-    method: 'get',
-    path: `${STAMPS_ENDPOINT}/${postageBatchId}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-export async function getPostageBatchBuckets(ky, postageBatchId) {
-  const response = await http(ky, {
-    method: 'get',
-    path: `${STAMPS_ENDPOINT}/${postageBatchId}/buckets`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-export async function createPostageBatch(ky, amount, depth, options) {
-  const headers = {};
-
-  if (options?.gasPrice) {
-    headers['gas-price'] = options.gasPrice.toString();
-  }
-
-  if (options?.immutableFlag !== undefined) {
-    headers.immutable = String(options.immutableFlag);
-  }
-
-  const response = await http(ky, {
-    method: 'post',
-    path: `${STAMPS_ENDPOINT}/${amount}/${depth}`,
-    responseType: 'json',
-    searchParams: {
-      label: options?.label
-    },
-    headers
-  });
-  return response.parsedData.batchID;
-}
-export async function topUpBatch(ky, id, amount) {
-  const response = await http(ky, {
-    method: 'patch',
-    path: `${STAMPS_ENDPOINT}/topup/${id}/${amount}`,
-    responseType: 'json'
-  });
-  return response.parsedData.batchID;
-}
-export async function diluteBatch(ky, id, depth) {
-  const response = await http(ky, {
-    method: 'patch',
-    path: `${STAMPS_ENDPOINT}/dilute/${id}/${depth}`,
-    responseType: 'json'
-  });
-  return response.parsedData.batchID;
-}

package/dist/src/modules/debug/states.js

@@ -1,46 +0,0 @@
-import { http } from "../../utils/http.js";
-const RESERVE_STATE_ENDPOINT = 'reservestate';
-const WALLET_ENDPOINT = 'wallet';
-const CHAIN_STATE_ENDPOINT = 'chainstate';
-/**
- * Get state of reserve
- *
- * @param ky Ky debug instance
- */
-
-export async function getReserveState(ky) {
-  const response = await http(ky, {
-    method: 'get',
-    path: `${RESERVE_STATE_ENDPOINT}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get state of reserve
- *
- * @param ky Ky debug instance
- */
-
-export async function getChainState(ky) {
-  const response = await http(ky, {
-    method: 'get',
-    path: `${CHAIN_STATE_ENDPOINT}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get wallet balances for xDai and BZZ of the node
- *
- * @param ky Ky debug instance
- */
-
-export async function getWalletBalance(ky) {
-  const response = await http(ky, {
-    method: 'get',
-    path: `${WALLET_ENDPOINT}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}

package/dist/src/modules/debug/tag.js

@@ -1,16 +0,0 @@
-import { http } from "../../utils/http.js";
-const endpoint = 'tags';
-/**
- * Retrieve tag with extended information from Bee node
- *
- * @param ky Ky debug instance
- * @param uid UID of tag to be retrieved
- */
-
-export async function retrieveExtendedTag(ky, uid) {
-  const response = await http(ky, {
-    path: `${endpoint}/${uid}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}

package/dist/src/modules/debug/transactions.js

@@ -1,69 +0,0 @@
-import { http } from "../../utils/http.js";
-const transactionsEndpoint = 'transactions';
-/**
- * Get list of all pending transactions
- *
- * @param ky   Debug Ky instance
- */
-
-export async function getAllTransactions(ky) {
-  const response = await http(ky, {
-    path: transactionsEndpoint,
-    responseType: 'json'
-  });
-  return response.parsedData.pendingTransactions;
-}
-/**
- * Get information for specific pending transactions
- *
- * @param ky   Debug Ky instance
- * @param transactionHash Hash of the transaction
- */
-
-export async function getTransaction(ky, transactionHash) {
-  const response = await http(ky, {
-    path: `${transactionsEndpoint}/${transactionHash}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Rebroadcast existing transaction
- *
- * @param ky   Debug Ky instance
- * @param transactionHash Hash of the transaction
- */
-
-export async function rebroadcastTransaction(ky, transactionHash) {
-  const response = await http(ky, {
-    method: 'post',
-    path: `${transactionsEndpoint}/${transactionHash}`,
-    responseType: 'json'
-  });
-  return response.parsedData.transactionHash;
-}
-/**
- * Cancel existing transaction
- *
- * @param ky   Debug Ky instance
- * @param transactionHash Hash of the transaction
- * @param gasPrice Optional gas price
- */
-
-export async function cancelTransaction(ky, transactionHash, gasPrice) {
-  let headers;
-
-  if (gasPrice) {
-    headers = {
-      'gas-price': gasPrice
-    };
-  }
-
-  const response = await http(ky, {
-    method: 'delete',
-    headers,
-    path: `${transactionsEndpoint}/${transactionHash}`,
-    responseType: 'json'
-  });
-  return response.parsedData.transactionHash;
-}

package/dist/src/modules/pinning.js

@@ -1,60 +0,0 @@
-import { http } from "../utils/http.js";
-const PINNING_ENDPOINT = 'pins';
-/**
- * Pin data with given reference
- *
- * @param ky Ky instance for given Bee class instance
- * @param reference Bee data reference
- */
-
-export async function pin(ky, reference) {
-  await http(ky, {
-    method: 'post',
-    responseType: 'json',
-    path: `${PINNING_ENDPOINT}/${reference}`
-  });
-}
-/**
- * Unpin data with given reference
- *
- * @param ky Ky instance for given Bee class instance
- * @param reference Bee data reference
- */
-
-export async function unpin(ky, reference) {
-  await http(ky, {
-    method: 'delete',
-    responseType: 'json',
-    path: `${PINNING_ENDPOINT}/${reference}`
-  });
-}
-/**
- * Get pin status for specific address.
- *
- * @param ky Ky instance
- * @param reference
- * @throws Error if given address is not pinned
- */
-
-export async function getPin(ky, reference) {
-  const response = await http(ky, {
-    method: 'get',
-    responseType: 'json',
-    path: `${PINNING_ENDPOINT}/${reference}`
-  });
-  return response.parsedData;
-}
-/**
- * Get list of all pins
- *
- * @param ky Ky instance
- */
-
-export async function getAllPins(ky) {
-  const response = await http(ky, {
-    method: 'get',
-    responseType: 'json',
-    path: `${PINNING_ENDPOINT}`
-  });
-  return response.parsedData.references;
-}

package/dist/src/modules/status.js

@@ -1,12 +0,0 @@
-import { http } from "../utils/http.js";
-/**
- * Ping the base bee URL. If connection was not successful throw error
- *
- * @param ky Ky instance for given Bee class instance
- */
-
-export async function checkConnection(ky) {
-  await http(ky, {
-    path: ''
-  });
-}

package/dist/src/modules/stewardship.js

@@ -1,24 +0,0 @@
-import { http } from "../utils/http.js";
-const stewardshipEndpoint = 'stewardship';
-/**
- * Reupload locally pinned data
- * @param ky Ky instance
- * @param reference
- * @param options
- * @throws BeeResponseError if not locally pinned or invalid data
- */
-
-export async function reupload(ky, reference) {
-  await http(ky, {
-    method: 'put',
-    path: `${stewardshipEndpoint}/${reference}`
-  });
-}
-export async function isRetrievable(ky, reference) {
-  const response = await http(ky, {
-    method: 'get',
-    responseType: 'json',
-    path: `${stewardshipEndpoint}/${reference}`
-  });
-  return response.parsedData.isRetrievable;
-}

package/dist/src/modules/tag.js

@@ -1,77 +0,0 @@
-import { http } from "../utils/http.js";
-const endpoint = 'tags';
-/**
- * Create new tag on the Bee node
- *
- * @param url Bee tag URL
- */
-
-export async function createTag(ky) {
-  const response = await http(ky, {
-    method: 'post',
-    path: endpoint,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Retrieve tag information from Bee node
- *
- * @param url Bee tag URL
- * @param uid UID of tag to be retrieved
- */
-
-export async function retrieveTag(ky, uid) {
-  const response = await http(ky, {
-    path: `${endpoint}/${uid}`,
-    responseType: 'json'
-  });
-  return response.parsedData;
-}
-/**
- * Get limited listing of all tags.
- *
- * @param url
- * @param offset
- * @param limit
- */
-
-export async function getAllTags(ky, offset, limit) {
-  const response = await http(ky, {
-    path: `${endpoint}`,
-    searchParams: {
-      offset,
-      limit
-    },
-    responseType: 'json'
-  });
-  return response.parsedData.tags;
-}
-/**
- * Removes tag from the Bee node.
- * @param url
- * @param uid
- */
-
-export async function deleteTag(ky, uid) {
-  await http(ky, {
-    method: 'delete',
-    path: `${endpoint}/${uid}`
-  });
-}
-/**
- * Updates tag
- * @param url
- * @param uid
- * @param reference
- */
-
-export async function updateTag(ky, uid, reference) {
-  await http(ky, {
-    method: 'patch',
-    path: `${endpoint}/${uid}`,
-    json: {
-      reference
-    }
-  });
-}

package/dist/src/utils/error.js

@@ -1,47 +0,0 @@
-export class BeeError extends Error {
-  constructor(message) {
-    super(message);
-  }
-
-}
-export class BeeArgumentError extends BeeError {
-  constructor(message, value) {
-    super(message);
-    this.value = value;
-  }
-
-}
-export class BeeRequestError extends BeeError {
-  /**
-   * @param message
-   * @param requestOptions KyOptions that were used to assemble the request. THIS MIGHT NOT BE COMPLETE! If custom Ky instance was used that has set defaults then these defaults are not visible in this object!
-   */
-  constructor(message, requestOptions) {
-    super(message);
-    this.requestOptions = requestOptions;
-  }
-
-}
-export class BeeResponseError extends BeeError {
-  /**
-   * @param status HTTP status code number
-   * @param response Response returned from the server
-   * @param responseBody Response body as string which is returned from response.text() call
-   * @param requestOptions KyOptions that were used to assemble the request. THIS MIGHT NOT BE COMPLETE! If custom Ky instance was used that has set defaults then these defaults are not visible in this object!
-   * @param message
-   */
-  constructor(status, response, responseBody, requestOptions, message) {
-    super(message);
-    this.status = status;
-    this.response = response;
-    this.responseBody = responseBody;
-    this.requestOptions = requestOptions;
-  }
-
-}
-export class BeeNotAJsonError extends BeeError {
-  constructor() {
-    super(`Received response is not valid JSON.`);
-  }
-
-}