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

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 (312) hide show
  1. package/README.md +4 -4
  2. package/dest/private/acvm_wasm.d.ts +1 -1
  3. package/dest/private/acvm_wasm.d.ts.map +1 -1
  4. package/dest/private/acvm_wasm.js +3 -1
  5. package/dest/private/circuit_recording/circuit_recorder.js +2 -2
  6. package/dest/public/avm/testing/account_proof_fetcher.d.ts +2 -0
  7. package/dest/public/avm/testing/account_proof_fetcher.d.ts.map +1 -0
  8. package/dest/public/avm/testing/account_proof_fetcher.js +152 -0
  9. package/dest/public/avm/{fixtures → testing}/base_avm_simulation_tester.d.ts +2 -1
  10. package/dest/public/avm/testing/base_avm_simulation_tester.d.ts.map +1 -0
  11. package/dest/public/avm/{fixtures → testing}/base_avm_simulation_tester.js +17 -2
  12. package/dest/public/avm/testing/utils.d.ts +32 -0
  13. package/dest/public/avm/testing/utils.d.ts.map +1 -0
  14. package/dest/public/avm/{fixtures → testing}/utils.js +3 -33
  15. package/dest/public/contracts_db_checkpoint.d.ts +2 -2
  16. package/dest/public/contracts_db_checkpoint.d.ts.map +1 -1
  17. package/dest/public/contracts_db_checkpoint.js +1 -1
  18. package/dest/public/fixtures/amm_test.js +2 -2
  19. package/dest/public/fixtures/bulk_test.d.ts +1 -1
  20. package/dest/public/fixtures/bulk_test.d.ts.map +1 -1
  21. package/dest/public/fixtures/bulk_test.js +31 -4
  22. package/dest/public/fixtures/index.d.ts +1 -4
  23. package/dest/public/fixtures/index.d.ts.map +1 -1
  24. package/dest/public/fixtures/index.js +0 -3
  25. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +8 -7
  26. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -1
  27. package/dest/public/fixtures/public_tx_simulation_tester.js +16 -17
  28. package/dest/public/fixtures/simple_contract_data_source.js +1 -1
  29. package/dest/public/fixtures/utils.d.ts +2 -2
  30. package/dest/public/fixtures/utils.d.ts.map +1 -1
  31. package/dest/public/fixtures/utils.js +19 -20
  32. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts +6 -4
  33. package/dest/public/fuzzing/avm_fuzzer_simulator.d.ts.map +1 -1
  34. package/dest/public/fuzzing/avm_fuzzer_simulator.js +12 -7
  35. package/dest/public/fuzzing/avm_simulator_bin.js +4 -4
  36. package/dest/public/index.d.ts +2 -2
  37. package/dest/public/index.d.ts.map +1 -1
  38. package/dest/public/index.js +1 -1
  39. package/dest/public/public_db_sources.d.ts +6 -3
  40. package/dest/public/public_db_sources.d.ts.map +1 -1
  41. package/dest/public/public_db_sources.js +16 -10
  42. package/dest/public/public_processor/guarded_merkle_tree.d.ts +8 -7
  43. package/dest/public/public_processor/guarded_merkle_tree.d.ts.map +1 -1
  44. package/dest/public/public_processor/guarded_merkle_tree.js +8 -5
  45. package/dest/public/public_processor/public_processor.d.ts +8 -5
  46. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  47. package/dest/public/public_processor/public_processor.js +109 -74
  48. package/dest/public/public_processor/public_processor_metrics.d.ts +4 -1
  49. package/dest/public/public_processor/public_processor_metrics.d.ts.map +1 -1
  50. package/dest/public/public_processor/public_processor_metrics.js +8 -0
  51. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts +1 -1
  52. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts.map +1 -1
  53. package/dest/public/public_tx_simulator/contract_provider_for_cpp.js +3 -2
  54. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.d.ts +23 -0
  55. package/dest/public/public_tx_simulator/dumping_public_tx_simulator.d.ts.map +1 -0
  56. package/dest/public/public_tx_simulator/{dumping_cpp_public_tx_simulator.js → dumping_public_tx_simulator.js} +2 -2
  57. package/dest/public/public_tx_simulator/factories.d.ts +6 -6
  58. package/dest/public/public_tx_simulator/factories.d.ts.map +1 -1
  59. package/dest/public/public_tx_simulator/factories.js +8 -8
  60. package/dest/public/public_tx_simulator/index.d.ts +3 -5
  61. package/dest/public/public_tx_simulator/index.d.ts.map +1 -1
  62. package/dest/public/public_tx_simulator/index.js +2 -4
  63. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +41 -70
  64. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  65. package/dest/public/public_tx_simulator/public_tx_simulator.js +98 -319
  66. package/dest/public/public_tx_simulator/public_tx_simulator_base.d.ts +22 -0
  67. package/dest/public/public_tx_simulator/public_tx_simulator_base.d.ts.map +1 -0
  68. package/dest/public/public_tx_simulator/public_tx_simulator_base.js +28 -0
  69. package/package.json +17 -18
  70. package/src/private/acvm_wasm.ts +4 -1
  71. package/src/private/circuit_recording/circuit_recorder.ts +2 -2
  72. package/src/public/avm/testing/account_proof.json +553 -0
  73. package/src/public/avm/testing/account_proof_fetcher.ts +166 -0
  74. package/src/public/avm/{fixtures → testing}/base_avm_simulation_tester.ts +22 -2
  75. package/src/public/avm/{fixtures → testing}/utils.ts +3 -39
  76. package/src/public/contracts_db_checkpoint.ts +1 -1
  77. package/src/public/fixtures/amm_test.ts +2 -2
  78. package/src/public/fixtures/bulk_test.ts +29 -4
  79. package/src/public/fixtures/index.ts +0 -3
  80. package/src/public/fixtures/public_tx_simulation_tester.ts +30 -15
  81. package/src/public/fixtures/simple_contract_data_source.ts +1 -1
  82. package/src/public/fixtures/utils.ts +26 -22
  83. package/src/public/fuzzing/avm_fuzzer_simulator.ts +16 -19
  84. package/src/public/fuzzing/avm_simulator_bin.ts +3 -5
  85. package/src/public/index.ts +3 -3
  86. package/src/public/public_db_sources.ts +21 -14
  87. package/src/public/public_processor/guarded_merkle_tree.ts +11 -8
  88. package/src/public/public_processor/public_processor.ts +142 -93
  89. package/src/public/public_processor/public_processor_metrics.ts +12 -0
  90. package/src/public/public_tx_simulator/contract_provider_for_cpp.ts +3 -2
  91. package/src/public/public_tx_simulator/{dumping_cpp_public_tx_simulator.ts → dumping_public_tx_simulator.ts} +2 -2
  92. package/src/public/public_tx_simulator/factories.ts +8 -7
  93. package/src/public/public_tx_simulator/index.ts +2 -4
  94. package/src/public/public_tx_simulator/public_tx_simulator.ts +150 -476
  95. package/src/public/public_tx_simulator/public_tx_simulator_base.ts +35 -0
  96. package/dest/public/avm/avm_context.d.ts +0 -41
  97. package/dest/public/avm/avm_context.d.ts.map +0 -1
  98. package/dest/public/avm/avm_context.js +0 -44
  99. package/dest/public/avm/avm_contract_call_result.d.ts +0 -32
  100. package/dest/public/avm/avm_contract_call_result.d.ts.map +0 -1
  101. package/dest/public/avm/avm_contract_call_result.js +0 -54
  102. package/dest/public/avm/avm_execution_environment.d.ts +0 -24
  103. package/dest/public/avm/avm_execution_environment.d.ts.map +0 -1
  104. package/dest/public/avm/avm_execution_environment.js +0 -33
  105. package/dest/public/avm/avm_gas.d.ts +0 -44
  106. package/dest/public/avm/avm_gas.d.ts.map +0 -1
  107. package/dest/public/avm/avm_gas.js +0 -195
  108. package/dest/public/avm/avm_machine_state.d.ts +0 -98
  109. package/dest/public/avm/avm_machine_state.d.ts.map +0 -1
  110. package/dest/public/avm/avm_machine_state.js +0 -110
  111. package/dest/public/avm/avm_memory_types.d.ts +0 -275
  112. package/dest/public/avm/avm_memory_types.d.ts.map +0 -1
  113. package/dest/public/avm/avm_memory_types.js +0 -354
  114. package/dest/public/avm/avm_simulator.d.ts +0 -41
  115. package/dest/public/avm/avm_simulator.d.ts.map +0 -1
  116. package/dest/public/avm/avm_simulator.js +0 -192
  117. package/dest/public/avm/avm_simulator_interface.d.ts +0 -9
  118. package/dest/public/avm/avm_simulator_interface.d.ts.map +0 -1
  119. package/dest/public/avm/avm_simulator_interface.js +0 -3
  120. package/dest/public/avm/calldata.d.ts +0 -51
  121. package/dest/public/avm/calldata.d.ts.map +0 -1
  122. package/dest/public/avm/calldata.js +0 -63
  123. package/dest/public/avm/errors.d.ts +0 -104
  124. package/dest/public/avm/errors.d.ts.map +0 -1
  125. package/dest/public/avm/errors.js +0 -141
  126. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +0 -22
  127. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +0 -1
  128. package/dest/public/avm/fixtures/avm_simulation_tester.js +0 -84
  129. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +0 -1
  130. package/dest/public/avm/fixtures/initializers.d.ts +0 -42
  131. package/dest/public/avm/fixtures/initializers.d.ts.map +0 -1
  132. package/dest/public/avm/fixtures/initializers.js +0 -45
  133. package/dest/public/avm/fixtures/utils.d.ts +0 -39
  134. package/dest/public/avm/fixtures/utils.d.ts.map +0 -1
  135. package/dest/public/avm/index.d.ts +0 -2
  136. package/dest/public/avm/index.d.ts.map +0 -1
  137. package/dest/public/avm/index.js +0 -1
  138. package/dest/public/avm/opcodes/accrued_substate.d.ts +0 -74
  139. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +0 -1
  140. package/dest/public/avm/opcodes/accrued_substate.js +0 -255
  141. package/dest/public/avm/opcodes/addressing_mode.d.ts +0 -31
  142. package/dest/public/avm/opcodes/addressing_mode.d.ts.map +0 -1
  143. package/dest/public/avm/opcodes/addressing_mode.js +0 -94
  144. package/dest/public/avm/opcodes/arithmetic.d.ts +0 -49
  145. package/dest/public/avm/opcodes/arithmetic.d.ts.map +0 -1
  146. package/dest/public/avm/opcodes/arithmetic.js +0 -97
  147. package/dest/public/avm/opcodes/bitwise.d.ts +0 -42
  148. package/dest/public/avm/opcodes/bitwise.d.ts.map +0 -1
  149. package/dest/public/avm/opcodes/bitwise.js +0 -99
  150. package/dest/public/avm/opcodes/comparators.d.ts +0 -25
  151. package/dest/public/avm/opcodes/comparators.d.ts.map +0 -1
  152. package/dest/public/avm/opcodes/comparators.js +0 -43
  153. package/dest/public/avm/opcodes/contract.d.ts +0 -20
  154. package/dest/public/avm/opcodes/contract.d.ts.map +0 -1
  155. package/dest/public/avm/opcodes/contract.js +0 -65
  156. package/dest/public/avm/opcodes/control_flow.d.ts +0 -41
  157. package/dest/public/avm/opcodes/control_flow.d.ts.map +0 -1
  158. package/dest/public/avm/opcodes/control_flow.js +0 -107
  159. package/dest/public/avm/opcodes/conversion.d.ts +0 -18
  160. package/dest/public/avm/opcodes/conversion.d.ts.map +0 -1
  161. package/dest/public/avm/opcodes/conversion.js +0 -333
  162. package/dest/public/avm/opcodes/ec_add.d.ts +0 -19
  163. package/dest/public/avm/opcodes/ec_add.d.ts.map +0 -1
  164. package/dest/public/avm/opcodes/ec_add.js +0 -93
  165. package/dest/public/avm/opcodes/environment_getters.d.ts +0 -28
  166. package/dest/public/avm/opcodes/environment_getters.d.ts.map +0 -1
  167. package/dest/public/avm/opcodes/environment_getters.js +0 -77
  168. package/dest/public/avm/opcodes/external_calls.d.ts +0 -59
  169. package/dest/public/avm/opcodes/external_calls.d.ts.map +0 -1
  170. package/dest/public/avm/opcodes/external_calls.js +0 -210
  171. package/dest/public/avm/opcodes/hashing.d.ts +0 -36
  172. package/dest/public/avm/opcodes/hashing.d.ts.map +0 -1
  173. package/dest/public/avm/opcodes/hashing.js +0 -119
  174. package/dest/public/avm/opcodes/index.d.ts +0 -16
  175. package/dest/public/avm/opcodes/index.d.ts.map +0 -1
  176. package/dest/public/avm/opcodes/index.js +0 -15
  177. package/dest/public/avm/opcodes/instruction.d.ts +0 -74
  178. package/dest/public/avm/opcodes/instruction.d.ts.map +0 -1
  179. package/dest/public/avm/opcodes/instruction.js +0 -95
  180. package/dest/public/avm/opcodes/instruction_impl.d.ts +0 -19
  181. package/dest/public/avm/opcodes/instruction_impl.d.ts.map +0 -1
  182. package/dest/public/avm/opcodes/instruction_impl.js +0 -30
  183. package/dest/public/avm/opcodes/memory.d.ts +0 -74
  184. package/dest/public/avm/opcodes/memory.d.ts.map +0 -1
  185. package/dest/public/avm/opcodes/memory.js +0 -257
  186. package/dest/public/avm/opcodes/misc.d.ts +0 -18
  187. package/dest/public/avm/opcodes/misc.d.ts.map +0 -1
  188. package/dest/public/avm/opcodes/misc.js +0 -73
  189. package/dest/public/avm/opcodes/storage.d.ts +0 -25
  190. package/dest/public/avm/opcodes/storage.d.ts.map +0 -1
  191. package/dest/public/avm/opcodes/storage.js +0 -78
  192. package/dest/public/avm/revert_reason.d.ts +0 -18
  193. package/dest/public/avm/revert_reason.d.ts.map +0 -1
  194. package/dest/public/avm/revert_reason.js +0 -39
  195. package/dest/public/avm/serialization/buffer_cursor.d.ts +0 -26
  196. package/dest/public/avm/serialization/buffer_cursor.d.ts.map +0 -1
  197. package/dest/public/avm/serialization/buffer_cursor.js +0 -99
  198. package/dest/public/avm/serialization/bytecode_serialization.d.ts +0 -17
  199. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +0 -1
  200. package/dest/public/avm/serialization/bytecode_serialization.js +0 -336
  201. package/dest/public/avm/serialization/instruction_serialization.d.ts +0 -114
  202. package/dest/public/avm/serialization/instruction_serialization.d.ts.map +0 -1
  203. package/dest/public/avm/serialization/instruction_serialization.js +0 -261
  204. package/dest/public/avm/test_utils.d.ts +0 -15
  205. package/dest/public/avm/test_utils.d.ts.map +0 -1
  206. package/dest/public/avm/test_utils.js +0 -44
  207. package/dest/public/debug_fn_name.d.ts +0 -18
  208. package/dest/public/debug_fn_name.d.ts.map +0 -1
  209. package/dest/public/debug_fn_name.js +0 -37
  210. package/dest/public/fixtures/custom_bytecode_tests.d.ts +0 -12
  211. package/dest/public/fixtures/custom_bytecode_tests.d.ts.map +0 -1
  212. package/dest/public/fixtures/custom_bytecode_tests.js +0 -174
  213. package/dest/public/fixtures/minimal_public_tx.d.ts +0 -4
  214. package/dest/public/fixtures/minimal_public_tx.d.ts.map +0 -1
  215. package/dest/public/fixtures/minimal_public_tx.js +0 -19
  216. package/dest/public/fixtures/opcode_spammer.d.ts +0 -122
  217. package/dest/public/fixtures/opcode_spammer.d.ts.map +0 -1
  218. package/dest/public/fixtures/opcode_spammer.js +0 -1653
  219. package/dest/public/hinting_db_sources.d.ts +0 -80
  220. package/dest/public/hinting_db_sources.d.ts.map +0 -1
  221. package/dest/public/hinting_db_sources.js +0 -355
  222. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +0 -53
  223. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +0 -1
  224. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +0 -132
  225. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts +0 -42
  226. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts.map +0 -1
  227. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.js +0 -86
  228. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts +0 -30
  229. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts.map +0 -1
  230. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.js +0 -171
  231. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts +0 -23
  232. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts.map +0 -1
  233. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts +0 -31
  234. package/dest/public/public_tx_simulator/measured_public_tx_simulator.d.ts.map +0 -1
  235. package/dest/public/public_tx_simulator/measured_public_tx_simulator.js +0 -51
  236. package/dest/public/public_tx_simulator/public_tx_context.d.ts +0 -131
  237. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +0 -1
  238. package/dest/public/public_tx_simulator/public_tx_context.js +0 -300
  239. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts +0 -21
  240. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.d.ts.map +0 -1
  241. package/dest/public/public_tx_simulator/telemetry_public_tx_simulator.js +0 -415
  242. package/dest/public/side_effect_trace.d.ts +0 -87
  243. package/dest/public/side_effect_trace.d.ts.map +0 -1
  244. package/dest/public/side_effect_trace.js +0 -199
  245. package/dest/public/side_effect_trace_interface.d.ts +0 -22
  246. package/dest/public/side_effect_trace_interface.d.ts.map +0 -1
  247. package/dest/public/side_effect_trace_interface.js +0 -1
  248. package/dest/public/state_manager/index.d.ts +0 -2
  249. package/dest/public/state_manager/index.d.ts.map +0 -1
  250. package/dest/public/state_manager/index.js +0 -1
  251. package/dest/public/state_manager/nullifiers.d.ts +0 -61
  252. package/dest/public/state_manager/nullifiers.d.ts.map +0 -1
  253. package/dest/public/state_manager/nullifiers.js +0 -92
  254. package/dest/public/state_manager/public_storage.d.ts +0 -66
  255. package/dest/public/state_manager/public_storage.d.ts.map +0 -1
  256. package/dest/public/state_manager/public_storage.js +0 -145
  257. package/dest/public/state_manager/state_manager.d.ts +0 -170
  258. package/dest/public/state_manager/state_manager.d.ts.map +0 -1
  259. package/dest/public/state_manager/state_manager.js +0 -402
  260. package/src/public/avm/avm_context.ts +0 -61
  261. package/src/public/avm/avm_contract_call_result.ts +0 -69
  262. package/src/public/avm/avm_execution_environment.ts +0 -51
  263. package/src/public/avm/avm_gas.ts +0 -183
  264. package/src/public/avm/avm_machine_state.ts +0 -170
  265. package/src/public/avm/avm_memory_types.ts +0 -440
  266. package/src/public/avm/avm_simulator.ts +0 -279
  267. package/src/public/avm/avm_simulator_interface.ts +0 -8
  268. package/src/public/avm/calldata.ts +0 -100
  269. package/src/public/avm/errors.ts +0 -177
  270. package/src/public/avm/fixtures/avm_simulation_tester.ts +0 -122
  271. package/src/public/avm/fixtures/initializers.ts +0 -103
  272. package/src/public/avm/index.ts +0 -1
  273. package/src/public/avm/opcodes/accrued_substate.ts +0 -286
  274. package/src/public/avm/opcodes/addressing_mode.ts +0 -111
  275. package/src/public/avm/opcodes/arithmetic.ts +0 -129
  276. package/src/public/avm/opcodes/bitwise.ts +0 -113
  277. package/src/public/avm/opcodes/comparators.ts +0 -55
  278. package/src/public/avm/opcodes/contract.ts +0 -72
  279. package/src/public/avm/opcodes/control_flow.ts +0 -123
  280. package/src/public/avm/opcodes/conversion.ts +0 -104
  281. package/src/public/avm/opcodes/ec_add.ts +0 -105
  282. package/src/public/avm/opcodes/environment_getters.ts +0 -87
  283. package/src/public/avm/opcodes/external_calls.ts +0 -262
  284. package/src/public/avm/opcodes/hashing.ts +0 -151
  285. package/src/public/avm/opcodes/index.ts +0 -15
  286. package/src/public/avm/opcodes/instruction.ts +0 -136
  287. package/src/public/avm/opcodes/instruction_impl.ts +0 -36
  288. package/src/public/avm/opcodes/memory.ts +0 -293
  289. package/src/public/avm/opcodes/misc.ts +0 -102
  290. package/src/public/avm/opcodes/storage.ts +0 -95
  291. package/src/public/avm/revert_reason.ts +0 -58
  292. package/src/public/avm/serialization/buffer_cursor.ts +0 -118
  293. package/src/public/avm/serialization/bytecode_serialization.ts +0 -215
  294. package/src/public/avm/serialization/instruction_serialization.ts +0 -249
  295. package/src/public/avm/test_utils.ts +0 -64
  296. package/src/public/debug_fn_name.ts +0 -52
  297. package/src/public/fixtures/custom_bytecode_tests.ts +0 -228
  298. package/src/public/fixtures/minimal_public_tx.ts +0 -26
  299. package/src/public/fixtures/opcode_spammer.ts +0 -1721
  300. package/src/public/hinting_db_sources.ts +0 -607
  301. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +0 -211
  302. package/src/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.ts +0 -134
  303. package/src/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.ts +0 -239
  304. package/src/public/public_tx_simulator/measured_public_tx_simulator.ts +0 -105
  305. package/src/public/public_tx_simulator/public_tx_context.ts +0 -484
  306. package/src/public/public_tx_simulator/telemetry_public_tx_simulator.ts +0 -63
  307. package/src/public/side_effect_trace.ts +0 -293
  308. package/src/public/side_effect_trace_interface.ts +0 -28
  309. package/src/public/state_manager/index.ts +0 -1
  310. package/src/public/state_manager/nullifiers.ts +0 -103
  311. package/src/public/state_manager/public_storage.ts +0 -174
  312. package/src/public/state_manager/state_manager.ts +0 -569
@@ -1,215 +0,0 @@
1
- import { type Bufferable, serializeToBuffer } from '@aztec/foundation/serialize';
2
-
3
- import {
4
- AvmExecutionError,
5
- AvmParsingError,
6
- InvalidOpcodeError,
7
- InvalidProgramCounterError,
8
- InvalidTagValueError,
9
- duringInstrFetch,
10
- } from '../errors.js';
11
- import {
12
- Add,
13
- And,
14
- Call,
15
- CalldataCopy,
16
- Cast,
17
- DebugLog,
18
- Div,
19
- EcAdd,
20
- EmitNoteHash,
21
- EmitNullifier,
22
- EmitUnencryptedLog,
23
- Eq,
24
- FieldDiv,
25
- GetContractInstance,
26
- GetEnvVar,
27
- Instruction,
28
- InternalCall,
29
- InternalReturn,
30
- Jump,
31
- JumpI,
32
- KeccakF1600,
33
- L1ToL2MessageExists,
34
- Lt,
35
- Lte,
36
- Mov,
37
- Mul,
38
- Not,
39
- NoteHashExists,
40
- NullifierExists,
41
- Or,
42
- Poseidon2,
43
- Return,
44
- ReturndataCopy,
45
- ReturndataSize,
46
- Revert,
47
- SLoad,
48
- SStore,
49
- SendL2ToL1Message,
50
- Set,
51
- Sha256Compression,
52
- Shl,
53
- Shr,
54
- StaticCall,
55
- Sub,
56
- SuccessCopy,
57
- ToRadixBE,
58
- Xor,
59
- } from '../opcodes/index.js';
60
- import { BufferCursor } from './buffer_cursor.js';
61
- import { MAX_OPCODE_VALUE, Opcode } from './instruction_serialization.js';
62
-
63
- export type InstructionDeserializer = (buf: BufferCursor | Buffer) => Instruction;
64
-
65
- export interface Deserializable {
66
- deserialize: InstructionDeserializer;
67
- }
68
-
69
- export type InstructionSet = Map<Opcode, InstructionDeserializer>;
70
- export const INSTRUCTION_SET = new Map<Opcode, InstructionDeserializer>([
71
- [Opcode.ADD_8, Add.as(Add.wireFormat8).fromBuffer],
72
- [Opcode.ADD_16, Add.as(Add.wireFormat16).fromBuffer],
73
- [Opcode.SUB_8, Sub.as(Sub.wireFormat8).fromBuffer],
74
- [Opcode.SUB_16, Sub.as(Sub.wireFormat16).fromBuffer],
75
- [Opcode.MUL_8, Mul.as(Mul.wireFormat8).fromBuffer],
76
- [Opcode.MUL_16, Mul.as(Mul.wireFormat16).fromBuffer],
77
- [Opcode.DIV_8, Div.as(Div.wireFormat8).fromBuffer],
78
- [Opcode.DIV_16, Div.as(Div.wireFormat16).fromBuffer],
79
- [Opcode.FDIV_8, FieldDiv.as(FieldDiv.wireFormat8).fromBuffer],
80
- [Opcode.FDIV_16, FieldDiv.as(FieldDiv.wireFormat16).fromBuffer],
81
- [Opcode.EQ_8, Eq.as(Eq.wireFormat8).fromBuffer],
82
- [Opcode.EQ_16, Eq.as(Eq.wireFormat16).fromBuffer],
83
- [Opcode.LT_8, Lt.as(Lt.wireFormat8).fromBuffer],
84
- [Opcode.LT_16, Lt.as(Lt.wireFormat16).fromBuffer],
85
- [Opcode.LTE_8, Lte.as(Lte.wireFormat8).fromBuffer],
86
- [Opcode.LTE_16, Lte.as(Lte.wireFormat16).fromBuffer],
87
- [Opcode.AND_8, And.as(And.wireFormat8).fromBuffer],
88
- [Opcode.AND_16, And.as(And.wireFormat16).fromBuffer],
89
- [Opcode.OR_8, Or.as(Or.wireFormat8).fromBuffer],
90
- [Opcode.OR_16, Or.as(Or.wireFormat16).fromBuffer],
91
- [Opcode.XOR_8, Xor.as(Xor.wireFormat8).fromBuffer],
92
- [Opcode.XOR_16, Xor.as(Xor.wireFormat16).fromBuffer],
93
- [Opcode.NOT_8, Not.as(Not.wireFormat8).fromBuffer],
94
- [Opcode.NOT_16, Not.as(Not.wireFormat16).fromBuffer],
95
- [Opcode.SHL_8, Shl.as(Shl.wireFormat8).fromBuffer],
96
- [Opcode.SHL_16, Shl.as(Shl.wireFormat16).fromBuffer],
97
- [Opcode.SHR_8, Shr.as(Shr.wireFormat8).fromBuffer],
98
- [Opcode.SHR_16, Shr.as(Shr.wireFormat16).fromBuffer],
99
- [Opcode.CAST_8, Cast.as(Cast.wireFormat8).fromBuffer],
100
- [Opcode.CAST_16, Cast.as(Cast.wireFormat16).fromBuffer],
101
- // Execution Environment
102
- [Opcode.GETENVVAR_16, GetEnvVar.as(GetEnvVar.wireFormat16).fromBuffer],
103
- [CalldataCopy.opcode, Instruction.fromBuffer.bind(CalldataCopy)],
104
- [SuccessCopy.opcode, Instruction.fromBuffer.bind(SuccessCopy)],
105
- [Opcode.RETURNDATASIZE, Instruction.fromBuffer.bind(ReturndataSize)],
106
- [Opcode.RETURNDATACOPY, Instruction.fromBuffer.bind(ReturndataCopy)],
107
-
108
- // Machine State - Internal Control Flow
109
- [Jump.opcode, Instruction.fromBuffer.bind(Jump)],
110
- [JumpI.opcode, Instruction.fromBuffer.bind(JumpI)],
111
- [InternalCall.opcode, Instruction.fromBuffer.bind(InternalCall)],
112
- [InternalReturn.opcode, Instruction.fromBuffer.bind(InternalReturn)],
113
- [Opcode.SET_8, Set.as(Set.wireFormat8).fromBuffer],
114
- [Opcode.SET_16, Set.as(Set.wireFormat16).fromBuffer],
115
- [Opcode.SET_32, Set.as(Set.wireFormat32).fromBuffer],
116
- [Opcode.SET_64, Set.as(Set.wireFormat64).fromBuffer],
117
- [Opcode.SET_128, Set.as(Set.wireFormat128).fromBuffer],
118
- [Opcode.SET_FF, Set.as(Set.wireFormatFF).fromBuffer],
119
- [Opcode.MOV_8, Mov.as(Mov.wireFormat8).fromBuffer],
120
- [Opcode.MOV_16, Mov.as(Mov.wireFormat16).fromBuffer],
121
-
122
- // World State
123
- [SLoad.opcode, Instruction.fromBuffer.bind(SLoad)], // Public Storage
124
- [SStore.opcode, Instruction.fromBuffer.bind(SStore)], // Public Storage
125
- [NoteHashExists.opcode, Instruction.fromBuffer.bind(NoteHashExists)], // Notes & Nullifiers
126
- [EmitNoteHash.opcode, Instruction.fromBuffer.bind(EmitNoteHash)], // Notes & Nullifiers
127
- [NullifierExists.opcode, Instruction.fromBuffer.bind(NullifierExists)], // Notes & Nullifiers
128
- [EmitNullifier.opcode, Instruction.fromBuffer.bind(EmitNullifier)], // Notes & Nullifiers
129
- [L1ToL2MessageExists.opcode, Instruction.fromBuffer.bind(L1ToL2MessageExists)], // Messages
130
-
131
- // Accrued Substate
132
- [EmitUnencryptedLog.opcode, Instruction.fromBuffer.bind(EmitUnencryptedLog)],
133
- [SendL2ToL1Message.opcode, Instruction.fromBuffer.bind(SendL2ToL1Message)],
134
- [GetContractInstance.opcode, Instruction.fromBuffer.bind(GetContractInstance)],
135
-
136
- // Control Flow - Contract Calls
137
- [Call.opcode, Instruction.fromBuffer.bind(Call)],
138
- [StaticCall.opcode, Instruction.fromBuffer.bind(StaticCall)],
139
- [Return.opcode, Instruction.fromBuffer.bind(Return)],
140
- [Opcode.REVERT_8, Revert.as(Revert.wireFormat8).fromBuffer],
141
- [Opcode.REVERT_16, Revert.as(Revert.wireFormat16).fromBuffer],
142
-
143
- // Misc
144
- [DebugLog.opcode, Instruction.fromBuffer.bind(DebugLog)],
145
-
146
- // Gadgets
147
- [EcAdd.opcode, Instruction.fromBuffer.bind(EcAdd)],
148
- [Poseidon2.opcode, Instruction.fromBuffer.bind(Poseidon2)],
149
- [Sha256Compression.opcode, Instruction.fromBuffer.bind(Sha256Compression)],
150
- [KeccakF1600.opcode, Instruction.fromBuffer.bind(KeccakF1600)],
151
-
152
- // Conversions
153
- [ToRadixBE.opcode, Instruction.fromBuffer.bind(ToRadixBE)],
154
- ]);
155
-
156
- /**
157
- * Serializes an array of instructions to bytecode.
158
- */
159
- export function encodeToBytecode(instructions: Bufferable[]): Buffer {
160
- return serializeToBuffer(instructions);
161
- }
162
-
163
- // For testing only
164
- export function decodeFromBytecode(bytecode: Buffer, instructionSet: InstructionSet = INSTRUCTION_SET): Instruction[] {
165
- const instructions: Instruction[] = [];
166
- let pc = 0;
167
- while (pc < bytecode.length) {
168
- const [instruction, bytesConsumed] = decodeInstructionFromBytecode(bytecode, pc, instructionSet);
169
- instructions.push(instruction);
170
- pc += bytesConsumed;
171
- }
172
- return instructions;
173
- }
174
-
175
- // Returns the instruction and the number of bytes consumed.
176
- export function decodeInstructionFromBytecode(
177
- bytecode: Buffer,
178
- pc: number,
179
- instructionSet: InstructionSet = INSTRUCTION_SET,
180
- ): [Instruction, number] {
181
- if (pc >= bytecode.length) {
182
- throw new InvalidProgramCounterError(pc, bytecode.length - 1);
183
- }
184
-
185
- try {
186
- const cursor = new BufferCursor(bytecode, pc);
187
- const startingPosition = cursor.position();
188
- const opcode: number = cursor.bufferAtPosition().readUint8(); // peek.
189
-
190
- if (opcode > MAX_OPCODE_VALUE) {
191
- throw new InvalidOpcodeError(
192
- `Opcode ${opcode} (0x${opcode.toString(16)}) value is not in the range of valid opcodes (at PC ${pc}).`,
193
- );
194
- }
195
-
196
- const instructionDeserializerOrUndef = instructionSet.get(opcode);
197
- if (instructionDeserializerOrUndef === undefined) {
198
- throw new InvalidOpcodeError(`Opcode ${Opcode[opcode]} (0x${opcode.toString(16)}) is not implemented`);
199
- }
200
-
201
- const instructionDeserializer: InstructionDeserializer = instructionDeserializerOrUndef;
202
-
203
- const instruction = instructionDeserializer(cursor);
204
- return [instruction, cursor.position() - startingPosition];
205
- } catch (error) {
206
- if (error instanceof InvalidTagValueError || error instanceof InvalidOpcodeError) {
207
- throw duringInstrFetch(error, pc);
208
- } else if (error instanceof AvmExecutionError) {
209
- throw new AvmParsingError(`Instruction parsing error at pc ${pc}: ${error.message}`);
210
- } else {
211
- const msg = error instanceof Error ? `: ${error.message}` : '';
212
- throw new AvmParsingError(`Instruction fetching error at pc ${pc}${msg}`);
213
- }
214
- }
215
- }
@@ -1,249 +0,0 @@
1
- import { Fr } from '@aztec/foundation/curves/bn254';
2
-
3
- import { strict as assert } from 'assert';
4
-
5
- import { TaggedMemory } from '../avm_memory_types.js';
6
- import { BufferCursor } from './buffer_cursor.js';
7
-
8
- /**
9
- * All AVM opcodes. (Keep in sync with cpp counterpart code avm_opcode.hpp and rs in opcodes.rs).
10
- * Source: https://yp-aztec.netlify.app/docs/public-vm/instruction-set
11
- */
12
- export enum Opcode {
13
- // Compute
14
- ADD_8,
15
- ADD_16,
16
- SUB_8,
17
- SUB_16,
18
- MUL_8,
19
- MUL_16,
20
- DIV_8,
21
- DIV_16,
22
- FDIV_8,
23
- FDIV_16,
24
- EQ_8,
25
- EQ_16,
26
- LT_8,
27
- LT_16,
28
- LTE_8,
29
- LTE_16,
30
- AND_8,
31
- AND_16,
32
- OR_8,
33
- OR_16,
34
- XOR_8,
35
- XOR_16,
36
- NOT_8,
37
- NOT_16,
38
- SHL_8,
39
- SHL_16,
40
- SHR_8,
41
- SHR_16,
42
- CAST_8,
43
- CAST_16,
44
- // Execution environment
45
- GETENVVAR_16,
46
- CALLDATACOPY,
47
- SUCCESSCOPY,
48
- RETURNDATASIZE,
49
- RETURNDATACOPY,
50
- // Control flow
51
- JUMP_32,
52
- JUMPI_32,
53
- INTERNALCALL,
54
- INTERNALRETURN,
55
- // Memory
56
- SET_8,
57
- SET_16,
58
- SET_32,
59
- SET_64,
60
- SET_128,
61
- SET_FF,
62
- MOV_8,
63
- MOV_16,
64
- // World state
65
- SLOAD,
66
- SSTORE,
67
- NOTEHASHEXISTS,
68
- EMITNOTEHASH,
69
- NULLIFIEREXISTS,
70
- EMITNULLIFIER,
71
- L1TOL2MSGEXISTS,
72
- GETCONTRACTINSTANCE,
73
- EMITUNENCRYPTEDLOG,
74
- SENDL2TOL1MSG,
75
- // External calls
76
- CALL,
77
- STATICCALL,
78
- RETURN,
79
- REVERT_8,
80
- REVERT_16,
81
- // Misc
82
- DEBUGLOG,
83
- // Gadgets
84
- POSEIDON2,
85
- SHA256COMPRESSION,
86
- KECCAKF1600,
87
- ECADD,
88
- // Conversion
89
- TORADIXBE,
90
- }
91
-
92
- export const MAX_OPCODE_VALUE = Math.max(
93
- ...Object.values(Opcode)
94
- .map(k => +k)
95
- .filter(k => !isNaN(k)),
96
- );
97
-
98
- // Possible types for an instruction's operand in its wire format.
99
- // The counterpart cpp file is: vm2/simulation/lib/serialization.hpp.
100
- export enum OperandType {
101
- UINT8,
102
- UINT16,
103
- UINT32,
104
- UINT64,
105
- UINT128,
106
- FF,
107
- TAG,
108
- }
109
-
110
- // Define a type that represents the possible types of the deserialized values.
111
- type DeserializedValue = number | bigint;
112
-
113
- type OperandNativeType = number | bigint;
114
- type OperandWriter = (value: any) => void;
115
-
116
- // Specifies how to read and write each operand type.
117
- const OPERAND_SPEC = new Map<OperandType, [number, (offset: number) => OperandNativeType, OperandWriter]>([
118
- [OperandType.UINT8, [1, Buffer.prototype.readUint8, Buffer.prototype.writeUint8]],
119
- [OperandType.UINT16, [2, Buffer.prototype.readUint16BE, Buffer.prototype.writeUint16BE]],
120
- [OperandType.UINT32, [4, Buffer.prototype.readUint32BE, Buffer.prototype.writeUint32BE]],
121
- [OperandType.UINT64, [8, readUint64BE, writeUint64BE]],
122
- [OperandType.UINT128, [16, readUint128BE, writeUint128BE]],
123
- [OperandType.FF, [32, readUint254BE, writeUint254BE]],
124
- [OperandType.TAG, [1, Buffer.prototype.readUint8, Buffer.prototype.writeUint8]],
125
- ]);
126
-
127
- /**
128
- * Returns the size of an operand in bytes.
129
- * Should not be called with unknown operand types.
130
- * @param operandType
131
- * @returns number size in bytes
132
- * @throws AssertionError if the operand type is unknown
133
- */
134
- export function getOperandSize(operandType: OperandType): number {
135
- assert(OPERAND_SPEC.has(operandType), `Unknown operand type: ${operandType}`);
136
- return OPERAND_SPEC.get(operandType)![0];
137
- }
138
-
139
- function readUintBE(buf: Buffer, offset: number, totalBytes: number): bigint {
140
- let value: bigint = 0n;
141
- for (let i = 0; i < totalBytes; ++i) {
142
- value <<= 8n;
143
- value |= BigInt(buf.readUint8(i + offset));
144
- }
145
- return value;
146
- }
147
-
148
- function writeUintBE(buf: Buffer, value: bigint, totalBytes: number): void {
149
- for (let offset = totalBytes - 1; offset >= 0; --offset) {
150
- buf.writeUint8(Number(value & 0xffn), offset);
151
- value >>= 8n;
152
- }
153
- }
154
-
155
- function readUint64BE(this: Buffer, offset: number): bigint {
156
- return readUintBE(this, offset, 8);
157
- }
158
-
159
- function writeUint64BE(this: Buffer, value: bigint): void {
160
- writeUintBE(this, value, 8);
161
- }
162
-
163
- function readUint254BE(this: Buffer, offset: number): bigint {
164
- let value = readUintBE(this, offset, 32);
165
-
166
- // In circuit, we only support values up to Fr.MODULUS and any deserialized value
167
- // would naturally undergo a modulus reduction.
168
- if (value >= Fr.MODULUS) {
169
- value = value % Fr.MODULUS;
170
- }
171
-
172
- return value;
173
- }
174
-
175
- function writeUint254BE(this: Buffer, value: bigint): void {
176
- writeUintBE(this, value, 32);
177
- }
178
-
179
- function readUint128BE(this: Buffer, offset: number): bigint {
180
- return readUintBE(this, offset, 16);
181
- }
182
-
183
- function writeUint128BE(this: Buffer, value: bigint): void {
184
- writeUintBE(this, value, 16);
185
- }
186
-
187
- /**
188
- * Reads an array of operands from a buffer.
189
- * @param cursor Buffer to read from. Might be longer than needed.
190
- * @param operands Specification of the operand types.
191
- * @returns An array as big as {@code operands}, with the converted TS values.
192
- */
193
- export function deserialize(cursor: BufferCursor | Buffer, operands: OperandType[]): DeserializedValue[] {
194
- const argValues: DeserializedValue[] = [];
195
- if (Buffer.isBuffer(cursor)) {
196
- cursor = new BufferCursor(cursor);
197
- }
198
-
199
- for (const opType of operands) {
200
- const [sizeBytes, reader, _writer] = OPERAND_SPEC.get(opType)!;
201
- const value = reader.call(cursor.buffer(), cursor.position());
202
- argValues.push(value);
203
- cursor.advance(sizeBytes);
204
- }
205
-
206
- // We first want to detect other parsing errors (e.g., instruction size
207
- // is longer than remaining bytes) first and therefore tag validation is done after completion
208
- // of parsing above. Order of errors need to match with circuit.
209
- for (let i = 0; i < operands.length; i++) {
210
- if (operands[i] === OperandType.TAG) {
211
- // We parsed a single byte (readUInt8()) and therefore value is of number type (not bigint)
212
- // We need to cast to number because checkIsValidTag expects a number.
213
- TaggedMemory.checkIsValidTag(Number(argValues[i] ?? 0));
214
- }
215
- }
216
-
217
- return argValues;
218
- }
219
-
220
- /**
221
- * Serializes a class using the specified operand types.
222
- * More specifically, this serializes {@code [cls.constructor.opcode, ...Object.values(cls)]}.
223
- * Observe in particular that:
224
- * (1) the first operand type specified must correspond to the opcode;
225
- * (2) the rest of the operand types must be specified in the order returned by {@code Object.values()}.
226
- * @param operands Type specification for the values to be serialized.
227
- * @param cls The class to be serialized.
228
- * @returns
229
- */
230
- export function serializeAs(operands: OperandType[], opcode: Opcode, cls: any): Buffer {
231
- const chunks: Buffer[] = [];
232
-
233
- const rawClassValues: any[] = [opcode, ...Object.values(cls)];
234
- assert(
235
- rawClassValues.length === operands.length,
236
- `Got ${rawClassValues.length} values but only ${operands.length} serialization operands are specified!`,
237
- );
238
- const classValues = rawClassValues as OperandNativeType[];
239
-
240
- for (let i = 0; i < operands.length; i++) {
241
- const opType = operands[i];
242
- const [sizeBytes, _reader, writer] = OPERAND_SPEC.get(opType)!;
243
- const buf = Buffer.alloc(sizeBytes);
244
- writer.call(buf, classValues[i]);
245
- chunks.push(buf);
246
- }
247
-
248
- return Buffer.concat(chunks);
249
- }
@@ -1,64 +0,0 @@
1
- import { Fr } from '@aztec/foundation/curves/bn254';
2
- import type { ContractClassPublic, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
3
-
4
- import type { jest } from '@jest/globals';
5
- import { mock } from 'jest-mock-extended';
6
-
7
- import type { PublicContractsDB, PublicTreesDB } from '../public_db_sources.js';
8
- import type { PublicSideEffectTraceInterface } from '../side_effect_trace_interface.js';
9
-
10
- export function mockTraceFork(trace: PublicSideEffectTraceInterface, nestedTrace?: PublicSideEffectTraceInterface) {
11
- (trace as jest.Mocked<PublicSideEffectTraceInterface>).fork.mockReturnValue(
12
- nestedTrace ?? mock<PublicSideEffectTraceInterface>(),
13
- );
14
- }
15
-
16
- export function mockStorageRead(worldStateDB: PublicTreesDB, value: Fr) {
17
- (worldStateDB as jest.Mocked<PublicTreesDB>).storageRead.mockResolvedValue(value);
18
- }
19
-
20
- export function mockNoteHashCount(mockedTrace: PublicSideEffectTraceInterface, count: number) {
21
- (mockedTrace as jest.Mocked<PublicSideEffectTraceInterface>).getNoteHashCount.mockReturnValue(count);
22
- }
23
-
24
- export function mockStorageReadWithMap(worldStateDB: PublicTreesDB, mockedStorage: Map<bigint, Fr>) {
25
- (worldStateDB as jest.Mocked<PublicTreesDB>).storageRead.mockImplementation((_address, slot) =>
26
- Promise.resolve(mockedStorage.get(slot.toBigInt()) ?? Fr.ZERO),
27
- );
28
- }
29
-
30
- export function mockGetNoteHash(worldStateDB: PublicTreesDB, _leafIndex: bigint, value?: Fr) {
31
- (worldStateDB as jest.Mocked<PublicTreesDB>).getNoteHash.mockImplementation((index: bigint) => {
32
- if (index == _leafIndex && value) {
33
- return Promise.resolve(value);
34
- } else {
35
- return Promise.resolve(Fr.ZERO);
36
- }
37
- });
38
- }
39
-
40
- export function mockCheckNullifierExists(worldStateDB: PublicTreesDB, exists: boolean, _ignoredValue?: Fr) {
41
- (worldStateDB as jest.Mocked<PublicTreesDB>).checkNullifierExists.mockResolvedValue(exists);
42
- }
43
-
44
- export function mockGetL1ToL2LeafValue(worldStateDB: PublicTreesDB, leafIndex: bigint, value?: Fr) {
45
- (worldStateDB as jest.Mocked<PublicTreesDB>).getL1ToL2LeafValue.mockImplementation((index: bigint) => {
46
- if (index == leafIndex && value) {
47
- return Promise.resolve(value);
48
- } else {
49
- return Promise.resolve(Fr.ZERO!);
50
- }
51
- });
52
- }
53
-
54
- export function mockGetContractInstance(contractsDB: PublicContractsDB, contractInstance: ContractInstanceWithAddress) {
55
- (contractsDB as jest.Mocked<PublicContractsDB>).getContractInstance.mockResolvedValue(contractInstance);
56
- }
57
-
58
- export function mockGetContractClass(contractsDB: PublicContractsDB, contractClass: ContractClassPublic) {
59
- (contractsDB as jest.Mocked<PublicContractsDB>).getContractClass.mockResolvedValue(contractClass);
60
- }
61
-
62
- export function mockGetBytecodeCommitment(contractsDB: PublicContractsDB, commitment: Fr) {
63
- (contractsDB as jest.Mocked<PublicContractsDB>).getBytecodeCommitment.mockResolvedValue(commitment);
64
- }
@@ -1,52 +0,0 @@
1
- import { FunctionSelector } from '@aztec/stdlib/abi';
2
- import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
-
4
- import type { CallData } from './avm/calldata.js';
5
- import type { PublicContractsDBInterface } from './db_interfaces.js';
6
-
7
- export async function getPublicFunctionDebugName(
8
- db: PublicContractsDBInterface,
9
- contractAddress: AztecAddress,
10
- calldata: CallData,
11
- ): Promise<string> {
12
- // Public function is dispatched and therefore the target function is passed in the first argument.
13
- const selectorField = calldata.read(0);
14
- if (!selectorField) {
15
- return `<calldata[0] undefined> (Contract Address: ${contractAddress})`;
16
- }
17
- const fallbackName = `<calldata[0]:${selectorField.toString()}> (Contract Address: ${contractAddress})`;
18
- const selector = FunctionSelector.fromFieldOrUndefined(selectorField);
19
- if (!selector) {
20
- return fallbackName;
21
- }
22
- return (await db.getDebugFunctionName(contractAddress, selector)) ?? fallbackName;
23
- }
24
-
25
- /**
26
- * Get the function selector and optional debug name for a public function.
27
- * Returns the selector and name separately, with name only populated if a debug name is available.
28
- * @param db - The contracts database
29
- * @param contractAddress - The contract address
30
- * @param calldata - The calldata (selector is in calldata[0])
31
- * @returns An object with functionSelector (always if calldata[0] exists) and functionName (only if debug name found)
32
- */
33
- export async function getPublicFunctionSelectorAndName(
34
- db: PublicContractsDBInterface,
35
- contractAddress: AztecAddress,
36
- calldata: CallData,
37
- ): Promise<{ functionSelector?: FunctionSelector; functionName?: string }> {
38
- // Public function is dispatched and therefore the target function is passed in the first argument.
39
- const selectorField = calldata.read(0);
40
- if (!selectorField) {
41
- return {};
42
- }
43
- const selector = FunctionSelector.fromFieldOrUndefined(selectorField);
44
- if (!selector) {
45
- return {};
46
- }
47
- const debugName = await db.getDebugFunctionName(contractAddress, selector);
48
- return {
49
- functionSelector: selector,
50
- functionName: debugName ?? undefined,
51
- };
52
- }