feat: PXE sync on demand

aztec-up/bin/docker-compose.sandbox.yml

@@ -28,7 +28,6 @@ services:
       P2P_BLOCK_CHECK_INTERVAL_MS: 50
       SEQ_TX_POLLING_INTERVAL_MS: 50
       WS_BLOCK_CHECK_INTERVAL_MS: 50
-      PXE_BLOCK_POLLING_INTERVAL_MS: 50
       ARCHIVER_VIEM_POLLING_INTERVAL_MS: 500
       PXE_PORT: ${PXE_PORT:-8080}
       PORT: ${AZTEC_NODE_PORT:-8080}

boxes/boxes/vite/src/config.ts

@@ -24,7 +24,10 @@ export class PrivateEnv {
   accountContract;
   account: AccountManager;
 
-  constructor(private secretKey: Fr, private nodeURL: string) {}
+  constructor(
+    private secretKey: Fr,
+    private nodeURL: string,
+  ) {}
 
   async init() {
     const config = getPXEServiceConfig();
@@ -33,20 +36,20 @@ export class PrivateEnv {
     const proofCreator = new TestPrivateKernelProver();
     this.pxe = await this.createPXEService(aztecNode, config, proofCreator);
     const encryptionPrivateKey = deriveMasterIncomingViewingSecretKey(
-      this.secretKey
+      this.secretKey,
     );
     this.accountContract = new SingleKeyAccountContract(encryptionPrivateKey);
     this.account = new AccountManager(
       this.pxe,
       this.secretKey,
-      this.accountContract
+      this.accountContract,
     );
   }
 
   async createPXEService(
     aztecNode: AztecNode,
     config: PXEServiceConfig,
-    proofCreator?: PrivateKernelProver
+    proofCreator?: PrivateKernelProver,
   ) {
     const l1Contracts = await aztecNode.getL1ContractAddresses();
     const configWithContracts = {
@@ -57,24 +60,24 @@ export class PrivateEnv {
     const store = await createStore(
       "pxe_data",
       configWithContracts,
-      createLogger("pxe:data:indexeddb")
+      createLogger("pxe:data:indexeddb"),
     );
 
     const keyStore = new KeyStore(store);
 
     const db = await KVPxeDatabase.create(store);
     const tips = new L2TipsStore(store, "pxe");
 
-    const server = new PXEService(
+    const pxe = new PXEService(
       keyStore,
       aztecNode,
       db,
       tips,
       proofCreator,
-      config
+      config,
     );
-    await server.start();
-    return server;
+    await pxe.init();
+    return pxe;
   }
 
   async getWallet() {
@@ -85,7 +88,7 @@ export class PrivateEnv {
 
 export const deployerEnv = new PrivateEnv(
   SECRET_KEY,
-  process.env.PXE_URL || "http://localhost:8080"
+  process.env.PXE_URL || "http://localhost:8080",
 );
 
 const IGNORE_FUNCTIONS = [
@@ -94,5 +97,5 @@ const IGNORE_FUNCTIONS = [
   "sync_notes",
 ];
 export const filteredInterface = BoxReactContractArtifact.functions.filter(
-  (f) => !IGNORE_FUNCTIONS.includes(f.name)
+  (f) => !IGNORE_FUNCTIONS.includes(f.name),
 );

boxes/docker-compose.yml

@@ -17,7 +17,6 @@ services:
       P2P_BLOCK_CHECK_INTERVAL_MS: 50
       SEQ_TX_POLLING_INTERVAL_MS: 50
       WS_BLOCK_CHECK_INTERVAL_MS: 50
-      PXE_BLOCK_POLLING_INTERVAL_MS: 50
       ARCHIVER_VIEM_POLLING_INTERVAL_MS: 500
     depends_on:
       - ethereum

docs/docs/reference/developer_references/sandbox_reference/sandbox-reference.md

@@ -37,7 +37,6 @@ ARCHIVER_POLLING_INTERVAL_MS=50
 P2P_BLOCK_CHECK_INTERVAL_MS=50
 SEQ_TX_POLLING_INTERVAL_MS=50
 WS_BLOCK_CHECK_INTERVAL_MS=50
-PXE_BLOCK_POLLING_INTERVAL_MS=50
 ARCHIVER_VIEM_POLLING_INTERVAL_MS=500
 ```
 
@@ -90,7 +89,6 @@ Variables like `TEST_ACCOUNTS` & `PXE_PORT` are valid here as described above.
 AZTEC_NODE_URL='http://localhost:8079' # The address of an Aztec Node URL that the PXE will connect to (default: http://localhost:8079)
 PXE_PORT=8080 # The port that the PXE will be listening to (default: 8080)
 TEST_ACCOUNTS='true' # Option to deploy 3 test account when sandbox starts. (default: true)
-PXE_BLOCK_POLLING_INTERVAL_MS=50 # Interval to check for new L2 blocks. (default: 50)
 PXE_L2_STARTING_BLOCK=1 # L2 Block to start synching the PXE from (default: 1)
 ```
 

spartan/aztec-network/templates/pxe.yaml

@@ -108,8 +108,8 @@ spec:
                 - -c
                 - |
                   curl -s -X POST -H 'content-type: application/json' \
-                  -d '{"jsonrpc":"2.0","method":"pxe_isGlobalStateSynchronized","params":[],"id":67}' \
-                  127.0.0.1:{{ .Values.pxe.service.nodePort }} | grep -q '"result":true'
+                  -d '{"jsonrpc":"2.0","method":"pxe_getNodeInfo","params":[],"id":67}' \
+                  127.0.0.1:{{ .Values.pxe.service.nodePort }} | grep -q '"protocolVersion":1'
             initialDelaySeconds: {{ .Values.pxe.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.pxe.readinessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.pxe.readinessProbe.timeoutSeconds }}

yarn-project/aztec.js/src/contract/sent_tx.test.ts

@@ -23,22 +23,8 @@ describe('SentTx', () => {
       pxe.getTxReceipt.mockResolvedValue(txReceipt);
     });
 
-    it('waits for all notes of the accounts to be available', async () => {
-      pxe.getSyncStatus.mockResolvedValueOnce({ blocks: 25 }).mockResolvedValueOnce({ blocks: 25 });
-
-      const actual = await sentTx.wait({ timeout: 1, interval: 0.4 });
-      expect(actual).toEqual(txReceipt);
-    });
-
-    it('does not wait for notes sync', async () => {
-      pxe.getSyncStatus.mockResolvedValue({ blocks: 19 });
-      const actual = await sentTx.wait({ timeout: 1, interval: 0.4, waitForNotesAvailable: false });
-      expect(actual).toEqual(txReceipt);
-    });
-
     it('throws if tx is dropped', async () => {
       pxe.getTxReceipt.mockResolvedValue({ ...txReceipt, status: TxStatus.DROPPED } as TxReceipt);
-      pxe.getSyncStatus.mockResolvedValue({ blocks: 19 });
       await expect(sentTx.wait({ timeout: 1, interval: 0.4, ignoreDroppedReceiptsFor: 0 })).rejects.toThrow(/dropped/);
     });
 

yarn-project/aztec.js/src/contract/sent_tx.ts

@@ -14,11 +14,6 @@ export type WaitOpts = {
   interval?: number;
   /** Whether to wait for the tx to be proven. */
   proven?: boolean;
-  /**
-   * Whether to wait for the node to notify that the block in which this tx was mined is available to fetch notes from.
-   * If false, then any queries that depend on state set by this transaction may return stale data. Defaults to true.
-   **/
-  waitForNotesAvailable?: boolean;
   /** Whether to include information useful for debugging/testing in the receipt. */
   debug?: boolean;
   /** Whether to accept a revert as a status code for the tx when waiting for it. If false, will throw if the tx reverts. */
@@ -31,7 +26,6 @@ export const DefaultWaitOpts: WaitOpts = {
   provenTimeout: 600,
   interval: 1,
   debug: false,
-  waitForNotesAvailable: true,
 };
 
 /**
@@ -124,16 +118,7 @@ export class SentTx {
           }
           return undefined;
         }
-        // If we don't care about waiting for notes to be synced, return the receipt
-        const waitForNotesAvailable = opts?.waitForNotesAvailable ?? DefaultWaitOpts.waitForNotesAvailable;
-        if (!waitForNotesAvailable) {
-          return txReceipt;
-        }
-        // Check if all sync blocks on the PXE Service are greater or equal than the block in which the tx was mined
-        const { blocks } = await this.pxe.getSyncStatus();
-        const targetBlock = txReceipt.blockNumber!;
-        const areNotesAvailable = blocks >= targetBlock;
-        return areNotesAvailable ? txReceipt : undefined;
+        return txReceipt;
       },
       'isMined',
       opts?.timeout ?? DefaultWaitOpts.timeout,

yarn-project/aztec.js/src/index.ts

@@ -149,7 +149,6 @@ export {
   type PXE,
   type PartialAddress,
   type PublicKey,
-  type SyncStatus,
 } from '@aztec/circuit-types';
 
 // TODO: These kinds of things have no place on our public api.

yarn-project/aztec.js/src/wallet/base_wallet.ts

@@ -10,7 +10,6 @@ import {
   type PXEInfo,
   type PrivateExecutionResult,
   type SiblingPath,
-  type SyncStatus,
   type Tx,
   type TxExecutionRequest,
   type TxHash,
@@ -170,12 +169,6 @@ export abstract class BaseWallet implements Wallet {
   getNodeInfo(): Promise<NodeInfo> {
     return this.pxe.getNodeInfo();
   }
-  isGlobalStateSynchronized() {
-    return this.pxe.isGlobalStateSynchronized();
-  }
-  getSyncStatus(): Promise<SyncStatus> {
-    return this.pxe.getSyncStatus();
-  }
   addAuthWitness(authWitness: AuthWitness) {
     return this.pxe.addAuthWitness(authWitness);
   }

yarn-project/aztec/docker-compose.yml

@@ -29,7 +29,6 @@ services:
       P2P_BLOCK_CHECK_INTERVAL_MS: 50
       SEQ_TX_POLLING_INTERVAL_MS: 50
       WS_BLOCK_CHECK_INTERVAL_MS: 50
-      PXE_BLOCK_POLLING_INTERVAL_MS: 50
       ARCHIVER_VIEM_POLLING_INTERVAL_MS: 500
     volumes:
       - ./log:/usr/src/yarn-project/aztec/log:rw

yarn-project/aztec/src/cli/cmds/start_pxe.ts

@@ -117,8 +117,5 @@ export async function addPXE(
   // Add PXE to services list
   services.pxe = [pxe, PXESchema];
 
-  // Add PXE stop function to signal handlers
-  signalHandlers.push(pxe.stop);
-
   return pxe;
 }

yarn-project/aztec/src/sandbox.ts

@@ -157,7 +157,6 @@ export async function createSandbox(config: Partial<SandboxConfig> = {}) {
   }
 
   const stop = async () => {
-    await pxe.stop();
     await node.stop();
     await watcher?.stop();
   };

yarn-project/bot/src/factory.ts

@@ -6,7 +6,6 @@ import {
   type DeployOptions,
   createLogger,
   createPXEClient,
-  retryUntil,
 } from '@aztec/aztec.js';
 import { type AztecNode, type FunctionCall, type PXE } from '@aztec/circuit-types';
 import { Fr, deriveSigningKey } from '@aztec/circuits.js';
@@ -67,16 +66,6 @@ export class BotFactory {
     if (isInit) {
       this.log.info(`Account at ${account.getAddress().toString()} already initialized`);
       const wallet = await account.register();
-      const blockNumber = await this.pxe.getBlockNumber();
-      await retryUntil(
-        async () => {
-          const status = await this.pxe.getSyncStatus();
-          return blockNumber <= status.blocks;
-        },
-        'pxe synch',
-        3600,
-        1,
-      );
       return wallet;
     } else {
       this.log.info(`Initializing account at ${account.getAddress().toString()}`);

yarn-project/circuit-types/src/interfaces/index.ts

@@ -18,7 +18,6 @@ export * from './proving-job.js';
 export * from './pxe.js';
 export * from './server_circuit_prover.js';
 export * from './service.js';
-export * from './sync-status.js';
 export * from './world_state.js';
 export * from './prover-broker.js';
 export * from './p2p.js';

yarn-project/circuit-types/src/interfaces/pxe.test.ts

@@ -43,7 +43,6 @@ import { Tx, TxHash, TxProvingResult, TxReceipt, TxSimulationResult } from '../t
 import { TxEffect } from '../tx_effect.js';
 import { TxExecutionRequest } from '../tx_execution_request.js';
 import { type EventMetadataDefinition, type PXE, type PXEInfo, PXESchema } from './pxe.js';
-import { type SyncStatus } from './sync-status.js';
 
 jest.setTimeout(12_000);
 
@@ -258,16 +257,6 @@ describe('PXESchema', () => {
     expect(result).toEqual(await handler.getPXEInfo());
   });
 
-  it('isGlobalStateSynchronized', async () => {
-    const result = await context.client.isGlobalStateSynchronized();
-    expect(result).toBe(true);
-  });
-
-  it('getSyncStatus', async () => {
-    const result = await context.client.getSyncStatus();
-    expect(result).toEqual(await handler.getSyncStatus());
-  });
-
   it('getContractInstance', async () => {
     const result = await context.client.getContractInstance(address);
     expect(result).toEqual(instance);
@@ -502,14 +491,6 @@ class MockPXE implements PXE {
       pxeVersion: '1.0',
     });
   }
-  isGlobalStateSynchronized(): Promise<boolean> {
-    return Promise.resolve(true);
-  }
-  getSyncStatus(): Promise<SyncStatus> {
-    return Promise.resolve({
-      blocks: 1,
-    });
-  }
   getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
     expect(address).toEqual(this.address);
     return Promise.resolve(this.instance);

yarn-project/circuit-types/src/interfaces/pxe.ts

@@ -43,7 +43,6 @@ import { SiblingPath } from '../sibling_path/sibling_path.js';
 import { Tx, TxHash, TxProvingResult, TxReceipt, TxSimulationResult } from '../tx/index.js';
 import { TxEffect } from '../tx_effect.js';
 import { TxExecutionRequest } from '../tx_execution_request.js';
-import { type SyncStatus, SyncStatusSchema } from './sync-status.js';
 
 // docs:start:pxe-interface
 /**
@@ -351,22 +350,6 @@ export interface PXE {
    */
   getPXEInfo(): Promise<PXEInfo>;
 
-  /**
-   * 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. Compares local block number with the block number from aztec node.
-   * @deprecated Use `getSyncStatus` instead.
-   */
-  isGlobalStateSynchronized(): Promise<boolean>;
-
-  /**
-   * Returns the latest block that has been synchronized globally and for each account. The global block number
-   * indicates whether global state has been updated up to that block, whereas each address indicates up to which
-   * block the private state has been synced for that account.
-   * @returns The latest block synchronized for blocks, and the latest block synched for notes for each public key being tracked.
-   */
-  getSyncStatus(): Promise<SyncStatus>;
-
   /**
    * Returns a Contract Instance given its address, which includes the contract class identifier,
    * initialization hash, deployment salt, and public keys hash.
@@ -540,8 +523,6 @@ export const PXESchema: ApiSchemaFor<PXE> = {
   getProvenBlockNumber: z.function().returns(z.number()),
   getNodeInfo: z.function().returns(NodeInfoSchema),
   getPXEInfo: z.function().returns(PXEInfoSchema),
-  isGlobalStateSynchronized: z.function().returns(z.boolean()),
-  getSyncStatus: z.function().returns(SyncStatusSchema),
   getContractInstance: z
     .function()
     .args(schemas.AztecAddress)

yarn-project/cli-wallet/src/bin/index.ts

@@ -2,7 +2,6 @@ import { Fr, computeSecretHash, fileURLToPath } from '@aztec/aztec.js';
 import { LOCALHOST } from '@aztec/cli/cli-utils';
 import { type LogFn, createConsoleLogger, createLogger } from '@aztec/foundation/log';
 import { AztecLmdbStore } from '@aztec/kv-store/lmdb';
-import { type PXEService } from '@aztec/pxe';
 
 import { Argument, Command, Option } from 'commander';
 import { readFileSync } from 'fs';
@@ -94,11 +93,6 @@ async function main() {
         await pxeWrapper.init(nodeUrl, join(dataDir, 'pxe'));
       }
       db.init(AztecLmdbStore.open(dataDir));
-    })
-    .hook('postAction', async () => {
-      if (pxeWrapper.getPXE()) {
-        await (pxeWrapper.getPXE() as PXEService).stop();
-      }
     });
 
   injectCommands(program, userLog, debugLogger, db, pxeWrapper);