@kohaku-eth/tornado-cash 0.0.2-alpha.11 → 0.0.2-alpha.13

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 import { Broadcaster } from '@kohaku-eth/plugins/broadcaster';
-import { Host, ChainId, Storage, PrivateOperation, PublicOperation, AssetAmount, ERC20AssetId, PluginInstance, AccountId } from '@kohaku-eth/plugins';
+import { Host, ExternalRawEvent, ChainId, Storage, PrivateOperation, PublicOperation, AccountId, AssetAmount, ERC20AssetId, PluginInstance, UnshieldOptions } from '@kohaku-eth/plugins';
+import { TxData } from '@kohaku-eth/provider';
 import { combineReducers } from '@reduxjs/toolkit';
 import { ParseAbiItem, SignedAuthorization, Hash, Address as Address$2 } from 'viem';
-import { TxData } from '@kohaku-eth/provider';
 import { Address as Address$1 } from 'ox/Address';
+import { Hex } from 'ox/Hex';
 
 type Nullifier$1 = bigint & {};
 type NullifierHash = bigint & {};
@@ -39,41 +40,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 +52,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 +86,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";
@@ -181,7 +191,7 @@ declare const INSTANCE_REGISTRY_EVENT_SIGNATURES: {
 };
 
 type IEventsMap = Record<string, ParseAbiItem<string>>;
-interface IGetEventsParams<T> {
+interface IGetEventsParams$1<T> {
     events: T | T[];
     fromBlock: bigint;
     toBlock?: bigint;
@@ -202,7 +212,7 @@ type IGroupedEvents<NamesTable extends Record<string, unknown>> = {
 };
 type GetEventsFn<EventsMap extends IEventsMap, ParsedEvents extends {
     [key in keyof EventsMap]: unknown;
-}> = <const T extends keyof ParsedEvents = never>(params: IGetEventsParams<T>) => Promise<Pick<IGroupedEvents<ParsedEvents>, T> & {
+}> = <const T extends keyof ParsedEvents = never>(params: IGetEventsParams$1<T>) => Promise<Pick<IGroupedEvents<ParsedEvents>, T> & {
     fromBlock: bigint;
     toBlock: bigint;
 }>;
@@ -211,7 +221,6 @@ interface IPoolConfig {
     isERC20: boolean;
     token: Address;
     state: 0 | 1;
-    uniswapPoolSwappingFee: number;
     protocolFeePercentage: number;
     denomination: bigint;
     rootHistorySize: number;
@@ -224,6 +233,14 @@ interface IRelayerAggregatorData {
 }
 interface IDataService {
     getPoolEvents: GetEventsFn<typeof POOL_EVENTS_SIGNATURES, IPoolEvents>;
+    getBlockNumber(): Promise<bigint>;
+    parsePoolEvents(events: ExternalRawEvent[]): {
+        Deposited: IRawDepositEvent[];
+        Withdrawn: IRawWithdrawalEvent[];
+    };
+    parseRelayerRegistryEvents(events: ExternalRawEvent[]): {
+        RelayerRegistered: IRelayerRegisteredEvent[];
+    };
     getRelayerRegistryEvents: GetEventsFn<typeof RELAYER_REGISTRY_EVENTS_SIGNATURES, IRelayerRegistryEvents>;
     getInstanceRegistryEvents: GetEventsFn<typeof INSTANCE_REGISTRY_EVENT_SIGNATURES, IInstanceRegistryEvents>;
     getAsset(assetAddress: Address): Promise<IAsset>;
@@ -240,7 +257,38 @@ interface IDataService {
     getLatestBlockTimestamp(): Promise<bigint>;
     getRelayerData(aggregatorAddress: Address, relayerNameHashes: bigint[], subdomains: string[]): Promise<IRelayerAggregatorData[]>;
     getAccountNonce(accountAddress: Address): Promise<number>;
-    quoteEthToToken(amountInWei: bigint, tokenAddress: Address, poolFee: number): Promise<bigint>;
+    quoteWeiInToken(paymasterAddress: Address, feeToken: Address, weiAmount: bigint): Promise<bigint>;
+}
+
+/** Identifies one contract to sync from a given block. */
+interface IGetEventsParams {
+    chainId: bigint;
+    address: Address;
+    fromBlock: bigint;
+}
+interface IGetPoolEventsResult {
+    Deposited: IRawDepositEvent[];
+    Withdrawn: IRawWithdrawalEvent[];
+    /** Highest block the returned events are synced up to. */
+    toBlock: bigint;
+}
+interface IGetRelayerRegistryEventsResult {
+    RelayerRegistered: IRelayerRegisteredEvent[];
+    /** Highest block the returned events are synced up to. */
+    toBlock: bigint;
+}
+interface ISyncService {
+    /**
+     * Fetches a single pool's `Deposited`/`Withdrawn` events from `fromBlock`.
+     * Uses the external sync provider for the bulk of a large range and the chain
+     * for the remaining tail; falls back to a chain-only fetch otherwise.
+     */
+    getPoolEvents(params: IGetEventsParams): Promise<IGetPoolEventsResult>;
+    /**
+     * Fetches the relayer registry's `RelayerRegistered` events from `fromBlock`,
+     * with the same external-then-chain strategy as {@link getPoolEvents}.
+     */
+    getRelayerRegistryEvents(params: IGetEventsParams): Promise<IGetRelayerRegistryEventsResult>;
 }
 
 type SpecificAssetBalanceFn<isAsync extends boolean = false> = <const Adresses extends Address | Address[] = Address[], ReturnType = Adresses extends unknown[] ? Map<Address, bigint> : bigint>(assetAddress?: Adresses) => isAsync extends true ? Promise<ReturnType> : ReturnType;
@@ -280,6 +328,7 @@ interface IRelayerFeeConfig {
 interface StoreFactoryParams {
     secretManagerFactory: () => Promise<ISecretManager>;
     dataService: IDataService;
+    syncService: ISyncService;
     relayerClient: IRelayerClient;
     paymasterConfig: IChainsPaymastersConfig;
     storageToSyncTo?: Storage;
@@ -294,6 +343,36 @@ declare enum DepositStrategy {
     MinFee = 1
 }
 
+interface SerializedAuth {
+    address: Address$1;
+    chainId: Hex;
+    nonce: Hex;
+    r: Hex;
+    s: Hex;
+    yParity: Hex;
+}
+/**
+ * A userOp serialized to the hex shape expected by `eth_sendUserOperation`, so
+ * it can be carried as plain (JSON-serializable) data from the prepare phase
+ * (thunk) to the broadcast phase.
+ */
+interface SerializedUserOperation {
+    sender: `0x${string}`;
+    nonce: `0x${string}`;
+    callData: `0x${string}`;
+    callGasLimit: `0x${string}`;
+    verificationGasLimit: `0x${string}`;
+    preVerificationGas: `0x${string}`;
+    maxFeePerGas: `0x${string}`;
+    maxPriorityFeePerGas: `0x${string}`;
+    paymaster?: `0x${string}`;
+    paymasterVerificationGasLimit?: `0x${string}`;
+    paymasterPostOpGasLimit?: `0x${string}`;
+    paymasterData?: `0x${string}`;
+    signature: `0x${string}`;
+    eip7702Auth?: SerializedAuth;
+}
+
 interface SignedDelegation {
     senderAddress: `0x${string}`;
     authorization: SignedAuthorization;
@@ -313,8 +392,7 @@ interface IGenericPaymasterWithdrawalPayload {
     paymasterAddress: `0x${string}`;
     entryPointAddress: `0x${string}`;
     bundlerUrl: string;
-    accountAddress: `0x${string}`;
-    delegation?: SignedDelegation;
+    userOperation: SerializedUserOperation;
 }
 interface PaymasterBroadcastResult {
     userOpHash: Hash;
@@ -323,16 +401,6 @@ interface IPaymasterBroadcasterClient {
     broadcast(withdrawals: IPaymasterWithdrawalPayload[]): Promise<PaymasterBroadcastResult[]>;
 }
 
-declare function makeLazyProverFactory(artifactsLoader: () => Promise<ITornadoArtifacts>, version?: 'legacy' | 'js'): () => Promise<ITornadoProver>;
-
-interface WorkerInitOptions {
-    protocolConfig: TCProtocolConfig;
-    relayerConfig?: IRelayerFeeConfig;
-    accountIndex: number;
-    paymasterConfig: IChainsPaymastersConfig;
-    proverVersion?: Parameters<typeof makeLazyProverFactory>[1];
-}
-
 type DelegationConfig = {
     mode: 'deterministic';
     path?: string;
@@ -367,7 +435,7 @@ interface ITornadoArtifacts {
     provingKey: ArrayBuffer;
 }
 type TCProtocolConfig = Omit<ProtocolConfigState, 'chainId'>;
-interface TCProtocolParams extends Pick<WorkerInitOptions, 'proverVersion'> {
+interface TCProtocolParams {
     accountIndex?: number;
     paymasterConfig: IChainsPaymastersConfig;
     secretManagerFactory: (params: SecretManagerParams) => Promise<ISecretManager>;
@@ -378,6 +446,12 @@ interface TCProtocolParams extends Pick<WorkerInitOptions, 'proverVersion'> {
     artifactsLoader?: () => Promise<ITornadoArtifacts>;
     initialState?: () => Promise<Record<string, PublicRootState>>;
     stateManagerWorkerUrl?: string;
+    /**
+     * When a pool is at least this many blocks behind, use the host's
+     * `externalSyncProvider` (if any) for the bulk of the sync instead of the
+     * chain. Omit to always sync from the chain.
+     */
+    minExternalSyncBlocksAmount?: number;
 }
 interface IBaseOperationParams {
 }
@@ -397,8 +471,18 @@ interface IRelayerWithdrawParams extends IWithdrawBaseParams {
 interface IPaymasterWithdrawParams extends IWithdrawBaseParams {
     mode: 'paymaster';
     delegation?: DelegationConfig;
+    tailCalls?: (address: AccountId) => Promise<TxData[]>;
 }
 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 {
@@ -419,6 +503,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>;
 }
 
@@ -431,7 +521,7 @@ type TCBroadcaster = Broadcaster<TCPrivateOperation, ITornadoWithdrawResponse[]>
 interface TCBaseCredential {
     accountIndex: number;
 }
-interface TCPluginParameters extends TCBroadcasterParameters, TCBaseCredential, Pick<TCProtocolParams, 'proverVersion' | 'initialState'> {
+interface TCPluginParameters extends TCBroadcasterParameters, TCBaseCredential, Pick<TCProtocolParams, 'initialState' | 'minExternalSyncBlocksAmount'> {
     protocolConfig: TCProtocolConfig;
     relayerConfig?: IRelayerFeeConfig;
     stateManagerWorkerUrl?: string;
@@ -440,11 +530,11 @@ interface TCPluginParameters extends TCBroadcasterParameters, TCBaseCredential,
 type TCAddress = Address$1;
 type TCAssetAmount<Tag extends string | undefined = undefined> = AssetAmount<ERC20AssetId, bigint, Tag>;
 type TCAssetBalance = TCAssetAmount;
-interface TCRelayerUnshieldOptions {
+interface TCRelayerUnshieldOptions extends UnshieldOptions {
     mode: 'relayer';
     preferredRelayersEns?: string[];
 }
-interface TCPaymasterUnshieldOptions {
+interface TCPaymasterUnshieldOptions extends UnshieldOptions {
     mode: 'paymaster';
     delegation?: DelegationConfig;
 }
@@ -463,6 +553,7 @@ type TCInstance = PluginInstance<TCAddress, {
         output: TCAssetAmount;
         read: TCAssetBalance;
     };
+    note: TCNote;
     extras: {
         sync(): Promise<void>;
         prepareShield(asset: TCAssetAmount, options: TCPrepareShieldOptions): Promise<TCPublicOperation>;
@@ -480,7 +571,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, proverVersion }: RequireOnly<TCProtocolParams, 'protocolConfig'>);
+    constructor(host: Host, { accountIndex, initialState, protocolConfig, artifactsLoader, stateManagerWorkerUrl, relayerConfig, paymasterConfig, relayerClientFactory, minExternalSyncBlocksAmount, }: RequireOnly<TCProtocolParams, 'protocolConfig'>);
     instanceId: () => Promise<"0x1">;
     /**
      * Only process supported assets or error out?
@@ -488,7 +579,14 @@ 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): Promise<TCPrivateOperation<'relayer'>>;
     prepareUnshield(assets: AssetAmount, to: AccountId, options?: TCRelayerUnshieldOptions): Promise<TCPrivateOperation<'relayer'>>;
     prepareUnshield(assets: AssetAmount, to: AccountId, options?: TCPaymasterUnshieldOptions): Promise<TCPrivateOperation<'paymaster'>>;
     sync(): Promise<void>;
@@ -513,11 +611,11 @@ declare const TornadoPaymasterConfigs: {
     readonly 11155111: {
         readonly bundlerUrl: "https://public.pimlico.io/v2/11155111/rpc";
         readonly entryPointAddress: "0x4337084D9E255Ff0702461CF8895CE9E3b5Ff108";
-        readonly paymasterAddress: "0xA0e2667AcdECb9bCDa6Fcf87638a962e2E9dB20D";
+        readonly paymasterAddress: "0x1c5aCCb9c09D72945b79EC986776136bE01d7B2F";
         readonly poolsAccountsMap: {
-            readonly '0x8c4a04d872a6c1be37964a21ba3a138525dff50b': "0x8A70E3dE493B8599447013f08d8b35719C8ED0ec";
-            readonly '0x8cc930096b4df705a007c4a039bdfa1320ed2508': "0x191e3De3cF7f61de7EbEf4Bf45cfBA4f652d1C6e";
-            readonly '0x6921fd1a97441dd603a997ed6ddf388658daf754': "0x060d053A6595630851ab873d6C95401b0C964d26";
+            readonly '0x8c4a04d872a6c1be37964a21ba3a138525dff50b': "0xa616aAE443FCCABfc2F1EA2Afe001E5046FFDCe0";
+            readonly '0x8cc930096b4df705a007c4a039bdfa1320ed2508': "0x67a898343F32641206d0f30CB3367944a8919A3A";
+            readonly '0x6921fd1a97441dd603a997ed6ddf388658daf754': "0xbF0a7969dacF8337716d0F283df0574dF56b0479";
         };
     };
     readonly 1: never;
@@ -537,7 +635,6 @@ declare const TornadoCashConfigs: {
             readonly address: 1329937909414098670091808248270266272594403334985n;
         };
         readonly weth: 1097077688018008265106216665536940668749033598146n;
-        readonly uniswapQuoterV2: 559478315000592720989748010348495519536007655966n;
     };
     readonly 11155111: {
         readonly ensSubdomainKey: "sepolia-tornado";
@@ -553,8 +650,7 @@ declare const TornadoCashConfigs: {
             readonly address: 368418168928372787409224158240737522620871644738n;
         };
         readonly weth: 1461358721292675304620367034492138750323989506836n;
-        readonly uniswapQuoterV2: 1353730886217084326490181093487957540173111046067n;
     };
 };
 
-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, TornadoPaymasterConfigs, 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 };