@aztec/wallets 0.0.1-commit.e2b2873ed → 0.0.1-commit.e57c76e

package/src/embedded/entrypoints/node.ts

@@ -1,34 +1,44 @@
 import { createAztecNodeClient } from '@aztec/aztec.js/node';
-import { createLogger } from '@aztec/foundation/log';
-import { createStore as createWalletStore, openTmpStore } from '@aztec/kv-store/lmdb-v2';
-import type { PXEConfig } from '@aztec/pxe/config';
-import { getPXEConfig } from '@aztec/pxe/config';
-import { type PXECreationOptions, createPXE } from '@aztec/pxe/server';
+import { type Logger, createLogger } from '@aztec/foundation/log';
+import { createStore, openTmpStore } from '@aztec/kv-store/lmdb-v2';
+import { type PXEConfig, getPXEConfig } from '@aztec/pxe/config';
+import { type PXE, type PXECreationOptions, createPXE } from '@aztec/pxe/server';
+import { getStandardAuthRegistry } from '@aztec/standard-contracts/auth-registry';
+import { getStandardMultiCallEntrypoint } from '@aztec/standard-contracts/multi-call-entrypoint';
 import type { AztecNode } from '@aztec/stdlib/interfaces/client';
 
 import { BundleAccountContractsProvider } from '../account-contract-providers/bundle.js';
-import { EmbeddedWallet, type EmbeddedWalletOptions } from '../embedded_wallet.js';
+import type { AccountContractsProvider } from '../account-contract-providers/types.js';
+import { EmbeddedWallet, type EmbeddedWalletOptions, splitPxeOptions } from '../embedded_wallet.js';
 import { WalletDB } from '../wallet_db.js';
 
-export type NodeEmbeddedWalletOptions = EmbeddedWalletOptions & {
-  /** Override PXE configuration. */
-  pxeConfig?: Partial<PXEConfig>;
-  /** Advanced PXE creation options (custom store, prover, simulator). */
-  pxeOptions?: PXECreationOptions;
-};
-
 export class NodeEmbeddedWallet extends EmbeddedWallet {
-  static async create(
+  static async create<T extends NodeEmbeddedWallet = NodeEmbeddedWallet>(
+    this: new (
+      pxe: PXE,
+      aztecNode: AztecNode,
+      walletDB: WalletDB,
+      accountContracts: AccountContractsProvider,
+      log?: Logger,
+    ) => T,
     nodeOrUrl: string | AztecNode,
-    options: NodeEmbeddedWalletOptions = {},
-  ): Promise<NodeEmbeddedWallet> {
+    options: EmbeddedWalletOptions = {},
+  ): Promise<T> {
     const rootLogger = options.logger ?? createLogger('embedded-wallet');
 
     const aztecNode = typeof nodeOrUrl === 'string' ? createAztecNodeClient(nodeOrUrl) : nodeOrUrl;
+    const l1Contracts = await aztecNode.getL1ContractAddresses();
+
+    // Support both the new unified `pxe` option and the deprecated `pxeConfig`/`pxeOptions`.
+    const { config: pxeConfigFromPxe, creation: pxeCreationFromPxe } = splitPxeOptions(options.pxe);
+    const mergedConfigOverrides = { ...options.pxeConfig, ...pxeConfigFromPxe };
+    const mergedCreationOverrides: PXECreationOptions = { ...options.pxeOptions, ...pxeCreationFromPxe };
 
-    const pxeConfig = Object.assign(getPXEConfig(), {
-      proverEnabled: options.pxeConfig?.proverEnabled ?? false,
-      ...options.pxeConfig,
+    const pxeConfig: PXEConfig = Object.assign(getPXEConfig(), {
+      proverEnabled: mergedConfigOverrides.proverEnabled ?? false,
+      dataDirectory: `pxe_data_${l1Contracts.rollupAddress}`,
+      autoSync: false,
+      ...mergedConfigOverrides,
     });
 
     if (options.ephemeral) {
@@ -36,45 +46,49 @@ export class NodeEmbeddedWallet extends EmbeddedWallet {
     }
 
     const pxeOptions: PXECreationOptions = {
-      ...options.pxeOptions,
+      ...mergedCreationOverrides,
+      preloadedContractsProvider: mergedCreationOverrides.preloadedContractsProvider ?? {
+        getPreloadedContracts: async () => [await getStandardMultiCallEntrypoint(), await getStandardAuthRegistry()],
+      },
       loggers: {
         store: rootLogger.createChild('pxe:data'),
         pxe: rootLogger.createChild('pxe:service'),
         prover: rootLogger.createChild('pxe:prover'),
-        ...options.pxeOptions?.loggers,
+        ...mergedCreationOverrides.loggers,
       },
     };
 
     const pxe = await createPXE(aztecNode, pxeConfig, pxeOptions);
 
-    const l1Contracts = await aztecNode.getL1ContractAddresses();
-    const rollupAddress = l1Contracts.rollupAddress;
-
-    const walletDBStore = options.ephemeral
-      ? await openTmpStore(
-          'wallet_data',
-          true,
-          undefined,
-          undefined,
-          rootLogger.createChild('wallet:data').getBindings(),
-        )
-      : await createWalletStore(
-          'wallet_data',
-          1,
-          {
-            dataDirectory: pxeConfig.dataDirectory,
-            dataStoreMapSizeKb: pxeConfig.dataStoreMapSizeKb,
-            l1Contracts: { rollupAddress },
-          },
-          rootLogger.createChild('wallet:data').getBindings(),
-        );
-    const walletDB = WalletDB.init(walletDBStore, rootLogger.createChild('wallet:db').info);
+    const walletDBStore =
+      options.walletDb?.store ??
+      (options.ephemeral
+        ? await openTmpStore(
+            `wallet_data_${l1Contracts.rollupAddress}`,
+            true,
+            undefined,
+            undefined,
+            rootLogger.createChild('wallet:data').getBindings(),
+          )
+        : await createStore(
+            'wallet_data',
+            1,
+            {
+              dataDirectory: `wallet_data_${l1Contracts.rollupAddress}`,
+              dataStoreMapSizeKb: pxeConfig.dataStoreMapSizeKb,
+              rollupAddress: l1Contracts.rollupAddress,
+            },
+            rootLogger.createChild('wallet:data').getBindings(),
+          ));
+    const walletDB = new WalletDB(walletDBStore, rootLogger.createChild('wallet:db').info);
 
-    return new NodeEmbeddedWallet(pxe, aztecNode, walletDB, new BundleAccountContractsProvider(), rootLogger);
+    const wallet = new this(pxe, aztecNode, walletDB, new BundleAccountContractsProvider(), rootLogger) as T;
+    await wallet.initStubClasses();
+    return wallet;
   }
 }
 
 export { NodeEmbeddedWallet as EmbeddedWallet };
-export type { EmbeddedWalletOptions } from '../embedded_wallet.js';
+export type { EmbeddedWalletOptions, EmbeddedWalletPXEOptions } from '../embedded_wallet.js';
 export { WalletDB } from '../wallet_db.js';
 export type { AccountType } from '../wallet_db.js';

package/src/embedded/store_encryption.ts

@@ -0,0 +1,107 @@
+/**
+ * Wallet-layer helpers for opening the embedded wallet's two encrypted stores (PXE + walletDB) as a cohesive unit.
+ *
+ * Sits on top of `@aztec/kv-store/sqlite-opfs`'s typed `SqliteEncryptionError` and adds:
+ *
+ *   - `storeName: 'pxe' | 'wallet'`, telling callers WHICH store failed.
+ *   - Cleanup: when the wallet store fails to open, ensures the already-opened PXE store is closed before the error
+ *     surfaces, so callers don't leak the SAH Pool's OPFS lock.
+ */
+import type { Logger } from '@aztec/foundation/log';
+import { AztecSQLiteOPFSStore, SqliteEncryptionError } from '@aztec/kv-store/sqlite-opfs';
+
+/** Which of the embedded wallet's two stores failed to open. */
+export type EmbeddedStoreName = 'pxe' | 'wallet';
+
+/**
+ * Thrown by {@link openEncryptedEmbeddedStores} when one of the two stores cannot be decrypted with the supplied
+ * key. The original {@link SqliteEncryptionError} is preserved as `cause`.
+ */
+export class EmbeddedWalletEncryptionError extends Error {
+  readonly storeName: EmbeddedStoreName;
+
+  constructor(storeName: EmbeddedStoreName, opts: { cause: SqliteEncryptionError }) {
+    super(`Embedded wallet '${storeName}' store could not be decrypted with the provided key`, { cause: opts.cause });
+    this.name = 'EmbeddedWalletEncryptionError';
+    this.storeName = storeName;
+  }
+}
+
+/** Configuration for {@link openEncryptedEmbeddedStores}. */
+export interface OpenEncryptedEmbeddedStoresOptions {
+  pxe: { name: string; poolDirectory?: string };
+  wallet: { name: string; poolDirectory?: string };
+}
+
+/**
+ * Internal seam for tests to inject a fake store opener. Defaults to `AztecSQLiteOPFSStore.open`. Not part of the
+ * public API.
+ *
+ * @internal
+ */
+export type OpenSqliteEncryptedStoreFn = (
+  log: Logger,
+  name: string,
+  poolDirectory: string | undefined,
+  encryptionKey: Uint8Array,
+) => Promise<AztecSQLiteOPFSStore>;
+
+const defaultOpenStore: OpenSqliteEncryptedStoreFn = (log, name, poolDirectory, encryptionKey) =>
+  AztecSQLiteOPFSStore.open(log, name, false, poolDirectory, encryptionKey);
+
+/**
+ * Opens the PXE and wallet stores in sequence, both encrypted with keys obtained from `getEncryptionKey`.
+ *
+ * The callback is invoked once per store (twice total per call) because `AztecSQLiteOPFSStore.open` *transfers*
+ * the key buffer to its worker. A single buffer would detach between the two opens.
+ *
+ * Failure modes:
+ *
+ *   - PXE store fails to decrypt → throws `EmbeddedWalletEncryptionError({ storeName: 'pxe', cause })`. No cleanup
+ *     needed (nothing was opened).
+ *   - Wallet store fails to decrypt → closes the already-opened PXE store then throws
+ *     `EmbeddedWalletEncryptionError({ storeName: 'wallet', cause })`.
+ *   - Any non-decrypt error during the wallet open → still closes PXE, then re-throws the original error unwrapped
+ *     (preserves callers' existing untyped error handling for non-encryption faults).
+ *
+ * @param config           - Per-store name/poolDirectory.
+ * @param getEncryptionKey - Returns a fresh 32-byte key per call (the buffer
+ *                           detaches on transfer, so each call must allocate).
+ * @param log              - Logger for both stores.
+ * @param openStore        - Internal test seam. Do not pass in production code.
+ */
+export async function openEncryptedEmbeddedStores(
+  config: OpenEncryptedEmbeddedStoresOptions,
+  getEncryptionKey: () => Promise<Uint8Array>,
+  log: Logger,
+  openStore: OpenSqliteEncryptedStoreFn = defaultOpenStore,
+): Promise<{ pxeStore: AztecSQLiteOPFSStore; walletStore: AztecSQLiteOPFSStore }> {
+  const pxeStore = await openOneStore('pxe', config.pxe, getEncryptionKey, log, openStore);
+  try {
+    const walletStore = await openOneStore('wallet', config.wallet, getEncryptionKey, log, openStore);
+    return { pxeStore, walletStore };
+  } catch (err) {
+    // Cleanup is best-effort — if close() itself throws (e.g. worker already dead), swallow it so the original error
+    // surfaces unobstructed.
+    await pxeStore.close().catch(() => {});
+    throw err;
+  }
+}
+
+async function openOneStore(
+  storeName: EmbeddedStoreName,
+  { name, poolDirectory }: { name: string; poolDirectory?: string },
+  getEncryptionKey: () => Promise<Uint8Array>,
+  log: Logger,
+  openStore: OpenSqliteEncryptedStoreFn,
+): Promise<AztecSQLiteOPFSStore> {
+  const key = await getEncryptionKey();
+  try {
+    return await openStore(log, name, poolDirectory, key);
+  } catch (err) {
+    if (err instanceof SqliteEncryptionError && err.code === 'decrypt_failed') {
+      throw new EmbeddedWalletEncryptionError(storeName, { cause: err });
+    }
+    throw err;
+  }
+}

package/src/embedded/wallet_db.ts

@@ -12,16 +12,15 @@ function accountKey(field: string, address: AztecAddress | string): string {
 }
 
 export class WalletDB {
-  private constructor(
-    private accounts: AztecAsyncMap<string, Buffer>,
-    private aliases: AztecAsyncMap<string, Buffer>,
-    private userLog: LogFn,
-  ) {}
+  private accounts: AztecAsyncMap<string, Buffer>;
+  private aliases: AztecAsyncMap<string, Buffer>;
 
-  static init(store: AztecAsyncKVStore, userLog: LogFn) {
-    const accounts = store.openMap<string, Buffer>('accounts');
-    const aliases = store.openMap<string, Buffer>('aliases');
-    return new WalletDB(accounts, aliases, userLog);
+  constructor(
+    private store: AztecAsyncKVStore,
+    private userLog: LogFn,
+  ) {
+    this.accounts = store.openMap<string, Buffer>('accounts');
+    this.aliases = store.openMap<string, Buffer>('aliases');
   }
 
   async storeAccount(
@@ -131,4 +130,8 @@ export class WalletDB {
       await this.aliases.delete(`accounts:${alias}`);
     }
   }
+
+  async close() {
+    await this.store.close();
+  }
 }

package/src/testing.ts

@@ -1,5 +1,6 @@
 import type { InitialAccountData } from '@aztec/accounts/testing';
 import { getInitialTestAccountsData } from '@aztec/accounts/testing/lazy';
+import { NO_FROM } from '@aztec/aztec.js/account';
 import type { WaitOpts } from '@aztec/aztec.js/contracts';
 import type { AccountManager } from '@aztec/aztec.js/wallet';
 import type { Fq, Fr } from '@aztec/foundation/curves/bn254';
@@ -21,7 +22,7 @@ export async function deployFundedSchnorrAccounts(
     const accountManager = await wallet.createSchnorrAccount(secret, salt, signingKey);
     const deployMethod = await accountManager.getDeployMethod();
     await deployMethod.send({
-      from: AztecAddress.ZERO,
+      from: NO_FROM,
       skipClassPublication: i !== 0,
       wait: waitOptions,
     });

package/dest/embedded/embedded_wallet_browser.d.ts

@@ -1,5 +0,0 @@
-import { EmbeddedWallet } from './embedded_wallet.js';
-export declare class BrowserEmbeddedWallet extends EmbeddedWallet {
-    static create(nodeUrl: string): Promise<BrowserEmbeddedWallet>;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW1iZWRkZWRfd2FsbGV0X2Jyb3dzZXIuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9lbWJlZGRlZC9lbWJlZGRlZF93YWxsZXRfYnJvd3Nlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFPQSxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFHdEQscUJBQWEscUJBQXNCLFNBQVEsY0FBYztJQUN2RCxPQUFhLE1BQU0sQ0FBQyxPQUFPLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQTJCbkU7Q0FDRiJ9

package/dest/embedded/embedded_wallet_browser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"embedded_wallet_browser.d.ts","sourceRoot":"","sources":["../../src/embedded/embedded_wallet_browser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAGtD,qBAAa,qBAAsB,SAAQ,cAAc;IACvD,OAAa,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CA2BnE;CACF"}

package/dest/embedded/embedded_wallet_browser.js

@@ -1,31 +0,0 @@
-import { createAztecNodeClient } from '@aztec/aztec.js/node';
-import { createLogger } from '@aztec/foundation/log';
-import { createStore } from '@aztec/kv-store/indexeddb';
-import { createPXE } from '@aztec/pxe/client/lazy';
-import { getPXEConfig } from '@aztec/pxe/config';
-import { LazyAccountContractsProvider } from './account-contract-providers/lazy.js';
-import { EmbeddedWallet } from './embedded_wallet.js';
-import { WalletDB } from './wallet_db.js';
-export class BrowserEmbeddedWallet extends EmbeddedWallet {
-    static async create(nodeUrl) {
-        const aztecNode = createAztecNodeClient(nodeUrl);
-        const l1Contracts = await aztecNode.getL1ContractAddresses();
-        const rollupAddress = l1Contracts.rollupAddress;
-        const config = getPXEConfig();
-        config.dataDirectory = `pxe-${rollupAddress}`;
-        const pxe = await createPXE(aztecNode, config, {
-            loggers: {
-                store: createLogger('pxe:data:idb'),
-                pxe: createLogger('pxe:service'),
-                prover: createLogger('bb:wasm:lazy')
-            }
-        });
-        const logger = createLogger('embedded-wallet:browser');
-        const walletDBStore = await createStore(`wallet-${rollupAddress}`, {
-            dataDirectory: 'wallet',
-            dataStoreMapSizeKb: 2e10
-        }, undefined, createLogger('wallet:data:idb'));
-        const walletDB = WalletDB.init(walletDBStore, logger.info);
-        return new BrowserEmbeddedWallet(pxe, aztecNode, walletDB, new LazyAccountContractsProvider());
-    }
-}

package/src/embedded/embedded_wallet_browser.ts

@@ -1,40 +0,0 @@
-import { createAztecNodeClient } from '@aztec/aztec.js/node';
-import { createLogger } from '@aztec/foundation/log';
-import { createStore } from '@aztec/kv-store/indexeddb';
-import { createPXE } from '@aztec/pxe/client/lazy';
-import { getPXEConfig } from '@aztec/pxe/config';
-
-import { LazyAccountContractsProvider } from './account-contract-providers/lazy.js';
-import { EmbeddedWallet } from './embedded_wallet.js';
-import { WalletDB } from './wallet_db.js';
-
-export class BrowserEmbeddedWallet extends EmbeddedWallet {
-  static async create(nodeUrl: string): Promise<BrowserEmbeddedWallet> {
-    const aztecNode = createAztecNodeClient(nodeUrl);
-
-    const l1Contracts = await aztecNode.getL1ContractAddresses();
-    const rollupAddress = l1Contracts.rollupAddress;
-
-    const config = getPXEConfig();
-    config.dataDirectory = `pxe-${rollupAddress}`;
-
-    const pxe = await createPXE(aztecNode, config, {
-      loggers: {
-        store: createLogger('pxe:data:idb'),
-        pxe: createLogger('pxe:service'),
-        prover: createLogger('bb:wasm:lazy'),
-      },
-    });
-
-    const logger = createLogger('embedded-wallet:browser');
-    const walletDBStore = await createStore(
-      `wallet-${rollupAddress}`,
-      { dataDirectory: 'wallet', dataStoreMapSizeKb: 2e10 },
-      undefined,
-      createLogger('wallet:data:idb'),
-    );
-    const walletDB = WalletDB.init(walletDBStore, logger.info);
-
-    return new BrowserEmbeddedWallet(pxe, aztecNode, walletDB, new LazyAccountContractsProvider());
-  }
-}