@upcoming/bee-js 0.5.4 → 0.6.0

package/dist/cjs/bee.js

@@ -824,6 +824,11 @@ class Bee {
         }
         return (0, feed_1.makeFeedWriter)(this.getRequestOptionsForCall(options), topic, signer);
     }
+    async fetchLatestFeedUpdate(topic, owner, requestOptions) {
+        topic = new typed_bytes_1.Topic(topic);
+        owner = new typed_bytes_1.EthAddress(owner);
+        return (0, feed_2.fetchLatestFeedUpdate)(this.getRequestOptionsForCall(requestOptions), owner, topic);
+    }
     /**
      * Returns an object for reading single owner chunks
      *
@@ -1293,7 +1298,6 @@ class Bee {
         if (options) {
             options = (0, type_1.prepareTransactionOptions)(options);
         }
-        // TODO: Add test for response
         return stake.stake(this.getRequestOptionsForCall(requestOptions), amountString, options);
     }
     /**

package/dist/cjs/manifest/manifest.js

@@ -102,6 +102,9 @@ class MantarayNode {
     get fullPathString() {
         return DECODER.decode(this.fullPath);
     }
+    /**
+     * Returns the metadata at the `/` path to access idiomatic properties.
+     */
     getRootMetadata() {
         const node = this.find('/');
         if (node && node.metadata) {
@@ -109,6 +112,34 @@ class MantarayNode {
         }
         return cafe_utility_1.Optional.empty();
     }
+    /**
+     * Returns the `swarm-index-document` and `swarm-error-document` metadata values.
+     */
+    getDocsMetadata() {
+        const node = this.find('/');
+        if (!node || !node.metadata) {
+            return { indexDocument: null, errorDocument: null };
+        }
+        return {
+            indexDocument: node.metadata['website-index-document'] ?? null,
+            errorDocument: node.metadata['website-error-document'] ?? null,
+        };
+    }
+    /**
+     * Attempts to resolve the manifest as a feed, returning the latest update.
+     */
+    async resolveFeed(bee, requestOptions) {
+        const node = this.find('/');
+        if (!node || !node.metadata) {
+            return cafe_utility_1.Optional.empty();
+        }
+        const owner = node.metadata['swarm-feed-owner'];
+        const topic = node.metadata['swarm-feed-topic'];
+        return cafe_utility_1.Optional.of(await bee.fetchLatestFeedUpdate(topic, owner, requestOptions));
+    }
+    /**
+     * Gets the binary representation of the node.
+     */
     async marshal() {
         for (const fork of this.forks.values()) {
             if (!fork.node.selfAddress) {
@@ -135,8 +166,21 @@ class MantarayNode {
             : this.targetAddress, forkBitmap, ...forks), this.obfuscationKey);
         return cafe_utility_1.Binary.concatBytes(this.obfuscationKey, data);
     }
+    /**
+     * Downloads and unmarshals a MantarayNode from the given reference.
+     *
+     * Do not forget calling `loadRecursively` on the returned node to load the entire tree.
+     */
     static async unmarshal(bee, reference, options, requestOptions) {
         const data = (await bee.downloadData(reference, options, requestOptions)).toUint8Array();
+        return this.unmarshalFromData(data);
+    }
+    /**
+     * Unmarshals a MantarayNode from the given data.
+     *
+     * Do not forget calling `loadRecursively` on the returned node to load the entire tree.
+     */
+    static unmarshalFromData(data) {
         const obfuscationKey = data.subarray(0, 32);
         const decrypted = cafe_utility_1.Binary.xorCypher(data.subarray(32), obfuscationKey);
         const reader = new cafe_utility_1.Uint8ArrayReader(decrypted);
@@ -157,6 +201,9 @@ class MantarayNode {
         }
         return node;
     }
+    /**
+     * Adds a fork to the node.
+     */
     addFork(path, reference, metadata) {
         this.selfAddress = null;
         path = path instanceof Uint8Array ? path : ENCODER.encode(path);
@@ -196,6 +243,9 @@ class MantarayNode {
             }
         }
     }
+    /**
+     * Removes a fork from the node.
+     */
     removeFork(path) {
         this.selfAddress = null;
         path = path instanceof Uint8Array ? path : ENCODER.encode(path);
@@ -212,12 +262,18 @@ class MantarayNode {
             parent.addFork(cafe_utility_1.Binary.concatBytes(match.path, fork.prefix), fork.node.targetAddress, fork.node.metadata);
         }
     }
+    /**
+     * Calculates the self address of the node.
+     */
     async calculateSelfAddress() {
         if (this.selfAddress) {
             return new typed_bytes_1.Reference(this.selfAddress);
         }
         return new typed_bytes_1.Reference((await cafe_utility_1.MerkleTree.root(await this.marshal())).hash());
     }
+    /**
+     * Saves the node and its children recursively.
+     */
     async saveRecursively(bee, postageBatchId, options, requestOptions) {
         for (const fork of this.forks.values()) {
             await fork.node.saveRecursively(bee, postageBatchId, options, requestOptions);
@@ -226,6 +282,9 @@ class MantarayNode {
         this.selfAddress = result.reference.toUint8Array();
         return result;
     }
+    /**
+     * Loads the node and its children recursively.
+     */
     async loadRecursively(bee, options, requestOptions) {
         for (const fork of this.forks.values()) {
             const node = await MantarayNode.unmarshal(bee, fork.node.targetAddress, options, requestOptions);
@@ -236,10 +295,16 @@ class MantarayNode {
             await fork.node.loadRecursively(bee, options, requestOptions);
         }
     }
+    /**
+     * Finds a node in the tree by its path.
+     */
     find(path) {
         const [closest, match] = this.findClosest(path);
         return match.length === path.length ? closest : null;
     }
+    /**
+     * Finds the closest node in the tree to the given path.
+     */
     findClosest(path, current = new Uint8Array()) {
         path = path instanceof Uint8Array ? path : ENCODER.encode(path);
         if (path.length === 0) {
@@ -251,6 +316,11 @@ class MantarayNode {
         }
         return [this, current];
     }
+    /**
+     * Returns an array of all nodes in the tree which have a target address set.
+     *
+     * Must be called after `loadRecursively`.
+     */
     collect(nodes = []) {
         for (const fork of this.forks.values()) {
             if (!cafe_utility_1.Binary.equals(fork.node.targetAddress, __1.NULL_ADDRESS)) {
@@ -260,6 +330,19 @@ class MantarayNode {
         }
         return nodes;
     }
+    /**
+     * Returns a path:reference map of all nodes in the tree which have a target address set.
+     *
+     * Must be called after `loadRecursively`.
+     */
+    collectAndMap() {
+        const nodes = this.collect();
+        const result = {};
+        for (const node of nodes) {
+            result[node.fullPathString] = new typed_bytes_1.Reference(node.targetAddress).toHex();
+        }
+        return result;
+    }
     determineType() {
         let type = 0;
         if (!cafe_utility_1.Binary.equals(this.targetAddress, __1.NULL_ADDRESS) || cafe_utility_1.Binary.equals(this.path, PATH_SEPARATOR)) {

package/dist/cjs/modules/debug/states.js

@@ -43,7 +43,7 @@ async function getChainState(requestOptions) {
         block: cafe_utility_1.Types.asNumber(body.block, { name: 'block' }),
         chainTip: cafe_utility_1.Types.asNumber(body.chainTip, { name: 'chainTip' }),
         totalAmount: (0, type_1.asNumberString)(body.totalAmount, { name: 'totalAmount' }),
-        currentPrice: (0, type_1.asNumberString)(body.currentPrice, { name: 'currentPrice' }),
+        currentPrice: cafe_utility_1.Types.asNumber(body.currentPrice, { name: 'currentPrice' }),
     };
 }
 exports.getChainState = getChainState;

package/dist/cjs/utils/tokens.js

@@ -52,19 +52,19 @@ class BZZ {
         return new BZZ(this.state.divide(other)[0]);
     }
     gt(other) {
-        return this.state.value > (other instanceof BZZ ? other.state : new cafe_utility_1.FixedPointNumber(other, BZZ.DIGITS)).value;
+        return this.state.compare(other.state) === 1;
     }
     gte(other) {
-        return this.state.value >= (other instanceof BZZ ? other.state : new cafe_utility_1.FixedPointNumber(other, BZZ.DIGITS)).value;
+        return this.state.compare(other.state) !== -1;
     }
     lt(other) {
-        return this.state.value < (other instanceof BZZ ? other.state : new cafe_utility_1.FixedPointNumber(other, BZZ.DIGITS)).value;
+        return this.state.compare(other.state) === -1;
     }
     lte(other) {
-        return this.state.value <= (other instanceof BZZ ? other.state : new cafe_utility_1.FixedPointNumber(other, BZZ.DIGITS)).value;
+        return this.state.compare(other.state) !== 1;
     }
     eq(other) {
-        return this.state.value === (other instanceof BZZ ? other.state : new cafe_utility_1.FixedPointNumber(other, BZZ.DIGITS)).value;
+        return this.state.compare(other.state) === 0;
     }
 }
 exports.BZZ = BZZ;
@@ -119,19 +119,19 @@ class DAI {
         return new DAI(this.state.divide(other)[0]);
     }
     gt(other) {
-        return this.state.value > (other instanceof DAI ? other.state : new cafe_utility_1.FixedPointNumber(other, DAI.DIGITS)).value;
+        return this.state.compare(other.state) === 1;
     }
     gte(other) {
-        return this.state.value >= (other instanceof DAI ? other.state : new cafe_utility_1.FixedPointNumber(other, DAI.DIGITS)).value;
+        return this.state.compare(other.state) !== -1;
     }
     lt(other) {
-        return this.state.value < (other instanceof DAI ? other.state : new cafe_utility_1.FixedPointNumber(other, DAI.DIGITS)).value;
+        return this.state.compare(other.state) === -1;
     }
     lte(other) {
-        return this.state.value <= (other instanceof DAI ? other.state : new cafe_utility_1.FixedPointNumber(other, DAI.DIGITS)).value;
+        return this.state.compare(other.state) !== 1;
     }
     eq(other) {
-        return this.state.value === (other instanceof DAI ? other.state : new cafe_utility_1.FixedPointNumber(other, DAI.DIGITS)).value;
+        return this.state.compare(other.state) === 0;
     }
 }
 exports.DAI = DAI;