@aztec/simulator 0.0.0-test.1 → 0.0.1-commit.5daedc8

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 (492) hide show
  1. package/README.md +6 -0
  2. package/dest/client.d.ts +6 -4
  3. package/dest/client.d.ts.map +1 -1
  4. package/dest/client.js +4 -2
  5. package/dest/common/errors.d.ts +5 -14
  6. package/dest/common/errors.d.ts.map +1 -1
  7. package/dest/common/errors.js +51 -32
  8. package/dest/common/index.d.ts +1 -2
  9. package/dest/common/index.d.ts.map +1 -1
  10. package/dest/common/index.js +0 -1
  11. package/dest/common/stats/index.d.ts +1 -1
  12. package/dest/common/stats/stats.d.ts +1 -1
  13. package/dest/private/acvm/acvm.d.ts +12 -6
  14. package/dest/private/acvm/acvm.d.ts.map +1 -1
  15. package/dest/private/acvm/acvm.js +10 -16
  16. package/dest/private/acvm/acvm_types.d.ts +2 -2
  17. package/dest/private/acvm/acvm_types.d.ts.map +1 -1
  18. package/dest/private/acvm/deserialize.d.ts +18 -19
  19. package/dest/private/acvm/deserialize.d.ts.map +1 -1
  20. package/dest/private/acvm/deserialize.js +31 -23
  21. package/dest/private/acvm/index.d.ts +1 -2
  22. package/dest/private/acvm/index.d.ts.map +1 -1
  23. package/dest/private/acvm/index.js +0 -1
  24. package/dest/private/acvm/serialize.d.ts +20 -3
  25. package/dest/private/acvm/serialize.d.ts.map +1 -1
  26. package/dest/private/acvm/serialize.js +53 -0
  27. package/dest/private/acvm_native.d.ts +39 -0
  28. package/dest/private/acvm_native.d.ts.map +1 -0
  29. package/dest/private/{providers/acvm_native.js → acvm_native.js} +26 -20
  30. package/dest/private/acvm_wasm.d.ts +15 -0
  31. package/dest/private/acvm_wasm.d.ts.map +1 -0
  32. package/dest/private/{providers/acvm_wasm.js → acvm_wasm.js} +22 -19
  33. package/dest/private/acvm_wasm_with_blobs.d.ts +20 -0
  34. package/dest/private/acvm_wasm_with_blobs.d.ts.map +1 -0
  35. package/dest/private/acvm_wasm_with_blobs.js +35 -0
  36. package/dest/private/circuit_recording/circuit_recorder.d.ts +108 -0
  37. package/dest/private/circuit_recording/circuit_recorder.d.ts.map +1 -0
  38. package/dest/private/circuit_recording/circuit_recorder.js +209 -0
  39. package/dest/private/circuit_recording/file_circuit_recorder.d.ts +31 -0
  40. package/dest/private/circuit_recording/file_circuit_recorder.d.ts.map +1 -0
  41. package/dest/private/circuit_recording/file_circuit_recorder.js +135 -0
  42. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts +5 -0
  43. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts.map +1 -0
  44. package/dest/private/circuit_recording/memory_circuit_recorder.js +9 -0
  45. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts +21 -0
  46. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts.map +1 -0
  47. package/dest/private/circuit_recording/simulator_recorder_wrapper.js +44 -0
  48. package/dest/private/circuit_simulator.d.ts +35 -0
  49. package/dest/private/circuit_simulator.d.ts.map +1 -0
  50. package/dest/private/circuit_simulator.js +43 -0
  51. package/dest/private/factory.d.ts +12 -0
  52. package/dest/private/factory.d.ts.map +1 -0
  53. package/dest/private/{providers/factory.js → factory.js} +2 -2
  54. package/dest/public/avm/avm_context.d.ts +6 -6
  55. package/dest/public/avm/avm_context.d.ts.map +1 -1
  56. package/dest/public/avm/avm_contract_call_result.d.ts +5 -3
  57. package/dest/public/avm/avm_contract_call_result.d.ts.map +1 -1
  58. package/dest/public/avm/avm_contract_call_result.js +11 -7
  59. package/dest/public/avm/avm_execution_environment.d.ts +4 -2
  60. package/dest/public/avm/avm_execution_environment.d.ts.map +1 -1
  61. package/dest/public/avm/avm_execution_environment.js +4 -2
  62. package/dest/public/avm/avm_gas.d.ts +5 -21
  63. package/dest/public/avm/avm_gas.d.ts.map +1 -1
  64. package/dest/public/avm/avm_gas.js +27 -35
  65. package/dest/public/avm/avm_machine_state.d.ts +3 -1
  66. package/dest/public/avm/avm_machine_state.d.ts.map +1 -1
  67. package/dest/public/avm/avm_machine_state.js +2 -0
  68. package/dest/public/avm/avm_memory_types.d.ts +99 -88
  69. package/dest/public/avm/avm_memory_types.d.ts.map +1 -1
  70. package/dest/public/avm/avm_memory_types.js +17 -6
  71. package/dest/public/avm/avm_simulator.d.ts +6 -6
  72. package/dest/public/avm/avm_simulator.d.ts.map +1 -1
  73. package/dest/public/avm/avm_simulator.js +23 -35
  74. package/dest/public/avm/avm_simulator_interface.d.ts +9 -0
  75. package/dest/public/avm/avm_simulator_interface.d.ts.map +1 -0
  76. package/dest/public/avm/avm_simulator_interface.js +3 -0
  77. package/dest/public/avm/errors.d.ts +7 -31
  78. package/dest/public/avm/errors.d.ts.map +1 -1
  79. package/dest/public/avm/errors.js +7 -57
  80. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +6 -5
  81. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +1 -1
  82. package/dest/public/avm/fixtures/avm_simulation_tester.js +22 -15
  83. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts +7 -5
  84. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +1 -1
  85. package/dest/public/avm/fixtures/base_avm_simulation_tester.js +37 -14
  86. package/dest/public/avm/fixtures/initializers.d.ts +42 -0
  87. package/dest/public/avm/fixtures/initializers.d.ts.map +1 -0
  88. package/dest/public/avm/fixtures/initializers.js +44 -0
  89. package/dest/public/avm/fixtures/utils.d.ts +38 -0
  90. package/dest/public/avm/fixtures/utils.d.ts.map +1 -0
  91. package/dest/public/avm/fixtures/utils.js +95 -0
  92. package/dest/public/avm/index.d.ts +1 -3
  93. package/dest/public/avm/index.d.ts.map +1 -1
  94. package/dest/public/avm/index.js +0 -2
  95. package/dest/public/avm/opcodes/accrued_substate.d.ts +3 -3
  96. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +1 -1
  97. package/dest/public/avm/opcodes/accrued_substate.js +28 -25
  98. package/dest/public/avm/opcodes/addressing_mode.d.ts +12 -8
  99. package/dest/public/avm/opcodes/addressing_mode.d.ts.map +1 -1
  100. package/dest/public/avm/opcodes/addressing_mode.js +46 -26
  101. package/dest/public/avm/opcodes/arithmetic.d.ts +17 -7
  102. package/dest/public/avm/opcodes/arithmetic.d.ts.map +1 -1
  103. package/dest/public/avm/opcodes/arithmetic.js +16 -2
  104. package/dest/public/avm/opcodes/bitwise.d.ts +10 -18
  105. package/dest/public/avm/opcodes/bitwise.d.ts.map +1 -1
  106. package/dest/public/avm/opcodes/bitwise.js +19 -26
  107. package/dest/public/avm/opcodes/comparators.d.ts +4 -4
  108. package/dest/public/avm/opcodes/comparators.d.ts.map +1 -1
  109. package/dest/public/avm/opcodes/comparators.js +3 -3
  110. package/dest/public/avm/opcodes/contract.d.ts +2 -3
  111. package/dest/public/avm/opcodes/contract.d.ts.map +1 -1
  112. package/dest/public/avm/opcodes/contract.js +9 -10
  113. package/dest/public/avm/opcodes/control_flow.d.ts +1 -1
  114. package/dest/public/avm/opcodes/control_flow.d.ts.map +1 -1
  115. package/dest/public/avm/opcodes/control_flow.js +10 -8
  116. package/dest/public/avm/opcodes/conversion.d.ts +2 -1
  117. package/dest/public/avm/opcodes/conversion.d.ts.map +1 -1
  118. package/dest/public/avm/opcodes/conversion.js +267 -3
  119. package/dest/public/avm/opcodes/ec_add.d.ts +2 -2
  120. package/dest/public/avm/opcodes/ec_add.d.ts.map +1 -1
  121. package/dest/public/avm/opcodes/ec_add.js +6 -6
  122. package/dest/public/avm/opcodes/environment_getters.d.ts +3 -3
  123. package/dest/public/avm/opcodes/environment_getters.d.ts.map +1 -1
  124. package/dest/public/avm/opcodes/environment_getters.js +17 -19
  125. package/dest/public/avm/opcodes/external_calls.d.ts +9 -8
  126. package/dest/public/avm/opcodes/external_calls.d.ts.map +1 -1
  127. package/dest/public/avm/opcodes/external_calls.js +39 -34
  128. package/dest/public/avm/opcodes/hashing.d.ts +2 -2
  129. package/dest/public/avm/opcodes/hashing.d.ts.map +1 -1
  130. package/dest/public/avm/opcodes/hashing.js +6 -6
  131. package/dest/public/avm/opcodes/index.d.ts +1 -1
  132. package/dest/public/avm/opcodes/instruction.d.ts +15 -11
  133. package/dest/public/avm/opcodes/instruction.d.ts.map +1 -1
  134. package/dest/public/avm/opcodes/instruction.js +23 -19
  135. package/dest/public/avm/opcodes/instruction_impl.d.ts +1 -1
  136. package/dest/public/avm/opcodes/instruction_impl.d.ts.map +1 -1
  137. package/dest/public/avm/opcodes/memory.d.ts +6 -6
  138. package/dest/public/avm/opcodes/memory.d.ts.map +1 -1
  139. package/dest/public/avm/opcodes/memory.js +37 -33
  140. package/dest/public/avm/opcodes/misc.d.ts +3 -2
  141. package/dest/public/avm/opcodes/misc.d.ts.map +1 -1
  142. package/dest/public/avm/opcodes/misc.js +41 -16
  143. package/dest/public/avm/opcodes/storage.d.ts +3 -3
  144. package/dest/public/avm/opcodes/storage.d.ts.map +1 -1
  145. package/dest/public/avm/opcodes/storage.js +7 -5
  146. package/dest/public/avm/revert_reason.d.ts +18 -0
  147. package/dest/public/avm/revert_reason.d.ts.map +1 -0
  148. package/dest/public/avm/revert_reason.js +38 -0
  149. package/dest/public/avm/serialization/buffer_cursor.d.ts +1 -3
  150. package/dest/public/avm/serialization/buffer_cursor.d.ts.map +1 -1
  151. package/dest/public/avm/serialization/bytecode_serialization.d.ts +3 -7
  152. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +1 -1
  153. package/dest/public/avm/serialization/bytecode_serialization.js +70 -69
  154. package/dest/public/avm/serialization/instruction_serialization.d.ts +14 -5
  155. package/dest/public/avm/serialization/instruction_serialization.d.ts.map +1 -1
  156. package/dest/public/avm/serialization/instruction_serialization.js +70 -35
  157. package/dest/public/avm/test_utils.d.ts +11 -14
  158. package/dest/public/avm/test_utils.d.ts.map +1 -1
  159. package/dest/public/avm/test_utils.js +16 -24
  160. package/dest/public/contracts_db_checkpoint.d.ts +16 -0
  161. package/dest/public/contracts_db_checkpoint.d.ts.map +1 -0
  162. package/dest/public/contracts_db_checkpoint.js +30 -0
  163. package/dest/public/db_interfaces.d.ts +68 -0
  164. package/dest/public/db_interfaces.d.ts.map +1 -0
  165. package/dest/public/db_interfaces.js +3 -0
  166. package/dest/public/debug_fn_name.d.ts +5 -0
  167. package/dest/public/debug_fn_name.d.ts.map +1 -0
  168. package/dest/public/debug_fn_name.js +9 -0
  169. package/dest/public/executor_metrics.d.ts +12 -4
  170. package/dest/public/executor_metrics.d.ts.map +1 -1
  171. package/dest/public/executor_metrics.js +37 -6
  172. package/dest/public/executor_metrics_interface.d.ts +10 -0
  173. package/dest/public/executor_metrics_interface.d.ts.map +1 -0
  174. package/dest/public/executor_metrics_interface.js +1 -0
  175. package/dest/public/fixtures/amm_test.d.ts +10 -0
  176. package/dest/public/fixtures/amm_test.d.ts.map +1 -0
  177. package/dest/public/fixtures/amm_test.js +213 -0
  178. package/dest/public/fixtures/bulk_test.d.ts +6 -0
  179. package/dest/public/fixtures/bulk_test.d.ts.map +1 -0
  180. package/dest/public/fixtures/bulk_test.js +326 -0
  181. package/dest/public/fixtures/custom_bytecode_tester.d.ts +12 -0
  182. package/dest/public/fixtures/custom_bytecode_tester.d.ts.map +1 -0
  183. package/dest/public/fixtures/custom_bytecode_tester.js +29 -0
  184. package/dest/public/fixtures/custom_bytecode_tests.d.ts +9 -0
  185. package/dest/public/fixtures/custom_bytecode_tests.d.ts.map +1 -0
  186. package/dest/public/fixtures/custom_bytecode_tests.js +109 -0
  187. package/dest/public/fixtures/index.d.ts +8 -1
  188. package/dest/public/fixtures/index.d.ts.map +1 -1
  189. package/dest/public/fixtures/index.js +7 -0
  190. package/dest/public/fixtures/minimal_public_tx.d.ts +9 -0
  191. package/dest/public/fixtures/minimal_public_tx.d.ts.map +1 -0
  192. package/dest/public/fixtures/minimal_public_tx.js +29 -0
  193. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +35 -14
  194. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -1
  195. package/dest/public/fixtures/public_tx_simulation_tester.js +100 -71
  196. package/dest/public/fixtures/simple_contract_data_source.d.ts +35 -0
  197. package/dest/public/fixtures/simple_contract_data_source.d.ts.map +1 -0
  198. package/dest/public/{avm/fixtures → fixtures}/simple_contract_data_source.js +31 -10
  199. package/dest/public/fixtures/token_test.d.ts +8 -0
  200. package/dest/public/fixtures/token_test.d.ts.map +1 -0
  201. package/dest/public/fixtures/token_test.js +94 -0
  202. package/dest/public/fixtures/utils.d.ts +17 -4
  203. package/dest/public/fixtures/utils.d.ts.map +1 -1
  204. package/dest/public/fixtures/utils.js +100 -58
  205. package/dest/public/hinting_db_sources.d.ts +78 -0
  206. package/dest/public/hinting_db_sources.d.ts.map +1 -0
  207. package/dest/public/hinting_db_sources.js +350 -0
  208. package/dest/public/index.d.ts +6 -9
  209. package/dest/public/index.d.ts.map +1 -1
  210. package/dest/public/index.js +4 -7
  211. package/dest/public/public_db_sources.d.ts +51 -101
  212. package/dest/public/public_db_sources.d.ts.map +1 -1
  213. package/dest/public/public_db_sources.js +219 -192
  214. package/dest/public/public_errors.d.ts +12 -0
  215. package/dest/public/public_errors.d.ts.map +1 -0
  216. package/dest/public/public_errors.js +13 -0
  217. package/dest/public/public_processor/guarded_merkle_tree.d.ts +49 -0
  218. package/dest/public/public_processor/guarded_merkle_tree.d.ts.map +1 -0
  219. package/dest/public/public_processor/guarded_merkle_tree.js +108 -0
  220. package/dest/public/public_processor/public_processor.d.ts +25 -37
  221. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  222. package/dest/public/public_processor/public_processor.js +154 -111
  223. package/dest/public/public_processor/public_processor_metrics.d.ts +3 -3
  224. package/dest/public/public_processor/public_processor_metrics.d.ts.map +1 -1
  225. package/dest/public/public_processor/public_processor_metrics.js +1 -1
  226. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts +30 -0
  227. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts.map +1 -0
  228. package/dest/public/public_tx_simulator/contract_provider_for_cpp.js +133 -0
  229. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +66 -0
  230. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +1 -0
  231. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +210 -0
  232. package/dest/public/public_tx_simulator/index.d.ts +5 -0
  233. package/dest/public/public_tx_simulator/index.d.ts.map +1 -0
  234. package/dest/public/public_tx_simulator/index.js +2 -0
  235. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts +31 -0
  236. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts.map +1 -0
  237. package/dest/public/public_tx_simulator/measured_public_tx_simulator.js +51 -0
  238. package/dest/public/public_tx_simulator/public_tx_context.d.ts +23 -30
  239. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +1 -1
  240. package/dest/public/public_tx_simulator/public_tx_context.js +71 -91
  241. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +36 -58
  242. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  243. package/dest/public/public_tx_simulator/public_tx_simulator.js +208 -206
  244. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts +9 -0
  245. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts.map +1 -0
  246. package/dest/public/public_tx_simulator/public_tx_simulator_interface.js +1 -0
  247. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts +21 -0
  248. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts.map +1 -0
  249. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.js +39 -0
  250. package/dest/public/side_effect_errors.d.ts +42 -2
  251. package/dest/public/side_effect_errors.d.ts.map +1 -1
  252. package/dest/public/side_effect_errors.js +70 -1
  253. package/dest/public/side_effect_trace.d.ts +21 -67
  254. package/dest/public/side_effect_trace.d.ts.map +1 -1
  255. package/dest/public/side_effect_trace.js +71 -121
  256. package/dest/public/side_effect_trace_interface.d.ts +12 -24
  257. package/dest/public/side_effect_trace_interface.d.ts.map +1 -1
  258. package/dest/public/state_manager/index.d.ts +2 -0
  259. package/dest/public/state_manager/index.d.ts.map +1 -0
  260. package/dest/public/state_manager/index.js +1 -0
  261. package/dest/public/{avm/journal → state_manager}/nullifiers.d.ts +3 -6
  262. package/dest/public/state_manager/nullifiers.d.ts.map +1 -0
  263. package/dest/public/{avm/journal → state_manager}/nullifiers.js +3 -8
  264. package/dest/public/{avm/journal → state_manager}/public_storage.d.ts +3 -3
  265. package/dest/public/state_manager/public_storage.d.ts.map +1 -0
  266. package/dest/public/state_manager/state_manager.d.ts +159 -0
  267. package/dest/public/state_manager/state_manager.d.ts.map +1 -0
  268. package/dest/public/state_manager/state_manager.js +392 -0
  269. package/dest/public/test_executor_metrics.d.ts +55 -0
  270. package/dest/public/test_executor_metrics.d.ts.map +1 -0
  271. package/dest/public/test_executor_metrics.js +307 -0
  272. package/dest/public/unique_class_ids.d.ts +1 -1
  273. package/dest/public/unique_class_ids.d.ts.map +1 -1
  274. package/dest/public/utils.d.ts +3 -5
  275. package/dest/public/utils.d.ts.map +1 -1
  276. package/dest/public/utils.js +4 -21
  277. package/dest/server.d.ts +7 -4
  278. package/dest/server.d.ts.map +1 -1
  279. package/dest/server.js +5 -2
  280. package/dest/testing.d.ts +2 -0
  281. package/dest/testing.d.ts.map +1 -0
  282. package/dest/testing.js +1 -0
  283. package/package.json +39 -33
  284. package/src/client.ts +5 -3
  285. package/src/common/errors.ts +79 -44
  286. package/src/common/index.ts +0 -1
  287. package/src/private/acvm/acvm.ts +17 -32
  288. package/src/private/acvm/acvm_types.ts +1 -1
  289. package/src/private/acvm/deserialize.ts +35 -29
  290. package/src/private/acvm/index.ts +0 -1
  291. package/src/private/acvm/serialize.ts +63 -0
  292. package/src/private/{providers/acvm_native.ts → acvm_native.ts} +47 -24
  293. package/src/private/acvm_wasm.ts +72 -0
  294. package/src/private/acvm_wasm_with_blobs.ts +54 -0
  295. package/src/private/circuit_recording/circuit_recorder.ts +260 -0
  296. package/src/private/circuit_recording/file_circuit_recorder.ts +158 -0
  297. package/src/private/circuit_recording/memory_circuit_recorder.ts +11 -0
  298. package/src/private/circuit_recording/simulator_recorder_wrapper.ts +91 -0
  299. package/src/private/circuit_simulator.ts +90 -0
  300. package/src/private/{providers/factory.ts → factory.ts} +6 -6
  301. package/src/public/avm/avm_context.ts +4 -4
  302. package/src/public/avm/avm_contract_call_result.ts +17 -5
  303. package/src/public/avm/avm_execution_environment.ts +8 -1
  304. package/src/public/avm/avm_gas.ts +23 -35
  305. package/src/public/avm/avm_machine_state.ts +5 -0
  306. package/src/public/avm/avm_memory_types.ts +19 -6
  307. package/src/public/avm/avm_simulator.ts +43 -54
  308. package/src/public/avm/avm_simulator_interface.ts +8 -0
  309. package/src/public/avm/errors.ts +8 -77
  310. package/src/public/avm/fixtures/avm_simulation_tester.ts +32 -21
  311. package/src/public/avm/fixtures/base_avm_simulation_tester.ts +45 -12
  312. package/src/public/avm/fixtures/initializers.ts +102 -0
  313. package/src/public/avm/fixtures/utils.ts +150 -0
  314. package/src/public/avm/index.ts +0 -2
  315. package/src/public/avm/opcodes/accrued_substate.ts +64 -29
  316. package/src/public/avm/opcodes/addressing_mode.ts +56 -32
  317. package/src/public/avm/opcodes/arithmetic.ts +24 -2
  318. package/src/public/avm/opcodes/bitwise.ts +33 -29
  319. package/src/public/avm/opcodes/comparators.ts +6 -3
  320. package/src/public/avm/opcodes/contract.ts +10 -7
  321. package/src/public/avm/opcodes/control_flow.ts +19 -10
  322. package/src/public/avm/opcodes/conversion.ts +27 -3
  323. package/src/public/avm/opcodes/ec_add.ts +9 -6
  324. package/src/public/avm/opcodes/environment_getters.ts +27 -22
  325. package/src/public/avm/opcodes/external_calls.ts +61 -29
  326. package/src/public/avm/opcodes/hashing.ts +28 -8
  327. package/src/public/avm/opcodes/instruction.ts +31 -21
  328. package/src/public/avm/opcodes/memory.ts +71 -32
  329. package/src/public/avm/opcodes/misc.ts +60 -18
  330. package/src/public/avm/opcodes/storage.ts +22 -6
  331. package/src/public/avm/revert_reason.ts +55 -0
  332. package/src/public/avm/serialization/buffer_cursor.ts +4 -1
  333. package/src/public/avm/serialization/bytecode_serialization.ts +72 -74
  334. package/src/public/avm/serialization/instruction_serialization.ts +75 -34
  335. package/src/public/avm/test_utils.ts +24 -41
  336. package/src/public/contracts_db_checkpoint.ts +41 -0
  337. package/src/public/db_interfaces.ts +76 -0
  338. package/src/{common → public}/debug_fn_name.ts +7 -7
  339. package/src/public/executor_metrics.ts +56 -6
  340. package/src/public/executor_metrics_interface.ts +15 -0
  341. package/src/public/fixtures/amm_test.ts +331 -0
  342. package/src/public/fixtures/bulk_test.ts +169 -0
  343. package/src/public/fixtures/custom_bytecode_tester.ts +49 -0
  344. package/src/public/fixtures/custom_bytecode_tests.ts +135 -0
  345. package/src/public/fixtures/index.ts +7 -0
  346. package/src/public/fixtures/minimal_public_tx.ts +35 -0
  347. package/src/public/fixtures/public_tx_simulation_tester.ts +166 -113
  348. package/src/public/{avm/fixtures → fixtures}/simple_contract_data_source.ts +36 -18
  349. package/src/public/fixtures/token_test.ts +139 -0
  350. package/src/public/fixtures/utils.ts +141 -68
  351. package/src/public/hinting_db_sources.ts +602 -0
  352. package/src/public/index.ts +5 -8
  353. package/src/public/public_db_sources.ts +278 -258
  354. package/src/public/public_errors.ts +14 -0
  355. package/src/public/public_processor/guarded_merkle_tree.ts +153 -0
  356. package/src/public/public_processor/public_processor.ts +212 -164
  357. package/src/public/public_processor/public_processor_metrics.ts +2 -2
  358. package/src/public/public_tx_simulator/contract_provider_for_cpp.ts +162 -0
  359. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +306 -0
  360. package/src/public/public_tx_simulator/index.ts +4 -0
  361. package/src/public/public_tx_simulator/measured_public_tx_simulator.ts +105 -0
  362. package/src/public/public_tx_simulator/public_tx_context.ts +167 -194
  363. package/src/public/public_tx_simulator/public_tx_simulator.ts +292 -265
  364. package/src/public/public_tx_simulator/public_tx_simulator_interface.ts +10 -0
  365. package/src/public/public_tx_simulator/telemetry_public_tx_simulator.ts +63 -0
  366. package/src/public/side_effect_errors.ts +91 -1
  367. package/src/public/side_effect_trace.ts +94 -320
  368. package/src/public/side_effect_trace_interface.ts +10 -58
  369. package/src/public/state_manager/index.ts +1 -0
  370. package/src/public/{avm/journal → state_manager}/nullifiers.ts +5 -11
  371. package/src/public/{avm/journal → state_manager}/public_storage.ts +2 -2
  372. package/src/public/state_manager/state_manager.ts +553 -0
  373. package/src/public/test_executor_metrics.ts +397 -0
  374. package/src/public/utils.ts +5 -21
  375. package/src/server.ts +6 -3
  376. package/src/testing.ts +1 -0
  377. package/dest/common/db_interfaces.d.ts +0 -80
  378. package/dest/common/db_interfaces.d.ts.map +0 -1
  379. package/dest/common/db_interfaces.js +0 -1
  380. package/dest/common/debug_fn_name.d.ts +0 -5
  381. package/dest/common/debug_fn_name.d.ts.map +0 -1
  382. package/dest/common/debug_fn_name.js +0 -6
  383. package/dest/common/message_load_oracle_inputs.d.ts +0 -15
  384. package/dest/common/message_load_oracle_inputs.d.ts.map +0 -1
  385. package/dest/common/message_load_oracle_inputs.js +0 -15
  386. package/dest/private/acvm/oracle/index.d.ts +0 -14
  387. package/dest/private/acvm/oracle/index.d.ts.map +0 -1
  388. package/dest/private/acvm/oracle/index.js +0 -2
  389. package/dest/private/acvm/oracle/oracle.d.ts +0 -49
  390. package/dest/private/acvm/oracle/oracle.d.ts.map +0 -1
  391. package/dest/private/acvm/oracle/oracle.js +0 -263
  392. package/dest/private/acvm/oracle/typed_oracle.d.ts +0 -83
  393. package/dest/private/acvm/oracle/typed_oracle.d.ts.map +0 -1
  394. package/dest/private/acvm/oracle/typed_oracle.js +0 -132
  395. package/dest/private/execution_data_provider.d.ts +0 -261
  396. package/dest/private/execution_data_provider.d.ts.map +0 -1
  397. package/dest/private/execution_data_provider.js +0 -14
  398. package/dest/private/execution_note_cache.d.ts +0 -93
  399. package/dest/private/execution_note_cache.d.ts.map +0 -1
  400. package/dest/private/execution_note_cache.js +0 -180
  401. package/dest/private/hashed_values_cache.d.ts +0 -28
  402. package/dest/private/hashed_values_cache.d.ts.map +0 -1
  403. package/dest/private/hashed_values_cache.js +0 -46
  404. package/dest/private/index.d.ts +0 -13
  405. package/dest/private/index.d.ts.map +0 -1
  406. package/dest/private/index.js +0 -12
  407. package/dest/private/pick_notes.d.ts +0 -85
  408. package/dest/private/pick_notes.d.ts.map +0 -1
  409. package/dest/private/pick_notes.js +0 -51
  410. package/dest/private/private_execution.d.ts +0 -25
  411. package/dest/private/private_execution.d.ts.map +0 -1
  412. package/dest/private/private_execution.js +0 -92
  413. package/dest/private/private_execution_oracle.d.ts +0 -215
  414. package/dest/private/private_execution_oracle.d.ts.map +0 -1
  415. package/dest/private/private_execution_oracle.js +0 -382
  416. package/dest/private/providers/acvm_native.d.ts +0 -40
  417. package/dest/private/providers/acvm_native.d.ts.map +0 -1
  418. package/dest/private/providers/acvm_wasm.d.ts +0 -15
  419. package/dest/private/providers/acvm_wasm.d.ts.map +0 -1
  420. package/dest/private/providers/acvm_wasm_with_blobs.d.ts +0 -19
  421. package/dest/private/providers/acvm_wasm_with_blobs.d.ts.map +0 -1
  422. package/dest/private/providers/acvm_wasm_with_blobs.js +0 -32
  423. package/dest/private/providers/factory.d.ts +0 -12
  424. package/dest/private/providers/factory.d.ts.map +0 -1
  425. package/dest/private/providers/simulation_provider.d.ts +0 -19
  426. package/dest/private/providers/simulation_provider.d.ts.map +0 -1
  427. package/dest/private/providers/simulation_provider.js +0 -24
  428. package/dest/private/simulator.d.ts +0 -34
  429. package/dest/private/simulator.d.ts.map +0 -1
  430. package/dest/private/simulator.js +0 -76
  431. package/dest/private/unconstrained_execution.d.ts +0 -10
  432. package/dest/private/unconstrained_execution.d.ts.map +0 -1
  433. package/dest/private/unconstrained_execution.js +0 -27
  434. package/dest/private/unconstrained_execution_oracle.d.ts +0 -161
  435. package/dest/private/unconstrained_execution_oracle.d.ts.map +0 -1
  436. package/dest/private/unconstrained_execution_oracle.js +0 -258
  437. package/dest/public/avm/bytecode_utils.d.ts +0 -5
  438. package/dest/public/avm/bytecode_utils.d.ts.map +0 -1
  439. package/dest/public/avm/bytecode_utils.js +0 -17
  440. package/dest/public/avm/fixtures/index.d.ts +0 -84
  441. package/dest/public/avm/fixtures/index.d.ts.map +0 -1
  442. package/dest/public/avm/fixtures/index.js +0 -175
  443. package/dest/public/avm/fixtures/simple_contract_data_source.d.ts +0 -35
  444. package/dest/public/avm/fixtures/simple_contract_data_source.d.ts.map +0 -1
  445. package/dest/public/avm/journal/index.d.ts +0 -2
  446. package/dest/public/avm/journal/index.d.ts.map +0 -1
  447. package/dest/public/avm/journal/index.js +0 -1
  448. package/dest/public/avm/journal/journal.d.ts +0 -209
  449. package/dest/public/avm/journal/journal.d.ts.map +0 -1
  450. package/dest/public/avm/journal/journal.js +0 -486
  451. package/dest/public/avm/journal/nullifiers.d.ts.map +0 -1
  452. package/dest/public/avm/journal/public_storage.d.ts.map +0 -1
  453. package/dest/public/bytecode_errors.d.ts +0 -4
  454. package/dest/public/bytecode_errors.d.ts.map +0 -1
  455. package/dest/public/bytecode_errors.js +0 -6
  456. package/dest/public/execution.d.ts +0 -108
  457. package/dest/public/execution.d.ts.map +0 -1
  458. package/dest/public/execution.js +0 -9
  459. package/dest/public/tx_contract_cache.d.ts +0 -41
  460. package/dest/public/tx_contract_cache.d.ts.map +0 -1
  461. package/dest/public/tx_contract_cache.js +0 -49
  462. package/dest/test/utils.d.ts +0 -13
  463. package/dest/test/utils.d.ts.map +0 -1
  464. package/dest/test/utils.js +0 -22
  465. package/src/common/db_interfaces.ts +0 -94
  466. package/src/common/message_load_oracle_inputs.ts +0 -15
  467. package/src/private/acvm/oracle/index.ts +0 -16
  468. package/src/private/acvm/oracle/oracle.ts +0 -455
  469. package/src/private/acvm/oracle/typed_oracle.ts +0 -259
  470. package/src/private/execution_data_provider.ts +0 -323
  471. package/src/private/execution_note_cache.ts +0 -217
  472. package/src/private/hashed_values_cache.ts +0 -55
  473. package/src/private/index.ts +0 -16
  474. package/src/private/pick_notes.ts +0 -141
  475. package/src/private/private_execution.ts +0 -151
  476. package/src/private/private_execution_oracle.ts +0 -614
  477. package/src/private/providers/acvm_wasm.ts +0 -63
  478. package/src/private/providers/acvm_wasm_with_blobs.ts +0 -50
  479. package/src/private/providers/simulation_provider.ts +0 -45
  480. package/src/private/simulator.ts +0 -147
  481. package/src/private/unconstrained_execution.ts +0 -50
  482. package/src/private/unconstrained_execution_oracle.ts +0 -373
  483. package/src/public/avm/bytecode_utils.ts +0 -17
  484. package/src/public/avm/fixtures/index.ts +0 -296
  485. package/src/public/avm/journal/index.ts +0 -1
  486. package/src/public/avm/journal/journal.ts +0 -742
  487. package/src/public/avm/opcodes/.eslintrc.cjs +0 -8
  488. package/src/public/bytecode_errors.ts +0 -6
  489. package/src/public/execution.ts +0 -140
  490. package/src/public/tx_contract_cache.ts +0 -69
  491. package/src/test/utils.ts +0 -36
  492. /package/dest/public/{avm/journal → state_manager}/public_storage.js +0 -0
@@ -1,253 +1,254 @@
1
- import type { Fr } from '@aztec/foundation/fields';
1
+ import { AVM_MAX_PROCESSABLE_L2_GAS } from '@aztec/constants';
2
+ import { Fr } from '@aztec/foundation/fields';
2
3
  import { type Logger, createLogger } from '@aztec/foundation/log';
3
- import { Timer } from '@aztec/foundation/timer';
4
- import { ProtocolContractAddress } from '@aztec/protocol-contracts';
4
+ import { ProtocolContractAddress, ProtocolContractsList } from '@aztec/protocol-contracts';
5
5
  import { computeFeePayerBalanceStorageSlot } from '@aztec/protocol-contracts/fee-juice';
6
- import type { AvmProvingRequest, RevertCode } from '@aztec/stdlib/avm';
6
+ import { AvmExecutionHints, AvmTxHint, PublicSimulatorConfig, PublicTxResult } from '@aztec/stdlib/avm';
7
7
  import { SimulationError } from '@aztec/stdlib/errors';
8
- import type { Gas, GasUsed } from '@aztec/stdlib/gas';
9
- import type { MerkleTreeReadOperations } from '@aztec/stdlib/interfaces/server';
10
- import type { PublicCallRequest } from '@aztec/stdlib/kernel';
11
- import type { AvmSimulationStats } from '@aztec/stdlib/stats';
8
+ import type { Gas } from '@aztec/stdlib/gas';
9
+ import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
12
10
  import {
13
11
  type GlobalVariables,
14
12
  NestedProcessReturnValues,
15
- PublicExecutionRequest,
13
+ PublicCallRequestWithCalldata,
16
14
  Tx,
17
15
  TxExecutionPhase,
18
16
  } from '@aztec/stdlib/tx';
19
- import { Attributes, type TelemetryClient, type Tracer, getTelemetryClient, trackSpan } from '@aztec/telemetry-client';
20
17
 
21
18
  import { strict as assert } from 'assert';
22
19
 
23
- import { getPublicFunctionDebugName } from '../../common/debug_fn_name.js';
24
20
  import type { AvmFinalizedCallResult } from '../avm/avm_contract_call_result.js';
25
- import { type AvmPersistableStateManager, AvmSimulator } from '../avm/index.js';
26
- import { NullifierCollisionError } from '../avm/journal/nullifiers.js';
27
- import { ExecutorMetrics } from '../executor_metrics.js';
28
- import type { WorldStateDB } from '../public_db_sources.js';
21
+ import { AvmSimulator } from '../avm/index.js';
22
+ import { getPublicFunctionDebugName } from '../debug_fn_name.js';
23
+ import { HintingMerkleWriteOperations, HintingPublicContractsDB } from '../hinting_db_sources.js';
24
+ import { type PublicContractsDB, PublicTreesDB } from '../public_db_sources.js';
25
+ import {
26
+ L2ToL1MessageLimitReachedError,
27
+ NoteHashLimitReachedError,
28
+ NullifierCollisionError,
29
+ NullifierLimitReachedError,
30
+ } from '../side_effect_errors.js';
31
+ import type { PublicPersistableStateManager } from '../state_manager/state_manager.js';
29
32
  import { PublicTxContext } from './public_tx_context.js';
33
+ import type { PublicTxSimulatorInterface } from './public_tx_simulator_interface.js';
34
+
35
+ // The errors below are only thrown here in the public tx simulator,
36
+ // and only during revertible phases (revertible insertions, app logic and teardown).
37
+ // These are strictly "checked" errors (not exported and never propagated).
38
+ // They are used internally for control flow to trigger rollbacks to the post-setup state.
39
+
40
+ /**
41
+ * Error thrown when public tx simulation reverts in a known/checked way during revertible insertions.
42
+ */
43
+ class TxSimRevertibleInsertionsRevert extends Error {
44
+ constructor() {
45
+ super('Public Tx Simulation reverted during Revertible Insertions');
46
+ this.name = 'TxSimRevertibleInsertionsRevert';
47
+ }
48
+ }
49
+
50
+ /**
51
+ * Error thrown when public tx simulation reverts during app logic.
52
+ */
53
+ class TxSimAppLogicRevert extends Error {
54
+ constructor() {
55
+ super('Public Tx Simulation reverted during App Logic');
56
+ this.name = 'TxSimAppLogicRevert';
57
+ }
58
+ }
59
+
60
+ /**
61
+ * Error thrown when public tx simulation reverts during teardown.
62
+ */
63
+ class TxSimTeardownRevert extends Error {
64
+ constructor() {
65
+ super('Public Tx Simulation reverted during Teardown');
66
+ this.name = 'TxSimTeardownRevert';
67
+ }
68
+ }
30
69
 
31
- export type ProcessedPhase = {
70
+ /** Only used internally. */
71
+ type ProcessedPhase = {
32
72
  phase: TxExecutionPhase;
33
- durationMs: number;
73
+ durationMs?: number;
34
74
  returnValues: NestedProcessReturnValues[];
35
75
  reverted: boolean;
36
76
  revertReason?: SimulationError;
37
77
  };
38
78
 
39
- export type PublicTxResult = {
40
- avmProvingRequest: AvmProvingRequest;
41
- /** Gas used during the execution of this tx */
42
- gasUsed: GasUsed;
43
- revertCode: RevertCode;
44
- /** Revert reason, if any */
45
- revertReason?: SimulationError;
46
- processedPhases: ProcessedPhase[];
47
- };
48
-
49
- export class PublicTxSimulator {
50
- metrics: ExecutorMetrics;
51
-
52
- private log: Logger;
79
+ export class PublicTxSimulator implements PublicTxSimulatorInterface {
80
+ protected log: Logger;
81
+ protected readonly config: PublicSimulatorConfig;
53
82
 
54
83
  constructor(
55
- private db: MerkleTreeReadOperations,
56
- private worldStateDB: WorldStateDB,
57
- private globalVariables: GlobalVariables,
58
- private doMerkleOperations: boolean = false,
59
- private skipFeeEnforcement: boolean = false,
60
- telemetryClient: TelemetryClient = getTelemetryClient(),
84
+ protected merkleTree: MerkleTreeWriteOperations,
85
+ protected contractsDB: PublicContractsDB,
86
+ protected globalVariables: GlobalVariables,
87
+ config?: Partial<PublicSimulatorConfig>,
61
88
  ) {
89
+ this.config = PublicSimulatorConfig.from(config ?? {});
62
90
  this.log = createLogger(`simulator:public_tx_simulator`);
63
- this.metrics = new ExecutorMetrics(telemetryClient, 'PublicTxSimulator');
64
91
  }
65
92
 
66
- get tracer(): Tracer {
67
- return this.metrics.tracer;
68
- }
69
93
  /**
70
94
  * Simulate a transaction's public portion including all of its phases.
71
95
  * @param tx - The transaction to simulate.
72
96
  * @returns The result of the transaction's public execution.
73
97
  */
74
98
  public async simulate(tx: Tx): Promise<PublicTxResult> {
75
- try {
76
- const startTime = process.hrtime.bigint();
99
+ const txHash = this.computeTxHash(tx);
100
+ this.log.debug(`Simulating ${tx.publicFunctionCalldata.length} public calls for tx ${txHash}`, { txHash });
77
101
 
78
- const txHash = await tx.getTxHash();
79
- this.log.debug(`Simulating ${tx.enqueuedPublicFunctionCalls.length} public calls for tx ${txHash}`, { txHash });
102
+ // Create hinting DBs.
103
+ const hints = new AvmExecutionHints(
104
+ this.globalVariables,
105
+ AvmTxHint.fromTx(tx, this.globalVariables.gasFees),
106
+ ProtocolContractsList, // imported from file
107
+ );
108
+ const hintingMerkleTree = await HintingMerkleWriteOperations.create(this.merkleTree, hints);
109
+ const hintingTreesDB = new PublicTreesDB(hintingMerkleTree);
110
+ const hintingContractsDB = new HintingPublicContractsDB(this.contractsDB, hints);
111
+
112
+ const context = await PublicTxContext.create(
113
+ hintingTreesDB,
114
+ hintingContractsDB,
115
+ tx,
116
+ this.globalVariables,
117
+ ProtocolContractsList, // imported from file
118
+ this.config.proverId,
119
+ );
80
120
 
81
- const context = await PublicTxContext.create(
82
- this.db,
83
- this.worldStateDB,
84
- tx,
85
- this.globalVariables,
86
- this.doMerkleOperations,
87
- );
121
+ // This will throw if there is a nullifier collision.
122
+ // In that case the transaction will be thrown out.
123
+ await this.insertNonRevertiblesFromPrivate(context);
88
124
 
89
- const nonRevertStart = process.hrtime.bigint();
90
- await this.insertNonRevertiblesFromPrivate(context);
91
- // add new contracts to the contracts db so that their functions may be found and called
92
- // TODO(#6464): Should we allow emitting contracts in the private setup phase?
93
- await this.worldStateDB.addNewNonRevertibleContracts(tx);
94
- const nonRevertEnd = process.hrtime.bigint();
95
- this.metrics.recordPrivateEffectsInsertion(Number(nonRevertEnd - nonRevertStart) / 1_000, 'non-revertible');
96
-
97
- const processedPhases: ProcessedPhase[] = [];
98
- if (context.hasPhase(TxExecutionPhase.SETUP)) {
99
- const setupResult: ProcessedPhase = await this.simulateSetupPhase(context);
100
- processedPhases.push(setupResult);
125
+ const processedPhases: ProcessedPhase[] = [];
126
+ if (context.hasPhase(TxExecutionPhase.SETUP)) {
127
+ // This will throw if the setup phase reverts.
128
+ // In that case the transaction will be thrown out.
129
+ const setupResult = await this.simulatePhase(TxExecutionPhase.SETUP, context);
130
+ if (setupResult.reverted) {
131
+ throw new Error(
132
+ `Setup phase reverted! The transaction will be thrown out. ${setupResult.revertReason?.message}`,
133
+ );
101
134
  }
135
+ processedPhases.push(setupResult);
136
+ }
102
137
 
103
- const revertStart = process.hrtime.bigint();
104
- const success = await this.insertRevertiblesFromPrivate(context);
105
- if (success) {
106
- // add new contracts to the contracts db so that their functions may be found and called
107
- await this.worldStateDB.addNewRevertibleContracts(tx);
108
- const revertEnd = process.hrtime.bigint();
109
- this.metrics.recordPrivateEffectsInsertion(Number(revertEnd - revertStart) / 1_000, 'revertible');
110
-
111
- // Only proceed with app logic if there was no revert during revertible insertion
112
- if (context.hasPhase(TxExecutionPhase.APP_LOGIC)) {
113
- const appLogicResult: ProcessedPhase = await this.simulateAppLogicPhase(context);
114
- processedPhases.push(appLogicResult);
138
+ // The checkpoint we should go back to if anything from now on reverts.
139
+ await context.state.fork();
140
+ hintingContractsDB.createCheckpoint();
141
+
142
+ try {
143
+ // This will throw if there is a nullifier collision or other insertion error (limit reached).
144
+ await this.insertRevertiblesFromPrivate(context);
145
+
146
+ // Only proceed with app logic if there was no revert during revertible insertion.
147
+ if (context.hasPhase(TxExecutionPhase.APP_LOGIC)) {
148
+ const appLogicResult = await this.simulatePhase(TxExecutionPhase.APP_LOGIC, context);
149
+ processedPhases.push(appLogicResult);
150
+ if (appLogicResult.reverted) {
151
+ throw new TxSimAppLogicRevert();
115
152
  }
153
+ }
154
+ } catch (e: any) {
155
+ if (e instanceof TxSimRevertibleInsertionsRevert || e instanceof TxSimAppLogicRevert) {
156
+ // We revert to the post-setup state.
157
+ await context.state.discardForkedState();
158
+ hintingContractsDB.revertCheckpoint();
159
+ // But we also create a new fork so that the teardown phase can transparently
160
+ // commit or rollback at the end of teardown.
161
+ await context.state.fork();
162
+ hintingContractsDB.createCheckpoint();
116
163
  } else {
117
- this.log.debug(`Revertible insertions failed. Skipping app logic.`);
164
+ // Unchecked/unknown error - re-throw as-is
165
+ throw e;
118
166
  }
167
+ }
119
168
 
169
+ try {
120
170
  if (context.hasPhase(TxExecutionPhase.TEARDOWN)) {
121
- const teardownResult: ProcessedPhase = await this.simulateTeardownPhase(context);
171
+ const teardownResult = await this.simulatePhase(TxExecutionPhase.TEARDOWN, context);
122
172
  processedPhases.push(teardownResult);
173
+ if (teardownResult.reverted) {
174
+ throw new TxSimTeardownRevert();
175
+ }
123
176
  }
124
-
125
- await context.halt();
126
- await this.payFee(context);
127
-
128
- const endStateReference = await this.db.getStateReference();
129
-
130
- const avmProvingRequest = await context.generateProvingRequest(endStateReference);
131
-
132
- const revertCode = context.getFinalRevertCode();
133
-
134
- if (!revertCode.isOK()) {
135
- await tx.filterRevertedLogs();
177
+ // We commit the forked state and we are done.
178
+ await context.state.mergeForkedState();
179
+ hintingContractsDB.commitCheckpoint();
180
+ } catch (e: any) {
181
+ if (e instanceof TxSimTeardownRevert) {
182
+ // We revert to the post-setup state and we are done.
183
+ await context.state.discardForkedState();
184
+ hintingContractsDB.revertCheckpoint();
185
+ } else {
186
+ // Unchecked/unknown error - re-throw as-is
187
+ throw e;
136
188
  }
137
- // Commit contracts from this TX to the block-level cache and clear tx cache
138
- // If the tx reverted, only commit non-revertible contracts
139
- // NOTE: You can't create contracts in public, so this is only relevant for private-created contracts
140
- this.worldStateDB.commitContractsForTx(/*onlyNonRevertibles=*/ !revertCode.isOK());
141
-
142
- const endTime = process.hrtime.bigint();
143
- this.log.debug(`Public TX simulator took ${Number(endTime - startTime) / 1_000_000} ms\n`);
144
-
145
- return {
146
- avmProvingRequest,
147
- gasUsed: {
148
- totalGas: context.getActualGasUsed(),
149
- teardownGas: context.teardownGasUsed,
150
- publicGas: context.getActualPublicGasUsed(),
151
- billedGas: context.getTotalGasUsed(),
152
- },
153
- revertCode,
154
- revertReason: context.revertReason,
155
- processedPhases: processedPhases,
156
- };
157
- } finally {
158
- // Make sure there are no new contracts in the tx-level cache.
159
- // They should either be committed to block-level cache or cleared.
160
- this.worldStateDB.clearContractsForTx();
161
189
  }
162
- }
163
190
 
164
- /**
165
- * Simulate the setup phase of a transaction's public execution.
166
- * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
167
- * @returns The phase result.
168
- */
169
- private async simulateSetupPhase(context: PublicTxContext): Promise<ProcessedPhase> {
170
- return await this.simulatePhase(TxExecutionPhase.SETUP, context);
171
- }
191
+ context.halt();
172
192
 
173
- /**
174
- * Simulate the app logic phase of a transaction's public execution.
175
- * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
176
- * @returns The phase result.
177
- */
178
- private async simulateAppLogicPhase(context: PublicTxContext): Promise<ProcessedPhase> {
179
- assert(context.state.isForked(), 'App logic phase should operate with forked state.');
180
-
181
- const result = await this.simulatePhase(TxExecutionPhase.APP_LOGIC, context);
182
-
183
- if (result.reverted) {
184
- // Drop the currently active forked state manager and rollback to end of setup.
185
- await context.state.discardForkedState();
186
- } else {
187
- if (!context.hasPhase(TxExecutionPhase.TEARDOWN)) {
188
- // Nothing to do after this (no teardown), so merge state updates now instead of letting teardown handle it.
189
- await context.state.mergeForkedState();
190
- }
191
- }
192
-
193
- return result;
193
+ // Such transactions should be filtered by GasTxValidator.
194
+ assert(
195
+ context.getActualGasUsed().l2Gas <= AVM_MAX_PROCESSABLE_L2_GAS,
196
+ `Transaction consumes ${context.getActualGasUsed().l2Gas} L2 gas, which exceeds the AVM maximum processable gas of ${AVM_MAX_PROCESSABLE_L2_GAS}`,
197
+ );
198
+ await this.payFee(context);
199
+
200
+ const publicInputs = await context.generateAvmCircuitPublicInputs();
201
+ const revertCode = context.getFinalRevertCode();
202
+
203
+ // We only return the app logic phase information.
204
+ const appLogicReturnValues =
205
+ processedPhases.find(({ phase }) => phase === TxExecutionPhase.APP_LOGIC)?.returnValues ?? [];
206
+
207
+ return new PublicTxResult(
208
+ /*gasUsed=*/ {
209
+ totalGas: context.getActualGasUsed(),
210
+ teardownGas: context.teardownGasUsed,
211
+ publicGas: context.getActualPublicGasUsed(),
212
+ billedGas: context.getTotalGasUsed(),
213
+ },
214
+ /*revertCode=*/ revertCode,
215
+ /*revertReason=*/ context.revertReason,
216
+ /*appLogicReturnValues=*/ appLogicReturnValues,
217
+ /*logs=*/ context.state.getActiveStateManager().getLogs(),
218
+ /*hints=*/ hints,
219
+ /*publicInputs=*/ publicInputs,
220
+ );
194
221
  }
195
222
 
196
- /**
197
- * Simulate the teardown phase of a transaction's public execution.
198
- * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
199
- * @returns The phase result.
200
- */
201
- private async simulateTeardownPhase(context: PublicTxContext): Promise<ProcessedPhase> {
202
- if (!context.state.isForked()) {
203
- // If state isn't forked (app logic reverted), fork now
204
- // so we can rollback to the end of setup if teardown reverts.
205
- await context.state.fork();
206
- }
207
-
208
- const result = await this.simulatePhase(TxExecutionPhase.TEARDOWN, context);
209
-
210
- if (result.reverted) {
211
- // Drop the currently active forked state manager and rollback to end of setup.
212
- await context.state.discardForkedState();
213
- } else {
214
- // Merge state updates from teardown,
215
- await context.state.mergeForkedState();
216
- }
217
-
218
- return result;
223
+ protected computeTxHash(tx: Tx) {
224
+ return tx.getTxHash();
219
225
  }
220
226
 
221
227
  /**
222
- * Simulate a phase of a transaction's public execution.
223
- * @param phase - The current phase
228
+ * Simulate the setup phase of a transaction's public execution.
224
229
  * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
225
230
  * @returns The phase result.
226
231
  */
227
- private async simulatePhase(phase: TxExecutionPhase, context: PublicTxContext): Promise<ProcessedPhase> {
232
+ protected async simulatePhase(phase: TxExecutionPhase, context: PublicTxContext): Promise<ProcessedPhase> {
228
233
  const callRequests = context.getCallRequestsForPhase(phase);
229
- const executionRequests = context.getExecutionRequestsForPhase(phase);
230
234
 
231
235
  this.log.debug(`Processing phase ${TxExecutionPhase[phase]} for tx ${context.txHash}`, {
232
236
  txHash: context.txHash.toString(),
233
237
  phase: TxExecutionPhase[phase],
234
238
  callRequests: callRequests.length,
235
- executionRequests: executionRequests.length,
236
239
  });
237
240
 
238
241
  const returnValues: NestedProcessReturnValues[] = [];
239
242
  let reverted = false;
240
243
  let revertReason: SimulationError | undefined;
241
- const phaseTimer = new Timer();
242
- for (let i = callRequests.length - 1; i >= 0; i--) {
244
+ for (let i = 0; i < callRequests.length; i++) {
243
245
  if (reverted) {
244
246
  break;
245
247
  }
246
248
 
247
249
  const callRequest = callRequests[i];
248
- const executionRequest = executionRequests[i];
249
250
 
250
- const enqueuedCallResult = await this.simulateEnqueuedCall(phase, context, callRequest, executionRequest);
251
+ const enqueuedCallResult = await this.simulateEnqueuedCall(phase, context, callRequest);
251
252
 
252
253
  returnValues.push(new NestedProcessReturnValues(enqueuedCallResult.output));
253
254
 
@@ -259,7 +260,6 @@ export class PublicTxSimulator {
259
260
 
260
261
  return {
261
262
  phase,
262
- durationMs: phaseTimer.ms(),
263
263
  returnValues,
264
264
  reverted,
265
265
  revertReason,
@@ -270,31 +270,23 @@ export class PublicTxSimulator {
270
270
  * Simulate an enqueued public call.
271
271
  * @param phase - The current phase of public execution
272
272
  * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
273
- * @param callRequest - The enqueued call to execute
274
- * @param executionRequest - The execution request (includes args)
273
+ * @param callRequest - The public function call request, including the calldata.
275
274
  * @returns The result of execution.
276
275
  */
277
- @trackSpan('PublicTxSimulator.simulateEnqueuedCall', (phase, context, _callRequest, executionRequest) => ({
278
- [Attributes.TX_HASH]: context.txHash.toString(),
279
- [Attributes.TARGET_ADDRESS]: executionRequest.callContext.contractAddress.toString(),
280
- [Attributes.SENDER_ADDRESS]: executionRequest.callContext.msgSender.toString(),
281
- [Attributes.SIMULATOR_PHASE]: TxExecutionPhase[phase].toString(),
282
- }))
283
- private async simulateEnqueuedCall(
276
+ protected async simulateEnqueuedCall(
284
277
  phase: TxExecutionPhase,
285
278
  context: PublicTxContext,
286
- callRequest: PublicCallRequest,
287
- executionRequest: PublicExecutionRequest,
279
+ callRequest: PublicCallRequestWithCalldata,
288
280
  ): Promise<AvmFinalizedCallResult> {
289
281
  const stateManager = context.state.getActiveStateManager();
290
- const address = executionRequest.callContext.contractAddress;
291
- const fnName = await getPublicFunctionDebugName(this.worldStateDB, address, executionRequest.args);
282
+ const contractAddress = callRequest.request.contractAddress;
283
+ const fnName = await getPublicFunctionDebugName(this.contractsDB, contractAddress, callRequest.calldata);
292
284
 
293
285
  const allocatedGas = context.getGasLeftAtPhase(phase);
294
286
 
295
287
  const result = await this.simulateEnqueuedCallInternal(
296
- context.state.getActiveStateManager(),
297
- executionRequest,
288
+ stateManager,
289
+ callRequest,
298
290
  allocatedGas,
299
291
  /*transactionFee=*/ context.getTransactionFee(phase),
300
292
  fnName,
@@ -306,11 +298,9 @@ export class PublicTxSimulator {
306
298
  `Simulated enqueued public call (${fnName}) consumed ${gasUsed.l2Gas} L2 gas ending with ${result.gasLeft.l2Gas} L2 gas left.`,
307
299
  );
308
300
 
309
- stateManager.traceEnqueuedCall(callRequest, executionRequest.args, result.reverted);
310
-
311
301
  if (result.reverted) {
312
- const culprit = `${executionRequest.callContext.contractAddress}:${executionRequest.callContext.functionSelector}`;
313
- context.revert(phase, result.revertReason, culprit); // throws if in setup (non-revertible) phase
302
+ const culprit = `${contractAddress}:${callRequest.functionSelector}`;
303
+ context.revert(phase, result.revertReason, culprit);
314
304
  }
315
305
 
316
306
  return result;
@@ -324,32 +314,24 @@ export class PublicTxSimulator {
324
314
  * while still simulating phases and generating a proving request.
325
315
  *
326
316
  * @param stateManager - The state manager for AvmSimulation
327
- * @param context - The context of the currently executing public transaction portion
328
- * @param executionRequest - The execution request (includes args)
317
+ * @param callRequest - The public function call request, including the calldata.
329
318
  * @param allocatedGas - The gas allocated to the enqueued call
330
319
  * @param fnName - The name of the function
331
320
  * @returns The result of execution.
332
321
  */
333
- @trackSpan(
334
- 'PublicTxSimulator.simulateEnqueuedCallInternal',
335
- (_stateManager, _executionRequest, _allocatedGas, _transactionFee, fnName) => ({
336
- [Attributes.APP_CIRCUIT_NAME]: fnName,
337
- }),
338
- )
339
- private async simulateEnqueuedCallInternal(
340
- stateManager: AvmPersistableStateManager,
341
- executionRequest: PublicExecutionRequest,
322
+ protected async simulateEnqueuedCallInternal(
323
+ stateManager: PublicPersistableStateManager,
324
+ { request, calldata }: PublicCallRequestWithCalldata,
342
325
  allocatedGas: Gas,
343
326
  transactionFee: Fr,
344
327
  fnName: string,
345
328
  ): Promise<AvmFinalizedCallResult> {
346
- const address = executionRequest.callContext.contractAddress;
347
- const sender = executionRequest.callContext.msgSender;
329
+ const address = request.contractAddress;
330
+ const sender = request.msgSender;
348
331
 
349
332
  this.log.debug(
350
333
  `Executing enqueued public call to external function ${fnName}@${address} with ${allocatedGas.l2Gas} allocated L2 gas.`,
351
334
  );
352
- const timer = new Timer();
353
335
 
354
336
  const simulator = await AvmSimulator.create(
355
337
  stateManager,
@@ -357,94 +339,138 @@ export class PublicTxSimulator {
357
339
  sender,
358
340
  transactionFee,
359
341
  this.globalVariables,
360
- executionRequest.callContext.isStaticCall,
361
- executionRequest.args,
342
+ request.isStaticCall,
343
+ calldata,
362
344
  allocatedGas,
345
+ this.config,
363
346
  );
364
347
  const avmCallResult = await simulator.execute();
365
- const result = avmCallResult.finalize();
366
-
367
- this.log.verbose(
368
- result.reverted
369
- ? `Simulation of enqueued public call ${fnName} reverted with reason ${result.revertReason}.`
370
- : `Simulation of enqueued public call ${fnName} completed successfully.`,
371
- {
372
- eventName: 'avm-simulation',
373
- appCircuitName: fnName,
374
- duration: timer.ms(),
375
- } satisfies AvmSimulationStats,
376
- );
377
-
378
- if (result.reverted) {
379
- this.metrics.recordFunctionSimulationFailure();
380
- } else {
381
- this.metrics.recordFunctionSimulation(timer.ms(), allocatedGas.sub(result.gasLeft).l2Gas, fnName);
382
- }
383
-
384
- return result;
348
+ return avmCallResult.finalize();
385
349
  }
386
350
 
387
351
  /**
388
352
  * Insert the non-revertible accumulated data from private into the public state.
389
353
  */
390
- public async insertNonRevertiblesFromPrivate(context: PublicTxContext) {
354
+ protected async insertNonRevertiblesFromPrivate(context: PublicTxContext) {
391
355
  const stateManager = context.state.getActiveStateManager();
392
- try {
393
- await stateManager.writeSiloedNullifiersFromPrivate(context.nonRevertibleAccumulatedDataFromPrivate.nullifiers);
394
- } catch (e) {
395
- if (e instanceof NullifierCollisionError) {
396
- throw new NullifierCollisionError(
397
- `Nullifier collision encountered when inserting non-revertible nullifiers from private.\nDetails: ${e.message}\nStack:${e.stack}`,
398
- );
399
- }
356
+
357
+ for (const siloedNullifier of context.nonRevertibleAccumulatedDataFromPrivate.nullifiers.filter(
358
+ n => !n.isEmpty(),
359
+ )) {
360
+ await stateManager.writeSiloedNullifier(siloedNullifier);
400
361
  }
401
362
  for (const noteHash of context.nonRevertibleAccumulatedDataFromPrivate.noteHashes) {
402
363
  if (!noteHash.isEmpty()) {
403
364
  await stateManager.writeUniqueNoteHash(noteHash);
404
365
  }
405
366
  }
367
+ for (const l2ToL1Message of context.nonRevertibleAccumulatedDataFromPrivate.l2ToL1Msgs) {
368
+ if (!l2ToL1Message.isEmpty()) {
369
+ stateManager.writeScopedL2ToL1Message(l2ToL1Message);
370
+ }
371
+ }
372
+
373
+ // add new contracts to the contracts db so that their code may be found and called
374
+ // FIXME(fcarreiro): this should conceptually use the hinting contracts db.
375
+ // However, things work as expected because later calls to getters on the hintingContractsDB
376
+ // will pick up the new contracts and will generate the necessary hints.
377
+ // So, a consumer of the hints will always see the new contracts.
378
+ await this.contractsDB.addContracts(context.nonRevertibleContractDeploymentData);
406
379
  }
407
380
 
408
381
  /**
409
382
  * Insert the revertible accumulated data from private into the public state.
410
- * Start by forking state so we can rollback to the end of setup if app logic or teardown reverts.
383
+ * Throws TxSimRevertibleInsertionsRevert if there is some checked error during revertible insertions.
384
+ * This function checks for the following errors:
385
+ * - NullifierLimitReachedError
386
+ * - NullifierCollisionError
387
+ * - NoteHashLimitReachedError
388
+ * - L2ToL1MessageLimitReachedError
411
389
  */
412
- public async insertRevertiblesFromPrivate(context: PublicTxContext): /*success=*/ Promise<boolean> {
413
- // Fork the state manager so we can rollback to end of setup if app logic reverts.
414
- await context.state.fork();
390
+ protected async insertRevertiblesFromPrivate(context: PublicTxContext) {
415
391
  const stateManager = context.state.getActiveStateManager();
392
+
416
393
  try {
417
- await stateManager.writeSiloedNullifiersFromPrivate(context.revertibleAccumulatedDataFromPrivate.nullifiers);
418
- } catch (e) {
419
- if (e instanceof NullifierCollisionError) {
420
- // Instead of throwing, revert the app_logic phase
394
+ for (const siloedNullifier of context.revertibleAccumulatedDataFromPrivate.nullifiers.filter(n => !n.isEmpty())) {
395
+ await stateManager.writeSiloedNullifier(siloedNullifier);
396
+ }
397
+ } catch (e: any) {
398
+ if (e instanceof NullifierLimitReachedError || e instanceof NullifierCollisionError) {
421
399
  context.revert(
422
400
  TxExecutionPhase.APP_LOGIC,
423
401
  new SimulationError(
424
- `Nullifier collision encountered when inserting revertible nullifiers from private\nDetails: ${e.message}\nError stack: ${e.stack}`,
402
+ `Error encountered when inserting revertible nullifiers from private.\nDetails: ${e.message}`,
425
403
  [],
426
404
  ),
427
- /*culprit=*/ 'insertRevertiblesFromPrivate',
428
405
  );
429
- return /*success=*/ false;
406
+ throw new TxSimRevertibleInsertionsRevert();
430
407
  } else {
408
+ // Unchecked/unknown error - re-throw as-is
431
409
  throw e;
432
410
  }
433
411
  }
434
- for (const noteHash of context.revertibleAccumulatedDataFromPrivate.noteHashes) {
435
- if (!noteHash.isEmpty()) {
436
- // Revertible note hashes from private are not hashed with nonce, since private can't know their final position, only we can.
437
- await stateManager.writeSiloedNoteHash(noteHash);
412
+
413
+ try {
414
+ for (const noteHash of context.revertibleAccumulatedDataFromPrivate.noteHashes) {
415
+ if (!noteHash.isEmpty()) {
416
+ // Revertible note hashes from private are not hashed with nonce, since private can't know their final position, only we can.
417
+ await stateManager.writeSiloedNoteHash(noteHash);
418
+ }
419
+ }
420
+ } catch (e: any) {
421
+ if (e instanceof NoteHashLimitReachedError) {
422
+ context.revert(
423
+ TxExecutionPhase.APP_LOGIC,
424
+ new SimulationError(
425
+ `Error encountered when inserting revertible note hashes from private.\nDetails: ${e.message}`,
426
+ [],
427
+ ),
428
+ );
429
+ throw new TxSimRevertibleInsertionsRevert();
430
+ } else {
431
+ // Unchecked/unknown error - re-throw as-is
432
+ throw e;
433
+ }
434
+ }
435
+
436
+ try {
437
+ for (const l2ToL1Message of context.revertibleAccumulatedDataFromPrivate.l2ToL1Msgs) {
438
+ if (!l2ToL1Message.isEmpty()) {
439
+ stateManager.writeScopedL2ToL1Message(l2ToL1Message);
440
+ }
441
+ }
442
+ } catch (e: any) {
443
+ if (e instanceof L2ToL1MessageLimitReachedError) {
444
+ context.revert(
445
+ TxExecutionPhase.APP_LOGIC,
446
+ new SimulationError(
447
+ `Error encountered when inserting revertible L2-to-L1 messages from private.\nDetails: ${e.message}`,
448
+ [],
449
+ ),
450
+ );
451
+ throw new TxSimRevertibleInsertionsRevert();
452
+ } else {
453
+ // Unchecked/unknown error - re-throw as-is
454
+ throw e;
438
455
  }
439
456
  }
440
- return /*success=*/ true;
457
+
458
+ // add new contracts to the contracts db so that their functions may be found and called
459
+ // FIXME(fcarreiro): this should conceptually use the hinting contracts db.
460
+ // However, things work as expected because later calls to getters on the hintingContractsDB
461
+ // will pick up the new contracts and will generate the necessary hints.
462
+ // So, a consumer of the hints will always see the new contracts.
463
+ await this.contractsDB.addContracts(context.revertibleContractDeploymentData);
441
464
  }
442
465
 
443
466
  private async payFee(context: PublicTxContext) {
444
467
  const txFee = context.getTransactionFee(TxExecutionPhase.TEARDOWN);
445
468
 
446
469
  if (context.feePayer.isZero()) {
447
- this.log.debug(`No one is paying the fee of ${txFee.toBigInt()}`);
470
+ // Real transactions are enforced by private kernel to have nonzero fee payer.
471
+ // Real transactions cannot skip fee enforcement (skipping fee enforcement makes them unprovable).
472
+ assert(this.config.skipFeeEnforcement, 'Fee payer cannot be 0 unless skipping fee enforcement for simulation');
473
+ this.log.debug(`Fee payer is 0. Skipping fee enforcement. No one is paying the fee of ${txFee.toBigInt()}`);
448
474
  return;
449
475
  }
450
476
 
@@ -459,13 +485,14 @@ export class PublicTxSimulator {
459
485
  // When mocking the balance of the fee payer, the circuit should not be able to prove the simulation
460
486
 
461
487
  if (currentBalance.lt(txFee)) {
462
- if (!this.skipFeeEnforcement) {
463
- throw new Error(
464
- `Not enough balance for fee payer to pay for transaction (got ${currentBalance.toBigInt()} needs ${txFee.toBigInt()})`,
465
- );
466
- } else {
467
- currentBalance = txFee;
468
- }
488
+ // Without "skipFeeEnforcement", such transactions should be filtered by GasTxValidator.
489
+ assert(
490
+ this.config.skipFeeEnforcement,
491
+ `Not enough balance for fee payer to pay for transaction (got ${currentBalance.toBigInt()} needs ${txFee.toBigInt()})`,
492
+ );
493
+ this.log.debug(`Fee payer balance insufficient, but we're skipping fee enforcement`);
494
+ // We still proceed and perform the storage write to minimize deviation from normal execution.
495
+ currentBalance = txFee;
469
496
  }
470
497
 
471
498
  const updatedBalance = currentBalance.sub(txFee);