@aztec/simulator 0.0.1-commit.2f68f620 → 0.0.1-commit.3100065

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 (317) hide show
  1. package/dest/client.d.ts +1 -3
  2. package/dest/client.d.ts.map +1 -1
  3. package/dest/client.js +0 -2
  4. package/dest/private/circuit_recording/circuit_recorder.d.ts +36 -23
  5. package/dest/private/circuit_recording/circuit_recorder.d.ts.map +1 -1
  6. package/dest/private/circuit_recording/circuit_recorder.js +65 -69
  7. package/dest/private/circuit_recording/file_circuit_recorder.d.ts +7 -19
  8. package/dest/private/circuit_recording/file_circuit_recorder.d.ts.map +1 -1
  9. package/dest/private/circuit_recording/file_circuit_recorder.js +38 -42
  10. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts +1 -1
  11. package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts.map +1 -1
  12. package/dest/private/circuit_recording/simulator_recorder_wrapper.js +11 -14
  13. package/dest/public/avm/avm_context.d.ts +41 -0
  14. package/dest/public/avm/avm_context.d.ts.map +1 -0
  15. package/dest/public/avm/avm_context.js +44 -0
  16. package/dest/public/avm/avm_contract_call_result.d.ts +32 -0
  17. package/dest/public/avm/avm_contract_call_result.d.ts.map +1 -0
  18. package/dest/public/avm/avm_contract_call_result.js +54 -0
  19. package/dest/public/avm/avm_execution_environment.d.ts +24 -0
  20. package/dest/public/avm/avm_execution_environment.d.ts.map +1 -0
  21. package/dest/public/avm/avm_execution_environment.js +33 -0
  22. package/dest/public/avm/avm_gas.d.ts +44 -0
  23. package/dest/public/avm/avm_gas.d.ts.map +1 -0
  24. package/dest/public/avm/avm_gas.js +195 -0
  25. package/dest/public/avm/avm_machine_state.d.ts +98 -0
  26. package/dest/public/avm/avm_machine_state.d.ts.map +1 -0
  27. package/dest/public/avm/avm_machine_state.js +110 -0
  28. package/dest/public/avm/avm_memory_types.d.ts +275 -0
  29. package/dest/public/avm/avm_memory_types.d.ts.map +1 -0
  30. package/dest/public/avm/avm_memory_types.js +354 -0
  31. package/dest/public/avm/avm_simulator.d.ts +41 -0
  32. package/dest/public/avm/avm_simulator.d.ts.map +1 -0
  33. package/dest/public/avm/avm_simulator.js +192 -0
  34. package/dest/public/avm/avm_simulator_interface.d.ts +9 -0
  35. package/dest/public/avm/avm_simulator_interface.d.ts.map +1 -0
  36. package/dest/public/avm/avm_simulator_interface.js +3 -0
  37. package/dest/public/avm/calldata.d.ts +51 -0
  38. package/dest/public/avm/calldata.d.ts.map +1 -0
  39. package/dest/public/avm/calldata.js +64 -0
  40. package/dest/public/avm/errors.d.ts +104 -0
  41. package/dest/public/avm/errors.d.ts.map +1 -0
  42. package/dest/public/avm/errors.js +141 -0
  43. package/dest/public/avm/fixtures/account_proof_fetcher.d.ts +2 -0
  44. package/dest/public/avm/fixtures/account_proof_fetcher.d.ts.map +1 -0
  45. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +22 -0
  46. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +1 -0
  47. package/dest/public/avm/fixtures/avm_simulation_tester.js +84 -0
  48. package/dest/public/avm/{testing → fixtures}/base_avm_simulation_tester.d.ts +1 -1
  49. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +1 -0
  50. package/dest/public/avm/{testing → fixtures}/base_avm_simulation_tester.js +1 -1
  51. package/dest/public/avm/fixtures/initializers.d.ts +42 -0
  52. package/dest/public/avm/fixtures/initializers.d.ts.map +1 -0
  53. package/dest/public/avm/fixtures/initializers.js +45 -0
  54. package/dest/public/avm/fixtures/utils.d.ts +39 -0
  55. package/dest/public/avm/fixtures/utils.d.ts.map +1 -0
  56. package/dest/public/avm/{testing → fixtures}/utils.js +34 -1
  57. package/dest/public/avm/index.d.ts +2 -0
  58. package/dest/public/avm/index.d.ts.map +1 -0
  59. package/dest/public/avm/index.js +1 -0
  60. package/dest/public/avm/opcodes/accrued_substate.d.ts +74 -0
  61. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +1 -0
  62. package/dest/public/avm/opcodes/accrued_substate.js +254 -0
  63. package/dest/public/avm/opcodes/addressing_mode.d.ts +31 -0
  64. package/dest/public/avm/opcodes/addressing_mode.d.ts.map +1 -0
  65. package/dest/public/avm/opcodes/addressing_mode.js +94 -0
  66. package/dest/public/avm/opcodes/arithmetic.d.ts +49 -0
  67. package/dest/public/avm/opcodes/arithmetic.d.ts.map +1 -0
  68. package/dest/public/avm/opcodes/arithmetic.js +97 -0
  69. package/dest/public/avm/opcodes/bitwise.d.ts +42 -0
  70. package/dest/public/avm/opcodes/bitwise.d.ts.map +1 -0
  71. package/dest/public/avm/opcodes/bitwise.js +99 -0
  72. package/dest/public/avm/opcodes/comparators.d.ts +25 -0
  73. package/dest/public/avm/opcodes/comparators.d.ts.map +1 -0
  74. package/dest/public/avm/opcodes/comparators.js +43 -0
  75. package/dest/public/avm/opcodes/contract.d.ts +21 -0
  76. package/dest/public/avm/opcodes/contract.d.ts.map +1 -0
  77. package/dest/public/avm/opcodes/contract.js +69 -0
  78. package/dest/public/avm/opcodes/control_flow.d.ts +41 -0
  79. package/dest/public/avm/opcodes/control_flow.d.ts.map +1 -0
  80. package/dest/public/avm/opcodes/control_flow.js +107 -0
  81. package/dest/public/avm/opcodes/conversion.d.ts +18 -0
  82. package/dest/public/avm/opcodes/conversion.d.ts.map +1 -0
  83. package/dest/public/avm/opcodes/conversion.js +333 -0
  84. package/dest/public/avm/opcodes/ec_add.d.ts +17 -0
  85. package/dest/public/avm/opcodes/ec_add.d.ts.map +1 -0
  86. package/dest/public/avm/opcodes/ec_add.js +79 -0
  87. package/dest/public/avm/opcodes/environment_getters.d.ts +28 -0
  88. package/dest/public/avm/opcodes/environment_getters.d.ts.map +1 -0
  89. package/dest/public/avm/opcodes/environment_getters.js +77 -0
  90. package/dest/public/avm/opcodes/external_calls.d.ts +59 -0
  91. package/dest/public/avm/opcodes/external_calls.d.ts.map +1 -0
  92. package/dest/public/avm/opcodes/external_calls.js +210 -0
  93. package/dest/public/avm/opcodes/hashing.d.ts +36 -0
  94. package/dest/public/avm/opcodes/hashing.d.ts.map +1 -0
  95. package/dest/public/avm/opcodes/hashing.js +119 -0
  96. package/dest/public/avm/opcodes/index.d.ts +16 -0
  97. package/dest/public/avm/opcodes/index.d.ts.map +1 -0
  98. package/dest/public/avm/opcodes/index.js +15 -0
  99. package/dest/public/avm/opcodes/instruction.d.ts +74 -0
  100. package/dest/public/avm/opcodes/instruction.d.ts.map +1 -0
  101. package/dest/public/avm/opcodes/instruction.js +95 -0
  102. package/dest/public/avm/opcodes/instruction_impl.d.ts +19 -0
  103. package/dest/public/avm/opcodes/instruction_impl.d.ts.map +1 -0
  104. package/dest/public/avm/opcodes/instruction_impl.js +30 -0
  105. package/dest/public/avm/opcodes/memory.d.ts +74 -0
  106. package/dest/public/avm/opcodes/memory.d.ts.map +1 -0
  107. package/dest/public/avm/opcodes/memory.js +257 -0
  108. package/dest/public/avm/opcodes/misc.d.ts +18 -0
  109. package/dest/public/avm/opcodes/misc.d.ts.map +1 -0
  110. package/dest/public/avm/opcodes/misc.js +73 -0
  111. package/dest/public/avm/opcodes/storage.d.ts +25 -0
  112. package/dest/public/avm/opcodes/storage.d.ts.map +1 -0
  113. package/dest/public/avm/opcodes/storage.js +78 -0
  114. package/dest/public/avm/revert_reason.d.ts +18 -0
  115. package/dest/public/avm/revert_reason.d.ts.map +1 -0
  116. package/dest/public/avm/revert_reason.js +39 -0
  117. package/dest/public/avm/serialization/buffer_cursor.d.ts +26 -0
  118. package/dest/public/avm/serialization/buffer_cursor.d.ts.map +1 -0
  119. package/dest/public/avm/serialization/buffer_cursor.js +99 -0
  120. package/dest/public/avm/serialization/bytecode_serialization.d.ts +17 -0
  121. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +1 -0
  122. package/dest/public/avm/serialization/bytecode_serialization.js +336 -0
  123. package/dest/public/avm/serialization/instruction_serialization.d.ts +114 -0
  124. package/dest/public/avm/serialization/instruction_serialization.d.ts.map +1 -0
  125. package/dest/public/avm/serialization/instruction_serialization.js +261 -0
  126. package/dest/public/avm/test_utils.d.ts +15 -0
  127. package/dest/public/avm/test_utils.d.ts.map +1 -0
  128. package/dest/public/avm/test_utils.js +44 -0
  129. package/dest/public/debug_fn_name.d.ts +18 -0
  130. package/dest/public/debug_fn_name.d.ts.map +1 -0
  131. package/dest/public/debug_fn_name.js +37 -0
  132. package/dest/public/fixtures/amm_test.js +2 -2
  133. package/dest/public/fixtures/bulk_test.js +2 -2
  134. package/dest/public/fixtures/custom_bytecode_tester.d.ts +1 -1
  135. package/dest/public/fixtures/custom_bytecode_tester.d.ts.map +1 -1
  136. package/dest/public/fixtures/custom_bytecode_tester.js +2 -2
  137. package/dest/public/fixtures/custom_bytecode_tests.d.ts +19 -0
  138. package/dest/public/fixtures/custom_bytecode_tests.d.ts.map +1 -0
  139. package/dest/public/fixtures/custom_bytecode_tests.js +263 -0
  140. package/dest/public/fixtures/index.d.ts +4 -1
  141. package/dest/public/fixtures/index.d.ts.map +1 -1
  142. package/dest/public/fixtures/index.js +3 -0
  143. package/dest/public/fixtures/minimal_public_tx.d.ts +4 -0
  144. package/dest/public/fixtures/minimal_public_tx.d.ts.map +1 -0
  145. package/dest/public/fixtures/minimal_public_tx.js +19 -0
  146. package/dest/public/fixtures/opcode_spammer.d.ts +122 -0
  147. package/dest/public/fixtures/opcode_spammer.d.ts.map +1 -0
  148. package/dest/public/fixtures/opcode_spammer.js +1645 -0
  149. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +3 -3
  150. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -1
  151. package/dest/public/fixtures/public_tx_simulation_tester.js +38 -8
  152. package/dest/public/fixtures/simple_contract_data_source.js +1 -1
  153. package/dest/public/fixtures/token_test.js +3 -3
  154. package/dest/public/fixtures/utils.d.ts +1 -1
  155. package/dest/public/fixtures/utils.d.ts.map +1 -1
  156. package/dest/public/fixtures/utils.js +5 -3
  157. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts +4 -6
  158. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts.map +1 -1
  159. package/dest/public/fuzzing/avm_fuzzer_simulator.js +7 -12
  160. package/dest/public/fuzzing/avm_simulator_bin.js +4 -4
  161. package/dest/public/hinting_db_sources.d.ts +80 -0
  162. package/dest/public/hinting_db_sources.d.ts.map +1 -0
  163. package/dest/public/hinting_db_sources.js +356 -0
  164. package/dest/public/index.d.ts +2 -2
  165. package/dest/public/index.d.ts.map +1 -1
  166. package/dest/public/index.js +1 -1
  167. package/dest/public/public_processor/guarded_merkle_tree.d.ts +3 -4
  168. package/dest/public/public_processor/guarded_merkle_tree.d.ts.map +1 -1
  169. package/dest/public/public_processor/guarded_merkle_tree.js +0 -3
  170. package/dest/public/public_processor/public_processor.d.ts +1 -1
  171. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  172. package/dest/public/public_processor/public_processor.js +22 -3
  173. package/dest/public/public_tx_simulator/contract_provider_for_cpp.js +2 -2
  174. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +53 -0
  175. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +1 -0
  176. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +131 -0
  177. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts +42 -0
  178. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts.map +1 -0
  179. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.js +86 -0
  180. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts +30 -0
  181. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts.map +1 -0
  182. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.js +171 -0
  183. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts +23 -0
  184. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts.map +1 -0
  185. package/dest/public/public_tx_simulator/{dumping_public_tx_simulator.js → dumping_cpp_public_tx_simulator.js} +2 -2
  186. package/dest/public/public_tx_simulator/factories.d.ts +6 -6
  187. package/dest/public/public_tx_simulator/factories.d.ts.map +1 -1
  188. package/dest/public/public_tx_simulator/factories.js +6 -6
  189. package/dest/public/public_tx_simulator/index.d.ts +5 -3
  190. package/dest/public/public_tx_simulator/index.d.ts.map +1 -1
  191. package/dest/public/public_tx_simulator/index.js +4 -2
  192. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts +31 -0
  193. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts.map +1 -0
  194. package/dest/public/public_tx_simulator/measured_public_tx_simulator.js +51 -0
  195. package/dest/public/public_tx_simulator/public_tx_context.d.ts +135 -0
  196. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +1 -0
  197. package/dest/public/public_tx_simulator/public_tx_context.js +298 -0
  198. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +74 -41
  199. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  200. package/dest/public/public_tx_simulator/public_tx_simulator.js +324 -98
  201. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts +21 -0
  202. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts.map +1 -0
  203. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.js +415 -0
  204. package/dest/public/side_effect_trace.d.ts +87 -0
  205. package/dest/public/side_effect_trace.d.ts.map +1 -0
  206. package/dest/public/side_effect_trace.js +199 -0
  207. package/dest/public/side_effect_trace_interface.d.ts +22 -0
  208. package/dest/public/side_effect_trace_interface.d.ts.map +1 -0
  209. package/dest/public/side_effect_trace_interface.js +1 -0
  210. package/dest/public/state_manager/index.d.ts +2 -0
  211. package/dest/public/state_manager/index.d.ts.map +1 -0
  212. package/dest/public/state_manager/index.js +1 -0
  213. package/dest/public/state_manager/nullifiers.d.ts +61 -0
  214. package/dest/public/state_manager/nullifiers.d.ts.map +1 -0
  215. package/dest/public/state_manager/nullifiers.js +92 -0
  216. package/dest/public/state_manager/public_storage.d.ts +66 -0
  217. package/dest/public/state_manager/public_storage.d.ts.map +1 -0
  218. package/dest/public/state_manager/public_storage.js +145 -0
  219. package/dest/public/state_manager/state_manager.d.ts +170 -0
  220. package/dest/public/state_manager/state_manager.d.ts.map +1 -0
  221. package/dest/public/state_manager/state_manager.js +402 -0
  222. package/dest/public/test_executor_metrics.d.ts +6 -1
  223. package/dest/public/test_executor_metrics.d.ts.map +1 -1
  224. package/dest/public/test_executor_metrics.js +22 -0
  225. package/package.json +18 -17
  226. package/src/client.ts +0 -2
  227. package/src/private/circuit_recording/circuit_recorder.ts +84 -78
  228. package/src/private/circuit_recording/file_circuit_recorder.ts +38 -48
  229. package/src/private/circuit_recording/simulator_recorder_wrapper.ts +9 -15
  230. package/src/public/avm/avm_context.ts +61 -0
  231. package/src/public/avm/avm_contract_call_result.ts +69 -0
  232. package/src/public/avm/avm_execution_environment.ts +51 -0
  233. package/src/public/avm/avm_gas.ts +183 -0
  234. package/src/public/avm/avm_machine_state.ts +170 -0
  235. package/src/public/avm/avm_memory_types.ts +440 -0
  236. package/src/public/avm/avm_simulator.ts +279 -0
  237. package/src/public/avm/avm_simulator_interface.ts +8 -0
  238. package/src/public/avm/calldata.ts +101 -0
  239. package/src/public/avm/errors.ts +177 -0
  240. package/src/public/avm/fixtures/avm_simulation_tester.ts +122 -0
  241. package/src/public/avm/{testing → fixtures}/base_avm_simulation_tester.ts +1 -1
  242. package/src/public/avm/fixtures/initializers.ts +103 -0
  243. package/src/public/avm/{testing → fixtures}/utils.ts +40 -1
  244. package/src/public/avm/index.ts +1 -0
  245. package/src/public/avm/opcodes/accrued_substate.ts +285 -0
  246. package/src/public/avm/opcodes/addressing_mode.ts +111 -0
  247. package/src/public/avm/opcodes/arithmetic.ts +129 -0
  248. package/src/public/avm/opcodes/bitwise.ts +113 -0
  249. package/src/public/avm/opcodes/comparators.ts +55 -0
  250. package/src/public/avm/opcodes/contract.ts +76 -0
  251. package/src/public/avm/opcodes/control_flow.ts +123 -0
  252. package/src/public/avm/opcodes/conversion.ts +104 -0
  253. package/src/public/avm/opcodes/ec_add.ts +86 -0
  254. package/src/public/avm/opcodes/environment_getters.ts +87 -0
  255. package/src/public/avm/opcodes/external_calls.ts +262 -0
  256. package/src/public/avm/opcodes/hashing.ts +151 -0
  257. package/src/public/avm/opcodes/index.ts +15 -0
  258. package/src/public/avm/opcodes/instruction.ts +136 -0
  259. package/src/public/avm/opcodes/instruction_impl.ts +36 -0
  260. package/src/public/avm/opcodes/memory.ts +293 -0
  261. package/src/public/avm/opcodes/misc.ts +102 -0
  262. package/src/public/avm/opcodes/storage.ts +95 -0
  263. package/src/public/avm/revert_reason.ts +58 -0
  264. package/src/public/avm/serialization/buffer_cursor.ts +118 -0
  265. package/src/public/avm/serialization/bytecode_serialization.ts +215 -0
  266. package/src/public/avm/serialization/instruction_serialization.ts +249 -0
  267. package/src/public/avm/test_utils.ts +64 -0
  268. package/src/public/debug_fn_name.ts +52 -0
  269. package/src/public/fixtures/amm_test.ts +2 -2
  270. package/src/public/fixtures/bulk_test.ts +2 -2
  271. package/src/public/fixtures/custom_bytecode_tester.ts +2 -2
  272. package/src/public/fixtures/custom_bytecode_tests.ts +435 -0
  273. package/src/public/fixtures/index.ts +3 -0
  274. package/src/public/fixtures/minimal_public_tx.ts +26 -0
  275. package/src/public/fixtures/opcode_spammer.ts +1713 -0
  276. package/src/public/fixtures/public_tx_simulation_tester.ts +36 -11
  277. package/src/public/fixtures/simple_contract_data_source.ts +1 -1
  278. package/src/public/fixtures/token_test.ts +3 -3
  279. package/src/public/fixtures/utils.ts +6 -11
  280. package/src/public/fuzzing/avm_fuzzer_simulator.ts +18 -15
  281. package/src/public/fuzzing/avm_simulator_bin.ts +5 -3
  282. package/src/public/hinting_db_sources.ts +610 -0
  283. package/src/public/index.ts +3 -3
  284. package/src/public/public_processor/guarded_merkle_tree.ts +2 -5
  285. package/src/public/public_processor/public_processor.ts +24 -3
  286. package/src/public/public_tx_simulator/contract_provider_for_cpp.ts +2 -2
  287. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +210 -0
  288. package/src/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.ts +134 -0
  289. package/src/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.ts +239 -0
  290. package/src/public/public_tx_simulator/{dumping_public_tx_simulator.ts → dumping_cpp_public_tx_simulator.ts} +2 -2
  291. package/src/public/public_tx_simulator/factories.ts +6 -6
  292. package/src/public/public_tx_simulator/index.ts +4 -2
  293. package/src/public/public_tx_simulator/measured_public_tx_simulator.ts +105 -0
  294. package/src/public/public_tx_simulator/public_tx_context.ts +482 -0
  295. package/src/public/public_tx_simulator/public_tx_simulator.ts +480 -150
  296. package/src/public/public_tx_simulator/telemetry_public_tx_simulator.ts +63 -0
  297. package/src/public/side_effect_trace.ts +293 -0
  298. package/src/public/side_effect_trace_interface.ts +28 -0
  299. package/src/public/state_manager/index.ts +1 -0
  300. package/src/public/state_manager/nullifiers.ts +103 -0
  301. package/src/public/state_manager/public_storage.ts +174 -0
  302. package/src/public/state_manager/state_manager.ts +569 -0
  303. package/src/public/test_executor_metrics.ts +24 -0
  304. package/dest/public/avm/testing/account_proof_fetcher.d.ts +0 -2
  305. package/dest/public/avm/testing/account_proof_fetcher.d.ts.map +0 -1
  306. package/dest/public/avm/testing/base_avm_simulation_tester.d.ts.map +0 -1
  307. package/dest/public/avm/testing/utils.d.ts +0 -32
  308. package/dest/public/avm/testing/utils.d.ts.map +0 -1
  309. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.d.ts +0 -23
  310. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.d.ts.map +0 -1
  311. package/dest/public/public_tx_simulator/public_tx_simulator_base.d.ts +0 -22
  312. package/dest/public/public_tx_simulator/public_tx_simulator_base.d.ts.map +0 -1
  313. package/dest/public/public_tx_simulator/public_tx_simulator_base.js +0 -28
  314. package/src/public/public_tx_simulator/public_tx_simulator_base.ts +0 -35
  315. /package/dest/public/avm/{testing → fixtures}/account_proof_fetcher.js +0 -0
  316. /package/src/public/avm/{testing → fixtures}/account_proof.json +0 -0
  317. /package/src/public/avm/{testing → fixtures}/account_proof_fetcher.ts +0 -0
@@ -0,0 +1,103 @@
1
+ import { AVM_MAX_PROCESSABLE_L2_GAS } from '@aztec/constants';
2
+ import { BlockNumber, SlotNumber } from '@aztec/foundation/branded-types';
3
+ import { Fr } from '@aztec/foundation/curves/bn254';
4
+ import { EthAddress } from '@aztec/foundation/eth-address';
5
+ import { PublicSimulatorConfig } from '@aztec/stdlib/avm';
6
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
7
+ import { GasFees } from '@aztec/stdlib/gas';
8
+ import { GlobalVariables } from '@aztec/stdlib/tx';
9
+ import type { UInt64 } from '@aztec/stdlib/types';
10
+
11
+ import { mock } from 'jest-mock-extended';
12
+
13
+ import type { PublicContractsDB, PublicTreesDB } from '../../public_db_sources.js';
14
+ import type { PublicSideEffectTraceInterface } from '../../side_effect_trace_interface.js';
15
+ import { NullifierManager } from '../../state_manager/nullifiers.js';
16
+ import { PublicStorage } from '../../state_manager/public_storage.js';
17
+ import { PublicPersistableStateManager } from '../../state_manager/state_manager.js';
18
+ import { AvmContext } from '../avm_context.js';
19
+ import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
20
+ import { AvmMachineState } from '../avm_machine_state.js';
21
+ import { AvmSimulator } from '../avm_simulator.js';
22
+ import { CallDataArray } from '../calldata.js';
23
+ import { DEFAULT_TIMESTAMP } from './utils.js';
24
+
25
+ /**
26
+ * Create a new AVM context with default values.
27
+ */
28
+ export function initContext(overrides?: {
29
+ persistableState?: PublicPersistableStateManager;
30
+ env?: AvmExecutionEnvironment;
31
+ machineState?: AvmMachineState;
32
+ }): AvmContext {
33
+ const ctx = new AvmContext(
34
+ overrides?.persistableState || initPersistableStateManager(),
35
+ overrides?.env || initExecutionEnvironment(),
36
+ overrides?.machineState || initMachineState(),
37
+ );
38
+ ctx.provideSimulator = AvmSimulator.build;
39
+ return ctx;
40
+ }
41
+
42
+ /** Creates an empty state manager with mocked host storage. */
43
+ export function initPersistableStateManager(overrides?: {
44
+ treesDB?: PublicTreesDB;
45
+ contractsDB?: PublicContractsDB;
46
+ trace?: PublicSideEffectTraceInterface;
47
+ publicStorage?: PublicStorage;
48
+ nullifiers?: NullifierManager;
49
+ firstNullifier?: Fr;
50
+ timestamp?: UInt64;
51
+ }): PublicPersistableStateManager {
52
+ const treesDB = overrides?.treesDB || mock<PublicTreesDB>();
53
+ return new PublicPersistableStateManager(
54
+ treesDB,
55
+ overrides?.contractsDB || mock<PublicContractsDB>(),
56
+ overrides?.trace || mock<PublicSideEffectTraceInterface>(),
57
+ overrides?.firstNullifier || new Fr(27),
58
+ overrides?.timestamp || DEFAULT_TIMESTAMP,
59
+ /*doMerkleOperations=*/ false,
60
+ );
61
+ }
62
+
63
+ /**
64
+ * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
65
+ */
66
+ export function initExecutionEnvironment(overrides?: Partial<AvmExecutionEnvironment>): AvmExecutionEnvironment {
67
+ return new AvmExecutionEnvironment(
68
+ overrides?.address ?? AztecAddress.zero(),
69
+ overrides?.sender ?? AztecAddress.zero(),
70
+ overrides?.contractCallDepth ?? Fr.zero(),
71
+ overrides?.transactionFee ?? Fr.zero(),
72
+ overrides?.globals ?? GlobalVariables.empty(),
73
+ overrides?.isStaticCall ?? false,
74
+ overrides?.calldata ?? new CallDataArray([]),
75
+ overrides?.config ?? PublicSimulatorConfig.empty(),
76
+ );
77
+ }
78
+
79
+ /**
80
+ * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
81
+ */
82
+ export function initGlobalVariables(overrides?: Partial<GlobalVariables>): GlobalVariables {
83
+ return new GlobalVariables(
84
+ overrides?.chainId ?? Fr.zero(),
85
+ overrides?.version ?? Fr.zero(),
86
+ overrides?.blockNumber ?? BlockNumber.ZERO,
87
+ overrides?.slotNumber ?? SlotNumber.ZERO,
88
+ overrides?.timestamp ?? 0n,
89
+ overrides?.coinbase ?? EthAddress.ZERO,
90
+ overrides?.feeRecipient ?? AztecAddress.zero(),
91
+ overrides?.gasFees ?? GasFees.empty(),
92
+ );
93
+ }
94
+
95
+ /**
96
+ * Create an empty instance of the Machine State where all values are set to a large enough amount, unless overridden in the overrides object
97
+ */
98
+ export function initMachineState(overrides?: Partial<AvmMachineState>): AvmMachineState {
99
+ return AvmMachineState.fromState({
100
+ l2GasLeft: overrides?.l2GasLeft ?? AVM_MAX_PROCESSABLE_L2_GAS,
101
+ daGasLeft: overrides?.daGasLeft ?? 1e8,
102
+ });
103
+ }
@@ -14,6 +14,7 @@ import {
14
14
  type ContractInstanceWithAddress,
15
15
  computeInitializationHash,
16
16
  } from '@aztec/stdlib/contract';
17
+ import { isNoirCallStackUnresolved } from '@aztec/stdlib/errors';
17
18
  import { siloNullifier } from '@aztec/stdlib/hash';
18
19
  import { deriveKeys } from '@aztec/stdlib/keys';
19
20
  import { makeContractClassPublic, makeContractInstanceFromClassId } from '@aztec/stdlib/testing';
@@ -22,6 +23,10 @@ import type { UInt64 } from '@aztec/stdlib/types';
22
23
  import { strict as assert } from 'assert';
23
24
  import merge from 'lodash.merge';
24
25
 
26
+ import { resolveAssertionMessageFromRevertData, traverseCauseChain } from '../../../common/index.js';
27
+ import { Field, Uint8, Uint32, Uint64 } from '../avm_memory_types.js';
28
+ import type { AvmRevertReason } from '../errors.js';
29
+
25
30
  export const PUBLIC_DISPATCH_FN_NAME = 'public_dispatch';
26
31
  export const DEFAULT_TIMESTAMP: UInt64 = 99833n;
27
32
  export const DEFAULT_BLOCK_NUMBER = BlockNumber(42);
@@ -33,6 +38,22 @@ export function allSameExcept(original: any, overrides: any): any {
33
38
  return merge({}, original, overrides);
34
39
  }
35
40
 
41
+ export function randomMemoryBytes(length: number): Uint8[] {
42
+ return [...Array(length)].map(_ => new Uint8(Math.floor(Math.random() * 255)));
43
+ }
44
+
45
+ export function randomMemoryUint32s(length: number): Uint32[] {
46
+ return [...Array(length)].map(_ => new Uint32(Math.floor(Math.random() * 255)));
47
+ }
48
+
49
+ export function randomMemoryUint64s(length: number): Uint64[] {
50
+ return [...Array(length)].map(_ => new Uint64(Math.floor(Math.random() * 255)));
51
+ }
52
+
53
+ export function randomMemoryFields(length: number): Field[] {
54
+ return [...Array(length)].map(_ => new Field(Fr.random()));
55
+ }
56
+
36
57
  export function getFunctionSelector(
37
58
  functionName: string,
38
59
  contractArtifact: ContractArtifact,
@@ -60,6 +81,24 @@ export function getContractFunctionAbi(
60
81
  );
61
82
  }
62
83
 
84
+ export function resolveContractAssertionMessage(
85
+ functionName: string,
86
+ revertReason: AvmRevertReason,
87
+ output: Fr[],
88
+ contractArtifact: ContractArtifact,
89
+ ): string | undefined {
90
+ traverseCauseChain(revertReason, cause => {
91
+ revertReason = cause as AvmRevertReason;
92
+ });
93
+
94
+ const functionArtifact = getAllFunctionAbis(contractArtifact).find(f => f.name === functionName);
95
+ if (!functionArtifact || !revertReason.noirCallStack || !isNoirCallStackUnresolved(revertReason.noirCallStack)) {
96
+ return undefined;
97
+ }
98
+
99
+ return resolveAssertionMessageFromRevertData(output, functionArtifact);
100
+ }
101
+
63
102
  /**
64
103
  * Create a contract class and instance given constructor args, artifact, etc.
65
104
  * NOTE: This is useful for testing real-ish contract class registration and instance deployment TXs (via logs)
@@ -107,7 +146,7 @@ export async function createContractClassAndInstance(
107
146
  });
108
147
 
109
148
  const contractAddressNullifier = await siloNullifier(
110
- AztecAddress.fromNumber(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS),
149
+ AztecAddress.fromNumberUnsafe(CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS),
111
150
  contractInstance.address.toField(),
112
151
  );
113
152
 
@@ -0,0 +1 @@
1
+ export * from './avm_simulator.js';
@@ -0,0 +1,285 @@
1
+ import { MAX_ETH_ADDRESS_VALUE } from '@aztec/constants';
2
+
3
+ import { NullifierCollisionError } from '../../side_effect_errors.js';
4
+ import type { AvmContext } from '../avm_context.js';
5
+ import { TypeTag, Uint1 } from '../avm_memory_types.js';
6
+ import { InstructionExecutionError, StaticCallAlterationError } from '../errors.js';
7
+ import { Opcode, OperandType } from '../serialization/instruction_serialization.js';
8
+ import { Addressing } from './addressing_mode.js';
9
+ import { Instruction } from './instruction.js';
10
+
11
+ export class NoteHashExists extends Instruction {
12
+ static type: string = 'NOTEHASHEXISTS';
13
+ static readonly opcode: Opcode = Opcode.NOTEHASHEXISTS;
14
+ // Informs (de)serialization. See Instruction.deserialize.
15
+ static readonly wireFormat = [
16
+ OperandType.UINT8,
17
+ OperandType.UINT8,
18
+ OperandType.UINT16,
19
+ OperandType.UINT16,
20
+ OperandType.UINT16,
21
+ ];
22
+
23
+ constructor(
24
+ private addressingMode: number,
25
+ private noteHashOffset: number,
26
+ private leafIndexOffset: number,
27
+ private existsOffset: number,
28
+ ) {
29
+ super();
30
+ }
31
+
32
+ public async execute(context: AvmContext): Promise<void> {
33
+ const memory = context.machineState.memory;
34
+ const addressing = Addressing.fromWire(this.addressingMode);
35
+
36
+ context.machineState.consumeGas(
37
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
38
+ );
39
+ const operands = [this.noteHashOffset, this.leafIndexOffset, this.existsOffset];
40
+ const [noteHashOffset, leafIndexOffset, existsOffset] = addressing.resolve(operands, memory);
41
+ memory.checkTag(TypeTag.FIELD, noteHashOffset);
42
+ memory.checkTag(TypeTag.UINT64, leafIndexOffset);
43
+
44
+ // Note that this instruction accepts any type in memory, and converts to Field.
45
+ const noteHash = memory.get(noteHashOffset).toFr();
46
+ const leafIndex = memory.get(leafIndexOffset).toBigInt();
47
+
48
+ const exists = await context.persistableState.checkNoteHashExists(context.environment.address, noteHash, leafIndex);
49
+ memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
50
+ }
51
+ }
52
+
53
+ export class EmitNoteHash extends Instruction {
54
+ static type: string = 'EMITNOTEHASH';
55
+ static readonly opcode: Opcode = Opcode.EMITNOTEHASH;
56
+ // Informs (de)serialization. See Instruction.deserialize.
57
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16];
58
+
59
+ constructor(
60
+ private addressingMode: number,
61
+ private noteHashOffset: number,
62
+ ) {
63
+ super();
64
+ }
65
+
66
+ public async execute(context: AvmContext): Promise<void> {
67
+ const memory = context.machineState.memory;
68
+ const addressing = Addressing.fromWire(this.addressingMode);
69
+
70
+ context.machineState.consumeGas(
71
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
72
+ );
73
+
74
+ const operands = [this.noteHashOffset];
75
+ const [noteHashOffset] = addressing.resolve(operands, memory);
76
+ memory.checkTag(TypeTag.FIELD, noteHashOffset);
77
+
78
+ if (context.environment.isStaticCall) {
79
+ throw new StaticCallAlterationError();
80
+ }
81
+
82
+ const noteHash = memory.get(noteHashOffset).toFr();
83
+ await context.persistableState.writeNoteHash(context.environment.address, noteHash);
84
+ }
85
+ }
86
+
87
+ export class NullifierExists extends Instruction {
88
+ static type: string = 'NULLIFIEREXISTS';
89
+ static readonly opcode: Opcode = Opcode.NULLIFIEREXISTS;
90
+ // Informs (de)serialization. See Instruction.deserialize.
91
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16, OperandType.UINT16];
92
+
93
+ constructor(
94
+ private addressingMode: number,
95
+ private siloedNullifierOffset: number,
96
+ private existsOffset: number,
97
+ ) {
98
+ super();
99
+ }
100
+
101
+ public async execute(context: AvmContext): Promise<void> {
102
+ const memory = context.machineState.memory;
103
+ const addressing = Addressing.fromWire(this.addressingMode);
104
+
105
+ context.machineState.consumeGas(
106
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
107
+ );
108
+
109
+ const operands = [this.siloedNullifierOffset, this.existsOffset];
110
+ const [siloedNullifierOffset, existsOffset] = addressing.resolve(operands, memory);
111
+ memory.checkTag(TypeTag.FIELD, siloedNullifierOffset);
112
+
113
+ const siloedNullifier = memory.get(siloedNullifierOffset).toFr();
114
+ const exists = await context.persistableState.checkSiloedNullifierExists(siloedNullifier);
115
+
116
+ memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
117
+ }
118
+ }
119
+
120
+ export class EmitNullifier extends Instruction {
121
+ static type: string = 'EMITNULLIFIER';
122
+ static readonly opcode: Opcode = Opcode.EMITNULLIFIER;
123
+ // Informs (de)serialization. See Instruction.deserialize.
124
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16];
125
+
126
+ constructor(
127
+ private addressingMode: number,
128
+ private nullifierOffset: number,
129
+ ) {
130
+ super();
131
+ }
132
+
133
+ public async execute(context: AvmContext): Promise<void> {
134
+ if (context.environment.isStaticCall) {
135
+ throw new StaticCallAlterationError();
136
+ }
137
+
138
+ const memory = context.machineState.memory;
139
+ const addressing = Addressing.fromWire(this.addressingMode);
140
+
141
+ context.machineState.consumeGas(
142
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
143
+ );
144
+
145
+ const operands = [this.nullifierOffset];
146
+ const [nullifierOffset] = addressing.resolve(operands, memory);
147
+ memory.checkTag(TypeTag.FIELD, nullifierOffset);
148
+
149
+ const nullifier = memory.get(nullifierOffset).toFr();
150
+ try {
151
+ await context.persistableState.writeNullifier(context.environment.address, nullifier);
152
+ } catch (e) {
153
+ if (e instanceof NullifierCollisionError) {
154
+ // Error is known/expected, raise as InstructionExecutionError that the will lead the simulator to revert this call
155
+ throw new InstructionExecutionError(
156
+ `Attempted to emit duplicate nullifier ${nullifier} (contract address: ${context.environment.address}).`,
157
+ );
158
+ } else {
159
+ throw e;
160
+ }
161
+ }
162
+ }
163
+ }
164
+
165
+ export class L1ToL2MessageExists extends Instruction {
166
+ static type: string = 'L1TOL2MSGEXISTS';
167
+ static readonly opcode: Opcode = Opcode.L1TOL2MSGEXISTS;
168
+ // Informs (de)serialization. See Instruction.deserialize.
169
+ static readonly wireFormat = [
170
+ OperandType.UINT8,
171
+ OperandType.UINT8,
172
+ OperandType.UINT16,
173
+ OperandType.UINT16,
174
+ OperandType.UINT16,
175
+ ];
176
+
177
+ constructor(
178
+ private addressingMode: number,
179
+ private msgHashOffset: number,
180
+ private msgLeafIndexOffset: number,
181
+ private existsOffset: number,
182
+ ) {
183
+ super();
184
+ }
185
+
186
+ public async execute(context: AvmContext): Promise<void> {
187
+ const memory = context.machineState.memory;
188
+ const addressing = Addressing.fromWire(this.addressingMode);
189
+
190
+ context.machineState.consumeGas(
191
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
192
+ );
193
+
194
+ const operands = [this.msgHashOffset, this.msgLeafIndexOffset, this.existsOffset];
195
+ const [msgHashOffset, msgLeafIndexOffset, existsOffset] = addressing.resolve(operands, memory);
196
+
197
+ memory.checkTag(TypeTag.FIELD, msgHashOffset);
198
+ memory.checkTag(TypeTag.UINT64, msgLeafIndexOffset);
199
+
200
+ const msgHash = memory.get(msgHashOffset).toFr();
201
+ const msgLeafIndex = memory.get(msgLeafIndexOffset).toFr();
202
+ const exists = await context.persistableState.checkL1ToL2MessageExists(msgHash, msgLeafIndex);
203
+ memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
204
+ }
205
+ }
206
+
207
+ export class EmitPublicLog extends Instruction {
208
+ static type: string = 'EMITPUBLICLOG';
209
+ static readonly opcode: Opcode = Opcode.EMITPUBLICLOG;
210
+ // Informs (de)serialization. See Instruction.deserialize.
211
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16, OperandType.UINT16];
212
+
213
+ constructor(
214
+ private addressingMode: number,
215
+ private logSizeOffset: number,
216
+ private logOffset: number,
217
+ ) {
218
+ super();
219
+ }
220
+
221
+ public async execute(context: AvmContext): Promise<void> {
222
+ if (context.environment.isStaticCall) {
223
+ throw new StaticCallAlterationError();
224
+ }
225
+
226
+ const memory = context.machineState.memory;
227
+ const addressing = Addressing.fromWire(this.addressingMode);
228
+
229
+ context.machineState.consumeGas(
230
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
231
+ );
232
+
233
+ const operands = [this.logSizeOffset, this.logOffset];
234
+ const [logSizeOffset, logOffset] = addressing.resolve(operands, memory);
235
+ memory.checkTag(TypeTag.UINT32, logSizeOffset);
236
+ const logSize = memory.get(logSizeOffset).toNumber();
237
+
238
+ const contractAddress = context.environment.address;
239
+
240
+ context.machineState.consumeGas(this.dynamicGasCost(logSize));
241
+ memory.checkTagsRange(TypeTag.FIELD, logOffset, logSize);
242
+ const log = memory.getSlice(logOffset, logSize).map(f => f.toFr());
243
+ context.persistableState.writePublicLog(contractAddress, log);
244
+ }
245
+ }
246
+
247
+ export class SendL2ToL1Message extends Instruction {
248
+ static type: string = 'SENDL2TOL1MSG';
249
+ static readonly opcode: Opcode = Opcode.SENDL2TOL1MSG;
250
+ // Informs (de)serialization. See Instruction.deserialize.
251
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16, OperandType.UINT16];
252
+
253
+ constructor(
254
+ private addressingMode: number,
255
+ private recipientOffset: number,
256
+ private contentOffset: number,
257
+ ) {
258
+ super();
259
+ }
260
+
261
+ public async execute(context: AvmContext): Promise<void> {
262
+ if (context.environment.isStaticCall) {
263
+ throw new StaticCallAlterationError();
264
+ }
265
+
266
+ const memory = context.machineState.memory;
267
+ const addressing = Addressing.fromWire(this.addressingMode);
268
+
269
+ context.machineState.consumeGas(
270
+ this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
271
+ );
272
+
273
+ const operands = [this.recipientOffset, this.contentOffset];
274
+ const [recipientOffset, contentOffset] = addressing.resolve(operands, memory);
275
+ memory.checkTags(TypeTag.FIELD, recipientOffset, contentOffset);
276
+
277
+ const recipient = memory.get(recipientOffset).toFr();
278
+
279
+ if (recipient.toBigInt() > MAX_ETH_ADDRESS_VALUE) {
280
+ throw new InstructionExecutionError(`SENDL2TOL1MSG: Recipient address is too large`);
281
+ }
282
+ const content = memory.get(contentOffset).toFr();
283
+ context.persistableState.writeL2ToL1Message(context.environment.address, recipient, content);
284
+ }
285
+ }
@@ -0,0 +1,111 @@
1
+ import { AVM_MAX_OPERANDS } from '@aztec/constants';
2
+ import { padArrayEnd } from '@aztec/foundation/collection';
3
+ import type { Tuple } from '@aztec/foundation/serialize';
4
+
5
+ import { strict as assert } from 'assert';
6
+
7
+ import { MemoryValue, TaggedMemory, type TaggedMemoryInterface, TypeTag } from '../avm_memory_types.js';
8
+ import { RelativeAddressOutOfRangeError, TagCheckError } from '../errors.js';
9
+
10
+ export enum AddressingMode {
11
+ DIRECT = 0,
12
+ INDIRECT = 1,
13
+ RELATIVE = 2,
14
+ INDIRECT_RELATIVE = 3,
15
+ }
16
+
17
+ /** A class to represent the addressing mode of an instruction. */
18
+ export class Addressing {
19
+ public constructor(
20
+ /** The addressing mode for each possible operand. */
21
+ private readonly modePerOperand: Tuple<AddressingMode, typeof AVM_MAX_OPERANDS>,
22
+ ) {}
23
+
24
+ public static fromModes(modes: AddressingMode[]): Addressing {
25
+ assert(modes.length <= AVM_MAX_OPERANDS, 'Too many operands for addressing mode');
26
+ return new Addressing(padArrayEnd(modes, AddressingMode.DIRECT, AVM_MAX_OPERANDS));
27
+ }
28
+
29
+ public static fromWire(wireModes: number): Addressing {
30
+ // The modes are stored in the wire format as one or two bytes, with each two bits representing the modes for an operand.
31
+ // Even bits are indirect, odd bits are relative.
32
+ const modes = new Array<AddressingMode>(AVM_MAX_OPERANDS);
33
+ for (let i = 0; i < AVM_MAX_OPERANDS; i++) {
34
+ modes[i] =
35
+ (((wireModes >> (i * 2)) & 1) * AddressingMode.INDIRECT) |
36
+ (((wireModes >> (i * 2 + 1)) & 1) * AddressingMode.RELATIVE);
37
+ }
38
+ // Casting the array to tuple since it should be more performant than using makeTuple
39
+ return new Addressing(modes as Tuple<AddressingMode, typeof AVM_MAX_OPERANDS>);
40
+ }
41
+
42
+ public toWire(): number {
43
+ // The modes are stored in the wire format as a byte, with each bit representing the mode for an operand.
44
+ // The least significant bit represents the zeroth operand, and the least significant bit represents the last operand.
45
+ let wire: number = 0;
46
+ for (let i = 0; i < this.modePerOperand.length; i++) {
47
+ if (this.modePerOperand[i] & AddressingMode.INDIRECT) {
48
+ wire |= 1 << (i * 2);
49
+ }
50
+ if (this.modePerOperand[i] & AddressingMode.RELATIVE) {
51
+ wire |= 1 << (i * 2 + 1);
52
+ }
53
+ }
54
+ return wire;
55
+ }
56
+
57
+ public indirectOperandsCount(): number {
58
+ return this.modePerOperand.filter(mode => mode & AddressingMode.INDIRECT).length;
59
+ }
60
+
61
+ public relativeOperandsCount(): number {
62
+ return this.modePerOperand.filter(mode => mode & AddressingMode.RELATIVE).length;
63
+ }
64
+
65
+ /**
66
+ * Resolves the offsets using the addressing mode.
67
+ * @param offsets The offsets to resolve.
68
+ * @param mem The memory to use for resolution.
69
+ * @returns The resolved offsets. The length of the returned array is the same as the length of the input array and the resolved offsets are guaranteed to be valid addresses.
70
+ * @throws An error if any step failed. Should be treated as a black box.
71
+ */
72
+ public resolve(offsets: number[], mem: TaggedMemoryInterface): number[] {
73
+ const resolved: number[] = new Array(offsets.length);
74
+ // These will be read (once) if we have any relative operands.
75
+ let baseAddr: MemoryValue | undefined;
76
+
77
+ for (const [i, offset] of offsets.entries()) {
78
+ const mode = this.modePerOperand[i];
79
+ // The given offsets are assumed to be valid addresses.
80
+ resolved[i] = offset;
81
+ if (mode & AddressingMode.RELATIVE) {
82
+ if (!baseAddr) {
83
+ baseAddr = mem.get(0);
84
+ const baseAddrTag = baseAddr.getTag();
85
+ if (!TaggedMemory.isValidMemoryAddressTag(baseAddrTag!)) {
86
+ throw TagCheckError.forBaseAddress(TypeTag[baseAddrTag!]);
87
+ }
88
+ }
89
+ // Here we know that resolved[i] is at most 32 bits and baseAddr is at most 32 bits.
90
+ // Therefore, the addition is safe since the `number` type fits more than 33 bits.
91
+ resolved[i] += Number(baseAddr.toBigInt());
92
+ if (resolved[i] >= TaggedMemory.MAX_MEMORY_SIZE) {
93
+ throw new RelativeAddressOutOfRangeError(Number(baseAddr.toBigInt()), offset);
94
+ }
95
+ }
96
+ if (mode & AddressingMode.INDIRECT) {
97
+ // At this point we know that resolved[i] is a valid memory address.
98
+ const resolvedValue = mem.get(resolved[i]);
99
+ const resolvedTag = resolvedValue.getTag();
100
+
101
+ // Final check.
102
+ if (!TaggedMemory.isValidMemoryAddressTag(resolvedTag)) {
103
+ throw TagCheckError.forIndirectAddress(resolved[i], TypeTag[resolvedTag]);
104
+ }
105
+
106
+ resolved[i] = Number(resolvedValue.toBigInt());
107
+ }
108
+ }
109
+ return resolved;
110
+ }
111
+ }