@0xbow/privacy-pools-core-sdk 0.0.0-c084059

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./types/index.js";
+export * from "./crypto.js";
+export * from "./external.js";
+export { PrivacyPoolSDK } from "./core/sdk.js";
+export * from "./types/commitment.js";
+export * from "./types/withdrawal.js";
+export * from "./errors/base.error.js";
+export * from "./interfaces/circuits.interface.js";
+export { CommitmentService } from "./core/commitment.service.js";
+export { WithdrawalService } from "./core/withdrawal.service.js";

package/dist/types/index.js

@@ -0,0 +1,20 @@
+export { o as BlockchainProvider, u as CircuitName, p as Circuits, C as CommitmentService, t as ContractError, q as ContractInteractionsService, E as ErrorCode, I as InvalidRpcUrl, P as PrivacyPoolSDK, r as ProofError, S as SDKError, W as WithdrawalService, l as bigintToHash, m as bigintToHex, n as calculateContext, k as generateMerkleProof, f as generateSecrets, j as getCommitment, h as hashPrecommitment } from './index-D-_1h8-n.js';
+import 'buffer';
+import 'http';
+import 'https';
+import 'zlib';
+import 'crypto';
+import 'node:crypto';
+import 'events';
+import 'net';
+import 'tls';
+import 'stream';
+import 'url';
+import 'assert';
+import 'os';
+import 'vm';
+import 'worker_threads';
+import 'fs';
+import 'constants';
+import 'readline';
+import 'path';

package/dist/types/interfaces/blockchainProvider.interface.d.ts

@@ -0,0 +1,12 @@
+import { Address } from "../internal.js";
+/**
+ * Represents an interface for a blockchain provider.
+ */
+export interface IBlockchainProvider {
+    /**
+     * Retrieves the balance of the specified address.
+     * @param {Address} address The address for which to retrieve the balance.
+     * @returns {Promise<bigint>} A Promise that resolves to the balance of the address.
+     */
+    getBalance(address: Address): Promise<bigint>;
+}

package/dist/types/interfaces/circuits.interface.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Available circuit types in the system.
+ */
+export declare enum CircuitName {
+    Commitment = "commitment",
+    Withdraw = "withdraw"
+}
+/**
+ * Type for circuit input signals.
+ */
+export type CircuitSignals = {
+    [key: string]: bigint | bigint[] | string;
+};
+/**
+ * Interface for accessing circuit-related resources.
+ */
+export interface CircuitsInterface {
+    /**
+     * Gets the WASM binary for a circuit.
+     */
+    getWasm(name: CircuitName): Promise<Uint8Array>;
+    /**
+     * Gets the proving key for a circuit.
+     */
+    getProvingKey(name: CircuitName): Promise<Uint8Array>;
+    /**
+     * Gets the verification key for a circuit.
+     */
+    getVerificationKey(name: CircuitName): Promise<Uint8Array>;
+}

package/dist/types/interfaces/contracts.interface.d.ts

@@ -0,0 +1,28 @@
+import { Address } from "viem";
+import { Withdrawal, WithdrawalProof } from "../types/withdrawal.js";
+import { CommitmentProof, Hash } from "../types/commitment.js";
+export interface SolidityGroth16Proof {
+    pA: [bigint, bigint];
+    pB: [[bigint, bigint], [bigint, bigint]];
+    pC: [bigint, bigint];
+    pubSignals: bigint[];
+}
+export interface TransactionResponse {
+    hash: string;
+    wait: () => Promise<void>;
+}
+export interface ContractInteractions {
+    depositERC20(asset: Address, amount: bigint, precommitment: bigint): Promise<TransactionResponse>;
+    depositETH(amount: bigint, precommitment: bigint): Promise<TransactionResponse>;
+    withdraw(withdrawal: Withdrawal, withdrawalProof: WithdrawalProof, scope: Hash): Promise<TransactionResponse>;
+    relay(withdrawal: Withdrawal, withdrawalProof: WithdrawalProof, scope: Hash): Promise<TransactionResponse>;
+    ragequit(commitmentProof: CommitmentProof, privacyPoolAddress: Address): Promise<TransactionResponse>;
+    getScope(privacyPoolAddress: Address): Promise<bigint>;
+    getStateRoot(privacyPoolAddress: Address): Promise<bigint>;
+    getStateSize(privacyPoolAddress: Address): Promise<bigint>;
+    getScopeData(scope: bigint): Promise<{
+        poolAddress: Address | null;
+        assetAddress: Address | null;
+    }>;
+    approveERC20(spenderAddress: Address, tokenAddress: Address, amount: bigint): Promise<TransactionResponse>;
+}

package/dist/types/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./blockchainProvider.interface.js";

package/dist/types/internal.d.ts

@@ -0,0 +1,6 @@
+export type { Address } from "viem";
+export * from "./exceptions/index.js";
+export * from "./interfaces/index.js";
+export * from "./providers/index.js";
+export * from "./circuits/index.js";
+export * from "./constants.js";

package/dist/types/providers/blockchainProvider.d.ts

@@ -0,0 +1,8 @@
+import type { Address } from "viem";
+import { IBlockchainProvider } from "../internal.js";
+export declare class BlockchainProvider implements IBlockchainProvider {
+    private client;
+    constructor(rpcUrl: string);
+    /** @inheritdoc */
+    getBalance(address: Address): Promise<bigint>;
+}

package/dist/types/providers/index.d.ts

@@ -0,0 +1 @@
+export * from "./blockchainProvider.js";

package/dist/types/types/commitment.d.ts

@@ -0,0 +1,48 @@
+import { Groth16Proof, PublicSignals } from "snarkjs";
+/**
+ * Represents a hash value in the system.
+ * This is a branded type to ensure type safety.
+ */
+export type Hash = bigint & {
+    readonly __brand: unique symbol;
+};
+/**
+ * Represents a secret value in the system.
+ * This is a branded type to ensure type safety.
+ */
+export type Secret = bigint & {
+    readonly __brand: unique symbol;
+};
+/**
+ * Represents a precommitment structure containing the hash, nullifier, and secret.
+ * All hashes are computed using Poseidon.
+ */
+export interface Precommitment {
+    readonly hash: Hash;
+    readonly nullifier: Secret;
+    readonly secret: Secret;
+}
+/**
+ * Represents the preimage of a commitment containing the value, label, and precommitment.
+ */
+export interface CommitmentPreimage {
+    readonly value: bigint;
+    readonly label: bigint;
+    readonly precommitment: Precommitment;
+}
+/**
+ * Represents a complete commitment structure.
+ * All hashes are computed using Poseidon.
+ */
+export interface Commitment {
+    readonly hash: Hash;
+    readonly nullifierHash: Hash;
+    readonly preimage: CommitmentPreimage;
+}
+/**
+ * Represents the result of a commitment proof operation.
+ */
+export interface CommitmentProof {
+    readonly proof: Groth16Proof;
+    readonly publicSignals: PublicSignals;
+}

package/dist/types/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./commitment.js";
+export * from "./withdrawal.js";

package/dist/types/types/withdrawal.d.ts

@@ -0,0 +1,30 @@
+import { Address, Hex } from "viem";
+import { Groth16Proof, PublicSignals } from "snarkjs";
+import { LeanIMTMerkleProof } from "@zk-kit/lean-imt";
+import { Hash, Secret } from "./commitment.js";
+/**
+ * Represents a withdrawal request in the system.
+ */
+export interface Withdrawal {
+    readonly processooor: Address;
+    readonly data: Hex;
+}
+export interface WithdrawalProof {
+    readonly proof: Groth16Proof;
+    readonly publicSignals: PublicSignals;
+}
+/**
+ * Input parameters required for withdrawal proof generation.
+ */
+export interface WithdrawalProofInput {
+    readonly context: bigint;
+    readonly withdrawalAmount: bigint;
+    readonly stateMerkleProof: LeanIMTMerkleProof<bigint>;
+    readonly aspMerkleProof: LeanIMTMerkleProof<bigint>;
+    readonly stateRoot: Hash;
+    readonly stateTreeDepth: bigint;
+    readonly aspRoot: Hash;
+    readonly aspTreeDepth: bigint;
+    readonly newSecret: Secret;
+    readonly newNullifier: Secret;
+}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@0xbow/privacy-pools-core-sdk",
+  "version": "0.0.0-c084059",
+  "description": "Typescript SDK for the Privacy Pool protocol",
+  "repository": "https://github.com/0xbow-io/privacy-pools-core",
+  "license": "Apache-2.0",
+  "author": "Wonderland",
+  "type": "module",
+  "main": "./dist/node/index.mjs",
+  "module": "./dist/esm/index.mjs",
+  "browser": "./dist/esm/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    "node": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/node/index.mjs"
+    },
+    "import": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/esm/index.mjs"
+    },
+    "browser": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/esm/index.mjs"
+    }
+  },
+  "directories": {
+    "src": "src"
+  },
+  "files": [
+    "dist/*",
+    "src",
+    "package.json",
+    "!**/*.tsbuildinfo"
+  ],
+  "scripts": {
+    "circuits:setup": "cd ../circuits/ && yarn install && yarn compile && yarn setup:all",
+    "circuits:copy": "sh ./scripts/copy_circuits.sh",
+    "build": "yarn clean && rollup -c ./configs/rollup.config.mjs",
+    "build:bundle": "yarn clean && rollup -c ./configs/rollup.config.mjs && yarn circuits:copy",
+    "check-types": "tsc --noEmit -p ./tsconfig.json",
+    "clean": "rm -rf dist .rollup.cache tsconfig.build.tsbuildinfo",
+    "format": "prettier --check \"{src,test}/**/*.{js,ts,json}\"",
+    "format:fix": "prettier --write \"{src,test}/**/*.{js,ts,json}\"",
+    "lint": "eslint \"{src,test}/**/*.{js,ts,json}\"",
+    "lint:fix": "eslint \"{src,test}/**/*.{js,ts,json}\" --fix",
+    "test": "vitest run --config vitest.config.ts --passWithNoTests",
+    "test:cov": "vitest run --config vitest.config.ts --coverage"
+  },
+  "dependencies": {
+    "@types/snarkjs": "0.7.9",
+    "@zk-kit/lean-imt": "2.2.4",
+    "maci-crypto": "2.5.0",
+    "snarkjs": "0.7.5",
+    "typescript": "^5.7.3",
+    "viem": "2.22.14"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "19.4.1",
+    "@eslint/js": "9.18.0",
+    "@ianvs/prettier-plugin-sort-imports": "4.3.1",
+    "@rollup/plugin-alias": "5.1.1",
+    "@rollup/plugin-commonjs": "28.0.2",
+    "@rollup/plugin-inject": "5.0.5",
+    "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-node-resolve": "16.0.0",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@rollup/plugin-wasm": "6.2.2",
+    "@types/node": "20.3.1",
+    "@types/snarkjs": "0.7.9",
+    "commitlint": "19.4.1",
+    "globals": "15.14.0",
+    "husky": "9.1.5",
+    "lint-staged": "15.2.10",
+    "memfs": "4.17.0",
+    "rollup": "4.30.1",
+    "rollup-plugin-dts": "6.1.1",
+    "snarkjs": "0.7.5",
+    "sort-package-json": "2.10.1"
+  }
+}

package/src/abi/ERC20.ts

@@ -0,0 +1,222 @@
+export const ERC20ABI = [
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_spender",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "approve",
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_from",
+        "type": "address"
+      },
+      {
+        "name": "_to",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "transferFrom",
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [
+      {
+        "name": "_owner",
+        "type": "address"
+      }
+    ],
+    "name": "balanceOf",
+    "outputs": [
+      {
+        "name": "balance",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [
+      {
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      {
+        "name": "_to",
+        "type": "address"
+      },
+      {
+        "name": "_value",
+        "type": "uint256"
+      }
+    ],
+    "name": "transfer",
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [
+      {
+        "name": "_owner",
+        "type": "address"
+      },
+      {
+        "name": "_spender",
+        "type": "address"
+      }
+    ],
+    "name": "allowance",
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "payable": true,
+    "stateMutability": "payable",
+    "type": "fallback"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  }
+];