@permissionless-technologies/upp-sdk 0.5.5 → 0.5.6

package/dist/react/index.d.cts

@@ -1,13 +1,145 @@
-import { aI as NoteCreationResult, r as ProofWorkerManager, j as DownloadProgress, aJ as PlonkProofStruct, aK as ShieldedNote, a0 as TransferStage, P as PlonkProvingStage, X as SwapOrderEvent, a2 as UPPCircuitType, f as CircuitCacheStatus } from '../transfer-p-NXHdGY.cjs';
-export { A as ASPProof, aR as ASP_TREE_DEPTH, C as CIRCUIT_CDN_BASE, c as CIRCUIT_VERSION, d as CircuitArtifactCache, aP as IndexerConfig, aO as ProofSystemType, aQ as SignTypedDataFn, aN as UPPAccountContextType, aM as UPPAccountProvider, a6 as buildASPTree, ac as computeMultiOriginASPRoot, af as computeSingleOriginASPRoot, ao as generateASPProof, aq as generateMultiOriginASPProof, as as generateSingleOriginASPProof, av as generateUPPProofAsync, aL as useUPPAccount } from '../transfer-p-NXHdGY.cjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { CSSProperties } from 'react';
+import { ReactNode, CSSProperties } from 'react';
+import { Hex, Address, PublicClient } from 'viem';
+import { M as MasterKeys, b as StarkMasterKeys } from '../types-CJSbxv4q.cjs';
+import { H as ShieldedNote, aL as NoteCreationResult, s as ProofSystem, t as ProofWorkerManager, j as DownloadProgress, aM as PlonkProofStruct, a3 as TransferStage, P as PlonkProvingStage, _ as SwapOrderEvent, a5 as UPPCircuitType, f as CircuitCacheStatus } from '../transfer-C1XU_z-6.cjs';
+export { A as ASPProof, aN as ASP_TREE_DEPTH, C as CIRCUIT_CDN_BASE, c as CIRCUIT_VERSION, d as CircuitArtifactCache, a9 as buildASPTree, af as computeMultiOriginASPRoot, ai as computeSingleOriginASPRoot, ar as generateASPProof, at as generateMultiOriginASPProof, av as generateSingleOriginASPProof, ay as generateUPPProofAsync } from '../transfer-C1XU_z-6.cjs';
 import { P as Point } from '../merkle-mteVOlDf.cjs';
-import { Address, Hex, PublicClient } from 'viem';
 import '../keccak-m31-B_AqBbRF.cjs';
 import '@permissionless-technologies/upc-sdk';
-import '../types-CJSbxv4q.cjs';
+
+/**
+ * EIP-712 Constants for UPP wallet signing
+ *
+ * Used by UPPAccountProvider to derive private keys from wallet signatures.
+ */
+
+/**
+ * Function signature for EIP-712 typed data signing.
+ * Compatible with wagmi's signTypedDataAsync.
+ */
+type SignTypedDataFn = (args: {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+    };
+    types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>;
+    primaryType: string;
+    message: Record<string, unknown>;
+}) => Promise<Hex>;
+
+/** @deprecated Use ProofSystem from core/types.ts */
+type ProofSystemType = ProofSystem;
+/**
+ * Indexer configuration for advanced usage
+ */
+interface IndexerConfig {
+    /** Enable IndexedDB storage (default: true if available) */
+    useIndexedDB?: boolean;
+    /** Custom storage prefix for multi-account support */
+    storagePrefix?: string;
+    /** Batch size for RPC scanning (default: 200, adapts on rate limits) */
+    batchSize?: number;
+    /** Sync interval for live sync in ms (default: 30000) */
+    liveSyncIntervalMs?: number;
+    /** Starting block for new accounts (skips blocks before account creation) */
+    fromBlock?: number;
+    /** Pool contract address (required for indexer) */
+    contractAddress?: Address;
+    /** UPPSwapModule proxy address (swap events come from this contract, not the pool) */
+    swapModuleAddress?: Address;
+}
+/**
+ * Context type for UPP Account
+ */
+interface UPPAccountContextType {
+    /** SNARK master keys (null if not setup) */
+    masterKeys: MasterKeys | null;
+    /** STARK master keys (null if not setup) */
+    starkMasterKeys: StarkMasterKeys | null;
+    /** Connected wallet address */
+    ethAddress: string | null;
+    /** Owner hash (public identifier, hex) — SNARK */
+    ownerHash: string | null;
+    /** Stealth address (bech32m encoded, 0zk prefix) — SNARK */
+    stealthAddress: string | null;
+    /** STARK stealth address (bech32m encoded, 0zs prefix) */
+    starkStealthAddress: string | null;
+    /** All notes */
+    notes: ShieldedNote[];
+    /** Unspent notes */
+    unspentNotes: ShieldedNote[];
+    /** Total balance of unspent notes */
+    balance: bigint;
+    /** Whether account is set up */
+    isSetup: boolean;
+    /** Whether SDK is loading/initializing */
+    isLoading: boolean;
+    /** Whether crypto is ready */
+    cryptoReady: boolean;
+    /** Whether sync is in progress */
+    isSyncing: boolean;
+    /** Last synced block number */
+    lastSyncedBlock: number;
+    /** Set up a new account from wallet signature (low-level) */
+    setupAccount: (signature: Hex) => Promise<void>;
+    /** Connect private account via EIP-712 wallet signature (requires wagmi signTypedData) */
+    connect: (password?: string) => Promise<void>;
+    /** Whether a connect operation is in progress */
+    isConnecting: boolean;
+    /** Clear account and logout */
+    logout: () => void;
+    /** Alias for logout */
+    disconnect: () => void;
+    /** Add a note to the account */
+    addNote: (note: ShieldedNote) => void;
+    /** Mark a note as spent */
+    markNoteSpent: (commitment: string) => void;
+    /** Create note for self (e.g., shield or change output) */
+    createNoteForSelf: (amount: bigint, origin: bigint, token: bigint) => Promise<NoteCreationResult>;
+    /** Get owner hash */
+    getOwnerHash: () => bigint | null;
+    /** Select optimal circuit for a given amount */
+    selectOptimalCircuit: (requiredAmount: bigint, tokenAddress?: string) => {
+        circuit: '1x2' | '2x2' | null;
+        selectedNotes: ShieldedNote[];
+        error?: string;
+    };
+    /** Sync notes from blockchain (requires client to be passed in) */
+    syncNotes: (contractAddress: Address, client: any) => Promise<number>;
+    /** Start live sync (polls for new notes at interval) */
+    startLiveSync: (contractAddress: Address, client: any) => void;
+    /** Stop live sync */
+    stopLiveSync: () => void;
+    /** Whether live sync is active */
+    isLiveSyncing: boolean;
+}
+
+interface UPPAccountProviderProps {
+    children: ReactNode;
+    /** Ethereum address of connected wallet */
+    ethAddress?: string;
+    /** Chain ID */
+    chainId?: number;
+    /** Indexer configuration */
+    indexerConfig?: IndexerConfig;
+    /** EIP-712 signing function (from wagmi's useSignTypedData().signTypedDataAsync) */
+    signTypedData?: SignTypedDataFn;
+    /** Public client for chain fingerprint validation (e.g. from wagmi usePublicClient) */
+    publicClient?: any;
+    /** Active proof system — filters unspentNotes and balance to only show spendable notes */
+    activeProofSystem?: ProofSystem;
+}
+declare function UPPAccountProvider({ children, ethAddress, chainId, indexerConfig, signTypedData, publicClient: publicClientProp, activeProofSystem, }: UPPAccountProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access UPP Account context
+ */
+declare function useUPPAccount(): UPPAccountContextType;
 
 interface UPPPrivateButtonProps {
     /** Additional inline styles for the outer button */
@@ -903,4 +1035,4 @@ interface UsePrivateBalanceReturn {
 }
 declare function usePrivateBalance(config: PrivateBalanceConfig): UsePrivateBalanceReturn;
 
-export { type AvatarData, type AvatarShape, type CancelOrderBuildData, type CancelOrderParams, CircuitCacheStatus, type ClaimOrderBuildData, type ClaimOrderParams, DownloadProgress, type FillOrderBuildData, type FillOrderParams, NoteCreationResult, type PersonalASPConfig, type PersonalASPInfo, type PlaceOrderBuildData, type PlaceOrderParams, PlonkProvingStage, type PoolTransferBuildData, type PoolTransferConfig, type PoolTransferParams, type PrivateBalanceConfig, ProofWorkerManager, type ShieldBuildData, type ShieldConfig, type ShieldParams, ShieldedNote, type SplitNoteBuildData, type SplitNoteParams, type SwapConfig, type SwapOrderBookConfig, type SwapStage, type TokenBalanceEntry, type TokenListItem, TransferStage, UPPAvatar, type UPPAvatarProps, UPPModal, type UPPModalProps, UPPPrivateButton, type UPPPrivateButtonProps, type UseCircuitCacheReturn, type UsePersonalASPReturn, type UsePoolTransferReturn, type UsePrivateBalanceReturn, type UseShieldReturn, type UseSwapOrderBookReturn, type UseSwapReturn, type UseWithdrawReturn, type WithdrawBuildData, type WithdrawConfig, type WithdrawParams, generateAvatarData, renderAvatarSVG, storePersonalASPId, useCircuitCache, usePersonalASP, usePoolTransfer, usePrivateBalance, useProofWorker, useShield, useSwap, useSwapOrderBook, useUPPCrypto, useWithdraw };
+export { type AvatarData, type AvatarShape, type CancelOrderBuildData, type CancelOrderParams, CircuitCacheStatus, type ClaimOrderBuildData, type ClaimOrderParams, DownloadProgress, type FillOrderBuildData, type FillOrderParams, type IndexerConfig, NoteCreationResult, type PersonalASPConfig, type PersonalASPInfo, type PlaceOrderBuildData, type PlaceOrderParams, PlonkProvingStage, type PoolTransferBuildData, type PoolTransferConfig, type PoolTransferParams, type PrivateBalanceConfig, ProofSystem, type ProofSystemType, ProofWorkerManager, type ShieldBuildData, type ShieldConfig, type ShieldParams, ShieldedNote, type SignTypedDataFn, type SplitNoteBuildData, type SplitNoteParams, type SwapConfig, type SwapOrderBookConfig, type SwapStage, type TokenBalanceEntry, type TokenListItem, TransferStage, type UPPAccountContextType, UPPAccountProvider, UPPAvatar, type UPPAvatarProps, UPPModal, type UPPModalProps, UPPPrivateButton, type UPPPrivateButtonProps, type UseCircuitCacheReturn, type UsePersonalASPReturn, type UsePoolTransferReturn, type UsePrivateBalanceReturn, type UseShieldReturn, type UseSwapOrderBookReturn, type UseSwapReturn, type UseWithdrawReturn, type WithdrawBuildData, type WithdrawConfig, type WithdrawParams, generateAvatarData, renderAvatarSVG, storePersonalASPId, useCircuitCache, usePersonalASP, usePoolTransfer, usePrivateBalance, useProofWorker, useShield, useSwap, useSwapOrderBook, useUPPAccount, useUPPCrypto, useWithdraw };

package/dist/react/index.d.ts

@@ -1,13 +1,145 @@
-import { aI as NoteCreationResult, r as ProofWorkerManager, j as DownloadProgress, aJ as PlonkProofStruct, aK as ShieldedNote, a0 as TransferStage, P as PlonkProvingStage, X as SwapOrderEvent, a2 as UPPCircuitType, f as CircuitCacheStatus } from '../transfer-BxiDgCvx.js';
-export { A as ASPProof, aR as ASP_TREE_DEPTH, C as CIRCUIT_CDN_BASE, c as CIRCUIT_VERSION, d as CircuitArtifactCache, aP as IndexerConfig, aO as ProofSystemType, aQ as SignTypedDataFn, aN as UPPAccountContextType, aM as UPPAccountProvider, a6 as buildASPTree, ac as computeMultiOriginASPRoot, af as computeSingleOriginASPRoot, ao as generateASPProof, aq as generateMultiOriginASPProof, as as generateSingleOriginASPProof, av as generateUPPProofAsync, aL as useUPPAccount } from '../transfer-BxiDgCvx.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { CSSProperties } from 'react';
+import { ReactNode, CSSProperties } from 'react';
+import { Hex, Address, PublicClient } from 'viem';
+import { M as MasterKeys, b as StarkMasterKeys } from '../types-mLybMxNR.js';
+import { H as ShieldedNote, aL as NoteCreationResult, s as ProofSystem, t as ProofWorkerManager, j as DownloadProgress, aM as PlonkProofStruct, a3 as TransferStage, P as PlonkProvingStage, _ as SwapOrderEvent, a5 as UPPCircuitType, f as CircuitCacheStatus } from '../transfer-DgjxZlR7.js';
+export { A as ASPProof, aN as ASP_TREE_DEPTH, C as CIRCUIT_CDN_BASE, c as CIRCUIT_VERSION, d as CircuitArtifactCache, a9 as buildASPTree, af as computeMultiOriginASPRoot, ai as computeSingleOriginASPRoot, ar as generateASPProof, at as generateMultiOriginASPProof, av as generateSingleOriginASPProof, ay as generateUPPProofAsync } from '../transfer-DgjxZlR7.js';
 import { P as Point } from '../merkle-mteVOlDf.js';
-import { Address, Hex, PublicClient } from 'viem';
 import '../keccak-m31-B_AqBbRF.js';
 import '@permissionless-technologies/upc-sdk';
-import '../types-mLybMxNR.js';
+
+/**
+ * EIP-712 Constants for UPP wallet signing
+ *
+ * Used by UPPAccountProvider to derive private keys from wallet signatures.
+ */
+
+/**
+ * Function signature for EIP-712 typed data signing.
+ * Compatible with wagmi's signTypedDataAsync.
+ */
+type SignTypedDataFn = (args: {
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+    };
+    types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>;
+    primaryType: string;
+    message: Record<string, unknown>;
+}) => Promise<Hex>;
+
+/** @deprecated Use ProofSystem from core/types.ts */
+type ProofSystemType = ProofSystem;
+/**
+ * Indexer configuration for advanced usage
+ */
+interface IndexerConfig {
+    /** Enable IndexedDB storage (default: true if available) */
+    useIndexedDB?: boolean;
+    /** Custom storage prefix for multi-account support */
+    storagePrefix?: string;
+    /** Batch size for RPC scanning (default: 200, adapts on rate limits) */
+    batchSize?: number;
+    /** Sync interval for live sync in ms (default: 30000) */
+    liveSyncIntervalMs?: number;
+    /** Starting block for new accounts (skips blocks before account creation) */
+    fromBlock?: number;
+    /** Pool contract address (required for indexer) */
+    contractAddress?: Address;
+    /** UPPSwapModule proxy address (swap events come from this contract, not the pool) */
+    swapModuleAddress?: Address;
+}
+/**
+ * Context type for UPP Account
+ */
+interface UPPAccountContextType {
+    /** SNARK master keys (null if not setup) */
+    masterKeys: MasterKeys | null;
+    /** STARK master keys (null if not setup) */
+    starkMasterKeys: StarkMasterKeys | null;
+    /** Connected wallet address */
+    ethAddress: string | null;
+    /** Owner hash (public identifier, hex) — SNARK */
+    ownerHash: string | null;
+    /** Stealth address (bech32m encoded, 0zk prefix) — SNARK */
+    stealthAddress: string | null;
+    /** STARK stealth address (bech32m encoded, 0zs prefix) */
+    starkStealthAddress: string | null;
+    /** All notes */
+    notes: ShieldedNote[];
+    /** Unspent notes */
+    unspentNotes: ShieldedNote[];
+    /** Total balance of unspent notes */
+    balance: bigint;
+    /** Whether account is set up */
+    isSetup: boolean;
+    /** Whether SDK is loading/initializing */
+    isLoading: boolean;
+    /** Whether crypto is ready */
+    cryptoReady: boolean;
+    /** Whether sync is in progress */
+    isSyncing: boolean;
+    /** Last synced block number */
+    lastSyncedBlock: number;
+    /** Set up a new account from wallet signature (low-level) */
+    setupAccount: (signature: Hex) => Promise<void>;
+    /** Connect private account via EIP-712 wallet signature (requires wagmi signTypedData) */
+    connect: (password?: string) => Promise<void>;
+    /** Whether a connect operation is in progress */
+    isConnecting: boolean;
+    /** Clear account and logout */
+    logout: () => void;
+    /** Alias for logout */
+    disconnect: () => void;
+    /** Add a note to the account */
+    addNote: (note: ShieldedNote) => void;
+    /** Mark a note as spent */
+    markNoteSpent: (commitment: string) => void;
+    /** Create note for self (e.g., shield or change output) */
+    createNoteForSelf: (amount: bigint, origin: bigint, token: bigint) => Promise<NoteCreationResult>;
+    /** Get owner hash */
+    getOwnerHash: () => bigint | null;
+    /** Select optimal circuit for a given amount */
+    selectOptimalCircuit: (requiredAmount: bigint, tokenAddress?: string) => {
+        circuit: '1x2' | '2x2' | null;
+        selectedNotes: ShieldedNote[];
+        error?: string;
+    };
+    /** Sync notes from blockchain (requires client to be passed in) */
+    syncNotes: (contractAddress: Address, client: any) => Promise<number>;
+    /** Start live sync (polls for new notes at interval) */
+    startLiveSync: (contractAddress: Address, client: any) => void;
+    /** Stop live sync */
+    stopLiveSync: () => void;
+    /** Whether live sync is active */
+    isLiveSyncing: boolean;
+}
+
+interface UPPAccountProviderProps {
+    children: ReactNode;
+    /** Ethereum address of connected wallet */
+    ethAddress?: string;
+    /** Chain ID */
+    chainId?: number;
+    /** Indexer configuration */
+    indexerConfig?: IndexerConfig;
+    /** EIP-712 signing function (from wagmi's useSignTypedData().signTypedDataAsync) */
+    signTypedData?: SignTypedDataFn;
+    /** Public client for chain fingerprint validation (e.g. from wagmi usePublicClient) */
+    publicClient?: any;
+    /** Active proof system — filters unspentNotes and balance to only show spendable notes */
+    activeProofSystem?: ProofSystem;
+}
+declare function UPPAccountProvider({ children, ethAddress, chainId, indexerConfig, signTypedData, publicClient: publicClientProp, activeProofSystem, }: UPPAccountProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access UPP Account context
+ */
+declare function useUPPAccount(): UPPAccountContextType;
 
 interface UPPPrivateButtonProps {
     /** Additional inline styles for the outer button */
@@ -903,4 +1035,4 @@ interface UsePrivateBalanceReturn {
 }
 declare function usePrivateBalance(config: PrivateBalanceConfig): UsePrivateBalanceReturn;
 
-export { type AvatarData, type AvatarShape, type CancelOrderBuildData, type CancelOrderParams, CircuitCacheStatus, type ClaimOrderBuildData, type ClaimOrderParams, DownloadProgress, type FillOrderBuildData, type FillOrderParams, NoteCreationResult, type PersonalASPConfig, type PersonalASPInfo, type PlaceOrderBuildData, type PlaceOrderParams, PlonkProvingStage, type PoolTransferBuildData, type PoolTransferConfig, type PoolTransferParams, type PrivateBalanceConfig, ProofWorkerManager, type ShieldBuildData, type ShieldConfig, type ShieldParams, ShieldedNote, type SplitNoteBuildData, type SplitNoteParams, type SwapConfig, type SwapOrderBookConfig, type SwapStage, type TokenBalanceEntry, type TokenListItem, TransferStage, UPPAvatar, type UPPAvatarProps, UPPModal, type UPPModalProps, UPPPrivateButton, type UPPPrivateButtonProps, type UseCircuitCacheReturn, type UsePersonalASPReturn, type UsePoolTransferReturn, type UsePrivateBalanceReturn, type UseShieldReturn, type UseSwapOrderBookReturn, type UseSwapReturn, type UseWithdrawReturn, type WithdrawBuildData, type WithdrawConfig, type WithdrawParams, generateAvatarData, renderAvatarSVG, storePersonalASPId, useCircuitCache, usePersonalASP, usePoolTransfer, usePrivateBalance, useProofWorker, useShield, useSwap, useSwapOrderBook, useUPPCrypto, useWithdraw };
+export { type AvatarData, type AvatarShape, type CancelOrderBuildData, type CancelOrderParams, CircuitCacheStatus, type ClaimOrderBuildData, type ClaimOrderParams, DownloadProgress, type FillOrderBuildData, type FillOrderParams, type IndexerConfig, NoteCreationResult, type PersonalASPConfig, type PersonalASPInfo, type PlaceOrderBuildData, type PlaceOrderParams, PlonkProvingStage, type PoolTransferBuildData, type PoolTransferConfig, type PoolTransferParams, type PrivateBalanceConfig, ProofSystem, type ProofSystemType, ProofWorkerManager, type ShieldBuildData, type ShieldConfig, type ShieldParams, ShieldedNote, type SignTypedDataFn, type SplitNoteBuildData, type SplitNoteParams, type SwapConfig, type SwapOrderBookConfig, type SwapStage, type TokenBalanceEntry, type TokenListItem, TransferStage, type UPPAccountContextType, UPPAccountProvider, UPPAvatar, type UPPAvatarProps, UPPModal, type UPPModalProps, UPPPrivateButton, type UPPPrivateButtonProps, type UseCircuitCacheReturn, type UsePersonalASPReturn, type UsePoolTransferReturn, type UsePrivateBalanceReturn, type UseShieldReturn, type UseSwapOrderBookReturn, type UseSwapReturn, type UseWithdrawReturn, type WithdrawBuildData, type WithdrawConfig, type WithdrawParams, generateAvatarData, renderAvatarSVG, storePersonalASPId, useCircuitCache, usePersonalASP, usePoolTransfer, usePrivateBalance, useProofWorker, useShield, useSwap, useSwapOrderBook, useUPPAccount, useUPPCrypto, useWithdraw };