@proto-kit/common 0.1.1-develop.187 → 0.1.1-develop.188

package/dist/utils/merkletree/RollupMerkleTree.js

@@ -1,246 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-/* eslint-disable id-length */
-/* eslint-disable line-comment-position */
-/* eslint-disable no-inline-comments */
-/* eslint-disable @typescript-eslint/no-magic-numbers */
-import { Bool, Circuit, Field, Poseidon, Struct } from "snarkyjs";
-import { notInCircuit } from "../utils";
-// external API
-// eslint-disable-next-line @typescript-eslint/no-use-before-define
-export { RollupMerkleTree, RollupMerkleWitness };
-// internal API
-// eslint-disable-next-line @typescript-eslint/no-use-before-define
-export { maybeSwap };
-/**
- * The {@link BaseMerkleWitness} class defines a circuit-compatible base class
- * for [Merkle Witness'](https://computersciencewiki.org/index.php/Merkle_proof).
- */
-class RollupMerkleWitness extends Struct({
-    path: Circuit.array(Field, 256 - 1),
-    isLeft: Circuit.array(Bool, 256 - 1),
-}) {
-    height() {
-        return RollupMerkleWitness.height;
-    }
-    /**
-     * Calculates a root depending on the leaf value.
-     * @param leaf Value of the leaf node that belongs to this Witness.
-     * @returns The calculated root.
-     */
-    calculateRoot(hash) {
-        const n = this.height();
-        for (let index = 1; index < n; ++index) {
-            const isLeft = this.isLeft[index - 1];
-            // eslint-disable-next-line @typescript-eslint/no-use-before-define
-            const [left, right] = maybeSwap(isLeft, hash, this.path[index - 1]);
-            hash = Poseidon.hash([left, right]);
-        }
-        return hash;
-    }
-    /**
-     * Calculates the index of the leaf node that belongs to this Witness.
-     * @returns Index of the leaf.
-     */
-    calculateIndex() {
-        let powerOfTwo = Field(1);
-        let index = Field(0);
-        const n = this.height();
-        // eslint-disable-next-line no-underscore-dangle
-        for (let index_ = 1; index_ < n; ++index_) {
-            index = Circuit.if(this.isLeft[index_ - 1], index, index.add(powerOfTwo));
-            powerOfTwo = powerOfTwo.mul(2);
-        }
-        return index;
-    }
-}
-RollupMerkleWitness.height = 256;
-/**
- * A [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree) is a binary tree in
- * which every leaf is the cryptography hash of a piece of data,
- * and every node is the hash of the concatenation of its two child nodes.
- *
- * A Merkle Tree allows developers to easily and securely verify
- * the integrity of large amounts of data.
- *
- * Take a look at our [documentation](https://docs.minaprotocol.com/en/zkapps)
- * on how to use Merkle Trees in combination with zkApps and
- * zero knowledge programming!
- *
- * Levels are indexed from leaves (level 0) to root (level N - 1).
- */
-class RollupMerkleTree {
-    static get leafCount() {
-        return 2n ** BigInt(RollupMerkleTree.height - 1);
-    }
-    constructor(store) {
-        this.store = store;
-        // eslint-disable-next-line @shopify/prefer-class-properties
-        this.zeroes = [0n];
-        for (let index = 1; index < RollupMerkleTree.height; index += 1) {
-            const previousLevel = Field(this.zeroes[index - 1]);
-            this.zeroes.push(Poseidon.hash([previousLevel, previousLevel]).toBigInt());
-        }
-    }
-    /**
-     * Returns a node which lives at a given index and level.
-     * @param level Level of the node.
-     * @param index Index of the node.
-     * @returns The data of the node.
-     */
-    getNode(level, index) {
-        return Field(this.store.getNode(index, level) ?? this.zeroes[level]);
-    }
-    /**
-     * Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree).
-     * @returns The root of the Merkle Tree.
-     */
-    getRoot() {
-        return this.getNode(RollupMerkleTree.height - 1, 0n);
-    }
-    // eslint-disable-next-line no-warning-comments
-    // TODO: this allows to set a node at an index larger than the size. OK?
-    setNode(level, index, value) {
-        this.store.setNode(index, level, value.toBigInt());
-    }
-    /**
-     * TODO: if this is passed an index bigger than the max, it will set a couple
-     * of out-of-bounds nodes but not affect the real Merkle root. OK?
-     */
-    /**
-     * Sets the value of a leaf node at a given index to a given value.
-     * @param index Position of the leaf node.
-     * @param leaf New value.
-     */
-    setLeaf(index, leaf) {
-        if (index >= this.leafCount) {
-            index %= this.leafCount;
-        }
-        this.store.openTransaction();
-        this.setNode(0, index, leaf);
-        let currentIndex = index;
-        for (let level = 1; level < RollupMerkleTree.height; level += 1) {
-            currentIndex /= 2n;
-            const left = this.getNode(level - 1, currentIndex * 2n);
-            const right = this.getNode(level - 1, currentIndex * 2n + 1n);
-            this.setNode(level, currentIndex, Poseidon.hash([left, right]));
-        }
-        this.store.commit();
-    }
-    /**
-     * Returns the witness (also known as
-     * [Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof))
-     * for the leaf at the given index.
-     * @param index Position of the leaf node.
-     * @returns The witness that belongs to the leaf.
-     */
-    getWitness(index) {
-        if (index >= this.leafCount) {
-            index %= this.leafCount;
-        }
-        const path = [];
-        const isLefts = [];
-        for (let level = 0; level < RollupMerkleTree.height - 1; level += 1) {
-            const isLeft = index % 2n === 0n;
-            const sibling = this.getNode(level, isLeft ? index + 1n : index - 1n);
-            isLefts.push(Bool(isLeft));
-            path.push(sibling);
-            index /= 2n;
-        }
-        return new RollupMerkleWitness({
-            isLeft: isLefts,
-            path,
-        });
-    }
-    // eslint-disable-next-line no-warning-comments, max-len
-    // TODO: should this take an optional offset? should it fail if the array is too long?
-    /**
-     * Fills all leaves of the tree.
-     * @param leaves Values to fill the leaves with.
-     */
-    fill(leaves) {
-        leaves.forEach((value, index) => {
-            this.setLeaf(BigInt(index), value);
-        });
-    }
-    /**
-     * Returns the amount of leaf nodes.
-     * @returns Amount of leaf nodes.
-     */
-    get leafCount() {
-        return RollupMerkleTree.leafCount;
-    }
-}
-RollupMerkleTree.height = 256;
-__decorate([
-    notInCircuit(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Number, BigInt]),
-    __metadata("design:returntype", Field)
-], RollupMerkleTree.prototype, "getNode", null);
-__decorate([
-    notInCircuit(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", Field)
-], RollupMerkleTree.prototype, "getRoot", null);
-__decorate([
-    notInCircuit(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [BigInt, Field]),
-    __metadata("design:returntype", void 0)
-], RollupMerkleTree.prototype, "setLeaf", null);
-__decorate([
-    notInCircuit(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [BigInt]),
-    __metadata("design:returntype", RollupMerkleWitness)
-], RollupMerkleTree.prototype, "getWitness", null);
-__decorate([
-    notInCircuit(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Array]),
-    __metadata("design:returntype", void 0)
-], RollupMerkleTree.prototype, "fill", null);
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export var MerkleTreeUtils;
-(function (MerkleTreeUtils) {
-    function normalizeKey(key) {
-        // if(NJORD_MERKLE_TREE_HEIGHT < 256){
-        //     return fieldMod(key, Field(RollupMerkleTree.leafCount).toConstant())
-        // eslint-disable-next-line max-len
-        //     // return modPower2(key, RollupMerkleTree.height - 1) //TODO Fix modPower2
-        // }else{
-        return key;
-        // }
-    }
-    MerkleTreeUtils.normalizeKey = normalizeKey;
-    function checkMembership(witness, root, key, value) {
-        const root2 = witness.calculateRoot(value);
-        const key2 = witness.calculateIndex();
-        key.assertEquals(key2, "Keys of MerkleWitness does not match");
-        return root.equals(root2);
-    }
-    MerkleTreeUtils.checkMembership = checkMembership;
-    function computeRoot(witness, value) {
-        return witness.calculateRoot(value);
-    }
-    MerkleTreeUtils.computeRoot = computeRoot;
-})(MerkleTreeUtils || (MerkleTreeUtils = {}));
-/**
- * More efficient version of `maybeSwapBad` which
- * reuses an intermediate variable
- */
-function maybeSwap(b, x, y) {
-    const m = b.toField().mul(x.sub(y)); // b*(x - y)
-    const x1 = y.add(m); // y + b*(x - y)
-    const y2 = x.sub(m); // x - b*(x - y) = x + b*(y - x)
-    return [x1, y2];
-}