@aztec/simulator 0.0.1-commit.5476d83 → 0.0.1-commit.6230efd

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. package/dest/common/errors.d.ts +2 -2
  2. package/dest/common/errors.d.ts.map +1 -1
  3. package/dest/private/acvm/deserialize.d.ts +2 -2
  4. package/dest/private/acvm/deserialize.d.ts.map +1 -1
  5. package/dest/private/acvm/deserialize.js +1 -1
  6. package/dest/private/acvm/serialize.d.ts +2 -2
  7. package/dest/private/acvm/serialize.d.ts.map +1 -1
  8. package/dest/private/acvm/serialize.js +1 -1
  9. package/dest/private/circuit_recording/circuit_recorder.d.ts +1 -1
  10. package/dest/private/circuit_recording/circuit_recorder.d.ts.map +1 -1
  11. package/dest/private/circuit_recording/circuit_recorder.js +16 -15
  12. package/dest/public/avm/avm_context.d.ts +2 -2
  13. package/dest/public/avm/avm_context.d.ts.map +1 -1
  14. package/dest/public/avm/avm_contract_call_result.d.ts +2 -2
  15. package/dest/public/avm/avm_contract_call_result.d.ts.map +1 -1
  16. package/dest/public/avm/avm_execution_environment.d.ts +2 -2
  17. package/dest/public/avm/avm_execution_environment.d.ts.map +1 -1
  18. package/dest/public/avm/avm_execution_environment.js +1 -1
  19. package/dest/public/avm/avm_gas.d.ts +1 -1
  20. package/dest/public/avm/avm_gas.d.ts.map +1 -1
  21. package/dest/public/avm/avm_machine_state.d.ts +2 -2
  22. package/dest/public/avm/avm_machine_state.d.ts.map +1 -1
  23. package/dest/public/avm/avm_memory_types.d.ts +2 -2
  24. package/dest/public/avm/avm_memory_types.d.ts.map +1 -1
  25. package/dest/public/avm/avm_memory_types.js +1 -1
  26. package/dest/public/avm/avm_simulator.d.ts +2 -2
  27. package/dest/public/avm/avm_simulator.d.ts.map +1 -1
  28. package/dest/public/avm/avm_simulator.js +6 -5
  29. package/dest/public/avm/errors.d.ts +8 -2
  30. package/dest/public/avm/errors.d.ts.map +1 -1
  31. package/dest/public/avm/errors.js +14 -2
  32. package/dest/public/avm/fixtures/avm_simulation_tester.js +1 -1
  33. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts +2 -2
  34. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +1 -1
  35. package/dest/public/avm/fixtures/base_avm_simulation_tester.js +1 -1
  36. package/dest/public/avm/fixtures/initializers.d.ts +2 -2
  37. package/dest/public/avm/fixtures/initializers.d.ts.map +1 -1
  38. package/dest/public/avm/fixtures/initializers.js +3 -3
  39. package/dest/public/avm/fixtures/utils.d.ts +4 -3
  40. package/dest/public/avm/fixtures/utils.d.ts.map +1 -1
  41. package/dest/public/avm/fixtures/utils.js +3 -2
  42. package/dest/public/avm/opcodes/addressing_mode.js +2 -2
  43. package/dest/public/avm/opcodes/arithmetic.d.ts +3 -1
  44. package/dest/public/avm/opcodes/arithmetic.d.ts.map +1 -1
  45. package/dest/public/avm/opcodes/arithmetic.js +11 -1
  46. package/dest/public/avm/opcodes/ec_add.js +2 -2
  47. package/dest/public/avm/opcodes/hashing.d.ts +1 -1
  48. package/dest/public/avm/opcodes/hashing.d.ts.map +1 -1
  49. package/dest/public/avm/opcodes/hashing.js +9 -4
  50. package/dest/public/avm/opcodes/memory.js +1 -1
  51. package/dest/public/avm/opcodes/misc.js +2 -2
  52. package/dest/public/avm/revert_reason.d.ts +2 -2
  53. package/dest/public/avm/revert_reason.d.ts.map +1 -1
  54. package/dest/public/avm/revert_reason.js +3 -2
  55. package/dest/public/avm/serialization/bytecode_serialization.d.ts +1 -1
  56. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +1 -1
  57. package/dest/public/avm/serialization/bytecode_serialization.js +9 -6
  58. package/dest/public/avm/serialization/instruction_serialization.js +1 -1
  59. package/dest/public/avm/test_utils.d.ts +2 -2
  60. package/dest/public/avm/test_utils.d.ts.map +1 -1
  61. package/dest/public/avm/test_utils.js +1 -1
  62. package/dest/public/contracts_db_checkpoint.d.ts +2 -2
  63. package/dest/public/contracts_db_checkpoint.d.ts.map +1 -1
  64. package/dest/public/db_interfaces.d.ts +2 -2
  65. package/dest/public/db_interfaces.d.ts.map +1 -1
  66. package/dest/public/debug_fn_name.d.ts +15 -2
  67. package/dest/public/debug_fn_name.d.ts.map +1 -1
  68. package/dest/public/debug_fn_name.js +28 -2
  69. package/dest/public/fixtures/amm_test.js +2 -2
  70. package/dest/public/fixtures/bulk_test.js +4 -52
  71. package/dest/public/fixtures/custom_bytecode_tester.d.ts +28 -6
  72. package/dest/public/fixtures/custom_bytecode_tester.d.ts.map +1 -1
  73. package/dest/public/fixtures/custom_bytecode_tester.js +36 -12
  74. package/dest/public/fixtures/custom_bytecode_tests.d.ts +4 -1
  75. package/dest/public/fixtures/custom_bytecode_tests.d.ts.map +1 -1
  76. package/dest/public/fixtures/custom_bytecode_tests.js +74 -9
  77. package/dest/public/fixtures/index.d.ts +4 -2
  78. package/dest/public/fixtures/index.d.ts.map +1 -1
  79. package/dest/public/fixtures/index.js +3 -1
  80. package/dest/public/fixtures/minimal_public_tx.d.ts +2 -7
  81. package/dest/public/fixtures/minimal_public_tx.d.ts.map +1 -1
  82. package/dest/public/fixtures/minimal_public_tx.js +2 -12
  83. package/dest/public/fixtures/opcode_spammer.d.ts +123 -0
  84. package/dest/public/fixtures/opcode_spammer.d.ts.map +1 -0
  85. package/dest/public/fixtures/opcode_spammer.js +1681 -0
  86. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +22 -3
  87. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -1
  88. package/dest/public/fixtures/public_tx_simulation_tester.js +50 -13
  89. package/dest/public/fixtures/simple_contract_data_source.d.ts +5 -4
  90. package/dest/public/fixtures/simple_contract_data_source.d.ts.map +1 -1
  91. package/dest/public/fixtures/simple_contract_data_source.js +4 -4
  92. package/dest/public/fixtures/token_test.d.ts +6 -2
  93. package/dest/public/fixtures/token_test.d.ts.map +1 -1
  94. package/dest/public/fixtures/token_test.js +13 -11
  95. package/dest/public/fixtures/utils.d.ts +2 -2
  96. package/dest/public/fixtures/utils.d.ts.map +1 -1
  97. package/dest/public/fixtures/utils.js +4 -3
  98. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts +46 -0
  99. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts.map +1 -0
  100. package/dest/public/fuzzing/avm_fuzzer_simulator.js +139 -0
  101. package/dest/public/fuzzing/avm_simulator_bin.d.ts +2 -0
  102. package/dest/public/fuzzing/avm_simulator_bin.d.ts.map +1 -0
  103. package/dest/public/fuzzing/avm_simulator_bin.js +100 -0
  104. package/dest/public/hinting_db_sources.d.ts +5 -3
  105. package/dest/public/hinting_db_sources.d.ts.map +1 -1
  106. package/dest/public/hinting_db_sources.js +5 -2
  107. package/dest/public/index.d.ts +2 -2
  108. package/dest/public/index.d.ts.map +1 -1
  109. package/dest/public/index.js +1 -1
  110. package/dest/public/public_db_sources.d.ts +2 -2
  111. package/dest/public/public_db_sources.d.ts.map +1 -1
  112. package/dest/public/public_db_sources.js +1 -1
  113. package/dest/public/public_processor/guarded_merkle_tree.d.ts +4 -2
  114. package/dest/public/public_processor/guarded_merkle_tree.d.ts.map +1 -1
  115. package/dest/public/public_processor/guarded_merkle_tree.js +3 -0
  116. package/dest/public/public_processor/public_processor.d.ts +5 -5
  117. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  118. package/dest/public/public_processor/public_processor.js +35 -22
  119. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts +1 -13
  120. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts.map +1 -1
  121. package/dest/public/public_tx_simulator/contract_provider_for_cpp.js +18 -53
  122. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +21 -34
  123. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +1 -1
  124. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +60 -139
  125. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts +42 -0
  126. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts.map +1 -0
  127. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.js +86 -0
  128. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts +30 -0
  129. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts.map +1 -0
  130. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.js +171 -0
  131. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts +22 -0
  132. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts.map +1 -0
  133. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.js +52 -0
  134. package/dest/public/public_tx_simulator/factories.d.ts +13 -0
  135. package/dest/public/public_tx_simulator/factories.d.ts.map +1 -0
  136. package/dest/public/public_tx_simulator/factories.js +28 -0
  137. package/dest/public/public_tx_simulator/index.d.ts +4 -1
  138. package/dest/public/public_tx_simulator/index.d.ts.map +1 -1
  139. package/dest/public/public_tx_simulator/index.js +3 -0
  140. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts +2 -2
  141. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts.map +1 -1
  142. package/dest/public/public_tx_simulator/public_tx_context.d.ts +2 -2
  143. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +1 -1
  144. package/dest/public/public_tx_simulator/public_tx_context.js +1 -1
  145. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +3 -3
  146. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  147. package/dest/public/public_tx_simulator/public_tx_simulator.js +11 -5
  148. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts +24 -1
  149. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts.map +1 -1
  150. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts +2 -2
  151. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts.map +1 -1
  152. package/dest/public/side_effect_trace.d.ts +2 -2
  153. package/dest/public/side_effect_trace.d.ts.map +1 -1
  154. package/dest/public/side_effect_trace.js +1 -1
  155. package/dest/public/side_effect_trace_interface.d.ts +2 -2
  156. package/dest/public/side_effect_trace_interface.d.ts.map +1 -1
  157. package/dest/public/state_manager/nullifiers.d.ts +2 -2
  158. package/dest/public/state_manager/nullifiers.d.ts.map +1 -1
  159. package/dest/public/state_manager/public_storage.d.ts +2 -2
  160. package/dest/public/state_manager/public_storage.d.ts.map +1 -1
  161. package/dest/public/state_manager/public_storage.js +1 -1
  162. package/dest/public/state_manager/state_manager.d.ts +7 -2
  163. package/dest/public/state_manager/state_manager.d.ts.map +1 -1
  164. package/dest/public/state_manager/state_manager.js +5 -2
  165. package/package.json +19 -19
  166. package/src/common/errors.ts +1 -1
  167. package/src/private/acvm/deserialize.ts +1 -1
  168. package/src/private/acvm/serialize.ts +1 -1
  169. package/src/private/circuit_recording/circuit_recorder.ts +17 -16
  170. package/src/public/avm/avm_context.ts +1 -1
  171. package/src/public/avm/avm_contract_call_result.ts +1 -1
  172. package/src/public/avm/avm_execution_environment.ts +1 -1
  173. package/src/public/avm/avm_gas.ts +3 -3
  174. package/src/public/avm/avm_machine_state.ts +1 -1
  175. package/src/public/avm/avm_memory_types.ts +1 -1
  176. package/src/public/avm/avm_simulator.ts +8 -5
  177. package/src/public/avm/errors.ts +17 -3
  178. package/src/public/avm/fixtures/avm_simulation_tester.ts +1 -1
  179. package/src/public/avm/fixtures/base_avm_simulation_tester.ts +1 -1
  180. package/src/public/avm/fixtures/initializers.ts +3 -3
  181. package/src/public/avm/fixtures/utils.ts +3 -2
  182. package/src/public/avm/opcodes/addressing_mode.ts +2 -2
  183. package/src/public/avm/opcodes/arithmetic.ts +13 -1
  184. package/src/public/avm/opcodes/ec_add.ts +2 -2
  185. package/src/public/avm/opcodes/hashing.ts +10 -4
  186. package/src/public/avm/opcodes/memory.ts +1 -1
  187. package/src/public/avm/opcodes/misc.ts +2 -2
  188. package/src/public/avm/revert_reason.ts +6 -3
  189. package/src/public/avm/serialization/bytecode_serialization.ts +17 -6
  190. package/src/public/avm/serialization/instruction_serialization.ts +1 -1
  191. package/src/public/avm/test_utils.ts +1 -1
  192. package/src/public/contracts_db_checkpoint.ts +1 -1
  193. package/src/public/db_interfaces.ts +1 -1
  194. package/src/public/debug_fn_name.ts +35 -3
  195. package/src/public/fixtures/amm_test.ts +2 -2
  196. package/src/public/fixtures/bulk_test.ts +7 -7
  197. package/src/public/fixtures/custom_bytecode_tester.ts +53 -19
  198. package/src/public/fixtures/custom_bytecode_tests.ts +93 -9
  199. package/src/public/fixtures/index.ts +7 -1
  200. package/src/public/fixtures/minimal_public_tx.ts +4 -13
  201. package/src/public/fixtures/opcode_spammer.ts +1638 -0
  202. package/src/public/fixtures/public_tx_simulation_tester.ts +69 -13
  203. package/src/public/fixtures/simple_contract_data_source.ts +8 -9
  204. package/src/public/fixtures/token_test.ts +18 -9
  205. package/src/public/fixtures/utils.ts +2 -3
  206. package/src/public/fuzzing/avm_fuzzer_simulator.ts +240 -0
  207. package/src/public/fuzzing/avm_simulator_bin.ts +140 -0
  208. package/src/public/hinting_db_sources.ts +8 -3
  209. package/src/public/index.ts +7 -1
  210. package/src/public/public_db_sources.ts +1 -1
  211. package/src/public/public_processor/guarded_merkle_tree.ts +6 -1
  212. package/src/public/public_processor/public_processor.ts +43 -27
  213. package/src/public/public_tx_simulator/contract_provider_for_cpp.ts +19 -60
  214. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +68 -174
  215. package/src/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.ts +132 -0
  216. package/src/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.ts +237 -0
  217. package/src/public/public_tx_simulator/dumping_cpp_public_tx_simulator.ts +81 -0
  218. package/src/public/public_tx_simulator/factories.ts +41 -0
  219. package/src/public/public_tx_simulator/index.ts +3 -0
  220. package/src/public/public_tx_simulator/measured_public_tx_simulator.ts +1 -1
  221. package/src/public/public_tx_simulator/public_tx_context.ts +1 -1
  222. package/src/public/public_tx_simulator/public_tx_simulator.ts +24 -9
  223. package/src/public/public_tx_simulator/public_tx_simulator_interface.ts +23 -0
  224. package/src/public/public_tx_simulator/telemetry_public_tx_simulator.ts +1 -1
  225. package/src/public/side_effect_trace.ts +1 -1
  226. package/src/public/side_effect_trace_interface.ts +1 -1
  227. package/src/public/state_manager/nullifiers.ts +1 -1
  228. package/src/public/state_manager/public_storage.ts +1 -1
  229. package/src/public/state_manager/state_manager.ts +10 -3
@@ -0,0 +1,237 @@
1
+ import { type Logger, createLogger, logLevel } from '@aztec/foundation/log';
2
+ import { avmSimulate } from '@aztec/native';
3
+ import { ProtocolContractsList } from '@aztec/protocol-contracts';
4
+ import {
5
+ AvmFastSimulationInputs,
6
+ AvmTxHint,
7
+ type PublicSimulatorConfig,
8
+ PublicTxResult,
9
+ deserializeFromMessagePack,
10
+ } from '@aztec/stdlib/avm';
11
+ import { SimulationError } from '@aztec/stdlib/errors';
12
+ import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
13
+ import type { GlobalVariables, StateReference, Tx } from '@aztec/stdlib/tx';
14
+ import { WorldStateRevisionWithHandle } from '@aztec/stdlib/world-state';
15
+
16
+ import { strict as assert } from 'assert';
17
+
18
+ import type { ExecutorMetricsInterface } from '../executor_metrics_interface.js';
19
+ import type { PublicContractsDB } from '../public_db_sources.js';
20
+ import { ContractProviderForCpp } from './contract_provider_for_cpp.js';
21
+ import { PublicTxSimulator } from './public_tx_simulator.js';
22
+ import type {
23
+ MeasuredPublicTxSimulatorInterface,
24
+ PublicTxSimulatorInterface,
25
+ } from './public_tx_simulator_interface.js';
26
+
27
+ /**
28
+ * An implementation of PublicTxSimulator that first simulates in C++, then TS, an compares the results.
29
+ * The C++ simulator accesses the world state directly/natively within C++.
30
+ * For contract DB accesses, it makes callbacks through NAPI back to the TS PublicContractsDB cache.
31
+ */
32
+ export class CppVsTsPublicTxSimulator extends PublicTxSimulator implements PublicTxSimulatorInterface {
33
+ protected override log: Logger;
34
+
35
+ constructor(
36
+ merkleTree: MerkleTreeWriteOperations,
37
+ contractsDB: PublicContractsDB,
38
+ globalVariables: GlobalVariables,
39
+ config?: Partial<PublicSimulatorConfig>,
40
+ ) {
41
+ super(merkleTree, contractsDB, globalVariables, config);
42
+ this.log = createLogger(`simulator:cpp_vs_public_tx_simulator`);
43
+ }
44
+
45
+ /**
46
+ * Simulate a transaction's public portion using the C++ avvm simulator.
47
+ *
48
+ * @param tx - The transaction to simulate.
49
+ * @returns The result of the transaction's public execution.
50
+ */
51
+ public override async simulate(tx: Tx): Promise<PublicTxResult> {
52
+ const txHash = this.computeTxHash(tx);
53
+ this.log.debug(`C++ simulation of ${tx.publicFunctionCalldata.length} public calls for tx ${txHash}`, {
54
+ txHash,
55
+ });
56
+
57
+ // Run TS simulation to generate hints and public inputs
58
+ this.log.debug(`Running TS simulation for tx ${txHash}`);
59
+
60
+ // create checkpoint for ws
61
+ let tsResult: PublicTxResult | undefined;
62
+ let tsStateRef: StateReference | undefined;
63
+ await this.merkleTree.createCheckpoint();
64
+ this.contractsDB.createCheckpoint();
65
+ try {
66
+ // Run the full TypeScript simulation using the parent class
67
+ // This will modify the merkle tree with the transaction's state changes
68
+ tsResult = await super.simulate(tx);
69
+ this.log.debug(`TS simulation completed for tx ${txHash}`);
70
+
71
+ tsStateRef = await this.merkleTree.getStateReference(); // capture tree roots for later comparsion
72
+ } catch (error: any) {
73
+ this.log.warn(`TS simulation failed, but still continuing with C++ simulation: ${error.message} ${error.stack}`);
74
+ } finally {
75
+ // revert checkpoint for ws and clear contract db changes
76
+ // (cpp should reapply exactly the same changes if there are no bugs)
77
+ await this.merkleTree.revertCheckpoint();
78
+ this.contractsDB.revertCheckpoint();
79
+ }
80
+
81
+ this.log.debug(`Running C++ simulation for tx ${txHash}`);
82
+
83
+ // Using the "as WorldStateRevisionWithHandle" is a bit of a "trust me bro", hence the assert.
84
+ let wsRevision = this.merkleTree.getRevision();
85
+ assert(
86
+ wsRevision instanceof WorldStateRevisionWithHandle,
87
+ 'CppPublicTxSimulator a real NativeWorldStateInstance with a handle to the C++ WorldState object',
88
+ );
89
+ const wsCppHandle = (wsRevision as WorldStateRevisionWithHandle).handle;
90
+ wsRevision = wsRevision.toWorldStateRevision(); // for msgpack serialization, we don't include the handle in the type
91
+
92
+ this.log.debug(`Running C++ simulation with world state revision ${JSON.stringify(wsRevision)}`);
93
+
94
+ // Create the fast simulation inputs
95
+ const txHint = AvmTxHint.fromTx(tx, this.globalVariables.gasFees);
96
+ const protocolContracts = ProtocolContractsList;
97
+ const fastSimInputs = new AvmFastSimulationInputs(
98
+ wsRevision,
99
+ this.config,
100
+ txHint,
101
+ this.globalVariables,
102
+ protocolContracts,
103
+ );
104
+
105
+ // Create contract provider for callbacks to TypeScript PublicContractsDB from C++
106
+ const contractProvider = new ContractProviderForCpp(this.contractsDB, this.globalVariables);
107
+
108
+ // Serialize to msgpack and call the C++ simulator
109
+ this.log.debug(`Serializing fast simulation inputs to msgpack...`);
110
+ const inputBuffer = fastSimInputs.serializeWithMessagePack();
111
+
112
+ let resultBuffer: Buffer;
113
+ try {
114
+ this.log.debug(`Calling C++ simulator for tx ${txHash}`);
115
+ resultBuffer = await avmSimulate(inputBuffer, contractProvider, wsCppHandle, logLevel);
116
+ } catch (error: any) {
117
+ throw new SimulationError(`C++ simulation failed: ${error.message}`, []);
118
+ }
119
+
120
+ // If we've reached this point, C++ succeeded during simulation,
121
+ // so we assert that TS also succeeded.
122
+ assert(tsResult !== undefined, 'TS simulation should have succeeded if C++ succeeded');
123
+ assert(tsStateRef !== undefined, 'TS state reference should have been captured if C++ succeeded');
124
+
125
+ // Deserialize the msgpack result
126
+ this.log.debug(`Deserializing C++ from buffer (size: ${resultBuffer.length})...`);
127
+ const cppResultJSON: object = deserializeFromMessagePack(resultBuffer);
128
+ this.log.debug(`Deserializing C++ result to PublicTxResult...`);
129
+ const cppResult = PublicTxResult.fromPlainObject(cppResultJSON);
130
+ this.log.debug(`Done.`);
131
+ assert(cppResult.revertCode.equals(tsResult.revertCode));
132
+ assert(cppResult.gasUsed.totalGas.equals(tsResult.gasUsed.totalGas));
133
+ assert(cppResult.gasUsed.publicGas.equals(tsResult.gasUsed.publicGas));
134
+ assert(cppResult.gasUsed.teardownGas.equals(tsResult.gasUsed.teardownGas));
135
+ assert(cppResult.gasUsed.billedGas.equals(tsResult.gasUsed.billedGas));
136
+ assert(cppResult.publicTxEffect.equals(tsResult.publicTxEffect));
137
+ if (cppResult.publicInputs !== undefined) {
138
+ assert(cppResult.publicInputs!.toBuffer().equals(tsResult.publicInputs!.toBuffer()));
139
+ }
140
+
141
+ // TODO(fcarreiro): complete this.
142
+ // Check that C++ hints are a strict subset of TS hints.
143
+ // Then enable for misc tests and validate hints.
144
+ //if (this.config?.collectHints) {
145
+ //}
146
+
147
+ if (this.config?.collectCallMetadata) {
148
+ assert(cppResult.getAppLogicReturnValues().length === tsResult.getAppLogicReturnValues().length);
149
+ for (let i = 0; i < cppResult.getAppLogicReturnValues().length; i++) {
150
+ assert(cppResult.getAppLogicReturnValues()[i].equals(tsResult.getAppLogicReturnValues()[i]));
151
+ }
152
+ }
153
+ // Messages are still not ok for exceptional halts (they are not plumbed in C++).
154
+ const cppRevertReason = cppResult.findRevertReason() || {};
155
+ const tsRevertReason = tsResult.findRevertReason() || {};
156
+ const cppRevertReasonAsObject = JSON.parse(JSON.stringify(cppRevertReason));
157
+ const tsRevertReasonAsObject = JSON.parse(JSON.stringify(tsRevertReason));
158
+ if (JSON.stringify(cppRevertReasonAsObject) !== JSON.stringify(tsRevertReasonAsObject)) {
159
+ this.log.debug('cppResult.findRevertReason()', cppRevertReasonAsObject);
160
+ this.log.debug('tsResult.findRevertReason()', tsRevertReasonAsObject);
161
+ }
162
+ // TODO: dont compare the strings since this is not deterministic.
163
+
164
+ // Sometimes error messages are different between C++ and TS, so we omit in the default comparison
165
+ const cppRevertReasonWithoutMessage = { ...cppRevertReasonAsObject, originalMessage: undefined };
166
+ const tsRevertReasonWithoutMessage = { ...tsRevertReasonAsObject, originalMessage: undefined };
167
+ assert(JSON.stringify(cppRevertReasonWithoutMessage) === JSON.stringify(tsRevertReasonWithoutMessage));
168
+
169
+ const cppHasRevertMessage =
170
+ cppRevertReasonAsObject.originalMessage && cppRevertReasonAsObject.originalMessage.length > 0;
171
+ const tsHasRevertMessage =
172
+ tsRevertReasonAsObject.originalMessage && tsRevertReasonAsObject.originalMessage.length > 0;
173
+ // assert that if one of the error messages is non-empty, the other is
174
+ assert(
175
+ cppHasRevertMessage === tsHasRevertMessage,
176
+ 'One of the AVM simulators (C++ or TS) produced a revert message, but the other did not',
177
+ );
178
+ // Ideally, we'd love to be able to compare full error messages, but without a lot of work
179
+ // the two simulators will always be able to produce some differing errors.
180
+ // Commenting out the code below will enforce that the error messages are at least
181
+ // similar (one contains the other). Even this is not something we can guarantee.
182
+ //if (cppHasRevertMessage) {
183
+ // const cppRevertMessageContainsTs = cppRevertReasonAsObject.originalMessage.includes(
184
+ // tsRevertReasonAsObject.originalMessage,
185
+ // );
186
+ // const tsRevertMessageContainsCpp = tsRevertReasonAsObject.originalMessage.includes(
187
+ // cppRevertReasonAsObject.originalMessage,
188
+ // );
189
+ // assert(
190
+ // cppRevertMessageContainsTs || tsRevertMessageContainsCpp,
191
+ // 'The AVM simulators (C++ and TS) produced different revert messages (neither was a substring of the other)',
192
+ // );
193
+ //}
194
+
195
+ // Confirm that tree roots match
196
+ const cppStateRef = await this.merkleTree.getStateReference();
197
+ assert(
198
+ cppStateRef.equals(tsStateRef),
199
+ `Tree roots mismatch between TS and C++ public simulations for tx ${txHash}`,
200
+ );
201
+
202
+ this.log.debug(`C++ simulation completed for tx ${txHash}`, {
203
+ txHash,
204
+ reverted: !cppResult.revertCode.isOK(),
205
+ cppGasUsed: cppResult.gasUsed.totalGas.l2Gas,
206
+ });
207
+
208
+ // Return cpp result as it has more detailed metadata / revert reasons
209
+ return cppResult;
210
+ }
211
+ }
212
+
213
+ export class MeasuredCppVsTsPublicTxSimulator
214
+ extends CppVsTsPublicTxSimulator
215
+ implements MeasuredPublicTxSimulatorInterface
216
+ {
217
+ constructor(
218
+ merkleTree: MerkleTreeWriteOperations,
219
+ contractsDB: PublicContractsDB,
220
+ globalVariables: GlobalVariables,
221
+ protected readonly metrics: ExecutorMetricsInterface,
222
+ config?: Partial<PublicSimulatorConfig>,
223
+ ) {
224
+ super(merkleTree, contractsDB, globalVariables, config);
225
+ }
226
+
227
+ public override async simulate(tx: Tx, txLabel: string = 'unlabeledTx'): Promise<PublicTxResult> {
228
+ this.metrics.startRecordingTxSimulation(txLabel);
229
+ let result: PublicTxResult | undefined;
230
+ try {
231
+ result = await super.simulate(tx);
232
+ } finally {
233
+ this.metrics.stopRecordingTxSimulation(txLabel, result?.gasUsed, result?.revertCode);
234
+ }
235
+ return result;
236
+ }
237
+ }
@@ -0,0 +1,81 @@
1
+ import {
2
+ AvmCircuitInputs,
3
+ AvmCircuitPublicInputs,
4
+ AvmExecutionHints,
5
+ type PublicSimulatorConfig,
6
+ PublicTxResult,
7
+ serializeWithMessagePack,
8
+ } from '@aztec/stdlib/avm';
9
+ import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
10
+ import type { GlobalVariables, Tx, TxHash } from '@aztec/stdlib/tx';
11
+
12
+ import { strict as assert } from 'assert';
13
+ import { mkdirSync, writeFileSync } from 'fs';
14
+ import { join } from 'path';
15
+
16
+ import type { PublicContractsDB } from '../public_db_sources.js';
17
+ import { CppPublicTxSimulator } from './cpp_public_tx_simulator.js';
18
+
19
+ /**
20
+ * A C++ public tx simulator that dumps AVM circuit inputs to disk after simulation.
21
+ * Used during nightly CI runs to collect circuit inputs for benchmarking.
22
+ */
23
+ export class DumpingCppPublicTxSimulator extends CppPublicTxSimulator {
24
+ private readonly outputDir: string;
25
+
26
+ constructor(
27
+ merkleTree: MerkleTreeWriteOperations,
28
+ contractsDB: PublicContractsDB,
29
+ globalVariables: GlobalVariables,
30
+ config: Partial<PublicSimulatorConfig>,
31
+ outputDir: string,
32
+ ) {
33
+ super(merkleTree, contractsDB, globalVariables, config);
34
+ assert(config.collectHints === true, 'collectHints must be enabled to dump AVM circuit inputs');
35
+ assert(config.collectPublicInputs === true, 'collectPublicInputs must be enabled to dump AVM circuit inputs');
36
+ this.outputDir = outputDir;
37
+ }
38
+
39
+ public override async simulate(tx: Tx): Promise<PublicTxResult> {
40
+ const result = await super.simulate(tx);
41
+
42
+ // Dump the circuit inputs after successful simulation
43
+ const txHash = this.computeTxHash(tx);
44
+ this.dumpAvmCircuitInputs(result, txHash);
45
+
46
+ return result;
47
+ }
48
+
49
+ /**
50
+ * Dumps AVM circuit inputs to disk.
51
+ *
52
+ * @param result - The simulation result containing hints and public inputs
53
+ * @param txHash - The transaction hash to use in the filename
54
+ */
55
+ private dumpAvmCircuitInputs(result: PublicTxResult, txHash: TxHash): void {
56
+ try {
57
+ // Ensure the output directory exists
58
+ mkdirSync(this.outputDir, { recursive: true });
59
+
60
+ // Generate filename using transaction hash
61
+ const filename = `avm-circuit-inputs-tx-${txHash.toString()}.bin`;
62
+ const filepath = join(this.outputDir, filename);
63
+
64
+ // Create circuit inputs from the result
65
+ const hints = result.hints ?? AvmExecutionHints.empty();
66
+ const publicInputs = result.publicInputs ?? AvmCircuitPublicInputs.empty();
67
+ const avmCircuitInputs = new AvmCircuitInputs(hints, publicInputs);
68
+
69
+ // Serialize the circuit inputs using MessagePack
70
+ const serialized = serializeWithMessagePack(avmCircuitInputs);
71
+
72
+ // Write to disk
73
+ writeFileSync(filepath, serialized);
74
+
75
+ this.log.debug(`Dumped AVM circuit inputs to ${filepath}`);
76
+ } catch (error) {
77
+ // Non-blocking error handling - log but don't interrupt processing
78
+ this.log.warn(`Failed to dump AVM circuit inputs for tx ${txHash.toString()}: ${error}`);
79
+ }
80
+ }
81
+ }
@@ -0,0 +1,41 @@
1
+ import { PublicSimulatorConfig } from '@aztec/stdlib/avm';
2
+ import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
3
+ import type { GlobalVariables } from '@aztec/stdlib/tx';
4
+ import type { TelemetryClient } from '@aztec/telemetry-client';
5
+
6
+ import type { PublicContractsDB } from '../public_db_sources.js';
7
+ import { TelemetryCppPublicTxSimulator } from './cpp_public_tx_simulator.js';
8
+ import { DumpingCppPublicTxSimulator } from './dumping_cpp_public_tx_simulator.js';
9
+
10
+ /**
11
+ * Creates a public tx simulator for block building.
12
+ * Uses DumpingCppPublicTxSimulator if DUMP_AVM_INPUTS_TO_DIR env var is set (for CI/testing avm circuit),
13
+ * otherwise uses TelemetryCppPublicTxSimulator (for production).
14
+ */
15
+ export function createPublicTxSimulatorForBlockBuilding(
16
+ merkleTree: MerkleTreeWriteOperations,
17
+ contractsDB: PublicContractsDB,
18
+ globalVariables: GlobalVariables,
19
+ telemetryClient: TelemetryClient,
20
+ ) {
21
+ const config = PublicSimulatorConfig.from({
22
+ skipFeeEnforcement: false,
23
+ collectDebugLogs: false,
24
+ collectHints: false,
25
+ collectPublicInputs: false,
26
+ collectStatistics: false,
27
+ collectCallMetadata: false,
28
+ });
29
+
30
+ const dumpDir = process.env.DUMP_AVM_INPUTS_TO_DIR;
31
+ if (dumpDir) {
32
+ // must collect hints and PIs for dumping
33
+ const dumpingConfig = {
34
+ ...config,
35
+ collectHints: true,
36
+ collectPublicInputs: true,
37
+ };
38
+ return new DumpingCppPublicTxSimulator(merkleTree, contractsDB, globalVariables, dumpingConfig, dumpDir);
39
+ }
40
+ return new TelemetryCppPublicTxSimulator(merkleTree, contractsDB, globalVariables, telemetryClient, config);
41
+ }
@@ -1,4 +1,7 @@
1
1
  export * from './public_tx_simulator.js';
2
+ export { CppPublicTxSimulator, TelemetryCppPublicTxSimulator } from './cpp_public_tx_simulator.js';
3
+ export { DumpingCppPublicTxSimulator } from './dumping_cpp_public_tx_simulator.js';
4
+ export { createPublicTxSimulatorForBlockBuilding } from './factories.js';
2
5
  export type { PublicTxSimulatorInterface } from './public_tx_simulator_interface.js';
3
6
  export { TelemetryPublicTxSimulator } from './telemetry_public_tx_simulator.js';
4
7
  export type { PublicTxResult, PublicSimulatorConfig as PublicTxSimulatorConfig } from '@aztec/stdlib/avm';
@@ -1,4 +1,4 @@
1
- import type { Fr } from '@aztec/foundation/fields';
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import { Timer } from '@aztec/foundation/timer';
3
3
  import type { PublicSimulatorConfig, PublicTxResult } from '@aztec/stdlib/avm';
4
4
  import type { Gas } from '@aztec/stdlib/gas';
@@ -6,7 +6,7 @@ import {
6
6
  MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
7
7
  } from '@aztec/constants';
8
8
  import { padArrayEnd } from '@aztec/foundation/collection';
9
- import { Fr } from '@aztec/foundation/fields';
9
+ import { Fr } from '@aztec/foundation/curves/bn254';
10
10
  import { type Logger, createLogger } from '@aztec/foundation/log';
11
11
  import {
12
12
  AvmAccumulatedData,
@@ -1,11 +1,11 @@
1
1
  import { AVM_MAX_PROCESSABLE_L2_GAS } from '@aztec/constants';
2
- import { Fr } from '@aztec/foundation/fields';
2
+ import { Fr } from '@aztec/foundation/curves/bn254';
3
3
  import { type Logger, createLogger } from '@aztec/foundation/log';
4
4
  import { ProtocolContractAddress, ProtocolContractsList } from '@aztec/protocol-contracts';
5
5
  import { computeFeePayerBalanceStorageSlot } from '@aztec/protocol-contracts/fee-juice';
6
- import { AvmExecutionHints, AvmTxHint, PublicSimulatorConfig, PublicTxResult } from '@aztec/stdlib/avm';
6
+ import { AvmExecutionHints, AvmTxHint, PublicSimulatorConfig, PublicTxEffect, PublicTxResult } from '@aztec/stdlib/avm';
7
7
  import { SimulationError } from '@aztec/stdlib/errors';
8
- import type { Gas } from '@aztec/stdlib/gas';
8
+ import { Gas } from '@aztec/stdlib/gas';
9
9
  import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
10
10
  import {
11
11
  type GlobalVariables,
@@ -129,7 +129,7 @@ export class PublicTxSimulator implements PublicTxSimulatorInterface {
129
129
  const setupResult = await this.simulatePhase(TxExecutionPhase.SETUP, context);
130
130
  if (setupResult.reverted) {
131
131
  throw new Error(
132
- `Setup phase reverted! The transaction will be thrown out. ${setupResult.revertReason?.message}`,
132
+ `[SETUP] UNRECOVERABLE ERROR! The transaction will be thrown out. ${setupResult.revertReason?.message}`,
133
133
  );
134
134
  }
135
135
  processedPhases.push(setupResult);
@@ -200,10 +200,25 @@ export class PublicTxSimulator implements PublicTxSimulatorInterface {
200
200
  const publicInputs = await context.generateAvmCircuitPublicInputs();
201
201
  const revertCode = context.getFinalRevertCode();
202
202
 
203
- // We only return the app logic phase information.
204
- const appLogicReturnValues =
203
+ // We only return the app logic phase information, and only 1 per phase.
204
+ const appLogicReturnValues: NestedProcessReturnValues[] =
205
205
  processedPhases.find(({ phase }) => phase === TxExecutionPhase.APP_LOGIC)?.returnValues ?? [];
206
206
 
207
+ // TODO(fcarreiro): This is a temporary backwards compatibility layer until we migrate to the C++ simulator.
208
+ if (context.revertReason !== undefined) {
209
+ (appLogicReturnValues as any).revertReason = context.revertReason;
210
+ }
211
+
212
+ // Create PublicTxEffect from PublicInputs.
213
+ const publicTxEffect = new PublicTxEffect(
214
+ publicInputs.transactionFee,
215
+ publicInputs.accumulatedData.noteHashes.filter(h => !h.isEmpty()),
216
+ publicInputs.accumulatedData.nullifiers.filter(n => !n.isEmpty()),
217
+ publicInputs.accumulatedData.l2ToL1Msgs.filter(m => !m.isEmpty()),
218
+ publicInputs.accumulatedData.publicLogs.toLogs(),
219
+ publicInputs.accumulatedData.publicDataWrites.filter(w => !w.isEmpty()),
220
+ );
221
+
207
222
  return new PublicTxResult(
208
223
  /*gasUsed=*/ {
209
224
  totalGas: context.getActualGasUsed(),
@@ -212,8 +227,8 @@ export class PublicTxSimulator implements PublicTxSimulatorInterface {
212
227
  billedGas: context.getTotalGasUsed(),
213
228
  },
214
229
  /*revertCode=*/ revertCode,
215
- /*revertReason=*/ context.revertReason,
216
- /*appLogicReturnValues=*/ appLogicReturnValues,
230
+ /*publicTxEffect=*/ publicTxEffect,
231
+ /*callStackMetadata=*/ appLogicReturnValues,
217
232
  /*logs=*/ context.state.getActiveStateManager().getLogs(),
218
233
  /*hints=*/ hints,
219
234
  /*publicInputs=*/ publicInputs,
@@ -299,7 +314,7 @@ export class PublicTxSimulator implements PublicTxSimulatorInterface {
299
314
  );
300
315
 
301
316
  if (result.reverted) {
302
- const culprit = `${contractAddress}:${callRequest.functionSelector}`;
317
+ const culprit = `${contractAddress}:${fnName}`;
303
318
  context.revert(phase, result.revertReason, culprit);
304
319
  }
305
320
 
@@ -3,8 +3,31 @@ import type { Tx } from '@aztec/stdlib/tx';
3
3
 
4
4
  export interface PublicTxSimulatorInterface {
5
5
  simulate(tx: Tx): Promise<PublicTxResult>;
6
+ /**
7
+ * Cancel the current simulation if one is in progress.
8
+ * This signals the underlying simulator (e.g., C++) to stop at the next safe point.
9
+ * Safe to call even if no simulation is in progress.
10
+ * Optional - not all implementations support cancellation.
11
+ *
12
+ * @param waitTimeoutMs - If provided, wait up to this many ms for the simulation to actually stop.
13
+ * This is important because signaling cancellation doesn't immediately stop C++ -
14
+ * it only sets a flag that C++ checks at certain points. If C++ is in the middle
15
+ * of a slow operation (e.g., pad_trees), it won't stop until that completes.
16
+ * @returns Promise that resolves when cancellation is signaled (and optionally when simulation stops)
17
+ */
18
+ cancel?(waitTimeoutMs?: number): Promise<void>;
6
19
  }
7
20
 
8
21
  export interface MeasuredPublicTxSimulatorInterface {
9
22
  simulate(tx: Tx, txLabel: string): Promise<PublicTxResult>;
23
+ /**
24
+ * Cancel the current simulation if one is in progress.
25
+ * This signals the underlying simulator (e.g., C++) to stop at the next safe point.
26
+ * Safe to call even if no simulation is in progress.
27
+ * Optional - not all implementations support cancellation.
28
+ *
29
+ * @param waitTimeoutMs - If provided, wait up to this many ms for the simulation to actually stop.
30
+ * @returns Promise that resolves when cancellation is signaled (and optionally when simulation stops)
31
+ */
32
+ cancel?(waitTimeoutMs?: number): Promise<void>;
10
33
  }
@@ -1,4 +1,4 @@
1
- import type { Fr } from '@aztec/foundation/fields';
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import type { PublicSimulatorConfig } from '@aztec/stdlib/avm';
3
3
  import type { Gas } from '@aztec/stdlib/gas';
4
4
  import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
@@ -7,8 +7,8 @@ import {
7
7
  MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
8
8
  PROTOCOL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
9
9
  } from '@aztec/constants';
10
+ import { Fr } from '@aztec/foundation/curves/bn254';
10
11
  import { EthAddress } from '@aztec/foundation/eth-address';
11
- import { Fr } from '@aztec/foundation/fields';
12
12
  import { type LogLevel, createLogger } from '@aztec/foundation/log';
13
13
  import { PublicDataUpdateRequest } from '@aztec/stdlib/avm';
14
14
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
@@ -1,4 +1,4 @@
1
- import type { Fr } from '@aztec/foundation/fields';
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import type { LogLevel } from '@aztec/foundation/log';
3
3
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
4
  import type { DebugLog } from '@aztec/stdlib/logs';
@@ -1,4 +1,4 @@
1
- import type { Fr } from '@aztec/foundation/fields';
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
2
 
3
3
  import type { PublicTreesDB } from '../public_db_sources.js';
4
4
  import { NullifierCollisionError } from '../side_effect_errors.js';
@@ -1,4 +1,4 @@
1
- import { Fr } from '@aztec/foundation/fields';
1
+ import { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
3
 
4
4
  import type { PublicStateDBInterface } from '../db_interfaces.js';
@@ -6,11 +6,12 @@ import {
6
6
  MULTI_CALL_ENTRYPOINT_ADDRESS,
7
7
  ROUTER_ADDRESS,
8
8
  } from '@aztec/constants';
9
- import { poseidon2Hash } from '@aztec/foundation/crypto';
10
- import { Fr } from '@aztec/foundation/fields';
9
+ import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
10
+ import { Fr } from '@aztec/foundation/curves/bn254';
11
11
  import { jsonStringify } from '@aztec/foundation/json-rpc';
12
12
  import { type LogLevel, createLogger } from '@aztec/foundation/log';
13
13
  import { ProtocolContractAddress } from '@aztec/protocol-contracts';
14
+ import { FunctionSelector } from '@aztec/stdlib/abi';
14
15
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
15
16
  import type { ContractClassPublicWithCommitment, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
16
17
  import { SerializableContractInstance } from '@aztec/stdlib/contract';
@@ -26,7 +27,7 @@ import { strict as assert } from 'assert';
26
27
 
27
28
  import type { AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
28
29
  import type { PublicContractsDBInterface } from '../db_interfaces.js';
29
- import { getPublicFunctionDebugName } from '../debug_fn_name.js';
30
+ import { getPublicFunctionDebugName, getPublicFunctionSelectorAndName } from '../debug_fn_name.js';
30
31
  import type { PublicTreesDB } from '../public_db_sources.js';
31
32
  import {
32
33
  L1ToL2MessageIndexOutOfRangeError,
@@ -532,6 +533,12 @@ export class PublicPersistableStateManager {
532
533
  return await getPublicFunctionDebugName(this.contractsDB, avmEnvironment.address, avmEnvironment.calldata);
533
534
  }
534
535
 
536
+ public async getPublicFunctionSelectorAndName(
537
+ avmEnvironment: AvmExecutionEnvironment,
538
+ ): Promise<{ functionSelector?: FunctionSelector; functionName?: string }> {
539
+ return await getPublicFunctionSelectorAndName(this.contractsDB, avmEnvironment.address, avmEnvironment.calldata);
540
+ }
541
+
535
542
  public async padTree(treeId: MerkleTreeId, leavesToInsert: number): Promise<void> {
536
543
  await this.treesDB.padTree(treeId, leavesToInsert);
537
544
  }