@aztec/simulator 0.0.0-test.1 → 0.0.1-commit.24de95ac

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 (466) hide show
  1. package/README.md +6 -0
  2. package/dest/client.d.ts +5 -3
  3. package/dest/client.d.ts.map +1 -1
  4. package/dest/client.js +4 -2
  5. package/dest/common/errors.d.ts +4 -7
  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 +0 -1
  9. package/dest/common/index.d.ts.map +1 -1
  10. package/dest/common/index.js +0 -1
  11. package/dest/private/acvm/acvm.d.ts +11 -5
  12. package/dest/private/acvm/acvm.d.ts.map +1 -1
  13. package/dest/private/acvm/acvm.js +10 -16
  14. package/dest/private/acvm/acvm_types.d.ts +1 -1
  15. package/dest/private/acvm/acvm_types.d.ts.map +1 -1
  16. package/dest/private/acvm/deserialize.d.ts +17 -18
  17. package/dest/private/acvm/deserialize.d.ts.map +1 -1
  18. package/dest/private/acvm/deserialize.js +31 -23
  19. package/dest/private/acvm/index.d.ts +0 -1
  20. package/dest/private/acvm/index.d.ts.map +1 -1
  21. package/dest/private/acvm/index.js +0 -1
  22. package/dest/private/acvm/serialize.d.ts +19 -2
  23. package/dest/private/acvm/serialize.d.ts.map +1 -1
  24. package/dest/private/acvm/serialize.js +53 -0
  25. package/dest/private/{providers/acvm_native.d.ts → acvm_native.d.ts} +9 -10
  26. package/dest/private/acvm_native.d.ts.map +1 -0
  27. package/dest/private/{providers/acvm_native.js → acvm_native.js} +26 -20
  28. package/dest/private/acvm_wasm.d.ts +15 -0
  29. package/dest/private/acvm_wasm.d.ts.map +1 -0
  30. package/dest/private/{providers/acvm_wasm.js → acvm_wasm.js} +22 -19
  31. package/dest/private/acvm_wasm_with_blobs.d.ts +20 -0
  32. package/dest/private/acvm_wasm_with_blobs.d.ts.map +1 -0
  33. package/dest/private/acvm_wasm_with_blobs.js +35 -0
  34. package/dest/private/circuit_recording/circuit_recorder.d.ts +108 -0
  35. package/dest/private/circuit_recording/circuit_recorder.d.ts.map +1 -0
  36. package/dest/private/circuit_recording/circuit_recorder.js +209 -0
  37. package/dest/private/circuit_recording/file_circuit_recorder.d.ts +31 -0
  38. package/dest/private/circuit_recording/file_circuit_recorder.d.ts.map +1 -0
  39. package/dest/private/circuit_recording/file_circuit_recorder.js +135 -0
  40. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts +5 -0
  41. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts.map +1 -0
  42. package/dest/private/circuit_recording/memory_circuit_recorder.js +9 -0
  43. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts +21 -0
  44. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts.map +1 -0
  45. package/dest/private/circuit_recording/simulator_recorder_wrapper.js +44 -0
  46. package/dest/private/circuit_simulator.d.ts +35 -0
  47. package/dest/private/circuit_simulator.d.ts.map +1 -0
  48. package/dest/private/circuit_simulator.js +43 -0
  49. package/dest/private/factory.d.ts +12 -0
  50. package/dest/private/factory.d.ts.map +1 -0
  51. package/dest/private/{providers/factory.js → factory.js} +2 -2
  52. package/dest/public/avm/avm_context.d.ts +5 -5
  53. package/dest/public/avm/avm_context.d.ts.map +1 -1
  54. package/dest/public/avm/avm_contract_call_result.d.ts +4 -2
  55. package/dest/public/avm/avm_contract_call_result.d.ts.map +1 -1
  56. package/dest/public/avm/avm_contract_call_result.js +11 -7
  57. package/dest/public/avm/avm_execution_environment.d.ts +3 -1
  58. package/dest/public/avm/avm_execution_environment.d.ts.map +1 -1
  59. package/dest/public/avm/avm_execution_environment.js +7 -2
  60. package/dest/public/avm/avm_gas.d.ts +4 -20
  61. package/dest/public/avm/avm_gas.d.ts.map +1 -1
  62. package/dest/public/avm/avm_gas.js +27 -35
  63. package/dest/public/avm/avm_machine_state.d.ts +2 -0
  64. package/dest/public/avm/avm_machine_state.d.ts.map +1 -1
  65. package/dest/public/avm/avm_machine_state.js +2 -0
  66. package/dest/public/avm/avm_memory_types.d.ts +98 -87
  67. package/dest/public/avm/avm_memory_types.d.ts.map +1 -1
  68. package/dest/public/avm/avm_memory_types.js +17 -6
  69. package/dest/public/avm/avm_simulator.d.ts +4 -5
  70. package/dest/public/avm/avm_simulator.d.ts.map +1 -1
  71. package/dest/public/avm/avm_simulator.js +23 -35
  72. package/dest/public/avm/avm_simulator_interface.d.ts +9 -0
  73. package/dest/public/avm/avm_simulator_interface.d.ts.map +1 -0
  74. package/dest/public/avm/avm_simulator_interface.js +3 -0
  75. package/dest/public/avm/errors.d.ts +6 -30
  76. package/dest/public/avm/errors.d.ts.map +1 -1
  77. package/dest/public/avm/errors.js +7 -57
  78. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +5 -4
  79. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +1 -1
  80. package/dest/public/avm/fixtures/avm_simulation_tester.js +12 -14
  81. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts +6 -4
  82. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +1 -1
  83. package/dest/public/avm/fixtures/base_avm_simulation_tester.js +37 -14
  84. package/dest/public/avm/fixtures/initializers.d.ts +43 -0
  85. package/dest/public/avm/fixtures/initializers.d.ts.map +1 -0
  86. package/dest/public/avm/fixtures/initializers.js +42 -0
  87. package/dest/public/avm/fixtures/utils.d.ts +38 -0
  88. package/dest/public/avm/fixtures/utils.d.ts.map +1 -0
  89. package/dest/public/avm/fixtures/utils.js +95 -0
  90. package/dest/public/avm/index.d.ts +0 -2
  91. package/dest/public/avm/index.d.ts.map +1 -1
  92. package/dest/public/avm/index.js +0 -2
  93. package/dest/public/avm/opcodes/accrued_substate.d.ts +2 -2
  94. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +1 -1
  95. package/dest/public/avm/opcodes/accrued_substate.js +28 -25
  96. package/dest/public/avm/opcodes/addressing_mode.d.ts +11 -7
  97. package/dest/public/avm/opcodes/addressing_mode.d.ts.map +1 -1
  98. package/dest/public/avm/opcodes/addressing_mode.js +46 -26
  99. package/dest/public/avm/opcodes/arithmetic.d.ts +11 -1
  100. package/dest/public/avm/opcodes/arithmetic.d.ts.map +1 -1
  101. package/dest/public/avm/opcodes/arithmetic.js +16 -2
  102. package/dest/public/avm/opcodes/bitwise.d.ts +5 -13
  103. package/dest/public/avm/opcodes/bitwise.d.ts.map +1 -1
  104. package/dest/public/avm/opcodes/bitwise.js +19 -26
  105. package/dest/public/avm/opcodes/comparators.d.ts.map +1 -1
  106. package/dest/public/avm/opcodes/comparators.js +3 -3
  107. package/dest/public/avm/opcodes/contract.d.ts +1 -2
  108. package/dest/public/avm/opcodes/contract.d.ts.map +1 -1
  109. package/dest/public/avm/opcodes/contract.js +9 -10
  110. package/dest/public/avm/opcodes/control_flow.d.ts.map +1 -1
  111. package/dest/public/avm/opcodes/control_flow.js +10 -8
  112. package/dest/public/avm/opcodes/conversion.d.ts +1 -0
  113. package/dest/public/avm/opcodes/conversion.d.ts.map +1 -1
  114. package/dest/public/avm/opcodes/conversion.js +267 -3
  115. package/dest/public/avm/opcodes/ec_add.d.ts.map +1 -1
  116. package/dest/public/avm/opcodes/ec_add.js +6 -6
  117. package/dest/public/avm/opcodes/environment_getters.d.ts +2 -2
  118. package/dest/public/avm/opcodes/environment_getters.d.ts.map +1 -1
  119. package/dest/public/avm/opcodes/environment_getters.js +17 -19
  120. package/dest/public/avm/opcodes/external_calls.d.ts +8 -7
  121. package/dest/public/avm/opcodes/external_calls.d.ts.map +1 -1
  122. package/dest/public/avm/opcodes/external_calls.js +39 -34
  123. package/dest/public/avm/opcodes/hashing.d.ts.map +1 -1
  124. package/dest/public/avm/opcodes/hashing.js +6 -6
  125. package/dest/public/avm/opcodes/instruction.d.ts +14 -10
  126. package/dest/public/avm/opcodes/instruction.d.ts.map +1 -1
  127. package/dest/public/avm/opcodes/instruction.js +23 -19
  128. package/dest/public/avm/opcodes/memory.d.ts +4 -4
  129. package/dest/public/avm/opcodes/memory.d.ts.map +1 -1
  130. package/dest/public/avm/opcodes/memory.js +37 -33
  131. package/dest/public/avm/opcodes/misc.d.ts +2 -1
  132. package/dest/public/avm/opcodes/misc.d.ts.map +1 -1
  133. package/dest/public/avm/opcodes/misc.js +41 -16
  134. package/dest/public/avm/opcodes/storage.d.ts.map +1 -1
  135. package/dest/public/avm/opcodes/storage.js +7 -5
  136. package/dest/public/avm/revert_reason.d.ts +18 -0
  137. package/dest/public/avm/revert_reason.d.ts.map +1 -0
  138. package/dest/public/avm/revert_reason.js +38 -0
  139. package/dest/public/avm/serialization/buffer_cursor.d.ts +0 -2
  140. package/dest/public/avm/serialization/buffer_cursor.d.ts.map +1 -1
  141. package/dest/public/avm/serialization/bytecode_serialization.d.ts +2 -6
  142. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +1 -1
  143. package/dest/public/avm/serialization/bytecode_serialization.js +70 -69
  144. package/dest/public/avm/serialization/instruction_serialization.d.ts +13 -4
  145. package/dest/public/avm/serialization/instruction_serialization.d.ts.map +1 -1
  146. package/dest/public/avm/serialization/instruction_serialization.js +70 -35
  147. package/dest/public/avm/test_utils.d.ts +10 -13
  148. package/dest/public/avm/test_utils.d.ts.map +1 -1
  149. package/dest/public/avm/test_utils.js +16 -24
  150. package/dest/public/db_interfaces.d.ts +56 -0
  151. package/dest/public/db_interfaces.d.ts.map +1 -0
  152. package/dest/public/db_interfaces.js +3 -0
  153. package/dest/public/debug_fn_name.d.ts +5 -0
  154. package/dest/public/debug_fn_name.d.ts.map +1 -0
  155. package/dest/public/debug_fn_name.js +9 -0
  156. package/dest/public/executor_metrics.d.ts +10 -3
  157. package/dest/public/executor_metrics.d.ts.map +1 -1
  158. package/dest/public/executor_metrics.js +37 -6
  159. package/dest/public/executor_metrics_interface.d.ts +9 -0
  160. package/dest/public/executor_metrics_interface.d.ts.map +1 -0
  161. package/dest/public/executor_metrics_interface.js +1 -0
  162. package/dest/public/fixtures/amm_test.d.ts +10 -0
  163. package/dest/public/fixtures/amm_test.d.ts.map +1 -0
  164. package/dest/public/fixtures/amm_test.js +213 -0
  165. package/dest/public/fixtures/bulk_test.d.ts +6 -0
  166. package/dest/public/fixtures/bulk_test.d.ts.map +1 -0
  167. package/dest/public/fixtures/bulk_test.js +326 -0
  168. package/dest/public/fixtures/custom_bytecode_tester.d.ts +12 -0
  169. package/dest/public/fixtures/custom_bytecode_tester.d.ts.map +1 -0
  170. package/dest/public/fixtures/custom_bytecode_tester.js +29 -0
  171. package/dest/public/fixtures/custom_bytecode_tests.d.ts +9 -0
  172. package/dest/public/fixtures/custom_bytecode_tests.d.ts.map +1 -0
  173. package/dest/public/fixtures/custom_bytecode_tests.js +109 -0
  174. package/dest/public/fixtures/index.d.ts +7 -0
  175. package/dest/public/fixtures/index.d.ts.map +1 -1
  176. package/dest/public/fixtures/index.js +7 -0
  177. package/dest/public/fixtures/minimal_public_tx.d.ts +10 -0
  178. package/dest/public/fixtures/minimal_public_tx.d.ts.map +1 -0
  179. package/dest/public/fixtures/minimal_public_tx.js +29 -0
  180. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +35 -13
  181. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -1
  182. package/dest/public/fixtures/public_tx_simulation_tester.js +96 -71
  183. package/dest/public/{avm/fixtures → fixtures}/simple_contract_data_source.d.ts +6 -6
  184. package/dest/public/fixtures/simple_contract_data_source.d.ts.map +1 -0
  185. package/dest/public/{avm/fixtures → fixtures}/simple_contract_data_source.js +31 -10
  186. package/dest/public/fixtures/token_test.d.ts +8 -0
  187. package/dest/public/fixtures/token_test.d.ts.map +1 -0
  188. package/dest/public/fixtures/token_test.js +95 -0
  189. package/dest/public/fixtures/utils.d.ts +16 -3
  190. package/dest/public/fixtures/utils.d.ts.map +1 -1
  191. package/dest/public/fixtures/utils.js +100 -58
  192. package/dest/public/hinting_db_sources.d.ts +70 -0
  193. package/dest/public/hinting_db_sources.d.ts.map +1 -0
  194. package/dest/public/hinting_db_sources.js +297 -0
  195. package/dest/public/index.d.ts +4 -8
  196. package/dest/public/index.d.ts.map +1 -1
  197. package/dest/public/index.js +4 -7
  198. package/dest/public/public_db_sources.d.ts +30 -39
  199. package/dest/public/public_db_sources.d.ts.map +1 -1
  200. package/dest/public/public_db_sources.js +151 -67
  201. package/dest/public/public_errors.d.ts +12 -0
  202. package/dest/public/public_errors.d.ts.map +1 -0
  203. package/dest/public/public_errors.js +13 -0
  204. package/dest/public/public_processor/guarded_merkle_tree.d.ts +49 -0
  205. package/dest/public/public_processor/guarded_merkle_tree.d.ts.map +1 -0
  206. package/dest/public/public_processor/guarded_merkle_tree.js +108 -0
  207. package/dest/public/public_processor/public_processor.d.ts +25 -30
  208. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  209. package/dest/public/public_processor/public_processor.js +141 -96
  210. package/dest/public/public_processor/public_processor_metrics.d.ts +2 -2
  211. package/dest/public/public_processor/public_processor_metrics.d.ts.map +1 -1
  212. package/dest/public/public_processor/public_processor_metrics.js +1 -1
  213. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +41 -0
  214. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +1 -0
  215. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +89 -0
  216. package/dest/public/public_tx_simulator/index.d.ts +4 -0
  217. package/dest/public/public_tx_simulator/index.d.ts.map +1 -0
  218. package/dest/public/public_tx_simulator/index.js +2 -0
  219. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts +24 -0
  220. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts.map +1 -0
  221. package/dest/public/public_tx_simulator/measured_public_tx_simulator.js +51 -0
  222. package/dest/public/public_tx_simulator/public_tx_context.d.ts +19 -29
  223. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +1 -1
  224. package/dest/public/public_tx_simulator/public_tx_context.js +63 -91
  225. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +45 -47
  226. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  227. package/dest/public/public_tx_simulator/public_tx_simulator.js +209 -184
  228. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts +9 -0
  229. package/dest/public/public_tx_simulator/public_tx_simulator_interface.d.ts.map +1 -0
  230. package/dest/public/public_tx_simulator/public_tx_simulator_interface.js +1 -0
  231. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts +21 -0
  232. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts.map +1 -0
  233. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.js +39 -0
  234. package/dest/public/side_effect_errors.d.ts +41 -1
  235. package/dest/public/side_effect_errors.d.ts.map +1 -1
  236. package/dest/public/side_effect_errors.js +70 -1
  237. package/dest/public/side_effect_trace.d.ts +20 -65
  238. package/dest/public/side_effect_trace.d.ts.map +1 -1
  239. package/dest/public/side_effect_trace.js +71 -121
  240. package/dest/public/side_effect_trace_interface.d.ts +11 -22
  241. package/dest/public/side_effect_trace_interface.d.ts.map +1 -1
  242. package/dest/public/state_manager/index.d.ts +2 -0
  243. package/dest/public/state_manager/index.d.ts.map +1 -0
  244. package/dest/public/state_manager/index.js +1 -0
  245. package/dest/public/{avm/journal → state_manager}/nullifiers.d.ts +2 -5
  246. package/dest/public/state_manager/nullifiers.d.ts.map +1 -0
  247. package/dest/public/{avm/journal → state_manager}/nullifiers.js +3 -8
  248. package/dest/public/{avm/journal → state_manager}/public_storage.d.ts +2 -2
  249. package/dest/public/state_manager/public_storage.d.ts.map +1 -0
  250. package/dest/public/{avm/journal/journal.d.ts → state_manager/state_manager.d.ts} +42 -85
  251. package/dest/public/state_manager/state_manager.d.ts.map +1 -0
  252. package/dest/public/state_manager/state_manager.js +391 -0
  253. package/dest/public/test_executor_metrics.d.ts +54 -0
  254. package/dest/public/test_executor_metrics.d.ts.map +1 -0
  255. package/dest/public/test_executor_metrics.js +306 -0
  256. package/dest/public/unique_class_ids.d.ts.map +1 -1
  257. package/dest/public/utils.d.ts +2 -4
  258. package/dest/public/utils.d.ts.map +1 -1
  259. package/dest/public/utils.js +4 -21
  260. package/dest/server.d.ts +6 -3
  261. package/dest/server.d.ts.map +1 -1
  262. package/dest/server.js +5 -2
  263. package/dest/testing.d.ts +2 -0
  264. package/dest/testing.d.ts.map +1 -0
  265. package/dest/testing.js +1 -0
  266. package/package.json +36 -31
  267. package/src/client.ts +5 -3
  268. package/src/common/errors.ts +79 -44
  269. package/src/common/index.ts +0 -1
  270. package/src/private/acvm/acvm.ts +17 -32
  271. package/src/private/acvm/acvm_types.ts +1 -1
  272. package/src/private/acvm/deserialize.ts +35 -29
  273. package/src/private/acvm/index.ts +0 -1
  274. package/src/private/acvm/serialize.ts +63 -0
  275. package/src/private/{providers/acvm_native.ts → acvm_native.ts} +47 -24
  276. package/src/private/acvm_wasm.ts +72 -0
  277. package/src/private/acvm_wasm_with_blobs.ts +54 -0
  278. package/src/private/circuit_recording/circuit_recorder.ts +260 -0
  279. package/src/private/circuit_recording/file_circuit_recorder.ts +158 -0
  280. package/src/private/circuit_recording/memory_circuit_recorder.ts +11 -0
  281. package/src/private/circuit_recording/simulator_recorder_wrapper.ts +91 -0
  282. package/src/private/circuit_simulator.ts +90 -0
  283. package/src/private/{providers/factory.ts → factory.ts} +6 -6
  284. package/src/public/avm/avm_context.ts +4 -4
  285. package/src/public/avm/avm_contract_call_result.ts +17 -5
  286. package/src/public/avm/avm_execution_environment.ts +10 -1
  287. package/src/public/avm/avm_gas.ts +23 -35
  288. package/src/public/avm/avm_machine_state.ts +5 -0
  289. package/src/public/avm/avm_memory_types.ts +19 -6
  290. package/src/public/avm/avm_simulator.ts +44 -54
  291. package/src/public/avm/avm_simulator_interface.ts +8 -0
  292. package/src/public/avm/errors.ts +8 -77
  293. package/src/public/avm/fixtures/avm_simulation_tester.ts +23 -20
  294. package/src/public/avm/fixtures/base_avm_simulation_tester.ts +45 -12
  295. package/src/public/avm/fixtures/initializers.ts +104 -0
  296. package/src/public/avm/fixtures/utils.ts +150 -0
  297. package/src/public/avm/index.ts +0 -2
  298. package/src/public/avm/opcodes/accrued_substate.ts +64 -29
  299. package/src/public/avm/opcodes/addressing_mode.ts +56 -32
  300. package/src/public/avm/opcodes/arithmetic.ts +24 -2
  301. package/src/public/avm/opcodes/bitwise.ts +33 -29
  302. package/src/public/avm/opcodes/comparators.ts +6 -3
  303. package/src/public/avm/opcodes/contract.ts +10 -7
  304. package/src/public/avm/opcodes/control_flow.ts +19 -10
  305. package/src/public/avm/opcodes/conversion.ts +27 -3
  306. package/src/public/avm/opcodes/ec_add.ts +9 -6
  307. package/src/public/avm/opcodes/environment_getters.ts +27 -22
  308. package/src/public/avm/opcodes/external_calls.ts +61 -29
  309. package/src/public/avm/opcodes/hashing.ts +28 -8
  310. package/src/public/avm/opcodes/instruction.ts +31 -21
  311. package/src/public/avm/opcodes/memory.ts +71 -32
  312. package/src/public/avm/opcodes/misc.ts +60 -18
  313. package/src/public/avm/opcodes/storage.ts +22 -6
  314. package/src/public/avm/revert_reason.ts +55 -0
  315. package/src/public/avm/serialization/buffer_cursor.ts +4 -1
  316. package/src/public/avm/serialization/bytecode_serialization.ts +72 -74
  317. package/src/public/avm/serialization/instruction_serialization.ts +75 -34
  318. package/src/public/avm/test_utils.ts +24 -41
  319. package/src/public/db_interfaces.ts +61 -0
  320. package/src/{common → public}/debug_fn_name.ts +7 -7
  321. package/src/public/executor_metrics.ts +55 -6
  322. package/src/public/executor_metrics_interface.ts +14 -0
  323. package/src/public/fixtures/amm_test.ts +331 -0
  324. package/src/public/fixtures/bulk_test.ts +169 -0
  325. package/src/public/fixtures/custom_bytecode_tester.ts +49 -0
  326. package/src/public/fixtures/custom_bytecode_tests.ts +135 -0
  327. package/src/public/fixtures/index.ts +7 -0
  328. package/src/public/fixtures/minimal_public_tx.ts +36 -0
  329. package/src/public/fixtures/public_tx_simulation_tester.ts +158 -113
  330. package/src/public/{avm/fixtures → fixtures}/simple_contract_data_source.ts +36 -18
  331. package/src/public/fixtures/token_test.ts +140 -0
  332. package/src/public/fixtures/utils.ts +141 -68
  333. package/src/public/hinting_db_sources.ts +505 -0
  334. package/src/public/index.ts +9 -8
  335. package/src/public/public_db_sources.ts +196 -97
  336. package/src/public/public_errors.ts +14 -0
  337. package/src/public/public_processor/guarded_merkle_tree.ts +153 -0
  338. package/src/public/public_processor/public_processor.ts +191 -153
  339. package/src/public/public_processor/public_processor_metrics.ts +2 -2
  340. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +128 -0
  341. package/src/public/public_tx_simulator/index.ts +3 -0
  342. package/src/public/public_tx_simulator/measured_public_tx_simulator.ts +109 -0
  343. package/src/public/public_tx_simulator/public_tx_context.ts +160 -193
  344. package/src/public/public_tx_simulator/public_tx_simulator.ts +294 -220
  345. package/src/public/public_tx_simulator/public_tx_simulator_interface.ts +11 -0
  346. package/src/public/public_tx_simulator/telemetry_public_tx_simulator.ts +63 -0
  347. package/src/public/side_effect_errors.ts +91 -1
  348. package/src/public/side_effect_trace.ts +94 -320
  349. package/src/public/side_effect_trace_interface.ts +10 -58
  350. package/src/public/state_manager/index.ts +1 -0
  351. package/src/public/{avm/journal → state_manager}/nullifiers.ts +5 -11
  352. package/src/public/{avm/journal → state_manager}/public_storage.ts +2 -2
  353. package/src/public/state_manager/state_manager.ts +560 -0
  354. package/src/public/test_executor_metrics.ts +395 -0
  355. package/src/public/utils.ts +5 -21
  356. package/src/server.ts +6 -3
  357. package/src/testing.ts +1 -0
  358. package/dest/common/db_interfaces.d.ts +0 -80
  359. package/dest/common/db_interfaces.d.ts.map +0 -1
  360. package/dest/common/db_interfaces.js +0 -1
  361. package/dest/common/debug_fn_name.d.ts +0 -5
  362. package/dest/common/debug_fn_name.d.ts.map +0 -1
  363. package/dest/common/debug_fn_name.js +0 -6
  364. package/dest/common/message_load_oracle_inputs.d.ts +0 -15
  365. package/dest/common/message_load_oracle_inputs.d.ts.map +0 -1
  366. package/dest/common/message_load_oracle_inputs.js +0 -15
  367. package/dest/private/acvm/oracle/index.d.ts +0 -14
  368. package/dest/private/acvm/oracle/index.d.ts.map +0 -1
  369. package/dest/private/acvm/oracle/index.js +0 -2
  370. package/dest/private/acvm/oracle/oracle.d.ts +0 -49
  371. package/dest/private/acvm/oracle/oracle.d.ts.map +0 -1
  372. package/dest/private/acvm/oracle/oracle.js +0 -263
  373. package/dest/private/acvm/oracle/typed_oracle.d.ts +0 -83
  374. package/dest/private/acvm/oracle/typed_oracle.d.ts.map +0 -1
  375. package/dest/private/acvm/oracle/typed_oracle.js +0 -132
  376. package/dest/private/execution_data_provider.d.ts +0 -261
  377. package/dest/private/execution_data_provider.d.ts.map +0 -1
  378. package/dest/private/execution_data_provider.js +0 -14
  379. package/dest/private/execution_note_cache.d.ts +0 -93
  380. package/dest/private/execution_note_cache.d.ts.map +0 -1
  381. package/dest/private/execution_note_cache.js +0 -180
  382. package/dest/private/hashed_values_cache.d.ts +0 -28
  383. package/dest/private/hashed_values_cache.d.ts.map +0 -1
  384. package/dest/private/hashed_values_cache.js +0 -46
  385. package/dest/private/index.d.ts +0 -13
  386. package/dest/private/index.d.ts.map +0 -1
  387. package/dest/private/index.js +0 -12
  388. package/dest/private/pick_notes.d.ts +0 -85
  389. package/dest/private/pick_notes.d.ts.map +0 -1
  390. package/dest/private/pick_notes.js +0 -51
  391. package/dest/private/private_execution.d.ts +0 -25
  392. package/dest/private/private_execution.d.ts.map +0 -1
  393. package/dest/private/private_execution.js +0 -92
  394. package/dest/private/private_execution_oracle.d.ts +0 -215
  395. package/dest/private/private_execution_oracle.d.ts.map +0 -1
  396. package/dest/private/private_execution_oracle.js +0 -382
  397. package/dest/private/providers/acvm_native.d.ts.map +0 -1
  398. package/dest/private/providers/acvm_wasm.d.ts +0 -15
  399. package/dest/private/providers/acvm_wasm.d.ts.map +0 -1
  400. package/dest/private/providers/acvm_wasm_with_blobs.d.ts +0 -19
  401. package/dest/private/providers/acvm_wasm_with_blobs.d.ts.map +0 -1
  402. package/dest/private/providers/acvm_wasm_with_blobs.js +0 -32
  403. package/dest/private/providers/factory.d.ts +0 -12
  404. package/dest/private/providers/factory.d.ts.map +0 -1
  405. package/dest/private/providers/simulation_provider.d.ts +0 -19
  406. package/dest/private/providers/simulation_provider.d.ts.map +0 -1
  407. package/dest/private/providers/simulation_provider.js +0 -24
  408. package/dest/private/simulator.d.ts +0 -34
  409. package/dest/private/simulator.d.ts.map +0 -1
  410. package/dest/private/simulator.js +0 -76
  411. package/dest/private/unconstrained_execution.d.ts +0 -10
  412. package/dest/private/unconstrained_execution.d.ts.map +0 -1
  413. package/dest/private/unconstrained_execution.js +0 -27
  414. package/dest/private/unconstrained_execution_oracle.d.ts +0 -161
  415. package/dest/private/unconstrained_execution_oracle.d.ts.map +0 -1
  416. package/dest/private/unconstrained_execution_oracle.js +0 -258
  417. package/dest/public/avm/bytecode_utils.d.ts +0 -5
  418. package/dest/public/avm/bytecode_utils.d.ts.map +0 -1
  419. package/dest/public/avm/bytecode_utils.js +0 -17
  420. package/dest/public/avm/fixtures/index.d.ts +0 -84
  421. package/dest/public/avm/fixtures/index.d.ts.map +0 -1
  422. package/dest/public/avm/fixtures/index.js +0 -175
  423. package/dest/public/avm/fixtures/simple_contract_data_source.d.ts.map +0 -1
  424. package/dest/public/avm/journal/index.d.ts +0 -2
  425. package/dest/public/avm/journal/index.d.ts.map +0 -1
  426. package/dest/public/avm/journal/index.js +0 -1
  427. package/dest/public/avm/journal/journal.d.ts.map +0 -1
  428. package/dest/public/avm/journal/journal.js +0 -486
  429. package/dest/public/avm/journal/nullifiers.d.ts.map +0 -1
  430. package/dest/public/avm/journal/public_storage.d.ts.map +0 -1
  431. package/dest/public/bytecode_errors.d.ts +0 -4
  432. package/dest/public/bytecode_errors.d.ts.map +0 -1
  433. package/dest/public/bytecode_errors.js +0 -6
  434. package/dest/public/execution.d.ts +0 -108
  435. package/dest/public/execution.d.ts.map +0 -1
  436. package/dest/public/execution.js +0 -9
  437. package/dest/test/utils.d.ts +0 -13
  438. package/dest/test/utils.d.ts.map +0 -1
  439. package/dest/test/utils.js +0 -22
  440. package/src/common/db_interfaces.ts +0 -94
  441. package/src/common/message_load_oracle_inputs.ts +0 -15
  442. package/src/private/acvm/oracle/index.ts +0 -16
  443. package/src/private/acvm/oracle/oracle.ts +0 -455
  444. package/src/private/acvm/oracle/typed_oracle.ts +0 -259
  445. package/src/private/execution_data_provider.ts +0 -323
  446. package/src/private/execution_note_cache.ts +0 -217
  447. package/src/private/hashed_values_cache.ts +0 -55
  448. package/src/private/index.ts +0 -16
  449. package/src/private/pick_notes.ts +0 -141
  450. package/src/private/private_execution.ts +0 -151
  451. package/src/private/private_execution_oracle.ts +0 -614
  452. package/src/private/providers/acvm_wasm.ts +0 -63
  453. package/src/private/providers/acvm_wasm_with_blobs.ts +0 -50
  454. package/src/private/providers/simulation_provider.ts +0 -45
  455. package/src/private/simulator.ts +0 -147
  456. package/src/private/unconstrained_execution.ts +0 -50
  457. package/src/private/unconstrained_execution_oracle.ts +0 -373
  458. package/src/public/avm/bytecode_utils.ts +0 -17
  459. package/src/public/avm/fixtures/index.ts +0 -296
  460. package/src/public/avm/journal/index.ts +0 -1
  461. package/src/public/avm/journal/journal.ts +0 -742
  462. package/src/public/avm/opcodes/.eslintrc.cjs +0 -8
  463. package/src/public/bytecode_errors.ts +0 -6
  464. package/src/public/execution.ts +0 -140
  465. package/src/test/utils.ts +0 -36
  466. /package/dest/public/{avm/journal → state_manager}/public_storage.js +0 -0
@@ -0,0 +1,391 @@
1
+ import { CANONICAL_AUTH_REGISTRY_ADDRESS, CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS, CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS, FEE_JUICE_ADDRESS, MULTI_CALL_ENTRYPOINT_ADDRESS, ROUTER_ADDRESS } from '@aztec/constants';
2
+ import { poseidon2Hash } from '@aztec/foundation/crypto';
3
+ import { jsonStringify } from '@aztec/foundation/json-rpc';
4
+ import { createLogger } from '@aztec/foundation/log';
5
+ import { ProtocolContractAddress } from '@aztec/protocol-contracts';
6
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
7
+ import { SerializableContractInstance } from '@aztec/stdlib/contract';
8
+ import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '@aztec/stdlib/delayed-public-mutable';
9
+ import { computeNoteHashNonce, computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
10
+ import { strict as assert } from 'assert';
11
+ import { getPublicFunctionDebugName } from '../debug_fn_name.js';
12
+ import { L1ToL2MessageIndexOutOfRangeError, MaxCallsToUniqueContractClassIdsError, NoteHashIndexOutOfRangeError, NullifierCollisionError } from '../side_effect_errors.js';
13
+ import { NullifierManager } from './nullifiers.js';
14
+ import { PublicStorage } from './public_storage.js';
15
+ /**
16
+ * A class to manage persistable AVM state for contract calls.
17
+ * Maintains a cache of the current world state,
18
+ * a trace of all side effects.
19
+ *
20
+ * The simulator should make any world state / tree queries through this object.
21
+ *
22
+ * Manages merging of successful/reverted child state into current state.
23
+ */ export class PublicPersistableStateManager {
24
+ treesDB;
25
+ contractsDB;
26
+ trace;
27
+ firstNullifier;
28
+ timestamp;
29
+ doMerkleOperations;
30
+ publicStorage;
31
+ nullifiers;
32
+ log;
33
+ /** Make sure a forked state is never merged twice. */ alreadyMergedIntoParent;
34
+ constructor(treesDB, contractsDB, trace, firstNullifier, timestamp, doMerkleOperations = false, publicStorage = new PublicStorage(treesDB), nullifiers = new NullifierManager(treesDB)){
35
+ this.treesDB = treesDB;
36
+ this.contractsDB = contractsDB;
37
+ this.trace = trace;
38
+ this.firstNullifier = firstNullifier;
39
+ this.timestamp = timestamp;
40
+ this.doMerkleOperations = doMerkleOperations;
41
+ this.publicStorage = publicStorage;
42
+ this.nullifiers = nullifiers;
43
+ this.log = createLogger('simulator:state_manager');
44
+ this.alreadyMergedIntoParent = false;
45
+ }
46
+ /**
47
+ * Create a new state manager
48
+ */ static create(treesDB, contractsDB, trace, doMerkleOperations = false, firstNullifier, timestamp) {
49
+ return new PublicPersistableStateManager(treesDB, contractsDB, trace, firstNullifier, timestamp, doMerkleOperations);
50
+ }
51
+ /**
52
+ * Create a new state manager forked from this one
53
+ */ async fork() {
54
+ await this.treesDB.createCheckpoint();
55
+ return new PublicPersistableStateManager(this.treesDB, this.contractsDB, this.trace.fork(), this.firstNullifier, this.timestamp, this.doMerkleOperations, this.publicStorage.fork(), this.nullifiers.fork());
56
+ }
57
+ /**
58
+ * Accept forked world state modifications & traced side effects / hints
59
+ */ async merge(forkedState) {
60
+ await this._merge(forkedState, /*reverted=*/ false);
61
+ }
62
+ /**
63
+ * Reject forked world state modifications & traced side effects, keep traced hints
64
+ */ async reject(forkedState) {
65
+ await this._merge(forkedState, /*reverted=*/ true);
66
+ }
67
+ async _merge(forkedState, reverted) {
68
+ // sanity check to avoid merging the same forked trace twice
69
+ assert(!forkedState.alreadyMergedIntoParent, 'Cannot merge forked state that has already been merged into its parent!');
70
+ forkedState.alreadyMergedIntoParent = true;
71
+ this.publicStorage.acceptAndMerge(forkedState.publicStorage);
72
+ this.nullifiers.acceptAndMerge(forkedState.nullifiers);
73
+ this.trace.merge(forkedState.trace, reverted);
74
+ if (reverted) {
75
+ this.log.trace('Reverting forked state...');
76
+ await this.treesDB.revertCheckpoint();
77
+ } else {
78
+ this.log.trace('Merging forked state into parent...');
79
+ await this.treesDB.commitCheckpoint();
80
+ }
81
+ }
82
+ /**
83
+ * Write to public storage, journal/trace the write.
84
+ *
85
+ * @param contractAddress - the address of the contract whose storage is being written to
86
+ * @param slot - the slot in the contract's storage being written to
87
+ * @param value - the value being written to the slot
88
+ */ async writeStorage(contractAddress, slot, value, protocolWrite = false) {
89
+ this.log.trace(`Storage write (address=${contractAddress}, slot=${slot}): value=${value}`);
90
+ await this.trace.tracePublicStorageWrite(contractAddress, slot, value, protocolWrite);
91
+ if (this.doMerkleOperations) {
92
+ // write to native merkle trees
93
+ await this.treesDB.storageWrite(contractAddress, slot, value);
94
+ } else {
95
+ // Cache storage writes for later reference/reads
96
+ this.publicStorage.write(contractAddress, slot, value);
97
+ }
98
+ }
99
+ isStorageCold(contractAddress, slot) {
100
+ return this.trace.isStorageCold(contractAddress, slot);
101
+ }
102
+ /**
103
+ * Read from public storage.
104
+ *
105
+ * @param contractAddress - the address of the contract whose storage is being read from
106
+ * @param slot - the slot in the contract's storage being read from
107
+ * @returns the latest value written to slot, or 0 if never written to before
108
+ */ async readStorage(contractAddress, slot) {
109
+ if (this.doMerkleOperations) {
110
+ return await this.treesDB.storageRead(contractAddress, slot);
111
+ } else {
112
+ // TODO(fcarreiro): I don't get this. PublicStorage CAN end up reading the tree. Why is it in the "dont do merkle operations" branch?
113
+ const read = await this.publicStorage.read(contractAddress, slot);
114
+ this.log.trace(`Storage read results (address=${contractAddress}, slot=${slot}): value=${read.value}, cached=${read.cached}`);
115
+ return read.value;
116
+ }
117
+ }
118
+ // TODO(4886): We currently don't silo note hashes.
119
+ /**
120
+ * Check if a note hash exists at the given leaf index, trace the check.
121
+ *
122
+ * @param contractAddress - the address of the contract whose storage is being read from
123
+ * @param noteHash - the unsiloed note hash being checked
124
+ * @param leafIndex - the leaf index being checked
125
+ * @returns true if the note hash exists at the given leaf index, false otherwise
126
+ */ async checkNoteHashExists(contractAddress, noteHash, leafIndex) {
127
+ try {
128
+ const gotLeafValue = await this.treesDB.getNoteHash(leafIndex);
129
+ const exists = gotLeafValue.equals(noteHash);
130
+ this.log.trace(`noteHashes(${contractAddress})@${noteHash} ?? leafIndex: ${leafIndex} | gotLeafValue: ${gotLeafValue}, exists: ${exists}.`);
131
+ return Promise.resolve(exists);
132
+ } catch (error) {
133
+ // If the index is out of range, note_hash_leaf_in_range = 0 and the circuit returns false:
134
+ if (error instanceof NoteHashIndexOutOfRangeError) {
135
+ return Promise.resolve(false);
136
+ }
137
+ // Otherwise, unknown error. This is a bug.
138
+ throw error;
139
+ }
140
+ }
141
+ /**
142
+ * Write a raw note hash, silo it and make it unique, then trace the write.
143
+ * @param noteHash - the unsiloed note hash to write
144
+ */ async writeNoteHash(contractAddress, noteHash) {
145
+ this.log.trace(`noteHashes(${contractAddress}) += ${noteHash}.`);
146
+ const siloedNoteHash = await siloNoteHash(contractAddress, noteHash);
147
+ await this.writeSiloedNoteHash(siloedNoteHash);
148
+ }
149
+ /**
150
+ * Write a note hash, make it unique, trace the write.
151
+ * @param siloedNoteHash - the non unique note hash to write
152
+ */ async writeSiloedNoteHash(siloedNoteHash) {
153
+ const noteNonce = await computeNoteHashNonce(this.firstNullifier, this.trace.getNoteHashCount());
154
+ const uniqueNoteHash = await computeUniqueNoteHash(noteNonce, siloedNoteHash);
155
+ await this.writeUniqueNoteHash(uniqueNoteHash);
156
+ }
157
+ /**
158
+ * Write a note hash, trace the write.
159
+ * @param uniqueNoteHash - the siloed unique hash to write
160
+ */ async writeUniqueNoteHash(uniqueNoteHash) {
161
+ this.log.trace(`noteHashes += @${uniqueNoteHash}.`);
162
+ this.trace.traceNewNoteHash(uniqueNoteHash);
163
+ if (this.doMerkleOperations) {
164
+ await this.treesDB.writeNoteHash(uniqueNoteHash);
165
+ }
166
+ }
167
+ /**
168
+ * Check if a nullifier exists, trace the check.
169
+ * @param contractAddress - address of the contract that the nullifier is associated with
170
+ * @param nullifier - the unsiloed nullifier to check
171
+ * @returns exists - whether the nullifier exists in the nullifier set
172
+ */ async checkNullifierExists(contractAddress, nullifier) {
173
+ this.log.trace(`Checking existence of nullifier (address=${contractAddress}, nullifier=${nullifier})`);
174
+ const siloedNullifier = await siloNullifier(contractAddress, nullifier);
175
+ if (this.doMerkleOperations) {
176
+ const exists = await this.treesDB.checkNullifierExists(siloedNullifier);
177
+ this.log.trace(`Checked siloed nullifier ${siloedNullifier} (exists=${exists})`);
178
+ return Promise.resolve(exists);
179
+ } else {
180
+ const { exists, cacheHit } = await this.nullifiers.checkExists(siloedNullifier);
181
+ this.log.trace(`Checked siloed nullifier ${siloedNullifier} (exists=${exists}), cacheHit=${cacheHit}`);
182
+ return Promise.resolve(exists);
183
+ }
184
+ }
185
+ /**
186
+ * Write a nullifier to the nullifier set, trace the write.
187
+ * @param contractAddress - address of the contract that the nullifier is associated with
188
+ * @param nullifier - the unsiloed nullifier to write
189
+ */ async writeNullifier(contractAddress, nullifier) {
190
+ this.log.trace(`Inserting new nullifier (address=${nullifier}, nullifier=${contractAddress})`);
191
+ const siloedNullifier = await siloNullifier(contractAddress, nullifier);
192
+ await this.writeSiloedNullifier(siloedNullifier);
193
+ }
194
+ /**
195
+ * Write a nullifier to the nullifier set, trace the write.
196
+ * @param siloedNullifier - the siloed nullifier to write
197
+ */ async writeSiloedNullifier(siloedNullifier) {
198
+ this.log.trace(`Inserting siloed nullifier=${siloedNullifier}`);
199
+ this.trace.traceNewNullifier(siloedNullifier);
200
+ if (this.doMerkleOperations) {
201
+ const exists = await this.treesDB.checkNullifierExists(siloedNullifier);
202
+ if (exists) {
203
+ this.log.verbose(`Siloed nullifier ${siloedNullifier} already present in tree!`);
204
+ throw new NullifierCollisionError(`Siloed nullifier ${siloedNullifier} already exists in parent cache or host.`);
205
+ } else {
206
+ await this.treesDB.writeNullifier(siloedNullifier);
207
+ }
208
+ } else {
209
+ // Cache pending nullifiers for later access
210
+ await this.nullifiers.append(siloedNullifier);
211
+ }
212
+ }
213
+ /**
214
+ * Check if an L1 to L2 message exists, trace the check.
215
+ * @param msgHash - the message hash to check existence of
216
+ * @param msgLeafIndex - the message leaf index to use in the check
217
+ * @returns exists - whether the message exists in the L1 to L2 Messages tree
218
+ */ async checkL1ToL2MessageExists(msgHash, msgLeafIndex) {
219
+ try {
220
+ const valueAtIndex = await this.treesDB.getL1ToL2LeafValue(msgLeafIndex.toBigInt());
221
+ const exists = valueAtIndex.equals(msgHash);
222
+ this.log.trace(`l1ToL2Messages(@${msgLeafIndex}) ?? exists: ${exists}, expected: ${msgHash}, found: ${valueAtIndex}.`);
223
+ return Promise.resolve(exists);
224
+ } catch (error) {
225
+ // If the index is out of range, l1_to_l2_msg_leaf_in_range = 0 and the circuit returns false:
226
+ if (error instanceof L1ToL2MessageIndexOutOfRangeError) {
227
+ return Promise.resolve(false);
228
+ }
229
+ // Otherwise, unknown error. This is a bug.
230
+ throw error;
231
+ }
232
+ }
233
+ /**
234
+ * Write an L2 to L1 message.
235
+ * @param contractAddress - L2 contract address that created this message
236
+ * @param recipient - L1 contract address to send the message to.
237
+ * @param content - Message content.
238
+ */ writeL2ToL1Message(contractAddress, recipient, content) {
239
+ this.log.trace(`L2ToL1Messages(${contractAddress}) += (recipient: ${recipient}, content: ${content}).`);
240
+ this.trace.traceNewL2ToL1Message(contractAddress, recipient, content);
241
+ }
242
+ /**
243
+ * Write a scoped L2 to L1 message.
244
+ * @param l2ToL1Message - The L2 to L1 message to write.
245
+ */ writeScopedL2ToL1Message(l2ToL1Message) {
246
+ this.writeL2ToL1Message(l2ToL1Message.contractAddress, l2ToL1Message.message.recipient.toField(), l2ToL1Message.message.content);
247
+ }
248
+ writeDebugLog(contractAddress, level, message, fields) {
249
+ this.trace.traceDebugLog(contractAddress, level, message, fields);
250
+ }
251
+ writeDebugLogMemoryReads(memoryReads) {
252
+ this.trace.traceDebugLogMemoryReads(memoryReads);
253
+ }
254
+ getDebugLogMemoryReads() {
255
+ return this.trace.getDebugLogMemoryReads();
256
+ }
257
+ getLogs() {
258
+ return this.trace.getDebugLogs();
259
+ }
260
+ /**
261
+ * Write a public log
262
+ * @param contractAddress - address of the contract that emitted the log
263
+ * @param log - log contents
264
+ */ writePublicLog(contractAddress, log) {
265
+ this.log.trace(`PublicLog(${contractAddress}) += event with ${log.length} fields.`);
266
+ this.trace.tracePublicLog(contractAddress, log);
267
+ }
268
+ /**
269
+ * Get a contract instance.
270
+ * @param contractAddress - address of the contract instance to retrieve.
271
+ * @returns the contract instance or undefined if it does not exist.
272
+ */ async getContractInstance(contractAddress) {
273
+ this.log.trace(`Getting contract instance for address ${contractAddress}`);
274
+ const instanceWithAddress = await this.contractsDB.getContractInstance(contractAddress, this.timestamp);
275
+ const exists = instanceWithAddress !== undefined;
276
+ const instance = exists ? new SerializableContractInstance(instanceWithAddress) : undefined;
277
+ if (contractAddressIsCanonical(contractAddress)) {
278
+ this.log.trace(`Got canonical contract instance (address=${contractAddress}): instance=${jsonStringify(instance)}`);
279
+ return instance;
280
+ }
281
+ // Nullifier check! We do this regardless of whether or not the instance exists,
282
+ // as even for non-existence, we need to generate nullifier check hints.
283
+ // This will internally decide whether to check the nullifier tree or not depending on doMerkleOperations.
284
+ const nullifierExistsInTree = await this.checkNullifierExists(AztecAddress.fromNumber(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS), contractAddress.toField());
285
+ assert(exists == nullifierExistsInTree, `Contract instance for address ${contractAddress} in DB: ${exists} != nullifier tree: ${nullifierExistsInTree}. This is a bug!`);
286
+ if (!exists) {
287
+ this.log.debug(`Contract instance NOT FOUND (address=${contractAddress})`);
288
+ return undefined;
289
+ }
290
+ this.log.trace(`Got contract instance (address=${contractAddress}): instance=${jsonStringify(instance)}`);
291
+ // All that is left is to check that the contract updatability information is correct.
292
+ // That is, that the current and original contract class ids are correct.
293
+ await this.checkContractUpdateInformation(instanceWithAddress);
294
+ return instance;
295
+ }
296
+ async checkContractUpdateInformation(instance) {
297
+ // If "merkle operations" are not requested, we trust the DB.
298
+ // Otherwise we check that the contract updatability information is correct.
299
+ // That is, that the current and original contract class ids are correct.
300
+ // All failures are fatal and the simulation is not expected to be provable.
301
+ if (this.doMerkleOperations) {
302
+ // Conceptually, we want to do the following:
303
+ // * Read a DelayedPublicMutable at the contract update slot.
304
+ // * Obtain the expected current class id from the DelayedPublicMutable, at the current block.
305
+ // * if expectedId == 0 then currentClassId should be original contract class id
306
+ // * if expectedId != 0 then currentClassId should be expectedId
307
+ //
308
+ // However, we will also be checking the hash of the delayed public mutable values.
309
+ // This is a bit of a leak of information, since the circuit will use it to prove
310
+ // one public read instead of N of the delayed public mutable values.
311
+ const { delayedPublicMutableSlot, delayedPublicMutableHashSlot } = await DelayedPublicMutableValuesWithHash.getContractUpdateSlots(instance.address);
312
+ const readDeployerStorage = async (storageSlot)=>await this.readStorage(ProtocolContractAddress.ContractInstanceRegistry, storageSlot);
313
+ const hash = await readDeployerStorage(delayedPublicMutableHashSlot);
314
+ const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(delayedPublicMutableSlot, readDeployerStorage);
315
+ const preImage = delayedPublicMutableValues.toFields();
316
+ // 1) update never scheduled: hash == 0 and preimage should be empty (but poseidon2hash(preimage) will not be 0s)
317
+ if (hash.isZero()) {
318
+ assert(preImage.every((f)=>f.isZero()), `Found updatability hash 0 but preimage is not empty for contract instance ${instance.address}.`);
319
+ assert(instance.currentContractClassId.equals(instance.originalContractClassId), `Found updatability hash 0 for contract instance ${instance.address} but original class id ${instance.originalContractClassId} != current class id ${instance.currentContractClassId}.`);
320
+ return;
321
+ }
322
+ // 2) At this point we know that the hash is not zero and this means that an update has at some point been scheduled.
323
+ const computedHash = await poseidon2Hash(preImage);
324
+ assert(hash.equals(computedHash), `Delayed public mutable values hash mismatch for contract instance ${instance.address}. Expected: ${hash}, computed: ${computedHash}`);
325
+ // We now check that, depending on the current block, the current class id is correct.
326
+ const expectedClassIdRaw = delayedPublicMutableValues.svc.getCurrentAt(this.timestamp).at(0);
327
+ const expectedClassId = expectedClassIdRaw.isZero() ? instance.originalContractClassId : expectedClassIdRaw;
328
+ assert(instance.currentContractClassId.equals(expectedClassId), `Current class id mismatch
329
+ for contract instance ${instance.address}. Expected: ${expectedClassId}, current: ${instance.currentContractClassId}`);
330
+ }
331
+ }
332
+ /**
333
+ * Get a contract class.
334
+ * @param classId - class id to retrieve.
335
+ * @returns the contract class or undefined if it does not exist.
336
+ */ async getContractClass(classId) {
337
+ this.log.trace(`Getting contract class for id ${classId}`);
338
+ const contractClass = await this.contractsDB.getContractClass(classId);
339
+ const exists = contractClass !== undefined;
340
+ let extendedClass = undefined;
341
+ // Note: We currently do not generate info to check the nullifier tree, because
342
+ // this is not needed for our use cases.
343
+ if (exists) {
344
+ this.log.trace(`Got contract class (id=${classId})`);
345
+ // Extend class information with public bytecode commitment.
346
+ const bytecodeCommitment = await this.contractsDB.getBytecodeCommitment(classId);
347
+ assert(bytecodeCommitment, `Bytecode commitment was not found in DB for contract class (${classId}). This should not happen!`);
348
+ extendedClass = {
349
+ ...contractClass,
350
+ publicBytecodeCommitment: bytecodeCommitment
351
+ };
352
+ } else {
353
+ this.log.debug(`Contract class NOT FOUND (id=${classId})`);
354
+ }
355
+ // TODO(dbanks12): does this need to be moved to before the DB accesses as was done with writeNullifier?
356
+ this.trace.traceGetContractClass(classId, exists);
357
+ return extendedClass;
358
+ }
359
+ /**
360
+ * Get a contract's bytecode from the contracts DB, also trace the contract class and instance indirectly.
361
+ */ async getBytecode(contractAddress) {
362
+ this.log.debug(`Getting bytecode for contract address ${contractAddress}`);
363
+ const contractInstance = await this.getContractInstance(contractAddress);
364
+ if (!contractInstance) {
365
+ return undefined;
366
+ }
367
+ try {
368
+ const contractClass = await this.getContractClass(contractInstance.currentContractClassId);
369
+ assert(contractClass, `Contract class not found in DB, but a contract instance was found with this class ID (${contractInstance.currentContractClassId}). This should not happen!`);
370
+ return contractClass.packedBytecode;
371
+ } catch (error) {
372
+ if (error instanceof MaxCallsToUniqueContractClassIdsError) {
373
+ return undefined;
374
+ }
375
+ // Otherwise, unknown error. This is a bug.
376
+ throw error;
377
+ }
378
+ }
379
+ async getPublicFunctionDebugName(avmEnvironment) {
380
+ return await getPublicFunctionDebugName(this.contractsDB, avmEnvironment.address, avmEnvironment.calldata);
381
+ }
382
+ async padTree(treeId, leavesToInsert) {
383
+ await this.treesDB.padTree(treeId, leavesToInsert);
384
+ }
385
+ async getTreeSnapshots() {
386
+ return await this.treesDB.getTreeSnapshots();
387
+ }
388
+ }
389
+ function contractAddressIsCanonical(contractAddress) {
390
+ return contractAddress.equals(AztecAddress.fromNumber(CANONICAL_AUTH_REGISTRY_ADDRESS)) || contractAddress.equals(AztecAddress.fromNumber(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS)) || contractAddress.equals(AztecAddress.fromNumber(CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS)) || contractAddress.equals(AztecAddress.fromNumber(MULTI_CALL_ENTRYPOINT_ADDRESS)) || contractAddress.equals(AztecAddress.fromNumber(FEE_JUICE_ADDRESS)) || contractAddress.equals(AztecAddress.fromNumber(ROUTER_ADDRESS));
391
+ }
@@ -0,0 +1,54 @@
1
+ import type { RevertCode } from '@aztec/stdlib/avm';
2
+ import type { ExecutorMetricsInterface } from './executor_metrics_interface.js';
3
+ export interface PublicEnqueuedCallMetrics {
4
+ fnName: string;
5
+ durationMs: number;
6
+ manaUsed: number;
7
+ totalInstructionsExecuted: number;
8
+ reverted: boolean;
9
+ }
10
+ export interface PublicTxMetrics {
11
+ totalDurationMs: number;
12
+ manaUsed: number;
13
+ totalInstructionsExecuted: number;
14
+ nonRevertiblePrivateInsertionsUs: number | undefined;
15
+ revertiblePrivateInsertionsUs: number | undefined;
16
+ enqueuedCalls: PublicEnqueuedCallMetrics[];
17
+ revertedCode: RevertCode | undefined;
18
+ proverSimulationStepMs: number | undefined;
19
+ proverProvingStepMs: number | undefined;
20
+ proverTraceGenerationStepMs: number | undefined;
21
+ traceGenerationInteractionsMs: number | undefined;
22
+ traceGenerationTracesMs: number | undefined;
23
+ provingSumcheckMs: number | undefined;
24
+ provingPcsMs: number | undefined;
25
+ provingLogDerivativeInverseMs: number | undefined;
26
+ provingLogDerivativeInverseCommitmentsMs: number | undefined;
27
+ provingWireCommitmentsMs: number | undefined;
28
+ }
29
+ export declare enum PublicTxMetricsFilter {
30
+ ALL = 0,
31
+ TOTALS = 1,
32
+ DURATIONS = 2,
33
+ INSTRUCTIONS = 3,
34
+ PROVING = 4
35
+ }
36
+ export declare class TestExecutorMetrics implements ExecutorMetricsInterface {
37
+ #private;
38
+ private logger;
39
+ private txMetrics;
40
+ private currentTxLabel;
41
+ private txTimer;
42
+ constructor();
43
+ startRecordingTxSimulation(txLabel: string): void;
44
+ stopRecordingTxSimulation(txLabel: string, revertedCode?: RevertCode): void;
45
+ recordEnqueuedCallSimulation(fnName: string, durationMs: number, manaUsed: number, totalInstructionsExecuted: number): void;
46
+ recordEnqueuedCallSimulationFailure(fnName: string, durationMs: number, manaUsed: number, totalInstructionsExecuted: number): void;
47
+ recordPrivateEffectsInsertion(durationUs: number, type: 'revertible' | 'non-revertible'): void;
48
+ recordProverMetrics(txLabel: string, metrics: Partial<PublicTxMetrics>): void;
49
+ prettyPrint(filter?: PublicTxMetricsFilter): void;
50
+ toPrettyString(filter?: PublicTxMetricsFilter): string;
51
+ toJSON(indent?: number): string;
52
+ toGithubActionBenchmarkJSON(indent?: number): string;
53
+ }
54
+ //# sourceMappingURL=test_executor_metrics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"test_executor_metrics.d.ts","sourceRoot":"","sources":["../../src/public/test_executor_metrics.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAIpD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAEhF,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB,EAAE,MAAM,CAAC;IAClC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAE9B,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB,EAAE,MAAM,CAAC;IAClC,gCAAgC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrD,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD,aAAa,EAAE,yBAAyB,EAAE,CAAC;IAC3C,YAAY,EAAE,UAAU,GAAG,SAAS,CAAC;IAErC,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,2BAA2B,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhD,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,6BAA6B,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD,wCAAwC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7D,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAWD,oBAAY,qBAAqB;IAC/B,GAAG,IAAA;IACH,MAAM,IAAA;IACN,SAAS,IAAA;IACT,YAAY,IAAA;IACZ,OAAO,IAAA;CACR;AA2BD,qBAAa,mBAAoB,YAAW,wBAAwB;;IAClE,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,SAAS,CAA2C;IAC5D,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,OAAO,CAAoB;;IAMnC,0BAA0B,CAAC,OAAO,EAAE,MAAM;IAQ1C,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,UAAU;IAkBpE,4BAA4B,CAC1B,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,yBAAyB,EAAE,MAAM;IAKnC,mCAAmC,CACjC,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,yBAAyB,EAAE,MAAM;IAuBnC,6BAA6B,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,gBAAgB;IAkBvF,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC;IAYtE,WAAW,CAAC,MAAM,GAAE,qBAAiD;IAIrE,cAAc,CAAC,MAAM,GAAE,qBAAiD;IAwGxE,MAAM,CAAC,MAAM,SAAI;IAIjB,2BAA2B,CAAC,MAAM,SAAI;CA6FvC"}