@upcoming/bee-js 0.10.1 → 0.12.0

package/dist/cjs/feed/index.js

@@ -23,7 +23,7 @@ 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.downloadFeedUpdate = exports.getFeedUpdateChunkReference = exports.updateFeedWithPayload = exports.updateFeedWithReference = exports.findNextIndex = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const soc_1 = require("../chunk/soc");
 const chunkAPI = __importStar(require("../modules/chunk"));
@@ -51,7 +51,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 +60,90 @@ 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);
+    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;
 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 update = await downloadFeedUpdate(requestOptions, owner, topic, options.index, options.hasTimestamp);
+        const feedIndex = typeof options.index === 'number' ? typed_bytes_1.FeedIndex.fromBigInt(BigInt(options.index)) : options.index;
+        return {
+            payload: update.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/index.js

@@ -26,11 +26,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BeeDev = exports.Bee = exports.Utils = exports.Duration = exports.Bytes = exports.SUPPORTED_BEE_VERSION_EXACT = exports.SUPPORTED_BEE_VERSION = exports.MantarayNode = exports.MerkleTree = void 0;
+exports.Stamper = exports.BeeDev = exports.Bee = exports.Utils = exports.Duration = exports.Bytes = exports.SUPPORTED_BEE_VERSION_EXACT = exports.SUPPORTED_BEE_VERSION = exports.MantarayNode = exports.MerkleTree = void 0;
 const bee_1 = require("./bee");
 Object.defineProperty(exports, "Bee", { enumerable: true, get: function () { return bee_1.Bee; } });
 const bee_dev_1 = require("./bee-dev");
 Object.defineProperty(exports, "BeeDev", { enumerable: true, get: function () { return bee_dev_1.BeeDev; } });
+const stamper_1 = require("./stamper/stamper");
+Object.defineProperty(exports, "Stamper", { enumerable: true, get: function () { return stamper_1.Stamper; } });
 var cafe_utility_1 = require("cafe-utility");
 Object.defineProperty(exports, "MerkleTree", { enumerable: true, get: function () { return cafe_utility_1.MerkleTree; } });
 var manifest_1 = require("./manifest/manifest");

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/stamper/stamper.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stamper = void 0;
+const cafe_utility_1 = require("cafe-utility");
+const typed_bytes_1 = require("../utils/typed-bytes");
+class Stamper {
+    constructor(signer, batchId, buckets, depth) {
+        this.signer = new typed_bytes_1.PrivateKey(signer);
+        this.batchId = new typed_bytes_1.BatchId(batchId);
+        this.buckets = buckets;
+        this.depth = depth;
+        this.maxSlot = 2 ** (this.depth - 16);
+    }
+    static fromBlank(signer, batchId, depth) {
+        return new Stamper(signer, batchId, new Uint32Array(65536), depth);
+    }
+    static fromState(signer, batchId, buckets, depth) {
+        return new Stamper(signer, batchId, buckets, depth);
+    }
+    stamp(chunk) {
+        const address = chunk.hash();
+        const bucket = cafe_utility_1.Binary.uint16ToNumber(address, 'BE');
+        const height = this.buckets[bucket];
+        if (height >= this.maxSlot) {
+            throw Error('Bucket is full');
+        }
+        this.buckets[bucket]++;
+        const index = cafe_utility_1.Binary.concatBytes(cafe_utility_1.Binary.numberToUint32(bucket, 'BE'), cafe_utility_1.Binary.numberToUint32(height, 'BE'));
+        const timestamp = cafe_utility_1.Binary.numberToUint64(BigInt(Date.now()), 'BE');
+        const signature = this.signer.sign(cafe_utility_1.Binary.concatBytes(address, this.batchId.toUint8Array(), index, timestamp));
+        return {
+            batchId: this.batchId,
+            index,
+            issuer: this.signer.publicKey().address().toUint8Array(),
+            signature: signature.toUint8Array(),
+            timestamp,
+        };
+    }
+    getState() {
+        return this.buckets;
+    }
+}
+exports.Stamper = Stamper;

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));