@ethersphere/bee-js 8.2.0 → 8.3.0

package/dist/mjs/bee.js

@@ -1,4 +1,3 @@
-import { ReferenceType } from '@ethersphere/swarm-cid';
 import { Objects, System } from 'cafe-utility';
 import { makeSigner } from "./chunk/signer.js";
 import { downloadSingleOwnerChunk, uploadSingleOwnerChunkData } from "./chunk/soc.js";
@@ -62,7 +61,9 @@ export class Bee {
       baseURL: this.url,
       timeout: options?.timeout ?? false,
       headers: options?.headers,
-      onRequest: options?.onRequest
+      onRequest: options?.onRequest,
+      httpAgent: options?.httpAgent,
+      httpsAgent: options?.httpsAgent
     };
   }
   /**
@@ -245,14 +246,14 @@ export class Bee {
         contentType,
         ...options
       };
-      return addCidConversionFunction(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), fileData, postageBatchId, fileName, fileOptions), ReferenceType.MANIFEST);
+      return addCidConversionFunction(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), fileData, postageBatchId, fileName, fileOptions), 'manifest');
     } else if (isReadable(data) && options?.tag && !options.size) {
       // TODO: Needed until https://github.com/ethersphere/bee/issues/2317 is resolved
       const result = await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, name, options);
       await this.updateTag(options.tag, result.reference);
-      return addCidConversionFunction(result, ReferenceType.MANIFEST);
+      return addCidConversionFunction(result, 'manifest');
     } else {
-      return addCidConversionFunction(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, name, options), ReferenceType.MANIFEST);
+      return addCidConversionFunction(await bzz.uploadFile(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, name, options), 'manifest');
     }
   }
   /**
@@ -269,7 +270,7 @@ export class Bee {
    */
   async downloadFile(reference, path = '', options) {
     assertRequestOptions(options);
-    reference = makeReferenceOrEns(reference, ReferenceType.MANIFEST);
+    reference = makeReferenceOrEns(reference, 'manifest');
     return bzz.downloadFile(this.getRequestOptionsForCall(options), reference, path);
   }
   /**
@@ -286,7 +287,7 @@ export class Bee {
    */
   async downloadReadableFile(reference, path = '', options) {
     assertRequestOptions(options);
-    reference = makeReferenceOrEns(reference, ReferenceType.MANIFEST);
+    reference = makeReferenceOrEns(reference, 'manifest');
     return bzz.downloadFileReadable(this.getRequestOptionsForCall(options), reference, path);
   }
   /**
@@ -312,7 +313,7 @@ export class Bee {
       assertCollectionUploadOptions(options);
     }
     const data = await makeCollectionFromFileList(fileList);
-    return addCidConversionFunction(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), ReferenceType.MANIFEST);
+    return addCidConversionFunction(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), 'manifest');
   }
   /**
    * Upload Collection that you can assembly yourself.
@@ -329,7 +330,7 @@ export class Bee {
     assertBatchId(postageBatchId);
     assertCollection(collection);
     if (options) assertCollectionUploadOptions(options);
-    return addCidConversionFunction(await bzz.uploadCollection(this.getRequestOptionsForCall(this.requestOptions), collection, postageBatchId, options), ReferenceType.MANIFEST);
+    return addCidConversionFunction(await bzz.uploadCollection(this.getRequestOptionsForCall(this.requestOptions), collection, postageBatchId, options), 'manifest');
   }
   /**
    * Upload collection of files.
@@ -352,7 +353,7 @@ export class Bee {
     assertRequestOptions(requestOptions);
     if (options) assertCollectionUploadOptions(options);
     const data = await makeCollectionFromFS(dir);
-    return addCidConversionFunction(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), ReferenceType.MANIFEST);
+    return addCidConversionFunction(await bzz.uploadCollection(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options), 'manifest');
   }
   /**
    * Create a new Tag which is meant for tracking progres of syncing data across network.
@@ -716,7 +717,7 @@ export class Bee {
     const reference = await createFeedManifest(this.getRequestOptionsForCall(options), canonicalOwner, canonicalTopic, stamp);
     return addCidConversionFunction({
       reference
-    }, ReferenceType.FEED);
+    }, 'feed');
   }
   /**
    * Make a new feed reader for downloading feed updates.

package/dist/mjs/index.js

@@ -1,6 +1,7 @@
 import { Bee } from "./bee.js";
 export { SUPPORTED_BEE_VERSION, SUPPORTED_BEE_VERSION_EXACT } from "./modules/debug/status.js";
 export * from "./types/index.js";
+export * from "./utils/constants.js";
 export * from "./utils/error.js";
 export * as Utils from "./utils/expose.js";
 export { Bee };

package/dist/mjs/modules/grantee.js

@@ -10,7 +10,7 @@ export async function getGrantees(reference, requestOptions) {
   return {
     status: response.status,
     statusText: response.statusText,
-    data: response.data.data
+    data: response.data
   };
 }
 export async function createGrantees(requestOptions, postageBatchId, grantees) {
@@ -18,7 +18,7 @@ export async function createGrantees(requestOptions, postageBatchId, grantees) {
     method: 'post',
     url: granteeEndpoint,
     data: {
-      grantees: grantees
+      grantees
     },
     headers: {
       ...extractRedundantUploadHeaders(postageBatchId)

package/dist/mjs/utils/cid.js

@@ -0,0 +1,33 @@
+import { Binary } from 'cafe-utility';
+export const SWARM_MANIFEST_CODEC = 0xfa;
+export const SWARM_FEED_CODEC = 0xfb;
+const CODEC_TABLE = {
+  [SWARM_MANIFEST_CODEC]: 'manifest',
+  [SWARM_FEED_CODEC]: 'feed'
+};
+export function convertReferenceToCid(reference, type) {
+  if (reference.length !== 64) {
+    throw TypeError('Only 32-byte, non-encrypted references are supported');
+  }
+  const base32 = 'b';
+  const version = new Uint8Array([1]);
+  const codec = new Uint8Array([type === 'feed' ? SWARM_FEED_CODEC : SWARM_MANIFEST_CODEC]);
+  const unknown = new Uint8Array([1]);
+  const sha256 = new Uint8Array([27]);
+  const size = new Uint8Array([32]);
+  const header = Binary.uint8ArrayToBase32(Binary.concatBytes(version, codec, unknown, sha256, size)).replace(/\=+$/, '');
+  const hash = Binary.uint8ArrayToBase32(Binary.hexToUint8Array(reference)).replace(/\=+$/, '');
+  return `${base32}${header}${hash}`.toLowerCase();
+}
+export function convertCidToReference(cid) {
+  const bytes = Binary.base32ToUint8Array(cid.toUpperCase().slice(1));
+  const codec = bytes[1];
+  if (!CODEC_TABLE[codec]) {
+    throw new Error('Unknown codec');
+  }
+  const reference = bytes.slice(-32);
+  return {
+    type: CODEC_TABLE[codec],
+    reference: Binary.uint8ArrayToHex(reference)
+  };
+}

package/dist/mjs/utils/constants.js

@@ -0,0 +1,3 @@
+export const SWARM_GATEWAY_URL = 'https://api.gateway.ethswarm.org';
+export const NULL_STAMP = '0000000000000000000000000000000000000000000000000000000000000000';
+export const NULL_TOPIC = '0000000000000000000000000000000000000000000000000000000000000000';

package/dist/mjs/utils/expose.js

@@ -7,5 +7,4 @@ export { keccak256Hash } from "./hash.js";
 export { makeMaxTarget } from "./pss.js";
 export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampEffectiveBytes, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage } from "./stamps.js";
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from "./redundancy.js";
-export const NULL_STAMP = '0000000000000000000000000000000000000000000000000000000000000000';
-export const NULL_TOPIC = '0000000000000000000000000000000000000000000000000000000000000000';
+export { convertCidToReference, convertReferenceToCid } from "./cid.js";

package/dist/mjs/utils/http.js

@@ -21,13 +21,6 @@ export async function http(options, config) {
     const requestConfig = Objects.deepMerge3(DEFAULT_HTTP_CONFIG, config, options);
     maybeRunOnRequestHook(options, requestConfig);
     const response = await axios(requestConfig);
-    // Axios does not parse array of strings as JSON
-    if (Array.isArray(response.data) && response.data.every(element => typeof element === 'string')) {
-      const array = response.data;
-      response.data = {
-        data: array
-      };
-    }
     // TODO: https://github.com/axios/axios/pull/6253
     return response;
   } catch (e) {

package/dist/mjs/utils/tar.browser.js

@@ -12,6 +12,9 @@ export class TarStream {
     });
   }
   beginFile(path, size) {
+    if (path.length > 100) {
+      throw new Error(`File name too long: ${path}`);
+    }
     const header = createHeader(path, size);
     this.pieces.push(header);
     this.currentFileSize = 0;

package/dist/mjs/utils/tar.js

@@ -5,6 +5,9 @@ export class TarStream {
     this.currentFileSize = 0;
   }
   beginFile(path, size) {
+    if (path.length > 100) {
+      throw new Error(`File name too long: ${path}`);
+    }
     const header = createHeader(path, size);
     this.output.write(header);
     this.currentFileSize = 0;

package/dist/mjs/utils/type.js

@@ -1,6 +1,6 @@
-import { decodeCid, encodeReference } from '@ethersphere/swarm-cid';
 import { Readable } from 'stream';
 import { ADDRESS_HEX_LENGTH, BATCH_ID_HEX_LENGTH, ENCRYPTED_REFERENCE_HEX_LENGTH, PSS_TARGET_HEX_LENGTH_MAX, PUBKEY_HEX_LENGTH, REFERENCE_HEX_LENGTH, TAGS_LIMIT_MAX, TAGS_LIMIT_MIN } from "../types/index.js";
+import { convertCidToReference, convertReferenceToCid } from "./cid.js";
 import { BeeArgumentError, BeeError } from "./error.js";
 import { isFile } from "./file.js";
 import { assertHexString, assertPrefixedHexString, isHexString } from "./hex.js";
@@ -110,7 +110,7 @@ export function makeReferenceOrEns(value, expectedCidType) {
     throw new TypeError('ReferenceCidOrEns has to be a string!');
   }
   try {
-    const result = decodeCid(value);
+    const result = convertCidToReference(value);
     if (result.type !== expectedCidType) {
       throw new BeeError(`CID was expected to be of type ${expectedCidType}, but got instead ${result.type ?? 'non-Swarm CID'}`);
     }
@@ -124,13 +124,13 @@ export function makeReferenceOrEns(value, expectedCidType) {
 /**
  * Function that adds getter which converts the reference into CID base32 encoded string.
  * @param result
- * @param cidType Type as described in the @ethersphere/swarm-cids-js -> ReferenceType
+ * @param cidType feed or manifest
  */
 export function addCidConversionFunction(result, cidType) {
   return {
     ...result,
     cid() {
-      return encodeReference(result.reference, cidType).toString();
+      return convertReferenceToCid(result.reference, cidType);
     }
   };
 }

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 import { Bee } from './bee';
 export { SUPPORTED_BEE_VERSION, SUPPORTED_BEE_VERSION_EXACT } from './modules/debug/status';
 export * from './types';
+export * from './utils/constants';
 export * from './utils/error';
 export * as Utils from './utils/expose';
 export { Bee };

package/dist/types/types/index.d.ts

@@ -7,9 +7,6 @@ import type { BeeError } from '../utils/error';
 import type { EthAddress, HexEthAddress } from '../utils/eth';
 import type { HexString } from '../utils/hex';
 export * from './debug';
-export interface Dictionary<T> {
-    [Key: string]: T;
-}
 export declare const SPAN_SIZE = 8;
 export declare const SECTION_SIZE = 32;
 export declare const BRANCHES = 128;
@@ -73,6 +70,8 @@ export type BeeRequestOptions = {
     timeout?: number | false;
     headers?: Record<string, string>;
     onRequest?: (request: BeeRequest) => void;
+    httpAgent?: any;
+    httpsAgent?: any;
 };
 export interface BeeOptions extends BeeRequestOptions {
     /**
@@ -96,7 +95,6 @@ export interface UploadResultWithCid extends UploadResult {
      * Function that converts the reference into Swarm CIDs
      *
      * @throws TypeError if the reference is encrypted reference (eq. 128 chars long) which is not supported in CID
-     * @see https://github.com/ethersphere/swarm-cid-js
      */
     cid: () => string;
 }
@@ -120,7 +118,6 @@ export interface UploadResult {
 export interface UploadOptions {
     /**
      * If set to true, an ACT will be created for the uploaded data.
-     *
      */
     act?: boolean;
     /**
@@ -380,8 +377,6 @@ export interface FeedManifestResult {
     reference: Reference;
     /**
      * Function that converts the reference into Swarm Feed CID.
-     *
-     * @see https://github.com/ethersphere/swarm-cid-js
      */
     cid: () => string;
 }

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

@@ -0,0 +1,9 @@
+import { Reference } from '..';
+export declare const SWARM_MANIFEST_CODEC = 250;
+export declare const SWARM_FEED_CODEC = 251;
+export type DecodedCID = {
+    type: 'feed' | 'manifest';
+    reference: Reference;
+};
+export declare function convertReferenceToCid(reference: Reference | string, type: 'feed' | 'manifest'): string;
+export declare function convertCidToReference(cid: string): DecodedCID;

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

@@ -0,0 +1,4 @@
+import { BatchId, Topic } from '..';
+export declare const SWARM_GATEWAY_URL = "https://api.gateway.ethswarm.org";
+export declare const NULL_STAMP: BatchId;
+export declare const NULL_TOPIC: Topic;

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

@@ -1,12 +1,10 @@
-import { BatchId, Topic } from '..';
 export { getCollectionSize } from './collection';
 export { getFolderSize } from './collection.node';
-export { assertBytes, assertFlexBytes, Bytes, bytesAtOffset, bytesEqual, FlexBytes, flexBytesAtOffset, isBytes, isFlexBytes, } from './bytes';
-export { assertHexString, assertPrefixedHexString, bytesToHex, HexString, hexToBytes, intToHex, isHexString, makeHexString, PrefixedHexString, } from './hex';
-export { capitalizeAddressERC55, EthAddress, ethToSwarmAddress, fromLittleEndian, isHexEthAddress, makeEthAddress, makeEthereumWalletSigner, makeHexEthAddress, toLittleEndian, } from './eth';
+export { Bytes, FlexBytes, assertBytes, assertFlexBytes, bytesAtOffset, bytesEqual, flexBytesAtOffset, isBytes, isFlexBytes, } from './bytes';
+export { HexString, PrefixedHexString, assertHexString, assertPrefixedHexString, bytesToHex, hexToBytes, intToHex, isHexString, makeHexString, } from './hex';
+export { EthAddress, capitalizeAddressERC55, ethToSwarmAddress, fromLittleEndian, isHexEthAddress, makeEthAddress, makeEthereumWalletSigner, makeHexEthAddress, toLittleEndian, } from './eth';
 export { keccak256Hash } from './hash';
 export { makeMaxTarget } from './pss';
 export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampEffectiveBytes, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage, } from './stamps';
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from './redundancy';
-export declare const NULL_STAMP: BatchId;
-export declare const NULL_TOPIC: Topic;
+export { convertCidToReference, convertReferenceToCid } from './cid';

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

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-import { ReferenceType } from '@ethersphere/swarm-cid';
 import { Readable } from 'stream';
 import { Address, AddressPrefix, AllTagsOptions, BatchId, BeeRequestOptions, CashoutOptions, CollectionUploadOptions, FileUploadOptions, NumberString, PostageBatchOptions, PssMessageHandler, PublicKey, Reference, ReferenceOrEns, Tag, TransactionHash, TransactionOptions, UploadOptions } from '../types';
 export declare function isReadable(obj: unknown): obj is Readable;
@@ -25,15 +24,15 @@ export declare function assertReferenceOrEns(value: unknown): asserts value is R
  * @param value
  * @param expectedCidType
  */
-export declare function makeReferenceOrEns(value: unknown, expectedCidType: ReferenceType): ReferenceOrEns;
+export declare function makeReferenceOrEns(value: unknown, expectedCidType: 'feed' | 'manifest'): ReferenceOrEns;
 /**
  * Function that adds getter which converts the reference into CID base32 encoded string.
  * @param result
- * @param cidType Type as described in the @ethersphere/swarm-cids-js -> ReferenceType
+ * @param cidType feed or manifest
  */
 export declare function addCidConversionFunction<T extends {
     reference: string;
-}>(result: T, cidType: ReferenceType): T & {
+}>(result: T, cidType: 'feed' | 'manifest'): T & {
     cid: () => string;
 };
 export declare function assertAddress(value: unknown): asserts value is Address;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -61,9 +61,8 @@
     "bee": "npx @fairdatasociety/fdp-play@3.2.0 start --detach --fresh"
   },
   "dependencies": {
-    "@ethersphere/swarm-cid": "^0.1.0",
     "axios": "^0.28.1",
-    "cafe-utility": "^23.7.0",
+    "cafe-utility": "^23.10.0",
     "elliptic": "^6.5.4",
     "isomorphic-ws": "^4.0.1",
     "js-sha3": "^0.8.0",
@@ -79,7 +78,6 @@
     "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.4.2",
-    "@fluffy-spoon/substitute": "^1.208.0",
     "@jest/types": "^29.6.3",
     "@naholyr/cross-env": "^1.0.0",
     "@types/elliptic": "^6.4.14",
@@ -100,7 +98,6 @@
     "husky": "^8.0.1",
     "jest": "^29.7.0",
     "nock": "^13.3.0",
-    "playwright-test": "^8.1.2",
     "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^5.3.1",