@aztec/pxe 0.0.1-commit.3469e52 → 0.0.1-commit.350e0a4d

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 (499) hide show
  1. package/dest/bin/check_oracle_version.js +44 -110
  2. package/dest/bin/index.d.ts +2 -0
  3. package/dest/bin/index.d.ts.map +1 -0
  4. package/dest/bin/index.js +1 -0
  5. package/dest/bin/oracle_version_helpers.d.ts +51 -0
  6. package/dest/bin/oracle_version_helpers.d.ts.map +1 -0
  7. package/dest/bin/oracle_version_helpers.js +254 -0
  8. package/dest/block_synchronizer/block_stream_source.d.ts +10 -0
  9. package/dest/block_synchronizer/block_stream_source.d.ts.map +1 -0
  10. package/dest/block_synchronizer/block_stream_source.js +37 -0
  11. package/dest/block_synchronizer/block_synchronizer.d.ts +26 -14
  12. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  13. package/dest/block_synchronizer/block_synchronizer.js +128 -26
  14. package/dest/config/index.d.ts +11 -2
  15. package/dest/config/index.d.ts.map +1 -1
  16. package/dest/config/index.js +18 -2
  17. package/dest/config/package_info.js +1 -1
  18. package/dest/contract/contract_class_service.d.ts +31 -0
  19. package/dest/contract/contract_class_service.d.ts.map +1 -0
  20. package/dest/contract/contract_class_service.js +68 -0
  21. package/dest/contract/contract_sync_service.d.ts +48 -0
  22. package/dest/contract/contract_sync_service.d.ts.map +1 -0
  23. package/dest/contract/contract_sync_service.js +116 -0
  24. package/dest/contract/helpers.d.ts +7 -0
  25. package/dest/contract/helpers.d.ts.map +1 -0
  26. package/dest/contract/helpers.js +20 -0
  27. package/dest/contract_function_simulator/anchored_contract_data.d.ts +36 -0
  28. package/dest/contract_function_simulator/anchored_contract_data.d.ts.map +1 -0
  29. package/dest/contract_function_simulator/anchored_contract_data.js +54 -0
  30. package/dest/contract_function_simulator/contract_function_simulator.d.ts +72 -36
  31. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  32. package/dest/contract_function_simulator/contract_function_simulator.js +265 -98
  33. package/dest/contract_function_simulator/ephemeral_array_service.d.ts +28 -0
  34. package/dest/contract_function_simulator/ephemeral_array_service.d.ts.map +1 -0
  35. package/dest/contract_function_simulator/ephemeral_array_service.js +78 -0
  36. package/dest/contract_function_simulator/execution_note_cache.d.ts +4 -10
  37. package/dest/contract_function_simulator/execution_note_cache.d.ts.map +1 -1
  38. package/dest/contract_function_simulator/execution_note_cache.js +8 -28
  39. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -11
  40. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  41. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -15
  42. package/dest/contract_function_simulator/index.d.ts +26 -5
  43. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  44. package/dest/contract_function_simulator/index.js +12 -3
  45. package/dest/contract_function_simulator/noir-structs/bounded_vec.d.ts +29 -0
  46. package/dest/contract_function_simulator/noir-structs/bounded_vec.d.ts.map +1 -0
  47. package/dest/contract_function_simulator/noir-structs/bounded_vec.js +30 -0
  48. package/dest/contract_function_simulator/noir-structs/contract_class_log_data.d.ts +9 -0
  49. package/dest/contract_function_simulator/noir-structs/contract_class_log_data.d.ts.map +1 -0
  50. package/dest/contract_function_simulator/noir-structs/contract_class_log_data.js +1 -0
  51. package/dest/contract_function_simulator/noir-structs/embedded_curve_point.d.ts +7 -0
  52. package/dest/contract_function_simulator/noir-structs/embedded_curve_point.d.ts.map +1 -0
  53. package/dest/contract_function_simulator/noir-structs/embedded_curve_point.js +1 -0
  54. package/dest/contract_function_simulator/noir-structs/ephemeral_array.d.ts +37 -0
  55. package/dest/contract_function_simulator/noir-structs/ephemeral_array.d.ts.map +1 -0
  56. package/dest/contract_function_simulator/noir-structs/ephemeral_array.js +59 -0
  57. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +4 -5
  58. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  59. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +10 -11
  60. package/dest/contract_function_simulator/noir-structs/fact.d.ts +16 -0
  61. package/dest/contract_function_simulator/noir-structs/fact.d.ts.map +1 -0
  62. package/dest/contract_function_simulator/noir-structs/fact.js +6 -0
  63. package/dest/contract_function_simulator/noir-structs/fact_collection.d.ts +27 -0
  64. package/dest/contract_function_simulator/noir-structs/fact_collection.d.ts.map +1 -0
  65. package/dest/contract_function_simulator/noir-structs/fact_collection.js +31 -0
  66. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts +19 -10
  67. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts.map +1 -1
  68. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.js +12 -24
  69. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +11 -9
  70. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  71. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +2 -63
  72. package/dest/contract_function_simulator/noir-structs/note_data.d.ts +27 -0
  73. package/dest/contract_function_simulator/noir-structs/note_data.d.ts.map +1 -0
  74. package/dest/contract_function_simulator/noir-structs/note_data.js +3 -0
  75. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +4 -6
  76. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  77. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +9 -13
  78. package/dest/contract_function_simulator/noir-structs/option.d.ts +59 -0
  79. package/dest/contract_function_simulator/noir-structs/option.d.ts.map +1 -0
  80. package/dest/contract_function_simulator/noir-structs/option.js +67 -0
  81. package/dest/contract_function_simulator/noir-structs/origin_block.d.ts +11 -0
  82. package/dest/contract_function_simulator/noir-structs/origin_block.d.ts.map +1 -0
  83. package/dest/contract_function_simulator/noir-structs/origin_block.js +5 -0
  84. package/dest/contract_function_simulator/noir-structs/pending_tagged_log.d.ts +11 -0
  85. package/dest/contract_function_simulator/noir-structs/pending_tagged_log.d.ts.map +1 -0
  86. package/dest/contract_function_simulator/noir-structs/pending_tagged_log.js +4 -0
  87. package/dest/contract_function_simulator/noir-structs/provided_secret.d.ts +8 -0
  88. package/dest/contract_function_simulator/noir-structs/provided_secret.d.ts.map +1 -0
  89. package/dest/contract_function_simulator/noir-structs/provided_secret.js +1 -0
  90. package/dest/contract_function_simulator/noir-structs/resolved_tagging_strategy.d.ts +28 -0
  91. package/dest/contract_function_simulator/noir-structs/resolved_tagging_strategy.d.ts.map +1 -0
  92. package/dest/contract_function_simulator/noir-structs/resolved_tagging_strategy.js +43 -0
  93. package/dest/contract_function_simulator/noir-structs/resolved_tx.d.ts +21 -0
  94. package/dest/contract_function_simulator/noir-structs/resolved_tx.d.ts.map +1 -0
  95. package/dest/contract_function_simulator/noir-structs/resolved_tx.js +50 -0
  96. package/dest/contract_function_simulator/noir-structs/tx_effect_data.d.ts +14 -0
  97. package/dest/contract_function_simulator/noir-structs/tx_effect_data.d.ts.map +1 -0
  98. package/dest/contract_function_simulator/noir-structs/tx_effect_data.js +5 -0
  99. package/dest/contract_function_simulator/noir-structs/utility_context.d.ts +6 -11
  100. package/dest/contract_function_simulator/noir-structs/utility_context.d.ts.map +1 -1
  101. package/dest/contract_function_simulator/noir-structs/utility_context.js +1 -20
  102. package/dest/contract_function_simulator/oracle/acir_callback.d.ts +21 -0
  103. package/dest/contract_function_simulator/oracle/acir_callback.d.ts.map +1 -0
  104. package/dest/contract_function_simulator/oracle/acir_callback.js +115 -0
  105. package/dest/contract_function_simulator/oracle/index.d.ts +2 -13
  106. package/dest/contract_function_simulator/oracle/index.d.ts.map +1 -1
  107. package/dest/contract_function_simulator/oracle/index.js +1 -1
  108. package/dest/contract_function_simulator/oracle/interfaces.d.ts +15 -95
  109. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  110. package/dest/contract_function_simulator/oracle/interfaces.js +2 -2
  111. package/dest/contract_function_simulator/oracle/legacy_oracle_registry.d.ts +39 -0
  112. package/dest/contract_function_simulator/oracle/legacy_oracle_registry.d.ts.map +1 -0
  113. package/dest/contract_function_simulator/oracle/legacy_oracle_registry.js +74 -0
  114. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.d.ts +3 -14
  115. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.d.ts.map +1 -1
  116. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.js +1 -24
  117. package/dest/contract_function_simulator/oracle/note_packing_utils.d.ts +2 -2
  118. package/dest/contract_function_simulator/oracle/note_packing_utils.d.ts.map +1 -1
  119. package/dest/contract_function_simulator/oracle/note_packing_utils.js +2 -2
  120. package/dest/contract_function_simulator/oracle/oracle_registry.d.ts +136 -0
  121. package/dest/contract_function_simulator/oracle/oracle_registry.d.ts.map +1 -0
  122. package/dest/contract_function_simulator/oracle/oracle_registry.js +989 -0
  123. package/dest/contract_function_simulator/oracle/oracle_type_mappings.d.ts +222 -0
  124. package/dest/contract_function_simulator/oracle/oracle_type_mappings.d.ts.map +1 -0
  125. package/dest/contract_function_simulator/oracle/oracle_type_mappings.js +1243 -0
  126. package/dest/contract_function_simulator/oracle/private_execution.d.ts +2 -22
  127. package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
  128. package/dest/contract_function_simulator/oracle/private_execution.js +7 -43
  129. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +88 -95
  130. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  131. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +269 -114
  132. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +206 -83
  133. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  134. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +595 -201
  135. package/dest/contract_function_simulator/pick_notes.d.ts +1 -1
  136. package/dest/contract_function_simulator/pick_notes.d.ts.map +1 -1
  137. package/dest/contract_function_simulator/pick_notes.js +20 -3
  138. package/dest/contract_function_simulator/transient_array_service.d.ts +31 -0
  139. package/dest/contract_function_simulator/transient_array_service.d.ts.map +1 -0
  140. package/dest/contract_function_simulator/transient_array_service.js +62 -0
  141. package/dest/contract_logging.d.ts +27 -0
  142. package/dest/contract_logging.d.ts.map +1 -0
  143. package/dest/contract_logging.js +38 -0
  144. package/dest/debug/pxe_debug_utils.d.ts +19 -10
  145. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  146. package/dest/debug/pxe_debug_utils.js +22 -17
  147. package/dest/entrypoints/client/bundle/index.d.ts +3 -1
  148. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  149. package/dest/entrypoints/client/bundle/index.js +2 -0
  150. package/dest/entrypoints/client/bundle/utils.d.ts +2 -2
  151. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  152. package/dest/entrypoints/client/bundle/utils.js +39 -12
  153. package/dest/entrypoints/client/lazy/index.d.ts +3 -1
  154. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  155. package/dest/entrypoints/client/lazy/index.js +2 -0
  156. package/dest/entrypoints/client/lazy/utils.d.ts +3 -3
  157. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  158. package/dest/entrypoints/client/lazy/utils.js +40 -13
  159. package/dest/entrypoints/pxe_creation_options.d.ts +18 -3
  160. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  161. package/dest/entrypoints/pxe_creation_options.js +3 -1
  162. package/dest/entrypoints/server/index.d.ts +7 -2
  163. package/dest/entrypoints/server/index.d.ts.map +1 -1
  164. package/dest/entrypoints/server/index.js +5 -1
  165. package/dest/entrypoints/server/utils.d.ts +4 -3
  166. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  167. package/dest/entrypoints/server/utils.js +47 -14
  168. package/dest/error_enriching.d.ts +5 -3
  169. package/dest/error_enriching.d.ts.map +1 -1
  170. package/dest/error_enriching.js +13 -11
  171. package/dest/events/event_service.d.ts +16 -8
  172. package/dest/events/event_service.d.ts.map +1 -1
  173. package/dest/events/event_service.js +46 -14
  174. package/dest/events/private_event_filter_validator.d.ts +3 -2
  175. package/dest/events/private_event_filter_validator.d.ts.map +1 -1
  176. package/dest/events/private_event_filter_validator.js +15 -0
  177. package/dest/hooks/authorize_utility_call.d.ts +41 -0
  178. package/dest/hooks/authorize_utility_call.d.ts.map +1 -0
  179. package/dest/hooks/authorize_utility_call.js +4 -0
  180. package/dest/hooks/execution_hooks.d.ts +62 -0
  181. package/dest/hooks/execution_hooks.d.ts.map +1 -0
  182. package/dest/hooks/execution_hooks.js +9 -0
  183. package/dest/hooks/index.d.ts +5 -0
  184. package/dest/hooks/index.d.ts.map +1 -0
  185. package/dest/hooks/index.js +1 -0
  186. package/dest/hooks/resolve_custom_request.d.ts +23 -0
  187. package/dest/hooks/resolve_custom_request.d.ts.map +1 -0
  188. package/dest/hooks/resolve_custom_request.js +3 -0
  189. package/dest/hooks/resolve_tagging_secret_strategy.d.ts +48 -0
  190. package/dest/hooks/resolve_tagging_secret_strategy.d.ts.map +1 -0
  191. package/dest/hooks/resolve_tagging_secret_strategy.js +3 -0
  192. package/dest/job_coordinator/job_coordinator.d.ts +3 -2
  193. package/dest/job_coordinator/job_coordinator.d.ts.map +1 -1
  194. package/dest/job_coordinator/job_coordinator.js +3 -2
  195. package/dest/logs/log_service.d.ts +16 -13
  196. package/dest/logs/log_service.d.ts.map +1 -1
  197. package/dest/logs/log_service.js +192 -91
  198. package/dest/messages/tx_resolver_service.d.ts +17 -0
  199. package/dest/messages/tx_resolver_service.d.ts.map +1 -0
  200. package/dest/messages/tx_resolver_service.js +55 -0
  201. package/dest/notes/note_service.d.ts +30 -8
  202. package/dest/notes/note_service.d.ts.map +1 -1
  203. package/dest/notes/note_service.js +94 -69
  204. package/dest/notes_filter.d.ts +24 -0
  205. package/dest/notes_filter.d.ts.map +1 -0
  206. package/dest/notes_filter.js +4 -0
  207. package/dest/oracle_version.d.ts +4 -3
  208. package/dest/oracle_version.d.ts.map +1 -1
  209. package/dest/oracle_version.js +20 -9
  210. package/dest/private_kernel/batch_planner.d.ts +47 -0
  211. package/dest/private_kernel/batch_planner.d.ts.map +1 -0
  212. package/dest/private_kernel/batch_planner.js +104 -0
  213. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  214. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  215. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  216. package/dest/private_kernel/hints/index.d.ts +1 -1
  217. package/dest/private_kernel/hints/index.js +1 -1
  218. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  219. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  220. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +135 -70
  221. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  222. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  223. package/dest/private_kernel/hints/test_utils.js +202 -0
  224. package/dest/private_kernel/private_kernel_execution_prover.d.ts +7 -2
  225. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  226. package/dest/private_kernel/private_kernel_execution_prover.js +209 -87
  227. package/dest/private_kernel/private_kernel_oracle.d.ts +17 -11
  228. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  229. package/dest/private_kernel/private_kernel_oracle.js +47 -29
  230. package/dest/pxe.d.ts +228 -66
  231. package/dest/pxe.d.ts.map +1 -1
  232. package/dest/pxe.js +415 -231
  233. package/dest/storage/address_store/address_store.d.ts +1 -1
  234. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  235. package/dest/storage/address_store/address_store.js +12 -11
  236. package/dest/storage/allowed_scopes.d.ts +6 -0
  237. package/dest/storage/allowed_scopes.d.ts.map +1 -0
  238. package/dest/storage/allowed_scopes.js +7 -0
  239. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +12 -1
  240. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  241. package/dest/storage/anchor_block_store/anchor_block_store.js +12 -3
  242. package/dest/storage/backwards_compatibility_tests/kv_store_snapshot.d.ts +42 -0
  243. package/dest/storage/backwards_compatibility_tests/kv_store_snapshot.d.ts.map +1 -0
  244. package/dest/storage/backwards_compatibility_tests/kv_store_snapshot.js +93 -0
  245. package/dest/storage/backwards_compatibility_tests/schema_tests.d.ts +15 -0
  246. package/dest/storage/backwards_compatibility_tests/schema_tests.d.ts.map +1 -0
  247. package/dest/storage/backwards_compatibility_tests/schema_tests.js +647 -0
  248. package/dest/storage/backwards_compatibility_tests/store_spy.d.ts +19 -0
  249. package/dest/storage/backwards_compatibility_tests/store_spy.d.ts.map +1 -0
  250. package/dest/storage/backwards_compatibility_tests/store_spy.js +63 -0
  251. package/dest/storage/capsule_store/capsule_service.d.ts +21 -0
  252. package/dest/storage/capsule_store/capsule_service.d.ts.map +1 -0
  253. package/dest/storage/capsule_store/capsule_service.js +47 -0
  254. package/dest/storage/capsule_store/capsule_store.d.ts +9 -9
  255. package/dest/storage/capsule_store/capsule_store.d.ts.map +1 -1
  256. package/dest/storage/capsule_store/capsule_store.js +42 -36
  257. package/dest/storage/capsule_store/index.d.ts +2 -1
  258. package/dest/storage/capsule_store/index.d.ts.map +1 -1
  259. package/dest/storage/capsule_store/index.js +1 -0
  260. package/dest/storage/contract_store/contract_store.d.ts +63 -34
  261. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  262. package/dest/storage/contract_store/contract_store.js +191 -146
  263. package/dest/storage/fact_store/fact_service.d.ts +22 -0
  264. package/dest/storage/fact_store/fact_service.d.ts.map +1 -0
  265. package/dest/storage/fact_store/fact_service.js +45 -0
  266. package/dest/storage/fact_store/fact_store.d.ts +95 -0
  267. package/dest/storage/fact_store/fact_store.d.ts.map +1 -0
  268. package/dest/storage/fact_store/fact_store.js +408 -0
  269. package/dest/storage/fact_store/fact_store_keys.d.ts +34 -0
  270. package/dest/storage/fact_store/fact_store_keys.d.ts.map +1 -0
  271. package/dest/storage/fact_store/fact_store_keys.js +50 -0
  272. package/dest/storage/fact_store/index.d.ts +6 -0
  273. package/dest/storage/fact_store/index.d.ts.map +1 -0
  274. package/dest/storage/fact_store/index.js +4 -0
  275. package/dest/storage/fact_store/origin_state.d.ts +57 -0
  276. package/dest/storage/fact_store/origin_state.d.ts.map +1 -0
  277. package/dest/storage/fact_store/origin_state.js +53 -0
  278. package/dest/storage/fact_store/stored_fact.d.ts +32 -0
  279. package/dest/storage/fact_store/stored_fact.d.ts.map +1 -0
  280. package/dest/storage/fact_store/stored_fact.js +64 -0
  281. package/dest/storage/index.d.ts +3 -2
  282. package/dest/storage/index.d.ts.map +1 -1
  283. package/dest/storage/index.js +2 -1
  284. package/dest/storage/metadata.d.ts +2 -2
  285. package/dest/storage/metadata.d.ts.map +1 -1
  286. package/dest/storage/metadata.js +1 -1
  287. package/dest/storage/note_store/note_store.d.ts +63 -56
  288. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  289. package/dest/storage/note_store/note_store.js +321 -266
  290. package/dest/storage/note_store/stored_note.d.ts +11 -0
  291. package/dest/storage/note_store/stored_note.d.ts.map +1 -0
  292. package/dest/storage/note_store/stored_note.js +27 -0
  293. package/dest/storage/open_pxe_stores.d.ts +35 -0
  294. package/dest/storage/open_pxe_stores.d.ts.map +1 -0
  295. package/dest/storage/open_pxe_stores.js +29 -0
  296. package/dest/storage/private_event_store/private_event_store.d.ts +26 -16
  297. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  298. package/dest/storage/private_event_store/private_event_store.js +214 -163
  299. package/dest/storage/private_event_store/stored_private_event.d.ts +23 -0
  300. package/dest/storage/private_event_store/stored_private_event.d.ts.map +1 -0
  301. package/dest/storage/private_event_store/stored_private_event.js +56 -0
  302. package/dest/storage/tagging_store/index.d.ts +2 -2
  303. package/dest/storage/tagging_store/index.d.ts.map +1 -1
  304. package/dest/storage/tagging_store/index.js +1 -1
  305. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  306. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  307. package/dest/storage/tagging_store/recipient_tagging_store.js +31 -19
  308. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  309. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  310. package/dest/storage/tagging_store/sender_tagging_store.js +233 -137
  311. package/dest/storage/tagging_store/tagging_secret_sources_store.d.ts +51 -0
  312. package/dest/storage/tagging_store/tagging_secret_sources_store.d.ts.map +1 -0
  313. package/dest/storage/tagging_store/tagging_secret_sources_store.js +105 -0
  314. package/dest/tagging/constants.d.ts +2 -2
  315. package/dest/tagging/constants.d.ts.map +1 -1
  316. package/dest/tagging/constants.js +5 -8
  317. package/dest/tagging/get_all_logs_by_tags.d.ts +48 -0
  318. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -0
  319. package/dest/tagging/get_all_logs_by_tags.js +59 -0
  320. package/dest/tagging/index.d.ts +7 -5
  321. package/dest/tagging/index.d.ts.map +1 -1
  322. package/dest/tagging/index.js +5 -3
  323. package/dest/tagging/persist_sender_tagging_index_ranges.d.ts +29 -0
  324. package/dest/tagging/persist_sender_tagging_index_ranges.d.ts.map +1 -0
  325. package/dest/tagging/persist_sender_tagging_index_ranges.js +42 -0
  326. package/dest/tagging/recipient_sync/sync_tagged_private_logs.d.ts +69 -0
  327. package/dest/tagging/recipient_sync/sync_tagged_private_logs.d.ts.map +1 -0
  328. package/dest/tagging/recipient_sync/sync_tagged_private_logs.js +203 -0
  329. package/dest/tagging/recipient_sync/utils/find_highest_indexes.d.ts +3 -3
  330. package/dest/tagging/recipient_sync/utils/find_highest_indexes.d.ts.map +1 -1
  331. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  332. package/dest/tagging/reconcile_tagging_index_ranges.d.ts +36 -0
  333. package/dest/tagging/reconcile_tagging_index_ranges.d.ts.map +1 -0
  334. package/dest/tagging/reconcile_tagging_index_ranges.js +74 -0
  335. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +5 -9
  336. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  337. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +32 -14
  338. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +13 -7
  339. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  340. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +44 -16
  341. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +6 -7
  342. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  343. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +42 -27
  344. package/package.json +29 -17
  345. package/src/bin/check_oracle_version.ts +51 -132
  346. package/src/bin/index.ts +5 -0
  347. package/src/bin/oracle_version_helpers.ts +311 -0
  348. package/src/block_synchronizer/block_stream_source.ts +42 -0
  349. package/src/block_synchronizer/block_synchronizer.ts +154 -48
  350. package/src/config/index.ts +22 -1
  351. package/src/config/package_info.ts +1 -1
  352. package/src/contract/contract_class_service.ts +83 -0
  353. package/src/contract/contract_sync_service.ts +176 -0
  354. package/src/contract/helpers.ts +35 -0
  355. package/src/contract_function_simulator/anchored_contract_data.ts +74 -0
  356. package/src/contract_function_simulator/contract_function_simulator.ts +463 -162
  357. package/src/contract_function_simulator/ephemeral_array_service.ts +110 -0
  358. package/src/contract_function_simulator/execution_note_cache.ts +8 -29
  359. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -18
  360. package/src/contract_function_simulator/index.ts +69 -4
  361. package/src/contract_function_simulator/noir-structs/bounded_vec.ts +43 -0
  362. package/src/contract_function_simulator/noir-structs/contract_class_log_data.ts +9 -0
  363. package/src/contract_function_simulator/noir-structs/embedded_curve_point.ts +4 -0
  364. package/src/contract_function_simulator/noir-structs/ephemeral_array.ts +66 -0
  365. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +11 -10
  366. package/src/contract_function_simulator/noir-structs/fact.ts +13 -0
  367. package/src/contract_function_simulator/noir-structs/fact_collection.ts +64 -0
  368. package/src/contract_function_simulator/noir-structs/log_retrieval_request.ts +27 -20
  369. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +14 -64
  370. package/src/contract_function_simulator/noir-structs/note_data.ts +27 -0
  371. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +7 -12
  372. package/src/contract_function_simulator/noir-structs/option.ts +75 -0
  373. package/src/contract_function_simulator/noir-structs/origin_block.ts +8 -0
  374. package/src/contract_function_simulator/noir-structs/pending_tagged_log.ts +12 -0
  375. package/src/contract_function_simulator/noir-structs/provided_secret.ts +5 -0
  376. package/src/contract_function_simulator/noir-structs/resolved_tagging_strategy.ts +58 -0
  377. package/src/contract_function_simulator/noir-structs/resolved_tx.ts +53 -0
  378. package/src/contract_function_simulator/noir-structs/tx_effect_data.ts +15 -0
  379. package/src/contract_function_simulator/noir-structs/utility_context.ts +5 -17
  380. package/src/contract_function_simulator/oracle/acir_callback.ts +154 -0
  381. package/src/contract_function_simulator/oracle/index.ts +1 -15
  382. package/src/contract_function_simulator/oracle/interfaces.ts +11 -167
  383. package/src/contract_function_simulator/oracle/legacy_oracle_registry.ts +120 -0
  384. package/src/contract_function_simulator/oracle/message_load_oracle_inputs.ts +6 -21
  385. package/src/contract_function_simulator/oracle/note_packing_utils.ts +3 -3
  386. package/src/contract_function_simulator/oracle/oracle_registry.ts +689 -0
  387. package/src/contract_function_simulator/oracle/oracle_type_mappings.ts +964 -0
  388. package/src/contract_function_simulator/oracle/private_execution.ts +7 -67
  389. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +339 -217
  390. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +909 -271
  391. package/src/contract_function_simulator/pick_notes.ts +22 -3
  392. package/src/contract_function_simulator/transient_array_service.ts +91 -0
  393. package/src/contract_logging.ts +52 -0
  394. package/src/debug/pxe_debug_utils.ts +55 -18
  395. package/src/entrypoints/client/bundle/index.ts +2 -0
  396. package/src/entrypoints/client/bundle/utils.ts +34 -21
  397. package/src/entrypoints/client/lazy/index.ts +2 -0
  398. package/src/entrypoints/client/lazy/utils.ts +36 -22
  399. package/src/entrypoints/pxe_creation_options.ts +23 -2
  400. package/src/entrypoints/server/index.ts +7 -1
  401. package/src/entrypoints/server/utils.ts +46 -33
  402. package/src/error_enriching.ts +27 -11
  403. package/src/events/event_service.ts +70 -24
  404. package/src/events/private_event_filter_validator.ts +21 -1
  405. package/src/hooks/authorize_utility_call.ts +44 -0
  406. package/src/hooks/execution_hooks.ts +68 -0
  407. package/src/hooks/index.ts +12 -0
  408. package/src/hooks/resolve_custom_request.ts +24 -0
  409. package/src/hooks/resolve_tagging_secret_strategy.ts +57 -0
  410. package/src/job_coordinator/job_coordinator.ts +4 -3
  411. package/src/logs/log_service.ts +239 -152
  412. package/src/messages/tx_resolver_service.ts +69 -0
  413. package/src/notes/note_service.ts +136 -100
  414. package/src/notes_filter.ts +24 -0
  415. package/src/oracle_version.ts +20 -9
  416. package/src/private_kernel/batch_planner.ts +168 -0
  417. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  418. package/src/private_kernel/hints/index.ts +1 -1
  419. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +176 -119
  420. package/src/private_kernel/hints/test_utils.ts +318 -0
  421. package/src/private_kernel/private_kernel_execution_prover.ts +347 -123
  422. package/src/private_kernel/private_kernel_oracle.ts +65 -36
  423. package/src/pxe.ts +729 -297
  424. package/src/storage/address_store/address_store.ts +15 -15
  425. package/src/storage/allowed_scopes.ts +14 -0
  426. package/src/storage/anchor_block_store/anchor_block_store.ts +12 -2
  427. package/src/storage/backwards_compatibility_tests/__snapshots__/AddressStore.json +22 -0
  428. package/src/storage/backwards_compatibility_tests/__snapshots__/AnchorBlockStore.json +3 -0
  429. package/src/storage/backwards_compatibility_tests/__snapshots__/CapsuleStore.json +16 -0
  430. package/src/storage/backwards_compatibility_tests/__snapshots__/ContractStore.json +28 -0
  431. package/src/storage/backwards_compatibility_tests/__snapshots__/FactStore.json +40 -0
  432. package/src/storage/backwards_compatibility_tests/__snapshots__/KeyStore.json +52 -0
  433. package/src/storage/backwards_compatibility_tests/__snapshots__/L2TipsKVStore.json +40 -0
  434. package/src/storage/backwards_compatibility_tests/__snapshots__/NoteStore.json +56 -0
  435. package/src/storage/backwards_compatibility_tests/__snapshots__/PrivateEventStore.json +44 -0
  436. package/src/storage/backwards_compatibility_tests/__snapshots__/RecipientTaggingStore.json +18 -0
  437. package/src/storage/backwards_compatibility_tests/__snapshots__/SenderTaggingStore.json +22 -0
  438. package/src/storage/backwards_compatibility_tests/__snapshots__/TaggingSecretSourcesStore.json +30 -0
  439. package/src/storage/backwards_compatibility_tests/__snapshots__/opened_stores.json +117 -0
  440. package/src/storage/backwards_compatibility_tests/kv_store_snapshot.ts +122 -0
  441. package/src/storage/backwards_compatibility_tests/schema_tests.ts +774 -0
  442. package/src/storage/backwards_compatibility_tests/store_spy.ts +73 -0
  443. package/src/storage/capsule_store/capsule_service.ts +85 -0
  444. package/src/storage/capsule_store/capsule_store.ts +52 -34
  445. package/src/storage/capsule_store/index.ts +1 -0
  446. package/src/storage/contract_store/contract_store.ts +247 -185
  447. package/src/storage/fact_store/fact_service.ts +69 -0
  448. package/src/storage/fact_store/fact_store.ts +487 -0
  449. package/src/storage/fact_store/fact_store_keys.ts +75 -0
  450. package/src/storage/fact_store/index.ts +14 -0
  451. package/src/storage/fact_store/origin_state.ts +75 -0
  452. package/src/storage/fact_store/stored_fact.ts +80 -0
  453. package/src/storage/index.ts +2 -1
  454. package/src/storage/metadata.ts +1 -1
  455. package/src/storage/note_store/note_store.ts +363 -324
  456. package/src/storage/note_store/stored_note.ts +26 -0
  457. package/src/storage/open_pxe_stores.ts +52 -0
  458. package/src/storage/private_event_store/private_event_store.ts +268 -210
  459. package/src/storage/private_event_store/stored_private_event.ts +73 -0
  460. package/src/storage/tagging_store/index.ts +1 -1
  461. package/src/storage/tagging_store/recipient_tagging_store.ts +34 -24
  462. package/src/storage/tagging_store/sender_tagging_store.ts +287 -156
  463. package/src/storage/tagging_store/tagging_secret_sources_store.ts +138 -0
  464. package/src/tagging/constants.ts +6 -8
  465. package/src/tagging/get_all_logs_by_tags.ts +120 -0
  466. package/src/tagging/index.ts +6 -4
  467. package/src/tagging/persist_sender_tagging_index_ranges.ts +57 -0
  468. package/src/tagging/recipient_sync/sync_tagged_private_logs.ts +301 -0
  469. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +4 -4
  470. package/src/tagging/reconcile_tagging_index_ranges.ts +102 -0
  471. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +54 -17
  472. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +47 -29
  473. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +38 -29
  474. package/dest/contract_function_simulator/oracle/oracle.d.ts +0 -58
  475. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +0 -1
  476. package/dest/contract_function_simulator/oracle/oracle.js +0 -346
  477. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts +0 -6
  478. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map +0 -1
  479. package/dest/contract_function_simulator/proxied_contract_data_source.js +0 -80
  480. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  481. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
  482. package/dest/storage/tagging_store/sender_address_book_store.d.ts +0 -14
  483. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +0 -1
  484. package/dest/storage/tagging_store/sender_address_book_store.js +0 -30
  485. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +0 -14
  486. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +0 -1
  487. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +0 -99
  488. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +0 -14
  489. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +0 -1
  490. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +0 -29
  491. package/dest/tree_membership/tree_membership_service.d.ts +0 -50
  492. package/dest/tree_membership/tree_membership_service.d.ts.map +0 -1
  493. package/dest/tree_membership/tree_membership_service.js +0 -75
  494. package/src/contract_function_simulator/oracle/oracle.ts +0 -607
  495. package/src/contract_function_simulator/proxied_contract_data_source.ts +0 -83
  496. package/src/storage/tagging_store/sender_address_book_store.ts +0 -42
  497. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +0 -133
  498. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +0 -43
  499. package/src/tree_membership/tree_membership_service.ts +0 -97
package/src/pxe.ts CHANGED
@@ -1,39 +1,45 @@
1
1
  import type { PrivateEventFilter } from '@aztec/aztec.js/wallet';
2
2
  import { BlockNumber } from '@aztec/foundation/branded-types';
3
3
  import { Fr } from '@aztec/foundation/curves/bn254';
4
- import { type Logger, createLogger } from '@aztec/foundation/log';
4
+ import { Point } from '@aztec/foundation/curves/grumpkin';
5
+ import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
5
6
  import { SerialQueue } from '@aztec/foundation/queue';
6
7
  import { Timer } from '@aztec/foundation/timer';
7
8
  import { KeyStore } from '@aztec/key-store';
9
+ import type { AccountPrivacyKeys, AccountPrivacySecretKeys } from '@aztec/key-store';
8
10
  import type { AztecAsyncKVStore } from '@aztec/kv-store';
9
- import { L2TipsKVStore } from '@aztec/kv-store/stores';
10
11
  import { type ProtocolContractsProvider, protocolContractNames } from '@aztec/protocol-contracts';
11
12
  import type { CircuitSimulator } from '@aztec/simulator/client';
12
13
  import {
13
14
  type ContractArtifact,
14
15
  EventSelector,
15
16
  FunctionCall,
17
+ type FunctionSelector,
16
18
  FunctionType,
17
19
  decodeFunctionSignature,
18
20
  } from '@aztec/stdlib/abi';
19
21
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
20
22
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
21
- import { L2BlockHash } from '@aztec/stdlib/block';
23
+ import { GENESIS_BLOCK_HEADER_HASH, type L2TipsProvider } from '@aztec/stdlib/block';
22
24
  import {
23
25
  CompleteAddress,
26
+ type ContractInstancePreimage,
27
+ type ContractInstancePreimageWithAddress,
24
28
  type ContractInstanceWithAddress,
25
29
  type PartialAddress,
26
30
  computeContractAddressFromInstance,
27
- getContractClassFromArtifact,
28
31
  } from '@aztec/stdlib/contract';
29
32
  import { SimulationError } from '@aztec/stdlib/errors';
30
- import type { AztecNode, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
33
+ import type { AztecNode, AztecNodeDebug, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
31
34
  import type {
32
35
  PrivateExecutionStep,
33
36
  PrivateKernelExecutionProofOutput,
34
37
  PrivateKernelTailCircuitPublicInputs,
35
38
  } from '@aztec/stdlib/kernel';
39
+ import { computeAddressSecret } from '@aztec/stdlib/keys';
40
+ import { deriveEcdhSharedSecretPoint } from '@aztec/stdlib/logs';
36
41
  import {
42
+ BlockHeader,
37
43
  type ContractOverrides,
38
44
  type InTx,
39
45
  PrivateExecutionResult,
@@ -47,24 +53,27 @@ import {
47
53
  TxProfileResult,
48
54
  TxProvingResult,
49
55
  TxSimulationResult,
50
- UtilitySimulationResult,
56
+ UtilityExecutionResult,
51
57
  } from '@aztec/stdlib/tx';
52
58
 
53
59
  import { inspect } from 'util';
54
60
 
55
61
  import { BlockSynchronizer } from './block_synchronizer/index.js';
56
62
  import type { PXEConfig } from './config/index.js';
63
+ import { ContractClassService } from './contract/contract_class_service.js';
64
+ import { ContractSyncService } from './contract/contract_sync_service.js';
57
65
  import { BenchmarkedNodeFactory } from './contract_function_simulator/benchmarked_node.js';
58
66
  import {
59
67
  ContractFunctionSimulator,
60
68
  generateSimulatedProvingResult,
61
69
  } from './contract_function_simulator/contract_function_simulator.js';
62
- import { readCurrentClassId } from './contract_function_simulator/oracle/private_execution.js';
63
- import { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
70
+ import { displayDebugLogs } from './contract_logging.js';
64
71
  import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
65
72
  import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
66
73
  import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
74
+ import type { ExecutionHooks } from './hooks/index.js';
67
75
  import { JobCoordinator } from './job_coordinator/job_coordinator.js';
76
+ import { TxResolverService } from './messages/tx_resolver_service.js';
68
77
  import {
69
78
  PrivateKernelExecutionProver,
70
79
  type PrivateKernelExecutionProverConfig,
@@ -74,17 +83,147 @@ import { AddressStore } from './storage/address_store/address_store.js';
74
83
  import { AnchorBlockStore } from './storage/anchor_block_store/anchor_block_store.js';
75
84
  import { CapsuleStore } from './storage/capsule_store/capsule_store.js';
76
85
  import { ContractStore } from './storage/contract_store/contract_store.js';
86
+ import { FactStore } from './storage/fact_store/index.js';
77
87
  import { NoteStore } from './storage/note_store/note_store.js';
88
+ import { openPxeStores } from './storage/open_pxe_stores.js';
78
89
  import { PrivateEventStore } from './storage/private_event_store/private_event_store.js';
79
90
  import { RecipientTaggingStore } from './storage/tagging_store/recipient_tagging_store.js';
80
- import { SenderAddressBookStore } from './storage/tagging_store/sender_address_book_store.js';
81
91
  import { SenderTaggingStore } from './storage/tagging_store/sender_tagging_store.js';
92
+ import {
93
+ type SharedSecretKind,
94
+ TaggingSecretSourcesStore,
95
+ } from './storage/tagging_store/tagging_secret_sources_store.js';
96
+ import { persistSenderTaggingIndexRangesForTx } from './tagging/index.js';
82
97
 
83
98
  export type PackedPrivateEvent = InTx & {
84
99
  packedEvent: Fr[];
85
100
  eventSelector: EventSelector;
86
101
  };
87
102
 
103
+ /** Options for PXE.proveTx. */
104
+ export type ProveTxOpts = {
105
+ /** Addresses whose private state and keys are accessible during private execution. */
106
+ scopes: AztecAddress[];
107
+ /** Sender address used to derive discovery tags for private messages (notes, events, logs) this tx emits. */
108
+ senderForTags?: AztecAddress;
109
+ };
110
+
111
+ /** Options for PXE.profileTx. */
112
+ export type ProfileTxOpts = {
113
+ /** The profiling mode to use. */
114
+ profileMode: 'full' | 'execution-steps' | 'gates';
115
+ /** If true, proof generation is skipped during profiling. Defaults to true. */
116
+ skipProofGeneration?: boolean;
117
+ /** Addresses whose private state and keys are accessible during private execution. */
118
+ scopes: AztecAddress[];
119
+ /** Sender address used to derive discovery tags for private messages (notes, events, logs) this tx emits. */
120
+ senderForTags?: AztecAddress;
121
+ };
122
+
123
+ /** Options for PXE.simulateTx. */
124
+ export type SimulateTxOpts = {
125
+ /** Whether to simulate the public part of the transaction. */
126
+ simulatePublic: boolean;
127
+ /** If false, this function throws if the transaction is unable to be included in a block at the current state. */
128
+ skipTxValidation?: boolean;
129
+ /** If false, fees are enforced. */
130
+ skipFeeEnforcement?: boolean;
131
+ /** If true, kernel logic is emulated in TS for simulation */
132
+ skipKernels?: boolean;
133
+ /**
134
+ * Pre-simulation overrides applied to the ephemeral fork and contract DB. Bundles publicStorage
135
+ * writes (no skipKernels required) and per-address (instance, artifact?) overrides used by both
136
+ * AVM-side public dispatch and PXE-side ACIR private dispatch (requires skipKernels: true).
137
+ */
138
+ overrides?: SimulationOverrides;
139
+ /** Addresses whose private state and keys are accessible during private execution */
140
+ scopes: AztecAddress[];
141
+ /** Sender address used to derive discovery tags for private messages (notes, events, logs) this tx emits. */
142
+ senderForTags?: AztecAddress;
143
+ };
144
+
145
+ /** Options for PXE.executeUtility. */
146
+ export type ExecuteUtilityOpts = {
147
+ /** The authentication witnesses required for the function call. */
148
+ authwits?: AuthWitness[];
149
+ /** The accounts whose notes we can access in this call */
150
+ scopes: AztecAddress[];
151
+ };
152
+
153
+ /**
154
+ * Supplies the set of "nice to have" contracts that every PXE preloads regardless of which wallet
155
+ * drives it. Today this is just the standard multi-call entrypoint: the SDK's self-paid account
156
+ * deploy flow ({@link DeployAccountMethod} with `from = NO_FROM`) routes its payload through it, so a
157
+ * PXE that did not register it would fail contract sync with an opaque "no contract instance" error.
158
+ *
159
+ * Returning a list keeps this extensible: a wallet may supply its own provider that preloads
160
+ * additional contracts. Injected the same way as {@link ProtocolContractsProvider} so the PXE never
161
+ * statically imports the bundled artifacts, keeping the bundle/lazy split intact.
162
+ */
163
+ export type PreloadedContractsProvider = {
164
+ /** Returns the contract instances and artifacts the PXE should preload on startup. */
165
+ getPreloadedContracts: () => Promise<Array<{ instance: ContractInstanceWithAddress; artifact: ContractArtifact }>>;
166
+ };
167
+
168
+ /** Args for PXE.create. */
169
+ export type PXECreateArgs = {
170
+ /** The Aztec node to connect to. */
171
+ node: AztecNode;
172
+ /**
173
+ * Optional debug API client. When provided, public function signatures are registered with the node so that
174
+ * node-side public-execution stack traces can be named. Skipped when the node does not expose the debug API.
175
+ */
176
+ nodeDebug?: AztecNodeDebug;
177
+ /** The key-value store for persisting PXE state. */
178
+ store: AztecAsyncKVStore;
179
+ /** The prover for generating private kernel proofs. */
180
+ proofCreator: PrivateKernelProver;
181
+ /** The circuit simulator for executing ACIR circuits. */
182
+ simulator: CircuitSimulator;
183
+ /** Provider for protocol contract artifacts and instances. */
184
+ protocolContractsProvider: ProtocolContractsProvider;
185
+ /**
186
+ * Contracts to preload on startup. Injected by the entrypoint with the bundle-or-lazy flavor that
187
+ * matches the runtime (bundle for node/eager browser, lazy for code-split browser), so the PXE
188
+ * never statically imports a standard-contract artifact and the bundle/lazy split stays intact.
189
+ */
190
+ preloadedContractsProvider: PreloadedContractsProvider;
191
+ /** PXE configuration options. */
192
+ config: PXEConfig;
193
+ /** Optional logger instance or string suffix for the logger name. */
194
+ loggerOrSuffix?: string | Logger;
195
+ /** Optional hooks to observe and influence contract execution. */
196
+ hooks?: ExecutionHooks;
197
+ };
198
+
199
+ /** A source from which PXE derives the tagging secrets it scans for to discover incoming private logs. */
200
+ export type TaggingSecretSource =
201
+ /**
202
+ * Derives a shared secret via ECDH from an external `sender` address against every account registered in this PXE
203
+ * (present and future), so registering one sender applies it to all of them. The address is not secret, so unlike
204
+ * `arbitrary-secret` it can be reused freely across recipients.
205
+ */
206
+ | { kind: 'address-derived'; sender: AztecAddress }
207
+ /**
208
+ * A shared secret point provided directly, scoped to a single recipient. It bypasses ECDH, so it must not be
209
+ * reused across recipients (each would then be able to find the others' tags).
210
+ */
211
+ | { kind: 'arbitrary-secret'; recipient: AztecAddress; secret: Point }
212
+ /**
213
+ * A handshake known by the x-coordinate of its ephemeral public key (the value a recipient learns while authorizing
214
+ * an interactive handshake, which emits no discoverable announcement). The ephemeral key's y-coordinate is always
215
+ * positive by protocol construction, so the x-coordinate alone identifies it.
216
+ */
217
+ | { kind: 'handshake'; recipient: AztecAddress; ephPk: Fr };
218
+
219
+ /**
220
+ * The registered form of a {@link TaggingSecretSource}.
221
+ */
222
+ export type RegisteredTaggingSecretSource =
223
+ | Exclude<TaggingSecretSource, { kind: 'handshake' }>
224
+ /** A handshake's resolved shared secret, derived at registration from the handshake's ephemeral key. */
225
+ | { kind: 'handshake'; recipient: AztecAddress; secret: Point };
226
+
88
227
  /**
89
228
  * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
90
229
  * manage private state of users.
@@ -92,25 +231,35 @@ export type PackedPrivateEvent = InTx & {
92
231
  export class PXE {
93
232
  private constructor(
94
233
  private node: AztecNode,
234
+ private nodeDebug: AztecNodeDebug | undefined,
235
+ private db: AztecAsyncKVStore,
95
236
  private blockStateSynchronizer: BlockSynchronizer,
96
237
  private keyStore: KeyStore,
97
238
  private contractStore: ContractStore,
98
239
  private noteStore: NoteStore,
99
240
  private capsuleStore: CapsuleStore,
241
+ private factStore: FactStore,
100
242
  private anchorBlockStore: AnchorBlockStore,
101
243
  private senderTaggingStore: SenderTaggingStore,
102
- private senderAddressBookStore: SenderAddressBookStore,
244
+ private taggingSecretSourcesStore: TaggingSecretSourcesStore,
103
245
  private recipientTaggingStore: RecipientTaggingStore,
104
246
  private addressStore: AddressStore,
105
247
  private privateEventStore: PrivateEventStore,
248
+ private contractSyncService: ContractSyncService,
249
+ private contractClassService: ContractClassService,
250
+ private txResolver: TxResolverService,
251
+ private l2TipsStore: L2TipsProvider,
106
252
  private simulator: CircuitSimulator,
107
253
  private proverEnabled: boolean,
254
+ private autoSync: boolean,
108
255
  private proofCreator: PrivateKernelProver,
109
256
  private protocolContractsProvider: ProtocolContractsProvider,
257
+ private preloadedContractsProvider: PreloadedContractsProvider,
110
258
  private log: Logger,
111
259
  private jobQueue: SerialQueue,
112
260
  private jobCoordinator: JobCoordinator,
113
261
  public debug: PXEDebugUtils,
262
+ private hooks: ExecutionHooks | undefined,
114
263
  ) {}
115
264
 
116
265
  /**
@@ -120,79 +269,133 @@ export class PXE {
120
269
  *
121
270
  * @returns A promise that resolves PXE is ready to be used.
122
271
  */
123
- public static async create(
124
- node: AztecNode,
125
- store: AztecAsyncKVStore,
126
- proofCreator: PrivateKernelProver,
127
- simulator: CircuitSimulator,
128
- protocolContractsProvider: ProtocolContractsProvider,
129
- config: PXEConfig,
130
- loggerOrSuffix?: string | Logger,
131
- ) {
272
+ public static async create({
273
+ node,
274
+ nodeDebug,
275
+ store,
276
+ proofCreator,
277
+ simulator,
278
+ protocolContractsProvider,
279
+ preloadedContractsProvider,
280
+ config,
281
+ loggerOrSuffix,
282
+ hooks,
283
+ }: PXECreateArgs) {
284
+ // Extract bindings from the logger, or use empty bindings if a string suffix is provided.
285
+ const bindings: LoggerBindings | undefined =
286
+ loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
287
+
132
288
  const log =
133
289
  !loggerOrSuffix || typeof loggerOrSuffix === 'string'
134
290
  ? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
135
291
  : loggerOrSuffix;
136
292
 
137
- const proverEnabled = !!config.proverEnabled;
138
- const addressStore = new AddressStore(store);
139
- const privateEventStore = new PrivateEventStore(store);
140
- const contractStore = new ContractStore(store);
141
- const noteStore = await NoteStore.create(store);
142
- const anchorBlockStore = new AnchorBlockStore(store);
143
- const senderTaggingStore = new SenderTaggingStore(store);
144
- const senderAddressBookStore = new SenderAddressBookStore(store);
145
- const recipientTaggingStore = new RecipientTaggingStore(store);
146
- const capsuleStore = new CapsuleStore(store);
147
- const keyStore = new KeyStore(store);
148
- const tipsStore = new L2TipsKVStore(store, 'pxe');
293
+ const info = await node.getNodeInfo();
294
+
295
+ // Source the genesis block hash from the node so PXE's L2BlockStream agrees with the node's
296
+ // archiver on the dynamic initial header hash. Without this the tip store would fall back to
297
+ // the static `GENESIS_BLOCK_HEADER_HASH` constant, which only matches deployments with the
298
+ // default empty genesis (timestamp 0, no prefilled public data) and diverges otherwise — the
299
+ // sync at block 0 would then get stuck in `areBlockHashesEqualAt` and abort. If the node does
300
+ // not return a genesis block (older node or test fixture) we fall back to the static constant.
301
+ const initialBlockHash = (await node.getBlock(BlockNumber.ZERO))?.hash ?? GENESIS_BLOCK_HEADER_HASH;
302
+
303
+ const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
304
+ const {
305
+ addressStore,
306
+ privateEventStore,
307
+ contractStore,
308
+ noteStore,
309
+ anchorBlockStore,
310
+ senderTaggingStore,
311
+ taggingSecretSourcesStore,
312
+ recipientTaggingStore,
313
+ capsuleStore,
314
+ keyStore,
315
+ l2TipsStore,
316
+ factStore,
317
+ } = openPxeStores(store, initialBlockHash);
318
+ const contractClassService = new ContractClassService(node, contractStore);
319
+ const contractSyncService = new ContractSyncService(
320
+ node,
321
+ contractStore,
322
+ contractClassService,
323
+ noteStore,
324
+ createLogger('pxe:contract_sync', bindings),
325
+ );
326
+ const txResolver = new TxResolverService(node);
327
+
149
328
  const synchronizer = new BlockSynchronizer(
150
329
  node,
151
330
  store,
152
331
  anchorBlockStore,
153
332
  noteStore,
154
333
  privateEventStore,
155
- tipsStore,
334
+ factStore,
335
+ l2TipsStore,
336
+ contractSyncService,
337
+ contractClassService,
156
338
  config,
157
- loggerOrSuffix,
339
+ bindings,
158
340
  );
159
341
 
160
- const jobCoordinator = new JobCoordinator(store);
161
- jobCoordinator.registerStores([capsuleStore, senderTaggingStore, recipientTaggingStore, privateEventStore]);
342
+ const jobCoordinator = new JobCoordinator(store, bindings);
343
+ jobCoordinator.registerStores([
344
+ capsuleStore,
345
+ senderTaggingStore,
346
+ recipientTaggingStore,
347
+ privateEventStore,
348
+ noteStore,
349
+ factStore,
350
+ contractSyncService,
351
+ ]);
162
352
 
163
- const debugUtils = new PXEDebugUtils(contractStore, noteStore);
353
+ const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
164
354
 
165
355
  const jobQueue = new SerialQueue();
166
356
 
167
357
  const pxe = new PXE(
168
358
  node,
359
+ nodeDebug,
360
+ store,
169
361
  synchronizer,
170
362
  keyStore,
171
363
  contractStore,
172
364
  noteStore,
173
365
  capsuleStore,
366
+ factStore,
174
367
  anchorBlockStore,
175
368
  senderTaggingStore,
176
- senderAddressBookStore,
369
+ taggingSecretSourcesStore,
177
370
  recipientTaggingStore,
178
371
  addressStore,
179
372
  privateEventStore,
373
+ contractSyncService,
374
+ contractClassService,
375
+ txResolver,
376
+ l2TipsStore,
180
377
  simulator,
181
378
  proverEnabled,
379
+ config.autoSync,
182
380
  proofCreator,
183
381
  protocolContractsProvider,
382
+ preloadedContractsProvider,
184
383
  log,
185
384
  jobQueue,
186
385
  jobCoordinator,
187
386
  debugUtils,
387
+ hooks,
188
388
  );
189
389
 
190
- debugUtils.setPXE(pxe);
390
+ debugUtils.setPXEHelpers(
391
+ pxe.#putInJobQueue.bind(pxe),
392
+ pxe.#getSimulatorForTx.bind(pxe),
393
+ pxe.#executeUtility.bind(pxe),
394
+ );
191
395
 
192
396
  pxe.jobQueue.start();
193
397
 
194
- await pxe.#registerProtocolContracts();
195
- const info = await node.getNodeInfo();
398
+ await Promise.all([pxe.#registerProtocolContracts(), pxe.#registerPreloadedContracts()]);
196
399
  log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
197
400
  return pxe;
198
401
  }
@@ -200,22 +403,50 @@ export class PXE {
200
403
  // Internal methods
201
404
 
202
405
  #getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
203
- const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
406
+ return new ContractFunctionSimulator({
407
+ contractStore: this.contractStore,
408
+ contractClassService: this.contractClassService,
409
+ overrides: overrides?.contracts,
410
+ noteStore: this.noteStore,
411
+ keyStore: this.keyStore,
412
+ addressStore: this.addressStore,
413
+ aztecNode: BenchmarkedNodeFactory.create(this.node),
414
+ l2TipsStore: this.l2TipsStore,
415
+ senderTaggingStore: this.senderTaggingStore,
416
+ recipientTaggingStore: this.recipientTaggingStore,
417
+ taggingSecretSourcesStore: this.taggingSecretSourcesStore,
418
+ capsuleStore: this.capsuleStore,
419
+ factStore: this.factStore,
420
+ privateEventStore: this.privateEventStore,
421
+ simulator: this.simulator,
422
+ contractSyncService: this.contractSyncService,
423
+ txResolver: this.txResolver,
424
+ hooks: this.hooks,
425
+ });
426
+ }
204
427
 
205
- return new ContractFunctionSimulator(
206
- proxyContractStore,
207
- this.noteStore,
208
- this.keyStore,
209
- this.addressStore,
210
- BenchmarkedNodeFactory.create(this.node),
211
- this.anchorBlockStore,
212
- this.senderTaggingStore,
213
- this.recipientTaggingStore,
214
- this.senderAddressBookStore,
215
- this.capsuleStore,
216
- this.privateEventStore,
217
- this.simulator,
218
- );
428
+ /** Best-effort debug function name for the class `address` runs at `anchorBlockHeader`. Used for log display only. */
429
+ async #getDebugFunctionName(
430
+ address: AztecAddress,
431
+ selector: FunctionSelector,
432
+ anchorBlockHeader: BlockHeader,
433
+ ): Promise<string> {
434
+ try {
435
+ const classId = await this.contractClassService.getCurrentClassId(address, anchorBlockHeader);
436
+ return classId ? await this.contractStore.getDebugFunctionName(classId, selector) : `${address}:${selector}`;
437
+ } catch {
438
+ return `${address}:${selector}`;
439
+ }
440
+ }
441
+
442
+ /** Best-effort debug contract name for the class `address` runs at `anchorBlockHeader`. Used for log display only. */
443
+ async #getDebugContractName(address: AztecAddress, anchorBlockHeader: BlockHeader): Promise<string | undefined> {
444
+ try {
445
+ const classId = await this.contractClassService.getCurrentClassId(address, anchorBlockHeader);
446
+ return classId ? await this.contractStore.getDebugContractName(classId) : undefined;
447
+ } catch {
448
+ return undefined;
449
+ }
219
450
  }
220
451
 
221
452
  #contextualizeError(err: Error, ...context: string[]): Error {
@@ -265,75 +496,112 @@ export class PXE {
265
496
  }
266
497
 
267
498
  async #registerProtocolContracts() {
268
- const registered: Record<string, string> = {};
269
- for (const name of protocolContractNames) {
270
- const { address, contractClass, instance, artifact } =
271
- await this.protocolContractsProvider.getProtocolContractArtifact(name);
272
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
273
- await this.contractStore.addContractInstance(instance);
274
- registered[name] = address.toString();
275
- }
499
+ const registered = Object.fromEntries(
500
+ await Promise.all(
501
+ protocolContractNames.map(async name => {
502
+ const { address, instance, artifact } =
503
+ await this.protocolContractsProvider.getProtocolContractArtifact(name);
504
+ await this.contractStore.addContractArtifact(artifact);
505
+ await this.contractStore.addContractInstance(instance);
506
+ return [name, address.toString()] as const;
507
+ }),
508
+ ),
509
+ );
276
510
  this.log.verbose(`Registered protocol contracts in pxe`, registered);
277
511
  }
278
512
 
513
+ async #registerPreloadedContracts() {
514
+ const contracts = await this.preloadedContractsProvider.getPreloadedContracts();
515
+ await Promise.all(
516
+ contracts.map(async ({ instance, artifact }) => {
517
+ if (artifact) {
518
+ await this.registerContractClass(artifact);
519
+ }
520
+ await this.registerContract(instance);
521
+ }),
522
+ );
523
+ this.log.verbose(`Registered preloaded contracts in pxe`, {
524
+ contracts: contracts.map(({ instance }) => instance.address.toString()),
525
+ });
526
+ }
527
+
279
528
  // Executes the entrypoint private function, as well as all nested private
280
529
  // functions that might arise.
281
- async #executePrivate(
282
- contractFunctionSimulator: ContractFunctionSimulator,
283
- txRequest: TxExecutionRequest,
284
- scopes: AztecAddress[] | undefined,
285
- jobId: string,
286
- ): Promise<PrivateExecutionResult> {
530
+ async #executePrivate({
531
+ contractFunctionSimulator,
532
+ txRequest,
533
+ anchorBlockHeader,
534
+ scopes,
535
+ jobId,
536
+ senderForTags,
537
+ }: {
538
+ contractFunctionSimulator: ContractFunctionSimulator;
539
+ txRequest: TxExecutionRequest;
540
+ anchorBlockHeader: BlockHeader;
541
+ scopes: AztecAddress[];
542
+ jobId: string;
543
+ senderForTags?: AztecAddress;
544
+ }): Promise<PrivateExecutionResult> {
287
545
  const { origin: contractAddress, functionSelector } = txRequest;
288
546
 
289
547
  try {
290
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
291
-
292
- const result = await contractFunctionSimulator.run(
293
- txRequest,
548
+ await this.contractSyncService.ensureContractSynced(
294
549
  contractAddress,
295
550
  functionSelector,
296
- undefined,
551
+ (privateSyncCall, execScopes) =>
552
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
297
553
  anchorBlockHeader,
298
- // The sender for tags is set by contracts, typically by an account
299
- // contract entrypoint
300
- undefined, // senderForTags
301
- scopes,
302
554
  jobId,
555
+ scopes,
303
556
  );
557
+
558
+ const result = await contractFunctionSimulator.run(txRequest, {
559
+ anchorBlockHeader,
560
+ scopes,
561
+ jobId,
562
+ senderForTags,
563
+ });
304
564
  this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
305
565
  return result;
306
566
  } catch (err) {
307
567
  if (err instanceof SimulationError) {
308
- await enrichSimulationError(err, this.contractStore, this.log);
568
+ await enrichSimulationError(err, this.contractStore, this.contractClassService, anchorBlockHeader, this.log);
309
569
  }
310
570
  throw err;
311
571
  }
312
572
  }
313
573
 
314
574
  /**
315
- * Simulate a utility function call on the given contract.
575
+ * Execute a utility function call on the given contract.
316
576
  * @param contractFunctionSimulator - The simulator to use for the function call.
317
577
  * @param call - The function call to execute.
318
578
  * @param authWitnesses - Authentication witnesses required for the function call.
319
579
  * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
320
580
  * accounts if not specified.
321
581
  * @param jobId - The job ID for staged writes.
322
- * @returns The simulation result containing the outputs of the utility function.
582
+ * @returns The execution result containing the outputs of the utility function.
323
583
  */
324
- async #simulateUtility(
584
+ async #executeUtility(
325
585
  contractFunctionSimulator: ContractFunctionSimulator,
326
586
  call: FunctionCall,
327
587
  authWitnesses: AuthWitness[] | undefined,
328
- scopes: AztecAddress[] | undefined,
588
+ scopes: AztecAddress[],
329
589
  jobId: string,
330
590
  ) {
331
591
  try {
332
592
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
333
- return contractFunctionSimulator.runUtility(call, authWitnesses ?? [], anchorBlockHeader, scopes, jobId);
593
+ const { result, offchainEffects } = await contractFunctionSimulator.runUtility(
594
+ call,
595
+ authWitnesses ?? [],
596
+ anchorBlockHeader,
597
+ scopes,
598
+ jobId,
599
+ );
600
+ return { result, offchainEffects };
334
601
  } catch (err) {
335
602
  if (err instanceof SimulationError) {
336
- await enrichSimulationError(err, this.contractStore, this.log);
603
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
604
+ await enrichSimulationError(err, this.contractStore, this.contractClassService, anchorBlockHeader, this.log);
337
605
  }
338
606
  throw err;
339
607
  }
@@ -345,11 +613,11 @@ export class PXE {
345
613
  * It can also be used for estimating gas in the future.
346
614
  * @param tx - The transaction to be simulated.
347
615
  */
348
- async #simulatePublicCalls(tx: Tx, skipFeeEnforcement: boolean) {
616
+ async #simulatePublicCalls(tx: Tx, skipFeeEnforcement: boolean, overrides?: SimulationOverrides) {
349
617
  // Simulating public calls can throw if the TX fails in a phase that doesn't allow reverts (setup)
350
618
  // Or return as reverted if it fails in a phase that allows reverts (app logic, teardown)
351
619
  try {
352
- const result = await this.node.simulatePublicCalls(tx, skipFeeEnforcement);
620
+ const result = await this.node.simulatePublicCalls(tx, skipFeeEnforcement, overrides);
353
621
  if (result.revertReason) {
354
622
  throw result.revertReason;
355
623
  }
@@ -357,7 +625,14 @@ export class PXE {
357
625
  } catch (err) {
358
626
  if (err instanceof SimulationError) {
359
627
  try {
360
- await enrichPublicSimulationError(err, this.contractStore, this.log);
628
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
629
+ await enrichPublicSimulationError(
630
+ err,
631
+ this.contractStore,
632
+ this.contractClassService,
633
+ anchorBlockHeader,
634
+ this.log,
635
+ );
361
636
  } catch (enrichErr) {
362
637
  this.log.error(`Failed to enrich public simulation error: ${enrichErr}`);
363
638
  }
@@ -381,19 +656,64 @@ export class PXE {
381
656
  txExecutionRequest: TxExecutionRequest,
382
657
  proofCreator: PrivateKernelProver,
383
658
  privateExecutionResult: PrivateExecutionResult,
659
+ anchorBlockHeader: BlockHeader,
384
660
  config: PrivateKernelExecutionProverConfig,
385
661
  ): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>> {
386
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
387
- const anchorBlockHash = L2BlockHash.fromField(await anchorBlockHeader.hash());
388
- const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHash);
389
- const kernelTraceProver = new PrivateKernelExecutionProver(kernelOracle, proofCreator, !this.proverEnabled);
662
+ const kernelOracle = new PrivateKernelOracle(
663
+ this.contractStore,
664
+ this.contractClassService,
665
+ this.keyStore,
666
+ this.node,
667
+ anchorBlockHeader,
668
+ );
669
+ const kernelTraceProver = new PrivateKernelExecutionProver(
670
+ kernelOracle,
671
+ proofCreator,
672
+ !this.proverEnabled,
673
+ this.log.getBindings(),
674
+ );
390
675
  this.log.debug(`Executing kernel trace prover (${JSON.stringify(config)})...`);
391
676
  return await kernelTraceProver.proveWithKernels(txExecutionRequest.toTxRequest(), privateExecutionResult, config);
392
677
  }
393
678
 
679
+ /**
680
+ * Syncs with the node only when `autoSync` is enabled.
681
+ * When `autoSync` is disabled, callers (typically a wallet) are
682
+ * responsible for invoking `pxe.sync()` at the right granularity.
683
+ */
684
+ async #maybeSync(): Promise<void> {
685
+ if (this.autoSync) {
686
+ await this.blockStateSynchronizer.sync();
687
+ }
688
+ }
689
+
394
690
  // Public API
395
691
 
396
- public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
692
+ /**
693
+ * Triggers a sync of PXE state with the node, regardless of the `autoSync` config flag. Use this to
694
+ * batch syncs across composite flows when `autoSync` is disabled (e.g. one sync per simulate+send
695
+ * instead of one per inner PXE call). Serialized through the job queue.
696
+ */
697
+ public sync(): Promise<void> {
698
+ return this.#putInJobQueue(() => this.blockStateSynchronizer.sync());
699
+ }
700
+
701
+ /**
702
+ * Returns the block header up to which the PXE has synced.
703
+ * @returns The synced block header
704
+ */
705
+ public getSyncedBlockHeader(): Promise<BlockHeader> {
706
+ return this.#putInJobQueue(() => {
707
+ return this.anchorBlockStore.getBlockHeader();
708
+ });
709
+ }
710
+
711
+ /**
712
+ * Returns the address preimage of the contract instance at a given address, if it's registered in the PXE.
713
+ * @param address - The contract address.
714
+ * @returns The contract instance address preimage if found, undefined otherwise.
715
+ */
716
+ public getContractInstance(address: AztecAddress): Promise<ContractInstancePreimageWithAddress | undefined> {
397
717
  return this.contractStore.getContractInstance(address);
398
718
  }
399
719
 
@@ -407,19 +727,23 @@ export class PXE {
407
727
  }
408
728
 
409
729
  /**
410
- * Registers a user account in PXE given its master encryption private key.
411
- * Once a new account is registered, the PXE will trial-decrypt all published notes on
412
- * the chain and store those that correspond to the registered account. Will do nothing if the
413
- * account is already registered.
730
+ * Registers a user account in PXE.
731
+ *
732
+ * PXE holds the account's four privacy secret keys but only the *public* message-signing and fallback keys: their
733
+ * secret keys are withheld, since PXE is not trusted to hold them.
734
+ *
735
+ * Does nothing if the account is already registered.
414
736
  *
415
- * @param secretKey - Secret key of the corresponding user master public key.
737
+ * The four privacy secret keys can be retrieved later with {@link getAccountSecretKeys}.
738
+ *
739
+ * @param keys - The account's privacy keys: four secret keys plus the message-signing and fallback public keys.
416
740
  * @param partialAddress - The partial address of the account contract corresponding to the account being registered.
417
741
  * @returns The complete address of the account.
418
742
  */
419
- public async registerAccount(secretKey: Fr, partialAddress: PartialAddress): Promise<CompleteAddress> {
743
+ public async registerAccount(keys: AccountPrivacyKeys, partialAddress: PartialAddress): Promise<CompleteAddress> {
420
744
  const accounts = await this.keyStore.getAccounts();
421
- const accountCompleteAddress = await this.keyStore.addAccount(secretKey, partialAddress);
422
- if (accounts.includes(accountCompleteAddress.address)) {
745
+ const accountCompleteAddress = await this.keyStore.addAccount(keys, partialAddress);
746
+ if (accounts.some(a => a.equals(accountCompleteAddress.address))) {
423
747
  this.log.info(`Account:\n "${accountCompleteAddress.address.toString()}"\n already registered.`);
424
748
  return accountCompleteAddress;
425
749
  } else {
@@ -428,58 +752,190 @@ export class PXE {
428
752
  }
429
753
 
430
754
  await this.addressStore.addCompleteAddress(accountCompleteAddress);
431
- await this.noteStore.addScope(accountCompleteAddress.address);
432
755
  return accountCompleteAddress;
433
756
  }
434
757
 
435
758
  /**
436
- * Registers a sender in this PXE.
759
+ * Retrieves the four privacy secret keys PXE holds for a registered account (nullifier-hiding, incoming-viewing,
760
+ * outgoing-viewing, tagging).
761
+ *
762
+ * These do NOT grant control over an account's assets, e.g. they are insufficient to impersonate the account or to
763
+ * spend notes, but they _do_ guard the account's privacy. Parties that have knowledge of these keys can decrypt all
764
+ * messages sent to the account, discover all of their on-chain activity, including notes, events, etc.
437
765
  *
438
- * After registering a new sender, the PXE will sync private logs that are tagged with this sender's address.
439
- * Will do nothing if the address is already registered.
766
+ * Security is paramount when handling these keys, which should itself be a very rare occurrence. Other than exporting
767
+ * and then importing an account into a separate PXE/wallet, there is typically no need for a wallet to ever access
768
+ * these keys. Applications should NEVER be given access to them.
440
769
  *
441
- * @param sender - Address of the sender to register.
442
- * @returns The address of the sender.
443
- * TODO: It's strange that we return the address here and I (benesjan) think we should drop the return value.
770
+ * @throws If the account is not registered.
444
771
  */
445
- public async registerSender(sender: AztecAddress): Promise<AztecAddress> {
446
- const accounts = await this.keyStore.getAccounts();
447
- if (accounts.includes(sender)) {
448
- this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
449
- return sender;
450
- }
772
+ public getAccountSecretKeys(account: AztecAddress): Promise<AccountPrivacySecretKeys> {
773
+ return this.keyStore.getAccountSecretKeys(account);
774
+ }
451
775
 
452
- const wasAdded = await this.senderAddressBookStore.addSender(sender);
776
+ /**
777
+ * Registers a source from which this PXE derives the tagging secrets it scans for to discover incoming private logs.
778
+ * See {@link TaggingSecretSource} for the meaning of each variant. Does nothing if the source is already registered.
779
+ *
780
+ * After a new source is added we clear the cache tracking which contracts have finished syncing, so every contract
781
+ * re-syncs against the new source's logs (whose notes/events could belong to any contract). Already-discovered
782
+ * notes/events are not discarded.
783
+ */
784
+ public async registerTaggingSecretSource(source: TaggingSecretSource): Promise<void> {
785
+ let wasAdded: boolean;
786
+
787
+ switch (source.kind) {
788
+ case 'address-derived':
789
+ wasAdded = await this.#registerSender(source.sender);
790
+ break;
791
+ case 'arbitrary-secret':
792
+ wasAdded = await this.#registerSharedSecret(source.recipient, 'arbitrary-secret', source.secret);
793
+ break;
794
+ case 'handshake':
795
+ wasAdded = await this.#registerSharedSecret(
796
+ source.recipient,
797
+ 'handshake',
798
+ await this.#deriveHandshakeSecret(source.recipient, source.ephPk),
799
+ );
800
+ break;
801
+ default: {
802
+ const _: never = source;
803
+ throw new Error('Unhandled tagging secret source kind');
804
+ }
805
+ }
453
806
 
454
807
  if (wasAdded) {
455
- this.log.info(`Added sender:\n ${sender.toString()}`);
456
- } else {
457
- this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
808
+ // Queued to avoid wiping while a job is in flight.
809
+ await this.#putInJobQueue(() => Promise.resolve(this.contractSyncService.wipe()));
458
810
  }
811
+ }
459
812
 
460
- return sender;
813
+ /**
814
+ * Removes a previously registered tagging secret source, identified by its registered form (see
815
+ * {@link getTaggingSecretSources}). Does nothing if it was not registered.
816
+ */
817
+ public async removeTaggingSecretSource(source: RegisteredTaggingSecretSource): Promise<void> {
818
+ switch (source.kind) {
819
+ case 'address-derived': {
820
+ const { sender } = source;
821
+ const wasRemoved = await this.taggingSecretSourcesStore.removeSender(sender);
822
+ this.log.info(
823
+ wasRemoved
824
+ ? `Removed sender:\n ${sender.toString()}`
825
+ : `Sender:\n "${sender.toString()}"\n not registered in PXE.`,
826
+ );
827
+ break;
828
+ }
829
+ case 'arbitrary-secret':
830
+ case 'handshake': {
831
+ const { kind, recipient, secret } = source;
832
+ const wasRemoved = await this.taggingSecretSourcesStore.removeSharedSecret(recipient, kind, secret);
833
+ this.log.info(
834
+ wasRemoved
835
+ ? `Removed ${kind} shared secret for recipient:\n ${recipient.toString()}`
836
+ : `No ${kind} shared secret registered for recipient:\n ${recipient.toString()}`,
837
+ );
838
+ break;
839
+ }
840
+ default: {
841
+ const _: never = source;
842
+ throw new Error('Unhandled tagging secret source kind');
843
+ }
844
+ }
461
845
  }
462
846
 
463
847
  /**
464
- * Retrieves senders registered in this PXE.
465
- * @returns Senders registered in this PXE.
848
+ * Retrieves the tagging secret sources registered in this PXE, in their registered form. Without a filter it
849
+ * returns every source; pass `{ kind }` to narrow to a single variant. See {@link RegisteredTaggingSecretSource}.
466
850
  */
467
- public getSenders(): Promise<AztecAddress[]> {
468
- return this.senderAddressBookStore.getSenders();
851
+ public getTaggingSecretSources<K extends RegisteredTaggingSecretSource['kind']>(filter: {
852
+ kind: K;
853
+ }): Promise<Extract<RegisteredTaggingSecretSource, { kind: K }>[]>;
854
+ public getTaggingSecretSources(): Promise<RegisteredTaggingSecretSource[]>;
855
+ public async getTaggingSecretSources(filter?: {
856
+ kind?: RegisteredTaggingSecretSource['kind'];
857
+ }): Promise<RegisteredTaggingSecretSource[]> {
858
+ const [senders, secrets] = await Promise.all([
859
+ this.taggingSecretSourcesStore.getSenders(),
860
+ this.taggingSecretSourcesStore.getAllSharedSecrets(),
861
+ ]);
862
+
863
+ const sources: RegisteredTaggingSecretSource[] = [
864
+ ...senders.map((sender): RegisteredTaggingSecretSource => ({ kind: 'address-derived', sender })),
865
+ ...secrets.map(({ recipient, kind, secret }): RegisteredTaggingSecretSource => ({ kind, recipient, secret })),
866
+ ];
867
+
868
+ return filter?.kind ? sources.filter(source => source.kind === filter.kind) : sources;
869
+ }
870
+
871
+ /** Registers a sender, skipping addresses that belong to a local account. Returns whether it was newly added. */
872
+ async #registerSender(address: AztecAddress): Promise<boolean> {
873
+ if (!(await address.isValid())) {
874
+ throw new Error(
875
+ `Address ${address} is not valid: it does not correspond to a point on the Grumpkin curve. Cannot register it as a sender.`,
876
+ );
877
+ }
878
+
879
+ const accounts = await this.keyStore.getAccounts();
880
+ if (accounts.some(a => a.equals(address))) {
881
+ this.log.info(`Sender:\n "${address.toString()}"\n already registered.`);
882
+ return false;
883
+ }
884
+
885
+ const wasAdded = await this.taggingSecretSourcesStore.addSender(address);
886
+ this.log.info(
887
+ wasAdded ? `Added sender:\n ${address.toString()}` : `Sender:\n "${address.toString()}"\n already registered.`,
888
+ );
889
+ return wasAdded;
469
890
  }
470
891
 
471
892
  /**
472
- * Removes a sender registered in this PXE.
473
- * @param sender - The address of the sender to remove.
893
+ * Derives the shared secret of a handshake from its ephemeral public key: `S = addressSecret(recipient) * ephPk`,
894
+ * the same derivation the recipient-side scan uses for handshakes discovered onchain. The ephemeral key is
895
+ * reconstructed from its x-coordinate with a positive y, matching how the protocol generates it.
896
+ *
897
+ * @throws If `ephPk` is not the x-coordinate of a Grumpkin curve point, or if `recipient` is not an account of
898
+ * this PXE, since the derivation needs its keys.
474
899
  */
475
- public async removeSender(sender: AztecAddress): Promise<void> {
476
- const wasRemoved = await this.senderAddressBookStore.removeSender(sender);
900
+ async #deriveHandshakeSecret(recipient: AztecAddress, ephPk: Fr): Promise<Point> {
901
+ let ephPkPoint: Point;
902
+ try {
903
+ ephPkPoint = await Point.fromXAndSign(ephPk, true);
904
+ } catch {
905
+ throw new Error(`Ephemeral public key x-coordinate ${ephPk} does not correspond to a Grumpkin curve point.`);
906
+ }
477
907
 
478
- if (wasRemoved) {
479
- this.log.info(`Removed sender:\n ${sender.toString()}`);
480
- } else {
481
- this.log.info(`Sender:\n "${sender.toString()}"\n not registered in PXE.`);
908
+ const completeAddress = await this.addressStore.getCompleteAddress(recipient);
909
+ if (!completeAddress || !(await this.keyStore.hasAccount(recipient))) {
910
+ throw new Error(
911
+ `Recipient ${recipient} is not an account of this PXE. A handshake's shared secret can only be derived for an account whose keys are held.`,
912
+ );
482
913
  }
914
+
915
+ const ivskM = await this.keyStore.getMasterIncomingViewingSecretKey(recipient);
916
+ const addressSecret = await computeAddressSecret(await completeAddress.getPreaddress(), ivskM);
917
+ return deriveEcdhSharedSecretPoint(addressSecret, ephPkPoint);
918
+ }
919
+
920
+ /** Registers a resolved shared secret scoped to a recipient. Returns whether it was newly added. */
921
+ async #registerSharedSecret(recipient: AztecAddress, kind: SharedSecretKind, secret: Point): Promise<boolean> {
922
+ if (!(await recipient.isValid())) {
923
+ throw new Error(
924
+ `Recipient ${recipient} is not valid: it does not correspond to a point on the Grumpkin curve. Cannot register a shared secret for it.`,
925
+ );
926
+ }
927
+
928
+ if (secret.isZero() || !secret.isOnCurve()) {
929
+ throw new Error(`Shared secret ${secret} is not a valid non-zero point on the Grumpkin curve.`);
930
+ }
931
+
932
+ const wasAdded = await this.taggingSecretSourcesStore.addSharedSecret(recipient, kind, secret);
933
+ this.log.info(
934
+ wasAdded
935
+ ? `Added ${kind} shared secret for recipient:\n ${recipient.toString()}`
936
+ : `${kind} shared secret already registered for recipient:\n ${recipient.toString()}`,
937
+ );
938
+ return wasAdded;
483
939
  }
484
940
 
485
941
  /**
@@ -502,95 +958,34 @@ export class PXE {
502
958
  * @param artifact - The build artifact for the contract class.
503
959
  */
504
960
  public async registerContractClass(artifact: ContractArtifact): Promise<void> {
505
- const { id: contractClassId } = await getContractClassFromArtifact(artifact);
506
- await this.contractStore.addContractArtifact(contractClassId, artifact);
961
+ const contractClassId = await this.contractStore.addContractArtifact(artifact);
962
+ // Publishing the artifact's public function signatures to the node is part of "registering a class", so that
963
+ // node-side debugging works regardless of which entrypoint (registerContractClass or registerContract) was used.
964
+ const publicFunctionSignatures = artifact.functions
965
+ .filter(fn => fn.functionType === FunctionType.PUBLIC)
966
+ .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
967
+ if (publicFunctionSignatures.length > 0) {
968
+ await this.nodeDebug?.registerContractFunctionSignatures(publicFunctionSignatures);
969
+ }
507
970
  this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
508
971
  }
509
972
 
510
973
  /**
511
- * Adds deployed contracts to the PXE. Deployed contract information is used to access the
512
- * contract code when simulating local transactions. This is automatically called by aztec.js when
513
- * deploying a contract. Dapps that wish to interact with contracts already deployed should register
514
- * these contracts in their users' PXE through this method.
974
+ * Registers a deployed contract instance so its private state can be synced and its functions simulated. The
975
+ * artifact for the class the instance runs must be registered separately via {@link registerContractClass}, before
976
+ * or after this call; registration performs no validation, so a missing or mismatched artifact only surfaces when
977
+ * the contract is later simulated. This is automatically called by aztec.js when deploying a contract.
515
978
  *
516
- * @param contract - A contract instance to register, with an optional artifact which can be omitted if the contract class has already been registered.
517
- */
518
- public async registerContract(contract: { instance: ContractInstanceWithAddress; artifact?: ContractArtifact }) {
519
- const { instance } = contract;
520
- let { artifact } = contract;
521
-
522
- if (artifact) {
523
- // If the user provides an artifact, validate it against the expected class id and register it
524
- const contractClass = await getContractClassFromArtifact(artifact);
525
- const contractClassId = contractClass.id;
526
- if (!contractClassId.equals(instance.currentContractClassId)) {
527
- throw new Error(
528
- `Artifact does not match expected class id (computed ${contractClassId} but instance refers to ${instance.currentContractClassId})`,
529
- );
530
- }
531
- const computedAddress = await computeContractAddressFromInstance(instance);
532
- if (!computedAddress.equals(instance.address)) {
533
- throw new Error('Added a contract in which the address does not match the contract instance.');
534
- }
535
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
536
-
537
- const publicFunctionSignatures = artifact.functions
538
- .filter(fn => fn.functionType === FunctionType.PUBLIC)
539
- .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
540
- await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
541
- } else {
542
- // Otherwise, make sure there is an artifact already registered for that class id
543
- artifact = await this.contractStore.getContractArtifact(instance.currentContractClassId);
544
- if (!artifact) {
545
- throw new Error(
546
- `Artifact not found when registering an instance. Contract class: ${instance.currentContractClassId}.`,
547
- );
548
- }
549
- }
550
-
551
- await this.contractStore.addContractInstance(instance);
552
- this.log.info(
553
- `Added contract ${artifact.name} at ${instance.address.toString()} with class ${instance.currentContractClassId}`,
554
- );
555
- }
556
-
557
- /**
558
- * Updates a deployed contract in the PXE. This is used to update the contract artifact when
559
- * an update has happened, so the new code can be used in the simulation of local transactions.
560
- * This is called by aztec.js when instantiating a contract in a given address with a mismatching artifact.
561
- * @param contractAddress - The address of the contract to update.
562
- * @param artifact - The updated artifact for the contract.
563
- * @throws If the artifact's contract class is not found in the PXE or if the contract class is different from
564
- * the current one (current one from the point of view of the node to which the PXE is connected).
979
+ * @param instance - The address preimage of the contract instance to register. The address is derived from it.
980
+ * @returns The address of the registered instance.
565
981
  */
566
- public updateContract(contractAddress: AztecAddress, artifact: ContractArtifact): Promise<void> {
567
- // We disable concurrently updating contracts to avoid concurrently syncing with the node, or changing a contract's
568
- // class while we're simulating it.
982
+ public registerContract(instance: ContractInstancePreimage): Promise<AztecAddress> {
983
+ // Run inside the job queue so we can't race a concurrent simulation while writing the instance to the store.
569
984
  return this.#putInJobQueue(async () => {
570
- const currentInstance = await this.contractStore.getContractInstance(contractAddress);
571
- if (!currentInstance) {
572
- throw new Error(`Instance not found when updating a contract. Contract address: ${contractAddress}.`);
573
- }
574
- const contractClass = await getContractClassFromArtifact(artifact);
575
- await this.blockStateSynchronizer.sync();
576
-
577
- const header = await this.anchorBlockStore.getBlockHeader();
578
-
579
- const currentClassId = await readCurrentClassId(contractAddress, currentInstance, this.node, header);
580
- if (!contractClass.id.equals(currentClassId)) {
581
- throw new Error('Could not update contract to a class different from the current one.');
582
- }
583
-
584
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
585
-
586
- const publicFunctionSignatures = artifact.functions
587
- .filter(fn => fn.functionType === FunctionType.PUBLIC)
588
- .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
589
- await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
590
-
591
- currentInstance.currentContractClassId = contractClass.id;
592
- await this.contractStore.addContractInstance(currentInstance);
593
- this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
985
+ const address = await computeContractAddressFromInstance(instance);
986
+ await this.contractStore.addContractInstance({ ...instance, address });
987
+ this.log.info(`Added contract at ${address}`, { address });
988
+ return address;
594
989
  });
595
990
  }
596
991
 
@@ -607,11 +1002,12 @@ export class PXE {
607
1002
  * (where validators prove the public portion).
608
1003
  *
609
1004
  * @param txRequest - An authenticated tx request ready for proving
1005
+ * @param scopes - Addresses whose private state and keys are accessible during private execution.
610
1006
  * @returns A result containing the proof and public inputs of the tail circuit.
611
1007
  * @throws If contract code not found, or public simulation reverts.
612
1008
  * Also throws if simulatePublic is true and public simulation reverts.
613
1009
  */
614
- public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
1010
+ public proveTx(txRequest: TxExecutionRequest, { scopes, senderForTags }: ProveTxOpts): Promise<TxProvingResult> {
615
1011
  let privateExecutionResult: PrivateExecutionResult;
616
1012
  // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
617
1013
  // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
@@ -619,17 +1015,25 @@ export class PXE {
619
1015
  const totalTimer = new Timer();
620
1016
  try {
621
1017
  const syncTimer = new Timer();
622
- await this.blockStateSynchronizer.sync();
1018
+ await this.#maybeSync();
1019
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
623
1020
  const syncTime = syncTimer.ms();
624
1021
  const contractFunctionSimulator = this.#getSimulatorForTx();
625
- privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, undefined, jobId);
1022
+ privateExecutionResult = await this.#executePrivate({
1023
+ contractFunctionSimulator,
1024
+ txRequest,
1025
+ anchorBlockHeader,
1026
+ scopes,
1027
+ jobId,
1028
+ senderForTags,
1029
+ });
626
1030
 
627
1031
  const {
628
1032
  publicInputs,
629
1033
  chonkProof,
630
1034
  executionSteps,
631
1035
  timings: { proving } = {},
632
- } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, {
1036
+ } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, anchorBlockHeader, {
633
1037
  simulate: false,
634
1038
  skipFeeEnforcement: false,
635
1039
  profileMode: 'none',
@@ -659,23 +1063,20 @@ export class PXE {
659
1063
  nodeRPCCalls: contractFunctionSimulator?.getStats().nodeRPCCalls,
660
1064
  });
661
1065
 
662
- // While not strictly necessary to store tagging cache contents in the DB since we sync tagging indexes from
663
- // chain before sending new logs, the sync can only see logs already included in blocks. If we send another
664
- // transaction before this one is included in a block from this PXE, and that transaction contains a log with
665
- // a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
666
- // storing the tags here prevents linkage of txs sent from the same PXE.
667
- const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
668
- if (preTagsUsedInTheTx.length > 0) {
669
- // TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
670
- const txHash = (await txProvingResult.toTx()).txHash;
671
-
672
- await this.senderTaggingStore.storePendingIndexes(preTagsUsedInTheTx, txHash, jobId);
673
- this.log.debug(`Stored used pre-tags as sender for the tx`, {
674
- preTagsUsedInTheTx,
675
- });
676
- } else {
677
- this.log.debug(`No pre-tags used in the tx`);
678
- }
1066
+ // We keep track of which tagging indices we've used in this tx so that we don't repeat them in future txs
1067
+ // (which would link them) without having to rely on this tx being mined (and us seeing the indices being used
1068
+ // onchain).
1069
+ // Note that this must happen _after_ proving as it requires the proof's public inputs, from which the kernels
1070
+ // may have removed some logs due to note-nullifier squashing - this may lead to range of tagging indices we've
1071
+ // actually used to being reduced.
1072
+ await persistSenderTaggingIndexRangesForTx(
1073
+ this.senderTaggingStore,
1074
+ privateExecutionResult.entrypoint.taggingIndexRanges,
1075
+ publicInputs,
1076
+ () => txProvingResult.getTxHash(),
1077
+ jobId,
1078
+ this.log,
1079
+ );
679
1080
 
680
1081
  return txProvingResult;
681
1082
  } catch (err: any) {
@@ -686,17 +1087,13 @@ export class PXE {
686
1087
 
687
1088
  /**
688
1089
  * Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
689
- *
690
- * @param txRequest - An authenticated tx request ready for simulation
691
- * @param msgSender - (Optional) The message sender to use for the simulation.
692
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
1090
+ * @param txRequest - An authenticated tx request ready for simulation.
693
1091
  * @returns A trace of the program execution with gate counts.
694
1092
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
695
1093
  */
696
1094
  public profileTx(
697
1095
  txRequest: TxExecutionRequest,
698
- profileMode: 'full' | 'execution-steps' | 'gates',
699
- skipProofGeneration: boolean = true,
1096
+ { profileMode, skipProofGeneration = true, scopes, senderForTags }: ProfileTxOpts,
700
1097
  ): Promise<TxProfileResult> {
701
1098
  // We disable concurrent profiles for consistency with simulateTx.
702
1099
  return this.#putInJobQueue(async jobId => {
@@ -715,21 +1112,25 @@ export class PXE {
715
1112
  txInfo,
716
1113
  );
717
1114
  const syncTimer = new Timer();
718
- await this.blockStateSynchronizer.sync();
1115
+ await this.#maybeSync();
1116
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
719
1117
  const syncTime = syncTimer.ms();
720
1118
 
721
1119
  const contractFunctionSimulator = this.#getSimulatorForTx();
722
- const privateExecutionResult = await this.#executePrivate(
1120
+ const privateExecutionResult = await this.#executePrivate({
723
1121
  contractFunctionSimulator,
724
1122
  txRequest,
725
- undefined,
1123
+ anchorBlockHeader,
1124
+ scopes,
726
1125
  jobId,
727
- );
1126
+ senderForTags,
1127
+ });
728
1128
 
729
1129
  const { executionSteps, timings: { proving } = {} } = await this.#prove(
730
1130
  txRequest,
731
1131
  this.proofCreator,
732
1132
  privateExecutionResult,
1133
+ anchorBlockHeader,
733
1134
  {
734
1135
  simulate: skipProofGeneration,
735
1136
  skipFeeEnforcement: false,
@@ -781,12 +1182,7 @@ export class PXE {
781
1182
  * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
782
1183
  *
783
1184
  *
784
- * @param txRequest - An authenticated tx request ready for simulation
785
- * @param simulatePublic - Whether to simulate the public part of the transaction.
786
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
787
- * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
788
- * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
789
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
1185
+ * @param txRequest - An authenticated tx request ready for simulation.
790
1186
  * @returns A simulated transaction result object that includes public and private return values.
791
1187
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
792
1188
  * Also throws if simulatePublic is true and public simulation reverts.
@@ -795,11 +1191,15 @@ export class PXE {
795
1191
  */
796
1192
  public simulateTx(
797
1193
  txRequest: TxExecutionRequest,
798
- simulatePublic: boolean,
799
- skipTxValidation: boolean = false,
800
- skipFeeEnforcement: boolean = false,
801
- overrides?: SimulationOverrides,
802
- scopes?: AztecAddress[],
1194
+ {
1195
+ simulatePublic,
1196
+ skipTxValidation = false,
1197
+ skipFeeEnforcement = false,
1198
+ skipKernels = true,
1199
+ overrides,
1200
+ scopes,
1201
+ senderForTags,
1202
+ }: SimulateTxOpts,
803
1203
  ): Promise<TxSimulationResult> {
804
1204
  // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
805
1205
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
@@ -820,17 +1220,26 @@ export class PXE {
820
1220
  txInfo,
821
1221
  );
822
1222
  const syncTimer = new Timer();
823
- await this.blockStateSynchronizer.sync();
1223
+ await this.#maybeSync();
1224
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
824
1225
  const syncTime = syncTimer.ms();
825
1226
 
1227
+ if (overrides?.contracts && Object.keys(overrides.contracts).length > 0 && !skipKernels) {
1228
+ throw new Error(
1229
+ 'Simulating with overridden contracts is not compatible with kernel execution. Please set skipKernels to true when simulating with overridden contracts.',
1230
+ );
1231
+ }
826
1232
  const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
827
- // Temporary: in case there are overrides, we have to skip the kernels or validations
828
- // will fail. Consider handing control to the user/wallet on whether they want to run them
829
- // or not.
830
- const skipKernels = overrides?.contracts !== undefined && Object.keys(overrides.contracts ?? {}).length > 0;
831
1233
 
832
1234
  // Execution of private functions only; no proving, and no kernel logic.
833
- const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
1235
+ const privateExecutionResult = await this.#executePrivate({
1236
+ contractFunctionSimulator,
1237
+ txRequest,
1238
+ anchorBlockHeader,
1239
+ scopes,
1240
+ jobId,
1241
+ senderForTags,
1242
+ });
834
1243
 
835
1244
  let publicInputs: PrivateKernelTailCircuitPublicInputs | undefined;
836
1245
  let executionSteps: PrivateExecutionStep[] = [];
@@ -838,15 +1247,22 @@ export class PXE {
838
1247
  if (skipKernels) {
839
1248
  ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
840
1249
  privateExecutionResult,
841
- this.contractStore,
1250
+ (addr, sel) => this.#getDebugFunctionName(addr, sel, anchorBlockHeader),
1251
+ this.node,
842
1252
  ));
843
1253
  } else {
844
1254
  // Kernel logic, plus proving of all private functions and kernels.
845
- ({ publicInputs, executionSteps } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, {
846
- simulate: true,
847
- skipFeeEnforcement,
848
- profileMode: 'none',
849
- }));
1255
+ ({ publicInputs, executionSteps } = await this.#prove(
1256
+ txRequest,
1257
+ this.proofCreator,
1258
+ privateExecutionResult,
1259
+ anchorBlockHeader,
1260
+ {
1261
+ simulate: true,
1262
+ skipFeeEnforcement,
1263
+ profileMode: 'none',
1264
+ },
1265
+ ));
850
1266
  }
851
1267
 
852
1268
  const privateSimulationResult = new PrivateSimulationResult(privateExecutionResult, publicInputs);
@@ -855,8 +1271,11 @@ export class PXE {
855
1271
  let publicOutput: PublicSimulationOutput | undefined;
856
1272
  if (simulatePublic && publicInputs.forPublic) {
857
1273
  const publicSimulationTimer = new Timer();
858
- publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
1274
+ publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement, overrides);
859
1275
  publicSimulationTime = publicSimulationTimer.ms();
1276
+ if (publicOutput?.debugLogs?.length) {
1277
+ await displayDebugLogs(publicOutput.debugLogs, addr => this.#getDebugContractName(addr, anchorBlockHeader));
1278
+ }
860
1279
  }
861
1280
 
862
1281
  let validationTime: number | undefined;
@@ -865,7 +1284,8 @@ export class PXE {
865
1284
  const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
866
1285
  validationTime = validationTimer.ms();
867
1286
  if (validationResult.result === 'invalid') {
868
- throw new Error('The simulated transaction is unable to be added to state and is invalid.');
1287
+ const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
1288
+ throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
869
1289
  }
870
1290
  }
871
1291
 
@@ -916,43 +1336,44 @@ export class PXE {
916
1336
  inspect(txRequest),
917
1337
  `simulatePublic=${simulatePublic}`,
918
1338
  `skipTxValidation=${skipTxValidation}`,
919
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1339
+ `scopes=${scopes.map(s => s.toString()).join(', ')}`,
920
1340
  );
921
1341
  }
922
1342
  });
923
1343
  }
924
1344
 
925
1345
  /**
926
- * Simulate the execution of a contract utility function.
927
- *
1346
+ * Executes a contract utility function.
928
1347
  * @param call - The function call containing the function details, arguments, and target contract address.
929
- * @param authwits - (Optional) The authentication witnesses required for the function call.
930
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
931
- * default to all.
932
- * @returns The result of the utility function call, structured based on the function ABI.
933
1348
  */
934
- public simulateUtility(
1349
+ public executeUtility(
935
1350
  call: FunctionCall,
936
- authwits?: AuthWitness[],
937
- scopes?: AztecAddress[],
938
- ): Promise<UtilitySimulationResult> {
939
- // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
1351
+ { authwits, scopes }: ExecuteUtilityOpts = { scopes: [] },
1352
+ ): Promise<UtilityExecutionResult> {
1353
+ // We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
940
1354
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
941
- // delete the same read value, or reading values that another simulation is currently modifying).
1355
+ // delete the same read value, or reading values that another execution is currently modifying).
942
1356
  return this.#putInJobQueue(async jobId => {
943
1357
  try {
944
1358
  const totalTimer = new Timer();
945
1359
  const syncTimer = new Timer();
946
- await this.blockStateSynchronizer.sync();
1360
+ await this.#maybeSync();
947
1361
  const syncTime = syncTimer.ms();
948
1362
  const functionTimer = new Timer();
949
1363
  const contractFunctionSimulator = this.#getSimulatorForTx();
950
1364
 
951
- await this.contractStore.syncPrivateState(call.to, call.selector, privateSyncCall =>
952
- this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1365
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
1366
+ await this.contractSyncService.ensureContractSynced(
1367
+ call.to,
1368
+ call.selector,
1369
+ (privateSyncCall, execScopes) =>
1370
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1371
+ anchorBlockHeader,
1372
+ jobId,
1373
+ scopes,
953
1374
  );
954
1375
 
955
- const executionResult = await this.#simulateUtility(
1376
+ const { result: executionResult, offchainEffects } = await this.#executeUtility(
956
1377
  contractFunctionSimulator,
957
1378
  call,
958
1379
  authwits ?? [],
@@ -973,14 +1394,19 @@ export class PXE {
973
1394
  };
974
1395
 
975
1396
  const simulationStats = contractFunctionSimulator.getStats();
976
- return { result: executionResult, stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls } };
1397
+ return {
1398
+ result: executionResult,
1399
+ offchainEffects,
1400
+ anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
1401
+ stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
1402
+ };
977
1403
  } catch (err: any) {
978
1404
  const { to, name, args } = call;
979
1405
  const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
980
1406
  throw this.#contextualizeError(
981
1407
  err,
982
- `simulateUtility ${to}:${name}(${stringifiedArgs})`,
983
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1408
+ `executeUtility ${to}:${name}(${stringifiedArgs})`,
1409
+ `scopes=${scopes.map(s => s.toString()).join(', ')}`,
984
1410
  );
985
1411
  }
986
1412
  });
@@ -1006,17 +1432,21 @@ export class PXE {
1006
1432
  let anchorBlockNumber: BlockNumber;
1007
1433
 
1008
1434
  await this.#putInJobQueue(async jobId => {
1009
- await this.blockStateSynchronizer.sync();
1435
+ await this.#maybeSync();
1010
1436
 
1011
- anchorBlockNumber = (await this.anchorBlockStore.getBlockHeader()).getBlockNumber();
1437
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
1438
+ anchorBlockNumber = anchorBlockHeader.getBlockNumber();
1012
1439
 
1013
1440
  const contractFunctionSimulator = this.#getSimulatorForTx();
1014
1441
 
1015
- await this.contractStore.syncPrivateState(
1442
+ await this.contractSyncService.ensureContractSynced(
1016
1443
  filter.contractAddress,
1017
1444
  null,
1018
- async privateSyncCall =>
1019
- await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1445
+ async (privateSyncCall, execScopes) =>
1446
+ await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1447
+ anchorBlockHeader,
1448
+ jobId,
1449
+ filter.scopes,
1020
1450
  );
1021
1451
  });
1022
1452
 
@@ -1031,9 +1461,11 @@ export class PXE {
1031
1461
  }
1032
1462
 
1033
1463
  /**
1034
- * Stops the PXE's job queue.
1464
+ * Stops the PXE's job queue and closes the backing store.
1035
1465
  */
1036
- public stop(): Promise<void> {
1037
- return this.jobQueue.end();
1466
+ public async stop(): Promise<void> {
1467
+ await this.jobQueue.end();
1468
+ await this.blockStateSynchronizer.stop();
1469
+ await this.db.close();
1038
1470
  }
1039
1471
  }