@upcoming/bee-js 0.11.0 → 0.13.0

package/dist/cjs/chunk/cac.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeContentAddressedChunk = exports.MAX_PAYLOAD_SIZE = exports.MIN_PAYLOAD_SIZE = void 0;
+exports.asContentAddressedChunk = exports.makeContentAddressedChunk = 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");
@@ -30,3 +30,17 @@ function makeContentAddressedChunk(payloadBytes) {
     };
 }
 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.uploadSingleOwnerChunkData = exports.uploadSingleOwnerChunk = exports.makeSingleOwnerChunk = exports.makeSOCAddress = exports.makeSingleOwnerChunkFromData = void 0;
+exports.downloadSingleOwnerChunk = exports.uploadSingleOwnerChunkWithWrappedChunk = exports.uploadSingleOwnerChunkData = exports.uploadSingleOwnerChunk = exports.makeSingleOwnerChunk = exports.makeSOCAddress = exports.makeSingleOwnerChunkFromData = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const chunkAPI = __importStar(require("../modules/chunk"));
 const socAPI = __importStar(require("../modules/soc"));
@@ -138,6 +138,13 @@ async function uploadSingleOwnerChunkData(requestOptions, signer, stamp, identif
     return uploadSingleOwnerChunk(requestOptions, soc, stamp, options);
 }
 exports.uploadSingleOwnerChunkData = uploadSingleOwnerChunkData;
+async function uploadSingleOwnerChunkWithWrappedChunk(requestOptions, signer, stamp, identifier, rootChunk, 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);
+    return uploadSingleOwnerChunk(requestOptions, soc, stamp, options);
+}
+exports.uploadSingleOwnerChunkWithWrappedChunk = uploadSingleOwnerChunkWithWrappedChunk;
 /**
  * Helper function to download SOC.
  *

package/dist/cjs/feed/index.js

@@ -23,13 +23,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeFeedWriter = exports.makeFeedReader = exports.downloadFeedUpdate = exports.getFeedUpdateChunkReference = exports.updateFeed = exports.findNextIndex = void 0;
+exports.makeFeedWriter = exports.makeFeedReader = exports.downloadFeedUpdateAsCAC = exports.downloadFeedUpdate = exports.getFeedUpdateChunkReference = exports.updateFeedWithPayload = exports.updateFeedWithReference = exports.findNextIndex = void 0;
 const cafe_utility_1 = require("cafe-utility");
+const cac_1 = require("../chunk/cac");
 const soc_1 = require("../chunk/soc");
+const bytes = __importStar(require("../modules/bytes"));
 const chunkAPI = __importStar(require("../modules/chunk"));
 const feed_1 = require("../modules/feed");
 const bytes_1 = require("../utils/bytes");
 const error_1 = require("../utils/error");
+const resource_locator_1 = require("../utils/resource-locator");
 const typed_bytes_1 = require("../utils/typed-bytes");
 const identifier_1 = require("./identifier");
 const TIMESTAMP_PAYLOAD_OFFSET = 0;
@@ -51,7 +54,7 @@ async function findNextIndex(requestOptions, owner, topic) {
     }
 }
 exports.findNextIndex = findNextIndex;
-async function updateFeed(requestOptions, signer, topic, reference, postageBatchId, options) {
+async function updateFeedWithReference(requestOptions, signer, topic, reference, postageBatchId, options) {
     reference = new typed_bytes_1.Reference(reference);
     const nextIndex = options?.index ?? (await findNextIndex(requestOptions, signer.publicKey().address(), topic));
     const identifier = (0, identifier_1.makeFeedIdentifier)(topic, nextIndex);
@@ -60,50 +63,105 @@ async function updateFeed(requestOptions, signer, topic, reference, postageBatch
     const payloadBytes = cafe_utility_1.Binary.concatBytes(timestamp, reference.toUint8Array());
     return (0, soc_1.uploadSingleOwnerChunkData)(requestOptions, signer, postageBatchId, identifier, payloadBytes, options);
 }
-exports.updateFeed = updateFeed;
+exports.updateFeedWithReference = updateFeedWithReference;
+async function updateFeedWithPayload(requestOptions, signer, topic, data, postageBatchId, options) {
+    const nextIndex = options?.index ?? (await findNextIndex(requestOptions, signer.publicKey().address(), topic));
+    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);
+        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);
+}
+exports.updateFeedWithPayload = updateFeedWithPayload;
 function getFeedUpdateChunkReference(owner, topic, index) {
     const identifier = (0, identifier_1.makeFeedIdentifier)(topic, index);
     return new typed_bytes_1.Reference(cafe_utility_1.Binary.keccak256(cafe_utility_1.Binary.concatBytes(identifier.toUint8Array(), owner.toUint8Array())));
 }
 exports.getFeedUpdateChunkReference = getFeedUpdateChunkReference;
-async function downloadFeedUpdate(requestOptions, owner, topic, index) {
+async function downloadFeedUpdate(requestOptions, owner, topic, index, hasTimestamp = false) {
     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 timestampBytes = bytes_1.Bytes.fromSlice(soc.payload.toUint8Array(), TIMESTAMP_PAYLOAD_OFFSET, TIMESTAMP_PAYLOAD_SIZE);
-    const timestamp = Number(cafe_utility_1.Binary.uint64ToNumber(timestampBytes.toUint8Array(), 'BE'));
+    let timestamp = cafe_utility_1.Optional.empty();
+    if (hasTimestamp) {
+        const timestampBytes = bytes_1.Bytes.fromSlice(soc.payload.toUint8Array(), TIMESTAMP_PAYLOAD_OFFSET, TIMESTAMP_PAYLOAD_SIZE);
+        timestamp = cafe_utility_1.Optional.of(Number(cafe_utility_1.Binary.uint64ToNumber(timestampBytes.toUint8Array(), 'BE')));
+    }
     return {
         timestamp,
-        payload: new bytes_1.Bytes(soc.payload.offset(REFERENCE_PAYLOAD_OFFSET)),
+        payload: new bytes_1.Bytes(soc.payload.offset(hasTimestamp ? REFERENCE_PAYLOAD_OFFSET : 0)),
     };
 }
 exports.downloadFeedUpdate = downloadFeedUpdate;
+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));
+}
+exports.downloadFeedUpdateAsCAC = downloadFeedUpdateAsCAC;
 function makeFeedReader(requestOptions, topic, owner) {
+    // TODO: remove after enough time has passed in deprecated version
+    const download = async (options) => {
+        if (options?.index === undefined) {
+            return (0, feed_1.fetchLatestFeedUpdate)(requestOptions, owner, topic);
+        }
+        const update = await downloadFeedUpdate(requestOptions, owner, topic, options.index, options.hasTimestamp ?? true);
+        const feedIndex = typeof options.index === 'number' ? typed_bytes_1.FeedIndex.fromBigInt(BigInt(options.index)) : options.index;
+        return {
+            payload: update.payload,
+            feedIndex,
+        };
+    };
+    const downloadPayload = async (options) => {
+        if (options?.index === undefined) {
+            return (0, feed_1.fetchLatestFeedUpdate)(requestOptions, owner, topic);
+        }
+        const cac = await downloadFeedUpdateAsCAC(requestOptions, owner, topic, options.index);
+        const payload = cac.span.toBigInt() <= 4096n
+            ? cac.payload
+            : await bytes.download(requestOptions, new resource_locator_1.ResourceLocator(cac.address));
+        const feedIndex = typeof options.index === 'number' ? typed_bytes_1.FeedIndex.fromBigInt(BigInt(options.index)) : options.index;
+        return {
+            payload,
+            feedIndex,
+        };
+    };
+    const downloadReference = async (options) => {
+        let index = options?.index;
+        if (index === undefined) {
+            index = (await (0, feed_1.probeFeed)(requestOptions, owner, topic)).feedIndex;
+        }
+        const payload = await download({ ...options, index: index });
+        return {
+            reference: new typed_bytes_1.Reference(payload.payload.toUint8Array()),
+            feedIndex: payload.feedIndex,
+        };
+    };
     return {
+        download,
+        downloadPayload,
+        downloadReference,
         owner,
         topic,
-        async download(options) {
-            if (options?.index === undefined) {
-                return (0, feed_1.fetchLatestFeedUpdate)(requestOptions, owner, topic);
-            }
-            const update = await downloadFeedUpdate(requestOptions, owner, topic, options.index);
-            const feedIndex = typeof options.index === 'number' ? typed_bytes_1.FeedIndex.fromBigInt(BigInt(options.index)) : options.index;
-            return {
-                payload: update.payload,
-                feedIndex,
-            };
-        },
     };
 }
 exports.makeFeedReader = makeFeedReader;
 function makeFeedWriter(requestOptions, topic, signer) {
     const upload = async (postageBatchId, reference, options) => {
-        return updateFeed(requestOptions, signer, topic, reference, postageBatchId, options);
+        return updateFeedWithReference(requestOptions, signer, topic, reference, postageBatchId, options);
+    };
+    const uploadPayload = async (postageBatchId, data, options) => {
+        return updateFeedWithPayload(requestOptions, signer, topic, data, postageBatchId, options);
     };
     return {
         ...makeFeedReader(requestOptions, topic, signer.publicKey().address()),
         upload,
+        uploadReference: upload,
+        uploadPayload,
     };
 }
 exports.makeFeedWriter = makeFeedWriter;

package/dist/cjs/modules/feed.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchLatestFeedUpdate = exports.createFeedManifest = void 0;
+exports.probeFeed = exports.fetchLatestFeedUpdate = exports.createFeedManifest = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const bytes_1 = require("../utils/bytes");
 const error_1 = require("../utils/error");
@@ -51,8 +51,8 @@ function readFeedUpdateHeaders(headers) {
  * index of the subsequent update.
  *
  * @param requestOptions Options for making requests
- * @param owner          Owner's ethereum address in hex
- * @param topic          Topic in hex
+ * @param owner          Owner's ethereum address
+ * @param topic          Topic
  * @param options        Additional options, like index, at, type
  */
 async function fetchLatestFeedUpdate(requestOptions, owner, topic, options) {
@@ -67,3 +67,14 @@ async function fetchLatestFeedUpdate(requestOptions, owner, topic, options) {
     };
 }
 exports.fetchLatestFeedUpdate = fetchLatestFeedUpdate;
+async function probeFeed(requestOptions, owner, topic) {
+    const response = await (0, http_1.http)(requestOptions, {
+        responseType: 'arraybuffer',
+        url: `${feedEndpoint}/${owner}/${topic}`,
+        params: {
+            'Swarm-Only-Root-Chunk': true,
+        },
+    });
+    return readFeedUpdateHeaders(response.headers);
+}
+exports.probeFeed = probeFeed;

package/dist/cjs/utils/bytes.js

@@ -66,5 +66,8 @@ class Bytes {
     toJSON() {
         return JSON.parse(this.toUtf8());
     }
+    equals(other) {
+        return this.toHex() === new Bytes(other).toHex();
+    }
 }
 exports.Bytes = Bytes;

package/dist/cjs/utils/typed-bytes.js

@@ -63,6 +63,9 @@ class Identifier extends bytes_1.Bytes {
     constructor(bytes) {
         super(bytes, 32);
     }
+    static fromString(value) {
+        return new Identifier(cafe_utility_1.Binary.keccak256(ENCODER.encode(value)));
+    }
 }
 exports.Identifier = Identifier;
 Identifier.LENGTH = 32;
@@ -142,6 +145,11 @@ class Signature extends bytes_1.Bytes {
         const [x, y] = cafe_utility_1.Elliptic.recoverPublicKey(cafe_utility_1.Binary.concatBytes(ENCODER.encode(`\x19Ethereum Signed Message:\n32`), cafe_utility_1.Binary.keccak256(digest instanceof Uint8Array ? digest : ENCODER.encode(digest))), r, s, v);
         return new PublicKey(cafe_utility_1.Binary.concatBytes(cafe_utility_1.Binary.numberToUint256(x, 'BE'), cafe_utility_1.Binary.numberToUint256(y, 'BE')));
     }
+    isValid(digest, expectedAddress) {
+        const publicKey = this.recoverPublicKey(digest);
+        const address = publicKey.address();
+        return address.equals(expectedAddress);
+    }
 }
 exports.Signature = Signature;
 Signature.LENGTH = 65;
@@ -168,3 +176,4 @@ class FeedIndex extends bytes_1.Bytes {
 }
 exports.FeedIndex = FeedIndex;
 FeedIndex.LENGTH = 8;
+FeedIndex.MINUS_ONE = new FeedIndex(new Uint8Array(8).fill(0xff, 0, 8));