@proto-kit/common 0.1.1-develop.190 → 0.1.1-develop.2024

package/dist/trees/lmt/LinkedMerkleTreeTypes.js

@@ -0,0 +1,50 @@
+import { Field, Poseidon, Provable, Struct } from "o1js";
+export class LinkedLeafStruct extends Struct({
+    value: Field,
+    path: Field,
+    nextPath: Field,
+}) {
+    isDummy() {
+        return this.path.equals(0).and(this.nextPath.equals(0));
+    }
+    hash() {
+        const hash = Poseidon.hash(LinkedLeafStruct.toFields(this));
+        return Provable.if(this.isDummy(), Field(0), hash);
+    }
+    static dummy() {
+        return new LinkedLeafStruct({
+            value: Field(0),
+            path: Field(0),
+            nextPath: Field(0),
+        });
+    }
+}
+// export class LinkedMerkleTreeGlobalState extends Struct({
+//   root: Field,
+//   lastOccupiedIndex: Field,
+// }) {
+//   public static equals(
+//     state1: LinkedMerkleTreeGlobalState,
+//     state2: LinkedMerkleTreeGlobalState
+//   ): Bool {
+//     return state1.root
+//       .equals(state2.root)
+//       .and(state1.lastOccupiedIndex.equals(state2.lastOccupiedIndex));
+//   }
+//
+//   public static assertEquals(
+//     state1: LinkedMerkleTreeGlobalState,
+//     state2: LinkedMerkleTreeGlobalState,
+//     msg?: string
+//   ) {
+//     state1.root.assertEquals(
+//       state2.root,
+//       msg !== undefined ? `${msg}: root` : msg
+//     );
+//     state1.lastOccupiedIndex.assertEquals(
+//       state2.lastOccupiedIndex,
+//       msg !== undefined ? `${msg}: lastOccupiedIndex` : msg
+//     );
+//   }
+// }
+//# sourceMappingURL=LinkedMerkleTreeTypes.js.map

package/dist/trees/lmt/LinkedMerkleTreeTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkedMerkleTreeTypes.js","sourceRoot":"","sources":["../../../src/trees/lmt/LinkedMerkleTreeTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAEzD,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC;IAC3C,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,KAAK;IACX,QAAQ,EAAE,KAAK;CAChB,CAAC;IACO,OAAO;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC;IAEM,IAAI;QACT,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,OAAO,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,OAAO,IAAI,gBAAgB,CAAC;YAC1B,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YACf,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;SACnB,CAAC,CAAC;IACL,CAAC;CACF;AAED,4DAA4D;AAC5D,iBAAiB;AACjB,8BAA8B;AAC9B,OAAO;AACP,0BAA0B;AAC1B,2CAA2C;AAC3C,0CAA0C;AAC1C,cAAc;AACd,yBAAyB;AACzB,6BAA6B;AAC7B,yEAAyE;AACzE,MAAM;AACN,EAAE;AACF,gCAAgC;AAChC,2CAA2C;AAC3C,2CAA2C;AAC3C,mBAAmB;AACnB,QAAQ;AACR,gCAAgC;AAChC,qBAAqB;AACrB,iDAAiD;AACjD,SAAS;AACT,6CAA6C;AAC7C,kCAAkC;AAClC,8DAA8D;AAC9D,SAAS;AACT,MAAM;AACN,IAAI"}

package/dist/trees/sparse/InMemoryMerkleTreeStorage.d.ts

@@ -0,0 +1,11 @@
+import { MerkleTreeStore } from "./MerkleTreeStore";
+export declare class InMemoryMerkleTreeStorage implements MerkleTreeStore {
+    nodes: {
+        [key: number]: {
+            [key: string]: bigint;
+        };
+    };
+    getNode(key: bigint, level: number): bigint | undefined;
+    setNode(key: bigint, level: number, value: bigint): void;
+}
+//# sourceMappingURL=InMemoryMerkleTreeStorage.d.ts.map

package/dist/trees/sparse/InMemoryMerkleTreeStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InMemoryMerkleTreeStorage.d.ts","sourceRoot":"","sources":["../../../src/trees/sparse/InMemoryMerkleTreeStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,qBAAa,yBAA0B,YAAW,eAAe;IACxD,KAAK,EAAE;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;SACvB,CAAC;KACH,CAAM;IAEA,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIvD,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;CAGhE"}

package/dist/trees/sparse/InMemoryMerkleTreeStorage.js

@@ -0,0 +1,13 @@
+export class InMemoryMerkleTreeStorage {
+    constructor() {
+        this.nodes = {};
+    }
+    getNode(key, level) {
+        return this.nodes[level]?.[key.toString()];
+    }
+    setNode(key, level, value) {
+        var _a;
+        ((_a = this.nodes)[level] ?? (_a[level] = {}))[key.toString()] = value;
+    }
+}
+//# sourceMappingURL=InMemoryMerkleTreeStorage.js.map

package/dist/trees/sparse/InMemoryMerkleTreeStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InMemoryMerkleTreeStorage.js","sourceRoot":"","sources":["../../../src/trees/sparse/InMemoryMerkleTreeStorage.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,yBAAyB;IAAtC;QACS,UAAK,GAIR,EAAE,CAAC;IAST,CAAC;IAPQ,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,KAAa;;QACtD,OAAC,IAAI,CAAC,KAAK,EAAC,KAAK,SAAL,KAAK,IAAM,EAAE,EAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,KAAK,CAAC;IACrD,CAAC;CACF"}

package/dist/trees/sparse/MerkleTreeStore.d.ts

@@ -0,0 +1,5 @@
+export interface MerkleTreeStore {
+    setNode: (key: bigint, level: number, value: bigint) => void;
+    getNode: (key: bigint, level: number) => bigint | undefined;
+}
+//# sourceMappingURL=MerkleTreeStore.d.ts.map

package/dist/trees/sparse/MerkleTreeStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MerkleTreeStore.d.ts","sourceRoot":"","sources":["../../../src/trees/sparse/MerkleTreeStore.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAE7D,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;CAC7D"}

package/dist/trees/sparse/MerkleTreeStore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MerkleTreeStore.js.map

package/dist/trees/sparse/MerkleTreeStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MerkleTreeStore.js","sourceRoot":"","sources":["../../../src/trees/sparse/MerkleTreeStore.ts"],"names":[],"mappings":""}

package/dist/trees/sparse/MockAsyncMerkleStore.d.ts

@@ -0,0 +1,9 @@
+import { InMemoryMerkleTreeStorage } from "./InMemoryMerkleTreeStorage";
+export declare class MockAsyncMerkleTreeStore {
+    readonly store: InMemoryMerkleTreeStorage;
+    commit(): void;
+    openTransaction(): void;
+    getNodeAsync(key: bigint, level: number): Promise<bigint | undefined>;
+    setNodeAsync(key: bigint, level: number, value: bigint): Promise<void>;
+}
+//# sourceMappingURL=MockAsyncMerkleStore.d.ts.map

package/dist/trees/sparse/MockAsyncMerkleStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockAsyncMerkleStore.d.ts","sourceRoot":"","sources":["../../../src/trees/sparse/MockAsyncMerkleStore.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,qBAAa,wBAAwB;IACnC,SAAgB,KAAK,4BAAmC;IAEjD,MAAM,IAAI,IAAI;IAId,eAAe,IAAI,IAAI;IAIjB,YAAY,CACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIjB,YAAY,CACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;CAGjB"}

package/dist/trees/sparse/MockAsyncMerkleStore.js

@@ -0,0 +1,20 @@
+import { noop } from "../../utils";
+import { InMemoryMerkleTreeStorage } from "./InMemoryMerkleTreeStorage";
+export class MockAsyncMerkleTreeStore {
+    constructor() {
+        this.store = new InMemoryMerkleTreeStorage();
+    }
+    commit() {
+        noop();
+    }
+    openTransaction() {
+        noop();
+    }
+    async getNodeAsync(key, level) {
+        return this.store.getNode(key, level);
+    }
+    async setNodeAsync(key, level, value) {
+        this.store.setNode(key, level, value);
+    }
+}
+//# sourceMappingURL=MockAsyncMerkleStore.js.map

package/dist/trees/sparse/MockAsyncMerkleStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockAsyncMerkleStore.js","sourceRoot":"","sources":["../../../src/trees/sparse/MockAsyncMerkleStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,MAAM,OAAO,wBAAwB;IAArC;QACkB,UAAK,GAAG,IAAI,yBAAyB,EAAE,CAAC;IAwB1D,CAAC;IAtBQ,MAAM;QACX,IAAI,EAAE,CAAC;IACT,CAAC;IAEM,eAAe;QACpB,IAAI,EAAE,CAAC;IACT,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,GAAW,EACX,KAAa;QAEb,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,GAAW,EACX,KAAa,EACb,KAAa;QAEb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;CACF"}

package/dist/trees/sparse/RollupMerkleTree.d.ts

@@ -0,0 +1,158 @@
+import { Bool, Field } from "o1js";
+import { TypedClass } from "../../types";
+import { MerkleTreeStore } from "./MerkleTreeStore";
+/**
+ * More efficient version of `maybeSwapBad` which
+ * reuses an intermediate variable
+ */
+export declare function maybeSwap(b: Bool, x: Field, y: Field): [Field, Field];
+declare const StructTemplate_base: (new (value: {
+    path: import("o1js/dist/node/lib/provable/field").Field[];
+    isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+}) => {
+    path: import("o1js/dist/node/lib/provable/field").Field[];
+    isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+}) & {
+    _isStruct: true;
+} & Omit<import("o1js/dist/node/lib/provable/types/provable-intf").Provable<{
+    path: import("o1js/dist/node/lib/provable/field").Field[];
+    isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+}, {
+    path: bigint[];
+    isLeft: boolean[];
+}>, "fromFields"> & {
+    fromFields: (fields: import("o1js/dist/node/lib/provable/field").Field[]) => {
+        path: import("o1js/dist/node/lib/provable/field").Field[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+} & {
+    fromValue: (value: {
+        path: import("o1js/dist/node/lib/provable/field").Field[] | bigint[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[] | boolean[];
+    }) => {
+        path: import("o1js/dist/node/lib/provable/field").Field[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+    toInput: (x: {
+        path: import("o1js/dist/node/lib/provable/field").Field[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        path: import("o1js/dist/node/lib/provable/field").Field[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+    }) => {
+        path: string[];
+        isLeft: boolean[];
+    };
+    fromJSON: (x: {
+        path: string[];
+        isLeft: boolean[];
+    }) => {
+        path: import("o1js/dist/node/lib/provable/field").Field[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+    empty: () => {
+        path: import("o1js/dist/node/lib/provable/field").Field[];
+        isLeft: import("o1js/dist/node/lib/provable/bool").Bool[];
+    };
+};
+export declare class StructTemplate extends StructTemplate_base {
+}
+export interface AbstractMerkleWitness extends StructTemplate {
+    height(): number;
+    /**
+     * Calculates a root depending on the leaf value.
+     * @param hash Value of the leaf node that belongs to this Witness.
+     * @returns The calculated root.
+     */
+    calculateRoot(hash: Field): Field;
+    calculateRootIncrement(index: Field, leaf: Field): [Field, AbstractMerkleWitness];
+    /**
+     * Calculates the index of the leaf node that belongs to this Witness.
+     * @returns Index of the leaf.
+     */
+    calculateIndex(): Field;
+    checkMembership(root: Field, key: Field, value: Field): Bool;
+    checkMembershipSimple(root: Field, value: Field): Bool;
+    checkMembershipGetRoots(root: Field, key: Field, value: Field): [Bool, Field, Field];
+    toShortenedEntries(): string[];
+}
+export interface AbstractMerkleTree {
+    store: MerkleTreeStore;
+    readonly leafCount: bigint;
+    assertIndexRange(index: bigint): void;
+    /**
+     * 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: number, index: bigint): Field;
+    /**
+     * Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree).
+     * @returns The root of the Merkle Tree.
+     */
+    getRoot(): Field;
+    /**
+     * 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: bigint, leaf: Field): void;
+    setLeaves(updates: {
+        index: bigint;
+        leaf: Field;
+    }[]): void;
+    /**
+     * 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: bigint): AbstractMerkleWitness;
+    /**
+     * Fills all leaves of the tree.
+     * @param leaves Values to fill the leaves with.
+     */
+    fill(leaves: Field[]): void;
+}
+export interface AbstractMerkleTreeClass {
+    new (store: MerkleTreeStore): AbstractMerkleTree;
+    WITNESS: TypedClass<AbstractMerkleWitness> & typeof StructTemplate & {
+        dummy: () => AbstractMerkleWitness;
+    };
+    HEIGHT: number;
+    EMPTY_ROOT: bigint;
+    get leafCount(): bigint;
+}
+/**
+ * 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).
+ *
+ * This function takes a height as argument and returns a class
+ * that implements a merkletree with that specified height.
+ *
+ * It also holds the Witness class under tree.WITNESS
+ */
+export declare function createMerkleTree(height: number): AbstractMerkleTreeClass;
+declare const RollupMerkleTree_base: AbstractMerkleTreeClass;
+export declare class RollupMerkleTree extends RollupMerkleTree_base {
+}
+export declare class RollupMerkleTreeWitness extends RollupMerkleTree.WITNESS {
+}
+export {};
+//# sourceMappingURL=RollupMerkleTree.d.ts.map

package/dist/trees/sparse/RollupMerkleTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RollupMerkleTree.d.ts","sourceRoot":"","sources":["../../../src/trees/sparse/RollupMerkleTree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAA8B,MAAM,MAAM,CAAC;AAI/D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAKrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,qBAAa,cAAe,SAAQ,mBAGlC;CAAG;AAEL,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,MAAM,IAAI,MAAM,CAAC;IAEjB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,CAAC;IAElC,sBAAsB,CACpB,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,KAAK,GACV,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAElC;;;OAGG;IACH,cAAc,IAAI,KAAK,CAAC;IAExB,eAAe,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE7D,qBAAqB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAEvD,uBAAuB,CACrB,IAAI,EAAE,KAAK,EACX,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,KAAK,GACX,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAExB,kBAAkB,IAAI,MAAM,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC;IAE7C;;;OAGG;IACH,OAAO,IAAI,KAAK,CAAC;IAEjB;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IAE1C,SAAS,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,KAAK,CAAA;KAAE,EAAE,GAAG,IAAI,CAAC;IAE3D;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,qBAAqB,CAAC;IAEjD;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,KAAK,EAAE,eAAe,GAAG,kBAAkB,CAAC;IAEjD,OAAO,EAAE,UAAU,CAAC,qBAAqB,CAAC,GACxC,OAAO,cAAc,GAAG;QAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;KAAE,CAAC;IAEjE,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,SAAS,IAAI,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,uBAAuB,CAoXxE;;AAED,qBAAa,gBAAiB,SAAQ,qBAAqB;CAAG;AAC9D,qBAAa,uBAAwB,SAAQ,gBAAgB,CAAC,OAAO;CAAG"}

package/dist/trees/sparse/RollupMerkleTree.js

@@ -0,0 +1,330 @@
+import { Bool, Field, Poseidon, Provable, Struct } from "o1js";
+import uniqBy from "lodash/uniqBy";
+import { range } from "../../utils";
+import { InMemoryMerkleTreeStorage } from "./InMemoryMerkleTreeStorage";
+/**
+ * More efficient version of `maybeSwapBad` which
+ * reuses an intermediate variable
+ */
+export 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];
+}
+export class StructTemplate extends Struct({
+    path: Provable.Array(Field, 0),
+    isLeft: Provable.Array(Bool, 0),
+}) {
+}
+/**
+ * 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).
+ *
+ * This function takes a height as argument and returns a class
+ * that implements a merkletree with that specified height.
+ *
+ * It also holds the Witness class under tree.WITNESS
+ */
+export function createMerkleTree(height) {
+    var _a;
+    function generateZeroes() {
+        const zeroes = [0n];
+        for (let index = 1; index < height; index += 1) {
+            const previousLevel = Field(zeroes[index - 1]);
+            zeroes.push(Poseidon.hash([previousLevel, previousLevel]).toBigInt());
+        }
+        return zeroes;
+    }
+    let zeroCache = undefined;
+    function getZeroes() {
+        if (zeroCache === undefined) {
+            zeroCache = generateZeroes();
+        }
+        return zeroCache;
+    }
+    /**
+     * The {@link RollupMerkleWitness} class defines a circuit-compatible base class
+     * for [Merkle Witness'](https://computersciencewiki.org/index.php/Merkle_proof).
+     */
+    class RollupMerkleWitness extends Struct({
+        path: Provable.Array(Field, height - 1),
+        isLeft: Provable.Array(Bool, height - 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(leaf) {
+            let hash = leaf;
+            const n = this.height();
+            for (let index = 1; index < n; ++index) {
+                const isLeft = this.isLeft[index - 1];
+                const [left, right] = maybeSwap(isLeft, hash, this.path[index - 1]);
+                hash = Poseidon.hash([left, right]);
+            }
+            return hash;
+        }
+        calculateRootIncrement(leafIndex, leaf) {
+            const root = this.calculateRoot(leaf);
+            const newWitness = Provable.witness(RollupMerkleWitness, () => {
+                const zero = getZeroes();
+                if (zero.length === 0) {
+                    throw new Error("Zeroes not initialized");
+                }
+                const zeroes = zero.map((x) => Field(x));
+                let hash = leaf;
+                const n = this.height();
+                let notDiverged = true;
+                const newPath = leafIndex.add(1).toBits();
+                newPath.push(Bool(false));
+                const newSiblings = [];
+                const newIsLefts = [];
+                for (let index = 0; index < n - 1; ++index) {
+                    const isLeft = this.isLeft[index];
+                    const sibling = this.path[index];
+                    const newIsLeft = newPath[index].not();
+                    // Bool(true) default for root level
+                    let convergesNextLevel = true;
+                    if (index < n - 2) {
+                        convergesNextLevel = newPath[index + 1]
+                            .equals(this.isLeft[index + 1])
+                            .not()
+                            .toBoolean();
+                    }
+                    const nextSibling = 
+                    // eslint-disable-next-line no-nested-ternary
+                    convergesNextLevel && notDiverged
+                        ? hash
+                        : notDiverged
+                            ? zeroes[index]
+                            : sibling;
+                    notDiverged = notDiverged && !convergesNextLevel;
+                    newSiblings.push(nextSibling);
+                    newIsLefts.push(newIsLeft);
+                    const [left, right] = maybeSwap(isLeft, hash, sibling);
+                    hash = Poseidon.hash([left, right]);
+                }
+                return new RollupMerkleWitness({
+                    isLeft: newIsLefts,
+                    path: newSiblings,
+                });
+            });
+            newWitness.calculateIndex().assertEquals(leafIndex.add(1));
+            return [root, newWitness];
+        }
+        /**
+         * 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();
+            for (let i = 1; i < n; ++i) {
+                index = Provable.if(this.isLeft[i - 1], index, index.add(powerOfTwo));
+                powerOfTwo = powerOfTwo.mul(2);
+            }
+            return index;
+        }
+        checkMembership(root, key, value) {
+            const calculatedRoot = this.calculateRoot(value);
+            const calculatedKey = this.calculateIndex();
+            // We don't have to range-check the key, because if it would be greater
+            // than leafCount, it would not match the computedKey
+            key.assertEquals(calculatedKey, "Keys of MerkleWitness does not match");
+            return root.equals(calculatedRoot);
+        }
+        checkMembershipSimple(root, value) {
+            const calculatedRoot = this.calculateRoot(value);
+            return root.equals(calculatedRoot);
+        }
+        checkMembershipGetRoots(root, key, value) {
+            const calculatedRoot = this.calculateRoot(value);
+            const calculatedKey = this.calculateIndex();
+            key.assertEquals(calculatedKey, "Keys of MerkleWitness does not match");
+            return [root.equals(calculatedRoot), root, calculatedRoot];
+        }
+        toShortenedEntries() {
+            return range(0, 5)
+                .concat(range(this.height() - 4, this.height()))
+                .map((index) => [
+                this.path[index].toString(),
+                this.isLeft[index].toString(),
+            ].toString());
+        }
+        static dummy() {
+            return new RollupMerkleWitness({
+                isLeft: Array(this.height - 1).fill(Bool(true)),
+                path: Array(this.height - 1).fill(Field(0)),
+            });
+        }
+    }
+    RollupMerkleWitness.height = height;
+    return _a = class AbstractRollupMerkleTree {
+            static get leafCount() {
+                return 2n ** BigInt(AbstractRollupMerkleTree.HEIGHT - 1);
+            }
+            constructor(store) {
+                this.store = store;
+                this.zeroes = generateZeroes();
+            }
+            assertIndexRange(index) {
+                if (index > this.leafCount) {
+                    throw new Error("Index greater than maximum leaf number");
+                }
+            }
+            /**
+             * 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) {
+                this.assertIndexRange(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(AbstractRollupMerkleTree.HEIGHT - 1, 0n).toConstant();
+            }
+            // private in interface
+            setNode(level, index, value) {
+                this.store.setNode(index, level, value.toBigInt());
+            }
+            /**
+             * 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) {
+                this.assertIndexRange(index);
+                this.setNode(0, index, leaf);
+                let currentIndex = index;
+                for (let level = 1; level < AbstractRollupMerkleTree.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]));
+                }
+            }
+            setLeaves(updates) {
+                updates.forEach(({ index }) => this.assertIndexRange(index));
+                const changes = [];
+                // We have to reverse here, because uniqBy only takes the first occurrence of every entry,
+                // but we need the last one (since that semantically overwrites the previous one,
+                // so we can ignore it)
+                let levelChanges = uniqBy(updates.reverse(), "index")
+                    // we can assume no index is in this list twice, so we don't care about the 0 case
+                    // This is in reverse order, so its a queue
+                    .sort((a, b) => (a.index < b.index ? 1 : -1));
+                changes.push(...levelChanges
+                    .map(({ leaf, index }) => ({
+                    level: 0,
+                    index,
+                    value: leaf,
+                }))
+                    .reverse());
+                for (let level = 1; level < AbstractRollupMerkleTree.HEIGHT; level += 1) {
+                    const nextLevelChanges = [];
+                    while (levelChanges.length > 0) {
+                        const node = levelChanges.pop();
+                        let newNode;
+                        if (node.index % 2n === 0n) {
+                            let sibling;
+                            const potentialSibling = levelChanges.at(-1);
+                            if (potentialSibling !== undefined &&
+                                potentialSibling.index === node.index + 1n) {
+                                sibling = potentialSibling.leaf;
+                                levelChanges.pop();
+                            }
+                            else {
+                                sibling = Field(this.getNode(level - 1, node.index + 1n));
+                            }
+                            newNode = Poseidon.hash([node.leaf, sibling]);
+                        }
+                        else {
+                            const sibling = Field(this.getNode(level - 1, node.index - 1n));
+                            newNode = Poseidon.hash([sibling, node.leaf]);
+                        }
+                        const nextLevelIndex = node.index / 2n;
+                        changes.push({ level, index: nextLevelIndex, value: newNode });
+                        nextLevelChanges.push({ index: nextLevelIndex, leaf: newNode });
+                    }
+                    levelChanges = nextLevelChanges.reverse();
+                }
+                changes.forEach(({ level, index, value }) => {
+                    this.setNode(level, index, value);
+                });
+            }
+            /**
+             * 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) {
+                this.assertIndexRange(index);
+                const path = [];
+                const isLefts = [];
+                let currentIndex = index;
+                for (let level = 0; level < AbstractRollupMerkleTree.HEIGHT - 1; level += 1) {
+                    const isLeft = currentIndex % 2n === 0n;
+                    const sibling = this.getNode(level, isLeft ? currentIndex + 1n : currentIndex - 1n);
+                    isLefts.push(Bool(isLeft));
+                    path.push(sibling);
+                    currentIndex /= 2n;
+                }
+                return new RollupMerkleWitness({
+                    isLeft: isLefts,
+                    path,
+                });
+            }
+            // 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 AbstractRollupMerkleTree.leafCount;
+            }
+        },
+        _a.HEIGHT = height,
+        _a.EMPTY_ROOT = new _a(new InMemoryMerkleTreeStorage())
+            .getRoot()
+            .toBigInt(),
+        _a.WITNESS = RollupMerkleWitness,
+        _a;
+}
+export class RollupMerkleTree extends createMerkleTree(256) {
+}
+export class RollupMerkleTreeWitness extends RollupMerkleTree.WITNESS {
+}
+//# sourceMappingURL=RollupMerkleTree.js.map