partially set up MP deser

Author: fcarreiro

yarn-project/simulator/src/public/public_processor/public_processor.test.ts

@@ -16,7 +16,7 @@ import { strict as assert } from 'assert';
 import { type MockProxy, mock } from 'jest-mock-extended';
 
 import { PublicContractsDB } from '../public_db_sources.js';
-import type { PublicTxResult, PublicTxSimulator } from '../public_tx_simulator/public_tx_simulator.js';
+import { PublicTxResult, type PublicTxSimulator } from '../public_tx_simulator/public_tx_simulator.js';
 import { GuardedMerkleTreeOperations } from './guarded_merkle_tree.js';
 import { PublicProcessor } from './public_processor.js';
 
@@ -45,19 +45,15 @@ describe('public_processor', () => {
 
     const stateReference = StateReference.empty();
 
-    mockedEnqueuedCallsResult = {
-      hints: AvmExecutionHints.empty(),
-      publicInputs: AvmCircuitPublicInputs.empty(),
-      gasUsed: {
-        totalGas: Gas.empty(),
-        teardownGas: Gas.empty(),
-        publicGas: Gas.empty(),
-        billedGas: Gas.empty(),
-      },
-      revertCode: RevertCode.OK,
-      appLogicReturnValue: [],
-      logs: [],
-    };
+    mockedEnqueuedCallsResult = new PublicTxResult(
+      /*gasUsed=*/ { totalGas: Gas.empty(), teardownGas: Gas.empty(), publicGas: Gas.empty(), billedGas: Gas.empty() },
+      RevertCode.OK,
+      undefined,
+      /*appLogicReturnValue=*/ [],
+      /*logs=*/ [],
+      AvmExecutionHints.empty(),
+      AvmCircuitPublicInputs.empty(),
+    );
 
     merkleTree.getPreviousValueIndex.mockResolvedValue({
       index: 0n,

yarn-project/simulator/src/public/public_tx_simulator/cpp_public_tx_simulator.ts

@@ -5,9 +5,11 @@ import { SimulationError } from '@aztec/stdlib/errors';
 import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
 import type { GlobalVariables, Tx } from '@aztec/stdlib/tx';
 
+import { strict as assert } from 'assert';
+
 import type { ExecutorMetricsInterface } from '../executor_metrics_interface.js';
 import type { PublicContractsDB } from '../public_db_sources.js';
-import { type PublicTxResult, PublicTxSimulator, type PublicTxSimulatorConfig } from './public_tx_simulator.js';
+import { PublicTxResult, PublicTxSimulator, type PublicTxSimulatorConfig } from './public_tx_simulator.js';
 import type {
   MeasuredPublicTxSimulatorInterface,
   PublicTxSimulatorInterface,
@@ -80,7 +82,11 @@ export class CppPublicTxSimulatorHintedDbs extends PublicTxSimulator implements
     }
 
     // Deserialize the msgpack result
-    const cppResult: PublicTxResult = deserializeFromMessagePack<PublicTxResult>(resultBuffer);
+    const cppResultJSON: any = deserializeFromMessagePack(resultBuffer);
+    // TODO(fcarreiro): complete this.
+    // console.log('cppResult', cppResultJSON);
+    const cppResult = PublicTxResult.partialSchema.parse(cppResultJSON);
+    assert(cppResult.revertCode.equals(tsResult.revertCode));
 
     this.log.debug(`C++ hinted simulation completed for tx ${txHash}`, {
       txHash,
@@ -89,7 +95,8 @@ export class CppPublicTxSimulatorHintedDbs extends PublicTxSimulator implements
       cppGasUsed: tsResult.gasUsed.totalGas.l2Gas,
     });
 
-    return cppResult;
+    // TODO(fcarreiro): complete this.
+    return tsResult;
   }
 }
 

yarn-project/simulator/src/public/public_tx_simulator/public_tx_simulator.ts

@@ -3,14 +3,16 @@ import { Fr } from '@aztec/foundation/fields';
 import { type Logger, createLogger } from '@aztec/foundation/log';
 import { ProtocolContractAddress, ProtocolContractsList } from '@aztec/protocol-contracts';
 import { computeFeePayerBalanceStorageSlot } from '@aztec/protocol-contracts/fee-juice';
-import { AvmCircuitPublicInputs, AvmExecutionHints, AvmTxHint, type RevertCode } from '@aztec/stdlib/avm';
+import { AvmCircuitPublicInputs, AvmExecutionHints, AvmTxHint, RevertCode } from '@aztec/stdlib/avm';
 import { SimulationError } from '@aztec/stdlib/errors';
 import type { Gas, GasUsed } from '@aztec/stdlib/gas';
-import type { DebugLog } from '@aztec/stdlib/logs';
+import { DebugLog } from '@aztec/stdlib/logs';
+import { schemas } from '@aztec/stdlib/schemas';
 import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
 import { type GlobalVariables, PublicCallRequestWithCalldata, Tx, TxExecutionPhase } from '@aztec/stdlib/tx';
 
 import { strict as assert } from 'assert';
+import { z } from 'zod';
 
 import type { AvmFinalizedCallResult } from '../avm/avm_contract_call_result.js';
 import { AvmSimulator } from '../avm/index.js';
@@ -27,17 +29,43 @@ import type { PublicPersistableStateManager } from '../state_manager/state_manag
 import { PublicTxContext } from './public_tx_context.js';
 import type { PublicTxSimulatorInterface } from './public_tx_simulator_interface.js';
 
-export type PublicTxResult = {
-  // Simulation result.
-  gasUsed: GasUsed; // Gas used during the execution of this tx
-  revertCode: RevertCode;
-  revertReason?: SimulationError; // Revert reason, if any
-  appLogicReturnValue?: Fr[]; // Return/revert value of the app logic phase
-  logs: DebugLog[];
-  // For the proving request.
-  hints?: AvmExecutionHints;
-  publicInputs: AvmCircuitPublicInputs;
-};
+export class PublicTxResult {
+  constructor(
+    // Simulation result.
+    public gasUsed: GasUsed,
+    public revertCode: RevertCode,
+    public revertReason: SimulationError | undefined, // Revert reason, if any
+    public appLogicReturnValue: Fr[] | undefined, // Return/revert value of the app logic phase
+    public logs: DebugLog[],
+    // For the proving request.
+    public hints: AvmExecutionHints | undefined,
+    public publicInputs: AvmCircuitPublicInputs,
+  ) {}
+
+  static get schema() {
+    return z
+      .object({
+        gasUsed: schemas.GasUsed,
+        revertCode: RevertCode.schema,
+        revertReason: SimulationError.schema.optional(),
+        appLogicReturnValue: z.array(schemas.Fr).optional(),
+        logs: z.array(DebugLog.schema),
+        hints: AvmExecutionHints.schema.optional(),
+        publicInputs: AvmCircuitPublicInputs.schema,
+      })
+      .transform(
+        ({ gasUsed, revertCode, revertReason, appLogicReturnValue, logs, hints, publicInputs }) =>
+          new PublicTxResult(gasUsed, revertCode, revertReason, appLogicReturnValue, logs, hints, publicInputs),
+      );
+  }
+
+  // TODO(fcarreiro): complete this.
+  static get partialSchema() {
+    return z.object({
+      revertCode: RevertCode.schema,
+    });
+  }
+}
 
 export type PublicTxSimulatorConfig = {
   proverId: Fr;

yarn-project/stdlib/src/avm/message_pack.ts

@@ -18,7 +18,10 @@ export function serializeWithMessagePack(obj: any): Buffer {
   return encoder.encode(obj);
 }
 
-export function deserializeFromMessagePack<T>(buffer: Buffer): T {
+// This deserializes into a JSON-like object. If you want a specific
+// class, you need to use zod to parse it into the specific class.
+// You can use T.schema.parse() for that.
+export function deserializeFromMessagePack(buffer: Buffer): any {
   setUpMessagePackExtensions();
   const decoder = new Decoder({
     useRecords: false,

yarn-project/stdlib/src/schemas/schemas.ts

@@ -10,6 +10,7 @@ import { EventSelector } from '../abi/event_selector.js';
 import { FunctionSelector } from '../abi/function_selector.js';
 import { NoteSelector } from '../abi/note_selector.js';
 import { AztecAddress } from '../aztec-address/index.js';
+import { Gas } from '../gas/gas.js';
 
 /**
  * Validation schemas for common types. Every schema must match its toJSON.
@@ -63,6 +64,13 @@ export const schemas = {
 
   /** Accepts a hex string. */
   EventSelector: EventSelector.schema,
+
+  GasUsed: z.object({
+    totalGas: Gas.schema,
+    teardownGas: Gas.schema,
+    publicGas: Gas.schema,
+    billedGas: Gas.schema,
+  }),
 };
 
 export const AbiDecodedSchema: ZodFor<AbiDecoded> = z.union([