@aztec/simulator 0.0.0-test.0

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 (367) hide show
  1. package/README.md +49 -0
  2. package/dest/client.d.ts +5 -0
  3. package/dest/client.d.ts.map +1 -0
  4. package/dest/client.js +3 -0
  5. package/dest/common/db_interfaces.d.ts +80 -0
  6. package/dest/common/db_interfaces.d.ts.map +1 -0
  7. package/dest/common/db_interfaces.js +1 -0
  8. package/dest/common/debug_fn_name.d.ts +5 -0
  9. package/dest/common/debug_fn_name.d.ts.map +1 -0
  10. package/dest/common/debug_fn_name.js +6 -0
  11. package/dest/common/errors.d.ts +54 -0
  12. package/dest/common/errors.d.ts.map +1 -0
  13. package/dest/common/errors.js +135 -0
  14. package/dest/common/index.d.ts +4 -0
  15. package/dest/common/index.d.ts.map +1 -0
  16. package/dest/common/index.js +3 -0
  17. package/dest/common/message_load_oracle_inputs.d.ts +15 -0
  18. package/dest/common/message_load_oracle_inputs.d.ts.map +1 -0
  19. package/dest/common/message_load_oracle_inputs.js +15 -0
  20. package/dest/common/stats/index.d.ts +2 -0
  21. package/dest/common/stats/index.d.ts.map +1 -0
  22. package/dest/common/stats/index.js +1 -0
  23. package/dest/common/stats/stats.d.ts +4 -0
  24. package/dest/common/stats/stats.d.ts.map +1 -0
  25. package/dest/common/stats/stats.js +10 -0
  26. package/dest/private/acvm/acvm.d.ts +35 -0
  27. package/dest/private/acvm/acvm.d.ts.map +1 -0
  28. package/dest/private/acvm/acvm.js +70 -0
  29. package/dest/private/acvm/acvm_types.d.ts +10 -0
  30. package/dest/private/acvm/acvm_types.d.ts.map +1 -0
  31. package/dest/private/acvm/acvm_types.js +3 -0
  32. package/dest/private/acvm/deserialize.d.ts +36 -0
  33. package/dest/private/acvm/deserialize.d.ts.map +1 -0
  34. package/dest/private/acvm/deserialize.js +42 -0
  35. package/dest/private/acvm/index.d.ts +6 -0
  36. package/dest/private/acvm/index.d.ts.map +1 -0
  37. package/dest/private/acvm/index.js +5 -0
  38. package/dest/private/acvm/oracle/index.d.ts +14 -0
  39. package/dest/private/acvm/oracle/index.d.ts.map +1 -0
  40. package/dest/private/acvm/oracle/index.js +2 -0
  41. package/dest/private/acvm/oracle/oracle.d.ts +49 -0
  42. package/dest/private/acvm/oracle/oracle.d.ts.map +1 -0
  43. package/dest/private/acvm/oracle/oracle.js +263 -0
  44. package/dest/private/acvm/oracle/typed_oracle.d.ts +83 -0
  45. package/dest/private/acvm/oracle/typed_oracle.d.ts.map +1 -0
  46. package/dest/private/acvm/oracle/typed_oracle.js +132 -0
  47. package/dest/private/acvm/serialize.d.ts +24 -0
  48. package/dest/private/acvm/serialize.d.ts.map +1 -0
  49. package/dest/private/acvm/serialize.js +46 -0
  50. package/dest/private/execution_data_provider.d.ts +261 -0
  51. package/dest/private/execution_data_provider.d.ts.map +1 -0
  52. package/dest/private/execution_data_provider.js +14 -0
  53. package/dest/private/execution_note_cache.d.ts +93 -0
  54. package/dest/private/execution_note_cache.d.ts.map +1 -0
  55. package/dest/private/execution_note_cache.js +180 -0
  56. package/dest/private/hashed_values_cache.d.ts +28 -0
  57. package/dest/private/hashed_values_cache.d.ts.map +1 -0
  58. package/dest/private/hashed_values_cache.js +46 -0
  59. package/dest/private/index.d.ts +13 -0
  60. package/dest/private/index.d.ts.map +1 -0
  61. package/dest/private/index.js +12 -0
  62. package/dest/private/pick_notes.d.ts +85 -0
  63. package/dest/private/pick_notes.d.ts.map +1 -0
  64. package/dest/private/pick_notes.js +51 -0
  65. package/dest/private/private_execution.d.ts +25 -0
  66. package/dest/private/private_execution.d.ts.map +1 -0
  67. package/dest/private/private_execution.js +92 -0
  68. package/dest/private/private_execution_oracle.d.ts +215 -0
  69. package/dest/private/private_execution_oracle.d.ts.map +1 -0
  70. package/dest/private/private_execution_oracle.js +382 -0
  71. package/dest/private/providers/acvm_native.d.ts +40 -0
  72. package/dest/private/providers/acvm_native.d.ts.map +1 -0
  73. package/dest/private/providers/acvm_native.js +139 -0
  74. package/dest/private/providers/acvm_wasm.d.ts +15 -0
  75. package/dest/private/providers/acvm_wasm.d.ts.map +1 -0
  76. package/dest/private/providers/acvm_wasm.js +62 -0
  77. package/dest/private/providers/acvm_wasm_with_blobs.d.ts +19 -0
  78. package/dest/private/providers/acvm_wasm_with_blobs.d.ts.map +1 -0
  79. package/dest/private/providers/acvm_wasm_with_blobs.js +32 -0
  80. package/dest/private/providers/factory.d.ts +12 -0
  81. package/dest/private/providers/factory.d.ts.map +1 -0
  82. package/dest/private/providers/factory.js +27 -0
  83. package/dest/private/providers/simulation_provider.d.ts +19 -0
  84. package/dest/private/providers/simulation_provider.d.ts.map +1 -0
  85. package/dest/private/providers/simulation_provider.js +24 -0
  86. package/dest/private/simulator.d.ts +34 -0
  87. package/dest/private/simulator.d.ts.map +1 -0
  88. package/dest/private/simulator.js +76 -0
  89. package/dest/private/unconstrained_execution.d.ts +10 -0
  90. package/dest/private/unconstrained_execution.d.ts.map +1 -0
  91. package/dest/private/unconstrained_execution.js +27 -0
  92. package/dest/private/unconstrained_execution_oracle.d.ts +161 -0
  93. package/dest/private/unconstrained_execution_oracle.d.ts.map +1 -0
  94. package/dest/private/unconstrained_execution_oracle.js +258 -0
  95. package/dest/public/avm/avm_context.d.ts +41 -0
  96. package/dest/public/avm/avm_context.d.ts.map +1 -0
  97. package/dest/public/avm/avm_context.js +44 -0
  98. package/dest/public/avm/avm_contract_call_result.d.ts +30 -0
  99. package/dest/public/avm/avm_contract_call_result.d.ts.map +1 -0
  100. package/dest/public/avm/avm_contract_call_result.js +50 -0
  101. package/dest/public/avm/avm_execution_environment.d.ts +21 -0
  102. package/dest/public/avm/avm_execution_environment.d.ts.map +1 -0
  103. package/dest/public/avm/avm_execution_environment.js +31 -0
  104. package/dest/public/avm/avm_gas.d.ts +60 -0
  105. package/dest/public/avm/avm_gas.d.ts.map +1 -0
  106. package/dest/public/avm/avm_gas.js +203 -0
  107. package/dest/public/avm/avm_machine_state.d.ts +95 -0
  108. package/dest/public/avm/avm_machine_state.d.ts.map +1 -0
  109. package/dest/public/avm/avm_machine_state.js +107 -0
  110. package/dest/public/avm/avm_memory_types.d.ts +264 -0
  111. package/dest/public/avm/avm_memory_types.d.ts.map +1 -0
  112. package/dest/public/avm/avm_memory_types.js +340 -0
  113. package/dest/public/avm/avm_simulator.d.ts +40 -0
  114. package/dest/public/avm/avm_simulator.d.ts.map +1 -0
  115. package/dest/public/avm/avm_simulator.js +202 -0
  116. package/dest/public/avm/bytecode_utils.d.ts +5 -0
  117. package/dest/public/avm/bytecode_utils.d.ts.map +1 -0
  118. package/dest/public/avm/bytecode_utils.js +17 -0
  119. package/dest/public/avm/errors.d.ts +122 -0
  120. package/dest/public/avm/errors.d.ts.map +1 -0
  121. package/dest/public/avm/errors.js +179 -0
  122. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +21 -0
  123. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +1 -0
  124. package/dest/public/avm/fixtures/avm_simulation_tester.js +76 -0
  125. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts +36 -0
  126. package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map +1 -0
  127. package/dest/public/avm/fixtures/base_avm_simulation_tester.js +83 -0
  128. package/dest/public/avm/fixtures/index.d.ts +84 -0
  129. package/dest/public/avm/fixtures/index.d.ts.map +1 -0
  130. package/dest/public/avm/fixtures/index.js +175 -0
  131. package/dest/public/avm/fixtures/simple_contract_data_source.d.ts +35 -0
  132. package/dest/public/avm/fixtures/simple_contract_data_source.d.ts.map +1 -0
  133. package/dest/public/avm/fixtures/simple_contract_data_source.js +74 -0
  134. package/dest/public/avm/index.d.ts +4 -0
  135. package/dest/public/avm/index.d.ts.map +1 -0
  136. package/dest/public/avm/index.js +3 -0
  137. package/dest/public/avm/journal/index.d.ts +2 -0
  138. package/dest/public/avm/journal/index.d.ts.map +1 -0
  139. package/dest/public/avm/journal/index.js +1 -0
  140. package/dest/public/avm/journal/journal.d.ts +209 -0
  141. package/dest/public/avm/journal/journal.d.ts.map +1 -0
  142. package/dest/public/avm/journal/journal.js +486 -0
  143. package/dest/public/avm/journal/nullifiers.d.ts +64 -0
  144. package/dest/public/avm/journal/nullifiers.d.ts.map +1 -0
  145. package/dest/public/avm/journal/nullifiers.js +97 -0
  146. package/dest/public/avm/journal/public_storage.d.ts +66 -0
  147. package/dest/public/avm/journal/public_storage.d.ts.map +1 -0
  148. package/dest/public/avm/journal/public_storage.js +145 -0
  149. package/dest/public/avm/opcodes/accrued_substate.d.ts +75 -0
  150. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +1 -0
  151. package/dest/public/avm/opcodes/accrued_substate.js +252 -0
  152. package/dest/public/avm/opcodes/addressing_mode.d.ts +27 -0
  153. package/dest/public/avm/opcodes/addressing_mode.d.ts.map +1 -0
  154. package/dest/public/avm/opcodes/addressing_mode.js +74 -0
  155. package/dest/public/avm/opcodes/arithmetic.d.ts +37 -0
  156. package/dest/public/avm/opcodes/arithmetic.d.ts.map +1 -0
  157. package/dest/public/avm/opcodes/arithmetic.js +73 -0
  158. package/dest/public/avm/opcodes/bitwise.d.ts +50 -0
  159. package/dest/public/avm/opcodes/bitwise.d.ts.map +1 -0
  160. package/dest/public/avm/opcodes/bitwise.js +106 -0
  161. package/dest/public/avm/opcodes/comparators.d.ts +25 -0
  162. package/dest/public/avm/opcodes/comparators.d.ts.map +1 -0
  163. package/dest/public/avm/opcodes/comparators.js +43 -0
  164. package/dest/public/avm/opcodes/contract.d.ts +21 -0
  165. package/dest/public/avm/opcodes/contract.d.ts.map +1 -0
  166. package/dest/public/avm/opcodes/contract.js +66 -0
  167. package/dest/public/avm/opcodes/control_flow.d.ts +41 -0
  168. package/dest/public/avm/opcodes/control_flow.d.ts.map +1 -0
  169. package/dest/public/avm/opcodes/control_flow.js +105 -0
  170. package/dest/public/avm/opcodes/conversion.d.ts +17 -0
  171. package/dest/public/avm/opcodes/conversion.d.ts.map +1 -0
  172. package/dest/public/avm/opcodes/conversion.js +69 -0
  173. package/dest/public/avm/opcodes/ec_add.d.ts +19 -0
  174. package/dest/public/avm/opcodes/ec_add.d.ts.map +1 -0
  175. package/dest/public/avm/opcodes/ec_add.js +84 -0
  176. package/dest/public/avm/opcodes/environment_getters.d.ts +28 -0
  177. package/dest/public/avm/opcodes/environment_getters.d.ts.map +1 -0
  178. package/dest/public/avm/opcodes/environment_getters.js +79 -0
  179. package/dest/public/avm/opcodes/external_calls.d.ts +58 -0
  180. package/dest/public/avm/opcodes/external_calls.d.ts.map +1 -0
  181. package/dest/public/avm/opcodes/external_calls.js +204 -0
  182. package/dest/public/avm/opcodes/hashing.d.ts +36 -0
  183. package/dest/public/avm/opcodes/hashing.d.ts.map +1 -0
  184. package/dest/public/avm/opcodes/hashing.js +114 -0
  185. package/dest/public/avm/opcodes/index.d.ts +16 -0
  186. package/dest/public/avm/opcodes/index.d.ts.map +1 -0
  187. package/dest/public/avm/opcodes/index.js +15 -0
  188. package/dest/public/avm/opcodes/instruction.d.ts +70 -0
  189. package/dest/public/avm/opcodes/instruction.d.ts.map +1 -0
  190. package/dest/public/avm/opcodes/instruction.js +91 -0
  191. package/dest/public/avm/opcodes/instruction_impl.d.ts +19 -0
  192. package/dest/public/avm/opcodes/instruction_impl.d.ts.map +1 -0
  193. package/dest/public/avm/opcodes/instruction_impl.js +30 -0
  194. package/dest/public/avm/opcodes/memory.d.ts +74 -0
  195. package/dest/public/avm/opcodes/memory.d.ts.map +1 -0
  196. package/dest/public/avm/opcodes/memory.js +253 -0
  197. package/dest/public/avm/opcodes/misc.d.ts +17 -0
  198. package/dest/public/avm/opcodes/misc.d.ts.map +1 -0
  199. package/dest/public/avm/opcodes/misc.js +48 -0
  200. package/dest/public/avm/opcodes/storage.d.ts +24 -0
  201. package/dest/public/avm/opcodes/storage.d.ts.map +1 -0
  202. package/dest/public/avm/opcodes/storage.js +66 -0
  203. package/dest/public/avm/serialization/buffer_cursor.d.ts +28 -0
  204. package/dest/public/avm/serialization/buffer_cursor.d.ts.map +1 -0
  205. package/dest/public/avm/serialization/buffer_cursor.js +99 -0
  206. package/dest/public/avm/serialization/bytecode_serialization.d.ts +21 -0
  207. package/dest/public/avm/serialization/bytecode_serialization.d.ts.map +1 -0
  208. package/dest/public/avm/serialization/bytecode_serialization.js +332 -0
  209. package/dest/public/avm/serialization/instruction_serialization.d.ts +105 -0
  210. package/dest/public/avm/serialization/instruction_serialization.d.ts.map +1 -0
  211. package/dest/public/avm/serialization/instruction_serialization.js +226 -0
  212. package/dest/public/avm/test_utils.d.ts +18 -0
  213. package/dest/public/avm/test_utils.d.ts.map +1 -0
  214. package/dest/public/avm/test_utils.js +52 -0
  215. package/dest/public/bytecode_errors.d.ts +4 -0
  216. package/dest/public/bytecode_errors.d.ts.map +1 -0
  217. package/dest/public/bytecode_errors.js +6 -0
  218. package/dest/public/execution.d.ts +108 -0
  219. package/dest/public/execution.d.ts.map +1 -0
  220. package/dest/public/execution.js +9 -0
  221. package/dest/public/executor_metrics.d.ts +13 -0
  222. package/dest/public/executor_metrics.d.ts.map +1 -0
  223. package/dest/public/executor_metrics.js +54 -0
  224. package/dest/public/fixtures/index.d.ts +3 -0
  225. package/dest/public/fixtures/index.d.ts.map +1 -0
  226. package/dest/public/fixtures/index.js +2 -0
  227. package/dest/public/fixtures/public_tx_simulation_tester.d.ts +32 -0
  228. package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map +1 -0
  229. package/dest/public/fixtures/public_tx_simulation_tester.js +93 -0
  230. package/dest/public/fixtures/utils.d.ts +13 -0
  231. package/dest/public/fixtures/utils.d.ts.map +1 -0
  232. package/dest/public/fixtures/utils.js +126 -0
  233. package/dest/public/index.d.ts +10 -0
  234. package/dest/public/index.d.ts.map +1 -0
  235. package/dest/public/index.js +8 -0
  236. package/dest/public/public_db_sources.d.ts +129 -0
  237. package/dest/public/public_db_sources.d.ts.map +1 -0
  238. package/dest/public/public_db_sources.js +264 -0
  239. package/dest/public/public_processor/public_processor.d.ts +74 -0
  240. package/dest/public/public_processor/public_processor.d.ts.map +1 -0
  241. package/dest/public/public_processor/public_processor.js +379 -0
  242. package/dest/public/public_processor/public_processor_metrics.d.ts +27 -0
  243. package/dest/public/public_processor/public_processor_metrics.d.ts.map +1 -0
  244. package/dest/public/public_processor/public_processor_metrics.js +125 -0
  245. package/dest/public/public_tx_simulator/public_tx_context.d.ts +137 -0
  246. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +1 -0
  247. package/dest/public/public_tx_simulator/public_tx_context.js +320 -0
  248. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +102 -0
  249. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -0
  250. package/dest/public/public_tx_simulator/public_tx_simulator.js +334 -0
  251. package/dest/public/side_effect_errors.d.ts +4 -0
  252. package/dest/public/side_effect_errors.d.ts.map +1 -0
  253. package/dest/public/side_effect_errors.js +6 -0
  254. package/dest/public/side_effect_trace.d.ts +132 -0
  255. package/dest/public/side_effect_trace.d.ts.map +1 -0
  256. package/dest/public/side_effect_trace.js +249 -0
  257. package/dest/public/side_effect_trace_interface.d.ts +34 -0
  258. package/dest/public/side_effect_trace_interface.d.ts.map +1 -0
  259. package/dest/public/side_effect_trace_interface.js +1 -0
  260. package/dest/public/tx_contract_cache.d.ts +41 -0
  261. package/dest/public/tx_contract_cache.d.ts.map +1 -0
  262. package/dest/public/tx_contract_cache.js +49 -0
  263. package/dest/public/unique_class_ids.d.ts +37 -0
  264. package/dest/public/unique_class_ids.d.ts.map +1 -0
  265. package/dest/public/unique_class_ids.js +61 -0
  266. package/dest/public/utils.d.ts +5 -0
  267. package/dest/public/utils.d.ts.map +1 -0
  268. package/dest/public/utils.js +35 -0
  269. package/dest/server.d.ts +6 -0
  270. package/dest/server.d.ts.map +1 -0
  271. package/dest/server.js +4 -0
  272. package/dest/test/utils.d.ts +13 -0
  273. package/dest/test/utils.d.ts.map +1 -0
  274. package/dest/test/utils.js +22 -0
  275. package/package.json +104 -0
  276. package/src/client.ts +4 -0
  277. package/src/common/db_interfaces.ts +94 -0
  278. package/src/common/debug_fn_name.ts +18 -0
  279. package/src/common/errors.ts +183 -0
  280. package/src/common/index.ts +3 -0
  281. package/src/common/message_load_oracle_inputs.ts +15 -0
  282. package/src/common/stats/index.ts +1 -0
  283. package/src/common/stats/stats.ts +20 -0
  284. package/src/private/acvm/acvm.ts +127 -0
  285. package/src/private/acvm/acvm_types.ts +11 -0
  286. package/src/private/acvm/deserialize.ts +52 -0
  287. package/src/private/acvm/index.ts +5 -0
  288. package/src/private/acvm/oracle/index.ts +16 -0
  289. package/src/private/acvm/oracle/oracle.ts +455 -0
  290. package/src/private/acvm/oracle/typed_oracle.ts +259 -0
  291. package/src/private/acvm/serialize.ts +60 -0
  292. package/src/private/execution_data_provider.ts +323 -0
  293. package/src/private/execution_note_cache.ts +217 -0
  294. package/src/private/hashed_values_cache.ts +55 -0
  295. package/src/private/index.ts +16 -0
  296. package/src/private/pick_notes.ts +141 -0
  297. package/src/private/private_execution.ts +151 -0
  298. package/src/private/private_execution_oracle.ts +614 -0
  299. package/src/private/providers/acvm_native.ts +171 -0
  300. package/src/private/providers/acvm_wasm.ts +63 -0
  301. package/src/private/providers/acvm_wasm_with_blobs.ts +50 -0
  302. package/src/private/providers/factory.ts +38 -0
  303. package/src/private/providers/simulation_provider.ts +45 -0
  304. package/src/private/simulator.ts +147 -0
  305. package/src/private/unconstrained_execution.ts +50 -0
  306. package/src/private/unconstrained_execution_oracle.ts +373 -0
  307. package/src/public/avm/avm_context.ts +61 -0
  308. package/src/public/avm/avm_contract_call_result.ts +55 -0
  309. package/src/public/avm/avm_execution_environment.ts +39 -0
  310. package/src/public/avm/avm_gas.ts +195 -0
  311. package/src/public/avm/avm_machine_state.ts +164 -0
  312. package/src/public/avm/avm_memory_types.ts +423 -0
  313. package/src/public/avm/avm_simulator.ts +284 -0
  314. package/src/public/avm/bytecode_utils.ts +17 -0
  315. package/src/public/avm/errors.ts +232 -0
  316. package/src/public/avm/fixtures/avm_simulation_tester.ts +105 -0
  317. package/src/public/avm/fixtures/base_avm_simulation_tester.ts +109 -0
  318. package/src/public/avm/fixtures/index.ts +296 -0
  319. package/src/public/avm/fixtures/simple_contract_data_source.ts +105 -0
  320. package/src/public/avm/index.ts +3 -0
  321. package/src/public/avm/journal/index.ts +1 -0
  322. package/src/public/avm/journal/journal.ts +742 -0
  323. package/src/public/avm/journal/nullifiers.ts +109 -0
  324. package/src/public/avm/journal/public_storage.ts +174 -0
  325. package/src/public/avm/opcodes/.eslintrc.cjs +8 -0
  326. package/src/public/avm/opcodes/accrued_substate.ts +253 -0
  327. package/src/public/avm/opcodes/addressing_mode.ts +87 -0
  328. package/src/public/avm/opcodes/arithmetic.ts +95 -0
  329. package/src/public/avm/opcodes/bitwise.ts +109 -0
  330. package/src/public/avm/opcodes/comparators.ts +52 -0
  331. package/src/public/avm/opcodes/contract.ts +72 -0
  332. package/src/public/avm/opcodes/control_flow.ts +114 -0
  333. package/src/public/avm/opcodes/conversion.ts +80 -0
  334. package/src/public/avm/opcodes/ec_add.ts +93 -0
  335. package/src/public/avm/opcodes/environment_getters.ts +82 -0
  336. package/src/public/avm/opcodes/external_calls.ts +228 -0
  337. package/src/public/avm/opcodes/hashing.ts +125 -0
  338. package/src/public/avm/opcodes/index.ts +15 -0
  339. package/src/public/avm/opcodes/instruction.ts +126 -0
  340. package/src/public/avm/opcodes/instruction_impl.ts +36 -0
  341. package/src/public/avm/opcodes/memory.ts +254 -0
  342. package/src/public/avm/opcodes/misc.ts +60 -0
  343. package/src/public/avm/opcodes/storage.ts +71 -0
  344. package/src/public/avm/serialization/buffer_cursor.ts +115 -0
  345. package/src/public/avm/serialization/bytecode_serialization.ts +206 -0
  346. package/src/public/avm/serialization/instruction_serialization.ts +208 -0
  347. package/src/public/avm/test_utils.ts +81 -0
  348. package/src/public/bytecode_errors.ts +6 -0
  349. package/src/public/execution.ts +140 -0
  350. package/src/public/executor_metrics.ts +71 -0
  351. package/src/public/fixtures/index.ts +2 -0
  352. package/src/public/fixtures/public_tx_simulation_tester.ts +179 -0
  353. package/src/public/fixtures/utils.ts +199 -0
  354. package/src/public/index.ts +9 -0
  355. package/src/public/public_db_sources.ts +369 -0
  356. package/src/public/public_processor/public_processor.ts +521 -0
  357. package/src/public/public_processor/public_processor_metrics.ts +154 -0
  358. package/src/public/public_tx_simulator/public_tx_context.ts +504 -0
  359. package/src/public/public_tx_simulator/public_tx_simulator.ts +474 -0
  360. package/src/public/side_effect_errors.ts +6 -0
  361. package/src/public/side_effect_trace.ts +516 -0
  362. package/src/public/side_effect_trace_interface.ts +76 -0
  363. package/src/public/tx_contract_cache.ts +69 -0
  364. package/src/public/unique_class_ids.ts +80 -0
  365. package/src/public/utils.ts +32 -0
  366. package/src/server.ts +5 -0
  367. package/src/test/utils.ts +36 -0
@@ -0,0 +1,109 @@
1
+ import type { Fr } from '@aztec/foundation/fields';
2
+
3
+ import type { WorldStateDB } from '../../public_db_sources.js';
4
+
5
+ /**
6
+ * A class to manage new nullifier staging and existence checks during a contract call's AVM simulation.
7
+ * Maintains a siloed nullifier cache, and ensures that existence checks fall back to the correct source.
8
+ * When a contract call completes, its cached nullifier set can be merged into its parent's.
9
+ */
10
+ export class NullifierManager {
11
+ constructor(
12
+ /** Reference to node storage. Checked on parent cache-miss. */
13
+ private readonly hostNullifiers: WorldStateDB,
14
+ /** Cache of siloed nullifiers. */
15
+ private cache: Set<bigint> = new Set(),
16
+ /** Parent nullifier manager to fall back on */
17
+ private readonly parent?: NullifierManager,
18
+ ) {}
19
+
20
+ /**
21
+ * Create a new nullifiers manager forked from this one
22
+ */
23
+ public fork() {
24
+ return new NullifierManager(this.hostNullifiers, new Set(), this);
25
+ }
26
+
27
+ /**
28
+ * Get a nullifier's existence in this' cache or parent's (recursively).
29
+ * DOES NOT CHECK HOST STORAGE!
30
+ * @param siloedNullifier - the nullifier to check for
31
+ * @returns exists: whether the nullifier exists in cache here or in parent's
32
+ */
33
+ private checkExistsHereOrParent(siloedNullifier: Fr): boolean {
34
+ // First check this cache
35
+ let existsAsPending = this.cache.has(siloedNullifier.toBigInt());
36
+ // Then try parent's nullifier cache
37
+ if (!existsAsPending && this.parent) {
38
+ // Note: this will recurse to grandparent/etc until a cache-hit is encountered.
39
+ existsAsPending = this.parent.checkExistsHereOrParent(siloedNullifier);
40
+ }
41
+ return existsAsPending;
42
+ }
43
+
44
+ /**
45
+ * Get a nullifier's existence status.
46
+ * 1. Check cache.
47
+ * 2. Check parent cache.
48
+ * 3. Fall back to the host state.
49
+ * 4. Not found! Nullifier does not exist.
50
+ *
51
+ * @param siloedNullifier - the nullifier to check for
52
+ * @returns exists: whether the nullifier exists at all,
53
+ * cacheHit: whether the nullifier was found in a cache,
54
+ */
55
+ public async checkExists(siloedNullifier: Fr): Promise<{ exists: boolean; cacheHit: boolean }> {
56
+ // Check this cache and parent's (recursively)
57
+ const cacheHit = this.checkExistsHereOrParent(siloedNullifier);
58
+ let existsInTree = false;
59
+ if (!cacheHit) {
60
+ // Finally try the host's Aztec state (a trip to the database)
61
+ //const leafOrLowLeafIndex = await this.hostNullifiers.db.getPreviousValueIndex(MerkleTreeId.NULLIFIER_TREE, siloedNullifier.toBigInt());
62
+ //assert(
63
+ // leafOrLowLeafIndex !== undefined,
64
+ // `${MerkleTreeId[MerkleTreeId.NULLIFIER_TREE]} low leaf index should always be found (even if target leaf does not exist)`,
65
+ //);
66
+ //existsInTree = leafOrLowLeafIndex.alreadyPresent;
67
+ const leafIndex = await this.hostNullifiers.getNullifierIndex(siloedNullifier);
68
+ existsInTree = leafIndex !== undefined;
69
+ }
70
+ const exists = cacheHit || existsInTree;
71
+ return Promise.resolve({ exists, cacheHit });
72
+ }
73
+
74
+ /**
75
+ * Stage a new nullifier (append it to the cache).
76
+ *
77
+ * @param siloedNullifier - the nullifier to stage
78
+ */
79
+ public async append(siloedNullifier: Fr) {
80
+ const { exists } = await this.checkExists(siloedNullifier);
81
+ if (exists) {
82
+ throw new NullifierCollisionError(`Siloed nullifier ${siloedNullifier} already exists in parent cache or host.`);
83
+ }
84
+ this.cache.add(siloedNullifier.toBigInt());
85
+ }
86
+
87
+ /**
88
+ * Merges another nullifier cache into this one.
89
+ *
90
+ * @param incomingNullifiers - the incoming cached nullifiers to merge into this instance's
91
+ */
92
+ public acceptAndMerge(incomingNullifiers: NullifierManager) {
93
+ for (const incomingNullifier of incomingNullifiers.cache) {
94
+ if (this.cache.has(incomingNullifier)) {
95
+ throw new NullifierCollisionError(
96
+ `Failed to merge in fork's cached nullifiers. Siloed nullifier ${incomingNullifier} already exists in parent cache.`,
97
+ );
98
+ }
99
+ }
100
+ this.cache = new Set([...this.cache, ...incomingNullifiers.cache]);
101
+ }
102
+ }
103
+
104
+ export class NullifierCollisionError extends Error {
105
+ constructor(message: string, ...rest: any[]) {
106
+ super(message, ...rest);
107
+ this.name = 'NullifierCollisionError';
108
+ }
109
+ }
@@ -0,0 +1,174 @@
1
+ import { Fr } from '@aztec/foundation/fields';
2
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
+
4
+ import type { PublicStateDB } from '../../../common/db_interfaces.js';
5
+
6
+ type PublicStorageReadResult = {
7
+ value: Fr;
8
+ cached: boolean;
9
+ };
10
+
11
+ /**
12
+ * A class to manage public storage reads and writes during a contract call's AVM simulation.
13
+ * Maintains a storage write cache, and ensures that reads fall back to the correct source.
14
+ * When a contract call completes, its storage cache can be merged into its parent's.
15
+ */
16
+ export class PublicStorage {
17
+ /** Cached storage writes. */
18
+ private readonly cache: PublicStorageCache;
19
+
20
+ constructor(
21
+ /** Reference to node storage. Checked on parent cache-miss. */
22
+ private readonly hostPublicStorage: PublicStateDB,
23
+ /** Parent's storage. Checked on this' cache-miss. */
24
+ private readonly parent?: PublicStorage,
25
+ ) {
26
+ this.cache = new PublicStorageCache();
27
+ }
28
+
29
+ /**
30
+ * Create a new public storage manager forked from this one
31
+ */
32
+ public fork() {
33
+ return new PublicStorage(this.hostPublicStorage, this);
34
+ }
35
+
36
+ /**
37
+ * Read a storage value from this' cache or parent's (recursively).
38
+ * DOES NOT CHECK HOST STORAGE!
39
+ *
40
+ * @param contractAddress - the address of the contract whose storage is being read from
41
+ * @param slot - the slot in the contract's storage being read from
42
+ * @returns value: the latest value written according to this cache or the parent's. undefined on cache miss.
43
+ */
44
+ public readHereOrParent(contractAddress: AztecAddress, slot: Fr): Fr | undefined {
45
+ // First try check this storage cache
46
+ let value = this.cache.read(contractAddress, slot);
47
+ // Then try parent's storage cache
48
+ if (!value && this.parent) {
49
+ // Note: this will recurse to grandparent/etc until a cache-hit is encountered.
50
+ value = this.parent.readHereOrParent(contractAddress, slot);
51
+ }
52
+ return value;
53
+ }
54
+
55
+ /**
56
+ * Read a value from storage.
57
+ * 1. Check cache.
58
+ * 2. Check parent cache.
59
+ * 3. Fall back to the host state.
60
+ * 4. Not found! Value has never been written to before. Flag it as non-existent and return value zero.
61
+ *
62
+ * @param contractAddress - the address of the contract whose storage is being read from
63
+ * @param slot - the slot in the contract's storage being read from
64
+ * @returns exists: whether the slot has EVER been written to before, value: the latest value written to slot, or 0 if never written to before
65
+ */
66
+ public async read(contractAddress: AztecAddress, slot: Fr): Promise<PublicStorageReadResult> {
67
+ let cached = false;
68
+ // Check this cache and parent's (recursively)
69
+ let value = this.readHereOrParent(contractAddress, slot);
70
+ // Finally try the host's Aztec state (a trip to the database)
71
+ if (!value) {
72
+ // This functions returns Fr.ZERO if it has never been written to before
73
+ // we explicity coalesce to Fr.ZERO in case we have some implementations that cause this to return undefined
74
+ value = (await this.hostPublicStorage.storageRead(contractAddress, slot)) ?? Fr.ZERO;
75
+ // TODO(dbanks12): if value retrieved from host storage, we can cache it here
76
+ // any future reads to the same slot can read from cache instead of more expensive
77
+ // DB access
78
+ } else {
79
+ cached = true;
80
+ }
81
+ // if value is Fr.ZERO here, it that means this slot has never been written to!
82
+ return Promise.resolve({ value, cached });
83
+ }
84
+
85
+ /**
86
+ * Stage a storage write.
87
+ *
88
+ * @param contractAddress - the address of the contract whose storage is being written to
89
+ * @param slot - the slot in the contract's storage being written to
90
+ * @param value - the value being written to the slot
91
+ */
92
+ public write(contractAddress: AztecAddress, slot: Fr, value: Fr) {
93
+ this.cache.write(contractAddress, slot, value);
94
+ }
95
+
96
+ /**
97
+ * Merges another PublicStorage's cache (pending writes) into this one.
98
+ *
99
+ * @param incomingPublicStorage - the incoming public storage to merge into this instance's
100
+ */
101
+ public acceptAndMerge(incomingPublicStorage: PublicStorage) {
102
+ this.cache.acceptAndMerge(incomingPublicStorage.cache);
103
+ }
104
+ }
105
+
106
+ /**
107
+ * A class to cache writes to public storage during a contract call's AVM simulation.
108
+ * "Writes" update a map, "reads" check that map or return undefined.
109
+ * An instance of this class can merge another instance's staged writes into its own.
110
+ */
111
+ class PublicStorageCache {
112
+ /**
113
+ * Map for staging storage writes.
114
+ * One inner-map per contract storage address,
115
+ * mapping storage slot to latest staged write value.
116
+ */
117
+ private cachePerContract: Map<bigint, Map<bigint, Fr>> = new Map();
118
+
119
+ /**
120
+ * Read a staged value from storage, if it has been previously written to.
121
+ *
122
+ * @param contractAddress - the address of the contract whose storage is being read from
123
+ * @param slot - the slot in the contract's storage being read from
124
+ * @returns the latest value written to slot, or undefined if no value has been written
125
+ */
126
+ public read(contractAddress: AztecAddress, slot: Fr): Fr | undefined {
127
+ return this.cachePerContract.get(contractAddress.toBigInt())?.get(slot.toBigInt());
128
+ }
129
+
130
+ /**
131
+ * Stage a storage write.
132
+ *
133
+ * @param contractAddress - the address of the contract whose storage is being written to
134
+ * @param slot - the slot in the contract's storage being written to
135
+ * @param value - the value being written to the slot
136
+ */
137
+ public write(contractAddress: AztecAddress, slot: Fr, value: Fr) {
138
+ let cacheAtContract = this.cachePerContract.get(contractAddress.toBigInt());
139
+ if (!cacheAtContract) {
140
+ // If this contract's storage has no staged modifications, create a new inner map to store them
141
+ cacheAtContract = new Map();
142
+ this.cachePerContract.set(contractAddress.toBigInt(), cacheAtContract);
143
+ }
144
+ cacheAtContract.set(slot.toBigInt(), value);
145
+ }
146
+
147
+ /**
148
+ * Merges another cache's staged writes into this instance's cache.
149
+ *
150
+ * Staged modifications in "incoming" take precedence over those
151
+ * present in "this" as they are assumed to occur after this' writes.
152
+ *
153
+ * In practice, "this" is a parent call's storage cache, and "incoming" is a nested call's.
154
+ *
155
+ * @param incomingStorageCache - the incoming storage write cache to merge into this instance's
156
+ */
157
+ public acceptAndMerge(incomingStorageCache: PublicStorageCache) {
158
+ // Iterate over all incoming contracts with staged writes.
159
+ for (const [incomingAddress, incomingCacheAtContract] of incomingStorageCache.cachePerContract) {
160
+ const thisCacheAtContract = this.cachePerContract.get(incomingAddress);
161
+ if (!thisCacheAtContract) {
162
+ // The contract has no storage writes staged here
163
+ // so just accept the incoming cache as-is for this contract.
164
+ this.cachePerContract.set(incomingAddress, incomingCacheAtContract);
165
+ } else {
166
+ // "Incoming" and "this" both have staged writes for this contract.
167
+ // Merge in incoming staged writes, giving them precedence over this'.
168
+ for (const [slot, value] of incomingCacheAtContract) {
169
+ thisCacheAtContract.set(slot, value);
170
+ }
171
+ }
172
+ }
173
+ }
174
+ }
@@ -0,0 +1,8 @@
1
+ const baseConfig = require('@aztec/foundation/eslint');
2
+ module.exports = {
3
+ ...baseConfig,
4
+ rules: {
5
+ ...baseConfig.rules,
6
+ 'require-await': 'off',
7
+ },
8
+ };
@@ -0,0 +1,253 @@
1
+ import type { AvmContext } from '../avm_context.js';
2
+ import { TypeTag, Uint1 } from '../avm_memory_types.js';
3
+ import { InstructionExecutionError, StaticCallAlterationError } from '../errors.js';
4
+ import { NullifierCollisionError } from '../journal/nullifiers.js';
5
+ import { Opcode, OperandType } from '../serialization/instruction_serialization.js';
6
+ import { Addressing } from './addressing_mode.js';
7
+ import { Instruction } from './instruction.js';
8
+
9
+ export class NoteHashExists extends Instruction {
10
+ static type: string = 'NOTEHASHEXISTS';
11
+ static readonly opcode: Opcode = Opcode.NOTEHASHEXISTS;
12
+ // Informs (de)serialization. See Instruction.deserialize.
13
+ static readonly wireFormat = [
14
+ OperandType.UINT8,
15
+ OperandType.UINT8,
16
+ OperandType.UINT16,
17
+ OperandType.UINT16,
18
+ OperandType.UINT16,
19
+ ];
20
+
21
+ constructor(
22
+ private indirect: number,
23
+ private noteHashOffset: number,
24
+ private leafIndexOffset: number,
25
+ private existsOffset: number,
26
+ ) {
27
+ super();
28
+ }
29
+
30
+ public async execute(context: AvmContext): Promise<void> {
31
+ const memory = context.machineState.memory;
32
+ context.machineState.consumeGas(this.gasCost());
33
+ const operands = [this.noteHashOffset, this.leafIndexOffset, this.existsOffset];
34
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
35
+ const [noteHashOffset, leafIndexOffset, existsOffset] = addressing.resolve(operands, memory);
36
+ memory.checkTags(TypeTag.FIELD, noteHashOffset, leafIndexOffset);
37
+
38
+ // Note that this instruction accepts any type in memory, and converts to Field.
39
+ const noteHash = memory.get(noteHashOffset).toFr();
40
+ const leafIndex = memory.get(leafIndexOffset).toFr();
41
+
42
+ const exists = await context.persistableState.checkNoteHashExists(context.environment.address, noteHash, leafIndex);
43
+ memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
44
+ }
45
+ }
46
+
47
+ export class EmitNoteHash extends Instruction {
48
+ static type: string = 'EMITNOTEHASH';
49
+ static readonly opcode: Opcode = Opcode.EMITNOTEHASH;
50
+ // Informs (de)serialization. See Instruction.deserialize.
51
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16];
52
+
53
+ constructor(private indirect: number, private noteHashOffset: number) {
54
+ super();
55
+ }
56
+
57
+ public async execute(context: AvmContext): Promise<void> {
58
+ const memory = context.machineState.memory;
59
+ context.machineState.consumeGas(this.gasCost());
60
+
61
+ const operands = [this.noteHashOffset];
62
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
63
+ const [noteHashOffset] = addressing.resolve(operands, memory);
64
+ memory.checkTag(TypeTag.FIELD, noteHashOffset);
65
+
66
+ if (context.environment.isStaticCall) {
67
+ throw new StaticCallAlterationError();
68
+ }
69
+
70
+ const noteHash = memory.get(noteHashOffset).toFr();
71
+ await context.persistableState.writeNoteHash(context.environment.address, noteHash);
72
+ }
73
+ }
74
+
75
+ export class NullifierExists extends Instruction {
76
+ static type: string = 'NULLIFIEREXISTS';
77
+ static readonly opcode: Opcode = Opcode.NULLIFIEREXISTS;
78
+ // Informs (de)serialization. See Instruction.deserialize.
79
+ static readonly wireFormat = [
80
+ OperandType.UINT8,
81
+ OperandType.UINT8,
82
+ OperandType.UINT16,
83
+ OperandType.UINT16,
84
+ OperandType.UINT16,
85
+ ];
86
+
87
+ constructor(
88
+ private indirect: number,
89
+ private nullifierOffset: number,
90
+ private addressOffset: number,
91
+ private existsOffset: number,
92
+ ) {
93
+ super();
94
+ }
95
+
96
+ public async execute(context: AvmContext): Promise<void> {
97
+ const memory = context.machineState.memory;
98
+ context.machineState.consumeGas(this.gasCost());
99
+
100
+ const operands = [this.nullifierOffset, this.addressOffset, this.existsOffset];
101
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
102
+ const [nullifierOffset, addressOffset, existsOffset] = addressing.resolve(operands, memory);
103
+ memory.checkTags(TypeTag.FIELD, nullifierOffset, addressOffset);
104
+
105
+ const nullifier = memory.get(nullifierOffset).toFr();
106
+ const address = memory.get(addressOffset).toAztecAddress();
107
+ const exists = await context.persistableState.checkNullifierExists(address, nullifier);
108
+
109
+ memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
110
+ }
111
+ }
112
+
113
+ export class EmitNullifier extends Instruction {
114
+ static type: string = 'EMITNULLIFIER';
115
+ static readonly opcode: Opcode = Opcode.EMITNULLIFIER;
116
+ // Informs (de)serialization. See Instruction.deserialize.
117
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16];
118
+
119
+ constructor(private indirect: number, private nullifierOffset: number) {
120
+ super();
121
+ }
122
+
123
+ public async execute(context: AvmContext): Promise<void> {
124
+ if (context.environment.isStaticCall) {
125
+ throw new StaticCallAlterationError();
126
+ }
127
+
128
+ const memory = context.machineState.memory;
129
+ context.machineState.consumeGas(this.gasCost());
130
+
131
+ const operands = [this.nullifierOffset];
132
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
133
+ const [nullifierOffset] = addressing.resolve(operands, memory);
134
+ memory.checkTag(TypeTag.FIELD, nullifierOffset);
135
+
136
+ const nullifier = memory.get(nullifierOffset).toFr();
137
+ try {
138
+ await context.persistableState.writeNullifier(context.environment.address, nullifier);
139
+ } catch (e) {
140
+ if (e instanceof NullifierCollisionError) {
141
+ // Error is known/expected, raise as InstructionExecutionError that the will lead the simulator to revert this call
142
+ throw new InstructionExecutionError(
143
+ `Attempted to emit duplicate nullifier ${nullifier} (contract address: ${context.environment.address}).`,
144
+ );
145
+ } else {
146
+ throw e;
147
+ }
148
+ }
149
+ }
150
+ }
151
+
152
+ export class L1ToL2MessageExists extends Instruction {
153
+ static type: string = 'L1TOL2MSGEXISTS';
154
+ static readonly opcode: Opcode = Opcode.L1TOL2MSGEXISTS;
155
+ // Informs (de)serialization. See Instruction.deserialize.
156
+ static readonly wireFormat = [
157
+ OperandType.UINT8,
158
+ OperandType.UINT8,
159
+ OperandType.UINT16,
160
+ OperandType.UINT16,
161
+ OperandType.UINT16,
162
+ ];
163
+
164
+ constructor(
165
+ private indirect: number,
166
+ private msgHashOffset: number,
167
+ private msgLeafIndexOffset: number,
168
+ private existsOffset: number,
169
+ ) {
170
+ super();
171
+ }
172
+
173
+ public async execute(context: AvmContext): Promise<void> {
174
+ const memory = context.machineState.memory;
175
+ context.machineState.consumeGas(this.gasCost());
176
+
177
+ const operands = [this.msgHashOffset, this.msgLeafIndexOffset, this.existsOffset];
178
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
179
+ const [msgHashOffset, msgLeafIndexOffset, existsOffset] = addressing.resolve(operands, memory);
180
+ memory.checkTags(TypeTag.FIELD, msgHashOffset, msgLeafIndexOffset);
181
+
182
+ const msgHash = memory.get(msgHashOffset).toFr();
183
+ const msgLeafIndex = memory.get(msgLeafIndexOffset).toFr();
184
+ const exists = await context.persistableState.checkL1ToL2MessageExists(
185
+ context.environment.address,
186
+ msgHash,
187
+ msgLeafIndex,
188
+ );
189
+ memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
190
+ }
191
+ }
192
+
193
+ export class EmitUnencryptedLog extends Instruction {
194
+ // TODO(#11124): rename unencrypted -> public
195
+ static type: string = 'EMITUNENCRYPTEDLOG';
196
+ static readonly opcode: Opcode = Opcode.EMITUNENCRYPTEDLOG;
197
+ // Informs (de)serialization. See Instruction.deserialize.
198
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16, OperandType.UINT16];
199
+
200
+ constructor(private indirect: number, private logOffset: number, private logSizeOffset: number) {
201
+ super();
202
+ }
203
+
204
+ public async execute(context: AvmContext): Promise<void> {
205
+ if (context.environment.isStaticCall) {
206
+ throw new StaticCallAlterationError();
207
+ }
208
+
209
+ const memory = context.machineState.memory;
210
+
211
+ const operands = [this.logOffset, this.logSizeOffset];
212
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
213
+ const [logOffset, logSizeOffset] = addressing.resolve(operands, memory);
214
+ memory.checkTag(TypeTag.UINT32, logSizeOffset);
215
+ const logSize = memory.get(logSizeOffset).toNumber();
216
+ memory.checkTagsRange(TypeTag.FIELD, logOffset, logSize);
217
+
218
+ const contractAddress = context.environment.address;
219
+
220
+ context.machineState.consumeGas(this.gasCost(logSize));
221
+ const log = memory.getSlice(logOffset, logSize).map(f => f.toFr());
222
+ context.persistableState.writePublicLog(contractAddress, log);
223
+ }
224
+ }
225
+
226
+ export class SendL2ToL1Message extends Instruction {
227
+ static type: string = 'SENDL2TOL1MSG';
228
+ static readonly opcode: Opcode = Opcode.SENDL2TOL1MSG;
229
+ // Informs (de)serialization. See Instruction.deserialize.
230
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16, OperandType.UINT16];
231
+
232
+ constructor(private indirect: number, private recipientOffset: number, private contentOffset: number) {
233
+ super();
234
+ }
235
+
236
+ public async execute(context: AvmContext): Promise<void> {
237
+ if (context.environment.isStaticCall) {
238
+ throw new StaticCallAlterationError();
239
+ }
240
+
241
+ const memory = context.machineState.memory;
242
+ context.machineState.consumeGas(this.gasCost());
243
+
244
+ const operands = [this.recipientOffset, this.contentOffset];
245
+ const addressing = Addressing.fromWire(this.indirect, operands.length);
246
+ const [recipientOffset, contentOffset] = addressing.resolve(operands, memory);
247
+ memory.checkTags(TypeTag.FIELD, recipientOffset, contentOffset);
248
+
249
+ const recipient = memory.get(recipientOffset).toFr();
250
+ const content = memory.get(contentOffset).toFr();
251
+ context.persistableState.writeL2ToL1Message(context.environment.address, recipient, content);
252
+ }
253
+ }
@@ -0,0 +1,87 @@
1
+ import { strict as assert } from 'assert';
2
+
3
+ import { TaggedMemory, type TaggedMemoryInterface } from '../avm_memory_types.js';
4
+ import { RelativeAddressOutOfRangeError } from '../errors.js';
5
+
6
+ export enum AddressingMode {
7
+ DIRECT = 0,
8
+ INDIRECT = 1,
9
+ RELATIVE = 2,
10
+ INDIRECT_RELATIVE = 3,
11
+ }
12
+
13
+ /** A class to represent the addressing mode of an instruction. */
14
+ export class Addressing {
15
+ public constructor(
16
+ /** The addressing mode for each operand. The length of this array is the number of operands of the instruction. */
17
+ private readonly modePerOperand: AddressingMode[],
18
+ ) {}
19
+
20
+ // TODO(facundo): 8 for backwards compatibility.
21
+ public static fromWire(wireModes: number, numOperands: number = 8): Addressing {
22
+ // The modes are stored in the wire format as a byte, with each bit representing the mode for an operand.
23
+ // The least significant bit represents the zeroth operand, and the most significant bit represents the last operand.
24
+ const modes = new Array<AddressingMode>(numOperands);
25
+ for (let i = 0; i < numOperands; i++) {
26
+ modes[i] =
27
+ (((wireModes >> i) & 1) * AddressingMode.INDIRECT) |
28
+ (((wireModes >> (i + numOperands)) & 1) * AddressingMode.RELATIVE);
29
+ }
30
+ return new Addressing(modes);
31
+ }
32
+
33
+ public toWire(): number {
34
+ // The modes are stored in the wire format as a byte, with each bit representing the mode for an operand.
35
+ // The least significant bit represents the zeroth operand, and the least significant bit represents the last operand.
36
+ let wire: number = 0;
37
+ for (let i = 0; i < this.modePerOperand.length; i++) {
38
+ if (this.modePerOperand[i] & AddressingMode.INDIRECT) {
39
+ wire |= 1 << i;
40
+ }
41
+ if (this.modePerOperand[i] & AddressingMode.RELATIVE) {
42
+ wire |= 1 << (this.modePerOperand.length + i);
43
+ }
44
+ }
45
+ return wire;
46
+ }
47
+
48
+ /** Returns how many operands use the given addressing mode. */
49
+ public count(mode: AddressingMode): number {
50
+ return this.modePerOperand.filter(m => (m & mode) !== 0).length;
51
+ }
52
+
53
+ /**
54
+ * Resolves the offsets using the addressing mode.
55
+ * @param offsets The offsets to resolve.
56
+ * @param mem The memory to use for resolution.
57
+ * @returns The resolved offsets. The length of the returned array is the same as the length of the input array.
58
+ */
59
+ public resolve(offsets: number[], mem: TaggedMemoryInterface): number[] {
60
+ assert(offsets.length <= this.modePerOperand.length);
61
+ const resolved = new Array(offsets.length);
62
+
63
+ let didRelativeOnce = false;
64
+ let baseAddr = 0;
65
+
66
+ for (const [i, offset] of offsets.entries()) {
67
+ const mode = this.modePerOperand[i];
68
+ resolved[i] = offset;
69
+ if (mode & AddressingMode.RELATIVE) {
70
+ if (!didRelativeOnce) {
71
+ mem.checkIsValidMemoryOffsetTag(0);
72
+ baseAddr = Number(mem.get(0).toBigInt());
73
+ didRelativeOnce = true;
74
+ }
75
+ resolved[i] += baseAddr;
76
+ if (resolved[i] >= TaggedMemory.MAX_MEMORY_SIZE) {
77
+ throw new RelativeAddressOutOfRangeError(baseAddr, offset);
78
+ }
79
+ }
80
+ if (mode & AddressingMode.INDIRECT) {
81
+ mem.checkIsValidMemoryOffsetTag(resolved[i]);
82
+ resolved[i] = Number(mem.get(resolved[i]).toBigInt());
83
+ }
84
+ }
85
+ return resolved;
86
+ }
87
+ }