@0xbow/privacy-pools-core-sdk 0.1.5

package/src/abi/IPrivacyPool.ts

@@ -0,0 +1,386 @@
+export const IPrivacyPoolABI = [
+  {
+    type: "function",
+    name: "ASSET",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "ENTRYPOINT",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "address",
+        internalType: "contract IEntrypoint",
+      },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "MAX_TREE_DEPTH",
+    inputs: [],
+    outputs: [{ name: "", type: "uint32", internalType: "uint32" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "RAGEQUIT_VERIFIER",
+    inputs: [],
+    outputs: [
+      { name: "", type: "address", internalType: "contract IVerifier" },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "ROOT_HISTORY_SIZE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint32", internalType: "uint32" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "SCOPE",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "WITHDRAWAL_VERIFIER",
+    inputs: [],
+    outputs: [
+      { name: "", type: "address", internalType: "contract IVerifier" },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "currentRoot",
+    inputs: [],
+    outputs: [{ name: "_root", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "currentRootIndex",
+    inputs: [],
+    outputs: [{ name: "", type: "uint32", internalType: "uint32" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "currentTreeDepth",
+    inputs: [],
+    outputs: [{ name: "_depth", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "currentTreeSize",
+    inputs: [],
+    outputs: [{ name: "_size", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "dead",
+    inputs: [],
+    outputs: [{ name: "", type: "bool", internalType: "bool" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "deposit",
+    inputs: [
+      { name: "_depositor", type: "address", internalType: "address" },
+      { name: "_value", type: "uint256", internalType: "uint256" },
+      {
+        name: "_precommitmentHash",
+        type: "uint256",
+        internalType: "uint256",
+      },
+    ],
+    outputs: [
+      { name: "_commitment", type: "uint256", internalType: "uint256" },
+    ],
+    stateMutability: "payable",
+  },
+  {
+    type: "function",
+    name: "depositors",
+    inputs: [{ name: "_label", type: "uint256", internalType: "uint256" }],
+    outputs: [
+      { name: "_depositooor", type: "address", internalType: "address" },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "nonce",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "nullifierHashes",
+    inputs: [
+      {
+        name: "_nullifierHash",
+        type: "uint256",
+        internalType: "uint256",
+      },
+    ],
+    outputs: [{ name: "_spent", type: "bool", internalType: "bool" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "ragequit",
+    inputs: [
+      {
+        name: "_proof",
+        type: "tuple",
+        internalType: "struct ProofLib.RagequitProof",
+        components: [
+          {
+            name: "pA",
+            type: "uint256[2]",
+            internalType: "uint256[2]",
+          },
+          {
+            name: "pB",
+            type: "uint256[2][2]",
+            internalType: "uint256[2][2]",
+          },
+          {
+            name: "pC",
+            type: "uint256[2]",
+            internalType: "uint256[2]",
+          },
+          {
+            name: "pubSignals",
+            type: "uint256[5]",
+            internalType: "uint256[5]",
+          },
+        ],
+      },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "roots",
+    inputs: [{ name: "_index", type: "uint256", internalType: "uint256" }],
+    outputs: [{ name: "_root", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "windDown",
+    inputs: [],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "withdraw",
+    inputs: [
+      {
+        name: "_withdrawal",
+        type: "tuple",
+        internalType: "struct IPrivacyPool.Withdrawal",
+        components: [
+          {
+            name: "processooor",
+            type: "address",
+            internalType: "address",
+          },
+          { name: "data", type: "bytes", internalType: "bytes" },
+        ],
+      },
+      {
+        name: "_proof",
+        type: "tuple",
+        internalType: "struct ProofLib.WithdrawProof",
+        components: [
+          {
+            name: "pA",
+            type: "uint256[2]",
+            internalType: "uint256[2]",
+          },
+          {
+            name: "pB",
+            type: "uint256[2][2]",
+            internalType: "uint256[2][2]",
+          },
+          {
+            name: "pC",
+            type: "uint256[2]",
+            internalType: "uint256[2]",
+          },
+          {
+            name: "pubSignals",
+            type: "uint256[8]",
+            internalType: "uint256[8]",
+          },
+        ],
+      },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "event",
+    name: "Deposited",
+    inputs: [
+      {
+        name: "_depositor",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+      {
+        name: "_commitment",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_label",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_value",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_merkleRoot",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "LeafInserted",
+    inputs: [
+      {
+        name: "_index",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_leaf",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_root",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+    ],
+    anonymous: false,
+  },
+  { type: "event", name: "PoolDied", inputs: [], anonymous: false },
+  {
+    type: "event",
+    name: "Ragequit",
+    inputs: [
+      {
+        name: "_ragequitter",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+      {
+        name: "_commitment",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_label",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_value",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "Withdrawn",
+    inputs: [
+      {
+        name: "_processooor",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+      {
+        name: "_value",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_spentNullifier",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+      {
+        name: "_newCommitment",
+        type: "uint256",
+        indexed: false,
+        internalType: "uint256",
+      },
+    ],
+    anonymous: false,
+  },
+  { type: "error", name: "ContextMismatch", inputs: [] },
+  { type: "error", name: "IncorrectASPRoot", inputs: [] },
+  { type: "error", name: "InvalidCommitment", inputs: [] },
+  { type: "error", name: "InvalidProcessooor", inputs: [] },
+  { type: "error", name: "InvalidProof", inputs: [] },
+  { type: "error", name: "InvalidTreeDepth", inputs: [] },
+  { type: "error", name: "LeafAlreadyExists", inputs: [] },
+  { type: "error", name: "LeafCannotBeZero", inputs: [] },
+  {
+    type: "error",
+    name: "LeafGreaterThanSnarkScalarField",
+    inputs: [],
+  },
+  { type: "error", name: "MaxTreeDepthReached", inputs: [] },
+  { type: "error", name: "NotYetRagequitteable", inputs: [] },
+  { type: "error", name: "NullifierAlreadySpent", inputs: [] },
+  { type: "error", name: "OnlyEntrypoint", inputs: [] },
+  { type: "error", name: "OnlyOriginalDepositor", inputs: [] },
+  { type: "error", name: "PoolIsDead", inputs: [] },
+  { type: "error", name: "ScopeMismatch", inputs: [] },
+  { type: "error", name: "UnknownStateRoot", inputs: [] },
+  { type: "error", name: "ZeroAddress", inputs: [] },
+];

package/src/circuits/circuits.impl.ts

@@ -0,0 +1,213 @@
+import { CircuitInitialization, FetchArtifact } from "../internal.js";
+import {
+  Binaries,
+  CircuitArtifacts,
+  CircuitName,
+  CircuitNameString,
+  CircuitsInterface,
+  circuitToAsset,
+  Version,
+  VersionString,
+} from "./circuits.interface.js";
+
+/**
+ * Class representing circuit management and artifact handling.
+ * Implements the CircuitsInterface.
+ */
+export class Circuits implements CircuitsInterface {
+  /**
+   * Indicates whether the circuits have been initialized.
+   * @type {boolean}
+   * @protected
+   */
+  protected initialized: boolean = false;
+  /**
+   * The version of the circuit artifacts being used.
+   * @type {VersionString}
+   * @protected
+   */
+  protected version: VersionString = Version.Latest;
+  /**
+   * The binaries containing circuit artifacts such as wasm, vkey, and zkey files.
+   * @type {Binaries}
+   * @protected
+   */
+  protected binaries!: Binaries;
+  /**
+   * The base URL for fetching circuit artifacts.
+   * @type {string}
+   * @protected
+   */
+  protected baseUrl: string = import.meta.url;
+
+  /**
+   * Determines whether the environment is a browser.
+   * @returns {boolean} True if running in a browser environment, false otherwise.
+   * @protected
+   */
+  _browser(): boolean {
+    return typeof window !== "undefined";
+  }
+
+  /**
+   * Initializes the circuit manager with binaries and a version.
+   * @param {Binaries} binaries - The binaries containing circuit artifacts.
+   * @param {VersionString} version - The version of the circuit artifacts.
+   * @protected
+   */
+  protected _initialize(binaries: Binaries, version: VersionString) {
+    this.binaries = binaries;
+    this.version = version;
+    this.initialized = true;
+  }
+
+  /**
+   * Handles initialization of circuit artifacts, fetching them if necessary.
+   * @param {VersionString} [version=Version.latest] - The version of the circuit artifacts.
+   * @throws {CircuitInitialization} If an error occurs during initialization.
+   * @protected
+   * @async
+   */
+  protected async _handleInitialization(
+    version: VersionString = Version.Latest,
+  ) {
+    if (!this.initialized || this.binaries === undefined) {
+      try {
+        await this.initArtifacts(version);
+      } catch (e) {
+        if (e instanceof FetchArtifact) {
+          throw new CircuitInitialization(`${e.name}: ${e.message}`);
+        } else {
+          console.error(e);
+          throw new CircuitInitialization(`UnknownError: ${e}`);
+        }
+      }
+    }
+  }
+
+  /**
+   * Fetches a versioned artifact from a given path.
+   * @param {string} artifactPath - The path to the artifact.
+   * @param {VersionString} version - The version of the artifact.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the artifact as a Uint8Array.
+   * @throws {FetchArtifact} If the artifact cannot be fetched.
+   * @protected
+   * @async
+   */
+  async _fetchVersionedArtifact(artifactPath: string): Promise<Uint8Array> {
+    const artifactUrl = new URL(artifactPath, this.baseUrl);
+    if (this._browser()) {
+      const res = await fetch(artifactUrl);
+      if (res.status !== 200) {
+        throw new FetchArtifact(artifactUrl);
+      }
+      const aBuf = await res.arrayBuffer();
+      return new Uint8Array(aBuf);
+    } else {
+      try {
+        const fs = (await import("node:fs/promises")).default;
+        const buf = await fs.readFile(artifactUrl);
+        return new Uint8Array(buf);
+      } catch (error) {
+        console.error(error);
+        throw new FetchArtifact(artifactUrl);
+      }
+    }
+  }
+
+  /**
+   * Downloads and returns the circuit artifacts for a specific circuit.
+   * @param {CircuitNameString} circuitName - The name of the circuit.
+   * @returns {Promise<CircuitArtifacts>} A promise that resolves to the circuit artifacts.
+   * @protected
+   * @async
+   */
+  async _downloadCircuitArtifacts(
+    circuitName: CircuitNameString,
+  ): Promise<CircuitArtifacts> {
+    const assetName = circuitToAsset[circuitName];
+
+    const [wasm, vkey, zkey] = await Promise.all([
+      this._fetchVersionedArtifact(["artifacts", assetName.wasm].join("/")),
+      this._fetchVersionedArtifact(["artifacts", assetName.vkey].join("/")),
+      this._fetchVersionedArtifact(["artifacts", assetName.zkey].join("/")),
+    ]);
+    return { wasm, vkey, zkey };
+  }
+
+  /**
+   * Downloads all circuit artifacts for the specified version.
+   * @param {VersionString} version - The version of the artifacts.
+   * @returns {Promise<Binaries>} A promise that resolves to the binaries containing all circuit artifacts.
+   * @async
+   */
+  // prettier-ignore
+  async downloadArtifacts(version: VersionString): Promise<Binaries> { // eslint-disable-line @typescript-eslint/no-unused-vars
+    const [commitment, merkleTree, withdraw] = await Promise.all([
+      this._downloadCircuitArtifacts(CircuitName.Commitment),
+      this._downloadCircuitArtifacts(CircuitName.MerkleTree),
+      this._downloadCircuitArtifacts(CircuitName.Withdraw),
+    ]);
+    return {
+      commitment,
+      merkleTree,
+      withdraw,
+    };
+  }
+
+  /**
+   * Initializes the circuit artifacts for the specified version.
+   * @param {VersionString} version - The version of the artifacts.
+   * @returns {Promise<void>} A promise that resolves when initialization is complete.
+   * @async
+   */
+  async initArtifacts(version: VersionString): Promise<void> {
+    const binaries = await this.downloadArtifacts(version);
+    this._initialize(binaries, version);
+  }
+
+  /**
+   * Retrieves the verification key for a specified circuit.
+   * @param {CircuitNameString} circuitName - The name of the circuit.
+   * @param {VersionString} [version=Version.latest] - The version of the artifacts.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the verification key.
+   * @async
+   */
+  async getVerificationKey(
+    circuitName: CircuitNameString,
+    version: VersionString = Version.Latest,
+  ): Promise<Uint8Array> {
+    await this._handleInitialization(version);
+    return this.binaries[circuitName]?.vkey;
+  }
+
+  /**
+   * Retrieves the proving key for a specified circuit.
+   * @param {CircuitNameString} circuitName - The name of the circuit.
+   * @param {VersionString} [version=Version.latest] - The version of the artifacts.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the proving key.
+   * @async
+   */
+  async getProvingKey(
+    circuitName: CircuitNameString,
+    version: VersionString = Version.Latest,
+  ): Promise<Uint8Array> {
+    await this._handleInitialization(version);
+    return this.binaries[circuitName]?.zkey;
+  }
+
+  /**
+   * Retrieves the wasm file for a specified circuit.
+   * @param {CircuitNameString} circuitName - The name of the circuit.
+   * @param {VersionString} [version=Version.latest] - The version of the artifacts.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the wasm file.
+   * @async
+   */
+  async getWasm(
+    circuitName: CircuitNameString,
+    version: VersionString = Version.Latest,
+  ): Promise<Uint8Array> {
+    await this._handleInitialization(version);
+    return this.binaries[circuitName]?.wasm;
+  }
+}