@aztec/pxe 0.66.0 → 0.67.1-devnet

package/src/synchronizer/synchronizer.ts

@@ -5,39 +5,36 @@ import {
   type L2BlockStreamEventHandler,
 } from '@aztec/circuit-types';
 import { INITIAL_L2_BLOCK_NUM } from '@aztec/circuits.js';
-import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
+import { type Logger, createLogger } from '@aztec/foundation/log';
 import { type L2TipsStore } from '@aztec/kv-store/stores';
 
 import { type PXEConfig } from '../config/index.js';
 import { type PxeDatabase } from '../database/index.js';
 
 /**
- * The Synchronizer class manages the synchronization of note processors and interacts with the Aztec node
- * to obtain encrypted logs, blocks, and other necessary information for the accounts.
- * It provides methods to start or stop the synchronization process, add new accounts, retrieve account
- * details, and fetch transactions by hash. The Synchronizer ensures that it maintains the note processors
- * in sync with the blockchain while handling retries and errors gracefully.
+ * The Synchronizer class manages the synchronization with the aztec node, allowing PXE to retrieve the
+ * latest block header and handle reorgs.
+ * It provides methods to trigger a sync and get the block number we are syncec to
+ * details, and fetch transactions by hash.
  */
 export class Synchronizer implements L2BlockStreamEventHandler {
-  private running = false;
   private initialSyncBlockNumber = INITIAL_L2_BLOCK_NUM - 1;
-  private log: DebugLogger;
+  private log: Logger;
   protected readonly blockStream: L2BlockStream;
 
   constructor(
     private node: AztecNode,
     private db: PxeDatabase,
     private l2TipsStore: L2TipsStore,
-    config: Partial<Pick<PXEConfig, 'l2BlockPollingIntervalMS' | 'l2StartingBlock'>> = {},
+    config: Partial<Pick<PXEConfig, 'l2StartingBlock'>> = {},
     logSuffix?: string,
   ) {
-    this.log = createDebugLogger(logSuffix ? `aztec:pxe_synchronizer_${logSuffix}` : 'aztec:pxe_synchronizer');
+    this.log = createLogger(logSuffix ? `pxe:synchronizer:${logSuffix}` : 'pxe:synchronizer');
     this.blockStream = this.createBlockStream(config);
   }
 
-  protected createBlockStream(config: Partial<Pick<PXEConfig, 'l2BlockPollingIntervalMS' | 'l2StartingBlock'>>) {
-    return new L2BlockStream(this.node, this.l2TipsStore, this, {
-      pollIntervalMS: config.l2BlockPollingIntervalMS,
+  protected createBlockStream(config: Partial<Pick<PXEConfig, 'l2StartingBlock'>>) {
+    return new L2BlockStream(this.node, this.l2TipsStore, this, createLogger('pxe:block_stream'), {
       startingBlock: config.l2StartingBlock,
     });
   }
@@ -47,12 +44,18 @@ export class Synchronizer implements L2BlockStreamEventHandler {
     await this.l2TipsStore.handleBlockStreamEvent(event);
 
     switch (event.type) {
-      case 'blocks-added':
-        this.log.verbose(`Processing blocks ${event.blocks[0].number} to ${event.blocks.at(-1)!.number}`);
-        await this.db.setHeader(event.blocks.at(-1)!.header);
+      case 'blocks-added': {
+        const lastBlock = event.blocks.at(-1)!;
+        this.log.verbose(`Updated pxe last block to ${lastBlock.number}`, {
+          blockHash: lastBlock.hash(),
+          archive: lastBlock.archive.root.toString(),
+          header: lastBlock.header.toInspect(),
+        });
+        await this.db.setHeader(lastBlock.header);
         break;
-      case 'chain-pruned':
-        this.log.info(`Pruning data after block ${event.blockNumber} due to reorg`);
+      }
+      case 'chain-pruned': {
+        this.log.warn(`Pruning data after block ${event.blockNumber} due to reorg`);
         // We first unnullify and then remove so that unnullified notes that were created after the block number end up deleted.
         await this.db.unnullifyNotesAfter(event.blockNumber);
         await this.db.removeNotesAfter(event.blockNumber);
@@ -62,73 +65,30 @@ export class Synchronizer implements L2BlockStreamEventHandler {
         // Update the header to the last block.
         await this.db.setHeader(await this.node.getBlockHeader(event.blockNumber));
         break;
+      }
     }
   }
 
   /**
-   * Starts the synchronization process by fetching encrypted logs and blocks from a specified position.
-   * Continuously processes the fetched data for all note processors until stopped. If there is no data
-   * available, it retries after a specified interval.
-   *
-   * @param limit - The maximum number of encrypted, unencrypted logs and blocks to fetch in each iteration.
-   * @param retryInterval - The time interval (in ms) to wait before retrying if no data is available.
+   * Syncs PXE and the node by dowloading the metadata of the latest blocks, allowing simulations to use
+   * recent data (e.g. notes), and handling any reorgs that might have occurred.
    */
-  public async start() {
-    if (this.running) {
-      return;
-    }
-    this.running = true;
-
-    // REFACTOR: We should know the header of the genesis block without having to request it from the node.
-    await this.db.setHeader(await this.node.getBlockHeader(0));
+  public async sync() {
+    let currentHeader;
 
-    await this.trigger();
-    this.log.info('Initial sync complete');
-    this.blockStream.start();
-    this.log.debug('Started loop');
-  }
-
-  /**
-   * Stops the synchronizer gracefully, interrupting any ongoing sleep and waiting for the current
-   * iteration to complete before setting the running state to false. Once stopped, the synchronizer
-   * will no longer process blocks or encrypted logs and must be restarted using the start method.
-   *
-   * @returns A promise that resolves when the synchronizer has successfully stopped.
-   */
-  public async stop() {
-    this.running = false;
-    await this.blockStream.stop();
-    this.log.info('Stopped');
-  }
-
-  /** Triggers a single run. */
-  public async trigger() {
+    try {
+      currentHeader = await this.db.getBlockHeader();
+    } catch (e) {
+      this.log.debug('Header is not set, requesting from the node');
+    }
+    if (!currentHeader) {
+      // REFACTOR: We should know the header of the genesis block without having to request it from the node.
+      await this.db.setHeader(await this.node.getBlockHeader(0));
+    }
     await this.blockStream.sync();
   }
 
-  private getSynchedBlockNumber() {
-    return this.db.getBlockNumber() ?? this.initialSyncBlockNumber;
-  }
-
-  /**
-   * Checks whether all the blocks were processed (tree roots updated, txs updated with block info, etc.).
-   * @returns True if there are no outstanding blocks to be synched.
-   * @remarks This indicates that blocks and transactions are synched even if notes are not.
-   * @remarks Compares local block number with the block number from aztec node.
-   */
-  public async isGlobalStateSynchronized() {
-    const latest = await this.node.getBlockNumber();
-    return latest <= this.getSynchedBlockNumber();
-  }
-
-  /**
-   * Returns the latest block that has been synchronized by the synchronizer and each account.
-   * @returns The latest block synchronized for blocks, and the latest block synched for notes for each public key being tracked.
-   */
-  public getSyncStatus() {
-    const lastBlockNumber = this.getSynchedBlockNumber();
-    return {
-      blocks: lastBlockNumber,
-    };
+  public async getSynchedBlockNumber() {
+    return (await this.db.getBlockNumber()) ?? this.initialSyncBlockNumber;
   }
 }

package/src/{pxe_service → utils}/create_pxe_service.ts

@@ -1,15 +1,16 @@
 import { BBNativePrivateKernelProver } from '@aztec/bb-prover';
+import { BBWasmPrivateKernelProver } from '@aztec/bb-prover/wasm';
 import { type AztecNode, type PrivateKernelProver } from '@aztec/circuit-types';
 import { randomBytes } from '@aztec/foundation/crypto';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { KeyStore } from '@aztec/key-store';
+import { createStore } from '@aztec/kv-store/lmdb';
 import { L2TipsStore } from '@aztec/kv-store/stores';
-import { createStore } from '@aztec/kv-store/utils';
 
 import { type PXEServiceConfig } from '../config/index.js';
 import { KVPxeDatabase } from '../database/kv_pxe_database.js';
 import { TestPrivateKernelProver } from '../kernel_prover/test/test_circuit_prover.js';
-import { PXEService } from './pxe_service.js';
+import { PXEService } from '../pxe_service/pxe_service.js';
 
 /**
  * Create and start an PXEService instance with the given AztecNode.
@@ -38,18 +39,18 @@ export async function createPXEService(
   } as PXEServiceConfig;
 
   const keyStore = new KeyStore(
-    await createStore('pxe_key_store', configWithContracts, createDebugLogger('aztec:pxe:keystore:lmdb')),
+    await createStore('pxe_key_store', configWithContracts, createLogger('pxe:keystore:lmdb')),
   );
 
-  const store = await createStore('pxe_data', configWithContracts, createDebugLogger('aztec:pxe:data:lmdb'));
+  const store = await createStore('pxe_data', configWithContracts, createLogger('pxe:data:lmdb'));
 
-  const db = new KVPxeDatabase(store);
+  const db = await KVPxeDatabase.create(store);
   const tips = new L2TipsStore(store, 'pxe');
 
   const prover = proofCreator ?? (await createProver(config, logSuffix));
-  const server = new PXEService(keyStore, aztecNode, db, tips, prover, config, logSuffix);
-  await server.start();
-  return server;
+  const pxe = new PXEService(keyStore, aztecNode, db, tips, prover, config, logSuffix);
+  await pxe.init();
+  return pxe;
 }
 
 function createProver(config: PXEServiceConfig, logSuffix?: string) {
@@ -59,9 +60,11 @@ function createProver(config: PXEServiceConfig, logSuffix?: string) {
 
   // (@PhilWindle) Temporary validation until WASM is implemented
   if (!config.bbBinaryPath || !config.bbWorkingDirectory) {
-    throw new Error(`Prover must be configured with binary path and working directory`);
+    return new BBWasmPrivateKernelProver(16);
+  } else {
+    const bbConfig = config as Required<Pick<PXEServiceConfig, 'bbBinaryPath' | 'bbWorkingDirectory'>> &
+      PXEServiceConfig;
+    const log = createLogger('pxe:bb-native-prover' + (logSuffix ? `:${logSuffix}` : ''));
+    return BBNativePrivateKernelProver.new({ bbSkipCleanup: false, ...bbConfig }, log);
   }
-  const bbConfig = config as Required<Pick<PXEServiceConfig, 'bbBinaryPath' | 'bbWorkingDirectory'>> & PXEServiceConfig;
-  const log = createDebugLogger('aztec:pxe:bb-native-prover' + (logSuffix ? `:${logSuffix}` : ''));
-  return BBNativePrivateKernelProver.new({ bbSkipCleanup: false, ...bbConfig }, log);
 }

package/dest/pxe_service/create_pxe_service.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create_pxe_service.d.ts","sourceRoot":"","sources":["../../src/pxe_service/create_pxe_service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAOhF,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG3D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CACpC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,gBAAgB,EACxB,YAAY,GAAE,MAAM,GAAG,OAAO,GAAG,SAAqB,EACtD,YAAY,CAAC,EAAE,mBAAmB,uBAwBnC"}

package/dest/pxe_service/create_pxe_service.js

@@ -1,49 +0,0 @@
-import { BBNativePrivateKernelProver } from '@aztec/bb-prover';
-import { randomBytes } from '@aztec/foundation/crypto';
-import { createDebugLogger } from '@aztec/foundation/log';
-import { KeyStore } from '@aztec/key-store';
-import { L2TipsStore } from '@aztec/kv-store/stores';
-import { createStore } from '@aztec/kv-store/utils';
-import { KVPxeDatabase } from '../database/kv_pxe_database.js';
-import { TestPrivateKernelProver } from '../kernel_prover/test/test_circuit_prover.js';
-import { PXEService } from './pxe_service.js';
-/**
- * Create and start an PXEService instance with the given AztecNode.
- * If no keyStore or database is provided, it will use KeyStore and MemoryDB as default values.
- * Returns a Promise that resolves to the started PXEService instance.
- *
- * @param aztecNode - The AztecNode instance to be used by the server.
- * @param config - The PXE Service Config to use
- * @param options - (Optional) Optional information for creating an PXEService.
- * @param proofCreator - An optional proof creator to use in place of any other configuration
- * @returns A Promise that resolves to the started PXEService instance.
- */
-export async function createPXEService(aztecNode, config, useLogSuffix = undefined, proofCreator) {
-    const logSuffix = typeof useLogSuffix === 'boolean' ? (useLogSuffix ? randomBytes(3).toString('hex') : undefined) : useLogSuffix;
-    const l1Contracts = await aztecNode.getL1ContractAddresses();
-    const configWithContracts = {
-        ...config,
-        l1Contracts,
-    };
-    const keyStore = new KeyStore(await createStore('pxe_key_store', configWithContracts, createDebugLogger('aztec:pxe:keystore:lmdb')));
-    const store = await createStore('pxe_data', configWithContracts, createDebugLogger('aztec:pxe:data:lmdb'));
-    const db = new KVPxeDatabase(store);
-    const tips = new L2TipsStore(store, 'pxe');
-    const prover = proofCreator ?? (await createProver(config, logSuffix));
-    const server = new PXEService(keyStore, aztecNode, db, tips, prover, config, logSuffix);
-    await server.start();
-    return server;
-}
-function createProver(config, logSuffix) {
-    if (!config.proverEnabled) {
-        return new TestPrivateKernelProver();
-    }
-    // (@PhilWindle) Temporary validation until WASM is implemented
-    if (!config.bbBinaryPath || !config.bbWorkingDirectory) {
-        throw new Error(`Prover must be configured with binary path and working directory`);
-    }
-    const bbConfig = config;
-    const log = createDebugLogger('aztec:pxe:bb-native-prover' + (logSuffix ? `:${logSuffix}` : ''));
-    return BBNativePrivateKernelProver.new({ bbSkipCleanup: false, ...bbConfig }, log);
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRlX3B4ZV9zZXJ2aWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3B4ZV9zZXJ2aWNlL2NyZWF0ZV9weGVfc2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsMkJBQTJCLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUUvRCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFDdkQsT0FBTyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDMUQsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBQzVDLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUNyRCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHcEQsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQy9ELE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLDhDQUE4QyxDQUFDO0FBQ3ZGLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUU5Qzs7Ozs7Ozs7OztHQVVHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxnQkFBZ0IsQ0FDcEMsU0FBb0IsRUFDcEIsTUFBd0IsRUFDeEIsZUFBNkMsU0FBUyxFQUN0RCxZQUFrQztJQUVsQyxNQUFNLFNBQVMsR0FDYixPQUFPLFlBQVksS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUMsWUFBWSxDQUFDO0lBRWpILE1BQU0sV0FBVyxHQUFHLE1BQU0sU0FBUyxDQUFDLHNCQUFzQixFQUFFLENBQUM7SUFDN0QsTUFBTSxtQkFBbUIsR0FBRztRQUMxQixHQUFHLE1BQU07UUFDVCxXQUFXO0tBQ1EsQ0FBQztJQUV0QixNQUFNLFFBQVEsR0FBRyxJQUFJLFFBQVEsQ0FDM0IsTUFBTSxXQUFXLENBQUMsZUFBZSxFQUFFLG1CQUFtQixFQUFFLGlCQUFpQixDQUFDLHlCQUF5QixDQUFDLENBQUMsQ0FDdEcsQ0FBQztJQUVGLE1BQU0sS0FBSyxHQUFHLE1BQU0sV0FBVyxDQUFDLFVBQVUsRUFBRSxtQkFBbUIsRUFBRSxpQkFBaUIsQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7SUFFM0csTUFBTSxFQUFFLEdBQUcsSUFBSSxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDcEMsTUFBTSxJQUFJLEdBQUcsSUFBSSxXQUFXLENBQUMsS0FBSyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBRTNDLE1BQU0sTUFBTSxHQUFHLFlBQVksSUFBSSxDQUFDLE1BQU0sWUFBWSxDQUFDLE1BQU0sRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO0lBQ3ZFLE1BQU0sTUFBTSxHQUFHLElBQUksVUFBVSxDQUFDLFFBQVEsRUFBRSxTQUFTLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBQ3hGLE1BQU0sTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQ3JCLE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUM7QUFFRCxTQUFTLFlBQVksQ0FBQyxNQUF3QixFQUFFLFNBQWtCO0lBQ2hFLElBQUksQ0FBQyxNQUFNLENBQUMsYUFBYSxFQUFFLENBQUM7UUFDMUIsT0FBTyxJQUFJLHVCQUF1QixFQUFFLENBQUM7SUFDdkMsQ0FBQztJQUVELCtEQUErRDtJQUMvRCxJQUFJLENBQUMsTUFBTSxDQUFDLFlBQVksSUFBSSxDQUFDLE1BQU0sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3ZELE1BQU0sSUFBSSxLQUFLLENBQUMsa0VBQWtFLENBQUMsQ0FBQztJQUN0RixDQUFDO0lBQ0QsTUFBTSxRQUFRLEdBQUcsTUFBb0csQ0FBQztJQUN0SCxNQUFNLEdBQUcsR0FBRyxpQkFBaUIsQ0FBQyw0QkFBNEIsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsSUFBSSxTQUFTLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztJQUNqRyxPQUFPLDJCQUEyQixDQUFDLEdBQUcsQ0FBQyxFQUFFLGFBQWEsRUFBRSxLQUFLLEVBQUUsR0FBRyxRQUFRLEVBQUUsRUFBRSxHQUFHLENBQUMsQ0FBQztBQUNyRixDQUFDIn0=