@ethersphere/bee-js 4.1.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -77,16 +77,16 @@
     "tar-js": "^0.3.0",
     "utf-8-validate": "^5.0.9",
     "web-streams-polyfill": "^4.0.0-beta.1",
-    "ws": "^8.6.0"
+    "ws": "^8.7.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.17.9",
+    "@babel/core": "^7.18.2",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.17.10",
     "@babel/preset-typescript": "^7.14.5",
-    "@commitlint/cli": "^16.2.3",
+    "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^16.2.1",
     "@ethersphere/bee-factory": "^0.4.1",
     "@fluffy-spoon/substitute": "^1.208.0",
@@ -126,17 +126,17 @@
     "puppeteer": "^14.1.0",
     "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^5.3.1",
-    "ts-node": "^10.7.0",
+    "ts-node": "^10.8.0",
     "typescript": "^4.5.4",
-    "webpack": "^5.72.0",
+    "webpack": "^5.72.1",
     "webpack-bundle-analyzer": "^4.5.0",
     "webpack-cli": "^4.9.2"
   },
   "engines": {
-    "node": ">=12.0.0",
+    "node": ">=14.0.0",
     "npm": ">=6.0.0",
-    "beeApiVersion": "3.0.1",
-    "beeDebugApiVersion": "2.0.1",
-    "bee": "1.6.0-6ceadd35"
+    "beeApiVersion": "3.0.2",
+    "beeDebugApiVersion": "3.0.2",
+    "bee": "1.7.0-bbf13011"
   }
 }

package/dist/cjs/test/utils.js

@@ -1,419 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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.testIdentity = exports.testJsonEns = exports.testJsonCid = exports.testJsonHash = exports.testJsonStringPayload = exports.testJsonPayload = exports.testBatchId = exports.testAddress = exports.testChunkHash = exports.testChunkData = exports.testChunkSpan = exports.testChunkPayload = exports.WAITING_USABLE_STAMP_TIMEOUT = exports.BLOCKCHAIN_TRANSACTION_TIMEOUT = exports.FEED_TIMEOUT = exports.PSS_TIMEOUT = exports.BIG_FILE_TIMEOUT = exports.ERR_TIMEOUT = exports.createdResponse = exports.okResponse = exports.invalidReference = exports.makeTestTarget = exports.getOrCreatePostageBatch = exports.waitForBatchToBeUsable = exports.shorten = exports.tryDeleteChunkFromLocalStorage = exports.beePeerDebugKy = exports.beePeerDebugUrl = exports.beeDebugKy = exports.beeDebugUrl = exports.getPostageBatch = exports.beePeerKy = exports.beePeerUrl = exports.beeKy = exports.beeUrl = exports.randomByteArray = exports.createReadableStream = exports.createRandomNodeReadable = exports.readWholeUint8ArrayReadableStream = exports.sleep = exports.commonMatchers = void 0;
-const stream_1 = require("stream");
-const web_streams_polyfill_1 = require("web-streams-polyfill");
-const ky_universal_1 = __importDefault(require("ky-universal"));
-const hex_1 = require("../src/utils/hex");
-const chunk_1 = require("../src/modules/debug/chunk");
-const src_1 = require("../src");
-const bytes_1 = require("../src/utils/bytes");
-const stamps = __importStar(require("../src/modules/debug/stamps"));
-/**
- * Load common own Jest Matchers which can be used to check particular return values.
- */
-function commonMatchers() {
-    expect.extend({
-        toBeHashReference(received) {
-            const result = {
-                pass: false,
-                message: () => 'Given input is not a Swarm hash reference',
-            };
-            if (typeof received === 'string' && /^[0-9a-fA-F]{64}$/.test(received)) {
-                result.pass = true;
-                result.message = () => 'Given string is semantically valid Swarm hash reference';
-            }
-            return result;
-        },
-        toBeBeeResponse(received, expectedStatusCode) {
-            const result = {
-                pass: false,
-                message: () => `Bee response does not have status code ${expectedStatusCode}. Got: ${received.code}\nResponse message: ${received.message}`,
-            };
-            if (received.code === expectedStatusCode) {
-                result.pass = true;
-                result.message = () => 'Bee response meets with its requirements';
-            }
-            return result;
-        },
-        toBeOneOf(received, argument) {
-            const validValues = Array.isArray(argument) ? argument : [argument];
-            let containsValidValue = false;
-            for (const validValue of validValues) {
-                try {
-                    expect(received).toEqual(validValue);
-                    containsValidValue = true;
-                    // eslint-disable-next-line no-empty
-                }
-                catch (e) { }
-            }
-            if (containsValidValue) {
-                return {
-                    message: () => `expected ${JSON.stringify(received)} not to be one of [${validValues.join(', ')}]`,
-                    pass: true,
-                };
-            }
-            return {
-                message: () => `expected ${JSON.stringify(received)} to be one of [${validValues.join(', ')}]`,
-                pass: false,
-            };
-        },
-        toBeType(received, argument) {
-            const initialType = typeof received;
-            const isArray = Array.isArray(received) ? 'array' : initialType;
-            const type = initialType === 'object' ? isArray : initialType;
-            return type === argument
-                ? {
-                    message: () => `expected ${received} to be type ${argument}`,
-                    pass: true,
-                }
-                : {
-                    message: () => `expected ${received} to be type ${argument}`,
-                    pass: false,
-                };
-        },
-        toBeNumberString(received) {
-            const message = () => `expected ${received} to be a number in a string type`;
-            return /^-?(0|[1-9][0-9]*)$/g.test(received)
-                ? {
-                    message,
-                    pass: true,
-                }
-                : {
-                    message,
-                    pass: false,
-                };
-        },
-    });
-}
-exports.commonMatchers = commonMatchers;
-/**
- * Sleep for N miliseconds
- *
- * @param ms Number of miliseconds to sleep
- */
-function sleep(ms) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise(resolve => setTimeout(() => resolve(), ms));
-    });
-}
-exports.sleep = sleep;
-/**
- * Helper function that reads whole content of ReadableStream
- * @param stream
- */
-function readWholeUint8ArrayReadableStream(stream) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const reader = stream.getReader();
-        let buff = [];
-        let readResult;
-        do {
-            readResult = yield reader.read();
-            if (readResult.value)
-                buff = [...buff, ...readResult.value];
-        } while (!readResult.done);
-        return new Uint8Array(buff);
-    });
-}
-exports.readWholeUint8ArrayReadableStream = readWholeUint8ArrayReadableStream;
-function createRandomNodeReadable(totalSize, chunkSize = 1000) {
-    if (totalSize % chunkSize !== 0) {
-        throw new Error(`totalSize ${totalSize} is not dividable without remainder by chunkSize ${chunkSize}`);
-    }
-    const stream = new stream_1.Readable();
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    stream._read = () => { };
-    for (let i = 0; i < totalSize / chunkSize; i++) {
-        stream.push(randomByteArray(chunkSize));
-    }
-    stream.push(null);
-    return stream;
-}
-exports.createRandomNodeReadable = createRandomNodeReadable;
-function createReadableStream(iterable) {
-    const iter = iterable[Symbol.iterator]();
-    return new web_streams_polyfill_1.ReadableStream({
-        pull(controller) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const result = iter.next();
-                if (result.done) {
-                    controller.close();
-                    return;
-                }
-                controller.enqueue(result.value);
-            });
-        },
-    });
-}
-exports.createReadableStream = createReadableStream;
-/**
- * Lehmer random number generator with seed (minstd_rand in C++11)
- * !!! Very fast but not well distributed pseudo-random function !!!
- *
- * @param seed Seed for the pseudo-random generator
- */
-function lrng(seed) {
-    return () => ((Math.pow(2, 31) - 1) & (seed = Math.imul(48271, seed))) / Math.pow(2, 31);
-}
-/**
- * Utility function for generating random Buffer
- * !!! IT IS NOT CRYPTO SAFE !!!
- * For that use `crypto.randomBytes()`
- *
- * @param length Number of bytes to generate
- * @param seed Seed for the pseudo-random generator
- */
-function randomByteArray(length, seed = 500) {
-    const rand = lrng(seed);
-    const buf = new Uint8Array(length);
-    for (let i = 0; i < length; ++i) {
-        buf[i] = (rand() * 0xff) << 0;
-    }
-    return buf;
-}
-exports.randomByteArray = randomByteArray;
-/**
- * Returns a url for testing the Bee public API
- */
-function beeUrl() {
-    return process.env.BEE_API_URL || 'http://127.0.0.1:1633';
-}
-exports.beeUrl = beeUrl;
-function beeKy() {
-    return ky_universal_1.default.create({ prefixUrl: beeUrl(), timeout: false });
-}
-exports.beeKy = beeKy;
-/**
- * Returns a url of another peer for testing the Bee public API
- */
-function beePeerUrl() {
-    return process.env.BEE_PEER_API_URL || 'http://127.0.0.1:11633';
-}
-exports.beePeerUrl = beePeerUrl;
-function beePeerKy() {
-    return ky_universal_1.default.create({ prefixUrl: beePeerUrl(), timeout: false });
-}
-exports.beePeerKy = beePeerKy;
-/**
- * Helper function that create monster batch for all the tests.
- * There is semaphore mechanism that allows only creation of one batch across all the
- * parallel running tests that have to wait until it is created.
- */
-function getPostageBatch(url = beeDebugUrl()) {
-    let stamp;
-    switch (url) {
-        case beeDebugUrl():
-            stamp = process.env.BEE_POSTAGE;
-            break;
-        case beePeerDebugUrl():
-            stamp = process.env.BEE_PEER_POSTAGE;
-            break;
-        default:
-            throw new Error('Unknown URL ' + url);
-    }
-    if (!stamp) {
-        throw new Error('There is no postage stamp configured for URL ' + url);
-    }
-    return stamp;
-}
-exports.getPostageBatch = getPostageBatch;
-/**
- * Returns a url for testing the Bee Debug API
- */
-function beeDebugUrl() {
-    return process.env.BEE_DEBUG_API_URL || 'http://127.0.0.1:1635';
-}
-exports.beeDebugUrl = beeDebugUrl;
-function beeDebugKy() {
-    return ky_universal_1.default.create({ prefixUrl: beeDebugUrl(), timeout: false });
-}
-exports.beeDebugKy = beeDebugKy;
-/**
- * Returns a url for testing the Bee Debug API
- */
-function beePeerDebugUrl() {
-    return process.env.BEE_PEER_DEBUG_API_URL || 'http://127.0.0.1:11635';
-}
-exports.beePeerDebugUrl = beePeerDebugUrl;
-function beePeerDebugKy() {
-    return ky_universal_1.default.create({ prefixUrl: beePeerDebugUrl(), timeout: false });
-}
-exports.beePeerDebugKy = beePeerDebugKy;
-/**
- * Try to delete a chunk from local storage, ignoring all errors
- *
- * @param address  Swarm address of chunk
- */
-function tryDeleteChunkFromLocalStorage(address) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (typeof address !== 'string') {
-            (0, bytes_1.assertBytes)(address, 32);
-            address = (0, hex_1.bytesToHex)(address);
-        }
-        try {
-            yield (0, chunk_1.deleteChunkFromLocalStorage)(beeDebugKy(), address);
-        }
-        catch (e) {
-            // ignore not found errors
-            if (e instanceof src_1.BeeResponseError && e.status === 404) {
-                return;
-            }
-            throw e;
-        }
-    });
-}
-exports.tryDeleteChunkFromLocalStorage = tryDeleteChunkFromLocalStorage;
-/**
- * Formatting utility for displaying long strings like hexstrings.
- *
- * @param inputStr
- * @param len
- */
-function shorten(inputStr, len = 17) {
-    const str = typeof inputStr === 'string' ? inputStr : inputStr.toString();
-    if (str.length <= len) {
-        return str;
-    }
-    return `${str.slice(0, 6)}...${str.slice(-6)} (length: ${str.length})`;
-}
-exports.shorten = shorten;
-function timeout(ms, message = 'Execution reached timeout!') {
-    return __awaiter(this, void 0, void 0, function* () {
-        yield sleep(ms);
-        throw new Error(message);
-    });
-}
-function waitForBatchToBeUsable(batchId, pollingInterval = 200) {
-    return __awaiter(this, void 0, void 0, function* () {
-        yield Promise.race([
-            timeout(USABLE_TIMEOUT, 'Awaiting of usable postage batch timed out!'),
-            () => __awaiter(this, void 0, void 0, function* () {
-                let stamp;
-                do {
-                    yield sleep(pollingInterval);
-                    stamp = yield stamps.getPostageBatch(beeDebugKy(), batchId);
-                } while (!stamp.usable);
-            }),
-        ]);
-    });
-}
-exports.waitForBatchToBeUsable = waitForBatchToBeUsable;
-const DEFAULT_BATCH_AMOUNT = '1';
-const DEFAULT_BATCH_DEPTH = 17;
-/**
- * Returns already existing batch or will create one.
- *
- * If some specification is passed then it is guaranteed that the batch will have this property(ies)
- *
- * @param amount
- * @param depth
- * @param immutable
- */
-function getOrCreatePostageBatch(amount, depth, immutable) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Non-usable stamps are ignored by Bee
-        const allUsableStamps = (yield stamps.getAllPostageBatches(beeDebugKy())).filter(stamp => stamp.usable);
-        if (allUsableStamps.length === 0) {
-            const batchId = yield stamps.createPostageBatch(beeDebugKy(), amount !== null && amount !== void 0 ? amount : DEFAULT_BATCH_AMOUNT, depth !== null && depth !== void 0 ? depth : DEFAULT_BATCH_DEPTH);
-            yield waitForBatchToBeUsable(batchId);
-            return stamps.getPostageBatch(beeDebugKy(), batchId);
-        }
-        // User does not want any specific batch, lets give him the first one
-        if (amount === undefined && depth === undefined && immutable === undefined) {
-            return allUsableStamps[0];
-        }
-        // User wants some specific batch
-        for (const stamp of allUsableStamps) {
-            let meetingAllCriteria = false;
-            if (amount !== undefined) {
-                meetingAllCriteria = amount === stamp.amount;
-            }
-            else {
-                meetingAllCriteria = true;
-            }
-            if (depth !== undefined) {
-                meetingAllCriteria = meetingAllCriteria && depth === stamp.depth;
-            }
-            if (immutable !== undefined) {
-                meetingAllCriteria = meetingAllCriteria && immutable === stamp.immutableFlag;
-            }
-            if (meetingAllCriteria) {
-                return stamp;
-            }
-        }
-        // No stamp meeting the criteria was found ==> we need to create a new one
-        const batchId = yield stamps.createPostageBatch(beeDebugKy(), amount !== null && amount !== void 0 ? amount : DEFAULT_BATCH_AMOUNT, depth !== null && depth !== void 0 ? depth : DEFAULT_BATCH_DEPTH);
-        yield waitForBatchToBeUsable(batchId);
-        return stamps.getPostageBatch(beeDebugKy(), batchId);
-    });
-}
-exports.getOrCreatePostageBatch = getOrCreatePostageBatch;
-function makeTestTarget(target) {
-    return target.slice(0, 2);
-}
-exports.makeTestTarget = makeTestTarget;
-exports.invalidReference = '0000000000000000000000000000000000000000000000000000000000000000';
-exports.okResponse = {
-    code: 200,
-    message: 'OK',
-};
-exports.createdResponse = {
-    code: 201,
-    message: 'Created',
-};
-const USABLE_TIMEOUT = 7000;
-exports.ERR_TIMEOUT = 40000;
-exports.BIG_FILE_TIMEOUT = 100000;
-exports.PSS_TIMEOUT = 120000;
-exports.FEED_TIMEOUT = 120000;
-exports.BLOCKCHAIN_TRANSACTION_TIMEOUT = 40000;
-exports.WAITING_USABLE_STAMP_TIMEOUT = 130000;
-exports.testChunkPayload = new Uint8Array([1, 2, 3]);
-// span is the payload length encoded as uint64 little endian
-exports.testChunkSpan = new Uint8Array([exports.testChunkPayload.length, 0, 0, 0, 0, 0, 0, 0]);
-exports.testChunkData = new Uint8Array([...exports.testChunkSpan, ...exports.testChunkPayload]);
-// the hash is hardcoded because we would need the bmt hasher otherwise
-exports.testChunkHash = 'ca6357a08e317d15ec560fef34e4c45f8f19f01c372aa70f1da72bfa7f1a4338';
-exports.testAddress = 'ca6357a08e317d15ec560fef34e4c45f8f19f01c372aa70f1da72bfa7f1a4338';
-exports.testBatchId = 'ca6357a08e317d15ec560fef34e4c45f8f19f01c372aa70f1da72bfa7f1a4338';
-exports.testJsonPayload = [{ some: 'object' }];
-exports.testJsonStringPayload = JSON.stringify(exports.testJsonPayload);
-exports.testJsonHash = '872a858115b8bee4408b1427b49e472883fdc2512d5a8f2d428b97ecc8f7ccfa';
-exports.testJsonCid = 'bah5acgzaq4vilaivxc7oiqelcqt3jhshfcb73qsrfvni6lkcrol6zshxzt5a';
-exports.testJsonEns = 'testing.eth';
-exports.testIdentity = {
-    privateKey: '634fb5a872396d9693e5c9f9d7233cfa93f395c093371017ff44aa9ae6564cdd',
-    publicKey: '03c32bb011339667a487b6c1c35061f15f7edc36aa9a0f8648aba07a4b8bd741b4',
-    address: '8d3766440f0d7b949a5e32995d09619a7f86e632',
-};