@aztec/pxe 0.0.0-test.0

package/README.md

@@ -0,0 +1,13 @@
+# PXE Service & PXE
+
+`PXE Service` (pronounced "pixie service") is a server-side software that provides a set of apis for interacting with the Aztec network. It acts as a bridge between the network and client applications by exposing methods to manage accounts, deploy contracts, create transactions, and retrieve public and account-specific information. It provides a secure environment for the execution of sensitive operations, ensuring private information and decrypted data are not accessible to unauthorized applications. The PXE Service is a critical component of the Aztec network, and its security and reliability are essential to the overall trustworthiness of user's data.
+
+`PXE` is the interface the PXE Service and every client-side instance implement. Various implementations of the client-side can exist, including those for different platforms such as mobile apps and web browsers. It is a relay between the dApps and the actual PXE Service.
+
+### Main Components in an PXE Service
+
+- [Simulator](../simulator/)
+- [Key Store](../key-store/)
+- [Account State](./src/account_state/account_state.ts): It coordinates other components to synchronize and decrypt data, simulate transactions, and generate kernel proofs, for a specific account.
+
+![Pixie](./pixie.png)

package/dest/bin/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dest/bin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":""}

package/dest/bin/index.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env -S node --no-warnings
+import { createLogger } from '@aztec/foundation/log';
+import { createAztecNodeClient } from '@aztec/stdlib/interfaces/client';
+import { getPXEServiceConfig } from '../config/index.js';
+import { createPXEService } from '../entrypoints/server/utils.js';
+import { startPXEHttpServer } from '../pxe_http/index.js';
+const { PXE_PORT = 8080, AZTEC_NODE_URL = 'http://localhost:8079' } = process.env;
+const logger = createLogger('pxe:service');
+/**
+ * Create and start a new PXE HTTP Server
+ */ async function main() {
+    logger.info(`Setting up PXE...`);
+    const pxeConfig = getPXEServiceConfig();
+    const nodeRpcClient = createAztecNodeClient(AZTEC_NODE_URL, {});
+    const pxeService = await createPXEService(nodeRpcClient, pxeConfig);
+    const shutdown = ()=>{
+        logger.info('Shutting down...');
+        process.exit(0);
+    };
+    process.once('SIGINT', shutdown);
+    process.once('SIGTERM', shutdown);
+    startPXEHttpServer(pxeService, PXE_PORT);
+    logger.info(`PXE listening on port ${PXE_PORT}`);
+}
+main().catch((err)=>{
+    logger.error(err);
+    process.exit(1);
+});

package/dest/config/index.d.ts

@@ -0,0 +1,48 @@
+import { type ConfigMappingsType } from '@aztec/foundation/config';
+import { type DataStoreConfig } from '@aztec/kv-store/config';
+import { type ChainConfig } from '@aztec/stdlib/config';
+import type { Network } from '@aztec/stdlib/network';
+export { getPackageInfo } from './package_info.js';
+/**
+ * Temporary configuration until WASM can be used instead of native
+ */
+export interface BBProverConfig {
+    bbWorkingDirectory?: string;
+    bbBinaryPath?: string;
+    bbSkipCleanup?: boolean;
+}
+/**
+ * Configuration settings for the prover factory
+ */
+export interface KernelProverConfig {
+    /** Whether we are running with real proofs */
+    proverEnabled?: boolean;
+}
+/**
+ * Configuration settings for the PXE.
+ */
+export interface PXEConfig {
+    /** L2 block to start scanning from for new accounts */
+    l2StartingBlock: number;
+}
+export type PXEServiceConfig = PXEConfig & KernelProverConfig & BBProverConfig & DataStoreConfig & ChainConfig;
+export type CliPXEOptions = {
+    /** External Aztec network to connect to. e.g. devnet */
+    network?: Network;
+    /** API Key required by the external network's node */
+    apiKey?: string;
+    /** Custom Aztec Node URL to connect to  */
+    nodeUrl?: string;
+};
+export declare const pxeConfigMappings: ConfigMappingsType<PXEServiceConfig>;
+/**
+ * Creates an instance of PXEServiceConfig out of environment variables using sensible defaults for integration testing if not set.
+ */
+export declare function getPXEServiceConfig(): PXEServiceConfig;
+export declare const pxeCliConfigMappings: ConfigMappingsType<CliPXEOptions>;
+export declare const allPxeConfigMappings: ConfigMappingsType<CliPXEOptions & PXEServiceConfig>;
+/**
+ * Creates an instance of CliPxeOptions out of environment variables
+ */
+export declare function getCliPXEOptions(): CliPXEOptions & PXEServiceConfig;
+//# sourceMappingURL=index.d.ts.map

package/dest/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,kBAAkB,EAKxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAE,KAAK,WAAW,EAAuB,MAAM,sBAAsB,CAAC;AAC7E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,uDAAuD;IACvD,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,kBAAkB,GAAG,cAAc,GAAG,eAAe,GAAG,WAAW,CAAC;AAE/G,MAAM,MAAM,aAAa,GAAG;IAC1B,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,kBAAkB,CAAC,gBAAgB,CA0BlE,CAAC;AAEF;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,gBAAgB,CAEtD;AAED,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,CAAC,aAAa,CAclE,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,CAAC,aAAa,GAAG,gBAAgB,CAUrF,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,GAAG,gBAAgB,CAQnE"}

package/dest/config/index.js

@@ -0,0 +1,74 @@
+import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
+import { booleanConfigHelper, getConfigFromMappings, numberConfigHelper, parseBooleanEnv } from '@aztec/foundation/config';
+import { dataConfigMappings } from '@aztec/kv-store/config';
+import { chainConfigMappings } from '@aztec/stdlib/config';
+export { getPackageInfo } from './package_info.js';
+export const pxeConfigMappings = {
+    ...dataConfigMappings,
+    ...chainConfigMappings,
+    l2StartingBlock: {
+        env: 'PXE_L2_STARTING_BLOCK',
+        ...numberConfigHelper(INITIAL_L2_BLOCK_NUM),
+        description: 'L2 block to start scanning from for new accounts'
+    },
+    bbBinaryPath: {
+        env: 'BB_BINARY_PATH',
+        description: 'Path to the BB binary'
+    },
+    bbWorkingDirectory: {
+        env: 'BB_WORKING_DIRECTORY',
+        description: 'Working directory for the BB binary'
+    },
+    bbSkipCleanup: {
+        env: 'BB_SKIP_CLEANUP',
+        description: 'True to skip cleanup of temporary files for debugging purposes',
+        ...booleanConfigHelper()
+    },
+    proverEnabled: {
+        env: 'PXE_PROVER_ENABLED',
+        description: 'Enable real proofs',
+        ...booleanConfigHelper()
+    }
+};
+/**
+ * Creates an instance of PXEServiceConfig out of environment variables using sensible defaults for integration testing if not set.
+ */ export function getPXEServiceConfig() {
+    return getConfigFromMappings(pxeConfigMappings);
+}
+export const pxeCliConfigMappings = {
+    network: {
+        env: 'NETWORK',
+        parseEnv: (val)=>val,
+        description: 'External Aztec network to connect to. e.g. devnet'
+    },
+    apiKey: {
+        env: 'API_KEY',
+        description: "API Key required by the external network's node"
+    },
+    nodeUrl: {
+        env: 'AZTEC_NODE_URL',
+        description: 'Custom Aztec Node URL to connect to'
+    }
+};
+export const allPxeConfigMappings = {
+    ...pxeConfigMappings,
+    ...pxeCliConfigMappings,
+    ...dataConfigMappings,
+    proverEnabled: {
+        env: 'PXE_PROVER_ENABLED',
+        parseEnv: (val)=>parseBooleanEnv(val) || !!process.env.NETWORK,
+        description: 'Enable real proofs',
+        isBoolean: true
+    }
+};
+/**
+ * Creates an instance of CliPxeOptions out of environment variables
+ */ export function getCliPXEOptions() {
+    const pxeConfig = getPXEServiceConfig();
+    const cliOptions = getConfigFromMappings(pxeCliConfigMappings);
+    return {
+        ...pxeConfig,
+        ...cliOptions,
+        proverEnabled: pxeConfig.proverEnabled || !!cliOptions.network
+    };
+}

package/dest/config/package_info.d.ts

@@ -0,0 +1,5 @@
+export declare function getPackageInfo(): {
+    version: string;
+    name: string;
+};
+//# sourceMappingURL=package_info.d.ts.map

package/dest/config/package_info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package_info.d.ts","sourceRoot":"","sources":["../../src/config/package_info.ts"],"names":[],"mappings":"AAAA,wBAAgB,cAAc;;;EAE7B"}

package/dest/config/package_info.js

@@ -0,0 +1,6 @@
+export function getPackageInfo() {
+    return {
+        version: '0.1.0',
+        name: '@aztec/pxe'
+    };
+}

package/dest/entrypoints/client/bundle/index.d.ts

@@ -0,0 +1,6 @@
+export * from '../../../pxe_service/index.js';
+export * from '../../../config/index.js';
+export * from '../../../storage/index.js';
+export * from './utils.js';
+export { PXEOracleInterface } from '../../../pxe_oracle_interface/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/entrypoints/client/bundle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/entrypoints/client/bundle/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC"}

package/dest/entrypoints/client/bundle/index.js

@@ -0,0 +1,5 @@
+export * from '../../../pxe_service/index.js';
+export * from '../../../config/index.js';
+export * from '../../../storage/index.js';
+export * from './utils.js';
+export { PXEOracleInterface } from '../../../pxe_oracle_interface/index.js';

package/dest/entrypoints/client/bundle/utils.d.ts

@@ -0,0 +1,16 @@
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { PXEServiceConfig } from '../../../config/index.js';
+import { PXEService } from '../../../pxe_service/pxe_service.js';
+import type { PXECreationOptions } from '../pxe_creation_options.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.
+ * @returns A Promise that resolves to the started PXEService instance.
+ */
+export declare function createPXEService(aztecNode: AztecNode, config: PXEServiceConfig, options?: PXECreationOptions): Promise<PXEService>;
+//# sourceMappingURL=utils.d.ts.map

package/dest/entrypoints/client/bundle/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/entrypoints/client/bundle/utils.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CACpC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,gBAAgB,EACxB,OAAO,GAAE,kBAAoC,uBAiC9C"}

package/dest/entrypoints/client/bundle/utils.js

@@ -0,0 +1,30 @@
+import { BBWASMBundlePrivateKernelProver } from '@aztec/bb-prover/wasm/bundle';
+import { createLogger } from '@aztec/foundation/log';
+import { createStore } from '@aztec/kv-store/indexeddb';
+import { BundledProtocolContractsProvider } from '@aztec/protocol-contracts/providers/bundle';
+import { WASMSimulator } from '@aztec/simulator/client';
+import { PXEService } from '../../../pxe_service/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.
+ * @returns A Promise that resolves to the started PXEService instance.
+ */ export async function createPXEService(aztecNode, config, options = {
+    loggers: {}
+}) {
+    const l1Contracts = await aztecNode.getL1ContractAddresses();
+    const configWithContracts = {
+        ...config,
+        l1Contracts
+    };
+    const store = await createStore('pxe_data', configWithContracts, options.loggers.store ?? createLogger('pxe:data:indexeddb'));
+    const simulationProvider = new WASMSimulator();
+    const prover = options.prover ?? new BBWASMBundlePrivateKernelProver(simulationProvider, 16, options.loggers.prover ?? createLogger('bb:wasm:bundle'));
+    const protocolContractsProvider = new BundledProtocolContractsProvider();
+    const pxe = await PXEService.create(aztecNode, store, prover, simulationProvider, protocolContractsProvider, config, options.loggers.pxe ?? createLogger('pxe:service'));
+    return pxe;
+}

package/dest/entrypoints/client/lazy/index.d.ts

@@ -0,0 +1,6 @@
+export * from '../../../pxe_service/index.js';
+export * from '../../../config/index.js';
+export * from '../../../storage/index.js';
+export * from './utils.js';
+export { PXEOracleInterface } from '../../../pxe_oracle_interface/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/entrypoints/client/lazy/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/entrypoints/client/lazy/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC"}

package/dest/entrypoints/client/lazy/index.js

@@ -0,0 +1,5 @@
+export * from '../../../pxe_service/index.js';
+export * from '../../../config/index.js';
+export * from '../../../storage/index.js';
+export * from './utils.js';
+export { PXEOracleInterface } from '../../../pxe_oracle_interface/index.js';

package/dest/entrypoints/client/lazy/utils.d.ts

@@ -0,0 +1,15 @@
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { PXEServiceConfig } from '../../../config/index.js';
+import { PXEService } from '../../../pxe_service/pxe_service.js';
+import type { PXECreationOptions } from '../pxe_creation_options.js';
+/**
+ * Create and start an PXEService instance with the given AztecNode.
+ * 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
+ * @returns A Promise that resolves to the started PXEService instance.
+ */
+export declare function createPXEService(aztecNode: AztecNode, config: PXEServiceConfig, options?: PXECreationOptions): Promise<PXEService>;
+//# sourceMappingURL=utils.d.ts.map

package/dest/entrypoints/client/lazy/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/entrypoints/client/lazy/utils.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CACpC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,gBAAgB,EACxB,OAAO,GAAE,kBAAoC,uBA6B9C"}

package/dest/entrypoints/client/lazy/utils.js

@@ -0,0 +1,29 @@
+import { BBWASMLazyPrivateKernelProver } from '@aztec/bb-prover/wasm/lazy';
+import { createLogger } from '@aztec/foundation/log';
+import { createStore } from '@aztec/kv-store/indexeddb';
+import { LazyProtocolContractsProvider } from '@aztec/protocol-contracts/providers/lazy';
+import { WASMSimulator } from '@aztec/simulator/client';
+import { PXEService } from '../../../pxe_service/pxe_service.js';
+/**
+ * Create and start an PXEService instance with the given AztecNode.
+ * 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
+ * @returns A Promise that resolves to the started PXEService instance.
+ */ export async function createPXEService(aztecNode, config, options = {
+    loggers: {}
+}) {
+    const l1Contracts = await aztecNode.getL1ContractAddresses();
+    const configWithContracts = {
+        ...config,
+        l1Contracts
+    };
+    const store = await createStore('pxe_data', configWithContracts, options.loggers.store ?? createLogger('pxe:data:indexeddb'));
+    const simulationProvider = new WASMSimulator();
+    const prover = options.prover ?? new BBWASMLazyPrivateKernelProver(simulationProvider, 16, options.loggers.prover ?? createLogger('bb:wasm:lazy'));
+    const protocolContractsProvider = new LazyProtocolContractsProvider();
+    const pxe = await PXEService.create(aztecNode, store, prover, simulationProvider, protocolContractsProvider, config, options.loggers.pxe ?? createLogger('pxe:service'));
+    return pxe;
+}

package/dest/entrypoints/client/pxe_creation_options.d.ts

@@ -0,0 +1,11 @@
+import type { Logger } from '@aztec/foundation/log';
+import type { PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
+export type PXECreationOptions = {
+    loggers: {
+        store?: Logger;
+        pxe?: Logger;
+        prover?: Logger;
+    };
+    prover?: PrivateKernelProver;
+};
+//# sourceMappingURL=pxe_creation_options.d.ts.map

package/dest/entrypoints/client/pxe_creation_options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pxe_creation_options.d.ts","sourceRoot":"","sources":["../../../src/entrypoints/client/pxe_creation_options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3D,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B,CAAC"}

package/dest/entrypoints/client/pxe_creation_options.js

@@ -0,0 +1 @@
+export { };

package/dest/entrypoints/server/index.d.ts

@@ -0,0 +1,7 @@
+export * from '../../pxe_service/index.js';
+export * from '../../pxe_http/index.js';
+export * from '../../config/index.js';
+export * from '../../storage/index.js';
+export * from './utils.js';
+export { PXEOracleInterface } from '../../pxe_oracle_interface/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/entrypoints/server/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/entrypoints/server/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC"}

package/dest/entrypoints/server/index.js

@@ -0,0 +1,6 @@
+export * from '../../pxe_service/index.js';
+export * from '../../pxe_http/index.js';
+export * from '../../config/index.js';
+export * from '../../storage/index.js';
+export * from './utils.js';
+export { PXEOracleInterface } from '../../pxe_oracle_interface/index.js';

package/dest/entrypoints/server/utils.d.ts

@@ -0,0 +1,16 @@
+import type { AztecNode, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
+import type { PXEServiceConfig } from '../../config/index.js';
+import { PXEService } from '../../pxe_service/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 useLogSuffix - (Optional) Log suffix for PXE's logger.
+ * @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 declare function createPXEService(aztecNode: AztecNode, config: PXEServiceConfig, useLogSuffix?: string | boolean | undefined, proofCreator?: PrivateKernelProver): Promise<PXEService>;
+//# sourceMappingURL=utils.d.ts.map

package/dest/entrypoints/server/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/entrypoints/server/utils.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAG9D;;;;;;;;;;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,uBA+BnC"}

package/dest/entrypoints/server/utils.js

@@ -0,0 +1,45 @@
+import { BBNativePrivateKernelProver } from '@aztec/bb-prover';
+import { BBWASMBundlePrivateKernelProver } from '@aztec/bb-prover/wasm/bundle';
+import { randomBytes } from '@aztec/foundation/crypto';
+import { createLogger } from '@aztec/foundation/log';
+import { createStore } from '@aztec/kv-store/lmdb-v2';
+import { BundledProtocolContractsProvider } from '@aztec/protocol-contracts/providers/bundle';
+import { WASMSimulator } from '@aztec/simulator/client';
+import { PXEService } from '../../pxe_service/pxe_service.js';
+import { PXE_DATA_SCHEMA_VERSION } from './index.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 useLogSuffix - (Optional) Log suffix for PXE's logger.
+ * @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 store = await createStore('pxe_data', PXE_DATA_SCHEMA_VERSION, configWithContracts, createLogger('pxe:data:lmdb'));
+    const simulationProvider = new WASMSimulator();
+    const prover = proofCreator ?? await createProver(config, simulationProvider, logSuffix);
+    const protocolContractsProvider = new BundledProtocolContractsProvider();
+    const pxe = await PXEService.create(aztecNode, store, prover, simulationProvider, protocolContractsProvider, config, logSuffix);
+    return pxe;
+}
+function createProver(config, simulationProvider, logSuffix) {
+    if (!config.bbBinaryPath || !config.bbWorkingDirectory) {
+        return new BBWASMBundlePrivateKernelProver(simulationProvider, 16);
+    } else {
+        const bbConfig = config;
+        const log = createLogger('pxe:bb-native-prover' + (logSuffix ? `:${logSuffix}` : ''));
+        return BBNativePrivateKernelProver.new({
+            bbSkipCleanup: false,
+            ...bbConfig
+        }, simulationProvider, log);
+    }
+}

package/dest/kernel_oracle/index.d.ts

@@ -0,0 +1,45 @@
+import { type NOTE_HASH_TREE_HEIGHT } from '@aztec/constants';
+import type { Fr, GrumpkinScalar, Point } from '@aztec/foundation/fields';
+import { MembershipWitness } from '@aztec/foundation/trees';
+import type { KeyStore } from '@aztec/key-store';
+import type { FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { L2BlockNumber } from '@aztec/stdlib/block';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import { UpdatedClassIdHints } from '@aztec/stdlib/kernel';
+import type { NullifierMembershipWitness } from '@aztec/stdlib/trees';
+import type { VerificationKeyAsFields } from '@aztec/stdlib/vks';
+import type { ContractDataProvider } from '../storage/contract_data_provider/contract_data_provider.js';
+import type { ProvingDataOracle } from './../kernel_prover/proving_data_oracle.js';
+/**
+ * A data oracle that provides information needed for simulating a transaction.
+ */
+export declare class KernelOracle implements ProvingDataOracle {
+    private contractDataProvider;
+    private keyStore;
+    private node;
+    private blockNumber;
+    private log;
+    constructor(contractDataProvider: ContractDataProvider, keyStore: KeyStore, node: AztecNode, blockNumber?: L2BlockNumber, log?: import("@aztec/foundation/log").Logger);
+    getContractAddressPreimage(address: AztecAddress): Promise<{
+        version: 1;
+        salt: Fr;
+        deployer: AztecAddress;
+        currentContractClassId: Fr;
+        originalContractClassId: Fr;
+        initializationHash: Fr;
+        publicKeys: import("@aztec/aztec.js").PublicKeys;
+        address: AztecAddress;
+        saltedInitializationHash: Fr;
+    }>;
+    getContractClassIdPreimage(contractClassId: Fr): Promise<import("@aztec/stdlib/contract").ContractClassIdPreimage>;
+    getFunctionMembershipWitness(contractClassId: Fr, selector: FunctionSelector): Promise<MembershipWitness<5>>;
+    getVkMembershipWitness(vk: VerificationKeyAsFields): Promise<MembershipWitness<6>>;
+    getNoteHashMembershipWitness(leafIndex: bigint): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT>>;
+    getNullifierMembershipWitness(nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+    getNoteHashTreeRoot(): Promise<Fr>;
+    getMasterSecretKey(masterPublicKey: Point): Promise<GrumpkinScalar>;
+    getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector): Promise<string>;
+    getUpdatedClassIdHints(contractAddress: AztecAddress): Promise<UpdatedClassIdHints>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dest/kernel_oracle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/kernel_oracle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,qBAAqB,EAA2C,MAAM,kBAAkB,CAAC;AACvG,OAAO,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AAG1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAEjE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6DAA6D,CAAC;AACxG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAInF;;GAEG;AACH,qBAAa,YAAa,YAAW,iBAAiB;IAElD,OAAO,CAAC,oBAAoB;IAC5B,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,GAAG;gBAJH,oBAAoB,EAAE,oBAAoB,EAC1C,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,SAAS,EACf,WAAW,GAAE,aAAwB,EACrC,GAAG,yCAAoC;IAGpC,0BAA0B,CAAC,OAAO,EAAE,YAAY;;;;;;;;;;;IAQhD,0BAA0B,CAAC,eAAe,EAAE,EAAE;IAK9C,4BAA4B,CAAC,eAAe,EAAE,EAAE,EAAE,QAAQ,EAAE,gBAAgB;IAIlF,sBAAsB,CAAC,EAAE,EAAE,uBAAuB;IAKnD,4BAA4B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,qBAAqB,CAAC,CAAC;IAS/G,6BAA6B,CAAC,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAIvF,mBAAmB,IAAI,OAAO,CAAC,EAAE,CAAC;IAQjC,kBAAkB,CAAC,eAAe,EAAE,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC;IAInE,oBAAoB,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1F,sBAAsB,CAAC,eAAe,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA6BjG"}

package/dest/kernel_oracle/index.js

@@ -0,0 +1,76 @@
+import { PUBLIC_DATA_TREE_HEIGHT, VK_TREE_HEIGHT } from '@aztec/constants';
+import { createLogger } from '@aztec/foundation/log';
+import { MembershipWitness } from '@aztec/foundation/trees';
+import { getVKIndex, getVKSiblingPath } from '@aztec/noir-protocol-circuits-types/vk-tree';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { computeContractClassIdPreimage, computeSaltedInitializationHash } from '@aztec/stdlib/contract';
+import { computePublicDataTreeLeafSlot } from '@aztec/stdlib/hash';
+import { UpdatedClassIdHints } from '@aztec/stdlib/kernel';
+import { SharedMutableValues, SharedMutableValuesWithHash } from '@aztec/stdlib/shared-mutable';
+// TODO: Block number should not be "latest".
+// It should be fixed at the time the proof is being simulated. I.e., it should be the same as the value defined in the constant data.
+/**
+ * A data oracle that provides information needed for simulating a transaction.
+ */ export class KernelOracle {
+    contractDataProvider;
+    keyStore;
+    node;
+    blockNumber;
+    log;
+    constructor(contractDataProvider, keyStore, node, blockNumber = 'latest', log = createLogger('pxe:kernel_oracle')){
+        this.contractDataProvider = contractDataProvider;
+        this.keyStore = keyStore;
+        this.node = node;
+        this.blockNumber = blockNumber;
+        this.log = log;
+    }
+    async getContractAddressPreimage(address) {
+        const instance = await this.contractDataProvider.getContractInstance(address);
+        return {
+            saltedInitializationHash: await computeSaltedInitializationHash(instance),
+            ...instance
+        };
+    }
+    async getContractClassIdPreimage(contractClassId) {
+        const contractClass = await this.contractDataProvider.getContractClass(contractClassId);
+        return computeContractClassIdPreimage(contractClass);
+    }
+    async getFunctionMembershipWitness(contractClassId, selector) {
+        return await this.contractDataProvider.getFunctionMembershipWitness(contractClassId, selector);
+    }
+    getVkMembershipWitness(vk) {
+        const leafIndex = getVKIndex(vk);
+        return Promise.resolve(new MembershipWitness(VK_TREE_HEIGHT, BigInt(leafIndex), getVKSiblingPath(leafIndex)));
+    }
+    async getNoteHashMembershipWitness(leafIndex) {
+        const path = await this.node.getNoteHashSiblingPath(this.blockNumber, leafIndex);
+        return new MembershipWitness(path.pathSize, leafIndex, path.toFields());
+    }
+    getNullifierMembershipWitness(nullifier) {
+        return this.node.getNullifierMembershipWitness(this.blockNumber, nullifier);
+    }
+    async getNoteHashTreeRoot() {
+        const header = await this.node.getBlockHeader(this.blockNumber);
+        if (!header) {
+            throw new Error(`No block header found for block number ${this.blockNumber}`);
+        }
+        return header.state.partial.noteHashTree.root;
+    }
+    getMasterSecretKey(masterPublicKey) {
+        return this.keyStore.getMasterSecretKey(masterPublicKey);
+    }
+    getDebugFunctionName(contractAddress, selector) {
+        return this.contractDataProvider.getDebugFunctionName(contractAddress, selector);
+    }
+    async getUpdatedClassIdHints(contractAddress) {
+        const { sharedMutableSlot, sharedMutableHashSlot } = await SharedMutableValuesWithHash.getContractUpdateSlots(contractAddress);
+        const hashLeafSlot = await computePublicDataTreeLeafSlot(ProtocolContractAddress.ContractInstanceDeployer, sharedMutableHashSlot);
+        const updatedClassIdWitness = await this.node.getPublicDataTreeWitness(this.blockNumber, hashLeafSlot);
+        if (!updatedClassIdWitness) {
+            throw new Error(`No public data tree witness found for ${hashLeafSlot}`);
+        }
+        const readStorage = (storageSlot)=>this.node.getPublicStorageAt(this.blockNumber, ProtocolContractAddress.ContractInstanceDeployer, storageSlot);
+        const sharedMutableValues = await SharedMutableValues.readFromTree(sharedMutableSlot, readStorage);
+        return new UpdatedClassIdHints(new MembershipWitness(PUBLIC_DATA_TREE_HEIGHT, updatedClassIdWitness.index, updatedClassIdWitness.siblingPath.toTuple()), updatedClassIdWitness.leafPreimage, sharedMutableValues);
+    }
+}

package/dest/kernel_prover/hints/build_private_kernel_reset_private_inputs.d.ts

@@ -0,0 +1,28 @@
+import { type PrivateKernelCircuitPublicInputs, PrivateKernelResetCircuitPrivateInputs, type PrivateKernelSimulateOutput } from '@aztec/stdlib/kernel';
+import { type PrivateCallExecutionResult } from '@aztec/stdlib/tx';
+import type { ProvingDataOracle } from '../proving_data_oracle.js';
+export declare class PrivateKernelResetPrivateInputsBuilder {
+    private previousKernelOutput;
+    private executionStack;
+    private noteHashNullifierCounterMap;
+    private validationRequestsSplitCounter;
+    private previousKernel;
+    private nextIteration?;
+    private noteHashResetStates;
+    private nullifierResetStates;
+    private numTransientData?;
+    private transientDataIndexHints;
+    private requestedDimensions;
+    constructor(previousKernelOutput: PrivateKernelSimulateOutput<PrivateKernelCircuitPublicInputs>, executionStack: PrivateCallExecutionResult[], noteHashNullifierCounterMap: Map<number, number>, validationRequestsSplitCounter: number);
+    needsReset(): boolean;
+    build(oracle: ProvingDataOracle, noteHashLeafIndexMap: Map<bigint, bigint>): Promise<PrivateKernelResetCircuitPrivateInputs>;
+    private reduceReadRequestStates;
+    private needsResetNoteHashReadRequests;
+    private needsResetNullifierReadRequests;
+    private needsResetNullifierKeys;
+    private needsResetTransientData;
+    private needsSiloNoteHashes;
+    private needsSiloNullifiers;
+    private needsSiloPrivateLogs;
+}
+//# sourceMappingURL=build_private_kernel_reset_private_inputs.d.ts.map

package/dest/kernel_prover/hints/build_private_kernel_reset_private_inputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build_private_kernel_reset_private_inputs.d.ts","sourceRoot":"","sources":["../../../src/kernel_prover/hints/build_private_kernel_reset_private_inputs.ts"],"names":[],"mappings":"AAeA,OAAO,EAGL,KAAK,gCAAgC,EAErC,sCAAsC,EAGtC,KAAK,2BAA2B,EAkBjC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,0BAA0B,EAAiB,MAAM,kBAAkB,CAAC;AAElF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAiDnE,qBAAa,sCAAsC;IAY/C,OAAO,CAAC,oBAAoB;IAC5B,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,2BAA2B;IACnC,OAAO,CAAC,8BAA8B;IAdxC,OAAO,CAAC,cAAc,CAAmC;IAEzD,OAAO,CAAC,aAAa,CAAC,CAA6B;IAEnD,OAAO,CAAC,mBAAmB,CAAoE;IAC/F,OAAO,CAAC,oBAAoB,CAAoE;IAChG,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAClC,OAAO,CAAC,uBAAuB,CAA8D;IAC7F,OAAO,CAAC,mBAAmB,CAA+B;gBAGhD,oBAAoB,EAAE,2BAA2B,CAAC,gCAAgC,CAAC,EACnF,cAAc,EAAE,0BAA0B,EAAE,EAC5C,2BAA2B,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAChD,8BAA8B,EAAE,MAAM;IAahD,UAAU,IAAI,OAAO;IAwBf,KAAK,CAAC,MAAM,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAgEhF,OAAO,CAAC,uBAAuB;IA2B/B,OAAO,CAAC,8BAA8B;IAoDtC,OAAO,CAAC,+BAA+B;IAoDvC,OAAO,CAAC,uBAAuB;IAiB/B,OAAO,CAAC,uBAAuB;IAmE/B,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,oBAAoB;CAmB7B"}