@ethersphere/bee-js 3.2.0 → 3.3.2-pre.0

package/dist/mjs/modules/debug/status.js

@@ -0,0 +1,134 @@
+import { http } from "../../utils/http.js";
+import getMajorSemver from 'semver/functions/major.js'; // Following lines bellow are automatically updated with GitHub Action when Bee version is updated
+// so if you are changing anything about them change the `update_bee` action accordingly!
+
+export const SUPPORTED_BEE_VERSION_EXACT = '1.4.3-1213e063';
+export const SUPPORTED_API_VERSION = '2.0.0';
+export const SUPPORTED_DEBUG_API_VERSION = '1.2.1';
+export const SUPPORTED_BEE_VERSION = SUPPORTED_BEE_VERSION_EXACT.substring(0, SUPPORTED_BEE_VERSION_EXACT.indexOf('-'));
+const NODE_INFO_URL = 'node';
+const HEALTH_URL = 'health';
+/**
+ * Get health of node
+ *
+ * @param ky Ky debug instance
+ */
+
+export async function getHealth(ky) {
+  const response = await http(ky, {
+    method: 'get',
+    path: HEALTH_URL,
+    responseType: 'json'
+  });
+  return response.data;
+}
+/**
+ * Get information about Bee node
+ *
+ * @param ky Ky debug instance
+ */
+
+export async function getNodeInfo(ky) {
+  const response = await http(ky, {
+    method: 'get',
+    path: NODE_INFO_URL,
+    responseType: 'json'
+  });
+  return response.data;
+}
+/**
+ * Connects to a node and checks if it is a supported Bee version by the bee-js
+ *
+ * @param ky Ky debug instance
+ *
+ * @returns true if the Bee node version is supported
+ * @deprecated Use `isSupportedExactVersion` instead
+ */
+
+export async function isSupportedVersion(ky) {
+  return isSupportedExactVersion(ky);
+}
+/**
+ * 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.
+ *
+ * @param ky
+ */
+
+export async function isSupportedExactVersion(ky) {
+  const {
+    version
+  } = await getHealth(ky);
+  return version === SUPPORTED_BEE_VERSION_EXACT;
+}
+/**
+ * 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 ky
+ */
+
+export async function isSupportedMainApiVersion(ky) {
+  const {
+    apiVersion
+  } = await getHealth(ky);
+  return getMajorSemver(apiVersion) === getMajorSemver(SUPPORTED_API_VERSION);
+}
+/**
+ * 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 ky
+ */
+
+export async function isSupportedDebugApiVersion(ky) {
+  const {
+    debugApiVersion
+  } = await getHealth(ky);
+  return getMajorSemver(debugApiVersion) === getMajorSemver(SUPPORTED_DEBUG_API_VERSION);
+}
+/**
+ * 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 ky
+ */
+
+export async function isSupportedApiVersion(ky) {
+  const {
+    apiVersion,
+    debugApiVersion
+  } = await getHealth(ky);
+  return getMajorSemver(apiVersion) === getMajorSemver(SUPPORTED_API_VERSION) && getMajorSemver(debugApiVersion) === getMajorSemver(SUPPORTED_DEBUG_API_VERSION);
+}
+/**
+ * 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 ky
+ */
+
+export async function getVersions(ky) {
+  const {
+    version,
+    apiVersion,
+    debugApiVersion
+  } = await getHealth(ky);
+  return {
+    supportedBeeVersion: SUPPORTED_BEE_VERSION_EXACT,
+    supportedBeeApiVersion: SUPPORTED_API_VERSION,
+    supportedBeeDebugApiVersion: SUPPORTED_DEBUG_API_VERSION,
+    beeVersion: version,
+    beeApiVersion: apiVersion,
+    beeDebugApiVersion: debugApiVersion
+  };
+}

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

@@ -0,0 +1,16 @@
+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.data;
+}

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

@@ -0,0 +1,63 @@
+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.data.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.data;
+}
+/**
+ * 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.data.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) {
+  const response = await http(ky, {
+    method: 'delete',
+    headers: {
+      'gas-price': gasPrice
+    },
+    path: `${transactionsEndpoint}/${transactionHash}`,
+    responseType: 'json'
+  });
+  return response.data.transactionHash;
+}

package/dist/mjs/modules/feed.js

@@ -0,0 +1,67 @@
+import { filterHeaders, http } from "../utils/http.js";
+import { extractUploadHeaders } from "../utils/headers.js";
+import { BeeError } from "../utils/error.js";
+const feedEndpoint = 'feeds';
+/**
+ * Create an initial feed root manifest
+ *
+ * @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 async function createFeedManifest(ky, owner, topic, postageBatchId, options) {
+  const response = await http(ky, {
+    method: 'post',
+    responseType: 'json',
+    path: `${feedEndpoint}/${owner}/${topic}`,
+    searchParams: filterHeaders(options),
+    headers: extractUploadHeaders(postageBatchId)
+  });
+  return response.data.reference;
+}
+
+function readFeedUpdateHeaders(headers) {
+  const feedIndex = headers.get('swarm-feed-index');
+  const feedIndexNext = headers.get('swarm-feed-index-next');
+
+  if (!feedIndex) {
+    throw new BeeError('Response did not contain expected swarm-feed-index!');
+  }
+
+  if (!feedIndexNext) {
+    throw new BeeError('Response did not contain expected swarm-feed-index-next!');
+  }
+
+  return {
+    feedIndex,
+    feedIndexNext
+  };
+}
+/**
+ * Find and retrieve feed update
+ *
+ * The feed consists of updates. This endpoint looks up an
+ * update that matches the provided parameters and returns
+ * the reference it contains along with its index and the
+ * index of the subsequent update.
+ *
+ * @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 async function fetchFeedUpdate(ky, owner, topic, options) {
+  const response = await http(ky, {
+    responseType: 'json',
+    path: `${feedEndpoint}/${owner}/${topic}`,
+    searchParams: filterHeaders(options)
+  });
+  return { ...response.data,
+    ...readFeedUpdateHeaders(response.headers)
+  };
+}

package/dist/mjs/modules/pinning.js

@@ -0,0 +1,66 @@
+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.data;
+}
+/**
+ * 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}`
+  });
+  const result = response.data.references;
+
+  if (result === null) {
+    return [];
+  }
+
+  return result;
+}

package/dist/mjs/modules/pss.js

@@ -0,0 +1,40 @@
+import WebSocket from 'isomorphic-ws';
+import { prepareData } from "../utils/data.js";
+import { http } from "../utils/http.js";
+import { extractUploadHeaders } from "../utils/headers.js";
+const endpoint = 'pss';
+/**
+ * Send to recipient or target with Postal Service for Swarm
+ *
+ * @param ky Ky instance for given Bee class instance
+ * @param topic Topic name
+ * @param target Target message address prefix
+ * @param data
+ * @param postageBatchId Postage BatchId that will be assigned to sent message
+ * @param recipient Recipient public key
+ *
+ */
+
+export async function send(ky, topic, target, data, postageBatchId, recipient) {
+  await http(ky, {
+    method: 'post',
+    path: `${endpoint}/send/${topic}/${target}`,
+    body: await prepareData(data),
+    responseType: 'json',
+    searchParams: {
+      recipient
+    },
+    headers: extractUploadHeaders(postageBatchId)
+  });
+}
+/**
+ * Subscribe for messages on the given topic
+ *
+ * @param url Bee node URL
+ * @param topic Topic name
+ */
+
+export function subscribe(url, topic) {
+  const wsUrl = url.replace(/^http/i, 'ws');
+  return new WebSocket(`${wsUrl}/${endpoint}/subscribe/${topic}`);
+}

package/dist/mjs/modules/soc.js

@@ -0,0 +1,31 @@
+import { extractUploadHeaders } from "../utils/headers.js";
+import { http } from "../utils/http.js";
+const socEndpoint = 'soc';
+/**
+ * Upload single owner chunk (SOC) to a Bee node
+ *
+ * @param ky Ky instance
+ * @param owner           Owner's ethereum address in hex
+ * @param identifier      Arbitrary identifier in hex
+ * @param signature       Signature in hex
+ * @param data            Content addressed chunk data to be uploaded
+ * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
+ * @param options         Additional options like tag, encryption, pinning
+ */
+
+export async function upload(ky, owner, identifier, signature, data, postageBatchId, options) {
+  const response = await http(ky, {
+    method: 'post',
+    path: `${socEndpoint}/${owner}/${identifier}`,
+    body: data,
+    headers: {
+      'content-type': 'application/octet-stream',
+      ...extractUploadHeaders(postageBatchId, options)
+    },
+    responseType: 'json',
+    searchParams: {
+      sig: signature
+    }
+  });
+  return response.data.reference;
+}

package/dist/mjs/modules/status.js

@@ -0,0 +1,12 @@
+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/mjs/modules/stewardship.js

@@ -0,0 +1,24 @@
+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.data.isRetrievable;
+}

package/dist/mjs/modules/tag.js

@@ -0,0 +1,77 @@
+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.data;
+}
+/**
+ * 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.data;
+}
+/**
+ * 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.data.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/mjs/package.json

@@ -0,0 +1,8 @@
+{
+    "type": "module",
+    "browser": {
+     "stream": false,
+      "./utils/data.js": "./utils/data.browser.js",
+      "./utils/collection.node.js": "./utils/collection.browser.js"
+    }
+}

package/dist/mjs/types/debug.js

@@ -0,0 +1,7 @@
+export var BeeModes;
+
+(function (BeeModes) {
+  BeeModes["FULL"] = "full";
+  BeeModes["LIGHT"] = "light";
+  BeeModes["DEV"] = "dev";
+})(BeeModes || (BeeModes = {}));

package/dist/mjs/types/index.js

@@ -0,0 +1,37 @@
+export * from "./debug.js";
+export const SPAN_SIZE = 8;
+export const SECTION_SIZE = 32;
+export const BRANCHES = 128;
+export const CHUNK_SIZE = SECTION_SIZE * BRANCHES;
+export const ADDRESS_HEX_LENGTH = 64;
+export const PSS_TARGET_HEX_LENGTH_MAX = 6;
+export const PUBKEY_HEX_LENGTH = 66;
+export const BATCH_ID_HEX_LENGTH = 64;
+export const REFERENCE_HEX_LENGTH = 64;
+export const ENCRYPTED_REFERENCE_HEX_LENGTH = 128;
+export const REFERENCE_BYTES_LENGTH = 32;
+export const ENCRYPTED_REFERENCE_BYTES_LENGTH = 64;
+/**
+ * Minimal depth that can be used for creation of postage batch
+ */
+
+export const STAMPS_DEPTH_MIN = 17;
+/**
+ * Maximal depth that can be used for creation of postage batch
+ */
+
+export const STAMPS_DEPTH_MAX = 255;
+export const TAGS_LIMIT_MIN = 1;
+export const TAGS_LIMIT_MAX = 1000;
+/*********************************************************
+ * Writers and Readers interfaces
+ */
+
+export const TOPIC_BYTES_LENGTH = 32;
+export const TOPIC_HEX_LENGTH = 64;
+/*********************************************************
+ * Ethereum compatible signing interfaces and definitions
+ */
+
+export const SIGNATURE_HEX_LENGTH = 130;
+export const SIGNATURE_BYTES_LENGTH = 65;

package/dist/mjs/types/ky-options.js

@@ -0,0 +1,7 @@
+/**
+ * Types extracted from Ky as a backport for older Ky non-ESM version
+ *
+ * @author https://github.com/sindresorhus
+ * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
+ */
+export {};

package/dist/mjs/types/ky-universal/common.js

@@ -0,0 +1,7 @@
+/**
+ * Types extracted from Ky as a backport for older Ky non-ESM version
+ *
+ * @author https://github.com/sindresorhus
+ * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
+ */
+export {};

package/dist/mjs/types/ky-universal/hooks.js

@@ -0,0 +1,7 @@
+/**
+ * Types extracted from Ky as a backport for older Ky non-ESM version
+ *
+ * @author https://github.com/sindresorhus
+ * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
+ */
+export {};

package/dist/mjs/types/ky-universal/retry.js

@@ -0,0 +1,7 @@
+/**
+ * Types extracted from Ky as a backport for older Ky non-ESM version
+ *
+ * @author https://github.com/sindresorhus
+ * @licence MIT https://github.com/sindresorhus/ky/blob/main/license
+ */
+export {};