Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

aztec-pxe

Embedded, in-process PXE runtime. Implements aztec_pxe_client::Pxe by composing local stores, an ACVM executor, the private kernel prover, and an AztecNode backend.

Source: crates/pxe/src/.

Top-Level Types

pub struct EmbeddedPxe<N: AztecNode> { /* ... */ }

pub struct EmbeddedPxeConfig {
    pub prover_config:     BbProverConfig,
    pub block_sync_config: BlockSyncConfig,
}

EmbeddedPxe is generic over the node backend so tests can substitute mock nodes. It implements Pxe and Send + Sync + 'static.

Construction

use aztec_pxe::{EmbeddedPxe, EmbeddedPxeConfig, InMemoryKvStore};

// Non-persistent, suitable for tests and short-lived processes:
let pxe = EmbeddedPxe::create_ephemeral(node.clone()).await?;

// Backed by any KvStore (InMemoryKvStore, SledKvStore):
let kv = std::sync::Arc::new(InMemoryKvStore::new());
let pxe = EmbeddedPxe::create(node.clone(), kv).await?;

// With a custom prover or sync config:
let pxe = EmbeddedPxe::create_with_config(
    node.clone(),
    kv,
    EmbeddedPxeConfig::default(),
).await?;

Accessors expose individual stores for advanced use: node(), contract_store(), key_store(), address_store(), note_store(), anchor_block_store(), private_event_store().

Module Map

ModuleHighlights
embedded_pxeEmbeddedPxe, EmbeddedPxeConfig, composition root and Pxe impl
storesAnchorBlockStore, NoteStore, PrivateEventStore, RecipientTaggingStore, SenderTaggingStore, KvStore, InMemoryKvStore, SledKvStore, plus private AddressStore / ContractStore / KeyStore / CapsuleStore / SenderStore
executionACVM executor, oracle handlers, note selection (pick_notes), utility-execution oracle, field conversion
kernelBbPrivateKernelProver, BbProverConfig, PrivateExecutionStep, PrivateKernelProver, PrivateKernelSimulateOutput, PrivateKernelOracle, PrivateKernelExecutionProver, SimulatedKernel, ChonkProofWithPublicInputs
syncBlockStateSynchronizer, BlockSyncConfig, ContractSyncService, EventService, LogService, NoteService, PrivateEventFilterValidator

Stores

The PXE keeps all state behind a KvStore abstraction. Two implementations ship:

  • InMemoryKvStore — ephemeral, fastest, ideal for tests.
  • SledKvStore — persistent, backed by sled.

Higher-level stores (NoteStore, PrivateEventStore, RecipientTaggingStore, SenderTaggingStore, AnchorBlockStore) are typed facades over the KV.

Execution

execution/ runs private function bodies through the ACVM (acvm_executor.rs) with oracle-based access to PXE state (oracle.rs, utility_oracle.rs). pick_notes.rs implements note selection for functions that consume notes.

Kernel

kernel/ folds the private-execution trace into kernel inputs and invokes the BB prover. Simulation-only flows go through SimulatedKernel; real proving through BbPrivateKernelProver using BbProverConfig.

Sync

BlockStateSynchronizer is the block follower. It pulls new blocks, routes logs to NoteService / EventService, and keeps tagging stores fresh for every registered account. BlockSyncConfig controls polling cadence and concurrency.

Full API

Bundled rustdoc: api/aztec_pxe/. Local regeneration:

cargo doc -p aztec-pxe --open

See Also