@kohaku-eth/tornado-cash 0.0.1 → 0.0.2-alpha.8

package/dist/worker-loader.browser.d.ts

@@ -0,0 +1,152 @@
+import * as comlink from 'comlink';
+import { combineReducers } from '@reduxjs/toolkit';
+import * as _kohaku_eth_plugins from '@kohaku-eth/plugins';
+import { SignedAuthorization } from 'viem';
+import * as _kohaku_eth_provider from '@kohaku-eth/provider';
+
+type Address = bigint & {};
+interface IContract {
+    address: Address;
+}
+interface IScrapeableContract extends IContract {
+    deploymentBlock: bigint;
+}
+
+interface InstanceRegistryConfig extends IScrapeableContract {
+    lastDeployedOnBlock?: bigint;
+}
+interface ProtocolConfigState {
+    chainId: bigint;
+    ensSubdomainKey: string;
+    instanceRegistry: InstanceRegistryConfig;
+    relayerRegistry: IScrapeableContract;
+    aggregator: IContract;
+}
+
+type RootState = ReturnType<ReturnType<typeof combineReducers<typeof reducers>>>;
+type PublicRootState = Omit<RootState, 'userSecrets'>;
+
+interface IRelayerStatusResponse {
+    currentQueue: number;
+    netId: number;
+    rewardAccount: string;
+    version: string;
+    tornadoServiceFee: number;
+    ethPrices: Record<string, string>;
+}
+interface ITornadoWithdrawRequest {
+    proof: `0x${string}`;
+    args: [`0x${string}`, `0x${string}`, `0x${string}`, `0x${string}`, `0x${string}`, `0x${string}`];
+    contract: `0x${string}`;
+}
+interface ITornadoWithdrawResponse {
+    id: string;
+}
+interface IRelayerClient {
+    getStatus(hostname: string): Promise<IRelayerStatusResponse>;
+    withdraw(relayerUrl: string, body: ITornadoWithdrawRequest): Promise<ITornadoWithdrawResponse>;
+}
+
+interface TornadoProveOutput {
+    proof: `0x${string}`;
+    args: [
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`
+    ];
+}
+
+interface IRelayerFeeConfig {
+    minFee: number;
+    maxFee: number;
+}
+
+declare enum DepositStrategy {
+    MaxAnonimitySet = 0,
+    MinFee = 1
+}
+
+interface SignedDelegation {
+    senderAddress: `0x${string}`;
+    authorization: SignedAuthorization;
+}
+interface IPaymasterWithdrawalPayload {
+    mode: 'paymaster';
+    proof: TornadoProveOutput;
+    poolAddress: Address;
+    isERC20: boolean;
+    delegation?: SignedDelegation;
+}
+
+type DelegationConfig = {
+    mode: 'deterministic';
+    path?: string;
+} | {
+    mode: 'random';
+};
+type StringAddress = `0x${string}`;
+interface IPaymasterConfig {
+    paymasterAddress: StringAddress;
+    entryPointAddress: StringAddress;
+    poolsAccountsMap: Record<StringAddress, StringAddress>;
+    bundlerUrl: string;
+}
+type IChainsPaymastersConfig = Record<number, IPaymasterConfig>;
+interface IRelayerWithdrawalPayload {
+    mode: 'relayer';
+    proof: TornadoProveOutput;
+    poolAddress: Address;
+    relayerUrl: string;
+}
+type IWithdrawalPayload = IRelayerWithdrawalPayload | IPaymasterWithdrawalPayload;
+interface ITornadoArtifacts {
+    circuitText: string;
+    provingKey: ArrayBuffer;
+}
+type TCProtocolConfig = Omit<ProtocolConfigState, 'chainId'>;
+interface IBaseOperationParams {
+}
+interface IDepositOperationParams extends IBaseOperationParams {
+    asset: Address;
+    amount: bigint;
+    strategy: DepositStrategy;
+}
+interface IWithdrawBaseParams extends Omit<IDepositOperationParams, 'amount' | 'strategy'> {
+    amount?: bigint;
+    recipient: Address;
+}
+interface IRelayerWithdrawParams extends IWithdrawBaseParams {
+    mode: 'relayer';
+    preferredRelayersEns?: string[];
+}
+interface IPaymasterWithdrawParams extends IWithdrawBaseParams {
+    mode: 'paymaster';
+    delegation?: DelegationConfig;
+}
+type IWithdrawapOperationParams = IRelayerWithdrawParams | IPaymasterWithdrawParams;
+type StoreKey = `${string}-${string}`;
+type StoreStorageKey = `tornado-cash-state-${StoreKey}`;
+
+interface WorkerInitOptions {
+    protocolConfig: TCProtocolConfig;
+    relayerConfig?: IRelayerFeeConfig;
+    accountIndex: number;
+    paymasterConfig: IChainsPaymastersConfig;
+}
+
+declare function loadStateManagerWorker(workerUrl?: string | URL): {
+    remote: comlink.Remote<{
+        init(provider: _kohaku_eth_provider.EthereumProvider, relayerClient: IRelayerClient, keystore: _kohaku_eth_plugins.Keystore, rawStorage: Omit<_kohaku_eth_plugins.Storage, "_brand">, initialState: () => Promise<Record<string, PublicRootState>>, artifactsLoader: () => Promise<ITornadoArtifacts>, { protocolConfig, accountIndex, relayerConfig, paymasterConfig }: WorkerInitOptions): Promise<void>;
+        sync(): Promise<void>;
+        getBalances(assets?: Address[]): Promise<Map<Address, bigint>>;
+        getDepositPayload(params: IDepositOperationParams): Promise<_kohaku_eth_provider.TxData[]>;
+        getWithdrawalPayloads(params: IWithdrawapOperationParams): Promise<IWithdrawalPayload[]>;
+        dumpState(): Record<StoreStorageKey, Omit<RootState, "userSecrets">>;
+    }>;
+    onError: (handler: (err: Error) => void) => void;
+};
+
+export { loadStateManagerWorker };

package/dist/worker-loader.browser.js

@@ -0,0 +1,13 @@
+// src/plugin/worker-loader.browser.ts
+import { wrap } from "comlink";
+function loadStateManagerWorker(workerUrl) {
+  const url = workerUrl ?? new URL("../state/state-manager.worker.js", import.meta.url);
+  const worker = new Worker(url, { type: "module" });
+  return {
+    remote: wrap(worker),
+    onError: (handler) => worker.addEventListener("error", (e) => handler(e.error ?? new Error(e.message)))
+  };
+}
+export {
+  loadStateManagerWorker
+};

package/dist/worker-loader.node.d.ts

@@ -0,0 +1,153 @@
+import * as comlink from 'comlink';
+import { combineReducers } from '@reduxjs/toolkit';
+import * as _kohaku_eth_plugins from '@kohaku-eth/plugins';
+import { SignedAuthorization } from 'viem';
+import * as _kohaku_eth_provider from '@kohaku-eth/provider';
+import { Worker } from 'worker_threads';
+
+type Address = bigint & {};
+interface IContract {
+    address: Address;
+}
+interface IScrapeableContract extends IContract {
+    deploymentBlock: bigint;
+}
+
+interface InstanceRegistryConfig extends IScrapeableContract {
+    lastDeployedOnBlock?: bigint;
+}
+interface ProtocolConfigState {
+    chainId: bigint;
+    ensSubdomainKey: string;
+    instanceRegistry: InstanceRegistryConfig;
+    relayerRegistry: IScrapeableContract;
+    aggregator: IContract;
+}
+
+type RootState = ReturnType<ReturnType<typeof combineReducers<typeof reducers>>>;
+type PublicRootState = Omit<RootState, 'userSecrets'>;
+
+interface IRelayerStatusResponse {
+    currentQueue: number;
+    netId: number;
+    rewardAccount: string;
+    version: string;
+    tornadoServiceFee: number;
+    ethPrices: Record<string, string>;
+}
+interface ITornadoWithdrawRequest {
+    proof: `0x${string}`;
+    args: [`0x${string}`, `0x${string}`, `0x${string}`, `0x${string}`, `0x${string}`, `0x${string}`];
+    contract: `0x${string}`;
+}
+interface ITornadoWithdrawResponse {
+    id: string;
+}
+interface IRelayerClient {
+    getStatus(hostname: string): Promise<IRelayerStatusResponse>;
+    withdraw(relayerUrl: string, body: ITornadoWithdrawRequest): Promise<ITornadoWithdrawResponse>;
+}
+
+interface TornadoProveOutput {
+    proof: `0x${string}`;
+    args: [
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`,
+        `0x${string}`
+    ];
+}
+
+interface IRelayerFeeConfig {
+    minFee: number;
+    maxFee: number;
+}
+
+declare enum DepositStrategy {
+    MaxAnonimitySet = 0,
+    MinFee = 1
+}
+
+interface SignedDelegation {
+    senderAddress: `0x${string}`;
+    authorization: SignedAuthorization;
+}
+interface IPaymasterWithdrawalPayload {
+    mode: 'paymaster';
+    proof: TornadoProveOutput;
+    poolAddress: Address;
+    isERC20: boolean;
+    delegation?: SignedDelegation;
+}
+
+type DelegationConfig = {
+    mode: 'deterministic';
+    path?: string;
+} | {
+    mode: 'random';
+};
+type StringAddress = `0x${string}`;
+interface IPaymasterConfig {
+    paymasterAddress: StringAddress;
+    entryPointAddress: StringAddress;
+    poolsAccountsMap: Record<StringAddress, StringAddress>;
+    bundlerUrl: string;
+}
+type IChainsPaymastersConfig = Record<number, IPaymasterConfig>;
+interface IRelayerWithdrawalPayload {
+    mode: 'relayer';
+    proof: TornadoProveOutput;
+    poolAddress: Address;
+    relayerUrl: string;
+}
+type IWithdrawalPayload = IRelayerWithdrawalPayload | IPaymasterWithdrawalPayload;
+interface ITornadoArtifacts {
+    circuitText: string;
+    provingKey: ArrayBuffer;
+}
+type TCProtocolConfig = Omit<ProtocolConfigState, 'chainId'>;
+interface IBaseOperationParams {
+}
+interface IDepositOperationParams extends IBaseOperationParams {
+    asset: Address;
+    amount: bigint;
+    strategy: DepositStrategy;
+}
+interface IWithdrawBaseParams extends Omit<IDepositOperationParams, 'amount' | 'strategy'> {
+    amount?: bigint;
+    recipient: Address;
+}
+interface IRelayerWithdrawParams extends IWithdrawBaseParams {
+    mode: 'relayer';
+    preferredRelayersEns?: string[];
+}
+interface IPaymasterWithdrawParams extends IWithdrawBaseParams {
+    mode: 'paymaster';
+    delegation?: DelegationConfig;
+}
+type IWithdrawapOperationParams = IRelayerWithdrawParams | IPaymasterWithdrawParams;
+type StoreKey = `${string}-${string}`;
+type StoreStorageKey = `tornado-cash-state-${StoreKey}`;
+
+interface WorkerInitOptions {
+    protocolConfig: TCProtocolConfig;
+    relayerConfig?: IRelayerFeeConfig;
+    accountIndex: number;
+    paymasterConfig: IChainsPaymastersConfig;
+}
+
+declare function loadStateManagerWorker(workerUrl?: string | URL): {
+    remote: comlink.Remote<{
+        init(provider: _kohaku_eth_provider.EthereumProvider, relayerClient: IRelayerClient, keystore: _kohaku_eth_plugins.Keystore, rawStorage: Omit<_kohaku_eth_plugins.Storage, "_brand">, initialState: () => Promise<Record<string, PublicRootState>>, artifactsLoader: () => Promise<ITornadoArtifacts>, { protocolConfig, accountIndex, relayerConfig, paymasterConfig }: WorkerInitOptions): Promise<void>;
+        sync(): Promise<void>;
+        getBalances(assets?: Address[]): Promise<Map<Address, bigint>>;
+        getDepositPayload(params: IDepositOperationParams): Promise<_kohaku_eth_provider.TxData[]>;
+        getWithdrawalPayloads(params: IWithdrawapOperationParams): Promise<IWithdrawalPayload[]>;
+        dumpState(): Record<StoreStorageKey, Omit<RootState, "userSecrets">>;
+    }>;
+    onError: (handler: (err: Error) => void) => Worker;
+};
+
+export { loadStateManagerWorker };

package/dist/worker-loader.node.js

@@ -0,0 +1,22 @@
+// src/plugin/worker-loader.node.ts
+import { wrap } from "comlink";
+import nodeEndpoint from "comlink/dist/umd/node-adapter.js";
+import { Worker } from "worker_threads";
+import { fileURLToPath } from "url";
+import { dirname, resolve } from "path";
+function loadStateManagerWorker(workerUrl) {
+  if (workerUrl !== void 0) {
+    console.warn("[worker-loader.node] workerUrl is ignored in Node.js \u2014 the worker file is always loaded from the local filesystem.");
+  }
+  const thisFile = fileURLToPath(import.meta.url);
+  const thisDir = dirname(thisFile);
+  const workerPath = resolve(thisDir, `./state-manager.worker.node.cjs`);
+  const worker = new Worker(workerPath);
+  return {
+    remote: wrap(nodeEndpoint(worker)),
+    onError: (handler) => worker.on("error", handler)
+  };
+}
+export {
+  loadStateManagerWorker
+};

package/package.json

@@ -1,17 +1,115 @@
 {
   "name": "@kohaku-eth/tornado-cash",
-  "version": "0.0.1",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "version": "0.0.2-alpha.8",
+  "description": "Simplified Privacy Pools TS utils",
+  "type": "module",
+  "private": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereum/kohaku.git",
+    "directory": "packages/tornado-cash"
+  },
+  "imports": {
+    "#worker-loader": {
+      "node": "./dist/worker-loader.node.js",
+      "browser": "./src/plugin/worker-loader.browser.ts",
+      "default": "./src/plugin/worker-loader.browser.ts"
+    },
+    "#circuit-loader": {
+      "default": "./dist/circuit-loader.js"
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./state-manager.worker.js": "./dist/state-manager.worker.js",
+    "./state-manager.worker.node.cjs": "./dist/state-manager.worker.node.cjs",
+    "./worker-loader": {
+      "node": "./dist/worker-loader.node.js",
+      "browser": "./dist/worker-loader.browser.js",
+      "default": "./dist/worker-loader.browser.js"
+    },
+    "./worker-loader.browser": "./dist/worker-loader.browser.js",
+    "./worker-loader.node": "./dist/worker-loader.node.js",
+    "./circuits/*": "./circuits/*",
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "circuits"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
-  "packageManager": "pnpm@10.15.0",
-  "private": false,
-  "publishConfig": {
-      "access": "public"
+  "license": "MIT",
+  "peerDependencies": {
+    "ethers": "^6.13.1"
+  },
+  "peerDependenciesMeta": {
+    "ethers": {
+      "optional": true
     }
-}
+  },
+  "dependencies": {
+    "@noble/curves": "^2.2.0",
+    "@noble/hashes": "^2.2.0",
+    "@privacy-paymasters/sdk": "0.0.2",
+    "@reduxjs/toolkit": "^2.11.2",
+    "buffer": "^6.0.3",
+    "circomlibjs": "0.1.2",
+    "comlink": "^4.4.2",
+    "fixed-merkle-tree": "^0.7.3",
+    "maci-crypto": "2.5.0",
+    "micro-zk-proofs": "0.3.0",
+    "ox": "^0.12.0",
+    "snarkjs": "git+https://github.com/tornadocash/snarkjs.git#869181cfaf7526fe8972073d31655493a04326d5",
+    "viem": "^2.51.3",
+    "websnark": "git+https://github.com/tornadocash/websnark.git#4c0af6a8b65aabea3c09f377f63c44e7a58afa6d",
+    "@kohaku-eth/plugins": "0.0.1-alpha.8",
+    "@kohaku-eth/provider": "0.1.0-alpha.8"
+  },
+  "devDependencies": {
+    "@types/node": "^24.12.2",
+    "dotenv": "^17.2.1",
+    "ethers": "^6.16.0",
+    "get-port": "^7.1.0",
+    "prool": "^0.0.24",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.0",
+    "tsx": "^4.17.0",
+    "typescript": "^5.9.2",
+    "vitest": "^3.0.0"
+  },
+  "scripts": {
+    "aux": "tsx src/account/keys.ts",
+    "check": "tsc --noEmit -p ./tsconfig.json",
+    "build": "echo Building @kohaku-eth/tornado-cash && tsup --config tsup.config.ts",
+    "dev": "tsup --config tsup.config.ts --watch",
+    "demo": "tsx demo/simple.ts",
+    "test": "vitest run --project=e2e-sepolia",
+    "test:unit": "vitest run --project=unit",
+    "test:e2e:sepolia": ". ./.env.e2e.tests && vitest run --project=e2e-sepolia",
+    "test:e2e:wl": ". ./.env.e2e.tests && vitest run --project=withdraw-sepolia",
+    "test:e2e:sh": ". ./.env.e2e.tests && vitest run --project=shield-sepolia",
+    "test:e2e:sh:debugger": ". ./.env.e2e.tests && vitest --inspect-brk --no-file-parallelism run --project=shield",
+    "test:e2e:wp:sepolia": "vitest run --project=withdraw-paymaster-sepolia",
+    "test:e2e:debugger": ". ./.env.e2e.tests && vitest --inspect-brk --no-file-parallelism run e2e",
+    "test:sync:sepolia": ". ./.env.e2e.tests && vitest run --project=sync-sepolia",
+    "test:sync:mainnet": ". ./.env.e2e.tests && vitest run --project=sync-mainnet",
+    "test:sync:debugger": ". ./.env.e2e.tests && vitest --inspect-brk --no-file-parallelism run --project=sync",
+    "test:watch": "vitest",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}