@aztec/merkle-tree 0.1.0-alpha23 → 0.1.0-alpha40

package/dest/sibling_path/sibling_path.js

@@ -1,120 +0,0 @@
-import { assertLength, deserializeArrayFromVector, serializeBufferArrayToVector, } from '@aztec/foundation/serialize';
-import { Fr } from '@aztec/foundation/fields';
-/**
- * Contains functionality to compute and serialize/deserialize a sibling path.
- * E.g. Sibling path for a leaf at index 3 in a tree of depth 3 consists of:
- *      d0:                                            [ root ]
- *      d1:                      [ ]                                               [*]
- *      d2:         [*]                      [ ]                       [ ]                     [ ]
- *      d3:   [ ]         [ ]          [*]         [ ]           [ ]         [ ]          [ ]        [ ].
- *
- *      And the elements would be ordered as: [ leaf_at_index_2, node_at_level_2_index_0, node_at_level_1_index_1 ].
- */
-export class SiblingPath {
-    /**
-     * Returns sibling path hashed up from the a element.
-     * @param size - The number of elements in a given path.
-     * @param zeroElement - Value of the zero element.
-     * @param pedersen - Implementation of a hasher interface using the Pedersen hash.
-     * @returns A sibling path hashed up from a zero element.
-     */
-    static ZERO(size, zeroElement, pedersen) {
-        const bufs = [];
-        let current = zeroElement;
-        for (let i = 0; i < size; ++i) {
-            bufs.push(current);
-            current = pedersen.compress(current, current);
-        }
-        return new SiblingPath(size, bufs);
-    }
-    /**
-     * Constructor.
-     * @param pathSize - The size of the sibling path.
-     * @param path - The sibling path data.
-     */
-    constructor(
-    /**
-     * Size of the sibling path (number of fields it contains).
-     */
-    pathSize, 
-    /**
-     * The sibling path data.
-     */
-    path) {
-        this.pathSize = pathSize;
-        this.data = assertLength(path, pathSize);
-    }
-    /**
-     * Serializes this SiblingPath object to a buffer.
-     * @returns The buffer representation of this object.
-     */
-    toBuffer() {
-        return serializeBufferArrayToVector(this.data);
-    }
-    /**
-     * Returns the path buffer underlying the sibling path.
-     * @returns The Buffer array representation of this object.
-     */
-    toBufferArray() {
-        return this.data;
-    }
-    /**
-     * Convert the Sibling Path object into an array of field elements.
-     * @returns The field array representation of this object.
-     */
-    toFieldArray() {
-        return this.data.map(buf => Fr.fromBuffer(buf));
-    }
-    /**
-     * Deserializes a SiblingPath from a buffer.
-     * @param buf - A buffer containing the buffer representation of SiblingPath.
-     * @param offset - An offset to start deserializing from.
-     * @returns A SiblingPath object.
-     */
-    static fromBuffer(buf, offset = 0) {
-        const { elem } = SiblingPath.deserialize(buf, offset);
-        return elem;
-    }
-    /**
-     * Deserializes a SiblingPath object from a slice of a part of a buffer and returns the amount of bytes advanced.
-     * @param buf - A buffer representation of the sibling path.
-     * @param offset - An offset to start deserializing from.
-     * @returns The deserialized sibling path and the number of bytes advanced.
-     */
-    static deserialize(buf, offset = 0) {
-        const deserializePath = (buf, offset) => ({
-            elem: buf.slice(offset, offset + 32),
-            adv: 32,
-        });
-        const { elem, adv } = deserializeArrayFromVector(deserializePath, buf, offset);
-        const size = elem.length;
-        return { elem: new SiblingPath(size, elem), adv };
-    }
-    /**
-     * Serializes this SiblingPath object to a hex string representation.
-     * @returns A hex string representation of the sibling path.
-     */
-    toString() {
-        return this.toBuffer().toString('hex');
-    }
-    /**
-     * Deserializes a SiblingPath object from a hex string representation.
-     * @param repr - A hex string representation of the sibling path.
-     * @returns A SiblingPath object.
-     */
-    static fromString(repr) {
-        return SiblingPath.fromBuffer(Buffer.from(repr, 'hex'));
-    }
-    /**
-     * Generate a subtree path from the current sibling path.
-     * @param subtreeHeight - The size of the subtree that we are getting the path for.
-     * @returns A new sibling path that is the for the requested subtree.
-     */
-    getSubtreeSiblingPath(subtreeHeight) {
-        // Drop the size of the subtree from the path, and return the rest.
-        const subtreeData = this.data.slice(subtreeHeight);
-        const subtreePathSize = (this.pathSize - subtreeHeight);
-        return new SiblingPath(subtreePathSize, subtreeData);
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2libGluZ19wYXRoLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NpYmxpbmdfcGF0aC9zaWJsaW5nX3BhdGgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUVMLFlBQVksRUFDWiwwQkFBMEIsRUFDMUIsNEJBQTRCLEdBQzdCLE1BQU0sNkJBQTZCLENBQUM7QUFFckMsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBRTlDOzs7Ozs7Ozs7R0FTRztBQUNILE1BQU0sT0FBTyxXQUFXO0lBR3RCOzs7Ozs7T0FNRztJQUNJLE1BQU0sQ0FBQyxJQUFJLENBQW1CLElBQU8sRUFBRSxXQUFtQixFQUFFLFFBQWtCO1FBQ25GLE1BQU0sSUFBSSxHQUFhLEVBQUUsQ0FBQztRQUMxQixJQUFJLE9BQU8sR0FBRyxXQUFXLENBQUM7UUFDMUIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLElBQUksRUFBRSxFQUFFLENBQUMsRUFBRTtZQUM3QixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1lBQ25CLE9BQU8sR0FBRyxRQUFRLENBQUMsUUFBUSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztTQUMvQztRQUNELE9BQU8sSUFBSSxXQUFXLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQ3JDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0g7SUFDRTs7T0FFRztJQUNJLFFBQVc7SUFDbEI7O09BRUc7SUFDSCxJQUFjO1FBSlAsYUFBUSxHQUFSLFFBQVEsQ0FBRztRQU1sQixJQUFJLENBQUMsSUFBSSxHQUFHLFlBQVksQ0FBQyxJQUFJLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFDM0MsQ0FBQztJQUVEOzs7T0FHRztJQUNJLFFBQVE7UUFDYixPQUFPLDRCQUE0QixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNqRCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0ksYUFBYTtRQUNsQixPQUFPLElBQUksQ0FBQyxJQUFJLENBQUM7SUFDbkIsQ0FBQztJQUVEOzs7T0FHRztJQUNJLFlBQVk7UUFDakIsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsVUFBVSxDQUFtQixHQUFXLEVBQUUsTUFBTSxHQUFHLENBQUM7UUFDekQsTUFBTSxFQUFFLElBQUksRUFBRSxHQUFHLFdBQVcsQ0FBQyxXQUFXLENBQUksR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQ3pELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsTUFBTSxDQUFDLFdBQVcsQ0FBbUIsR0FBVyxFQUFFLE1BQU0sR0FBRyxDQUFDO1FBQzFELE1BQU0sZUFBZSxHQUFHLENBQUMsR0FBVyxFQUFFLE1BQWMsRUFBRSxFQUFFLENBQUMsQ0FBQztZQUN4RCxJQUFJLEVBQUUsR0FBRyxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLEVBQUUsQ0FBQztZQUNwQyxHQUFHLEVBQUUsRUFBRTtTQUNSLENBQUMsQ0FBQztRQUNILE1BQU0sRUFBRSxJQUFJLEVBQUUsR0FBRyxFQUFFLEdBQUcsMEJBQTBCLENBQUMsZUFBZSxFQUFFLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUMvRSxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDO1FBQ3pCLE9BQU8sRUFBRSxJQUFJLEVBQUUsSUFBSSxXQUFXLENBQUksSUFBUyxFQUFFLElBQUksQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFDO0lBQzVELENBQUM7SUFFRDs7O09BR0c7SUFDSSxRQUFRO1FBQ2IsT0FBTyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ3pDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksTUFBTSxDQUFDLFVBQVUsQ0FBbUIsSUFBWTtRQUNyRCxPQUFPLFdBQVcsQ0FBQyxVQUFVLENBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUM3RCxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNJLHFCQUFxQixDQUMxQixhQUE0QjtRQUU1QixtRUFBbUU7UUFDbkUsTUFBTSxXQUFXLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDbkQsTUFBTSxlQUFlLEdBQUcsQ0FBQyxJQUFJLENBQUMsUUFBUSxHQUFHLGFBQWEsQ0FBNkIsQ0FBQztRQUNwRixPQUFPLElBQUksV0FBVyxDQUFDLGVBQWUsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUN2RCxDQUFDO0NBQ0YifQ==

package/src/hasher.ts

@@ -1,9 +0,0 @@
-/**
- * Defines hasher interface used by Merkle trees.
- */
-export interface Hasher {
-  compress(lhs: Uint8Array, rhs: Uint8Array): Buffer;
-  compressInputs(inputs: Buffer[]): Buffer;
-  hashToField(data: Uint8Array): Buffer;
-  hashToTree(leaves: Buffer[]): Promise<Buffer[]>;
-}

package/src/sibling_path/sibling_path.ts

@@ -1,139 +0,0 @@
-import {
-  Tuple,
-  assertLength,
-  deserializeArrayFromVector,
-  serializeBufferArrayToVector,
-} from '@aztec/foundation/serialize';
-import { Pedersen } from '../pedersen.js';
-import { Fr } from '@aztec/foundation/fields';
-
-/**
- * Contains functionality to compute and serialize/deserialize a sibling path.
- * E.g. Sibling path for a leaf at index 3 in a tree of depth 3 consists of:
- *      d0:                                            [ root ]
- *      d1:                      [ ]                                               [*]
- *      d2:         [*]                      [ ]                       [ ]                     [ ]
- *      d3:   [ ]         [ ]          [*]         [ ]           [ ]         [ ]          [ ]        [ ].
- *
- *      And the elements would be ordered as: [ leaf_at_index_2, node_at_level_2_index_0, node_at_level_1_index_1 ].
- */
-export class SiblingPath<N extends number> {
-  private data: Tuple<Buffer, N>;
-
-  /**
-   * Returns sibling path hashed up from the a element.
-   * @param size - The number of elements in a given path.
-   * @param zeroElement - Value of the zero element.
-   * @param pedersen - Implementation of a hasher interface using the Pedersen hash.
-   * @returns A sibling path hashed up from a zero element.
-   */
-  public static ZERO<N extends number>(size: N, zeroElement: Buffer, pedersen: Pedersen): SiblingPath<N> {
-    const bufs: Buffer[] = [];
-    let current = zeroElement;
-    for (let i = 0; i < size; ++i) {
-      bufs.push(current);
-      current = pedersen.compress(current, current);
-    }
-    return new SiblingPath(size, bufs);
-  }
-
-  /**
-   * Constructor.
-   * @param pathSize - The size of the sibling path.
-   * @param path - The sibling path data.
-   */
-  constructor(
-    /**
-     * Size of the sibling path (number of fields it contains).
-     */
-    public pathSize: N,
-    /**
-     * The sibling path data.
-     */
-    path: Buffer[],
-  ) {
-    this.data = assertLength(path, pathSize);
-  }
-
-  /**
-   * Serializes this SiblingPath object to a buffer.
-   * @returns The buffer representation of this object.
-   */
-  public toBuffer(): Buffer {
-    return serializeBufferArrayToVector(this.data);
-  }
-
-  /**
-   * Returns the path buffer underlying the sibling path.
-   * @returns The Buffer array representation of this object.
-   */
-  public toBufferArray(): Buffer[] {
-    return this.data;
-  }
-
-  /**
-   * Convert the Sibling Path object into an array of field elements.
-   * @returns The field array representation of this object.
-   */
-  public toFieldArray(): Fr[] {
-    return this.data.map(buf => Fr.fromBuffer(buf));
-  }
-
-  /**
-   * Deserializes a SiblingPath from a buffer.
-   * @param buf - A buffer containing the buffer representation of SiblingPath.
-   * @param offset - An offset to start deserializing from.
-   * @returns A SiblingPath object.
-   */
-  static fromBuffer<N extends number>(buf: Buffer, offset = 0): SiblingPath<N> {
-    const { elem } = SiblingPath.deserialize<N>(buf, offset);
-    return elem;
-  }
-
-  /**
-   * Deserializes a SiblingPath object from a slice of a part of a buffer and returns the amount of bytes advanced.
-   * @param buf - A buffer representation of the sibling path.
-   * @param offset - An offset to start deserializing from.
-   * @returns The deserialized sibling path and the number of bytes advanced.
-   */
-  static deserialize<N extends number>(buf: Buffer, offset = 0) {
-    const deserializePath = (buf: Buffer, offset: number) => ({
-      elem: buf.slice(offset, offset + 32),
-      adv: 32,
-    });
-    const { elem, adv } = deserializeArrayFromVector(deserializePath, buf, offset);
-    const size = elem.length;
-    return { elem: new SiblingPath<N>(size as N, elem), adv };
-  }
-
-  /**
-   * Serializes this SiblingPath object to a hex string representation.
-   * @returns A hex string representation of the sibling path.
-   */
-  public toString(): string {
-    return this.toBuffer().toString('hex');
-  }
-
-  /**
-   * Deserializes a SiblingPath object from a hex string representation.
-   * @param repr - A hex string representation of the sibling path.
-   * @returns A SiblingPath object.
-   */
-  public static fromString<N extends number>(repr: string): SiblingPath<N> {
-    return SiblingPath.fromBuffer<N>(Buffer.from(repr, 'hex'));
-  }
-
-  /**
-   * Generate a subtree path from the current sibling path.
-   * @param subtreeHeight - The size of the subtree that we are getting the path for.
-   * @returns A new sibling path that is the for the requested subtree.
-   */
-  public getSubtreeSiblingPath<SubtreeHeight extends number, SubtreeSiblingPathHeight extends number>(
-    subtreeHeight: SubtreeHeight,
-  ): SiblingPath<SubtreeSiblingPathHeight> {
-    // Drop the size of the subtree from the path, and return the rest.
-    const subtreeData = this.data.slice(subtreeHeight);
-    const subtreePathSize = (this.pathSize - subtreeHeight) as SubtreeSiblingPathHeight;
-    return new SiblingPath(subtreePathSize, subtreeData);
-  }
-}