@permissionless-technologies/upp-sdk 0.4.22 → 0.5.0

package/dist/{index-AooYZ0kF.d.cts → index-brLSTa0y.d.cts}

@@ -1,5 +1,5 @@
 import { PublicClient, WalletClient, Address, Hex } from 'viem';
-import { B as ShieldParams, m as Note, $ as TransferParams, M as MergeParams, a5 as WithdrawParams, E as EncryptedNote } from './transfer-BhB-UuBP.cjs';
+import { B as ShieldParams, m as Note, $ as TransferParams, M as MergeParams, a5 as WithdrawParams, E as EncryptedNote } from './transfer-p-NXHdGY.cjs';
 import { M as MasterKeys, O as OneTimeKeys, b as StarkMasterKeys } from './types-CJSbxv4q.cjs';
 import { a as M31Digest } from './keccak-m31-B_AqBbRF.cjs';
 import { P as Point } from './merkle-mteVOlDf.cjs';
@@ -275,6 +275,183 @@ declare function generateStarkStealthAddress(keys: StarkMasterKeys, chainId?: nu
  */
 declare function detectAddressType(address: string): 'snark' | 'stark' | 'unknown';
 
+/**
+ * Deployment Configuration Loader
+ *
+ * Loads contract addresses based on chain ID.
+ * Built-in: Anvil (31337) and Sepolia (11155111).
+ * Custom chains can be registered at runtime via registerDeployment().
+ */
+
+/**
+ * Verifier contract addresses
+ */
+interface VerifierAddresses {
+    Transfer: Address;
+    Merge: Address;
+    Withdraw: Address;
+    JoinSplit?: Address;
+    MergeTransfer2x2?: Address;
+    MergeTransfer4x2?: Address;
+    /** @deprecated Use `Transfer` */
+    TransferVerifier?: Address;
+    /** @deprecated Use `Merge` */
+    MergeVerifier?: Address;
+    /** @deprecated Use `Withdraw` */
+    WithdrawVerifier?: Address;
+}
+/**
+ * STARK verifier contract addresses
+ */
+interface StarkVerifierAddresses {
+    CircleStarkVerifier?: Address;
+}
+/**
+ * Implementation addresses for UUPS proxies (for upgrade verification)
+ */
+interface ImplementationAddresses {
+    UniversalPrivatePool?: Address;
+    ASPRegistryHub?: Address;
+    UPPSwapModule?: Address;
+}
+/**
+ * Deployment configuration for a chain
+ */
+interface DeploymentConfig {
+    /** Universal Private Pool contract address (proxy) */
+    UniversalPrivatePool: Address;
+    /** ASP Registry Hub contract address (proxy) */
+    ASPRegistryHub: Address;
+    /** UPP Swap Module contract address (proxy) */
+    UPPSwapModule?: Address;
+    /** Implementation addresses for UUPS proxies */
+    implementations?: ImplementationAddresses;
+    /** Test token address (local/testnet) */
+    TestToken?: Address;
+    /** Test token 2 address — bonding curve token (local/testnet) */
+    TestToken2?: Address;
+    /** Verifier contract addresses */
+    verifiers: VerifierAddresses;
+    /** STARK verifier contract addresses */
+    starkVerifiers?: StarkVerifierAddresses;
+    /** Chain ID */
+    chainId: number;
+    /** Block number when contracts were deployed (for efficient scanning) */
+    deployBlock: number;
+    /** Timestamp when contracts were deployed */
+    deployTimestamp?: number;
+}
+/**
+ * Get deployment config for a chain
+ *
+ * @param chainId - Chain ID to get deployment for
+ * @returns Deployment config or null if not found
+ *
+ * @example
+ * ```ts
+ * const deployment = getDeployment(31337)
+ * if (deployment) {
+ *   console.log('Pool address:', deployment.UniversalPrivatePool)
+ * }
+ * ```
+ */
+declare function getDeployment(chainId: number): DeploymentConfig | null;
+/**
+ * Get deployment config or throw if not found
+ *
+ * @param chainId - Chain ID to get deployment for
+ * @returns Deployment config
+ * @throws Error if deployment not found
+ */
+declare function getDeploymentOrThrow(chainId: number): DeploymentConfig;
+/**
+ * Check if a chain has a deployment
+ */
+declare function hasDeployment(chainId: number): boolean;
+/**
+ * Get all supported chain IDs
+ */
+declare function getSupportedChainIds(): number[];
+/**
+ * Get the token address for a chain
+ */
+declare function getTokenAddress(chainId: number): Address | null;
+/**
+ * Register a deployment for a custom chain at runtime.
+ *
+ * Use this when deploying your own pool on a chain not built into the SDK.
+ * Overrides any existing deployment for the same chainId.
+ *
+ * @example
+ * ```ts
+ * registerDeployment(8453, {
+ *   UniversalPrivatePool: '0x...',
+ *   ASPRegistryHub: '0x...',
+ *   verifiers: { Transfer: '0x...', Merge: '0x...', Withdraw: '0x...' },
+ *   chainId: 8453,
+ *   deployBlock: 12345678,
+ * })
+ * ```
+ */
+declare function registerDeployment(chainId: number, config: DeploymentConfig): void;
+
+/**
+ * UPP Deployment Verification — Check on-chain state matches deployment config.
+ *
+ * Verifies:
+ * 1. Bytecode exists at proxy and implementation addresses
+ * 2. UUPS proxy implementation slots point to expected implementations
+ *
+ * Use `verifyDeployment()` for comprehensive checks, or `checkImplementation()`
+ * for a lightweight proxy-vs-expected check suitable for UI warnings.
+ */
+
+interface VerificationCheck {
+    name: string;
+    passed: boolean;
+    expected?: string;
+    actual?: string;
+}
+interface VerificationResult {
+    chainId: number;
+    checks: VerificationCheck[];
+    passed: number;
+    failed: number;
+    allPassed: boolean;
+}
+/**
+ * Lightweight check: does the on-chain proxy point to the expected implementation?
+ *
+ * Returns `true` if the implementation matches, `false` if it doesn't or can't be read.
+ * Use this in UI code to warn users about outdated deployments.
+ *
+ * @example
+ * ```ts
+ * import { checkImplementation, getDeploymentOrThrow } from '@permissionless-technologies/upp-sdk'
+ *
+ * const deployment = getDeploymentOrThrow(11155111)
+ * const ok = await checkImplementation(publicClient, deployment, 'UniversalPrivatePool')
+ * if (!ok) {
+ *   console.warn('Pool implementation has been upgraded — SDK may be outdated')
+ * }
+ * ```
+ */
+declare function checkImplementation(publicClient: PublicClient, deployment: DeploymentConfig, contract: 'UniversalPrivatePool' | 'ASPRegistryHub'): Promise<boolean>;
+/**
+ * Full deployment verification — checks bytecode existence and proxy implementations.
+ *
+ * @example
+ * ```ts
+ * const result = await verifyDeployment(publicClient, deployment)
+ * if (!result.allPassed) {
+ *   for (const check of result.checks.filter(c => !c.passed)) {
+ *     console.error(`FAIL: ${check.name}`, check.expected, check.actual)
+ *   }
+ * }
+ * ```
+ */
+declare function verifyDeployment(publicClient: PublicClient, deployment: DeploymentConfig): Promise<VerificationResult>;
+
 /**
  * Indexer Types
  *
@@ -780,4 +957,4 @@ declare class NoteStore implements INoteStore {
     private notify;
 }
 
-export { ADDRESS_VERSION as A, decodeStealthAddress as B, type CommitmentInsertedArgs as C, DirectAccountAdapter as D, decryptNote as E, detectAddressType as F, encodeStarkStealthAddress as G, encodeStealthAddress as H, type Indexer as I, encryptNote as J, generateStarkStealthAddress as K, type LiveSyncConfig as L, generateStealthAddress as M, type NoteStatus$1 as N, isValidStarkStealthAddress as O, type ProofSystem as P, isValidStealthAddress as Q, type RpcIndexerConfig as R, type StorageAdapter as S, verifyOwnership as T, type UPPClient as U, type NoteStatus as V, type IndexedNote as a, type NoteFilters as b, type SyncResult as c, type SyncProgress as d, type SyncConfig as e, type IndexerState as f, type SyncState as g, type SerializedNote as h, type StealthTransactArgs as i, type NullifiedArgs as j, type ASPMembershipProof as k, type IASPProvider as l, type IAccountAdapter as m, type INoteStore as n, NoteStore as o, STARK_ADDRESS_VERSION as p, STARK_STEALTH_ADDRESS_PREFIX as q, STEALTH_ADDRESS_PREFIX as r, type ShieldedNote as s, StorableAccountAdapter as t, type UPPClientConfig as u, computeNoteEncryptionKey as v, createNote as w, createOneTimeKeys as x, createUPPClient as y, decodeStarkStealthAddress as z };
+export { hasDeployment as $, ADDRESS_VERSION as A, createNote as B, type CommitmentInsertedArgs as C, type DeploymentConfig as D, createOneTimeKeys as E, createUPPClient as F, decodeStarkStealthAddress as G, decodeStealthAddress as H, type Indexer as I, decryptNote as J, detectAddressType as K, type LiveSyncConfig as L, encodeStarkStealthAddress as M, type NoteStatus$1 as N, encodeStealthAddress as O, type ProofSystem as P, encryptNote as Q, type RpcIndexerConfig as R, type StorageAdapter as S, generateStarkStealthAddress as T, type UPPClient as U, type VerificationCheck as V, generateStealthAddress as W, getDeployment as X, getDeploymentOrThrow as Y, getSupportedChainIds as Z, getTokenAddress as _, type IndexedNote as a, isValidStarkStealthAddress as a0, isValidStealthAddress as a1, registerDeployment as a2, verifyDeployment as a3, verifyOwnership as a4, type NoteStatus as a5, type NoteFilters as b, type SyncResult as c, type SyncProgress as d, type SyncConfig as e, type IndexerState as f, type SyncState as g, type SerializedNote as h, type StealthTransactArgs as i, type NullifiedArgs as j, type ASPMembershipProof as k, DirectAccountAdapter as l, type IASPProvider as m, type IAccountAdapter as n, type INoteStore as o, NoteStore as p, STARK_ADDRESS_VERSION as q, STARK_STEALTH_ADDRESS_PREFIX as r, STEALTH_ADDRESS_PREFIX as s, type ShieldedNote as t, StorableAccountAdapter as u, type UPPClientConfig as v, type VerificationResult as w, type VerifierAddresses as x, checkImplementation as y, computeNoteEncryptionKey as z };