@ethersphere/bee-js 10.2.0 → 10.3.0

package/README.md

@@ -200,7 +200,7 @@ The `toString` method uses `toHex`.
 | `pssSend`                            | `POST /pss/send/:topic/:target` [🔗](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1send~1%7Btopic%7D~1%7Btargets%7D/post)     | ❌✅✅   |
 | `pssSubscribe` _Websocket_           | `GET /pss/subscribe/:topic` [🔗](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1%7Btopic%7D/get)                    | ❌❌✅   |
 | `pssReceive`                         | `GET /pss/subscribe/:topic` [🔗](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1%7Btopic%7D/get)                    | ❌❌✅   |
-| `getAllPostageBatch`                 | `GET /stamps` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get)                                                                 | ❌✅✅   |
+| `getPostageBatches`                  | `GET /stamps` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get)                                                                 | ❌✅✅   |
 | `getGlobalPostageBatches`            | `GET /batches` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1batches/get)                                                               | ❌✅✅   |
 | `getPostageBatch`                    | `GET /stamps/:batchId` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get)                                        | ❌✅✅   |
 | `getPostageBatchBuckets`             | `GET /stamps/:batchId/buckets` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D~1buckets/get)                       | ❌✅✅   |
@@ -266,7 +266,7 @@ async function getOrCreatePostageBatch() {
   const bee = new Bee('http://localhost:1633')
   let batchId
 
-  const batches = await bee.getAllPostageBatch()
+  const batches = await bee.getPostageBatches()
   const usable = batches.find(x => x.usable)
 
   if (usable) {

package/dist/cjs/bee.js

@@ -184,7 +184,7 @@ class Bee {
      * Chunks uploaded with this method should be retrieved with the {@link downloadChunk} method.
      *
      * @param stamp Postage Batch ID or an Envelope created with the {@link createEnvelope} method.
-     * @param data    Raw chunk to be uploaded
+     * @param data    Raw chunk to be uploaded (Content Addressed Chunk or Single Owner Chunk)
      * @param options Additional options like tag, encryption, pinning, content-type and request options
      * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
      *
@@ -193,6 +193,7 @@ class Bee {
      * @see [Bee API reference - `POST /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)
      */
     async uploadChunk(stamp, data, options, requestOptions) {
+        const isSOC = 'identifier' in data && 'signature' in data && 'owner' in data;
         data = data instanceof Uint8Array ? data : data.data;
         if (options) {
             options = (0, type_1.prepareUploadOptions)(options);
@@ -200,8 +201,11 @@ class Bee {
         if (data.length < typed_bytes_1.Span.LENGTH) {
             throw new error_1.BeeArgumentError(`Chunk has to have size of at least ${typed_bytes_1.Span.LENGTH}.`, data);
         }
-        if (data.length > types_1.CHUNK_SIZE + typed_bytes_1.Span.LENGTH) {
-            throw new error_1.BeeArgumentError(`Chunk has to have size of at most ${types_1.CHUNK_SIZE + typed_bytes_1.Span.LENGTH}.`, data);
+        if (!isSOC && data.length > types_1.CHUNK_SIZE + typed_bytes_1.Span.LENGTH) {
+            throw new error_1.BeeArgumentError(`Content Addressed Chunk must not exceed ${types_1.CHUNK_SIZE + typed_bytes_1.Span.LENGTH} bytes.`, data);
+        }
+        if (isSOC && data.length > types_1.CHUNK_SIZE + typed_bytes_1.Span.LENGTH + typed_bytes_1.Signature.LENGTH + typed_bytes_1.Identifier.LENGTH) {
+            throw new error_1.BeeArgumentError(`Single Owner Chunk must not exceed ${types_1.CHUNK_SIZE + typed_bytes_1.Span.LENGTH + typed_bytes_1.Signature.LENGTH + typed_bytes_1.Identifier.LENGTH} bytes.`, data);
         }
         return chunk.upload(this.getRequestOptionsForCall(requestOptions), data, stamp, options);
     }
@@ -837,7 +841,7 @@ class Bee {
         signer = new typed_bytes_1.PrivateKey(signer);
         identifier = new typed_bytes_1.Identifier(identifier);
         const cac = (0, cac_1.makeContentAddressedChunk)(data);
-        const soc = (0, soc_1.makeSingleOwnerChunk)(cac, identifier, signer);
+        const soc = cac.toSingleOwnerChunk(identifier, signer);
         return gsoc.send(this.getRequestOptionsForCall(requestOptions), soc, postageBatchId, options);
     }
     /**
@@ -968,6 +972,70 @@ class Bee {
         owner = new typed_bytes_1.EthAddress(owner);
         return (0, feed_2.fetchLatestFeedUpdate)(this.getRequestOptionsForCall(requestOptions), owner, topic);
     }
+    /**
+     * Creates a Content Addressed Chunk.
+     *
+     * To be uploaded with the {@link uploadChunk} method.
+     *
+     * Payload size must be between 1 and 4096 bytes.
+     *
+     * @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 (0, cac_1.makeContentAddressedChunk)(rawPayload, span);
+    }
+    /**
+     * Attempts to unmarshal arbitrary data into a Content Addressed Chunk.
+     * Throws an error if the data is not a valid CAC.
+     *
+     * @param data The chunk data (`span` and `payload`)
+     */
+    unmarshalContentAddressedChunk(data) {
+        return (0, cac_1.unmarshalContentAddressedChunk)(data);
+    }
+    /**
+     * Creates a Single Owner Chunk.
+     *
+     * To be uploaded with the {@link uploadChunk} method.
+     *
+     * Identical to chaining `makeContentAddressedChunk` and `toSingleOwnerChunk`.
+     *
+     * Payload size must be between 1 and 4096 bytes.
+     *
+     * @param address     Address of the Content Addressed Chunk
+     * @param span        Span of the Content Addressed Chunk
+     * @param payload     Payload of the Content Addressed Chunk
+     * @param identifier  The identifier of the chunk
+     * @param signer      The signer interface for signing the chunk
+     */
+    makeSingleOwnerChunk(address, span, payload, identifier, signer) {
+        return (0, soc_1.makeSingleOwnerChunk)(address, span, payload, identifier, signer);
+    }
+    /**
+     * Calculates the address of a Single Owner Chunk based on its identifier and owner address.
+     *
+     * @param identifier
+     * @param address
+     */
+    calculateSingleOwnerChunkAddress(identifier, address) {
+        return (0, soc_1.makeSOCAddress)(identifier, address);
+    }
+    /**
+     * Attempts to unmarshal arbitrary data into a Single Owner Chunk.
+     * Throws an error if the data is not a valid SOC.
+     *
+     * @param data    The chunk data
+     * @param address The address of the single owner chunk
+     *
+     * @returns a single owner chunk or throws error
+     */
+    unmarshalSingleOwnerChunk(data, address) {
+        return (0, soc_1.unmarshalSingleOwnerChunk)(data, address);
+    }
     /**
      * Returns an object for reading single owner chunks
      *
@@ -1550,7 +1618,9 @@ class Bee {
         const blockTime = this.network === 'gnosis' ? 5 : 15;
         const additionalAmount = (0, stamps_1.getAmountForDuration)(duration, chainState.currentPrice, blockTime);
         const currentAmount = (0, stamps_1.getAmountForDuration)(batch.duration, chainState.currentPrice, blockTime);
-        const targetAmount = duration.isZero() ? currentAmount * multiplier : currentAmount + additionalAmount * multiplier;
+        const targetAmount = duration.isZero()
+            ? currentAmount * multiplier
+            : (currentAmount + additionalAmount) * multiplier;
         const amountDelta = targetAmount - currentAmount;
         const transactionId = await this.topUpBatch(batch.batchID, amountDelta, requestOptions);
         if (depthDelta > 0) {

package/dist/cjs/chunk/cac.js

@@ -1,46 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asContentAddressedChunk = exports.makeContentAddressedChunk = exports.MAX_PAYLOAD_SIZE = exports.MIN_PAYLOAD_SIZE = void 0;
+exports.makeContentAddressedChunk = exports.unmarshalContentAddressedChunk = exports.MAX_PAYLOAD_SIZE = exports.MIN_PAYLOAD_SIZE = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const bytes_1 = require("../utils/bytes");
 const typed_bytes_1 = require("../utils/typed-bytes");
 const bmt_1 = require("./bmt");
+const soc_1 = require("./soc");
 exports.MIN_PAYLOAD_SIZE = 1;
 exports.MAX_PAYLOAD_SIZE = 4096;
-const ENCODER = new TextEncoder();
-/**
- * Creates a content addressed chunk and verifies the payload size.
- *
- * @param payloadBytes the data to be stored in the chunk
- */
-function makeContentAddressedChunk(payloadBytes) {
-    if (!(payloadBytes instanceof Uint8Array)) {
-        payloadBytes = ENCODER.encode(payloadBytes);
+function unmarshalContentAddressedChunk(data) {
+    data = new bytes_1.Bytes(data);
+    return makeContentAddressedChunk(data.toUint8Array().slice(typed_bytes_1.Span.LENGTH), typed_bytes_1.Span.fromSlice(data.toUint8Array(), 0));
+}
+exports.unmarshalContentAddressedChunk = unmarshalContentAddressedChunk;
+function makeContentAddressedChunk(rawPayload, span) {
+    if (cafe_utility_1.Types.isString(rawPayload)) {
+        rawPayload = bytes_1.Bytes.fromUtf8(rawPayload);
     }
-    if (payloadBytes.length < exports.MIN_PAYLOAD_SIZE || payloadBytes.length > exports.MAX_PAYLOAD_SIZE) {
-        throw new RangeError(`payload size ${payloadBytes.length} exceeds limits [${exports.MIN_PAYLOAD_SIZE}, ${exports.MAX_PAYLOAD_SIZE}]`);
+    if (rawPayload.length < exports.MIN_PAYLOAD_SIZE || rawPayload.length > exports.MAX_PAYLOAD_SIZE) {
+        throw new RangeError(`payload size ${rawPayload.length} exceeds limits [${exports.MIN_PAYLOAD_SIZE}, ${exports.MAX_PAYLOAD_SIZE}]`);
     }
-    const span = typed_bytes_1.Span.fromBigInt(BigInt(payloadBytes.length));
-    const data = cafe_utility_1.Binary.concatBytes(span.toUint8Array(), payloadBytes);
+    const typedSpan = span
+        ? typeof span === 'bigint'
+            ? typed_bytes_1.Span.fromBigInt(span)
+            : span
+        : typed_bytes_1.Span.fromBigInt(BigInt(rawPayload.length));
+    const payload = new bytes_1.Bytes(rawPayload);
+    const data = cafe_utility_1.Binary.concatBytes(typedSpan.toUint8Array(), payload.toUint8Array());
+    const address = (0, bmt_1.calculateChunkAddress)(data);
     return {
         data,
-        span,
-        payload: bytes_1.Bytes.fromSlice(data, typed_bytes_1.Span.LENGTH),
-        address: (0, bmt_1.calculateChunkAddress)(data),
+        span: typedSpan,
+        payload,
+        address,
+        toSingleOwnerChunk: (identifier, signer) => {
+            return (0, soc_1.makeSingleOwnerChunk)(address, typedSpan, payload, identifier, signer);
+        },
     };
 }
 exports.makeContentAddressedChunk = makeContentAddressedChunk;
-function asContentAddressedChunk(chunkBytes) {
-    if (chunkBytes.length < exports.MIN_PAYLOAD_SIZE + typed_bytes_1.Span.LENGTH || chunkBytes.length > exports.MAX_PAYLOAD_SIZE + typed_bytes_1.Span.LENGTH) {
-        throw new RangeError(`chunk size ${chunkBytes.length} exceeds limits [${exports.MIN_PAYLOAD_SIZE + typed_bytes_1.Span.LENGTH}, ${typed_bytes_1.Span.LENGTH}]`);
-    }
-    const span = typed_bytes_1.Span.fromSlice(chunkBytes, 0);
-    const data = cafe_utility_1.Binary.concatBytes(span.toUint8Array(), chunkBytes.slice(typed_bytes_1.Span.LENGTH));
-    return {
-        data,
-        span,
-        payload: bytes_1.Bytes.fromSlice(data, typed_bytes_1.Span.LENGTH),
-        address: (0, bmt_1.calculateChunkAddress)(data),
-    };
-}
-exports.asContentAddressedChunk = asContentAddressedChunk;

package/dist/cjs/chunk/soc.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadSingleOwnerChunk = exports.uploadSingleOwnerChunkWithWrappedChunk = exports.uploadSingleOwnerChunkData = exports.uploadSingleOwnerChunk = exports.makeSingleOwnerChunk = exports.makeSOCAddress = exports.makeSingleOwnerChunkFromData = void 0;
+exports.downloadSingleOwnerChunk = exports.uploadSingleOwnerChunkWithWrappedChunk = exports.uploadSingleOwnerChunkData = exports.uploadSingleOwnerChunk = exports.makeSingleOwnerChunk = exports.makeSOCAddress = exports.unmarshalSingleOwnerChunk = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const chunkAPI = __importStar(require("../modules/chunk"));
 const socAPI = __importStar(require("../modules/soc"));
@@ -33,8 +33,8 @@ const typed_bytes_1 = require("../utils/typed-bytes");
 const bmt_1 = require("./bmt");
 const cac_1 = require("./cac");
 const SOC_SIGNATURE_OFFSET = typed_bytes_1.Identifier.LENGTH;
-const SOC_SPAN_OFFSET = SOC_SIGNATURE_OFFSET + typed_bytes_1.Signature.LENGTH;
-const SOC_PAYLOAD_OFFSET = SOC_SPAN_OFFSET + typed_bytes_1.Span.LENGTH;
+const SOC_SPAN_OFFSET = typed_bytes_1.Identifier.LENGTH + typed_bytes_1.Signature.LENGTH;
+const SOC_PAYLOAD_OFFSET = typed_bytes_1.Identifier.LENGTH + typed_bytes_1.Signature.LENGTH + typed_bytes_1.Span.LENGTH;
 function recoverChunkOwner(data) {
     const cacData = data.slice(SOC_SPAN_OFFSET);
     const chunkAddress = (0, bmt_1.calculateChunkAddress)(cacData);
@@ -45,21 +45,22 @@ function recoverChunkOwner(data) {
     return ownerAddress;
 }
 /**
- * Verifies if the data is a valid single owner chunk
+ * Unmarshals arbitrary data into a Single Owner Chunk.
+ * Throws an error if the data is not a valid SOC.
  *
  * @param data    The chunk data
  * @param address The address of the single owner chunk
  *
  * @returns a single owner chunk or throws error
  */
-function makeSingleOwnerChunkFromData(data, address) {
+function unmarshalSingleOwnerChunk(data, address) {
     data = data instanceof bytes_1.Bytes ? data.toUint8Array() : data;
     address = new typed_bytes_1.Reference(address);
     const ownerAddress = recoverChunkOwner(data);
     const identifier = bytes_1.Bytes.fromSlice(data, 0, typed_bytes_1.Identifier.LENGTH);
     const socAddress = new typed_bytes_1.Reference(cafe_utility_1.Binary.keccak256(cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), ownerAddress.toUint8Array())));
     if (!cafe_utility_1.Binary.equals(address.toUint8Array(), socAddress.toUint8Array())) {
-        throw new error_1.BeeError('SOC Data does not match given address!');
+        throw new error_1.BeeError('SOC data does not match given address!');
     }
     const signature = typed_bytes_1.Signature.fromSlice(data, SOC_SIGNATURE_OFFSET);
     const span = typed_bytes_1.Span.fromSlice(data, SOC_SPAN_OFFSET);
@@ -74,7 +75,7 @@ function makeSingleOwnerChunkFromData(data, address) {
         owner: ownerAddress,
     };
 }
-exports.makeSingleOwnerChunkFromData = makeSingleOwnerChunkFromData;
+exports.unmarshalSingleOwnerChunk = unmarshalSingleOwnerChunk;
 function makeSOCAddress(identifier, address) {
     return new typed_bytes_1.Reference(cafe_utility_1.Binary.keccak256(cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), address.toUint8Array())));
 }
@@ -86,21 +87,19 @@ exports.makeSOCAddress = makeSOCAddress;
  * @param identifier  The identifier of the chunk
  * @param signer      The signer interface for signing the chunk
  */
-function makeSingleOwnerChunk(chunk, identifier, signer) {
+function makeSingleOwnerChunk(address, span, payload, identifier, signer) {
     identifier = new typed_bytes_1.Identifier(identifier);
     signer = new typed_bytes_1.PrivateKey(signer);
-    const address = makeSOCAddress(identifier, signer.publicKey().address());
-    const signature = signer.sign(cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), chunk.address.toUint8Array()));
-    const data = cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), signature.toUint8Array(), chunk.data);
-    const span = typed_bytes_1.Span.fromSlice(chunk.data, 0);
-    const payload = bytes_1.Bytes.fromSlice(chunk.data, typed_bytes_1.Span.LENGTH);
+    const socAddress = makeSOCAddress(identifier, signer.publicKey().address());
+    const signature = signer.sign(cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), address.toUint8Array()));
+    const data = cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), signature.toUint8Array(), span.toUint8Array(), payload.toUint8Array());
     return {
         data,
         identifier,
         signature,
         span,
         payload,
-        address,
+        address: socAddress,
         owner: signer.publicKey().address(),
     };
 }
@@ -134,14 +133,14 @@ async function uploadSingleOwnerChunkData(requestOptions, signer, stamp, identif
     signer = new typed_bytes_1.PrivateKey(signer);
     identifier = new typed_bytes_1.Identifier(identifier);
     const cac = (0, cac_1.makeContentAddressedChunk)(data);
-    const soc = makeSingleOwnerChunk(cac, identifier, signer);
+    const soc = cac.toSingleOwnerChunk(identifier, signer);
     return uploadSingleOwnerChunk(requestOptions, soc, stamp, options);
 }
 exports.uploadSingleOwnerChunkData = uploadSingleOwnerChunkData;
-async function uploadSingleOwnerChunkWithWrappedChunk(requestOptions, signer, stamp, identifier, rootChunk, options) {
+async function uploadSingleOwnerChunkWithWrappedChunk(requestOptions, signer, stamp, identifier, wrappedChunk, options) {
     signer = new typed_bytes_1.PrivateKey(signer);
     identifier = new typed_bytes_1.Identifier(identifier);
-    const soc = makeSingleOwnerChunk((0, cac_1.asContentAddressedChunk)(rootChunk), identifier, signer);
+    const soc = wrappedChunk.toSingleOwnerChunk(identifier, signer);
     return uploadSingleOwnerChunk(requestOptions, soc, stamp, options);
 }
 exports.uploadSingleOwnerChunkWithWrappedChunk = uploadSingleOwnerChunkWithWrappedChunk;
@@ -157,6 +156,6 @@ async function downloadSingleOwnerChunk(requestOptions, ownerAddress, identifier
     ownerAddress = new typed_bytes_1.EthAddress(ownerAddress);
     const address = makeSOCAddress(identifier, ownerAddress);
     const cac = await chunkAPI.download(requestOptions, address.toHex());
-    return makeSingleOwnerChunkFromData(cac, address);
+    return unmarshalSingleOwnerChunk(cac, address);
 }
 exports.downloadSingleOwnerChunk = downloadSingleOwnerChunk;

package/dist/cjs/feed/index.js

@@ -69,7 +69,7 @@ async function updateFeedWithPayload(requestOptions, signer, topic, data, postag
     const identifier = (0, identifier_1.makeFeedIdentifier)(topic, nextIndex);
     if (data.length > 4096) {
         const uploadResult = await bytes.upload(requestOptions, data, postageBatchId, options);
-        const rootChunk = await chunkAPI.download(requestOptions, uploadResult.reference);
+        const rootChunk = (0, cac_1.unmarshalContentAddressedChunk)(await chunkAPI.download(requestOptions, uploadResult.reference));
         return (0, soc_1.uploadSingleOwnerChunkWithWrappedChunk)(requestOptions, signer, postageBatchId, identifier, rootChunk, options);
     }
     return (0, soc_1.uploadSingleOwnerChunkData)(requestOptions, signer, postageBatchId, identifier, cafe_utility_1.Types.isString(data) ? bytes_1.Bytes.fromUtf8(data).toUint8Array() : data, options);
@@ -84,7 +84,7 @@ async function downloadFeedUpdate(requestOptions, owner, topic, index, hasTimest
     index = typeof index === 'number' ? typed_bytes_1.FeedIndex.fromBigInt(BigInt(index)) : index;
     const address = getFeedUpdateChunkReference(owner, topic, index);
     const data = await chunkAPI.download(requestOptions, address.toHex());
-    const soc = (0, soc_1.makeSingleOwnerChunkFromData)(data, address);
+    const soc = (0, soc_1.unmarshalSingleOwnerChunk)(data, address);
     let timestamp = cafe_utility_1.Optional.empty();
     if (hasTimestamp) {
         const timestampBytes = bytes_1.Bytes.fromSlice(soc.payload.toUint8Array(), TIMESTAMP_PAYLOAD_OFFSET, TIMESTAMP_PAYLOAD_SIZE);
@@ -100,7 +100,8 @@ async function downloadFeedUpdateAsCAC(requestOptions, owner, topic, index) {
     index = typeof index === 'number' ? typed_bytes_1.FeedIndex.fromBigInt(BigInt(index)) : index;
     const address = getFeedUpdateChunkReference(owner, topic, index);
     const data = await chunkAPI.download(requestOptions, address);
-    return (0, cac_1.asContentAddressedChunk)(data.slice(typed_bytes_1.Identifier.LENGTH + typed_bytes_1.Signature.LENGTH));
+    const soc = (0, soc_1.unmarshalSingleOwnerChunk)(data, address);
+    return (0, cac_1.makeContentAddressedChunk)(soc.payload, soc.span);
 }
 exports.downloadFeedUpdateAsCAC = downloadFeedUpdateAsCAC;
 function makeFeedReader(requestOptions, topic, owner) {