@ethersphere/bee-js 4.0.0 → 4.1.0

package/dist/types/{types → src/types}/debug.d.ts

@@ -215,3 +215,21 @@ export interface ChainState {
     totalAmount: NumberString;
     currentPrice: NumberString;
 }
+export interface WalletBalance {
+    /**
+     * Balance of BZZ tokens
+     */
+    bzz: NumberString;
+    /**
+     * Balance of xDai
+     */
+    xDai: NumberString;
+    /**
+     * Chain network ID to which the Bee node is connected
+     */
+    chainID: number;
+    /**
+     * Chequebook contract address
+     */
+    contractAddress: string;
+}

package/dist/types/{types → src/types}/index.d.ts

@@ -51,9 +51,12 @@ export declare const FEED_INDEX_HEX_LENGTH = 16;
 export declare type Reference = HexString<typeof REFERENCE_HEX_LENGTH> | HexString<typeof ENCRYPTED_REFERENCE_HEX_LENGTH>;
 /**
  * Type that represents either Swarm's reference in hex string or ESN domain (something.eth).
- * This is the type used on all the download functions.
  */
 export declare type ReferenceOrEns = Reference | string;
+/**
+ * Type that represents either Swarm's reference in hex string, ESN domain (something.eth) or CID using one of the Swarm's codecs.
+ */
+export declare type ReferenceCidOrEns = ReferenceOrEns | string;
 export declare type PlainBytesReference = Bytes<typeof REFERENCE_BYTES_LENGTH>;
 export declare type EncryptedBytesReference = Bytes<typeof ENCRYPTED_REFERENCE_BYTES_LENGTH>;
 export declare type BytesReference = PlainBytesReference | EncryptedBytesReference;
@@ -120,6 +123,9 @@ export interface BeeOptions extends RequestOptions {
      */
     onResponse?: HookCallback<BeeResponse>;
 }
+export interface UploadResultWithCid extends UploadResult {
+    cid: string;
+}
 /**
  * Result of upload calls.
  */
@@ -450,6 +456,22 @@ export interface PostageBatchOptions extends RequestOptions {
      */
     gasPrice?: NumberString;
     immutableFlag?: boolean;
+    /**
+     * The returned Promise will await until the purchased Postage Batch is usable.
+     * In other word, it has to have enough block confirmations that Bee pronounce it usable.
+     * If turned on, this significantly prolong the creation of postage batch!
+     * If you plan to use the stamp right away for some action with Bee (like uploading using this stamp) it is
+     * highly recommended to use this option, otherwise you might get errors "stamp not usable" from Bee.
+     *
+     * In next breaking release this option will be turned on by default.
+     * @default false
+     */
+    waitForUsable?: boolean;
+    /**
+     * When waiting for the postage stamp to become usable, this specify the timeout for the waiting.
+     * Default: 120s
+     */
+    waitForUsableTimeout?: number;
 }
 /**
  * With this type a number should be represented in a string

package/dist/types/{utils → src/utils}/type.d.ts

@@ -1,4 +1,5 @@
-import { Address, AddressPrefix, AllTagsOptions, BatchId, CollectionUploadOptions, FileUploadOptions, NumberString, PssMessageHandler, PublicKey, Readable, Reference, Tag, UploadOptions, TransactionHash, RequestOptions, PostageBatchOptions, CashoutOptions, ReferenceOrEns } from '../types';
+import { Address, AddressPrefix, AllTagsOptions, BatchId, CollectionUploadOptions, FileUploadOptions, NumberString, PssMessageHandler, PublicKey, Readable, Reference, Tag, UploadOptions, TransactionHash, RequestOptions, PostageBatchOptions, CashoutOptions, ReferenceOrEns, UploadResult, UploadResultWithCid } from '../types';
+import { ReferenceType } from '@ethersphere/swarm-cid';
 export declare function isUint8Array(obj: unknown): obj is Uint8Array;
 export declare function isInteger(value: unknown): value is number | NumberString;
 export declare function isObject(value: unknown): value is Record<string, unknown>;
@@ -22,8 +23,22 @@ export declare function assertStrictlyObject(value: unknown, name?: string): ass
 export declare function assertBoolean(value: unknown, name?: string): asserts value is boolean;
 export declare function assertInteger(value: unknown, name?: string): asserts value is number | NumberString;
 export declare function assertNonNegativeInteger(value: unknown, name?: string): asserts value is number | NumberString;
+export declare function assertPositiveInteger(value: unknown, name?: string): asserts value is number | NumberString;
 export declare function assertReference(value: unknown): asserts value is Reference;
 export declare function assertReferenceOrEns(value: unknown): asserts value is ReferenceOrEns;
+/**
+ * Function that mainly converts Swarm CID into hex encoded Swarm Reference
+ *
+ * @param value
+ * @param expectedCidType
+ */
+export declare function makeReferenceOrEns(value: unknown, expectedCidType: ReferenceType): 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
+ */
+export declare function addCidConversionFunction(result: UploadResult, cidType: ReferenceType): UploadResultWithCid;
 export declare function assertAddress(value: unknown): asserts value is Address;
 export declare function assertBatchId(value: unknown): asserts value is BatchId;
 export declare function assertRequestOptions(value: unknown, name?: string): asserts value is RequestOptions;

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

@@ -0,0 +1,119 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+import type { Ky, BeeGenericResponse, Reference, Address, BatchId, PostageBatch, PlainBytesReference } from '../src/types';
+import { HexString } from '../src/utils/hex';
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            toBeHashReference(): R;
+            toBeBeeResponse(expectedStatusCode: number): R;
+            toBeOneOf(el: unknown[]): R;
+            toBeType(type: string): R;
+            toBeNumberString(): R;
+        }
+    }
+}
+/**
+ * Load common own Jest Matchers which can be used to check particular return values.
+ */
+export declare function commonMatchers(): void;
+/**
+ * Sleep for N miliseconds
+ *
+ * @param ms Number of miliseconds to sleep
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * Helper function that reads whole content of ReadableStream
+ * @param stream
+ */
+export declare function readWholeUint8ArrayReadableStream(stream: ReadableStream<Uint8Array>): Promise<Uint8Array>;
+export declare function createRandomNodeReadable(totalSize: number, chunkSize?: number): Readable;
+export declare function createReadableStream(iterable: Iterable<Uint8Array>): ReadableStream;
+/**
+ * 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
+ */
+export declare function randomByteArray(length: number, seed?: number): Uint8Array;
+/**
+ * Returns a url for testing the Bee public API
+ */
+export declare function beeUrl(): string;
+export declare function beeKy(): Ky;
+/**
+ * Returns a url of another peer for testing the Bee public API
+ */
+export declare function beePeerUrl(): string;
+export declare function beePeerKy(): Ky;
+/**
+ * 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.
+ */
+export declare function getPostageBatch(url?: string): BatchId;
+/**
+ * Returns a url for testing the Bee Debug API
+ */
+export declare function beeDebugUrl(): string;
+export declare function beeDebugKy(): Ky;
+/**
+ * Returns a url for testing the Bee Debug API
+ */
+export declare function beePeerDebugUrl(): string;
+export declare function beePeerDebugKy(): Ky;
+/**
+ * Try to delete a chunk from local storage, ignoring all errors
+ *
+ * @param address  Swarm address of chunk
+ */
+export declare function tryDeleteChunkFromLocalStorage(address: string | PlainBytesReference): Promise<void>;
+/**
+ * Formatting utility for displaying long strings like hexstrings.
+ *
+ * @param inputStr
+ * @param len
+ */
+export declare function shorten(inputStr: unknown, len?: number): string;
+export declare function waitForBatchToBeUsable(batchId: string, pollingInterval?: number): Promise<void>;
+/**
+ * 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
+ */
+export declare function getOrCreatePostageBatch(amount?: string, depth?: number, immutable?: boolean): Promise<PostageBatch>;
+export declare function makeTestTarget(target: string): string;
+export declare const invalidReference: Reference;
+export declare const okResponse: BeeGenericResponse;
+export declare const createdResponse: BeeGenericResponse;
+export declare const ERR_TIMEOUT = 40000;
+export declare const BIG_FILE_TIMEOUT = 100000;
+export declare const PSS_TIMEOUT = 120000;
+export declare const FEED_TIMEOUT = 120000;
+export declare const BLOCKCHAIN_TRANSACTION_TIMEOUT = 40000;
+export declare const WAITING_USABLE_STAMP_TIMEOUT = 130000;
+export declare const testChunkPayload: Uint8Array;
+export declare const testChunkSpan: Uint8Array;
+export declare const testChunkData: Uint8Array;
+export declare const testChunkHash: Reference;
+export declare const testAddress: Address;
+export declare const testBatchId: BatchId;
+export declare const testJsonPayload: {
+    some: string;
+}[];
+export declare const testJsonStringPayload: string;
+export declare const testJsonHash = "872a858115b8bee4408b1427b49e472883fdc2512d5a8f2d428b97ecc8f7ccfa";
+export declare const testJsonCid = "bah5acgzaq4vilaivxc7oiqelcqt3jhshfcb73qsrfvni6lkcrol6zshxzt5a";
+export declare const testJsonEns = "testing.eth";
+export declare const testIdentity: {
+    privateKey: HexString<number>;
+    publicKey: HexString<number>;
+    address: HexString<number>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -64,6 +64,7 @@
     "bee": "bee-factory start"
   },
   "dependencies": {
+    "@ethersphere/swarm-cid": "^0.1.0",
     "@types/readable-stream": "^2.3.13",
     "bufferutil": "^4.0.6",
     "elliptic": "^6.5.4",
@@ -87,7 +88,7 @@
     "@babel/preset-typescript": "^7.14.5",
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.2.1",
-    "@ethersphere/bee-factory": "^0.4.0",
+    "@ethersphere/bee-factory": "^0.4.1",
     "@fluffy-spoon/substitute": "^1.208.0",
     "@jest/test-sequencer": "^27.5.0",
     "@jest/types": "^27.5.1",
@@ -103,8 +104,8 @@
     "@types/semver": "^7.3.9",
     "@types/ws": "^8.5.3",
     "@typescript-eslint/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/parser": "^5.13.0",
-    "babel-jest": "^27.0.5",
+    "@typescript-eslint/parser": "^5.26.0",
+    "babel-jest": "^28.1.0",
     "babel-loader": "^8.2.5",
     "babel-plugin-add-import-extension": "^1.6.0",
     "cross-blob": "^2.0.1",