@kohaku-eth/tornado-cash 0.0.2-alpha.10 → 0.0.2-alpha.12

package/dist/index.d.ts

@@ -39,41 +39,6 @@ interface SecretManagerParams {
 }
 declare function SecretManager({ host: { keystore }, accountIndex }: SecretManagerParams): Promise<ISecretManager>;
 
-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 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 IBaseEvent {
     blockNumber: bigint;
     transactionHash: bigint;
@@ -86,6 +51,15 @@ interface IDepositEvent extends IPoolEvent {
     leafIndex: number;
     timestamp: bigint;
 }
+interface IIndexedDepositEvent extends IDepositEvent {
+    index: number;
+}
+interface IDepositWithAsset extends IIndexedDepositEvent {
+    assetAddress: Address;
+}
+interface IDepositWithBalance extends IDepositWithAsset {
+    balance: bigint;
+}
 interface IWithdrawalEvent extends IPoolEvent {
     to: Address;
     nullifierHash: NullifierHash;
@@ -111,6 +85,41 @@ interface IAsset {
     symbol: string;
 }
 
+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 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'>;
+
 declare const POOL_EVENTS_SIGNATURES: {
     readonly Deposited: {
         readonly name: "Deposit";
@@ -305,6 +314,17 @@ interface IPaymasterWithdrawalPayload {
     isERC20: boolean;
     delegation?: SignedDelegation;
 }
+interface IGenericPaymasterWithdrawalPayload {
+    mode: 'paymaster';
+    proof: TornadoProveOutput;
+    poolAddress: Address;
+    isERC20: boolean;
+    paymasterAddress: `0x${string}`;
+    entryPointAddress: `0x${string}`;
+    bundlerUrl: string;
+    accountAddress: `0x${string}`;
+    delegation?: SignedDelegation;
+}
 interface PaymasterBroadcastResult {
     userOpHash: Hash;
 }
@@ -332,7 +352,7 @@ interface IRelayerWithdrawalPayload {
     poolAddress: Address;
     relayerUrl: string;
 }
-type IWithdrawalPayload = IRelayerWithdrawalPayload | IPaymasterWithdrawalPayload;
+type IWithdrawalPayload = IRelayerWithdrawalPayload | IGenericPaymasterWithdrawalPayload;
 interface TCPrivateOperation<Mode extends IWithdrawalPayload['mode'] = 'relayer' | 'paymaster'> extends PrivateOperation {
     withdrawals: (IWithdrawalPayload & {
         mode: Mode;
@@ -346,7 +366,7 @@ interface ITornadoArtifacts {
     provingKey: ArrayBuffer;
 }
 type TCProtocolConfig = Omit<ProtocolConfigState, 'chainId'>;
-interface PrivacyPoolsV1ProtocolParams {
+interface TCProtocolParams {
     accountIndex?: number;
     paymasterConfig: IChainsPaymastersConfig;
     secretManagerFactory: (params: SecretManagerParams) => Promise<ISecretManager>;
@@ -355,7 +375,6 @@ interface PrivacyPoolsV1ProtocolParams {
     protocolConfig: TCProtocolConfig;
     relayerConfig?: IRelayerFeeConfig;
     artifactsLoader?: () => Promise<ITornadoArtifacts>;
-    proverFactory?: () => Promise<ITornadoProver>;
     initialState?: () => Promise<Record<string, PublicRootState>>;
     stateManagerWorkerUrl?: string;
 }
@@ -379,6 +398,15 @@ interface IPaymasterWithdrawParams extends IWithdrawBaseParams {
     delegation?: DelegationConfig;
 }
 type IWithdrawapOperationParams = IRelayerWithdrawParams | IPaymasterWithdrawParams;
+interface IGetNotesParams extends IBaseOperationParams {
+    includeSpent?: boolean;
+    assets?: Address[];
+}
+type TCNote = Pick<IDepositWithBalance, 'commitment' | 'balance' | 'assetAddress' | 'timestamp' | 'leafIndex' | 'pool'> & {
+    /** Fixed pool denomination for this note. */
+    amount: bigint;
+    depositIndex: number;
+};
 type StoreKey = `${string}-${string}`;
 type StoreStorageKey = `tornado-cash-state-${StoreKey}`;
 interface IStateManager {
@@ -399,6 +427,12 @@ interface IStateManager {
      * All assets if not specified.
      */
     getBalances: SpecificAssetBalanceFn<true>;
+    /**
+     * Gets all notes for the account.
+     * @param includeSpent - If true, include notes with zero balance
+     * @param assets - Optional filter by specific assets
+     */
+    getNotes: (params: IGetNotesParams) => Promise<TCNote[]>;
     dumpState: () => Record<StoreStorageKey, PublicRootState>;
 }
 
@@ -411,12 +445,11 @@ type TCBroadcaster = Broadcaster<TCPrivateOperation, ITornadoWithdrawResponse[]>
 interface TCBaseCredential {
     accountIndex: number;
 }
-interface TCPluginParameters extends TCBroadcasterParameters, TCBaseCredential {
+interface TCPluginParameters extends TCBroadcasterParameters, TCBaseCredential, Pick<TCProtocolParams, 'initialState'> {
     protocolConfig: TCProtocolConfig;
     relayerConfig?: IRelayerFeeConfig;
-    initialState?: PrivacyPoolsV1ProtocolParams['initialState'];
-    artifacts: ITornadoArtifacts;
     stateManagerWorkerUrl?: string;
+    artifactsLoader?: () => Promise<ITornadoArtifacts>;
 }
 type TCAddress = Address$1;
 type TCAssetAmount<Tag extends string | undefined = undefined> = AssetAmount<ERC20AssetId, bigint, Tag>;
@@ -444,6 +477,7 @@ type TCInstance = PluginInstance<TCAddress, {
         output: TCAssetAmount;
         read: TCAssetBalance;
     };
+    note: TCNote;
     extras: {
         sync(): Promise<void>;
         prepareShield(asset: TCAssetAmount, options: TCPrepareShieldOptions): Promise<TCPublicOperation>;
@@ -461,7 +495,7 @@ type RequireOnly<T, Keys extends keyof T> = Partial<T> & Pick<T, Keys>;
 declare class TornadoCashProtocol implements TCInstance {
     readonly host: Host;
     private stateManager;
-    constructor(host: Host, { accountIndex, initialState, protocolConfig, artifactsLoader, stateManagerWorkerUrl, relayerConfig, paymasterConfig, relayerClientFactory }: RequireOnly<PrivacyPoolsV1ProtocolParams, 'protocolConfig'>);
+    constructor(host: Host, { accountIndex, initialState, protocolConfig, artifactsLoader, stateManagerWorkerUrl, relayerConfig, paymasterConfig, relayerClientFactory, }: RequireOnly<TCProtocolParams, 'protocolConfig'>);
     instanceId: () => Promise<"0x1">;
     /**
      * Only process supported assets or error out?
@@ -469,6 +503,12 @@ declare class TornadoCashProtocol implements TCInstance {
      * The assets retain the provided order. If an asset is not supported its balance will be 0
      */
     balance(assets?: ERC20AssetId[]): Promise<TCAssetBalance[]>;
+    /**
+     * Returns all notes for the account.
+     * @param assets - Filter by specific assets (optional, if empty returns all)
+     * @param includeSpent - Include notes with zero balance (default: false)
+     */
+    notes(assets?: ERC20AssetId[], includeSpent?: boolean): Promise<TCNote[]>;
     prepareShield(assets: TCAssetAmount, options?: TCPrepareShieldOptions | `0x${string}`): Promise<TCPublicOperation>;
     prepareUnshield(assets: AssetAmount, to: AccountId, options?: TCRelayerUnshieldOptions): Promise<TCPrivateOperation<'relayer'>>;
     prepareUnshield(assets: AssetAmount, to: AccountId, options?: TCPaymasterUnshieldOptions): Promise<TCPrivateOperation<'paymaster'>>;
@@ -490,6 +530,19 @@ interface Nullifier {
 }
 
 declare const E_ADDRESS = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
+declare const TornadoPaymasterConfigs: {
+    readonly 11155111: {
+        readonly bundlerUrl: "https://public.pimlico.io/v2/11155111/rpc";
+        readonly entryPointAddress: "0x4337084D9E255Ff0702461CF8895CE9E3b5Ff108";
+        readonly paymasterAddress: "0xA0e2667AcdECb9bCDa6Fcf87638a962e2E9dB20D";
+        readonly poolsAccountsMap: {
+            readonly '0x8c4a04d872a6c1be37964a21ba3a138525dff50b': "0x8A70E3dE493B8599447013f08d8b35719C8ED0ec";
+            readonly '0x8cc930096b4df705a007c4a039bdfa1320ed2508': "0x191e3De3cF7f61de7EbEf4Bf45cfBA4f652d1C6e";
+            readonly '0x6921fd1a97441dd603a997ed6ddf388658daf754': "0x060d053A6595630851ab873d6C95401b0C964d26";
+        };
+    };
+    readonly 1: never;
+};
 declare const TornadoCashConfigs: {
     readonly 1: {
         readonly ensSubdomainKey: "mainnet-tornado";
@@ -525,4 +578,4 @@ declare const TornadoCashConfigs: {
     };
 };
 
-export { type Commitment, DepositStrategy, E_ADDRESS, type ISecretManager, type Nullifier, SecretManager, type SecretManagerParams, type TCAddress, type TCAssetAmount, type TCAssetBalance, type TCBroadcaster, type TCBroadcasterParameters, type TCInstance, type TCPaymasterUnshieldOptions, type TCPluginParameters, type TCPrepareShieldOptions, type TCPrepareUnshieldOptions, type TCRelayerUnshieldOptions, TornadoCashConfigs, TornadoCashProtocol, createTCBroadcaster, createTCPlugin };
+export { type Commitment, DepositStrategy, E_ADDRESS, type ISecretManager, type Nullifier, SecretManager, type SecretManagerParams, type TCAddress, type TCAssetAmount, type TCAssetBalance, type TCBroadcaster, type TCBroadcasterParameters, type TCInstance, type TCNote, type TCPaymasterUnshieldOptions, type TCPluginParameters, type TCPrepareShieldOptions, type TCPrepareUnshieldOptions, type TCRelayerUnshieldOptions, TornadoCashConfigs, TornadoCashProtocol, TornadoPaymasterConfigs, createTCBroadcaster, createTCPlugin };

package/dist/index.js

@@ -8,8 +8,6 @@ import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';
 import { numberToBytesLE, bytesToNumberLE, concatBytes } from '@noble/curves/utils.js';
 import { keccak_256 } from '@noble/hashes/sha3.js';
 import { pedersenHash as pedersenHash$1, Point } from 'micro-zk-proofs/pedersen.js';
-import 'micro-zk-proofs/mimcsponge.js';
-import 'fixed-merkle-tree';
 
 // src/state/thunks/getDepositPayloadThunk.ts
 
@@ -409,7 +407,7 @@ async function loadCircuitFiles(circuitUrl, provingKeyUrl) {
 
 // src/utils/default-artifacts-loader.ts
 var TC_CIRCUIT_URL = "https://raw.githubusercontent.com/tornadocash/tornado-cli/refs/heads/master/build/circuits/tornado.json";
-var TC_PROVING_KEY_URL = "https://github.com/tornadocash/tornado-cli/raw/refs/heads/master/build/circuits/tornadoProvingKey.bin";
+var TC_PROVING_KEY_URL = "https://raw.githubusercontent.com/tornadocash/tornado-cli/refs/heads/master/build/circuits/tornadoProvingKey.bin";
 var defaultArtifactsLoader = () => loadCircuitFiles(TC_CIRCUIT_URL, TC_PROVING_KEY_URL);
 
 // src/plugin/base.ts
@@ -448,6 +446,7 @@ var TornadoCashProtocol = class {
       return {
         sync: () => remote.sync(),
         getBalances: ((assets) => remote.getBalances(assets)),
+        getNotes: (params) => remote.getNotes(params),
         getDepositPayload: (params) => remote.getDepositPayload(params),
         getWithdrawalPayloads: (params) => remote.getWithdrawalPayloads(params),
         dumpState: (() => remote.dumpState())
@@ -486,6 +485,23 @@ var TornadoCashProtocol = class {
       };
     });
   }
+  /**
+   * Returns all notes for the account.
+   * @param assets - Filter by specific assets (optional, if empty returns all)
+   * @param includeSpent - Include notes with zero balance (default: false)
+   */
+  async notes(assets = [], includeSpent = false) {
+    const stateManager = await this.stateManager;
+    await stateManager.sync();
+    const assetAddresses = assets.map(({ contract }) => {
+      const parsedAddress = BigInt(contract);
+      return parsedAddress === E_ADDRESS_BIGINT ? 0n : parsedAddress;
+    });
+    return stateManager.getNotes({
+      includeSpent,
+      assets: assetAddresses.length > 0 ? assetAddresses : void 0
+    });
+  }
   async prepareShield(assets, options) {
     const { asset, amount } = assets;
     const strategy = typeof options === "string" ? 1 /* MinFee */ : options?.strategy || 1 /* MinFee */;
@@ -580,10 +596,7 @@ var PaymasterBroadcaster = class _PaymasterBroadcaster {
   async broadcast(withdrawals) {
     const chainId = Number(await this.provider.getChainId());
     const {
-      poolsAccountsMap: rawPoolsAccountsMap,
-      bundlerUrl,
-      paymasterAddress,
-      entryPointAddress
+      poolsAccountsMap: rawPoolsAccountsMap
     } = this.options[chainId];
     const poolAcountsMap = new Map(
       Object.entries(rawPoolsAccountsMap).map(([poolAccount, tornadoAccount]) => [
@@ -594,9 +607,6 @@ var PaymasterBroadcaster = class _PaymasterBroadcaster {
     const results = await Promise.allSettled(
       withdrawals.map((w) => _PaymasterBroadcaster.broadcastOne({
         ...w,
-        bundlerUrl,
-        paymasterAddress,
-        entryPointAddress,
         accountAddress: poolAcountsMap.get(w.poolAddress)
       }, this.provider))
     );
@@ -775,4 +785,4 @@ function tcPath({ accountIndex, secretType, depositIndex }) {
   return `${TORNADO_CASH_PATH}/${accountIndex}'/${_secretType}'/${depositIndex}'`;
 }
 
-export { DepositStrategy, E_ADDRESS, SecretManager, TornadoCashConfigs, TornadoCashProtocol, createTCBroadcaster, createTCPlugin };
+export { DepositStrategy, E_ADDRESS, SecretManager, TornadoCashConfigs, TornadoCashProtocol, TornadoPaymasterConfigs, createTCBroadcaster, createTCPlugin };