@aztec/txe 5.0.0-private.20260319 → 5.0.0-rc.1

package/dest/index.js

@@ -1,35 +1,25 @@
-import { SchnorrAccountContractArtifact } from '@aztec/accounts/schnorr';
-import { loadContractArtifact } from '@aztec/aztec.js/abi';
-import { AztecAddress } from '@aztec/aztec.js/addresses';
-import { getContractInstanceFromInstantiationParams } from '@aztec/aztec.js/contracts';
 import { Fr } from '@aztec/aztec.js/fields';
-import { PublicKeys, deriveKeys } from '@aztec/aztec.js/keys';
-import { createSafeJsonRpcServer } from '@aztec/foundation/json-rpc/server';
-import { openTmpStore } from '@aztec/kv-store/lmdb-v2';
-import { protocolContractNames } from '@aztec/protocol-contracts';
-import { BundledProtocolContractsProvider } from '@aztec/protocol-contracts/providers/bundle';
-import { ContractStore } from '@aztec/pxe/server';
-import { computeArtifactHash } from '@aztec/stdlib/contract';
+import { cloneEphemeralStoreFrom } from '@aztec/kv-store/lmdb-v2';
+import { ContractStore } from '@aztec/pxe/client/lazy';
 import { zodFor } from '@aztec/stdlib/schemas';
-import { createHash } from 'crypto';
-import { createReadStream } from 'fs';
-import { readFile, readdir } from 'fs/promises';
-import { join, parse } from 'path';
+import { join } from 'path';
 import { z } from 'zod';
+// Side-effect import: registers the msgpackr Fr extension for the bundled `Fr` class. Must
+// be loaded before any `sendMessage` call. See msgpackr_fr_extension.ts for the why.
+import './msgpackr_fr_extension.js';
 import { TXESession } from './txe_session.js';
-import { ForeignCallArgsSchema, ForeignCallResultSchema, addressFromSingle, fromArray, fromSingle, toSingle } from './util/encoding.js';
+import { ForeignCallArgsSchema, ForeignCallResultSchema } from './utils/encoding.js';
+import { TXEArtifactResolver } from './utils/txe_artifact_resolver.js';
+// Protocol contracts TXE registers in its contract store. Only AuthRegistry is needed for the
+// current test suites; add a contract here if a lookup against a `0x000…00X` address fails.
+export const TXE_REQUIRED_PROTOCOL_CONTRACTS = [];
 const sessions = new Map();
-/*
- * TXE typically has to load the same contract artifacts over and over again for multiple tests,
- * so we cache them here to avoid loading from disk repeatedly.
- *
- * The in-flight map coalesces concurrent requests for the same cache key so that
- * computeArtifactHash (very expensive) is only run once even under parallelism.
- */ const TXEArtifactsCache = new Map();
-const TXEArtifactsCacheInFlight = new Map();
-const TXEForeignCallInputSchema = zodFor()(z.object({
+export const TXEForeignCallInputSchema = zodFor()(z.object({
+    // Nargo generates session_id as a u64, which may exceed Number.MAX_SAFE_INTEGER.
+    // Zod 4's `.int()` enforces the safe-integer bound, so we drop it here and only require
+    // the value to be a non-negative number (it is used solely as a Map key).
     // eslint-disable-next-line camelcase
-    session_id: z.number().int().nonnegative(),
+    session_id: z.number().nonnegative(),
     function: z.string(),
     // eslint-disable-next-line camelcase
     root_path: z.string(),
@@ -37,184 +27,74 @@ const TXEForeignCallInputSchema = zodFor()(z.object({
     package_name: z.string(),
     inputs: ForeignCallArgsSchema
 }));
-class TXEDispatcher {
+export class TXEDispatcher {
     logger;
     contractStore;
-    constructor(logger){
+    artifactResolver;
+    contractStoreSourceDir;
+    schnorrClassId;
+    constructor(logger, opts){
         this.logger = logger;
+        this.contractStoreSourceDir = opts.contractStoreSourceDir;
+        this.schnorrClassId = Fr.fromString(opts.schnorrClassId);
     }
-    fastHashFile(path) {
-        return new Promise((resolve)=>{
-            const fd = createReadStream(path);
-            const hash = createHash('sha1');
-            hash.setEncoding('hex');
-            fd.on('end', function() {
-                hash.end();
-                resolve(hash.read());
-            });
-            fd.pipe(hash);
-        });
-    }
-    async #processDeployInputs({ inputs, root_path: rootPath, package_name: packageName }) {
-        const [contractPath, initializer] = inputs.slice(0, 2).map((input)=>fromArray(input).map((char)=>String.fromCharCode(char.toNumber())).join(''));
-        const decodedArgs = fromArray(inputs[3]);
-        const secret = fromSingle(inputs[4]);
-        const salt = fromSingle(inputs[5]);
-        const deployer = addressFromSingle(inputs[6]);
-        const publicKeys = secret.equals(Fr.ZERO) ? PublicKeys.default() : (await deriveKeys(secret)).publicKeys;
-        const publicKeysHash = await publicKeys.hash();
-        let artifactPath = '';
-        const { dir: contractDirectory, base: contractFilename } = parse(contractPath);
-        if (contractDirectory) {
-            if (contractDirectory.includes('@')) {
-                // We're deploying a contract that belongs in a workspace
-                // env.deploy("../path/to/workspace/root@packageName/contractName")
-                const [workspace, pkg] = contractDirectory.split('@');
-                const targetPath = join(rootPath, workspace, '/target');
-                this.logger.debug(`Looking for compiled artifact in workspace ${targetPath}`);
-                artifactPath = join(targetPath, `${pkg}-${contractFilename}.json`);
-            } else {
-                // We're deploying a standalone external contract
-                // env.deploy("../path/to/contract/root/contractName")
-                const targetPath = join(rootPath, contractDirectory, '/target');
-                this.logger.debug(`Looking for compiled artifact in ${targetPath}`);
-                [artifactPath] = (await readdir(targetPath)).filter((file)=>file.endsWith(`-${contractFilename}.json`));
-            }
-        } else {
-            // We're deploying a local contract
-            // env.deploy("contractName")
-            artifactPath = join(rootPath, './target', `${packageName}-${contractFilename}.json`);
-        }
-        const fileHash = await this.fastHashFile(artifactPath);
-        const cacheKey = `${contractDirectory ?? ''}-${contractFilename}-${initializer}-${decodedArgs.map((arg)=>arg.toString()).join('-')}-${publicKeysHash}-${salt}-${deployer}-${fileHash}`;
-        let instance;
-        let artifact;
-        if (TXEArtifactsCache.has(cacheKey)) {
-            this.logger.debug(`Using cached artifact for ${cacheKey}`);
-            ({ artifact, instance } = TXEArtifactsCache.get(cacheKey));
-        } else {
-            if (!TXEArtifactsCacheInFlight.has(cacheKey)) {
-                this.logger.debug(`Loading compiled artifact ${artifactPath}`);
-                const compute = async ()=>{
-                    const artifactJSON = JSON.parse(await readFile(artifactPath, 'utf-8'));
-                    const artifactWithoutHash = loadContractArtifact(artifactJSON);
-                    const computedArtifact = {
-                        ...artifactWithoutHash,
-                        // Artifact hash is *very* expensive to compute, so we do it here once
-                        // and the TXE contract data provider can cache it
-                        artifactHash: await computeArtifactHash(artifactWithoutHash)
-                    };
-                    this.logger.debug(`Deploy ${computedArtifact.name} with initializer ${initializer}(${decodedArgs}) and public keys hash ${publicKeysHash.toString()}`);
-                    const computedInstance = await getContractInstanceFromInstantiationParams(computedArtifact, {
-                        constructorArgs: decodedArgs,
-                        skipArgsDecoding: true,
-                        salt,
-                        publicKeys,
-                        constructorArtifact: initializer ? initializer : undefined,
-                        deployer
-                    });
-                    const result = {
-                        artifact: computedArtifact,
-                        instance: computedInstance
-                    };
-                    TXEArtifactsCache.set(cacheKey, result);
-                    TXEArtifactsCacheInFlight.delete(cacheKey);
-                    return result;
-                };
-                TXEArtifactsCacheInFlight.set(cacheKey, compute());
-            }
-            ({ artifact, instance } = await TXEArtifactsCacheInFlight.get(cacheKey));
+    /**
+   * Clones the pre-populated LMDB at `contractStoreSourceDir` into a fresh per-instance tmpdir
+   * on first use, so this dispatcher has a writable store already containing the required
+   * protocol contracts + SchnorrAccount. Idempotent — subsequent calls are no-ops.
+   */ async warmUp() {
+        if (this.contractStore) {
+            return;
         }
-        inputs.splice(0, 1, artifact, instance, toSingle(secret));
-    }
-    async #processAddAccountInputs({ inputs }) {
-        const secret = fromSingle(inputs[0]);
-        const cacheKey = `SchnorrAccountContract-${secret}`;
-        let artifact;
-        let instance;
-        if (TXEArtifactsCache.has(cacheKey)) {
-            this.logger.debug(`Using cached artifact for ${cacheKey}`);
-            ({ artifact, instance } = TXEArtifactsCache.get(cacheKey));
-        } else {
-            if (!TXEArtifactsCacheInFlight.has(cacheKey)) {
-                const compute = async ()=>{
-                    const keys = await deriveKeys(secret);
-                    const args = [
-                        keys.publicKeys.masterIncomingViewingPublicKey.x,
-                        keys.publicKeys.masterIncomingViewingPublicKey.y
-                    ];
-                    const computedArtifact = {
-                        ...SchnorrAccountContractArtifact,
-                        // Artifact hash is *very* expensive to compute, so we do it here once
-                        // and the TXE contract data provider can cache it
-                        artifactHash: await computeArtifactHash(SchnorrAccountContractArtifact)
-                    };
-                    const computedInstance = await getContractInstanceFromInstantiationParams(computedArtifact, {
-                        constructorArgs: args,
-                        skipArgsDecoding: true,
-                        salt: Fr.ONE,
-                        publicKeys: keys.publicKeys,
-                        constructorArtifact: 'constructor',
-                        deployer: AztecAddress.ZERO
-                    });
-                    const result = {
-                        artifact: computedArtifact,
-                        instance: computedInstance
-                    };
-                    TXEArtifactsCache.set(cacheKey, result);
-                    TXEArtifactsCacheInFlight.delete(cacheKey);
-                    return result;
-                };
-                TXEArtifactsCacheInFlight.set(cacheKey, compute());
-            }
-            ({ artifact, instance } = await TXEArtifactsCacheInFlight.get(cacheKey));
-        }
-        inputs.splice(0, 0, artifact, instance);
+        const t0 = Date.now();
+        const kvStore = await cloneEphemeralStoreFrom(join(this.contractStoreSourceDir, 'data.mdb'), 'txe-contracts', undefined, 2);
+        this.contractStore = new ContractStore(kvStore);
+        this.artifactResolver = new TXEArtifactResolver(this.contractStore, this.schnorrClassId);
+        this.logger.debug('Cloned shared protocol-contracts store', {
+            totalMs: Date.now() - t0
+        });
     }
     // eslint-disable-next-line camelcase
     async resolve_foreign_call(callData) {
-        const { session_id: sessionId, function: functionName, inputs } = callData;
+        const { session_id: sessionId, function: functionName, inputs, root_path: rootPath, package_name: packageName } = callData;
         this.logger.debug(`Calling ${functionName} on session ${sessionId}`);
         if (!sessions.has(sessionId)) {
             this.logger.debug(`Creating new session ${sessionId}`);
-            if (!this.contractStore) {
-                const kvStore = await openTmpStore('txe-contracts');
-                this.contractStore = new ContractStore(kvStore);
-                const provider = new BundledProtocolContractsProvider();
-                for (const name of protocolContractNames){
-                    const { instance, artifact } = await provider.getProtocolContractArtifact(name);
-                    await this.contractStore.addContractArtifact(artifact);
-                    await this.contractStore.addContractInstance(instance);
-                }
-                this.logger.debug('Registered protocol contracts in shared contract store');
-            }
-            sessions.set(sessionId, await TXESession.init(this.contractStore));
-        }
-        switch(functionName){
-            case 'aztec_txe_deploy':
-                {
-                    await this.#processDeployInputs(callData);
-                    break;
-                }
-            case 'aztec_txe_addAccount':
-                {
-                    await this.#processAddAccountInputs(callData);
-                    break;
-                }
+            await this.warmUp();
+            sessions.set(sessionId, await TXESession.init(this.contractStore, this.artifactResolver, rootPath, packageName));
         }
         return await sessions.get(sessionId).processFunction(functionName, inputs);
     }
+    /**
+   * Releases a session and its resources (per-session LMDB + `NativeWorldStateService`).
+   * Called by the dispatcher pool when nargo closes its TCP connection for a test (see
+   * `rpc_server.ts`'s socket tracker). No-op if the session was never created — that happens
+   * when nargo opens a connection but errors before sending a request.
+   */ async disposeSession(sessionId) {
+        const session = sessions.get(sessionId);
+        if (!session) {
+            return;
+        }
+        sessions.delete(sessionId);
+        await session.dispose();
+    }
 }
-const TXEDispatcherApiSchema = {
+/** Diagnostic-only: number of sessions currently held by this worker. */ export function activeSessionCount() {
+    return sessions.size;
+}
+export const TXEDispatcherApiSchema = {
     // eslint-disable-next-line camelcase
-    resolve_foreign_call: z.function().args(TXEForeignCallInputSchema).returns(ForeignCallResultSchema)
+    resolve_foreign_call: z.function({
+        input: z.tuple([
+            TXEForeignCallInputSchema
+        ]),
+        output: ForeignCallResultSchema
+    }),
+    // disposeSession is invoked over IPC from the worker, not via RPC; required by ApiSchemaFor.
+    disposeSession: z.function({
+        input: z.tuple([
+            z.number().nonnegative()
+        ]),
+        output: z.void()
+    })
 };
-/**
- * Creates an RPC server that forwards calls to the TXE.
- * @param logger - Logger to output to
- * @returns A TXE RPC server.
- */ export function createTXERpcServer(logger) {
-    return createSafeJsonRpcServer(new TXEDispatcher(logger), TXEDispatcherApiSchema, {
-        http200OnError: true
-    });
-}