@aztec/simulator 0.0.1-commit.d431d1c → 0.0.1-commit.d58ff9d0

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