@0xbow/privacy-pools-core-sdk 0.1.21 → 0.1.22

package/dist/node/index.mjs

@@ -1,4 +1,4 @@
-export { n as AccountError, A as AccountService, B as BlockchainProvider, o as CircuitName, j as Circuits, C as CommitmentService, m as ContractError, k as ContractInteractionsService, D as DataService, E as ErrorCode, I as InvalidRpcUrl, P as PrivacyPoolSDK, l as ProofError, S as SDKError, W as WithdrawalService, e as bigintToHash, f as bigintToHex, i as calculateContext, a as generateDepositSecrets, g as generateMasterKeys, d as generateMerkleProof, b as generateWithdrawalSecrets, c as getCommitment, h as hashPrecommitment } from './index-CwopFzOC.js';
+export { n as AccountError, A as AccountService, B as BlockchainProvider, o as CircuitName, j as Circuits, C as CommitmentService, m as ContractError, k as ContractInteractionsService, D as DataService, E as ErrorCode, I as InvalidRpcUrl, P as PrivacyPoolSDK, l as ProofError, S as SDKError, W as WithdrawalService, e as bigintToHash, f as bigintToHex, i as calculateContext, a as generateDepositSecrets, g as generateMasterKeys, d as generateMerkleProof, b as generateWithdrawalSecrets, c as getCommitment, h as hashPrecommitment } from './index-C0m_hCj-.js';
 import 'viem/accounts';
 import 'buffer';
 import 'http';

package/dist/types/core/account.service.d.ts

@@ -2,7 +2,12 @@ import { Hash, Secret } from "../types/commitment.js";
 import { Hex } from "viem";
 import { DataService } from "./data.service.js";
 import { AccountCommitment, PoolAccount, PoolInfo, PrivacyPoolAccount } from "../types/account.js";
-import { RagequitEvent } from "../types/events.js";
+import { DepositEvent, PoolEventsError, PoolEventsResult, RagequitEvent, WithdrawalEvent } from "../types/events.js";
+type AccountServiceConfig = {
+    mnemonic: string;
+} | {
+    account: PrivacyPoolAccount;
+};
 /**
  * Service responsible for managing privacy pool accounts and their associated commitments.
  * Handles account initialization, deposit/withdrawal tracking, and history synchronization.
@@ -19,12 +24,13 @@ export declare class AccountService {
      * Creates a new AccountService instance.
      *
      * @param dataService - Service for fetching on-chain events
-     * @param account - Optional existing account to initialize with
-     * @param mnemonic - Optional mnemonic for deterministic key generation
+     * @param config - Configuration for the account service (either mnemonic or existing account)
+     * @param config.mnemonic - Optional mnemonic for deterministic key generation
+     * @param config.account - Optional existing account to initialize with
      *
      * @throws {AccountError} If account initialization fails
      */
-    constructor(dataService: DataService, mnemonic: string, account?: PrivacyPoolAccount);
+    constructor(dataService: DataService, config: AccountServiceConfig);
     /**
      * Initializes a new account from a mnemonic phrase.
      *
@@ -193,6 +199,111 @@ export declare class AccountService {
      */
     addRagequitToAccount(label: Hash, ragequit: RagequitEvent): PoolAccount;
     /**
+     * Fetches deposit events for a given pool and returns a map of precommitments to their events for efficient lookup
+     *
+     * @param pool - The pool to fetch deposit events for
+     *
+     * @returns A map of precommitments to their events
+     */
+    getDepositEvents(pool: PoolInfo): Promise<Map<Hash, DepositEvent>>;
+    /**
+     * Fetches withdrawal events for a given pool and returns a map of spent nullifiers to their events for efficient lookup
+     *
+     * @param pool - The pool to fetch withdrawal events for
+     *
+     * @returns A map of spent nullifiers to their events
+     */
+    getWithdrawalEvents(pool: PoolInfo): Promise<Map<Hash, WithdrawalEvent>>;
+    /**
+     * Fetches ragequit events for a given pool and returns a map of ragequit labels to their events for efficient lookup
+     *
+     * @param pool - The pool to fetch ragequit events for
+     *
+     * @returns A map of ragequit labels to their events
+     */
+    getRagequitEvents(pool: PoolInfo): Promise<Map<Hash, RagequitEvent>>;
+    /**
+     * Fetches events for a given set of pools
+     *
+     * @param pools - The pools to fetch events for
+     *
+     * @returns A map of pool scopes to their events
+     */
+    getEvents(pools: PoolInfo[]): Promise<PoolEventsResult>;
+    /**
+     * Processes deposit events for a given scope and adds them to the account
+     * Deterministically generate deposit secrets and check if they match on-chain deposits
+     *
+     * @param scope - The scope of the pool
+     * @param depositEvents - The map of deposit events
+     *
+     */
+    private _processDepositEvents;
+    /**
+     * Processes withdrawal events for a given scope and adds them to the account
+     *
+     * @param scope - The scope of the pool
+     * @param withdrawalEvents - The map of withdrawal events
+     *
+     * @remarks
+     * This method performs the following steps for each pool:
+     * 1. Identifies the earliest deposit block for each scope
+     * 2. For each account, reconstructs the withdrawal history by:
+     *    - Generating nullifiers sequentially
+     *    - Matching them against on-chain events
+     *    - Adding matched withdrawals to the account state
+     *
+     * @throws {DataError} If event fetching fails
+     * @private
+     *
+     */
+    private _processWithdrawalEvents;
+    /**
+     * Processes ragequit events for a given scope and adds them to the account
+     *
+     * @param scope - The scope of the pool
+     * @param ragequitEvents - The map of ragequit events
+     *
+     * @remarks
+     * This method performs the following steps for each pool:
+     * 1. Adds ragequit events to accounts if found
+     *
+     * @throws {DataError} If event fetching fails
+     * @private
+     *
+     */
+    private _processRagequitEvents;
+    /**
+     * Initializes an AccountService instance with events for a given set of pools
+     *
+     * @param dataService - The data service to use for fetching events
+     * @param source - The source to use for initializing the account. Either a mnemonic or an existing account service instance
+     * @param pools - The pools to fetch events for
+     *
+     * @remarks
+     * This method performs the following steps for each pool:
+     * 1. Fetches deposit, withdrawal, and ragequit events for each pool
+     * 2. Processes deposit events and creates pool accounts
+     * 3. Processes withdrawal events and adds commitments to pool accounts
+     * 4. Processes ragequit events and adds ragequit to pool accounts
+     *
+     * @returns The initialized AccountService instance and array of errors if any pool events fetching fails
+     *
+     * if any pool events fetching fails, the account will be initialized without the events for that pool
+     * user can then call to this method again with the same account and missing pools to fetch the missing events
+     *
+     * @throws {AccountError} If account state reconstruction fails or if duplicate pools are found
+     */
+    static initializeWithEvents(dataService: DataService, source: {
+        mnemonic: string;
+    } | {
+        service: AccountService;
+    }, pools: PoolInfo[]): Promise<{
+        account: AccountService;
+        errors: PoolEventsError[];
+    }>;
+    /**
+     * @deprecated Use `initializeWithEvents` for instantiating an account with history reconstruction
      * Retrieves the history of deposits and withdrawals for the given pools.
      *
      * @param pools - Array of pool configurations to sync history for
@@ -231,3 +342,4 @@ export declare class AccountService {
      */
     private _processWithdrawalsAndRagequits;
 }
+export {};

package/dist/types/core/contracts.service.d.ts

@@ -1,6 +1,6 @@
 import { Address, Chain, Hex } from "viem";
 import { Withdrawal, WithdrawalProof } from "../types/withdrawal.js";
-import { ContractInteractions, TransactionResponse } from "../interfaces/contracts.interface.js";
+import { AssetConfig, ContractInteractions, TransactionResponse } from "../interfaces/contracts.interface.js";
 import { CommitmentProof, Hash } from "../types/commitment.js";
 export declare class ContractInteractionsService implements ContractInteractions {
     private publicClient;
@@ -80,6 +80,14 @@ export declare class ContractInteractionsService implements ContractInteractions
      * @returns The size of the state tree as a bigint.
      */
     getStateSize(privacyPoolAddress: Address): Promise<bigint>;
+    /**
+     * Retrieves data from the corresponding asset
+     *
+     * @param assetAddress - The asset contract address.
+     * @returns AssetConfig - An object containing the privacy pool address, minimum deposit amount, vetting fee and maximum relaying fee.
+     * @throws ContractError if the asset does not exist in the pool.
+     */
+    getAssetConfig(assetAddress: Address): Promise<AssetConfig>;
     /**
      * Retrieves data about a specific scope, including the associated privacy pool
      * and the asset used in that pool.

package/dist/types/core/sdk.d.ts

@@ -3,6 +3,7 @@ import { Commitment, CommitmentProof } from "../types/commitment.js";
 import { WithdrawalProof, WithdrawalProofInput } from "../types/withdrawal.js";
 import { ContractInteractionsService } from "./contracts.service.js";
 import { Hex, Address, Chain } from "viem";
+import { AccountCommitment } from "../types/account.js";
 /**
  * Main SDK class providing access to all privacy pool functionality.
  * Uses Poseidon hash for all commitment operations.
@@ -34,7 +35,7 @@ export declare class PrivacyPoolSDK {
      * @param input - Input parameters for the withdrawal
      * @param withdrawal - Withdrawal details
      */
-    proveWithdrawal(commitment: Commitment, input: WithdrawalProofInput): Promise<WithdrawalProof>;
+    proveWithdrawal(commitment: Commitment | AccountCommitment, input: WithdrawalProofInput): Promise<WithdrawalProof>;
     /**
      * Verifies a withdrawal proof.
      *

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

@@ -1,6 +1,6 @@
 import { CircuitsInterface } from "../interfaces/circuits.interface.js";
-import { Commitment } from "../types/commitment.js";
 import { WithdrawalProof, WithdrawalProofInput } from "../types/withdrawal.js";
+import { AccountCommitment, Commitment } from "../index.js";
 /**
  * Service responsible for handling withdrawal-related operations.
  */
@@ -16,7 +16,7 @@ export declare class WithdrawalService {
      * @returns Promise resolving to withdrawal payload
      * @throws {ProofError} If proof generation fails
      */
-    proveWithdrawal(commitment: Commitment, input: WithdrawalProofInput): Promise<WithdrawalProof>;
+    proveWithdrawal(commitment: Commitment | AccountCommitment, input: WithdrawalProofInput): Promise<WithdrawalProof>;
     /**
      * Verifies a withdrawal proof.
      *

package/dist/types/errors/account.error.d.ts

@@ -5,4 +5,6 @@ export declare class AccountError extends SDKError {
     static commitmentNotFound(hash: Hash | string): AccountError;
     static invalidPoolAccount(): AccountError;
     static accountInitializationFailed(reason: string): AccountError;
+    static duplicatePools(scope: bigint): AccountError;
+    static invalidIndex(index: bigint): AccountError;
 }

package/dist/types/errors/base.error.d.ts

@@ -49,4 +49,5 @@ export declare class ProofError extends SDKError {
 export declare class ContractError extends SDKError {
     constructor(message: string, code?: ErrorCode, details?: Record<string, unknown>);
     static scopeNotFound(scope: bigint): ContractError;
+    static assetNotFound(address: string): ContractError;
 }

package/dist/types/errors/events.error.d.ts

@@ -0,0 +1,9 @@
+import { ErrorCode } from "./base.error.js";
+import { DataError } from "./data.error.js";
+import { Hash } from "../types/commitment.js";
+export declare class EventError extends DataError {
+    constructor(message: string, code?: ErrorCode, details?: Record<string, unknown>);
+    static depositEventError(chainId: number, scope: Hash, error: Error): EventError;
+    static withdrawalEventError(chainId: number, scope: Hash, error: Error): EventError;
+    static ragequitEventError(chainId: number, scope: Hash, error: Error): EventError;
+}

package/dist/types/{fetchArtifacts.esm-CxFhH8oR.js → fetchArtifacts.esm-BgiOz4v6.js}

@@ -1,4 +1,4 @@
-import { F as FetchArtifact } from './index-CIvuCHHq.js';
+import { F as FetchArtifact } from './index-oyPK96A0.js';
 import 'viem/accounts';
 import 'buffer';
 import 'http';

package/dist/types/{fetchArtifacts.node-Cqk_Z-mS.js → fetchArtifacts.node-t3dhlGoF.js}

@@ -1,4 +1,4 @@
-import { F as FetchArtifact } from './index-CIvuCHHq.js';
+import { F as FetchArtifact } from './index-oyPK96A0.js';
 import 'viem/accounts';
 import 'buffer';
 import 'http';