feat(public execution): allow public execution to access commitment trees

yarn-project/acir-simulator/src/acvm/acvm.ts

@@ -31,6 +31,9 @@ export interface ACIRCallback {
   storageWrite(params: ACVMField[]): Promise<[ACVMField]>;
   viewNotesPage(params: ACVMField[]): Promise<ACVMField[]>;
   getL1ToL2Message(params: ACVMField[]): Promise<ACVMField[]>;
+  // TODO(SEAN): change the transparent note syntax stuff
+  getTransparentMessage(params: ACVMField[]): Promise<ACVMField[]>;
+  notifyCreatedTransparentMessage(params: ACVMField[]): Promise<ACVMField[]>;
   /**
    * Logging utility for logging data.
    */

yarn-project/acir-simulator/src/client/db_oracle.ts

@@ -40,10 +40,17 @@ export interface MessageLoadOracleInputs {
   index: bigint;
 }
 
+// TODO(Maddiaa): Think about renaming these
 /**
- * The database oracle interface.
+ * Client Oracle
  */
-export interface DBOracle {
+export interface ClientOracle extends KeyOracle, DBOracle, ClientContractOracle{}
+
+
+/**
+ * The Key oracle interface
+ */
+export interface KeyOracle {
   getSecretKey(contractAddress: AztecAddress, address: AztecAddress): Promise<Buffer>;
   getNotes(
     contractAddress: AztecAddress,
@@ -56,7 +63,21 @@ export interface DBOracle {
     /** The notes. */
     notes: NoteLoadOracleInputs[];
   }>;
+}
+
+
+/**
+ * Client Contract oracle
+ */
+export interface ClientContractOracle {
   getFunctionABI(contractAddress: AztecAddress, functionSelector: Buffer): Promise<FunctionAbi>;
   getPortalContractAddress(contractAddress: AztecAddress): Promise<EthAddress>;
+}
+
+/**
+ * The database oracle interface.
+ * TODO(Maddiaa): This should be more generalised and not restricted to the local execution
+ */
+export interface DBOracle {
   getL1ToL2Message(msgKey: Fr): Promise<MessageLoadOracleInputs>;
 }

yarn-project/acir-simulator/src/client/private_execution.test.ts

@@ -34,15 +34,15 @@ import { default as levelup } from 'levelup';
 import { default as memdown, type MemDown } from 'memdown';
 import { encodeArguments } from '../abi_coder/index.js';
 import { NoirPoint, computeSlotForMapping, toPublicKey } from '../utils.js';
-import { DBOracle } from './db_oracle.js';
+import { ClientOracle } from './db_oracle.js';
 import { AcirSimulator } from './simulator.js';
 import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';
 
 const createMemDown = () => (memdown as any)() as MemDown<any, any>;
 
 describe('Private Execution test suite', () => {
   let bbWasm: BarretenbergWasm;
-  let oracle: ReturnType<typeof mock<DBOracle>>;
+  let oracle: ReturnType<typeof mock<ClientOracle>>;
   let acirSimulator: AcirSimulator;
   let logger: DebugLogger;
 
@@ -52,7 +52,7 @@ describe('Private Execution test suite', () => {
   });
 
   beforeEach(() => {
-    oracle = mock<DBOracle>();
+    oracle = mock<ClientOracle>();
     acirSimulator = new AcirSimulator(oracle);
   });
 

yarn-project/acir-simulator/src/client/private_execution.ts

@@ -26,9 +26,10 @@ import {
   toAcvmEnqueuePublicFunctionResult,
 } from '../acvm/index.js';
 import { sizeOfType } from '../index.js';
+import { PrivateExecutionContext } from '../execution_context.js';
 import { fieldsToFormattedStr } from './debug.js';
-import { ClientTxExecutionContext } from './client_execution_context.js';
 import { Tuple, assertLength } from '@aztec/foundation/serialize';
+import { TxExecutionRequest } from '@aztec/types';
 
 /**
  * The contents of a new note.
@@ -103,7 +104,8 @@ const notAvailable = () => {
  */
 export class PrivateFunctionExecution {
   constructor(
-    private context: ClientTxExecutionContext,
+    private context: PrivateExecutionContext,
+    private request: TxExecutionRequest,
     private abi: FunctionAbi,
     private contractAddress: AztecAddress,
     private functionData: FunctionData,
@@ -173,7 +175,7 @@ export class PrivateFunctionExecution {
         return toAcvmCallPrivateStackItem(childExecutionResult.callStackItem);
       },
       getL1ToL2Message: ([msgKey]: ACVMField[]) => this.context.getL1ToL2Message(fromACVMField(msgKey)),
-
+      getTransparentMessage: ([msgKey]: ACVMField[]) => this.context.getMessage(fromACVMField(msgKey)),
       debugLog: (fields: ACVMField[]) => {
         this.log(fieldsToFormattedStr(fields));
         return Promise.resolve([ZERO_ACVM_FIELD]);
@@ -193,6 +195,7 @@ export class PrivateFunctionExecution {
         enqueuedPublicFunctionCalls.push(enqueuedRequest);
         return toAcvmEnqueuePublicFunctionResult(enqueuedRequest);
       },
+      notifyCreatedTransparentMessage: notAvailable,
       viewNotesPage: notAvailable,
       storageRead: notAvailable,
       storageWrite: notAvailable,
@@ -249,10 +252,10 @@ export class PrivateFunctionExecution {
       this.callContext.portalContractAddress,
       this.callContext.storageContractAddress,
 
-      this.context.request.txContext.contractDeploymentData.constructorVkHash,
-      this.context.request.txContext.contractDeploymentData.contractAddressSalt,
-      this.context.request.txContext.contractDeploymentData.functionTreeRoot,
-      this.context.request.txContext.contractDeploymentData.portalContractAddress,
+      this.request.txContext.contractDeploymentData.constructorVkHash,
+      this.request.txContext.contractDeploymentData.contractAddressSalt,
+      this.request.txContext.contractDeploymentData.functionTreeRoot,
+      this.request.txContext.contractDeploymentData.portalContractAddress,
 
       this.context.historicRoots.contractTreeRoot,
       this.context.historicRoots.l1ToL2MessagesTreeRoot,
@@ -285,6 +288,7 @@ export class PrivateFunctionExecution {
 
     const nestedExecution = new PrivateFunctionExecution(
       this.context,
+      this.request,
       targetAbi,
       targetContractAddress,
       targetFunctionData,

yarn-project/acir-simulator/src/client/simulator.ts

@@ -6,8 +6,8 @@ import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { TxExecutionRequest } from '@aztec/types';
-import { ClientTxExecutionContext } from './client_execution_context.js';
-import { DBOracle } from './db_oracle.js';
+import { BaseExecutionContext, PrivateExecutionContext } from '../execution_context.js';
+import { ClientOracle, DBOracle } from './db_oracle.js';
 import { ExecutionResult, PrivateFunctionExecution } from './private_execution.js';
 import { UnconstrainedFunctionExecution } from './unconstrained_execution.js';
 
@@ -21,7 +21,7 @@ const OUTER_NULLIFIER_GENERATOR_INDEX = 7;
  * The ACIR simulator.
  */
 export class AcirSimulator {
-  constructor(private db: DBOracle) {}
+  constructor(private db: ClientOracle) {}
 
   /**
    * Runs a private function.
@@ -53,7 +53,8 @@ export class AcirSimulator {
     );
 
     const execution = new PrivateFunctionExecution(
-      new ClientTxExecutionContext(this.db, request, historicRoots),
+      new PrivateExecutionContext(this.db, historicRoots),
+      request,
       entryPointABI,
       contractAddress,
       request.functionData,
@@ -92,8 +93,9 @@ export class AcirSimulator {
       request.functionData.isConstructor,
     );
 
+    // TODO(Maddiaa): double check syntax here, maybe compose with the base context.
     const execution = new UnconstrainedFunctionExecution(
-      new ClientTxExecutionContext(this.db, request, historicRoots),
+      new PrivateExecutionContext(this.db, historicRoots),
       entryPointABI,
       contractAddress,
       request.functionData,

yarn-project/acir-simulator/src/client/unconstrained_execution.test.ts

@@ -16,20 +16,20 @@ import { TxExecutionRequest } from '@aztec/types';
 import { mock } from 'jest-mock-extended';
 import { encodeArguments } from '../abi_coder/index.js';
 import { NoirPoint, toPublicKey } from '../utils.js';
-import { DBOracle } from './db_oracle.js';
+import { ClientOracle } from './db_oracle.js';
 import { AcirSimulator } from './simulator.js';
 
 describe('Unconstrained Execution test suite', () => {
   let bbWasm: BarretenbergWasm;
-  let oracle: ReturnType<typeof mock<DBOracle>>;
+  let oracle: ReturnType<typeof mock<ClientOracle>>;
   let acirSimulator: AcirSimulator;
 
   beforeAll(async () => {
     bbWasm = await BarretenbergWasm.get();
   });
 
   beforeEach(() => {
-    oracle = mock<DBOracle>();
+    oracle = mock<ClientOracle>();
     acirSimulator = new AcirSimulator(oracle);
   });
 

yarn-project/acir-simulator/src/client/unconstrained_execution.ts

@@ -4,7 +4,7 @@ import { frToAztecAddress, frToNumber } from '../acvm/deserialize.js';
 import { FunctionAbi } from '@aztec/foundation/abi';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { decodeReturnValues } from '../abi_coder/decoder.js';
-import { ClientTxExecutionContext } from './client_execution_context.js';
+import { PrivateExecutionContext } from '../execution_context.js';
 import { select_return_flattened as selectReturnFlattened } from '@noir-lang/noir_util_wasm';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
@@ -19,7 +19,7 @@ const notAvailable = () => {
  */
 export class UnconstrainedFunctionExecution {
   constructor(
-    private context: ClientTxExecutionContext,
+    private context: PrivateExecutionContext,
     private abi: FunctionAbi,
     private contractAddress: AztecAddress,
     private functionData: FunctionData,
@@ -61,6 +61,10 @@ export class UnconstrainedFunctionExecution {
         return Promise.resolve([ZERO_ACVM_FIELD]);
       },
       getL1ToL2Message: ([msgKey]: ACVMField[]) => this.context.getL1ToL2Message(fromACVMField(msgKey)),
+
+      getTransparentMessage: notAvailable,
+      notifyCreatedTransparentMessage: notAvailable,
+
       enqueuePublicFunctionCall: notAvailable,
       notifyCreatedNote: notAvailable,
       notifyNullifiedNote: notAvailable,