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

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

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pingPeer = exports.getTopology = exports.removePeer = exports.getBlocklist = exports.getPeers = exports.getNodeAddresses = void 0;
+const http_1 = require("../../utils/http");
+function getNodeAddresses(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: 'addresses',
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getNodeAddresses = getNodeAddresses;
+function getPeers(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: 'peers',
+            responseType: 'json',
+        });
+        return response.data.peers || [];
+    });
+}
+exports.getPeers = getPeers;
+function getBlocklist(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: 'blocklist',
+            responseType: 'json',
+        });
+        return response.data.peers || [];
+    });
+}
+exports.getBlocklist = getBlocklist;
+function removePeer(ky, peer) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: `peers/${peer}`,
+            responseType: 'json',
+            method: 'DELETE',
+        });
+        return response.data;
+    });
+}
+exports.removePeer = removePeer;
+function getTopology(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: `topology`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getTopology = getTopology;
+function pingPeer(ky, peer) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: `pingpong/${peer}`,
+            responseType: 'json',
+            method: 'POST',
+        });
+        return response.data;
+    });
+}
+exports.pingPeer = pingPeer;

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

@@ -0,0 +1,45 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllSettlements = exports.getSettlements = void 0;
+const http_1 = require("../../utils/http");
+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
+ */
+function getSettlements(ky, peer) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: `${settlementsEndpoint}/${peer}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getSettlements = getSettlements;
+/**
+ * Get settlements with all known peers and total amount sent or received
+ *
+ * @param ky Ky debug instance
+ */
+function getAllSettlements(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: settlementsEndpoint,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getAllSettlements = getAllSettlements;

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

@@ -0,0 +1,89 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.diluteBatch = exports.topUpBatch = exports.createPostageBatch = exports.getPostageBatchBuckets = exports.getPostageBatch = exports.getAllPostageBatches = void 0;
+const http_1 = require("../../utils/http");
+const STAMPS_ENDPOINT = 'stamps';
+function getAllPostageBatches(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: `${STAMPS_ENDPOINT}`,
+            responseType: 'json',
+        });
+        return response.data.stamps || [];
+    });
+}
+exports.getAllPostageBatches = getAllPostageBatches;
+function getPostageBatch(ky, postageBatchId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: `${STAMPS_ENDPOINT}/${postageBatchId}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getPostageBatch = getPostageBatch;
+function getPostageBatchBuckets(ky, postageBatchId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: `${STAMPS_ENDPOINT}/${postageBatchId}/buckets`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getPostageBatchBuckets = getPostageBatchBuckets;
+function createPostageBatch(ky, amount, depth, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const headers = {};
+        if (options === null || options === void 0 ? void 0 : options.gasPrice) {
+            headers['gas-price'] = options.gasPrice.toString();
+        }
+        if ((options === null || options === void 0 ? void 0 : options.immutableFlag) !== undefined) {
+            headers.immutable = String(options.immutableFlag);
+        }
+        const response = yield (0, http_1.http)(ky, {
+            method: 'post',
+            path: `${STAMPS_ENDPOINT}/${amount}/${depth}`,
+            responseType: 'json',
+            searchParams: { label: options === null || options === void 0 ? void 0 : options.label },
+            headers,
+        });
+        return response.data.batchID;
+    });
+}
+exports.createPostageBatch = createPostageBatch;
+function topUpBatch(ky, id, amount) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'patch',
+            path: `${STAMPS_ENDPOINT}/topup/${id}/${amount}`,
+            responseType: 'json',
+        });
+        return response.data.batchID;
+    });
+}
+exports.topUpBatch = topUpBatch;
+function diluteBatch(ky, id, depth) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'patch',
+            path: `${STAMPS_ENDPOINT}/dilute/${id}/${depth}`,
+            responseType: 'json',
+        });
+        return response.data.batchID;
+    });
+}
+exports.diluteBatch = diluteBatch;

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

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChainState = exports.getReserveState = void 0;
+const http_1 = require("../../utils/http");
+const RESERVE_STATE_ENDPOINT = 'reservestate';
+const CHAIN_STATE_ENDPOINT = 'chainstate';
+/**
+ * Get state of reserve
+ *
+ * @param ky Ky debug instance
+ */
+function getReserveState(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: `${RESERVE_STATE_ENDPOINT}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getReserveState = getReserveState;
+/**
+ * Get state of reserve
+ *
+ * @param ky Ky debug instance
+ */
+function getChainState(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: `${CHAIN_STATE_ENDPOINT}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getChainState = getChainState;

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

@@ -0,0 +1,153 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersions = exports.isSupportedApiVersion = exports.isSupportedDebugApiVersion = exports.isSupportedMainApiVersion = exports.isSupportedExactVersion = exports.isSupportedVersion = exports.getNodeInfo = exports.getHealth = exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_DEBUG_API_VERSION = exports.SUPPORTED_API_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT = void 0;
+const http_1 = require("../../utils/http");
+const major_js_1 = __importDefault(require("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!
+exports.SUPPORTED_BEE_VERSION_EXACT = '1.4.3-1213e063';
+exports.SUPPORTED_API_VERSION = '2.0.0';
+exports.SUPPORTED_DEBUG_API_VERSION = '1.2.1';
+exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT.substring(0, exports.SUPPORTED_BEE_VERSION_EXACT.indexOf('-'));
+const NODE_INFO_URL = 'node';
+const HEALTH_URL = 'health';
+/**
+ * Get health of node
+ *
+ * @param ky Ky debug instance
+ */
+function getHealth(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: HEALTH_URL,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getHealth = getHealth;
+/**
+ * Get information about Bee node
+ *
+ * @param ky Ky debug instance
+ */
+function getNodeInfo(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            path: NODE_INFO_URL,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getNodeInfo = getNodeInfo;
+/**
+ * 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
+ */
+function isSupportedVersion(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return isSupportedExactVersion(ky);
+    });
+}
+exports.isSupportedVersion = isSupportedVersion;
+/**
+ * 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
+ */
+function isSupportedExactVersion(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { version } = yield getHealth(ky);
+        return version === exports.SUPPORTED_BEE_VERSION_EXACT;
+    });
+}
+exports.isSupportedExactVersion = isSupportedExactVersion;
+/**
+ * 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
+ */
+function isSupportedMainApiVersion(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { apiVersion } = yield getHealth(ky);
+        return (0, major_js_1.default)(apiVersion) === (0, major_js_1.default)(exports.SUPPORTED_API_VERSION);
+    });
+}
+exports.isSupportedMainApiVersion = isSupportedMainApiVersion;
+/**
+ * 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
+ */
+function isSupportedDebugApiVersion(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { debugApiVersion } = yield getHealth(ky);
+        return (0, major_js_1.default)(debugApiVersion) === (0, major_js_1.default)(exports.SUPPORTED_DEBUG_API_VERSION);
+    });
+}
+exports.isSupportedDebugApiVersion = isSupportedDebugApiVersion;
+/**
+ * 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
+ */
+function isSupportedApiVersion(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { apiVersion, debugApiVersion } = yield getHealth(ky);
+        return ((0, major_js_1.default)(apiVersion) === (0, major_js_1.default)(exports.SUPPORTED_API_VERSION) &&
+            (0, major_js_1.default)(debugApiVersion) === (0, major_js_1.default)(exports.SUPPORTED_DEBUG_API_VERSION));
+    });
+}
+exports.isSupportedApiVersion = isSupportedApiVersion;
+/**
+ * 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
+ */
+function getVersions(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { version, apiVersion, debugApiVersion } = yield getHealth(ky);
+        return {
+            supportedBeeVersion: exports.SUPPORTED_BEE_VERSION_EXACT,
+            supportedBeeApiVersion: exports.SUPPORTED_API_VERSION,
+            supportedBeeDebugApiVersion: exports.SUPPORTED_DEBUG_API_VERSION,
+            beeVersion: version,
+            beeApiVersion: apiVersion,
+            beeDebugApiVersion: debugApiVersion,
+        };
+    });
+}
+exports.getVersions = getVersions;

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

@@ -0,0 +1,30 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retrieveExtendedTag = void 0;
+const http_1 = require("../../utils/http");
+const endpoint = 'tags';
+/**
+ * Retrieve tag with extended information from Bee node
+ *
+ * @param ky Ky debug instance
+ * @param uid UID of tag to be retrieved
+ */
+function retrieveExtendedTag(ky, uid) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: `${endpoint}/${uid}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.retrieveExtendedTag = retrieveExtendedTag;

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

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelTransaction = exports.rebroadcastTransaction = exports.getTransaction = exports.getAllTransactions = void 0;
+const http_1 = require("../../utils/http");
+const transactionsEndpoint = 'transactions';
+/**
+ * Get list of all pending transactions
+ *
+ * @param ky   Debug Ky instance
+ */
+function getAllTransactions(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: transactionsEndpoint,
+            responseType: 'json',
+        });
+        return response.data.pendingTransactions;
+    });
+}
+exports.getAllTransactions = getAllTransactions;
+/**
+ * Get information for specific pending transactions
+ *
+ * @param ky   Debug Ky instance
+ * @param transactionHash Hash of the transaction
+ */
+function getTransaction(ky, transactionHash) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            path: `${transactionsEndpoint}/${transactionHash}`,
+            responseType: 'json',
+        });
+        return response.data;
+    });
+}
+exports.getTransaction = getTransaction;
+/**
+ * Rebroadcast existing transaction
+ *
+ * @param ky   Debug Ky instance
+ * @param transactionHash Hash of the transaction
+ */
+function rebroadcastTransaction(ky, transactionHash) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'post',
+            path: `${transactionsEndpoint}/${transactionHash}`,
+            responseType: 'json',
+        });
+        return response.data.transactionHash;
+    });
+}
+exports.rebroadcastTransaction = rebroadcastTransaction;
+/**
+ * Cancel existing transaction
+ *
+ * @param ky   Debug Ky instance
+ * @param transactionHash Hash of the transaction
+ * @param gasPrice Optional gas price
+ */
+function cancelTransaction(ky, transactionHash, gasPrice) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'delete',
+            headers: { 'gas-price': gasPrice },
+            path: `${transactionsEndpoint}/${transactionHash}`,
+            responseType: 'json',
+        });
+        return response.data.transactionHash;
+    });
+}
+exports.cancelTransaction = cancelTransaction;

package/dist/cjs/modules/feed.js

@@ -0,0 +1,76 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchFeedUpdate = exports.createFeedManifest = void 0;
+const http_1 = require("../utils/http");
+const headers_1 = require("../utils/headers");
+const error_1 = require("../utils/error");
+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')
+ */
+function createFeedManifest(ky, owner, topic, postageBatchId, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'post',
+            responseType: 'json',
+            path: `${feedEndpoint}/${owner}/${topic}`,
+            searchParams: (0, http_1.filterHeaders)(options),
+            headers: (0, headers_1.extractUploadHeaders)(postageBatchId),
+        });
+        return response.data.reference;
+    });
+}
+exports.createFeedManifest = createFeedManifest;
+function readFeedUpdateHeaders(headers) {
+    const feedIndex = headers.get('swarm-feed-index');
+    const feedIndexNext = headers.get('swarm-feed-index-next');
+    if (!feedIndex) {
+        throw new error_1.BeeError('Response did not contain expected swarm-feed-index!');
+    }
+    if (!feedIndexNext) {
+        throw new error_1.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
+ */
+function fetchFeedUpdate(ky, owner, topic, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            responseType: 'json',
+            path: `${feedEndpoint}/${owner}/${topic}`,
+            searchParams: (0, http_1.filterHeaders)(options),
+        });
+        return Object.assign(Object.assign({}, response.data), readFeedUpdateHeaders(response.headers));
+    });
+}
+exports.fetchFeedUpdate = fetchFeedUpdate;

package/dist/cjs/modules/pinning.js

@@ -0,0 +1,84 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllPins = exports.getPin = exports.unpin = exports.pin = void 0;
+const http_1 = require("../utils/http");
+const PINNING_ENDPOINT = 'pins';
+/**
+ * Pin data with given reference
+ *
+ * @param ky Ky instance for given Bee class instance
+ * @param reference Bee data reference
+ */
+function pin(ky, reference) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield (0, http_1.http)(ky, {
+            method: 'post',
+            responseType: 'json',
+            path: `${PINNING_ENDPOINT}/${reference}`,
+        });
+    });
+}
+exports.pin = pin;
+/**
+ * Unpin data with given reference
+ *
+ * @param ky Ky instance for given Bee class instance
+ * @param reference Bee data reference
+ */
+function unpin(ky, reference) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield (0, http_1.http)(ky, {
+            method: 'delete',
+            responseType: 'json',
+            path: `${PINNING_ENDPOINT}/${reference}`,
+        });
+    });
+}
+exports.unpin = unpin;
+/**
+ * Get pin status for specific address.
+ *
+ * @param ky Ky instance
+ * @param reference
+ * @throws Error if given address is not pinned
+ */
+function getPin(ky, reference) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            responseType: 'json',
+            path: `${PINNING_ENDPOINT}/${reference}`,
+        });
+        return response.data;
+    });
+}
+exports.getPin = getPin;
+/**
+ * Get list of all pins
+ *
+ * @param ky Ky instance
+ */
+function getAllPins(ky) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield (0, http_1.http)(ky, {
+            method: 'get',
+            responseType: 'json',
+            path: `${PINNING_ENDPOINT}`,
+        });
+        const result = response.data.references;
+        if (result === null) {
+            return [];
+        }
+        return result;
+    });
+}
+exports.getAllPins = getAllPins;