@ethersphere/bee-js 10.3.0 → 11.0.0

package/dist/mjs/bee.js

@@ -953,9 +953,6 @@ export class Bee {
    *
    * @param rawPayload Data to be stored in the chunk. If the data is a string, it will be converted to UTF-8 bytes.
    * @param span       Optional span for the chunk. If not provided, it will be set to the length of the payload.
-   *
-   * @example
-   *
    */
   makeContentAddressedChunk(rawPayload, span) {
     return makeContentAddressedChunk(rawPayload, span);

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

@@ -1,11 +1,8 @@
 import { Types } from 'cafe-utility';
-import { Duration } from "../../utils/duration.js";
 import { http } from "../../utils/http.js";
-import { Size } from "../../utils/size.js";
-import { getStampEffectiveBytes, getStampTheoreticalBytes, getStampUsage } from "../../utils/stamps.js";
+import { mapPostageBatch } from "../../utils/stamps.js";
 import { asNumberString } from "../../utils/type.js";
 import { BatchId, EthAddress } from "../../utils/typed-bytes.js";
-import { normalizeBatchTTL } from "../../utils/workaround.js";
 const STAMPS_ENDPOINT = 'stamps';
 const BATCHES_ENDPOINT = 'batches';
 export async function getGlobalPostageBatches(requestOptions) {
@@ -63,60 +60,7 @@ export async function getAllPostageBatches(requestOptions) {
   }).map(x => Types.asObject(x, {
     name: 'stamp'
   }));
-  return stamps.map(x => {
-    const utilization = Types.asNumber(x.utilization, {
-      name: 'utilization'
-    });
-    const depth = Types.asNumber(x.depth, {
-      name: 'depth'
-    });
-    const bucketDepth = Types.asNumber(x.bucketDepth, {
-      name: 'bucketDepth'
-    });
-    const usage = getStampUsage(utilization, depth, bucketDepth);
-    const batchTTL = normalizeBatchTTL(Types.asNumber(x.batchTTL, {
-      name: 'batchTTL'
-    }));
-    const duration = Duration.fromSeconds(batchTTL);
-    const effectiveBytes = getStampEffectiveBytes(depth);
-    return {
-      batchID: new BatchId(Types.asString(x.batchID, {
-        name: 'batchID'
-      })),
-      utilization,
-      usable: Types.asBoolean(x.usable, {
-        name: 'usable'
-      }),
-      label: Types.asEmptiableString(x.label, {
-        name: 'label'
-      }),
-      depth,
-      amount: asNumberString(x.amount, {
-        name: 'amount'
-      }),
-      bucketDepth,
-      blockNumber: Types.asNumber(x.blockNumber, {
-        name: 'blockNumber'
-      }),
-      immutableFlag: Types.asBoolean(x.immutableFlag, {
-        name: 'immutableFlag'
-      }),
-      usage,
-      usageText: `${Math.round(usage * 100)}%`,
-      size: Size.fromBytes(effectiveBytes),
-      remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
-      theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(depth)),
-      duration,
-      calculateSize(encryption, redundancyLevel) {
-        const effectiveBytes = getStampEffectiveBytes(this.depth, encryption, redundancyLevel);
-        return Size.fromBytes(effectiveBytes);
-      },
-      calculateRemainingSize(encryption, redundancyLevel) {
-        const effectiveBytes = getStampEffectiveBytes(this.depth, encryption, redundancyLevel);
-        return Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)));
-      }
-    };
-  });
+  return stamps.map(x => mapPostageBatch(validateRawPostageBatch(x)));
 }
 export async function getPostageBatch(requestOptions, postageBatchId, encryption, erasureCodeLevel) {
   const response = await http(requestOptions, {
@@ -127,58 +71,7 @@ export async function getPostageBatch(requestOptions, postageBatchId, encryption
   const body = Types.asObject(response.data, {
     name: 'response.data'
   });
-  const utilization = Types.asNumber(body.utilization, {
-    name: 'utilization'
-  });
-  const depth = Types.asNumber(body.depth, {
-    name: 'depth'
-  });
-  const bucketDepth = Types.asNumber(body.bucketDepth, {
-    name: 'bucketDepth'
-  });
-  const usage = getStampUsage(utilization, depth, bucketDepth);
-  const batchTTL = normalizeBatchTTL(Types.asNumber(body.batchTTL, {
-    name: 'batchTTL'
-  }));
-  const duration = Duration.fromSeconds(batchTTL);
-  const effectiveBytes = getStampEffectiveBytes(depth, encryption, erasureCodeLevel);
-  return {
-    batchID: new BatchId(Types.asString(body.batchID, {
-      name: 'batchID'
-    })),
-    utilization,
-    usable: Types.asBoolean(body.usable, {
-      name: 'usable'
-    }),
-    label: Types.asEmptiableString(body.label, {
-      name: 'label'
-    }),
-    depth,
-    amount: asNumberString(body.amount, {
-      name: 'amount'
-    }),
-    bucketDepth,
-    blockNumber: Types.asNumber(body.blockNumber, {
-      name: 'blockNumber'
-    }),
-    immutableFlag: Types.asBoolean(body.immutableFlag, {
-      name: 'immutableFlag'
-    }),
-    usage,
-    usageText: `${Math.round(usage * 100)}%`,
-    size: Size.fromBytes(effectiveBytes),
-    remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
-    theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(depth)),
-    duration,
-    calculateSize(encryption, redundancyLevel) {
-      const effectiveBytes = getStampEffectiveBytes(depth, encryption, redundancyLevel);
-      return Size.fromBytes(effectiveBytes);
-    },
-    calculateRemainingSize(encryption, redundancyLevel) {
-      const effectiveBytes = getStampEffectiveBytes(depth, encryption, redundancyLevel);
-      return Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage)));
-    }
-  };
+  return mapPostageBatch(validateRawPostageBatch(body), encryption, erasureCodeLevel);
 }
 export async function getPostageBatchBuckets(requestOptions, postageBatchId) {
   const response = await http(requestOptions, {
@@ -262,4 +155,38 @@ export async function diluteBatch(requestOptions, id, depth) {
   return new BatchId(Types.asString(body.batchID, {
     name: 'batchID'
   }));
+}
+function validateRawPostageBatch(raw) {
+  return {
+    amount: asNumberString(raw.amount, {
+      name: 'amount'
+    }),
+    batchID: Types.asString(raw.batchID, {
+      name: 'batchID'
+    }),
+    batchTTL: Types.asNumber(raw.batchTTL, {
+      name: 'batchTTL'
+    }),
+    bucketDepth: Types.asNumber(raw.bucketDepth, {
+      name: 'bucketDepth'
+    }),
+    blockNumber: Types.asNumber(raw.blockNumber, {
+      name: 'blockNumber'
+    }),
+    depth: Types.asNumber(raw.depth, {
+      name: 'depth'
+    }),
+    immutableFlag: Types.asBoolean(raw.immutableFlag, {
+      name: 'immutableFlag'
+    }),
+    label: Types.asEmptiableString(raw.label, {
+      name: 'label'
+    }),
+    usable: Types.asBoolean(raw.usable, {
+      name: 'usable'
+    }),
+    utilization: Types.asNumber(raw.utilization, {
+      name: 'utilization'
+    })
+  };
 }

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

@@ -30,6 +30,9 @@ export async function getReserveState(requestOptions) {
     }),
     storageRadius: Types.asNumber(body.storageRadius, {
       name: 'storageRadius'
+    }),
+    reserveCapacityDoubling: Types.asNumber(body.reserveCapacityDoubling, {
+      name: 'reserveCapacityDoubling'
     })
   };
 }

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

@@ -2,7 +2,7 @@ import { Types } from 'cafe-utility';
 import getMajorSemver from 'semver/functions/major.js';
 import { toBeeMode } from "../../types/debug.js";
 import { http } from "../../utils/http.js";
-export const SUPPORTED_BEE_VERSION_EXACT = '2.6.0-d0aa8b93';
+export const SUPPORTED_BEE_VERSION_EXACT = '2.7.0-6ddf9b45';
 export const SUPPORTED_BEE_VERSION = SUPPORTED_BEE_VERSION_EXACT.split('-')[0];
 export const SUPPORTED_API_VERSION = '7.3.0';
 const NODE_INFO_URL = 'node';

package/dist/mjs/utils/expose.js

@@ -2,4 +2,4 @@ export { getCollectionSize, makeCollectionFromFileList } from "./collection.js";
 export { getFolderSize } from "./collection.node.js";
 export { makeMaxTarget } from "./pss.js";
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from "./redundancy.js";
-export { getAmountForDuration, getDepthForSize, getStampCost, getStampDuration, getStampEffectiveBytes, getStampEffectiveBytesBreakpoints, getStampTheoreticalBytes, getStampUsage } from "./stamps.js";
+export { convertEnvelopeToMarshaledStamp, getAmountForDuration, getDepthForSize, getStampCost, getStampDuration, getStampEffectiveBytes, getStampEffectiveBytesBreakpoints, getStampTheoreticalBytes, getStampUsage, mapPostageBatch, unmapPostageBatch } from "./stamps.js";

package/dist/mjs/utils/stamps.js

@@ -2,8 +2,11 @@ import { Binary } from 'cafe-utility';
 import { capacityBreakpoints } from "../types/index.js";
 import { Bytes, parseSizeToBytes } from "./bytes.js";
 import { Duration } from "./duration.js";
+import { Size } from "./size.js";
 import { BZZ } from "./tokens.js";
 import { asNumberString } from "./type.js";
+import { BatchId } from "./typed-bytes.js";
+import { normalizeBatchTTL } from "./workaround.js";
 const MAX_UTILIZATION = 0.9;
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
@@ -137,4 +140,49 @@ export function marshalStamp(signature, batchId, timestamp, index) {
     throw Error('invalid index length');
   }
   return new Bytes(Binary.concatBytes(batchId, index, timestamp, signature));
+}
+export function mapPostageBatch(raw, encryption, erasureCodeLevel) {
+  const usage = getStampUsage(raw.utilization, raw.depth, raw.bucketDepth);
+  const batchTTL = normalizeBatchTTL(raw.batchTTL);
+  const duration = Duration.fromSeconds(batchTTL);
+  const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, erasureCodeLevel);
+  return {
+    batchID: new BatchId(raw.batchID),
+    utilization: raw.utilization,
+    usable: raw.usable,
+    label: raw.label,
+    depth: raw.depth,
+    amount: asNumberString(raw.amount),
+    bucketDepth: raw.bucketDepth,
+    blockNumber: raw.blockNumber,
+    immutableFlag: raw.immutableFlag,
+    usage,
+    usageText: `${Math.round(usage * 100)}%`,
+    size: Size.fromBytes(effectiveBytes),
+    remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
+    theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(raw.depth)),
+    duration,
+    calculateSize(encryption, redundancyLevel) {
+      const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, redundancyLevel);
+      return Size.fromBytes(effectiveBytes);
+    },
+    calculateRemainingSize(encryption, redundancyLevel) {
+      const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, redundancyLevel);
+      return Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)));
+    }
+  };
+}
+export function unmapPostageBatch(batch) {
+  return {
+    batchID: batch.batchID.toHex(),
+    utilization: batch.utilization,
+    usable: batch.usable,
+    label: batch.label,
+    depth: batch.depth,
+    amount: batch.amount,
+    bucketDepth: batch.bucketDepth,
+    blockNumber: batch.blockNumber,
+    immutableFlag: batch.immutableFlag,
+    batchTTL: batch.duration.toSeconds()
+  };
 }

package/dist/mjs/utils/workaround.js

@@ -6,8 +6,11 @@ export function normalizeBatchTTL(batchTTL) {
   if (batchTTL < 1) {
     return 1;
   }
-  if (batchTTL > 315569260) {
-    return 315569260;
+  // Cap `batchTTL` (represents seconds) to 100 years.
+  // We can assume `storagePrice` is invalid (e.g. 1).
+  // This is needed to prevent Date objects breaking.
+  if (batchTTL > 3155695200) {
+    return 3155695200;
   }
   return batchTTL;
 }

package/dist/types/bee.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Readable } from 'stream';
 import { Chunk } from './chunk/cac';
 import { SingleOwnerChunk } from './chunk/soc';
@@ -618,9 +617,6 @@ export declare class Bee {
      *
      * @param rawPayload Data to be stored in the chunk. If the data is a string, it will be converted to UTF-8 bytes.
      * @param span       Optional span for the chunk. If not provided, it will be set to the length of the payload.
-     *
-     * @example
-     *
      */
     makeContentAddressedChunk(rawPayload: Bytes | Uint8Array | string, span?: Span | bigint): Chunk;
     /**

package/dist/types/index.d.ts

@@ -2,8 +2,8 @@ import { Bee } from './bee';
 import { BeeDev } from './bee-dev';
 import { Stamper } from './stamper/stamper';
 export { MerkleTree } from 'cafe-utility';
-export { Chunk } from './chunk/cac';
-export { SingleOwnerChunk } from './chunk/soc';
+export type { Chunk } from './chunk/cac';
+export type { SingleOwnerChunk } from './chunk/soc';
 export { MantarayNode } from './manifest/manifest';
 export { SUPPORTED_BEE_VERSION, SUPPORTED_BEE_VERSION_EXACT } from './modules/debug/status';
 export * from './types';
@@ -15,6 +15,7 @@ export * as Utils from './utils/expose';
 export { Size } from './utils/size';
 export * from './utils/tokens';
 export * from './utils/typed-bytes';
+export type { UploadProgress } from './utils/upload-progress';
 export { Bee, BeeDev, Stamper };
 declare global {
     interface Window {

package/dist/types/modules/bzz.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Readable } from 'stream';
 import { BeeRequestOptions, Collection, CollectionUploadOptions, DownloadOptions, FileData, FileUploadOptions, UploadResult } from '../types';
 import { Bytes } from '../utils/bytes';

package/dist/types/modules/debug/status.d.ts

@@ -1,7 +1,7 @@
 import { BeeRequestOptions } from '../../index';
 import type { DebugStatus, Health, NodeInfo, Readiness } from '../../types/debug';
 import { BeeVersions } from '../../types/debug';
-export declare const SUPPORTED_BEE_VERSION_EXACT = "2.6.0-d0aa8b93";
+export declare const SUPPORTED_BEE_VERSION_EXACT = "2.7.0-6ddf9b45";
 export declare const SUPPORTED_BEE_VERSION: string;
 export declare const SUPPORTED_API_VERSION = "7.3.0";
 export declare function getDebugStatus(requestOptions: BeeRequestOptions): Promise<DebugStatus>;

package/dist/types/modules/gsoc.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="ws" />
 import WebSocket from 'isomorphic-ws';
 import { BeeRequestOptions, UploadOptions } from '..';
 import { SingleOwnerChunk } from '../chunk/soc';

package/dist/types/modules/pss.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="ws" />
 import WebSocket from 'isomorphic-ws';
 import type { BeeRequestOptions } from '../types';
 import { BatchId, PublicKey, Topic } from '../utils/typed-bytes';

package/dist/types/types/debug.d.ts

@@ -212,6 +212,7 @@ export interface ReserveState {
     radius: number;
     storageRadius: number;
     commitment: number;
+    reserveCapacityDoubling: number;
 }
 export interface ChainState {
     chainTip: number;

package/dist/types/utils/constants.d.ts

@@ -2,6 +2,6 @@ import { BatchId, Topic } from './typed-bytes';
 export declare const SWARM_GATEWAY_URL = "https://api.gateway.ethswarm.org";
 export declare const NULL_STAMP: BatchId;
 export declare const NULL_TOPIC: Topic;
-export declare const NULL_ADDRESS: Uint8Array;
-export declare const NULL_IDENTIFIER: Uint8Array;
-export declare const NULL_OWNER: Uint8Array;
+export declare const NULL_ADDRESS: Uint8Array<ArrayBuffer>;
+export declare const NULL_IDENTIFIER: Uint8Array<ArrayBuffer>;
+export declare const NULL_OWNER: Uint8Array<ArrayBuffer>;

package/dist/types/utils/error.d.ts

@@ -8,8 +8,8 @@ export declare class BeeArgumentError extends BeeError {
 export declare class BeeResponseError extends BeeError {
     method: string;
     url: string;
-    responseBody?: unknown;
+    responseBody?: unknown | undefined;
     status?: number | undefined;
     statusText?: string | undefined;
-    constructor(method: string, url: string, message: string, responseBody?: unknown, status?: number | undefined, statusText?: string | undefined);
+    constructor(method: string, url: string, message: string, responseBody?: unknown | undefined, status?: number | undefined, statusText?: string | undefined);
 }

package/dist/types/utils/expose.d.ts

@@ -2,4 +2,4 @@ export { getCollectionSize, makeCollectionFromFileList } from './collection';
 export { getFolderSize } from './collection.node';
 export { makeMaxTarget } from './pss';
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from './redundancy';
-export { getAmountForDuration, getDepthForSize, getStampCost, getStampDuration, getStampEffectiveBytes, getStampEffectiveBytesBreakpoints, getStampTheoreticalBytes, getStampUsage, } from './stamps';
+export { convertEnvelopeToMarshaledStamp, getAmountForDuration, getDepthForSize, getStampCost, getStampDuration, getStampEffectiveBytes, getStampEffectiveBytesBreakpoints, getStampTheoreticalBytes, getStampUsage, mapPostageBatch, unmapPostageBatch, } from './stamps';

package/dist/types/utils/stamps.d.ts

@@ -1,4 +1,4 @@
-import { EnvelopeWithBatchId, NumberString, RedundancyLevel } from '../types';
+import { EnvelopeWithBatchId, NumberString, PostageBatch, RedundancyLevel } from '../types';
 import { Bytes } from './bytes';
 import { Duration } from './duration';
 import { Size } from './size';
@@ -58,3 +58,17 @@ export declare function getAmountForDuration(duration: Duration, pricePerBlock:
 export declare function getDepthForSize(size: Size, encryption?: boolean, erasureCodeLevel?: RedundancyLevel): number;
 export declare function convertEnvelopeToMarshaledStamp(envelope: EnvelopeWithBatchId): Bytes;
 export declare function marshalStamp(signature: Uint8Array, batchId: Uint8Array, timestamp: Uint8Array, index: Uint8Array): Bytes;
+export interface RawPostageBatch {
+    batchID: string;
+    utilization: number;
+    usable: boolean;
+    label: string;
+    depth: number;
+    amount: string;
+    bucketDepth: number;
+    blockNumber: number;
+    immutableFlag: boolean;
+    batchTTL: number;
+}
+export declare function mapPostageBatch(raw: RawPostageBatch, encryption?: boolean, erasureCodeLevel?: RedundancyLevel): PostageBatch;
+export declare function unmapPostageBatch(batch: PostageBatch): RawPostageBatch;

package/dist/types/utils/tar.browser.d.ts

@@ -1,7 +1,7 @@
 export declare class TarStream {
     pieces: Uint8Array[];
     currentFileSize: number;
-    get output(): Uint8Array;
+    get output(): Uint8Array<ArrayBufferLike>;
     beginFile(path: string, size: number): void;
     appendFile(data: Uint8Array): Promise<void>;
     endFile(): Promise<void>;

package/dist/types/utils/tar.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { PassThrough } from 'stream';
 export declare class TarStream {
     output: PassThrough;

package/dist/types/utils/type.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import * as stream from 'stream';
 import { AllTagsOptions, BeeRequestOptions, CollectionUploadOptions, DownloadOptions, FileUploadOptions, GsocMessageHandler, NumberString, PostageBatchOptions, PssMessageHandler, RedundantUploadOptions, Tag, TransactionOptions, UploadOptions } from '../types';
 export declare function isReadable(value: unknown): value is stream.Readable;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "10.3.0",
+  "version": "11.0.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -50,18 +50,18 @@
     "dist"
   ],
   "scripts": {
-    "prepublishOnly": "cross-env NODE_ENV=production npm run build",
+    "prepublishOnly": "NODE_ENV=production npm run build",
     "build": "rimraf dist && npm run build:node && npm run build:types && npm run build:browser",
     "build:node": "tsc -p tsconfig.json && tsc -p tsconfig-mjs.json && ./build-fixup && babel --plugins \"babel-plugin-add-import-extension\" --out-dir dist/mjs/ dist/mjs/",
     "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist/types",
     "build:browser": "webpack --progress",
-    "test": "jest --config=jest.config.ts --runInBand --verbose --forceExit",
+    "test": "TS_NODE_PROJECT=tsconfig.test.json jest --runInBand --verbose --forceExit",
     "check": "tsc --project tsconfig.test.json",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" && prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
     "depcheck": "depcheck ."
   },
   "dependencies": {
-    "axios": "^0.30.0",
+    "axios": "^0.30.2",
     "cafe-utility": "^33.3.4",
     "debug": "^4.4.1",
     "isomorphic-ws": "^4.0.1",
@@ -77,10 +77,8 @@
     "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.4.2",
-    "@jest/types": "^29.6.3",
-    "@naholyr/cross-env": "^1.0.0",
     "@types/debug": "^4.1.12",
-    "@types/jest": "^29.5.13",
+    "@types/jest": "^30.0.0",
     "@types/node": "^18.11.11",
     "@types/semver": "^7.3.9",
     "@types/ws": "^8.5.3",
@@ -88,20 +86,19 @@
     "@typescript-eslint/parser": "^5.46.0",
     "babel-loader": "^9.1.0",
     "babel-plugin-add-import-extension": "^1.6.0",
-    "cross-env": "^7.0.3",
     "depcheck": "^1.4.7",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-unused-imports": "^2.0.0",
     "husky": "^8.0.1",
-    "jest": "^29.7.0",
+    "jest": "^30.2.0",
     "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^5.3.1",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.5",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1"
   }