@ethersphere/bee-js 13.1.1-upcoming.gebd4706 → 13.2.0-upcoming.g40a63fd

package/README.md

@@ -59,6 +59,18 @@ Loading this module through a script tag will make the `BeeJs` object available
 <script src="https://unpkg.com/@ethersphere/bee-js/dist/index.browser.min.js"></script>
 ```
 
+### Browser apps and CORS
+
+From Bee 2.8.3, a node rejects `POST`, `PUT`, `PATCH` and `DELETE` requests from a browser page on another origin with
+`403 Forbidden`, unless that origin is listed in the node's `cors-allowed-origins` option. Uploads, stamp purchases and
+other write calls from a web app therefore need the app's origin in that list:
+
+```sh
+bee start --cors-allowed-origins="https://my-app.example"
+```
+
+Node.js scripts are not affected, because they send no `Origin` header.
+
 ## Overview
 
 ### Type interfaces
@@ -69,7 +81,7 @@ types. Where `NumberString` is present, `number` is disallowed in order to avoid
 ### Byte primitives
 
 All the classes below extend `Bytes`, therefore the following methods are available on all of them: `toUint8Array`,
-`toHex`, `toBase64`, `toBase32`, `toUtf8`, `toJSON`, `static keccak256`, `static fromUtf8`.
+`toHex`, `toBase64`, `toBase32`, `toUtf8`, `parsePayloadAsJson`, `static keccak256`, `static fromUtf8`.
 
 The `toString` method uses `toHex`.
 

package/dist/cjs/api/redistributionstate.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRedistributionState = getRedistributionState;
+exports.setRedistributionEnabled = setRedistributionEnabled;
 const stake_1 = require("../types/schema/stake");
 const http_1 = require("../utils/http");
 const redistributionStateEndpoint = 'redistributionstate';
@@ -15,3 +16,12 @@ async function getRedistributionState(requestOptions) {
     });
     return stake_1.GetRedistributionStateResponse.parse(response.data);
 }
+async function setRedistributionEnabled(requestOptions, enabled) {
+    const response = await (0, http_1.http)(requestOptions, {
+        method: 'patch',
+        responseType: 'json',
+        url: redistributionStateEndpoint,
+        data: { enabled },
+    });
+    return stake_1.RedistributionToggleResponse.parse(response.data).enabled;
+}

package/dist/cjs/api/stake.js

@@ -18,7 +18,7 @@ async function getStake(requestOptions) {
         responseType: 'json',
         url: STAKE_ENDPOINT,
     });
-    return stake_1.GetStakeResponse.parse(response.data).stakedAmount;
+    return stake_1.GetStakeResponse.parse(response.data);
 }
 async function getWithdrawableStake(requestOptions) {
     const response = await (0, http_1.http)(requestOptions, {

package/dist/cjs/manifest/manifest.js

@@ -43,9 +43,7 @@ async function loadRecursively(node, bee, options, requestOptions) {
             };
         }
         const data = (await bee.data.download(fork.node.selfAddress, downloadOptions, requestOptions)).toUint8Array();
-        const loaded = core_sdk_1.MantarayNode.unmarshalFromData(data, fork.node.selfAddress);
-        fork.node.targetAddress = loaded.targetAddress;
-        fork.node.forks = loaded.forks;
+        fork.node.hydrate(data);
         fork.node.path = fork.prefix;
         fork.node.parent = node;
         await loadRecursively(fork.node, bee, options, requestOptions);

package/dist/cjs/modules/chequebook.js

@@ -71,7 +71,7 @@ class Chequebook {
      */
     async deposit(amount, gasPrice, requestOptions) {
         const amountString = amount instanceof tokens_1.BZZ ? amount.toPLURString() : (0, type_1.asNumberString)(amount, { min: 1n, name: 'amount' });
-        const gasPriceString = gasPrice ? (0, type_1.asNumberString)(amount, { min: 0n, name: 'gasPrice' }) : undefined;
+        const gasPriceString = gasPrice ? (0, type_1.asNumberString)(gasPrice, { min: 0n, name: 'gasPrice' }) : undefined;
         return api.depositTokens(this.context.getRequestOptionsForCall(requestOptions), amountString, gasPriceString);
     }
     /**
@@ -83,7 +83,7 @@ class Chequebook {
      */
     async withdraw(amount, gasPrice, requestOptions) {
         const amountString = amount instanceof tokens_1.BZZ ? amount.toPLURString() : (0, type_1.asNumberString)(amount, { min: 1n, name: 'amount' });
-        const gasPriceString = gasPrice ? (0, type_1.asNumberString)(amount, { min: 0n, name: 'gasPrice' }) : undefined;
+        const gasPriceString = gasPrice ? (0, type_1.asNumberString)(gasPrice, { min: 0n, name: 'gasPrice' }) : undefined;
         return api.withdrawTokens(this.context.getRequestOptionsForCall(requestOptions), amountString, gasPriceString);
     }
 }

package/dist/cjs/modules/messaging.js

@@ -194,13 +194,23 @@ class Messaging {
      * @param address
      * @param identifier
      * @param handler
+     * @param options SOC fields to receive and whether to cache the wrapped chunk; requires Bee 2.8.3 or later
      */
-    gsocSubscribe(address, identifier, handler) {
+    gsocSubscribe(address, identifier, handler, options) {
         const ethAddress = new core_sdk_1.EthAddress(address);
         const id = new core_sdk_1.Identifier(identifier);
         handler = schema_1.GsocMessageHandlerSchema.parse(handler);
+        const { fields, cacheWrappedChunk } = schema_1.GsocSubscribeOptionsSchema.parse(options ?? {});
+        const params = new URLSearchParams();
+        if (fields) {
+            params.set('swarm-soc-fields', fields.join(','));
+        }
+        if (cacheWrappedChunk !== undefined) {
+            params.set('swarm-cache-wrapped-chunk', String(cacheWrappedChunk));
+        }
         const socAddress = (0, soc_1.makeSOCAddress)(id, ethAddress);
-        const ws = this.openWebSocket(`${GSOC_ENDPOINT}/subscribe/${socAddress.toHex()}`);
+        const query = params.toString() ? `?${params.toString()}` : '';
+        const ws = this.openWebSocket(`${GSOC_ENDPOINT}/subscribe/${socAddress.toHex()}${query}`);
         const cancel = this.makeCancel(ws);
         const subscription = { address: ethAddress, cancel };
         ws.onmessage = async (event) => {

package/dist/cjs/modules/stake.js

@@ -34,6 +34,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Stake = void 0;
+const zod_1 = require("zod");
 const schema_1 = require("../utils/schema");
 const tokens_1 = require("../utils/tokens");
 const type_1 = require("../utils/type");
@@ -54,7 +55,13 @@ class Stake {
      * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
      */
     async get(requestOptions) {
-        return stakeApi.getStake(this.context.getRequestOptionsForCall(requestOptions));
+        const { stakedAmount } = await stakeApi.getStake(this.context.getRequestOptionsForCall(requestOptions));
+        return stakedAmount;
+    }
+    /** Gets the minimum next deposit, or `null` when Bee cannot determine it (e.g. the price oracle is unavailable). */
+    async getMinimumDeposit(requestOptions) {
+        const { minimumDeposit } = await stakeApi.getStake(this.context.getRequestOptionsForCall(requestOptions));
+        return minimumDeposit;
     }
     /**
      * Gets the amount of withdrawable staked BZZ.
@@ -65,7 +72,7 @@ class Stake {
         return stakeApi.getWithdrawableStake(this.context.getRequestOptionsForCall(requestOptions));
     }
     /**
-     * Stakes the given amount of BZZ. Initial deposit must be at least 10 BZZ.
+     * Stakes the given amount of BZZ. Must be at least {@link getMinimumDeposit}, otherwise Bee rejects it with 400.
      *
      * Be aware that staked BZZ tokens can **not** be withdrawn.
      *
@@ -106,5 +113,9 @@ class Stake {
     async getRedistributionState(requestOptions) {
         return redistributionApi.getRedistributionState(this.context.getRequestOptionsForCall(requestOptions));
     }
+    /** Enables or disables participation in new redistribution rounds; resets to enabled when the node restarts. */
+    async setRedistributionEnabled(enabled, requestOptions) {
+        return redistributionApi.setRedistributionEnabled(this.context.getRequestOptionsForCall(requestOptions), zod_1.z.boolean().parse(enabled));
+    }
 }
 exports.Stake = Stake;

package/dist/cjs/types/schema/stake.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetRedistributionStateResponse = exports.TxHashResponse = exports.GetWithdrawableStakeResponse = exports.GetStakeResponse = void 0;
+exports.RedistributionToggleResponse = exports.GetRedistributionStateResponse = exports.TxHashResponse = exports.GetWithdrawableStakeResponse = exports.GetStakeResponse = void 0;
 const core_sdk_1 = require("@ethersphere/core-sdk");
 const zod_1 = require("zod");
 const tokens_1 = require("../../utils/tokens");
 const type_1 = require("../../utils/type");
 exports.GetStakeResponse = zod_1.z.object({
     stakedAmount: zod_1.z.string().transform(s => tokens_1.BZZ.fromPLUR((0, type_1.asNumberString)(s, { name: 'stakedAmount' }))),
+    minimumDeposit: zod_1.z
+        .string()
+        .nullish()
+        .transform(s => (s ? tokens_1.BZZ.fromPLUR((0, type_1.asNumberString)(s, { name: 'minimumDeposit' })) : null)),
 });
 exports.GetWithdrawableStakeResponse = zod_1.z.object({
     withdrawableAmount: zod_1.z.string().transform(s => tokens_1.BZZ.fromPLUR((0, type_1.asNumberString)(s, { name: 'withdrawableAmount' }))),
@@ -30,4 +34,10 @@ exports.GetRedistributionStateResponse = zod_1.z.object({
     reward: zod_1.z.string().transform(s => tokens_1.BZZ.fromPLUR((0, type_1.asNumberString)(s, { name: 'reward' }))),
     fees: zod_1.z.string().transform(s => tokens_1.DAI.fromWei((0, type_1.asNumberString)(s, { name: 'fees' }))),
     isHealthy: zod_1.z.boolean(),
+    enabled: zod_1.z.boolean(),
+    hasCommittedThisRound: zod_1.z.boolean(),
+    hasRevealedThisRound: zod_1.z.boolean(),
+});
+exports.RedistributionToggleResponse = zod_1.z.object({
+    enabled: zod_1.z.boolean(),
 });

package/dist/cjs/utils/error.js

@@ -4,6 +4,7 @@ exports.BeeResponseError = exports.BeeArgumentError = exports.BeeError = void 0;
 class BeeError extends Error {
     constructor(message) {
         super(message);
+        this.name = 'BeeError';
     }
 }
 exports.BeeError = BeeError;
@@ -11,6 +12,7 @@ class BeeArgumentError extends BeeError {
     constructor(message, value) {
         super(message);
         this.value = value;
+        this.name = 'BeeArgumentError';
     }
 }
 exports.BeeArgumentError = BeeArgumentError;
@@ -22,6 +24,7 @@ class BeeResponseError extends BeeError {
         this.responseBody = responseBody;
         this.status = status;
         this.statusText = statusText;
+        this.name = 'BeeResponseError';
         this.response = { status, data: responseBody, statusText };
     }
 }

package/dist/cjs/utils/http.js

@@ -53,7 +53,7 @@ async function http(options, config) {
             debug(`${method} ${url}`, { headers: requestConfig.headers, params: requestConfig.params });
             const res = await fetch(url, requestConfig);
             if (!res.ok)
-                await throwHttpError(method, url, res, requestConfig.responseType);
+                await throwHttpError(method, url, res);
             return toBeeResponse(res, requestConfig.responseType);
         }
         catch (e) {
@@ -87,11 +87,23 @@ function attachBody(config) {
         config.headers = { 'content-type': ct, ...config.headers };
     }
 }
-async function throwHttpError(method, url, res, responseType) {
-    const errBody = await toBeeResponse(res, responseType).catch(() => ({ data: undefined }));
-    const bodyMsg = typeof errBody.data === 'string' ? errBody.data : JSON.stringify(errBody.data);
-    const message = bodyMsg && bodyMsg !== 'undefined' ? `${res.statusText}: ${bodyMsg}` : res.statusText;
-    throw new index_1.BeeResponseError(method, url, message, errBody.data, res.status, res.statusText);
+async function throwHttpError(method, url, res) {
+    const data = await readErrorBody(res);
+    const bodyMsg = typeof data === 'string' ? data : JSON.stringify(data);
+    const message = bodyMsg ? `${res.statusText}: ${bodyMsg}` : res.statusText;
+    throw new index_1.BeeResponseError(method, url, message, data, res.status, res.statusText);
+}
+async function readErrorBody(res) {
+    const raw = await res.text().catch(() => '');
+    if (!raw) {
+        return undefined;
+    }
+    try {
+        return JSON.parse(raw);
+    }
+    catch {
+        return raw;
+    }
 }
 function toBeeError(err, method, url) {
     if (err.name === 'AbortError') {

package/dist/cjs/utils/schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AllTagsOptionsSchema = exports.TransactionOptionsSchema = exports.PostageBatchOptionsSchema = exports.GsocMessageHandlerSchema = exports.PssMessageHandlerSchema = exports.TagUidSchema = exports.TagInputSchema = exports.CollectionUploadOptionsSchema = exports.FileUploadOptionsSchema = exports.RedundantUploadOptionsSchema = exports.UploadOptionsSchema = exports.DownloadOptionsSchema = exports.BeeRequestOptionsSchema = exports.HexStringSchema = void 0;
+exports.AllTagsOptionsSchema = exports.TransactionOptionsSchema = exports.PostageBatchOptionsSchema = exports.GsocSubscribeOptionsSchema = exports.GsocMessageHandlerSchema = exports.PssMessageHandlerSchema = exports.TagUidSchema = exports.TagInputSchema = exports.CollectionUploadOptionsSchema = exports.FileUploadOptionsSchema = exports.RedundantUploadOptionsSchema = exports.UploadOptionsSchema = exports.DownloadOptionsSchema = exports.BeeRequestOptionsSchema = exports.HexStringSchema = void 0;
 const core_sdk_1 = require("@ethersphere/core-sdk");
 const zod_1 = require("zod");
 const types_1 = require("../types");
@@ -71,6 +71,13 @@ exports.GsocMessageHandlerSchema = zod_1.z.object({
     onError: fnField,
     onClose: fnField,
 });
+exports.GsocSubscribeOptionsSchema = zod_1.z.object({
+    fields: zod_1.z
+        .array(zod_1.z.enum(['address', 'recoveredPubKey', 'identifier', 'signature', 'wrappedAddress', 'span', 'payload']))
+        .nonempty()
+        .optional(),
+    cacheWrappedChunk: zod_1.z.boolean().optional(),
+});
 exports.PostageBatchOptionsSchema = zod_1.z.object({
     gasPrice: integerStringField.optional(),
     immutableFlag: zod_1.z.boolean().optional(),

package/dist/cjs/version.js

@@ -4,8 +4,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SUPPORTED_API_VERSION = exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT = void 0;
 /** Exact supported Bee version, including the commit hash suffix. */
-exports.SUPPORTED_BEE_VERSION_EXACT = '2.8.1-7cf53193';
+exports.SUPPORTED_BEE_VERSION_EXACT = '2.8.3';
 /** Supported Bee version without the commit hash suffix. */
 exports.SUPPORTED_BEE_VERSION = exports.SUPPORTED_BEE_VERSION_EXACT.split('-')[0];
 /** Supported Bee API version. */
-exports.SUPPORTED_API_VERSION = '8.1.0';
+exports.SUPPORTED_API_VERSION = '8.2.0';

package/dist/codemod/transforms/v13.js

@@ -171,14 +171,19 @@ const METHOD_MAP = {
 function transform(sourceFile, checker) {
     const source = sourceFile.text;
     const isNewBee = (node) => !!node && ts.isNewExpression(node) && ts.isIdentifier(node.expression) && node.expression.text === 'Bee';
-    // Does the type annotation mention `Bee` (`Bee`, `Bee | null`, `Bee | undefined`, …)?
+    const typeNameText = (name) => (ts.isIdentifier(name) ? name.text : name.right.text);
+    // Does the type annotation mention `Bee`, plain or wrapped (`Bee | null`, `Mocked<Bee>`,
+    // `jest.Mocked<Bee> & Extra`, …)? Arrays and tuples are left out — they don't expose Bee's members.
     const typeMentionsBee = (type) => {
         if (!type)
             return false;
-        if (ts.isTypeReferenceNode(type) && ts.isIdentifier(type.typeName) && type.typeName.text === 'Bee')
-            return true;
-        if (ts.isUnionTypeNode(type))
+        if (ts.isParenthesizedTypeNode(type))
+            return typeMentionsBee(type.type);
+        if (ts.isUnionTypeNode(type) || ts.isIntersectionTypeNode(type))
             return type.types.some(typeMentionsBee);
+        if (ts.isTypeReferenceNode(type)) {
+            return typeNameText(type.typeName) === 'Bee' || (type.typeArguments ?? []).some(typeMentionsBee);
+        }
         return false;
     };
     // Syntactic pass — identify Bee bindings from annotations and `new Bee(...)` alone, so
@@ -214,10 +219,17 @@ function transform(sourceFile, checker) {
         ts.forEachChild(node, collect);
     };
     collect(sourceFile);
+    const isBeeJsFile = (file) => /[/\\]bee-js[/\\]/.test(file) || /[/\\]bee\.(d\.)?ts$/.test(file);
+    // A wrapper type (`Mocked<Bee>`, `Partial<Bee>`, …) has no Bee symbol of its own, but the
+    // members it maps over still point back at the Bee class they came from.
+    const hasBeeMember = (type, memberName) => (type.getProperty(memberName)?.getDeclarations() ?? []).some(decl => {
+        const parent = decl.parent;
+        return (ts.isClassDeclaration(parent) && parent.name?.text === 'Bee' && isBeeJsFile(parent.getSourceFile().fileName));
+    });
     // A receiver is a Bee if identified syntactically (above) OR resolved by the type checker
     // to the `Bee` class declared by bee-js — the latter additionally catches imported/shared
-    // instances and factory calls (`getBee()`) when the project's types resolve.
-    const isBeeReceiver = (expr) => {
+    // instances, factory calls (`getBee()`) and mock wrappers when the project's types resolve.
+    const isBeeReceiver = (expr, memberName) => {
         if (ts.isIdentifier(expr) && beeNames.has(expr.text))
             return true;
         if (ts.isPropertyAccessExpression(expr) &&
@@ -225,17 +237,14 @@ function transform(sourceFile, checker) {
             beeFields.has(expr.name.text)) {
             return true;
         }
-        const symbol = checker.getTypeAtLocation(expr).getSymbol();
+        const type = checker.getTypeAtLocation(expr);
+        if (memberName && hasBeeMember(type, memberName))
+            return true;
+        const symbol = type.getSymbol();
         if (!symbol || symbol.getName() !== 'Bee') {
             return false;
         }
-        return (symbol.getDeclarations() ?? []).some(decl => {
-            if (!ts.isClassDeclaration(decl)) {
-                return false;
-            }
-            const file = decl.getSourceFile().fileName;
-            return /[/\\]bee-js[/\\]/.test(file) || /[/\\]bee\.(d\.)?ts$/.test(file);
-        });
+        return (symbol.getDeclarations() ?? []).some(decl => ts.isClassDeclaration(decl) && isBeeJsFile(decl.getSourceFile().fileName));
     };
     // ChunkBuilder.hash() now returns a Reference, not a raw Uint8Array.
     const isChunkBuilderReceiver = (expr) => {
@@ -434,7 +443,7 @@ function transform(sourceFile, checker) {
         // Any `<bee>.<method>` access — called or not — so bare method references migrate too.
         if (ts.isPropertyAccessExpression(node) && ts.isIdentifier(node.name)) {
             const mapping = METHOD_MAP[node.name.text];
-            if (mapping && isBeeReceiver(node.expression)) {
+            if (mapping && isBeeReceiver(node.expression, node.name.text)) {
                 // Preserve optional chaining on the receiver: `bee?.uploadData` → `bee?.data.upload`.
                 const separator = node.questionDotToken ? '?.' : '.';
                 replacements.push({
@@ -468,7 +477,7 @@ function transform(sourceFile, checker) {
                         text: `${quote}${mapping.newName}${quote}`,
                     });
                 }
-                else if (mapping && isBeeReceiver(receiverArg)) {
+                else if (mapping && isBeeReceiver(receiverArg, methodArg.text)) {
                     replacements.push({
                         start: receiverArg.getStart(sourceFile),
                         end: receiverArg.getEnd(),