@aztec/simulator 0.0.1-commit.b655e406 → 0.0.1-commit.b9865e97

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 (380) hide show
  1. package/README.md +6 -4
  2. package/dest/client.d.ts +1 -1
  3. package/dest/common/errors.d.ts +2 -2
  4. package/dest/common/errors.d.ts.map +1 -1
  5. package/dest/common/index.d.ts +1 -1
  6. package/dest/common/stats/index.d.ts +1 -1
  7. package/dest/common/stats/stats.d.ts +1 -1
  8. package/dest/private/acvm/acvm.d.ts +4 -2
  9. package/dest/private/acvm/acvm.d.ts.map +1 -1
  10. package/dest/private/acvm/acvm.js +4 -3
  11. package/dest/private/acvm/acvm_types.d.ts +1 -1
  12. package/dest/private/acvm/deserialize.d.ts +2 -2
  13. package/dest/private/acvm/deserialize.d.ts.map +1 -1
  14. package/dest/private/acvm/deserialize.js +1 -1
  15. package/dest/private/acvm/index.d.ts +1 -1
  16. package/dest/private/acvm/serialize.d.ts +2 -2
  17. package/dest/private/acvm/serialize.d.ts.map +1 -1
  18. package/dest/private/acvm/serialize.js +1 -1
  19. package/dest/private/acvm_native.d.ts +5 -3
  20. package/dest/private/acvm_native.d.ts.map +1 -1
  21. package/dest/private/acvm_native.js +8 -6
  22. package/dest/private/acvm_wasm.d.ts +4 -3
  23. package/dest/private/acvm_wasm.d.ts.map +1 -1
  24. package/dest/private/acvm_wasm.js +7 -5
  25. package/dest/private/acvm_wasm_with_blobs.d.ts +1 -1
  26. package/dest/private/acvm_wasm_with_blobs.d.ts.map +1 -1
  27. package/dest/private/circuit_recording/circuit_recorder.d.ts +4 -3
  28. package/dest/private/circuit_recording/circuit_recorder.d.ts.map +1 -1
  29. package/dest/private/circuit_recording/circuit_recorder.js +23 -20
  30. package/dest/private/circuit_recording/file_circuit_recorder.d.ts +3 -2
  31. package/dest/private/circuit_recording/file_circuit_recorder.d.ts.map +1 -1
  32. package/dest/private/circuit_recording/file_circuit_recorder.js +2 -2
  33. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts +7 -2
  34. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts.map +1 -1
  35. package/dest/private/circuit_recording/memory_circuit_recorder.js +4 -4
  36. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts +1 -1
  37. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts.map +1 -1
  38. package/dest/private/circuit_simulator.d.ts +1 -1
  39. package/dest/private/factory.d.ts +3 -3
  40. package/dest/private/factory.d.ts.map +1 -1
  41. package/dest/private/factory.js +7 -4
  42. package/dest/public/avm/testing/account_proof_fetcher.d.ts +2 -0
  43. package/dest/public/avm/testing/account_proof_fetcher.d.ts.map +1 -0
  44. package/dest/public/avm/testing/account_proof_fetcher.js +152 -0
  45. package/dest/public/avm/{fixtures → testing}/base_avm_simulation_tester.d.ts +3 -2
  46. package/dest/public/avm/testing/base_avm_simulation_tester.d.ts.map +1 -0
  47. package/dest/public/avm/{fixtures → testing}/base_avm_simulation_tester.js +18 -3
  48. package/dest/public/avm/{fixtures → testing}/utils.d.ts +4 -10
  49. package/dest/public/avm/testing/utils.d.ts.map +1 -0
  50. package/dest/public/avm/{fixtures → testing}/utils.js +6 -35
  51. package/dest/public/contracts_db_checkpoint.d.ts +16 -0
  52. package/dest/public/contracts_db_checkpoint.d.ts.map +1 -0
  53. package/dest/public/contracts_db_checkpoint.js +30 -0
  54. package/dest/public/db_interfaces.d.ts +14 -2
  55. package/dest/public/db_interfaces.d.ts.map +1 -1
  56. package/dest/public/executor_metrics.d.ts +3 -2
  57. package/dest/public/executor_metrics.d.ts.map +1 -1
  58. package/dest/public/executor_metrics.js +13 -34
  59. package/dest/public/executor_metrics_interface.d.ts +3 -2
  60. package/dest/public/executor_metrics_interface.d.ts.map +1 -1
  61. package/dest/public/fixtures/amm_test.d.ts +1 -1
  62. package/dest/public/fixtures/amm_test.js +4 -4
  63. package/dest/public/fixtures/bulk_test.d.ts +3 -3
  64. package/dest/public/fixtures/bulk_test.d.ts.map +1 -1
  65. package/dest/public/fixtures/bulk_test.js +36 -73
  66. package/dest/public/fixtures/custom_bytecode_tester.d.ts +29 -7
  67. package/dest/public/fixtures/custom_bytecode_tester.d.ts.map +1 -1
  68. package/dest/public/fixtures/custom_bytecode_tester.js +36 -12
  69. package/dest/public/fixtures/index.d.ts +2 -3
  70. package/dest/public/fixtures/index.d.ts.map +1 -1
  71. package/dest/public/fixtures/index.js +1 -2
  72. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +30 -11
  73. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -1
  74. package/dest/public/fixtures/public_tx_simulation_tester.js +98 -31
  75. package/dest/public/fixtures/simple_contract_data_source.d.ts +5 -4
  76. package/dest/public/fixtures/simple_contract_data_source.d.ts.map +1 -1
  77. package/dest/public/fixtures/simple_contract_data_source.js +5 -5
  78. package/dest/public/fixtures/token_test.d.ts +6 -2
  79. package/dest/public/fixtures/token_test.d.ts.map +1 -1
  80. package/dest/public/fixtures/token_test.js +13 -12
  81. package/dest/public/fixtures/utils.d.ts +3 -3
  82. package/dest/public/fixtures/utils.d.ts.map +1 -1
  83. package/dest/public/fixtures/utils.js +23 -23
  84. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts +62 -0
  85. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts.map +1 -0
  86. package/dest/public/fuzzing/avm_fuzzer_simulator.js +176 -0
  87. package/dest/public/fuzzing/avm_simulator_bin.d.ts +2 -0
  88. package/dest/public/fuzzing/avm_simulator_bin.d.ts.map +1 -0
  89. package/dest/public/fuzzing/avm_simulator_bin.js +118 -0
  90. package/dest/public/index.d.ts +3 -2
  91. package/dest/public/index.d.ts.map +1 -1
  92. package/dest/public/index.js +1 -1
  93. package/dest/public/public_db_sources.d.ts +29 -66
  94. package/dest/public/public_db_sources.d.ts.map +1 -1
  95. package/dest/public/public_db_sources.js +83 -134
  96. package/dest/public/public_errors.d.ts +1 -1
  97. package/dest/public/public_errors.d.ts.map +1 -1
  98. package/dest/public/public_processor/guarded_merkle_tree.d.ts +8 -5
  99. package/dest/public/public_processor/guarded_merkle_tree.d.ts.map +1 -1
  100. package/dest/public/public_processor/guarded_merkle_tree.js +12 -4
  101. package/dest/public/public_processor/public_processor.d.ts +19 -21
  102. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  103. package/dest/public/public_processor/public_processor.js +553 -123
  104. package/dest/public/public_processor/public_processor_metrics.d.ts +5 -2
  105. package/dest/public/public_processor/public_processor_metrics.d.ts.map +1 -1
  106. package/dest/public/public_processor/public_processor_metrics.js +36 -45
  107. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts +19 -0
  108. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts.map +1 -0
  109. package/dest/public/public_tx_simulator/contract_provider_for_cpp.js +99 -0
  110. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.d.ts +23 -0
  111. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.d.ts.map +1 -0
  112. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.js +52 -0
  113. package/dest/public/public_tx_simulator/factories.d.ts +14 -0
  114. package/dest/public/public_tx_simulator/factories.d.ts.map +1 -0
  115. package/dest/public/public_tx_simulator/factories.js +28 -0
  116. package/dest/public/public_tx_simulator/index.d.ts +5 -3
  117. package/dest/public/public_tx_simulator/index.d.ts.map +1 -1
  118. package/dest/public/public_tx_simulator/index.js +3 -2
  119. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +42 -89
  120. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  121. package/dest/public/public_tx_simulator/public_tx_simulator.js +101 -334
  122. package/dest/public/public_tx_simulator/public_tx_simulator_base.d.ts +22 -0
  123. package/dest/public/public_tx_simulator/public_tx_simulator_base.d.ts.map +1 -0
  124. package/dest/public/public_tx_simulator/public_tx_simulator_base.js +28 -0
  125. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts +25 -2
  126. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts.map +1 -1
  127. package/dest/public/side_effect_errors.d.ts +1 -1
  128. package/dest/public/side_effect_errors.d.ts.map +1 -1
  129. package/dest/public/test_executor_metrics.d.ts +11 -4
  130. package/dest/public/test_executor_metrics.d.ts.map +1 -1
  131. package/dest/public/test_executor_metrics.js +29 -6
  132. package/dest/public/unique_class_ids.d.ts +1 -1
  133. package/dest/public/unique_class_ids.d.ts.map +1 -1
  134. package/dest/public/utils.d.ts +1 -1
  135. package/dest/server.d.ts +1 -1
  136. package/dest/testing.d.ts +1 -1
  137. package/package.json +22 -22
  138. package/src/common/errors.ts +1 -1
  139. package/src/private/acvm/acvm.ts +4 -3
  140. package/src/private/acvm/deserialize.ts +1 -1
  141. package/src/private/acvm/serialize.ts +1 -1
  142. package/src/private/acvm_native.ts +11 -5
  143. package/src/private/acvm_wasm.ts +11 -4
  144. package/src/private/circuit_recording/circuit_recorder.ts +24 -21
  145. package/src/private/circuit_recording/file_circuit_recorder.ts +7 -2
  146. package/src/private/circuit_recording/memory_circuit_recorder.ts +6 -4
  147. package/src/private/factory.ts +7 -4
  148. package/src/public/avm/testing/account_proof.json +553 -0
  149. package/src/public/avm/testing/account_proof_fetcher.ts +166 -0
  150. package/src/public/avm/{fixtures → testing}/base_avm_simulation_tester.ts +23 -3
  151. package/src/public/avm/{fixtures → testing}/utils.ts +6 -41
  152. package/src/public/contracts_db_checkpoint.ts +41 -0
  153. package/src/public/db_interfaces.ts +16 -1
  154. package/src/public/executor_metrics.ts +11 -34
  155. package/src/public/executor_metrics_interface.ts +2 -1
  156. package/src/public/fixtures/amm_test.ts +4 -4
  157. package/src/public/fixtures/bulk_test.ts +38 -13
  158. package/src/public/fixtures/custom_bytecode_tester.ts +54 -20
  159. package/src/public/fixtures/index.ts +5 -2
  160. package/src/public/fixtures/public_tx_simulation_tester.ts +129 -27
  161. package/src/public/fixtures/simple_contract_data_source.ts +9 -10
  162. package/src/public/fixtures/token_test.ts +18 -10
  163. package/src/public/fixtures/utils.ts +28 -25
  164. package/src/public/fuzzing/avm_fuzzer_simulator.ts +285 -0
  165. package/src/public/fuzzing/avm_simulator_bin.ts +173 -0
  166. package/src/public/index.ts +4 -2
  167. package/src/public/public_db_sources.ts +112 -174
  168. package/src/public/public_processor/guarded_merkle_tree.ts +14 -6
  169. package/src/public/public_processor/public_processor.ts +225 -136
  170. package/src/public/public_processor/public_processor_metrics.ts +28 -44
  171. package/src/public/public_tx_simulator/contract_provider_for_cpp.ts +125 -0
  172. package/src/public/public_tx_simulator/dumping_public_tx_simulator.ts +83 -0
  173. package/src/public/public_tx_simulator/factories.ts +44 -0
  174. package/src/public/public_tx_simulator/index.ts +4 -2
  175. package/src/public/public_tx_simulator/public_tx_simulator.ts +153 -500
  176. package/src/public/public_tx_simulator/public_tx_simulator_base.ts +35 -0
  177. package/src/public/public_tx_simulator/public_tx_simulator_interface.ts +24 -2
  178. package/src/public/test_executor_metrics.ts +34 -8
  179. package/dest/public/avm/avm_context.d.ts +0 -41
  180. package/dest/public/avm/avm_context.d.ts.map +0 -1
  181. package/dest/public/avm/avm_context.js +0 -44
  182. package/dest/public/avm/avm_contract_call_result.d.ts +0 -32
  183. package/dest/public/avm/avm_contract_call_result.d.ts.map +0 -1
  184. package/dest/public/avm/avm_contract_call_result.js +0 -54
  185. package/dest/public/avm/avm_execution_environment.d.ts +0 -23
  186. package/dest/public/avm/avm_execution_environment.d.ts.map +0 -1
  187. package/dest/public/avm/avm_execution_environment.js +0 -36
  188. package/dest/public/avm/avm_gas.d.ts +0 -44
  189. package/dest/public/avm/avm_gas.d.ts.map +0 -1
  190. package/dest/public/avm/avm_gas.js +0 -195
  191. package/dest/public/avm/avm_machine_state.d.ts +0 -97
  192. package/dest/public/avm/avm_machine_state.d.ts.map +0 -1
  193. package/dest/public/avm/avm_machine_state.js +0 -109
  194. package/dest/public/avm/avm_memory_types.d.ts +0 -275
  195. package/dest/public/avm/avm_memory_types.d.ts.map +0 -1
  196. package/dest/public/avm/avm_memory_types.js +0 -351
  197. package/dest/public/avm/avm_simulator.d.ts +0 -39
  198. package/dest/public/avm/avm_simulator.d.ts.map +0 -1
  199. package/dest/public/avm/avm_simulator.js +0 -190
  200. package/dest/public/avm/avm_simulator_interface.d.ts +0 -9
  201. package/dest/public/avm/avm_simulator_interface.d.ts.map +0 -1
  202. package/dest/public/avm/avm_simulator_interface.js +0 -3
  203. package/dest/public/avm/errors.d.ts +0 -98
  204. package/dest/public/avm/errors.d.ts.map +0 -1
  205. package/dest/public/avm/errors.js +0 -129
  206. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +0 -22
  207. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +0 -1
  208. package/dest/public/avm/fixtures/avm_simulation_tester.js +0 -74
  209. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +0 -1
  210. package/dest/public/avm/fixtures/initializers.d.ts +0 -43
  211. package/dest/public/avm/fixtures/initializers.d.ts.map +0 -1
  212. package/dest/public/avm/fixtures/initializers.js +0 -42
  213. package/dest/public/avm/fixtures/utils.d.ts.map +0 -1
  214. package/dest/public/avm/index.d.ts +0 -2
  215. package/dest/public/avm/index.d.ts.map +0 -1
  216. package/dest/public/avm/index.js +0 -1
  217. package/dest/public/avm/opcodes/accrued_substate.d.ts +0 -75
  218. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +0 -1
  219. package/dest/public/avm/opcodes/accrued_substate.js +0 -255
  220. package/dest/public/avm/opcodes/addressing_mode.d.ts +0 -31
  221. package/dest/public/avm/opcodes/addressing_mode.d.ts.map +0 -1
  222. package/dest/public/avm/opcodes/addressing_mode.js +0 -94
  223. package/dest/public/avm/opcodes/arithmetic.d.ts +0 -47
  224. package/dest/public/avm/opcodes/arithmetic.d.ts.map +0 -1
  225. package/dest/public/avm/opcodes/arithmetic.js +0 -87
  226. package/dest/public/avm/opcodes/bitwise.d.ts +0 -42
  227. package/dest/public/avm/opcodes/bitwise.d.ts.map +0 -1
  228. package/dest/public/avm/opcodes/bitwise.js +0 -99
  229. package/dest/public/avm/opcodes/comparators.d.ts +0 -25
  230. package/dest/public/avm/opcodes/comparators.d.ts.map +0 -1
  231. package/dest/public/avm/opcodes/comparators.js +0 -43
  232. package/dest/public/avm/opcodes/contract.d.ts +0 -20
  233. package/dest/public/avm/opcodes/contract.d.ts.map +0 -1
  234. package/dest/public/avm/opcodes/contract.js +0 -65
  235. package/dest/public/avm/opcodes/control_flow.d.ts +0 -41
  236. package/dest/public/avm/opcodes/control_flow.d.ts.map +0 -1
  237. package/dest/public/avm/opcodes/control_flow.js +0 -107
  238. package/dest/public/avm/opcodes/conversion.d.ts +0 -18
  239. package/dest/public/avm/opcodes/conversion.d.ts.map +0 -1
  240. package/dest/public/avm/opcodes/conversion.js +0 -333
  241. package/dest/public/avm/opcodes/ec_add.d.ts +0 -19
  242. package/dest/public/avm/opcodes/ec_add.d.ts.map +0 -1
  243. package/dest/public/avm/opcodes/ec_add.js +0 -84
  244. package/dest/public/avm/opcodes/environment_getters.d.ts +0 -28
  245. package/dest/public/avm/opcodes/environment_getters.d.ts.map +0 -1
  246. package/dest/public/avm/opcodes/environment_getters.js +0 -77
  247. package/dest/public/avm/opcodes/external_calls.d.ts +0 -59
  248. package/dest/public/avm/opcodes/external_calls.d.ts.map +0 -1
  249. package/dest/public/avm/opcodes/external_calls.js +0 -209
  250. package/dest/public/avm/opcodes/hashing.d.ts +0 -36
  251. package/dest/public/avm/opcodes/hashing.d.ts.map +0 -1
  252. package/dest/public/avm/opcodes/hashing.js +0 -114
  253. package/dest/public/avm/opcodes/index.d.ts +0 -16
  254. package/dest/public/avm/opcodes/index.d.ts.map +0 -1
  255. package/dest/public/avm/opcodes/index.js +0 -15
  256. package/dest/public/avm/opcodes/instruction.d.ts +0 -74
  257. package/dest/public/avm/opcodes/instruction.d.ts.map +0 -1
  258. package/dest/public/avm/opcodes/instruction.js +0 -95
  259. package/dest/public/avm/opcodes/instruction_impl.d.ts +0 -19
  260. package/dest/public/avm/opcodes/instruction_impl.d.ts.map +0 -1
  261. package/dest/public/avm/opcodes/instruction_impl.js +0 -30
  262. package/dest/public/avm/opcodes/memory.d.ts +0 -74
  263. package/dest/public/avm/opcodes/memory.d.ts.map +0 -1
  264. package/dest/public/avm/opcodes/memory.js +0 -257
  265. package/dest/public/avm/opcodes/misc.d.ts +0 -18
  266. package/dest/public/avm/opcodes/misc.d.ts.map +0 -1
  267. package/dest/public/avm/opcodes/misc.js +0 -73
  268. package/dest/public/avm/opcodes/storage.d.ts +0 -24
  269. package/dest/public/avm/opcodes/storage.d.ts.map +0 -1
  270. package/dest/public/avm/opcodes/storage.js +0 -68
  271. package/dest/public/avm/revert_reason.d.ts +0 -18
  272. package/dest/public/avm/revert_reason.d.ts.map +0 -1
  273. package/dest/public/avm/revert_reason.js +0 -38
  274. package/dest/public/avm/serialization/buffer_cursor.d.ts +0 -26
  275. package/dest/public/avm/serialization/buffer_cursor.d.ts.map +0 -1
  276. package/dest/public/avm/serialization/buffer_cursor.js +0 -99
  277. package/dest/public/avm/serialization/bytecode_serialization.d.ts +0 -17
  278. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +0 -1
  279. package/dest/public/avm/serialization/bytecode_serialization.js +0 -333
  280. package/dest/public/avm/serialization/instruction_serialization.d.ts +0 -114
  281. package/dest/public/avm/serialization/instruction_serialization.d.ts.map +0 -1
  282. package/dest/public/avm/serialization/instruction_serialization.js +0 -261
  283. package/dest/public/avm/test_utils.d.ts +0 -15
  284. package/dest/public/avm/test_utils.d.ts.map +0 -1
  285. package/dest/public/avm/test_utils.js +0 -44
  286. package/dest/public/debug_fn_name.d.ts +0 -5
  287. package/dest/public/debug_fn_name.d.ts.map +0 -1
  288. package/dest/public/debug_fn_name.js +0 -9
  289. package/dest/public/fixtures/custom_bytecode_tests.d.ts +0 -9
  290. package/dest/public/fixtures/custom_bytecode_tests.d.ts.map +0 -1
  291. package/dest/public/fixtures/custom_bytecode_tests.js +0 -109
  292. package/dest/public/fixtures/minimal_public_tx.d.ts +0 -10
  293. package/dest/public/fixtures/minimal_public_tx.d.ts.map +0 -1
  294. package/dest/public/fixtures/minimal_public_tx.js +0 -29
  295. package/dest/public/hinting_db_sources.d.ts +0 -70
  296. package/dest/public/hinting_db_sources.d.ts.map +0 -1
  297. package/dest/public/hinting_db_sources.js +0 -297
  298. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +0 -41
  299. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +0 -1
  300. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +0 -89
  301. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts +0 -24
  302. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts.map +0 -1
  303. package/dest/public/public_tx_simulator/measured_public_tx_simulator.js +0 -51
  304. package/dest/public/public_tx_simulator/public_tx_context.d.ts +0 -127
  305. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +0 -1
  306. package/dest/public/public_tx_simulator/public_tx_context.js +0 -292
  307. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts +0 -21
  308. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts.map +0 -1
  309. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.js +0 -39
  310. package/dest/public/side_effect_trace.d.ts +0 -87
  311. package/dest/public/side_effect_trace.d.ts.map +0 -1
  312. package/dest/public/side_effect_trace.js +0 -199
  313. package/dest/public/side_effect_trace_interface.d.ts +0 -23
  314. package/dest/public/side_effect_trace_interface.d.ts.map +0 -1
  315. package/dest/public/side_effect_trace_interface.js +0 -1
  316. package/dest/public/state_manager/index.d.ts +0 -2
  317. package/dest/public/state_manager/index.d.ts.map +0 -1
  318. package/dest/public/state_manager/index.js +0 -1
  319. package/dest/public/state_manager/nullifiers.d.ts +0 -61
  320. package/dest/public/state_manager/nullifiers.d.ts.map +0 -1
  321. package/dest/public/state_manager/nullifiers.js +0 -92
  322. package/dest/public/state_manager/public_storage.d.ts +0 -66
  323. package/dest/public/state_manager/public_storage.d.ts.map +0 -1
  324. package/dest/public/state_manager/public_storage.js +0 -145
  325. package/dest/public/state_manager/state_manager.d.ts +0 -166
  326. package/dest/public/state_manager/state_manager.d.ts.map +0 -1
  327. package/dest/public/state_manager/state_manager.js +0 -391
  328. package/dest/public/tx_contract_cache.d.ts +0 -41
  329. package/dest/public/tx_contract_cache.d.ts.map +0 -1
  330. package/dest/public/tx_contract_cache.js +0 -49
  331. package/src/public/avm/avm_context.ts +0 -61
  332. package/src/public/avm/avm_contract_call_result.ts +0 -67
  333. package/src/public/avm/avm_execution_environment.ts +0 -48
  334. package/src/public/avm/avm_gas.ts +0 -183
  335. package/src/public/avm/avm_machine_state.ts +0 -169
  336. package/src/public/avm/avm_memory_types.ts +0 -436
  337. package/src/public/avm/avm_simulator.ts +0 -274
  338. package/src/public/avm/avm_simulator_interface.ts +0 -8
  339. package/src/public/avm/errors.ts +0 -163
  340. package/src/public/avm/fixtures/avm_simulation_tester.ts +0 -108
  341. package/src/public/avm/fixtures/initializers.ts +0 -104
  342. package/src/public/avm/index.ts +0 -1
  343. package/src/public/avm/opcodes/accrued_substate.ts +0 -288
  344. package/src/public/avm/opcodes/addressing_mode.ts +0 -111
  345. package/src/public/avm/opcodes/arithmetic.ts +0 -117
  346. package/src/public/avm/opcodes/bitwise.ts +0 -113
  347. package/src/public/avm/opcodes/comparators.ts +0 -55
  348. package/src/public/avm/opcodes/contract.ts +0 -75
  349. package/src/public/avm/opcodes/control_flow.ts +0 -123
  350. package/src/public/avm/opcodes/conversion.ts +0 -104
  351. package/src/public/avm/opcodes/ec_add.ts +0 -96
  352. package/src/public/avm/opcodes/environment_getters.ts +0 -87
  353. package/src/public/avm/opcodes/external_calls.ts +0 -260
  354. package/src/public/avm/opcodes/hashing.ts +0 -145
  355. package/src/public/avm/opcodes/index.ts +0 -15
  356. package/src/public/avm/opcodes/instruction.ts +0 -136
  357. package/src/public/avm/opcodes/instruction_impl.ts +0 -36
  358. package/src/public/avm/opcodes/memory.ts +0 -293
  359. package/src/public/avm/opcodes/misc.ts +0 -102
  360. package/src/public/avm/opcodes/storage.ts +0 -87
  361. package/src/public/avm/revert_reason.ts +0 -55
  362. package/src/public/avm/serialization/buffer_cursor.ts +0 -118
  363. package/src/public/avm/serialization/bytecode_serialization.ts +0 -204
  364. package/src/public/avm/serialization/instruction_serialization.ts +0 -249
  365. package/src/public/avm/test_utils.ts +0 -64
  366. package/src/public/debug_fn_name.ts +0 -18
  367. package/src/public/fixtures/custom_bytecode_tests.ts +0 -135
  368. package/src/public/fixtures/minimal_public_tx.ts +0 -36
  369. package/src/public/hinting_db_sources.ts +0 -505
  370. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +0 -128
  371. package/src/public/public_tx_simulator/measured_public_tx_simulator.ts +0 -109
  372. package/src/public/public_tx_simulator/public_tx_context.ts +0 -471
  373. package/src/public/public_tx_simulator/telemetry_public_tx_simulator.ts +0 -63
  374. package/src/public/side_effect_trace.ts +0 -290
  375. package/src/public/side_effect_trace_interface.ts +0 -28
  376. package/src/public/state_manager/index.ts +0 -1
  377. package/src/public/state_manager/nullifiers.ts +0 -103
  378. package/src/public/state_manager/public_storage.ts +0 -174
  379. package/src/public/state_manager/state_manager.ts +0 -560
  380. package/src/public/tx_contract_cache.ts +0 -69
@@ -1,548 +1,201 @@
1
- import { AVM_MAX_PROCESSABLE_L2_GAS, DEFAULT_MAX_DEBUG_LOG_MEMORY_READS } from '@aztec/constants';
2
- import { Fr } from '@aztec/foundation/fields';
3
- import { type Logger, createLogger } from '@aztec/foundation/log';
4
- import { ProtocolContractAddress, ProtocolContractsList } from '@aztec/protocol-contracts';
5
- import { computeFeePayerBalanceStorageSlot } from '@aztec/protocol-contracts/fee-juice';
1
+ import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
2
+ import { sleep } from '@aztec/foundation/sleep';
3
+ import { type CancellationToken, avmSimulate, cancelSimulation, createCancellationToken } from '@aztec/native';
4
+ import { ProtocolContractsList } from '@aztec/protocol-contracts';
6
5
  import {
7
- AvmCircuitInputs,
8
- AvmCircuitPublicInputs,
9
- AvmExecutionHints,
10
- type AvmProvingRequest,
6
+ AvmFastSimulationInputs,
11
7
  AvmTxHint,
12
- type RevertCode,
8
+ type PublicSimulatorConfig,
9
+ PublicTxResult,
10
+ deserializeFromMessagePack,
13
11
  } from '@aztec/stdlib/avm';
14
12
  import { SimulationError } from '@aztec/stdlib/errors';
15
- import type { Gas, GasUsed } from '@aztec/stdlib/gas';
16
- import type { DebugLog } from '@aztec/stdlib/logs';
17
- import { ProvingRequestType } from '@aztec/stdlib/proofs';
18
13
  import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
19
- import {
20
- type GlobalVariables,
21
- NestedProcessReturnValues,
22
- PublicCallRequestWithCalldata,
23
- Tx,
24
- TxExecutionPhase,
25
- } from '@aztec/stdlib/tx';
26
-
27
- import { strict as assert } from 'assert';
28
-
29
- import type { AvmFinalizedCallResult } from '../avm/avm_contract_call_result.js';
30
- import { AvmSimulator } from '../avm/index.js';
31
- import { getPublicFunctionDebugName } from '../debug_fn_name.js';
32
- import { HintingMerkleWriteOperations, HintingPublicContractsDB } from '../hinting_db_sources.js';
33
- import { type PublicContractsDB, PublicTreesDB } from '../public_db_sources.js';
34
- import {
35
- L2ToL1MessageLimitReachedError,
36
- NoteHashLimitReachedError,
37
- NullifierCollisionError,
38
- NullifierLimitReachedError,
39
- } from '../side_effect_errors.js';
40
- import type { PublicPersistableStateManager } from '../state_manager/state_manager.js';
41
- import { PublicTxContext } from './public_tx_context.js';
42
- import type { PublicTxSimulatorInterface } from './public_tx_simulator_interface.js';
43
-
44
- export type ProcessedPhase = {
45
- phase: TxExecutionPhase;
46
- durationMs?: number;
47
- returnValues: NestedProcessReturnValues[];
48
- reverted: boolean;
49
- revertReason?: SimulationError;
50
- };
51
-
52
- export type PublicTxResult = {
53
- avmProvingRequest: AvmProvingRequest;
54
- /** Gas used during the execution of this tx */
55
- gasUsed: GasUsed;
56
- revertCode: RevertCode;
57
- /** Revert reason, if any */
58
- revertReason?: SimulationError;
59
- processedPhases: ProcessedPhase[];
60
- logs: DebugLog[];
61
- };
62
-
63
- export type PublicTxSimulatorConfig = {
64
- proverId: Fr;
65
- doMerkleOperations: boolean;
66
- skipFeeEnforcement: boolean;
67
- clientInitiatedSimulation: boolean;
68
- maxDebugLogMemoryReads: number;
69
- };
70
-
71
- // The errors below are only thrown here in the public tx simulator,
72
- // and only during revertible phases (revertible insertions, app logic and teardown).
73
- // These are strictly "checked" errors (not exported and never propagated).
74
- // They are used internally for control flow to trigger rollbacks to the post-setup state.
75
-
76
- /**
77
- * Error thrown when public tx simulation reverts in a known/checked way during revertible insertions.
78
- */
79
- class TxSimRevertibleInsertionsRevert extends Error {
80
- constructor() {
81
- super('Public Tx Simulation reverted during Revertible Insertions');
82
- this.name = 'TxSimRevertibleInsertionsRevert';
83
- }
84
- }
85
-
86
- /**
87
- * Error thrown when public tx simulation reverts during app logic.
88
- */
89
- class TxSimAppLogicRevert extends Error {
90
- constructor() {
91
- super('Public Tx Simulation reverted during App Logic');
92
- this.name = 'TxSimAppLogicRevert';
93
- }
94
- }
14
+ import type { GlobalVariables, Tx } from '@aztec/stdlib/tx';
15
+ import { type TelemetryClient, type Tracer, getTelemetryClient } from '@aztec/telemetry-client';
16
+
17
+ import { ExecutorMetrics } from '../executor_metrics.js';
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 { PublicTxSimulatorBase } from './public_tx_simulator_base.js';
22
+ import type {
23
+ MeasuredPublicTxSimulatorInterface,
24
+ PublicTxSimulatorInterface,
25
+ } from './public_tx_simulator_interface.js';
95
26
 
96
27
  /**
97
- * Error thrown when public tx simulation reverts during teardown.
28
+ * Simulates a transaction's public portion using the C++ AVM simulator.
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.
98
31
  */
99
- class TxSimTeardownRevert extends Error {
100
- constructor() {
101
- super('Public Tx Simulation reverted during Teardown');
102
- this.name = 'TxSimTeardownRevert';
103
- }
104
- }
105
-
106
- export class PublicTxSimulator implements PublicTxSimulatorInterface {
107
- protected log: Logger;
108
- private config: PublicTxSimulatorConfig;
32
+ export class PublicTxSimulator extends PublicTxSimulatorBase implements PublicTxSimulatorInterface {
33
+ protected override log: Logger;
34
+ /** Current cancellation token for in-flight simulation. */
35
+ private cancellationToken?: CancellationToken;
36
+ /** Current simulation promise, used to wait for completion after cancellation. */
37
+ private simulationPromise?: Promise<Buffer>;
109
38
 
110
39
  constructor(
111
- protected merkleTree: MerkleTreeWriteOperations,
112
- protected contractsDB: PublicContractsDB,
113
- protected globalVariables: GlobalVariables,
114
- config?: Partial<PublicTxSimulatorConfig>,
40
+ merkleTree: MerkleTreeWriteOperations,
41
+ contractsDB: PublicContractsDB,
42
+ globalVariables: GlobalVariables,
43
+ config?: Partial<PublicSimulatorConfig>,
44
+ bindings?: LoggerBindings,
115
45
  ) {
116
- this.config = {
117
- proverId: config?.proverId ?? Fr.ZERO,
118
- doMerkleOperations: config?.doMerkleOperations ?? false,
119
- skipFeeEnforcement: config?.skipFeeEnforcement ?? false,
120
- clientInitiatedSimulation: config?.clientInitiatedSimulation ?? false,
121
- maxDebugLogMemoryReads: config?.maxDebugLogMemoryReads ?? DEFAULT_MAX_DEBUG_LOG_MEMORY_READS,
122
- };
123
- this.log = createLogger(`simulator:public_tx_simulator`);
46
+ super(merkleTree, contractsDB, globalVariables, config, undefined, bindings);
47
+ this.log = createLogger(`simulator:public_tx_simulator`, bindings);
124
48
  }
125
49
 
126
50
  /**
127
- * Simulate a transaction's public portion including all of its phases.
51
+ * Simulate a transaction's public portion using the C++ avvm simulator.
52
+ *
128
53
  * @param tx - The transaction to simulate.
129
54
  * @returns The result of the transaction's public execution.
130
55
  */
131
56
  public async simulate(tx: Tx): Promise<PublicTxResult> {
132
- try {
133
- const txHash = this.computeTxHash(tx);
134
- this.log.debug(`Simulating ${tx.publicFunctionCalldata.length} public calls for tx ${txHash}`, { txHash });
135
-
136
- // Create hinting DBs.
137
- const hints = new AvmExecutionHints(
138
- this.globalVariables,
139
- AvmTxHint.fromTx(tx, this.globalVariables.gasFees),
140
- ProtocolContractsList, // imported from file
141
- );
142
- const hintingMerkleTree = await HintingMerkleWriteOperations.create(this.merkleTree, hints);
143
- const hintingTreesDB = new PublicTreesDB(hintingMerkleTree);
144
- const hintingContractsDB = new HintingPublicContractsDB(this.contractsDB, hints);
145
-
146
- const context = await PublicTxContext.create(
147
- hintingTreesDB,
148
- hintingContractsDB,
149
- tx,
150
- this.globalVariables,
151
- ProtocolContractsList, // imported from file
152
- this.config.doMerkleOperations,
153
- this.config.proverId,
154
- );
57
+ const txHash = this.computeTxHash(tx);
58
+ this.log.debug(`C++ simulation of ${tx.publicFunctionCalldata.length} public calls for tx ${txHash}`, {
59
+ txHash,
60
+ });
155
61
 
156
- // This will throw if there is a nullifier collision.
157
- // In that case the transaction will be thrown out.
158
- await this.insertNonRevertiblesFromPrivate(context, tx);
62
+ const wsRevision = this.merkleTree.getRevision();
63
+ const wsdbIpcPath = this.merkleTree.getIpcPath();
159
64
 
160
- const processedPhases: ProcessedPhase[] = [];
161
- if (context.hasPhase(TxExecutionPhase.SETUP)) {
162
- // This will throw if the setup phase reverts.
163
- // In that case the transaction will be thrown out.
164
- const setupResult = await this.simulatePhase(TxExecutionPhase.SETUP, context);
165
- if (setupResult.reverted) {
166
- throw new Error(
167
- `Setup phase reverted! The transaction will be thrown out. ${setupResult.revertReason?.message}`,
168
- );
169
- }
170
- processedPhases.push(setupResult);
171
- }
65
+ this.log.trace(`Running C++ simulation with world state revision ${JSON.stringify(wsRevision)}`);
172
66
 
173
- // The checkpoint we should go back to if anything from now on reverts.
174
- await context.state.fork();
175
-
176
- try {
177
- // This will throw if there is a nullifier collision or other insertion error (limit reached).
178
- await this.insertRevertiblesFromPrivate(context, tx);
67
+ // Create the fast simulation inputs
68
+ const txHint = AvmTxHint.fromTx(tx, this.globalVariables.gasFees);
69
+ const protocolContracts = ProtocolContractsList;
70
+ const fastSimInputs = new AvmFastSimulationInputs(
71
+ wsRevision,
72
+ this.config,
73
+ txHint,
74
+ this.globalVariables,
75
+ protocolContracts,
76
+ );
179
77
 
180
- // Only proceed with app logic if there was no revert during revertible insertion.
181
- if (context.hasPhase(TxExecutionPhase.APP_LOGIC)) {
182
- const appLogicResult = await this.simulatePhase(TxExecutionPhase.APP_LOGIC, context);
183
- processedPhases.push(appLogicResult);
184
- if (appLogicResult.reverted) {
185
- throw new TxSimAppLogicRevert();
186
- }
187
- }
188
- } catch (e: any) {
189
- if (e instanceof TxSimRevertibleInsertionsRevert || e instanceof TxSimAppLogicRevert) {
190
- // We revert to the post-setup state.
191
- await context.state.discardForkedState();
192
- // But we also create a new fork so that the teardown phase can transparently
193
- // commit or rollback at the end of teardown.
194
- await context.state.fork();
195
- } else {
196
- // Unchecked/unknown error - re-throw as-is
197
- throw e;
198
- }
199
- }
78
+ // Create contract provider for callbacks to TypeScript PublicContractsDB from C++
79
+ const contractProvider = new ContractProviderForCpp(this.contractsDB, this.globalVariables, this.bindings);
80
+
81
+ // Serialize to msgpack and call the C++ simulator
82
+ this.log.trace(`Serializing fast simulation inputs to msgpack...`);
83
+ const inputBuffer = fastSimInputs.serializeWithMessagePack();
84
+
85
+ // Create cancellation token for this simulation
86
+ this.cancellationToken = createCancellationToken();
87
+
88
+ // Store the promise so cancel() can wait for it
89
+ this.log.debug(`Calling C++ simulator for tx ${txHash}`);
90
+ this.simulationPromise = avmSimulate(
91
+ inputBuffer,
92
+ contractProvider,
93
+ wsdbIpcPath,
94
+ this.log.level,
95
+ undefined,
96
+ this.cancellationToken,
97
+ );
200
98
 
201
- try {
202
- if (context.hasPhase(TxExecutionPhase.TEARDOWN)) {
203
- const teardownResult = await this.simulatePhase(TxExecutionPhase.TEARDOWN, context);
204
- processedPhases.push(teardownResult);
205
- if (teardownResult.reverted) {
206
- throw new TxSimTeardownRevert();
207
- }
208
- }
209
- // We commit the forked state and we are done.
210
- await context.state.mergeForkedState();
211
- } catch (e: any) {
212
- if (e instanceof TxSimTeardownRevert) {
213
- // We revert to the post-setup state and we are done.
214
- await context.state.discardForkedState();
215
- } else {
216
- // Unchecked/unknown error - re-throw as-is
217
- throw e;
218
- }
99
+ let resultBuffer: Buffer;
100
+ try {
101
+ resultBuffer = await this.simulationPromise;
102
+ } catch (error: any) {
103
+ // Check if this was a cancellation
104
+ if (error.message?.includes('Simulation cancelled')) {
105
+ throw new SimulationError(`C++ simulation cancelled`, []);
219
106
  }
220
-
221
- context.halt();
222
-
223
- // Such transactions should be filtered by GasTxValidator.
224
- assert(
225
- context.getActualGasUsed().l2Gas <= AVM_MAX_PROCESSABLE_L2_GAS,
226
- `Transaction consumes ${context.getActualGasUsed().l2Gas} L2 gas, which exceeds the AVM maximum processable gas of ${AVM_MAX_PROCESSABLE_L2_GAS}`,
227
- );
228
- await this.payFee(context);
229
-
230
- const publicInputs = await context.generateAvmCircuitPublicInputs();
231
- const avmProvingRequest = PublicTxSimulator.generateProvingRequest(publicInputs, hints);
232
-
233
- const revertCode = context.getFinalRevertCode();
234
-
235
- // Commit contracts from this TX to the block-level cache and clear tx cache
236
- // If the tx reverted, only commit non-revertible contracts
237
- // NOTE: You can't create contracts in public, so this is only relevant for private-created contracts
238
- // FIXME(fcarreiro): this should conceptually use the hinted contracts db.
239
- // However things should work as they are now because the hinted db would still pick up the new contracts.
240
- this.contractsDB.commitContractsForTx(/*onlyNonRevertibles=*/ !revertCode.isOK());
241
-
242
- return {
243
- avmProvingRequest,
244
- gasUsed: {
245
- totalGas: context.getActualGasUsed(),
246
- teardownGas: context.teardownGasUsed,
247
- publicGas: context.getActualPublicGasUsed(),
248
- billedGas: context.getTotalGasUsed(),
249
- },
250
- revertCode,
251
- revertReason: context.revertReason,
252
- processedPhases: processedPhases,
253
- logs: context.state.getActiveStateManager().getLogs(),
254
- };
107
+ throw new SimulationError(`C++ simulation failed: ${error.message}`, []);
255
108
  } finally {
256
- // Make sure there are no new contracts in the tx-level cache.
257
- // They should either be committed to block-level cache or cleared.
258
- // FIXME(fcarreiro): this should conceptually use the hinted contracts db.
259
- // However things should work as they are now because the hinted db would still pick up the new contracts.
260
- this.contractsDB.clearContractsForTx();
109
+ this.cancellationToken = undefined;
110
+ this.simulationPromise = undefined;
261
111
  }
262
- }
263
112
 
264
- protected computeTxHash(tx: Tx) {
265
- return tx.getTxHash();
266
- }
113
+ // If we've reached this point, C++ succeeded during simulation,
267
114
 
268
- /**
269
- * Simulate the setup phase of a transaction's public execution.
270
- * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
271
- * @returns The phase result.
272
- */
273
- protected async simulatePhase(phase: TxExecutionPhase, context: PublicTxContext): Promise<ProcessedPhase> {
274
- const callRequests = context.getCallRequestsForPhase(phase);
115
+ // Deserialize the msgpack result
116
+ this.log.trace(`Deserializing C++ from buffer (size: ${resultBuffer.length})...`);
117
+ const cppResultJSON: object = deserializeFromMessagePack(resultBuffer);
118
+ this.log.trace(`Deserializing C++ result to PublicTxResult...`);
119
+ const cppResult = PublicTxResult.fromPlainObject(cppResultJSON);
275
120
 
276
- this.log.debug(`Processing phase ${TxExecutionPhase[phase]} for tx ${context.txHash}`, {
277
- txHash: context.txHash.toString(),
278
- phase: TxExecutionPhase[phase],
279
- callRequests: callRequests.length,
121
+ this.log.trace(`C++ simulation completed for tx ${txHash}`, {
122
+ txHash,
123
+ reverted: !cppResult.revertCode.isOK(),
124
+ cppGasUsed: cppResult.gasUsed.totalGas.l2Gas,
280
125
  });
281
126
 
282
- const returnValues: NestedProcessReturnValues[] = [];
283
- let reverted = false;
284
- let revertReason: SimulationError | undefined;
285
- for (let i = 0; i < callRequests.length; i++) {
286
- if (reverted) {
287
- break;
288
- }
289
-
290
- const callRequest = callRequests[i];
291
-
292
- const enqueuedCallResult = await this.simulateEnqueuedCall(phase, context, callRequest);
293
-
294
- returnValues.push(new NestedProcessReturnValues(enqueuedCallResult.output));
295
-
296
- if (enqueuedCallResult.reverted) {
297
- reverted = true;
298
- revertReason = enqueuedCallResult.revertReason;
299
- }
300
- }
301
-
302
- return {
303
- phase,
304
- returnValues,
305
- reverted,
306
- revertReason,
307
- };
127
+ return cppResult;
308
128
  }
309
129
 
310
130
  /**
311
- * Simulate an enqueued public call.
312
- * @param phase - The current phase of public execution
313
- * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
314
- * @param callRequest - The public function call request, including the calldata.
315
- * @returns The result of execution.
316
- */
317
- protected async simulateEnqueuedCall(
318
- phase: TxExecutionPhase,
319
- context: PublicTxContext,
320
- callRequest: PublicCallRequestWithCalldata,
321
- ): Promise<AvmFinalizedCallResult> {
322
- const stateManager = context.state.getActiveStateManager();
323
- const contractAddress = callRequest.request.contractAddress;
324
- const fnName = await getPublicFunctionDebugName(this.contractsDB, contractAddress, callRequest.calldata);
325
-
326
- const allocatedGas = context.getGasLeftAtPhase(phase);
327
-
328
- const result = await this.simulateEnqueuedCallInternal(
329
- stateManager,
330
- callRequest,
331
- allocatedGas,
332
- /*transactionFee=*/ context.getTransactionFee(phase),
333
- fnName,
334
- );
335
-
336
- const gasUsed = allocatedGas.sub(result.gasLeft); // by enqueued call
337
- context.consumeGas(phase, gasUsed);
338
- this.log.debug(
339
- `Simulated enqueued public call (${fnName}) consumed ${gasUsed.l2Gas} L2 gas ending with ${result.gasLeft.l2Gas} L2 gas left.`,
340
- );
341
-
342
- if (result.reverted) {
343
- const culprit = `${contractAddress}:${callRequest.functionSelector}`;
344
- context.revert(phase, result.revertReason, culprit);
345
- }
346
-
347
- return result;
348
- }
349
-
350
- /**
351
- * Simulate an enqueued public call, without modifying the context (PublicTxContext).
352
- * Resulting modifications to the context can be applied by the caller.
353
- *
354
- * This function can be mocked for testing to skip actual AVM simulation
355
- * while still simulating phases and generating a proving request.
131
+ * Cancel the current simulation if one is in progress.
132
+ * This signals the C++ simulator to stop at the next opcode or before the next WorldState write.
133
+ * Safe to call even if no simulation is in progress.
356
134
  *
357
- * @param stateManager - The state manager for AvmSimulation
358
- * @param callRequest - The public function call request, including the calldata.
359
- * @param allocatedGas - The gas allocated to the enqueued call
360
- * @param fnName - The name of the function
361
- * @returns The result of execution.
362
- */
363
- protected async simulateEnqueuedCallInternal(
364
- stateManager: PublicPersistableStateManager,
365
- { request, calldata }: PublicCallRequestWithCalldata,
366
- allocatedGas: Gas,
367
- transactionFee: Fr,
368
- fnName: string,
369
- ): Promise<AvmFinalizedCallResult> {
370
- const address = request.contractAddress;
371
- const sender = request.msgSender;
372
-
373
- this.log.debug(
374
- `Executing enqueued public call to external function ${fnName}@${address} with ${allocatedGas.l2Gas} allocated L2 gas.`,
375
- );
376
-
377
- const simulator = await AvmSimulator.create(
378
- stateManager,
379
- address,
380
- sender,
381
- transactionFee,
382
- this.globalVariables,
383
- request.isStaticCall,
384
- calldata,
385
- allocatedGas,
386
- this.config.clientInitiatedSimulation,
387
- this.config.maxDebugLogMemoryReads,
388
- );
389
- const avmCallResult = await simulator.execute();
390
- return avmCallResult.finalize();
391
- }
392
-
393
- /**
394
- * Insert the non-revertible accumulated data from private into the public state.
135
+ * @param waitTimeoutMs - If provided, wait up to this many ms for the simulation to actually stop.
136
+ * This is important because C++ might be in the middle of a slow operation
137
+ * (e.g., pad_trees) and won't check the cancellation flag until it completes.
138
+ * Default timeout of 100ms after cancellation.
395
139
  */
396
- protected async insertNonRevertiblesFromPrivate(context: PublicTxContext, tx: Tx) {
397
- const stateManager = context.state.getActiveStateManager();
398
-
399
- for (const siloedNullifier of context.nonRevertibleAccumulatedDataFromPrivate.nullifiers.filter(
400
- n => !n.isEmpty(),
401
- )) {
402
- await stateManager.writeSiloedNullifier(siloedNullifier);
403
- }
404
- for (const noteHash of context.nonRevertibleAccumulatedDataFromPrivate.noteHashes) {
405
- if (!noteHash.isEmpty()) {
406
- await stateManager.writeUniqueNoteHash(noteHash);
407
- }
140
+ public async cancel(waitTimeoutMs: number = 100): Promise<void> {
141
+ if (this.cancellationToken) {
142
+ this.log.debug('Cancelling C++ simulation');
143
+ cancelSimulation(this.cancellationToken);
408
144
  }
409
- for (const l2ToL1Message of context.nonRevertibleAccumulatedDataFromPrivate.l2ToL1Msgs) {
410
- if (!l2ToL1Message.isEmpty()) {
411
- stateManager.writeScopedL2ToL1Message(l2ToL1Message);
412
- }
413
- }
414
-
415
- // add new contracts to the contracts db so that their functions may be found and called
416
- // TODO(#6464): Should we allow emitting contracts in the private setup phase?
417
- // FIXME(fcarreiro): this should conceptually use the hinted contracts db.
418
- // However things should work as they are now because the hinted db would still pick up the new contracts.
419
- await this.contractsDB.addNewNonRevertibleContracts(tx);
420
- }
421
145
 
422
- /**
423
- * Insert the revertible accumulated data from private into the public state.
424
- * Throws TxSimRevertibleInsertionsRevert if there is some checked error during revertible insertions.
425
- * This function checks for the following errors:
426
- * - NullifierLimitReachedError
427
- * - NullifierCollisionError
428
- * - NoteHashLimitReachedError
429
- * - L2ToL1MessageLimitReachedError
430
- */
431
- protected async insertRevertiblesFromPrivate(context: PublicTxContext, tx: Tx) {
432
- const stateManager = context.state.getActiveStateManager();
433
-
434
- try {
435
- for (const siloedNullifier of context.revertibleAccumulatedDataFromPrivate.nullifiers.filter(n => !n.isEmpty())) {
436
- await stateManager.writeSiloedNullifier(siloedNullifier);
437
- }
438
- } catch (e: any) {
439
- if (e instanceof NullifierLimitReachedError || e instanceof NullifierCollisionError) {
440
- context.revert(
441
- TxExecutionPhase.APP_LOGIC,
442
- new SimulationError(
443
- `Error encountered when inserting revertible nullifiers from private.\nDetails: ${e.message}`,
444
- [],
445
- ),
446
- );
447
- throw new TxSimRevertibleInsertionsRevert();
448
- } else {
449
- // Unchecked/unknown error - re-throw as-is
450
- throw e;
451
- }
146
+ // Wait for the simulation to actually complete if not already done
147
+ if (this.simulationPromise) {
148
+ this.log.debug(`Waiting up to ${waitTimeoutMs}ms for C++ simulation to stop`);
149
+ await Promise.race([
150
+ this.simulationPromise.catch(() => {}), // Ignore rejection, just wait for completion
151
+ sleep(waitTimeoutMs),
152
+ ]);
153
+ this.log.debug('C++ simulation stopped or wait timed out');
452
154
  }
155
+ }
156
+ }
453
157
 
454
- try {
455
- for (const noteHash of context.revertibleAccumulatedDataFromPrivate.noteHashes) {
456
- if (!noteHash.isEmpty()) {
457
- // Revertible note hashes from private are not hashed with nonce, since private can't know their final position, only we can.
458
- await stateManager.writeSiloedNoteHash(noteHash);
459
- }
460
- }
461
- } catch (e: any) {
462
- if (e instanceof NoteHashLimitReachedError) {
463
- context.revert(
464
- TxExecutionPhase.APP_LOGIC,
465
- new SimulationError(
466
- `Error encountered when inserting revertible note hashes from private.\nDetails: ${e.message}`,
467
- [],
468
- ),
469
- );
470
- throw new TxSimRevertibleInsertionsRevert();
471
- } else {
472
- // Unchecked/unknown error - re-throw as-is
473
- throw e;
474
- }
475
- }
158
+ export class MeasuredPublicTxSimulator extends PublicTxSimulator implements MeasuredPublicTxSimulatorInterface {
159
+ constructor(
160
+ merkleTree: MerkleTreeWriteOperations,
161
+ contractsDB: PublicContractsDB,
162
+ globalVariables: GlobalVariables,
163
+ protected readonly metrics: ExecutorMetricsInterface,
164
+ config?: Partial<PublicSimulatorConfig>,
165
+ bindings?: LoggerBindings,
166
+ ) {
167
+ super(merkleTree, contractsDB, globalVariables, config, bindings);
168
+ }
476
169
 
170
+ public override async simulate(tx: Tx, txLabel: string = 'unlabeledTx'): Promise<PublicTxResult> {
171
+ this.metrics.startRecordingTxSimulation(txLabel);
172
+ let result: PublicTxResult | undefined;
477
173
  try {
478
- for (const l2ToL1Message of context.revertibleAccumulatedDataFromPrivate.l2ToL1Msgs) {
479
- if (!l2ToL1Message.isEmpty()) {
480
- stateManager.writeScopedL2ToL1Message(l2ToL1Message);
481
- }
482
- }
483
- } catch (e: any) {
484
- if (e instanceof L2ToL1MessageLimitReachedError) {
485
- context.revert(
486
- TxExecutionPhase.APP_LOGIC,
487
- new SimulationError(
488
- `Error encountered when inserting revertible L2-to-L1 messages from private.\nDetails: ${e.message}`,
489
- [],
490
- ),
491
- );
492
- throw new TxSimRevertibleInsertionsRevert();
493
- } else {
494
- // Unchecked/unknown error - re-throw as-is
495
- throw e;
496
- }
174
+ result = await super.simulate(tx);
175
+ } finally {
176
+ this.metrics.stopRecordingTxSimulation(txLabel, result?.gasUsed, result?.revertCode);
497
177
  }
498
-
499
- // add new contracts to the contracts db so that their functions may be found and called
500
- // FIXME(fcarreiro): this should conceptually use the hinted contracts db.
501
- // However things should work as they are now because the hinted db would still pick up the new contracts.
502
- await this.contractsDB.addNewRevertibleContracts(tx);
178
+ return result;
503
179
  }
180
+ }
504
181
 
505
- private async payFee(context: PublicTxContext) {
506
- const txFee = context.getTransactionFee(TxExecutionPhase.TEARDOWN);
507
-
508
- if (context.feePayer.isZero()) {
509
- this.log.debug(`No one is paying the fee of ${txFee.toBigInt()}`);
510
- return;
511
- }
512
-
513
- const feeJuiceAddress = ProtocolContractAddress.FeeJuice;
514
- const balanceSlot = await computeFeePayerBalanceStorageSlot(context.feePayer);
515
-
516
- this.log.debug(`Deducting ${txFee.toBigInt()} balance in Fee Juice for ${context.feePayer}`);
517
- const stateManager = context.state.getActiveStateManager();
518
-
519
- let currentBalance = await stateManager.readStorage(feeJuiceAddress, balanceSlot);
520
- // We allow to fake the balance of the fee payer to allow fee estimation
521
- // When mocking the balance of the fee payer, the circuit should not be able to prove the simulation
522
-
523
- if (currentBalance.lt(txFee)) {
524
- // Without "skipFeeEnforcement", such transactions should be filtered by GasTxValidator.
525
- assert(
526
- this.config.skipFeeEnforcement,
527
- `Not enough balance for fee payer to pay for transaction (got ${currentBalance.toBigInt()} needs ${txFee.toBigInt()})`,
528
- );
529
- currentBalance = txFee;
530
- }
531
-
532
- const updatedBalance = currentBalance.sub(txFee);
533
- await stateManager.writeStorage(feeJuiceAddress, balanceSlot, updatedBalance, true);
534
- }
182
+ /**
183
+ * A C++ public tx simulator that tracks runtime/production metrics with telemetry.
184
+ */
185
+ export class TelemetryPublicTxSimulator extends MeasuredPublicTxSimulator {
186
+ /* tracer needed by trackSpans */
187
+ public readonly tracer: Tracer;
535
188
 
536
- /**
537
- * Generate the proving request for the AVM circuit.
538
- */
539
- private static generateProvingRequest(
540
- publicInputs: AvmCircuitPublicInputs,
541
- hints: AvmExecutionHints,
542
- ): AvmProvingRequest {
543
- return {
544
- type: ProvingRequestType.PUBLIC_VM,
545
- inputs: new AvmCircuitInputs(hints, publicInputs),
546
- };
189
+ constructor(
190
+ merkleTree: MerkleTreeWriteOperations,
191
+ contractsDB: PublicContractsDB,
192
+ globalVariables: GlobalVariables,
193
+ telemetryClient: TelemetryClient = getTelemetryClient(),
194
+ config?: Partial<PublicSimulatorConfig>,
195
+ bindings?: LoggerBindings,
196
+ ) {
197
+ const metrics = new ExecutorMetrics(telemetryClient, 'PublicTxSimulator');
198
+ super(merkleTree, contractsDB, globalVariables, metrics, config, bindings);
199
+ this.tracer = metrics.tracer;
547
200
  }
548
201
  }