@aztec/simulator 0.0.0-test.1 → 0.0.1-fake-ceab37513c

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