@aztec/pxe 0.0.1-commit.4d79d1f2d → 0.0.1-commit.4d9804df

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 (516) hide show
  1. package/dest/bin/check_oracle_version.js +41 -112
  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 +34 -0
  6. package/dest/bin/oracle_version_helpers.d.ts.map +1 -0
  7. package/dest/bin/oracle_version_helpers.js +46 -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 +23 -15
  12. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  13. package/dest/block_synchronizer/block_synchronizer.js +84 -28
  14. package/dest/config/index.d.ts +9 -2
  15. package/dest/config/index.d.ts.map +1 -1
  16. package/dest/config/index.js +14 -15
  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/skip_sync_contracts.d.ts +11 -0
  28. package/dest/contract/skip_sync_contracts.d.ts.map +1 -0
  29. package/dest/contract/skip_sync_contracts.js +18 -0
  30. package/dest/contract_function_simulator/anchored_contract_data.d.ts +36 -0
  31. package/dest/contract_function_simulator/anchored_contract_data.d.ts.map +1 -0
  32. package/dest/contract_function_simulator/anchored_contract_data.js +54 -0
  33. package/dest/contract_function_simulator/aztec_node_read_cache.d.ts +39 -0
  34. package/dest/contract_function_simulator/aztec_node_read_cache.d.ts.map +1 -0
  35. package/dest/contract_function_simulator/aztec_node_read_cache.js +60 -0
  36. package/dest/contract_function_simulator/contract_function_simulator.d.ts +34 -20
  37. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  38. package/dest/contract_function_simulator/contract_function_simulator.js +210 -74
  39. package/dest/contract_function_simulator/ephemeral_array_service.d.ts +28 -0
  40. package/dest/contract_function_simulator/ephemeral_array_service.d.ts.map +1 -0
  41. package/dest/contract_function_simulator/ephemeral_array_service.js +78 -0
  42. package/dest/contract_function_simulator/execution_note_cache.d.ts +4 -10
  43. package/dest/contract_function_simulator/execution_note_cache.d.ts.map +1 -1
  44. package/dest/contract_function_simulator/execution_note_cache.js +8 -28
  45. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -11
  46. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  47. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -15
  48. package/dest/contract_function_simulator/index.d.ts +26 -5
  49. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  50. package/dest/contract_function_simulator/index.js +11 -3
  51. package/dest/contract_function_simulator/noir-structs/bounded_vec.d.ts +29 -0
  52. package/dest/contract_function_simulator/noir-structs/bounded_vec.d.ts.map +1 -0
  53. package/dest/contract_function_simulator/noir-structs/bounded_vec.js +30 -0
  54. package/dest/contract_function_simulator/noir-structs/contract_class_log_data.d.ts +9 -0
  55. package/dest/contract_function_simulator/noir-structs/contract_class_log_data.d.ts.map +1 -0
  56. package/dest/contract_function_simulator/noir-structs/contract_class_log_data.js +1 -0
  57. package/dest/contract_function_simulator/noir-structs/embedded_curve_point.d.ts +7 -0
  58. package/dest/contract_function_simulator/noir-structs/embedded_curve_point.d.ts.map +1 -0
  59. package/dest/contract_function_simulator/noir-structs/embedded_curve_point.js +1 -0
  60. package/dest/contract_function_simulator/noir-structs/ephemeral_array.d.ts +37 -0
  61. package/dest/contract_function_simulator/noir-structs/ephemeral_array.d.ts.map +1 -0
  62. package/dest/contract_function_simulator/noir-structs/ephemeral_array.js +59 -0
  63. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +3 -4
  64. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  65. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +9 -10
  66. package/dest/contract_function_simulator/noir-structs/fact.d.ts +16 -0
  67. package/dest/contract_function_simulator/noir-structs/fact.d.ts.map +1 -0
  68. package/dest/contract_function_simulator/noir-structs/fact.js +6 -0
  69. package/dest/contract_function_simulator/noir-structs/fact_collection.d.ts +27 -0
  70. package/dest/contract_function_simulator/noir-structs/fact_collection.d.ts.map +1 -0
  71. package/dest/contract_function_simulator/noir-structs/fact_collection.js +31 -0
  72. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts +19 -10
  73. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts.map +1 -1
  74. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.js +12 -24
  75. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +11 -9
  76. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  77. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +2 -63
  78. package/dest/contract_function_simulator/noir-structs/note_data.d.ts +27 -0
  79. package/dest/contract_function_simulator/noir-structs/note_data.d.ts.map +1 -0
  80. package/dest/contract_function_simulator/noir-structs/note_data.js +3 -0
  81. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +3 -5
  82. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  83. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +8 -12
  84. package/dest/contract_function_simulator/noir-structs/option.d.ts +59 -0
  85. package/dest/contract_function_simulator/noir-structs/option.d.ts.map +1 -0
  86. package/dest/contract_function_simulator/noir-structs/option.js +67 -0
  87. package/dest/contract_function_simulator/noir-structs/origin_block.d.ts +11 -0
  88. package/dest/contract_function_simulator/noir-structs/origin_block.d.ts.map +1 -0
  89. package/dest/contract_function_simulator/noir-structs/origin_block.js +5 -0
  90. package/dest/contract_function_simulator/noir-structs/pending_tagged_log.d.ts +11 -0
  91. package/dest/contract_function_simulator/noir-structs/pending_tagged_log.d.ts.map +1 -0
  92. package/dest/contract_function_simulator/noir-structs/pending_tagged_log.js +4 -0
  93. package/dest/contract_function_simulator/noir-structs/provided_secret.d.ts +8 -0
  94. package/dest/contract_function_simulator/noir-structs/provided_secret.d.ts.map +1 -0
  95. package/dest/contract_function_simulator/noir-structs/provided_secret.js +1 -0
  96. package/dest/contract_function_simulator/noir-structs/resolved_tagging_strategy.d.ts +28 -0
  97. package/dest/contract_function_simulator/noir-structs/resolved_tagging_strategy.d.ts.map +1 -0
  98. package/dest/contract_function_simulator/noir-structs/resolved_tagging_strategy.js +50 -0
  99. package/dest/contract_function_simulator/noir-structs/resolved_tx.d.ts +19 -0
  100. package/dest/contract_function_simulator/noir-structs/resolved_tx.d.ts.map +1 -0
  101. package/dest/contract_function_simulator/noir-structs/resolved_tx.js +9 -0
  102. package/dest/contract_function_simulator/noir-structs/tx_effect_data.d.ts +15 -0
  103. package/dest/contract_function_simulator/noir-structs/tx_effect_data.d.ts.map +1 -0
  104. package/dest/contract_function_simulator/noir-structs/tx_effect_data.js +5 -0
  105. package/dest/contract_function_simulator/noir-structs/utility_context.d.ts +6 -11
  106. package/dest/contract_function_simulator/noir-structs/utility_context.d.ts.map +1 -1
  107. package/dest/contract_function_simulator/noir-structs/utility_context.js +1 -20
  108. package/dest/contract_function_simulator/oracle/acir_callback.d.ts +21 -0
  109. package/dest/contract_function_simulator/oracle/acir_callback.d.ts.map +1 -0
  110. package/dest/contract_function_simulator/oracle/acir_callback.js +115 -0
  111. package/dest/contract_function_simulator/oracle/index.d.ts +2 -13
  112. package/dest/contract_function_simulator/oracle/index.d.ts.map +1 -1
  113. package/dest/contract_function_simulator/oracle/index.js +1 -1
  114. package/dest/contract_function_simulator/oracle/interfaces.d.ts +15 -98
  115. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  116. package/dest/contract_function_simulator/oracle/interfaces.js +2 -2
  117. package/dest/contract_function_simulator/oracle/legacy_oracle_registry.d.ts +39 -0
  118. package/dest/contract_function_simulator/oracle/legacy_oracle_registry.d.ts.map +1 -0
  119. package/dest/contract_function_simulator/oracle/legacy_oracle_registry.js +107 -0
  120. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.d.ts +3 -14
  121. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.d.ts.map +1 -1
  122. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.js +1 -24
  123. package/dest/contract_function_simulator/oracle/note_packing_utils.d.ts +2 -2
  124. package/dest/contract_function_simulator/oracle/note_packing_utils.d.ts.map +1 -1
  125. package/dest/contract_function_simulator/oracle/note_packing_utils.js +2 -2
  126. package/dest/contract_function_simulator/oracle/oracle_registry.d.ts +139 -0
  127. package/dest/contract_function_simulator/oracle/oracle_registry.d.ts.map +1 -0
  128. package/dest/contract_function_simulator/oracle/oracle_registry.js +1016 -0
  129. package/dest/contract_function_simulator/oracle/oracle_type_mappings.d.ts +274 -0
  130. package/dest/contract_function_simulator/oracle/oracle_type_mappings.d.ts.map +1 -0
  131. package/dest/contract_function_simulator/oracle/oracle_type_mappings.js +1243 -0
  132. package/dest/contract_function_simulator/oracle/private_execution.d.ts +1 -1
  133. package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
  134. package/dest/contract_function_simulator/oracle/private_execution.js +7 -6
  135. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +62 -76
  136. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  137. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +210 -122
  138. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +178 -80
  139. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  140. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +573 -174
  141. package/dest/contract_function_simulator/pick_notes.d.ts +1 -1
  142. package/dest/contract_function_simulator/pick_notes.d.ts.map +1 -1
  143. package/dest/contract_function_simulator/pick_notes.js +20 -3
  144. package/dest/contract_function_simulator/transient_array_service.d.ts +31 -0
  145. package/dest/contract_function_simulator/transient_array_service.d.ts.map +1 -0
  146. package/dest/contract_function_simulator/transient_array_service.js +62 -0
  147. package/dest/contract_logging.d.ts +27 -0
  148. package/dest/contract_logging.d.ts.map +1 -0
  149. package/dest/contract_logging.js +38 -0
  150. package/dest/debug/pxe_debug_utils.d.ts +5 -9
  151. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  152. package/dest/debug/pxe_debug_utils.js +4 -10
  153. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  154. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  155. package/dest/entrypoints/client/bundle/index.js +3 -0
  156. package/dest/entrypoints/client/bundle/utils.d.ts +2 -2
  157. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  158. package/dest/entrypoints/client/bundle/utils.js +27 -8
  159. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  160. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  161. package/dest/entrypoints/client/lazy/index.js +3 -0
  162. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  163. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  164. package/dest/entrypoints/client/lazy/utils.js +27 -8
  165. package/dest/entrypoints/client/store.d.ts +14 -0
  166. package/dest/entrypoints/client/store.d.ts.map +1 -0
  167. package/dest/entrypoints/client/store.js +42 -0
  168. package/dest/entrypoints/pxe_creation_options.d.ts +16 -2
  169. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  170. package/dest/entrypoints/pxe_creation_options.js +3 -1
  171. package/dest/entrypoints/server/index.d.ts +8 -3
  172. package/dest/entrypoints/server/index.d.ts.map +1 -1
  173. package/dest/entrypoints/server/index.js +6 -2
  174. package/dest/entrypoints/server/store.d.ts +18 -0
  175. package/dest/entrypoints/server/store.d.ts.map +1 -0
  176. package/dest/entrypoints/server/store.js +28 -0
  177. package/dest/entrypoints/server/utils.d.ts +4 -3
  178. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  179. package/dest/entrypoints/server/utils.js +28 -8
  180. package/dest/error_enriching.d.ts +5 -3
  181. package/dest/error_enriching.d.ts.map +1 -1
  182. package/dest/error_enriching.js +13 -11
  183. package/dest/events/event_service.d.ts +15 -6
  184. package/dest/events/event_service.d.ts.map +1 -1
  185. package/dest/events/event_service.js +44 -11
  186. package/dest/events/private_event_filter_validator.d.ts +3 -2
  187. package/dest/events/private_event_filter_validator.d.ts.map +1 -1
  188. package/dest/events/private_event_filter_validator.js +15 -0
  189. package/dest/hooks/authorize_utility_call.d.ts +41 -0
  190. package/dest/hooks/authorize_utility_call.d.ts.map +1 -0
  191. package/dest/hooks/authorize_utility_call.js +4 -0
  192. package/dest/hooks/execution_hooks.d.ts +62 -0
  193. package/dest/hooks/execution_hooks.d.ts.map +1 -0
  194. package/dest/hooks/execution_hooks.js +9 -0
  195. package/dest/hooks/index.d.ts +5 -0
  196. package/dest/hooks/index.d.ts.map +1 -0
  197. package/dest/hooks/index.js +2 -0
  198. package/dest/hooks/resolve_custom_request.d.ts +23 -0
  199. package/dest/hooks/resolve_custom_request.d.ts.map +1 -0
  200. package/dest/hooks/resolve_custom_request.js +3 -0
  201. package/dest/hooks/resolve_tagging_secret_strategy.d.ts +50 -0
  202. package/dest/hooks/resolve_tagging_secret_strategy.d.ts.map +1 -0
  203. package/dest/hooks/resolve_tagging_secret_strategy.js +3 -0
  204. package/dest/logs/log_service.d.ts +14 -11
  205. package/dest/logs/log_service.d.ts.map +1 -1
  206. package/dest/logs/log_service.js +195 -81
  207. package/dest/messages/tx_resolver_service.d.ts +17 -0
  208. package/dest/messages/tx_resolver_service.d.ts.map +1 -0
  209. package/dest/messages/tx_resolver_service.js +60 -0
  210. package/dest/notes/note_service.d.ts +28 -6
  211. package/dest/notes/note_service.d.ts.map +1 -1
  212. package/dest/notes/note_service.js +84 -59
  213. package/dest/notes_filter.d.ts +24 -0
  214. package/dest/notes_filter.d.ts.map +1 -0
  215. package/dest/notes_filter.js +4 -0
  216. package/dest/oracle_version.d.ts +4 -3
  217. package/dest/oracle_version.d.ts.map +1 -1
  218. package/dest/oracle_version.js +20 -10
  219. package/dest/private_kernel/batch_planner.d.ts +47 -0
  220. package/dest/private_kernel/batch_planner.d.ts.map +1 -0
  221. package/dest/private_kernel/batch_planner.js +104 -0
  222. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  223. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  224. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  225. package/dest/private_kernel/hints/index.d.ts +1 -1
  226. package/dest/private_kernel/hints/index.js +1 -1
  227. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  228. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  229. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +135 -70
  230. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  231. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  232. package/dest/private_kernel/hints/test_utils.js +202 -0
  233. package/dest/private_kernel/private_kernel_execution_prover.d.ts +6 -2
  234. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  235. package/dest/private_kernel/private_kernel_execution_prover.js +208 -86
  236. package/dest/private_kernel/private_kernel_oracle.d.ts +17 -11
  237. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  238. package/dest/private_kernel/private_kernel_oracle.js +47 -29
  239. package/dest/pxe.d.ts +178 -61
  240. package/dest/pxe.d.ts.map +1 -1
  241. package/dest/pxe.js +377 -220
  242. package/dest/storage/allowed_scopes.d.ts +6 -0
  243. package/dest/storage/allowed_scopes.d.ts.map +1 -0
  244. package/dest/storage/allowed_scopes.js +7 -0
  245. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -6
  246. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  247. package/dest/storage/anchor_block_store/anchor_block_store.js +9 -7
  248. package/dest/storage/backwards_compatibility_tests/kv_store_snapshot.d.ts +42 -0
  249. package/dest/storage/backwards_compatibility_tests/kv_store_snapshot.d.ts.map +1 -0
  250. package/dest/storage/backwards_compatibility_tests/kv_store_snapshot.js +93 -0
  251. package/dest/storage/backwards_compatibility_tests/schema_tests.d.ts +15 -0
  252. package/dest/storage/backwards_compatibility_tests/schema_tests.d.ts.map +1 -0
  253. package/dest/storage/backwards_compatibility_tests/schema_tests.js +671 -0
  254. package/dest/storage/backwards_compatibility_tests/store_spy.d.ts +19 -0
  255. package/dest/storage/backwards_compatibility_tests/store_spy.d.ts.map +1 -0
  256. package/dest/storage/backwards_compatibility_tests/store_spy.js +63 -0
  257. package/dest/storage/capsule_store/capsule_service.d.ts +21 -0
  258. package/dest/storage/capsule_store/capsule_service.d.ts.map +1 -0
  259. package/dest/storage/capsule_store/capsule_service.js +47 -0
  260. package/dest/storage/capsule_store/capsule_store.d.ts +9 -9
  261. package/dest/storage/capsule_store/capsule_store.d.ts.map +1 -1
  262. package/dest/storage/capsule_store/capsule_store.js +36 -28
  263. package/dest/storage/capsule_store/index.d.ts +2 -1
  264. package/dest/storage/capsule_store/index.d.ts.map +1 -1
  265. package/dest/storage/capsule_store/index.js +1 -0
  266. package/dest/storage/contract_store/contract_store.d.ts +63 -33
  267. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  268. package/dest/storage/contract_store/contract_store.js +178 -130
  269. package/dest/storage/fact_store/fact_service.d.ts +22 -0
  270. package/dest/storage/fact_store/fact_service.d.ts.map +1 -0
  271. package/dest/storage/fact_store/fact_service.js +45 -0
  272. package/dest/storage/fact_store/fact_store.d.ts +95 -0
  273. package/dest/storage/fact_store/fact_store.d.ts.map +1 -0
  274. package/dest/storage/fact_store/fact_store.js +408 -0
  275. package/dest/storage/fact_store/fact_store_keys.d.ts +34 -0
  276. package/dest/storage/fact_store/fact_store_keys.d.ts.map +1 -0
  277. package/dest/storage/fact_store/fact_store_keys.js +50 -0
  278. package/dest/storage/fact_store/index.d.ts +6 -0
  279. package/dest/storage/fact_store/index.d.ts.map +1 -0
  280. package/dest/storage/fact_store/index.js +4 -0
  281. package/dest/storage/fact_store/origin_state.d.ts +59 -0
  282. package/dest/storage/fact_store/origin_state.d.ts.map +1 -0
  283. package/dest/storage/fact_store/origin_state.js +60 -0
  284. package/dest/storage/fact_store/stored_fact.d.ts +32 -0
  285. package/dest/storage/fact_store/stored_fact.d.ts.map +1 -0
  286. package/dest/storage/fact_store/stored_fact.js +64 -0
  287. package/dest/storage/index.d.ts +3 -2
  288. package/dest/storage/index.d.ts.map +1 -1
  289. package/dest/storage/index.js +2 -1
  290. package/dest/storage/metadata.d.ts +2 -2
  291. package/dest/storage/metadata.d.ts.map +1 -1
  292. package/dest/storage/metadata.js +1 -1
  293. package/dest/storage/note_store/note_store.d.ts +44 -34
  294. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  295. package/dest/storage/note_store/note_store.js +199 -170
  296. package/dest/storage/note_store/stored_note.d.ts +3 -8
  297. package/dest/storage/note_store/stored_note.d.ts.map +1 -1
  298. package/dest/storage/note_store/stored_note.js +4 -20
  299. package/dest/storage/open_pxe_stores.d.ts +35 -0
  300. package/dest/storage/open_pxe_stores.d.ts.map +1 -0
  301. package/dest/storage/open_pxe_stores.js +29 -0
  302. package/dest/storage/private_event_store/private_event_store.d.ts +13 -16
  303. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  304. package/dest/storage/private_event_store/private_event_store.js +43 -43
  305. package/dest/storage/private_event_store/stored_private_event.js +1 -1
  306. package/dest/storage/store_identity.d.ts +35 -0
  307. package/dest/storage/store_identity.d.ts.map +1 -0
  308. package/dest/storage/store_identity.js +44 -0
  309. package/dest/storage/tagging_store/index.d.ts +2 -2
  310. package/dest/storage/tagging_store/index.d.ts.map +1 -1
  311. package/dest/storage/tagging_store/index.js +1 -1
  312. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  313. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  314. package/dest/storage/tagging_store/sender_tagging_store.d.ts +45 -28
  315. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  316. package/dest/storage/tagging_store/sender_tagging_store.js +182 -119
  317. package/dest/storage/tagging_store/tagging_secret_sources_store.d.ts +51 -0
  318. package/dest/storage/tagging_store/tagging_secret_sources_store.d.ts.map +1 -0
  319. package/dest/storage/tagging_store/tagging_secret_sources_store.js +105 -0
  320. package/dest/tagging/constants.d.ts +3 -2
  321. package/dest/tagging/constants.d.ts.map +1 -1
  322. package/dest/tagging/constants.js +28 -10
  323. package/dest/tagging/get_all_logs_by_tags.d.ts +34 -10
  324. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  325. package/dest/tagging/get_all_logs_by_tags.js +45 -32
  326. package/dest/tagging/index.d.ts +7 -6
  327. package/dest/tagging/index.d.ts.map +1 -1
  328. package/dest/tagging/index.js +5 -4
  329. package/dest/tagging/persist_sender_tagging_index_ranges.d.ts +29 -0
  330. package/dest/tagging/persist_sender_tagging_index_ranges.d.ts.map +1 -0
  331. package/dest/tagging/persist_sender_tagging_index_ranges.js +42 -0
  332. package/dest/tagging/recipient_sync/sync_tagged_private_logs.d.ts +74 -0
  333. package/dest/tagging/recipient_sync/sync_tagged_private_logs.d.ts.map +1 -0
  334. package/dest/tagging/recipient_sync/sync_tagged_private_logs.js +238 -0
  335. package/dest/tagging/recipient_sync/utils/find_highest_indexes.d.ts +3 -3
  336. package/dest/tagging/recipient_sync/utils/find_highest_indexes.d.ts.map +1 -1
  337. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  338. package/dest/tagging/reconcile_tagging_index_ranges.d.ts +36 -0
  339. package/dest/tagging/reconcile_tagging_index_ranges.d.ts.map +1 -0
  340. package/dest/tagging/reconcile_tagging_index_ranges.js +74 -0
  341. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -9
  342. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  343. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +32 -14
  344. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +13 -7
  345. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  346. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +41 -10
  347. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  348. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  349. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +41 -25
  350. package/dest/tagging/testing/tag_query_test_utils.d.ts +6 -0
  351. package/dest/tagging/testing/tag_query_test_utils.d.ts.map +1 -0
  352. package/dest/tagging/testing/tag_query_test_utils.js +10 -0
  353. package/package.json +20 -17
  354. package/src/bin/check_oracle_version.ts +46 -135
  355. package/src/bin/index.ts +1 -0
  356. package/src/bin/oracle_version_helpers.ts +54 -0
  357. package/src/block_synchronizer/block_stream_source.ts +42 -0
  358. package/src/block_synchronizer/block_synchronizer.ts +102 -39
  359. package/src/config/index.ts +16 -9
  360. package/src/config/package_info.ts +1 -1
  361. package/src/contract/contract_class_service.ts +83 -0
  362. package/src/contract/contract_sync_service.ts +176 -0
  363. package/src/contract/helpers.ts +35 -0
  364. package/src/contract/skip_sync_contracts.ts +23 -0
  365. package/src/contract_function_simulator/anchored_contract_data.ts +74 -0
  366. package/src/contract_function_simulator/aztec_node_read_cache.ts +89 -0
  367. package/src/contract_function_simulator/contract_function_simulator.ts +375 -104
  368. package/src/contract_function_simulator/ephemeral_array_service.ts +110 -0
  369. package/src/contract_function_simulator/execution_note_cache.ts +8 -29
  370. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -18
  371. package/src/contract_function_simulator/index.ts +89 -4
  372. package/src/contract_function_simulator/noir-structs/bounded_vec.ts +43 -0
  373. package/src/contract_function_simulator/noir-structs/contract_class_log_data.ts +9 -0
  374. package/src/contract_function_simulator/noir-structs/embedded_curve_point.ts +4 -0
  375. package/src/contract_function_simulator/noir-structs/ephemeral_array.ts +66 -0
  376. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +10 -9
  377. package/src/contract_function_simulator/noir-structs/fact.ts +13 -0
  378. package/src/contract_function_simulator/noir-structs/fact_collection.ts +64 -0
  379. package/src/contract_function_simulator/noir-structs/log_retrieval_request.ts +27 -20
  380. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +14 -64
  381. package/src/contract_function_simulator/noir-structs/note_data.ts +27 -0
  382. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +6 -11
  383. package/src/contract_function_simulator/noir-structs/option.ts +75 -0
  384. package/src/contract_function_simulator/noir-structs/origin_block.ts +8 -0
  385. package/src/contract_function_simulator/noir-structs/pending_tagged_log.ts +12 -0
  386. package/src/contract_function_simulator/noir-structs/provided_secret.ts +5 -0
  387. package/src/contract_function_simulator/noir-structs/resolved_tagging_strategy.ts +66 -0
  388. package/src/contract_function_simulator/noir-structs/resolved_tx.ts +19 -0
  389. package/src/contract_function_simulator/noir-structs/tx_effect_data.ts +16 -0
  390. package/src/contract_function_simulator/noir-structs/utility_context.ts +5 -17
  391. package/src/contract_function_simulator/oracle/acir_callback.ts +154 -0
  392. package/src/contract_function_simulator/oracle/index.ts +1 -15
  393. package/src/contract_function_simulator/oracle/interfaces.ts +11 -176
  394. package/src/contract_function_simulator/oracle/legacy_oracle_registry.ts +147 -0
  395. package/src/contract_function_simulator/oracle/message_load_oracle_inputs.ts +6 -21
  396. package/src/contract_function_simulator/oracle/note_packing_utils.ts +3 -3
  397. package/src/contract_function_simulator/oracle/oracle_registry.ts +710 -0
  398. package/src/contract_function_simulator/oracle/oracle_type_mappings.ts +1052 -0
  399. package/src/contract_function_simulator/oracle/private_execution.ts +6 -7
  400. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +259 -153
  401. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +880 -264
  402. package/src/contract_function_simulator/pick_notes.ts +22 -3
  403. package/src/contract_function_simulator/transient_array_service.ts +91 -0
  404. package/src/contract_logging.ts +52 -0
  405. package/src/debug/pxe_debug_utils.ts +9 -16
  406. package/src/entrypoints/client/bundle/index.ts +3 -0
  407. package/src/entrypoints/client/bundle/utils.ts +32 -8
  408. package/src/entrypoints/client/lazy/index.ts +3 -0
  409. package/src/entrypoints/client/lazy/utils.ts +32 -8
  410. package/src/entrypoints/client/store.ts +54 -0
  411. package/src/entrypoints/pxe_creation_options.ts +21 -1
  412. package/src/entrypoints/server/index.ts +8 -2
  413. package/src/entrypoints/server/store.ts +47 -0
  414. package/src/entrypoints/server/utils.ts +45 -14
  415. package/src/error_enriching.ts +27 -11
  416. package/src/events/event_service.ts +69 -21
  417. package/src/events/private_event_filter_validator.ts +21 -1
  418. package/src/hooks/authorize_utility_call.ts +44 -0
  419. package/src/hooks/execution_hooks.ts +68 -0
  420. package/src/hooks/index.ts +13 -0
  421. package/src/hooks/resolve_custom_request.ts +24 -0
  422. package/src/hooks/resolve_tagging_secret_strategy.ts +60 -0
  423. package/src/logs/log_service.ts +234 -145
  424. package/src/messages/tx_resolver_service.ts +69 -0
  425. package/src/notes/note_service.ts +121 -86
  426. package/src/notes_filter.ts +24 -0
  427. package/src/oracle_version.ts +20 -10
  428. package/src/private_kernel/batch_planner.ts +168 -0
  429. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  430. package/src/private_kernel/hints/index.ts +1 -1
  431. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +176 -119
  432. package/src/private_kernel/hints/test_utils.ts +318 -0
  433. package/src/private_kernel/private_kernel_execution_prover.ts +341 -120
  434. package/src/private_kernel/private_kernel_oracle.ts +65 -36
  435. package/src/pxe.ts +597 -255
  436. package/src/storage/allowed_scopes.ts +14 -0
  437. package/src/storage/anchor_block_store/anchor_block_store.ts +9 -7
  438. package/src/storage/backwards_compatibility_tests/__snapshots__/AddressStore.json +22 -0
  439. package/src/storage/backwards_compatibility_tests/__snapshots__/AnchorBlockStore.json +3 -0
  440. package/src/storage/backwards_compatibility_tests/__snapshots__/CapsuleStore.json +16 -0
  441. package/src/storage/backwards_compatibility_tests/__snapshots__/ContractStore.json +28 -0
  442. package/src/storage/backwards_compatibility_tests/__snapshots__/FactStore.json +40 -0
  443. package/src/storage/backwards_compatibility_tests/__snapshots__/KeyStore.json +52 -0
  444. package/src/storage/backwards_compatibility_tests/__snapshots__/L2TipsKVStore.json +40 -0
  445. package/src/storage/backwards_compatibility_tests/__snapshots__/NoteStore.json +56 -0
  446. package/src/storage/backwards_compatibility_tests/__snapshots__/PrivateEventStore.json +44 -0
  447. package/src/storage/backwards_compatibility_tests/__snapshots__/RecipientTaggingStore.json +26 -0
  448. package/src/storage/backwards_compatibility_tests/__snapshots__/SenderTaggingStore.json +30 -0
  449. package/src/storage/backwards_compatibility_tests/__snapshots__/TaggingSecretSourcesStore.json +30 -0
  450. package/src/storage/backwards_compatibility_tests/__snapshots__/opened_stores.json +117 -0
  451. package/src/storage/backwards_compatibility_tests/kv_store_snapshot.ts +122 -0
  452. package/src/storage/backwards_compatibility_tests/schema_tests.ts +803 -0
  453. package/src/storage/backwards_compatibility_tests/store_spy.ts +73 -0
  454. package/src/storage/capsule_store/capsule_service.ts +85 -0
  455. package/src/storage/capsule_store/capsule_store.ts +44 -26
  456. package/src/storage/capsule_store/index.ts +1 -0
  457. package/src/storage/contract_store/contract_store.ts +236 -165
  458. package/src/storage/fact_store/fact_service.ts +69 -0
  459. package/src/storage/fact_store/fact_store.ts +487 -0
  460. package/src/storage/fact_store/fact_store_keys.ts +75 -0
  461. package/src/storage/fact_store/index.ts +15 -0
  462. package/src/storage/fact_store/origin_state.ts +84 -0
  463. package/src/storage/fact_store/stored_fact.ts +80 -0
  464. package/src/storage/index.ts +2 -1
  465. package/src/storage/metadata.ts +1 -1
  466. package/src/storage/note_store/note_store.ts +230 -190
  467. package/src/storage/note_store/stored_note.ts +5 -27
  468. package/src/storage/open_pxe_stores.ts +52 -0
  469. package/src/storage/private_event_store/private_event_store.ts +52 -54
  470. package/src/storage/private_event_store/stored_private_event.ts +1 -1
  471. package/src/storage/store_identity.ts +72 -0
  472. package/src/storage/tagging_store/index.ts +1 -1
  473. package/src/storage/tagging_store/recipient_tagging_store.ts +5 -5
  474. package/src/storage/tagging_store/sender_tagging_store.ts +235 -141
  475. package/src/storage/tagging_store/tagging_secret_sources_store.ts +138 -0
  476. package/src/tagging/constants.ts +30 -10
  477. package/src/tagging/get_all_logs_by_tags.ts +87 -35
  478. package/src/tagging/index.ts +6 -5
  479. package/src/tagging/persist_sender_tagging_index_ranges.ts +57 -0
  480. package/src/tagging/recipient_sync/sync_tagged_private_logs.ts +358 -0
  481. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +4 -4
  482. package/src/tagging/reconcile_tagging_index_ranges.ts +102 -0
  483. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +52 -17
  484. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +44 -14
  485. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +31 -27
  486. package/src/tagging/testing/tag_query_test_utils.ts +11 -0
  487. package/dest/contract_function_simulator/oracle/oracle.d.ts +0 -60
  488. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +0 -1
  489. package/dest/contract_function_simulator/oracle/oracle.js +0 -368
  490. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts +0 -6
  491. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map +0 -1
  492. package/dest/contract_function_simulator/proxied_contract_data_source.js +0 -80
  493. package/dest/contract_sync/contract_sync_service.d.ts +0 -42
  494. package/dest/contract_sync/contract_sync_service.d.ts.map +0 -1
  495. package/dest/contract_sync/contract_sync_service.js +0 -97
  496. package/dest/contract_sync/helpers.d.ts +0 -28
  497. package/dest/contract_sync/helpers.d.ts.map +0 -1
  498. package/dest/contract_sync/helpers.js +0 -55
  499. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  500. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
  501. package/dest/storage/tagging_store/sender_address_book_store.d.ts +0 -14
  502. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +0 -1
  503. package/dest/storage/tagging_store/sender_address_book_store.js +0 -36
  504. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +0 -15
  505. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +0 -1
  506. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +0 -99
  507. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +0 -15
  508. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +0 -1
  509. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +0 -32
  510. package/src/contract_function_simulator/oracle/oracle.ts +0 -637
  511. package/src/contract_function_simulator/proxied_contract_data_source.ts +0 -83
  512. package/src/contract_sync/contract_sync_service.ts +0 -145
  513. package/src/contract_sync/helpers.ts +0 -93
  514. package/src/storage/tagging_store/sender_address_book_store.ts +0 -48
  515. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +0 -143
  516. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +0 -49
package/src/pxe.ts CHANGED
@@ -1,37 +1,43 @@
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 { Point } from '@aztec/foundation/curves/grumpkin';
4
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';
23
+ import { GENESIS_BLOCK_HEADER_HASH, type L2TipsProvider } from '@aztec/stdlib/block';
21
24
  import {
22
25
  CompleteAddress,
26
+ type ContractInstancePreimage,
27
+ type ContractInstancePreimageWithAddress,
23
28
  type ContractInstanceWithAddress,
24
29
  type PartialAddress,
25
30
  computeContractAddressFromInstance,
26
- getContractClassFromArtifact,
27
31
  } from '@aztec/stdlib/contract';
28
32
  import { SimulationError } from '@aztec/stdlib/errors';
29
- import type { AztecNode, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
33
+ import type { AztecNode, AztecNodeDebug, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
30
34
  import type {
31
35
  PrivateExecutionStep,
32
36
  PrivateKernelExecutionProofOutput,
33
37
  PrivateKernelTailCircuitPublicInputs,
34
38
  } from '@aztec/stdlib/kernel';
39
+ import { computeAddressSecret } from '@aztec/stdlib/keys';
40
+ import { deriveEcdhSharedSecretPoint, protectFromForgery } from '@aztec/stdlib/logs';
35
41
  import {
36
42
  BlockHeader,
37
43
  type ContractOverrides,
@@ -47,25 +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 { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
63
- import { ContractSyncService } from './contract_sync/contract_sync_service.js';
64
- import { readCurrentClassId } from './contract_sync/helpers.js';
70
+ import { displayDebugLogs } from './contract_logging.js';
65
71
  import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
66
72
  import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
67
73
  import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
74
+ import type { ExecutionHooks } from './hooks/index.js';
68
75
  import { JobCoordinator } from './job_coordinator/job_coordinator.js';
76
+ import { TxResolverService } from './messages/tx_resolver_service.js';
69
77
  import {
70
78
  PrivateKernelExecutionProver,
71
79
  type PrivateKernelExecutionProverConfig,
@@ -75,17 +83,31 @@ import { AddressStore } from './storage/address_store/address_store.js';
75
83
  import { AnchorBlockStore } from './storage/anchor_block_store/anchor_block_store.js';
76
84
  import { CapsuleStore } from './storage/capsule_store/capsule_store.js';
77
85
  import { ContractStore } from './storage/contract_store/contract_store.js';
86
+ import { FactStore } from './storage/fact_store/index.js';
78
87
  import { NoteStore } from './storage/note_store/note_store.js';
88
+ import { openPxeStores } from './storage/open_pxe_stores.js';
79
89
  import { PrivateEventStore } from './storage/private_event_store/private_event_store.js';
80
90
  import { RecipientTaggingStore } from './storage/tagging_store/recipient_tagging_store.js';
81
- import { SenderAddressBookStore } from './storage/tagging_store/sender_address_book_store.js';
82
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';
83
97
 
84
98
  export type PackedPrivateEvent = InTx & {
85
99
  packedEvent: Fr[];
86
100
  eventSelector: EventSelector;
87
101
  };
88
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
+
89
111
  /** Options for PXE.profileTx. */
90
112
  export type ProfileTxOpts = {
91
113
  /** The profiling mode to use. */
@@ -93,7 +115,9 @@ export type ProfileTxOpts = {
93
115
  /** If true, proof generation is skipped during profiling. Defaults to true. */
94
116
  skipProofGeneration?: boolean;
95
117
  /** Addresses whose private state and keys are accessible during private execution. */
96
- scopes?: AztecAddress[];
118
+ scopes: AztecAddress[];
119
+ /** Sender address used to derive discovery tags for private messages (notes, events, logs) this tx emits. */
120
+ senderForTags?: AztecAddress;
97
121
  };
98
122
 
99
123
  /** Options for PXE.simulateTx. */
@@ -104,24 +128,52 @@ export type SimulateTxOpts = {
104
128
  skipTxValidation?: boolean;
105
129
  /** If false, fees are enforced. */
106
130
  skipFeeEnforcement?: boolean;
107
- /** State overrides for the simulation, such as contract instances and artifacts. */
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
+ */
108
138
  overrides?: SimulationOverrides;
109
- /** Addresses whose private state and keys are accessible during private execution. Defaults to all. */
110
- scopes?: AztecAddress[];
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;
111
143
  };
112
144
 
113
- /** Options for PXE.simulateUtility. */
114
- export type SimulateUtilityOpts = {
145
+ /** Options for PXE.executeUtility. */
146
+ export type ExecuteUtilityOpts = {
115
147
  /** The authentication witnesses required for the function call. */
116
148
  authwits?: AuthWitness[];
117
- /** The accounts whose notes we can access in this call. Defaults to all. */
118
- scopes?: AztecAddress[];
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 }>>;
119
166
  };
120
167
 
121
168
  /** Args for PXE.create. */
122
169
  export type PXECreateArgs = {
123
170
  /** The Aztec node to connect to. */
124
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;
125
177
  /** The key-value store for persisting PXE state. */
126
178
  store: AztecAsyncKVStore;
127
179
  /** The prover for generating private kernel proofs. */
@@ -130,12 +182,48 @@ export type PXECreateArgs = {
130
182
  simulator: CircuitSimulator;
131
183
  /** Provider for protocol contract artifacts and instances. */
132
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;
133
191
  /** PXE configuration options. */
134
192
  config: PXEConfig;
135
193
  /** Optional logger instance or string suffix for the logger name. */
136
194
  loggerOrSuffix?: string | Logger;
195
+ /** Optional hooks to observe and influence contract execution. */
196
+ hooks?: ExecutionHooks;
137
197
  };
138
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
+
139
227
  /**
140
228
  * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
141
229
  * manage private state of users.
@@ -143,26 +231,35 @@ export type PXECreateArgs = {
143
231
  export class PXE {
144
232
  private constructor(
145
233
  private node: AztecNode,
234
+ private nodeDebug: AztecNodeDebug | undefined,
235
+ private db: AztecAsyncKVStore,
146
236
  private blockStateSynchronizer: BlockSynchronizer,
147
237
  private keyStore: KeyStore,
148
238
  private contractStore: ContractStore,
149
239
  private noteStore: NoteStore,
150
240
  private capsuleStore: CapsuleStore,
241
+ private factStore: FactStore,
151
242
  private anchorBlockStore: AnchorBlockStore,
152
243
  private senderTaggingStore: SenderTaggingStore,
153
- private senderAddressBookStore: SenderAddressBookStore,
244
+ private taggingSecretSourcesStore: TaggingSecretSourcesStore,
154
245
  private recipientTaggingStore: RecipientTaggingStore,
155
246
  private addressStore: AddressStore,
156
247
  private privateEventStore: PrivateEventStore,
157
248
  private contractSyncService: ContractSyncService,
249
+ private contractClassService: ContractClassService,
250
+ private txResolver: TxResolverService,
251
+ private l2TipsStore: L2TipsProvider,
158
252
  private simulator: CircuitSimulator,
159
253
  private proverEnabled: boolean,
254
+ private autoSync: boolean,
160
255
  private proofCreator: PrivateKernelProver,
161
256
  private protocolContractsProvider: ProtocolContractsProvider,
257
+ private preloadedContractsProvider: PreloadedContractsProvider,
162
258
  private log: Logger,
163
259
  private jobQueue: SerialQueue,
164
260
  private jobCoordinator: JobCoordinator,
165
261
  public debug: PXEDebugUtils,
262
+ private hooks: ExecutionHooks | undefined,
166
263
  ) {}
167
264
 
168
265
  /**
@@ -174,12 +271,15 @@ export class PXE {
174
271
  */
175
272
  public static async create({
176
273
  node,
274
+ nodeDebug,
177
275
  store,
178
276
  proofCreator,
179
277
  simulator,
180
278
  protocolContractsProvider,
279
+ preloadedContractsProvider,
181
280
  config,
182
281
  loggerOrSuffix,
282
+ hooks,
183
283
  }: PXECreateArgs) {
184
284
  // Extract bindings from the logger, or use empty bindings if a string suffix is provided.
185
285
  const bindings: LoggerBindings | undefined =
@@ -192,32 +292,49 @@ export class PXE {
192
292
 
193
293
  const info = await node.getNodeInfo();
194
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
+
195
303
  const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
196
- const addressStore = new AddressStore(store);
197
- const privateEventStore = new PrivateEventStore(store);
198
- const contractStore = new ContractStore(store);
199
- const noteStore = new NoteStore(store);
200
- const anchorBlockStore = new AnchorBlockStore(store);
201
- const senderTaggingStore = new SenderTaggingStore(store);
202
- const senderAddressBookStore = new SenderAddressBookStore(store);
203
- const recipientTaggingStore = new RecipientTaggingStore(store);
204
- const capsuleStore = new CapsuleStore(store);
205
- const keyStore = new KeyStore(store);
206
- const tipsStore = new L2TipsKVStore(store, 'pxe');
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);
207
319
  const contractSyncService = new ContractSyncService(
208
320
  node,
209
321
  contractStore,
322
+ contractClassService,
210
323
  noteStore,
211
324
  createLogger('pxe:contract_sync', bindings),
212
325
  );
326
+ const txResolver = new TxResolverService(node);
327
+
213
328
  const synchronizer = new BlockSynchronizer(
214
329
  node,
215
330
  store,
216
331
  anchorBlockStore,
217
332
  noteStore,
218
333
  privateEventStore,
219
- tipsStore,
334
+ factStore,
335
+ l2TipsStore,
220
336
  contractSyncService,
337
+ contractClassService,
221
338
  config,
222
339
  bindings,
223
340
  );
@@ -229,6 +346,7 @@ export class PXE {
229
346
  recipientTaggingStore,
230
347
  privateEventStore,
231
348
  noteStore,
349
+ factStore,
232
350
  contractSyncService,
233
351
  ]);
234
352
 
@@ -238,37 +356,46 @@ export class PXE {
238
356
 
239
357
  const pxe = new PXE(
240
358
  node,
359
+ nodeDebug,
360
+ store,
241
361
  synchronizer,
242
362
  keyStore,
243
363
  contractStore,
244
364
  noteStore,
245
365
  capsuleStore,
366
+ factStore,
246
367
  anchorBlockStore,
247
368
  senderTaggingStore,
248
- senderAddressBookStore,
369
+ taggingSecretSourcesStore,
249
370
  recipientTaggingStore,
250
371
  addressStore,
251
372
  privateEventStore,
252
373
  contractSyncService,
374
+ contractClassService,
375
+ txResolver,
376
+ l2TipsStore,
253
377
  simulator,
254
378
  proverEnabled,
379
+ config.autoSync,
255
380
  proofCreator,
256
381
  protocolContractsProvider,
382
+ preloadedContractsProvider,
257
383
  log,
258
384
  jobQueue,
259
385
  jobCoordinator,
260
386
  debugUtils,
387
+ hooks,
261
388
  );
262
389
 
263
390
  debugUtils.setPXEHelpers(
264
391
  pxe.#putInJobQueue.bind(pxe),
265
392
  pxe.#getSimulatorForTx.bind(pxe),
266
- pxe.#simulateUtility.bind(pxe),
393
+ pxe.#executeUtility.bind(pxe),
267
394
  );
268
395
 
269
396
  pxe.jobQueue.start();
270
397
 
271
- await pxe.#registerProtocolContracts();
398
+ await Promise.all([pxe.#registerProtocolContracts(), pxe.#registerPreloadedContracts()]);
272
399
  log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
273
400
  return pxe;
274
401
  }
@@ -276,24 +403,52 @@ export class PXE {
276
403
  // Internal methods
277
404
 
278
405
  #getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
279
- const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
280
-
281
406
  return new ContractFunctionSimulator({
282
- contractStore: proxyContractStore,
407
+ contractStore: this.contractStore,
408
+ contractClassService: this.contractClassService,
409
+ overrides: overrides?.contracts,
283
410
  noteStore: this.noteStore,
284
411
  keyStore: this.keyStore,
285
412
  addressStore: this.addressStore,
286
413
  aztecNode: BenchmarkedNodeFactory.create(this.node),
414
+ l2TipsStore: this.l2TipsStore,
287
415
  senderTaggingStore: this.senderTaggingStore,
288
416
  recipientTaggingStore: this.recipientTaggingStore,
289
- senderAddressBookStore: this.senderAddressBookStore,
417
+ taggingSecretSourcesStore: this.taggingSecretSourcesStore,
290
418
  capsuleStore: this.capsuleStore,
419
+ factStore: this.factStore,
291
420
  privateEventStore: this.privateEventStore,
292
421
  simulator: this.simulator,
293
422
  contractSyncService: this.contractSyncService,
423
+ txResolver: this.txResolver,
424
+ hooks: this.hooks,
294
425
  });
295
426
  }
296
427
 
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
+ }
450
+ }
451
+
297
452
  #contextualizeError(err: Error, ...context: string[]): Error {
298
453
  let contextStr = '';
299
454
  if (context.length > 0) {
@@ -341,80 +496,112 @@ export class PXE {
341
496
  }
342
497
 
343
498
  async #registerProtocolContracts() {
344
- const registered: Record<string, string> = {};
345
- for (const name of protocolContractNames) {
346
- const { address, contractClass, instance, artifact } =
347
- await this.protocolContractsProvider.getProtocolContractArtifact(name);
348
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
349
- await this.contractStore.addContractInstance(instance);
350
- registered[name] = address.toString();
351
- }
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
+ );
352
510
  this.log.verbose(`Registered protocol contracts in pxe`, registered);
353
511
  }
354
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
+
355
528
  // Executes the entrypoint private function, as well as all nested private
356
529
  // functions that might arise.
357
- async #executePrivate(
358
- contractFunctionSimulator: ContractFunctionSimulator,
359
- txRequest: TxExecutionRequest,
360
- scopes: AztecAddress[] | undefined,
361
- jobId: string,
362
- ): 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> {
363
545
  const { origin: contractAddress, functionSelector } = txRequest;
364
546
 
365
547
  try {
366
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
367
-
368
548
  await this.contractSyncService.ensureContractSynced(
369
549
  contractAddress,
370
550
  functionSelector,
371
551
  (privateSyncCall, execScopes) =>
372
- this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
552
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
373
553
  anchorBlockHeader,
374
554
  jobId,
375
555
  scopes,
376
556
  );
377
557
 
378
558
  const result = await contractFunctionSimulator.run(txRequest, {
379
- contractAddress,
380
- selector: functionSelector,
381
559
  anchorBlockHeader,
382
560
  scopes,
383
561
  jobId,
562
+ senderForTags,
384
563
  });
385
564
  this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
386
565
  return result;
387
566
  } catch (err) {
388
567
  if (err instanceof SimulationError) {
389
- await enrichSimulationError(err, this.contractStore, this.log);
568
+ await enrichSimulationError(err, this.contractStore, this.contractClassService, anchorBlockHeader, this.log);
390
569
  }
391
570
  throw err;
392
571
  }
393
572
  }
394
573
 
395
574
  /**
396
- * Simulate a utility function call on the given contract.
575
+ * Execute a utility function call on the given contract.
397
576
  * @param contractFunctionSimulator - The simulator to use for the function call.
398
577
  * @param call - The function call to execute.
399
578
  * @param authWitnesses - Authentication witnesses required for the function call.
400
579
  * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
401
580
  * accounts if not specified.
402
581
  * @param jobId - The job ID for staged writes.
403
- * @returns The simulation result containing the outputs of the utility function.
582
+ * @returns The execution result containing the outputs of the utility function.
404
583
  */
405
- async #simulateUtility(
584
+ async #executeUtility(
406
585
  contractFunctionSimulator: ContractFunctionSimulator,
407
586
  call: FunctionCall,
408
587
  authWitnesses: AuthWitness[] | undefined,
409
- scopes: AztecAddress[] | undefined,
588
+ scopes: AztecAddress[],
410
589
  jobId: string,
411
590
  ) {
412
591
  try {
413
592
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
414
- 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 };
415
601
  } catch (err) {
416
602
  if (err instanceof SimulationError) {
417
- 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);
418
605
  }
419
606
  throw err;
420
607
  }
@@ -426,11 +613,11 @@ export class PXE {
426
613
  * It can also be used for estimating gas in the future.
427
614
  * @param tx - The transaction to be simulated.
428
615
  */
429
- async #simulatePublicCalls(tx: Tx, skipFeeEnforcement: boolean) {
616
+ async #simulatePublicCalls(tx: Tx, skipFeeEnforcement: boolean, overrides?: SimulationOverrides) {
430
617
  // Simulating public calls can throw if the TX fails in a phase that doesn't allow reverts (setup)
431
618
  // Or return as reverted if it fails in a phase that allows reverts (app logic, teardown)
432
619
  try {
433
- const result = await this.node.simulatePublicCalls(tx, skipFeeEnforcement);
620
+ const result = await this.node.simulatePublicCalls(tx, skipFeeEnforcement, overrides);
434
621
  if (result.revertReason) {
435
622
  throw result.revertReason;
436
623
  }
@@ -438,7 +625,14 @@ export class PXE {
438
625
  } catch (err) {
439
626
  if (err instanceof SimulationError) {
440
627
  try {
441
- 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
+ );
442
636
  } catch (enrichErr) {
443
637
  this.log.error(`Failed to enrich public simulation error: ${enrichErr}`);
444
638
  }
@@ -462,11 +656,16 @@ export class PXE {
462
656
  txExecutionRequest: TxExecutionRequest,
463
657
  proofCreator: PrivateKernelProver,
464
658
  privateExecutionResult: PrivateExecutionResult,
659
+ anchorBlockHeader: BlockHeader,
465
660
  config: PrivateKernelExecutionProverConfig,
466
661
  ): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>> {
467
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
468
- const anchorBlockHash = await anchorBlockHeader.hash();
469
- const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHash);
662
+ const kernelOracle = new PrivateKernelOracle(
663
+ this.contractStore,
664
+ this.contractClassService,
665
+ this.keyStore,
666
+ this.node,
667
+ anchorBlockHeader,
668
+ );
470
669
  const kernelTraceProver = new PrivateKernelExecutionProver(
471
670
  kernelOracle,
472
671
  proofCreator,
@@ -477,22 +676,44 @@ export class PXE {
477
676
  return await kernelTraceProver.proveWithKernels(txExecutionRequest.toTxRequest(), privateExecutionResult, config);
478
677
  }
479
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
+
480
690
  // Public API
481
691
 
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
+
482
701
  /**
483
702
  * Returns the block header up to which the PXE has synced.
484
703
  * @returns The synced block header
485
704
  */
486
705
  public getSyncedBlockHeader(): Promise<BlockHeader> {
487
- return this.anchorBlockStore.getBlockHeader();
706
+ return this.#putInJobQueue(() => {
707
+ return this.anchorBlockStore.getBlockHeader();
708
+ });
488
709
  }
489
710
 
490
711
  /**
491
- * Returns the contract instance for a given address, if it's registered in the PXE.
712
+ * Returns the address preimage of the contract instance at a given address, if it's registered in the PXE.
492
713
  * @param address - The contract address.
493
- * @returns The contract instance if found, undefined otherwise.
714
+ * @returns The contract instance address preimage if found, undefined otherwise.
494
715
  */
495
- public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
716
+ public getContractInstance(address: AztecAddress): Promise<ContractInstancePreimageWithAddress | undefined> {
496
717
  return this.contractStore.getContractInstance(address);
497
718
  }
498
719
 
@@ -506,19 +727,23 @@ export class PXE {
506
727
  }
507
728
 
508
729
  /**
509
- * Registers a user account in PXE given its master encryption private key.
510
- * Once a new account is registered, the PXE will trial-decrypt all published notes on
511
- * the chain and store those that correspond to the registered account. Will do nothing if the
512
- * 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.
513
736
  *
514
- * @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.
515
740
  * @param partialAddress - The partial address of the account contract corresponding to the account being registered.
516
741
  * @returns The complete address of the account.
517
742
  */
518
- public async registerAccount(secretKey: Fr, partialAddress: PartialAddress): Promise<CompleteAddress> {
743
+ public async registerAccount(keys: AccountPrivacyKeys, partialAddress: PartialAddress): Promise<CompleteAddress> {
519
744
  const accounts = await this.keyStore.getAccounts();
520
- const accountCompleteAddress = await this.keyStore.addAccount(secretKey, partialAddress);
521
- if (accounts.includes(accountCompleteAddress.address)) {
745
+ const accountCompleteAddress = await this.keyStore.addAccount(keys, partialAddress);
746
+ if (accounts.some(a => a.equals(accountCompleteAddress.address))) {
522
747
  this.log.info(`Account:\n "${accountCompleteAddress.address.toString()}"\n already registered.`);
523
748
  return accountCompleteAddress;
524
749
  } else {
@@ -531,53 +756,189 @@ export class PXE {
531
756
  }
532
757
 
533
758
  /**
534
- * 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.
535
765
  *
536
- * After registering a new sender, the PXE will sync private logs that are tagged with this sender's address.
537
- * 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.
538
769
  *
539
- * @param sender - Address of the sender to register.
540
- * @returns The address of the sender.
541
- * 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.
542
771
  */
543
- public async registerSender(sender: AztecAddress): Promise<AztecAddress> {
544
- const accounts = await this.keyStore.getAccounts();
545
- if (accounts.includes(sender)) {
546
- this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
547
- return sender;
548
- }
772
+ public getAccountSecretKeys(account: AztecAddress): Promise<AccountPrivacySecretKeys> {
773
+ return this.keyStore.getAccountSecretKeys(account);
774
+ }
549
775
 
550
- 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
+ }
551
806
 
552
807
  if (wasAdded) {
553
- this.log.info(`Added sender:\n ${sender.toString()}`);
554
- } else {
555
- 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()));
556
810
  }
811
+ }
557
812
 
558
- 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
+ }
559
845
  }
560
846
 
561
847
  /**
562
- * Retrieves senders registered in this PXE.
563
- * @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}.
564
850
  */
565
- public getSenders(): Promise<AztecAddress[]> {
566
- 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;
567
890
  }
568
891
 
569
892
  /**
570
- * Removes a sender registered in this PXE.
571
- * @param sender - The address of the sender to remove.
893
+ * Derives the shared secret of a handshake from its ephemeral public key: the raw ECDH secret
894
+ * `S = addressSecret(recipient) * ephPk` with the forgery protection applied,
895
+ * matching the protected secret the registry stores and the derivation the recipient-side scan uses for
896
+ * handshakes discovered onchain. The ephemeral key is reconstructed from its x-coordinate with a positive y,
897
+ * matching how the protocol generates it.
898
+ *
899
+ * @throws If `ephPk` is not the x-coordinate of a Grumpkin curve point, or if `recipient` is not an account of
900
+ * this PXE, since the derivation needs its keys.
572
901
  */
573
- public async removeSender(sender: AztecAddress): Promise<void> {
574
- const wasRemoved = await this.senderAddressBookStore.removeSender(sender);
902
+ async #deriveHandshakeSecret(recipient: AztecAddress, ephPk: Fr): Promise<Point> {
903
+ let ephPkPoint: Point;
904
+ try {
905
+ ephPkPoint = await Point.fromXAndSign(ephPk, true);
906
+ } catch {
907
+ throw new Error(`Ephemeral public key x-coordinate ${ephPk} does not correspond to a Grumpkin curve point.`);
908
+ }
575
909
 
576
- if (wasRemoved) {
577
- this.log.info(`Removed sender:\n ${sender.toString()}`);
578
- } else {
579
- this.log.info(`Sender:\n "${sender.toString()}"\n not registered in PXE.`);
910
+ const completeAddress = await this.addressStore.getCompleteAddress(recipient);
911
+ if (!completeAddress || !(await this.keyStore.hasAccount(recipient))) {
912
+ throw new Error(
913
+ `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.`,
914
+ );
580
915
  }
916
+
917
+ const ivskM = await this.keyStore.getMasterIncomingViewingSecretKey(recipient);
918
+ const addressSecret = await computeAddressSecret(await completeAddress.getPreaddress(), ivskM);
919
+ const rawSecret = await deriveEcdhSharedSecretPoint(addressSecret, ephPkPoint);
920
+ return protectFromForgery(rawSecret, ephPkPoint, await recipient.toAddressPoint());
921
+ }
922
+
923
+ /** Registers a resolved shared secret scoped to a recipient. Returns whether it was newly added. */
924
+ async #registerSharedSecret(recipient: AztecAddress, kind: SharedSecretKind, secret: Point): Promise<boolean> {
925
+ if (!(await recipient.isValid())) {
926
+ throw new Error(
927
+ `Recipient ${recipient} is not valid: it does not correspond to a point on the Grumpkin curve. Cannot register a shared secret for it.`,
928
+ );
929
+ }
930
+
931
+ if (secret.isZero() || !secret.isOnCurve()) {
932
+ throw new Error(`Shared secret ${secret} is not a valid non-zero point on the Grumpkin curve.`);
933
+ }
934
+
935
+ const wasAdded = await this.taggingSecretSourcesStore.addSharedSecret(recipient, kind, secret);
936
+ this.log.info(
937
+ wasAdded
938
+ ? `Added ${kind} shared secret for recipient:\n ${recipient.toString()}`
939
+ : `${kind} shared secret already registered for recipient:\n ${recipient.toString()}`,
940
+ );
941
+ return wasAdded;
581
942
  }
582
943
 
583
944
  /**
@@ -600,95 +961,34 @@ export class PXE {
600
961
  * @param artifact - The build artifact for the contract class.
601
962
  */
602
963
  public async registerContractClass(artifact: ContractArtifact): Promise<void> {
603
- const { id: contractClassId } = await getContractClassFromArtifact(artifact);
604
- await this.contractStore.addContractArtifact(contractClassId, artifact);
964
+ const contractClassId = await this.contractStore.addContractArtifact(artifact);
965
+ // Publishing the artifact's public function signatures to the node is part of "registering a class", so that
966
+ // node-side debugging works regardless of which entrypoint (registerContractClass or registerContract) was used.
967
+ const publicFunctionSignatures = artifact.functions
968
+ .filter(fn => fn.functionType === FunctionType.PUBLIC)
969
+ .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
970
+ if (publicFunctionSignatures.length > 0) {
971
+ await this.nodeDebug?.registerContractFunctionSignatures(publicFunctionSignatures);
972
+ }
605
973
  this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
606
974
  }
607
975
 
608
976
  /**
609
- * Adds deployed contracts to the PXE. Deployed contract information is used to access the
610
- * contract code when simulating local transactions. This is automatically called by aztec.js when
611
- * deploying a contract. Dapps that wish to interact with contracts already deployed should register
612
- * these contracts in their users' PXE through this method.
977
+ * Registers a deployed contract instance so its private state can be synced and its functions simulated. The
978
+ * artifact for the class the instance runs must be registered separately via {@link registerContractClass}, before
979
+ * or after this call; registration performs no validation, so a missing or mismatched artifact only surfaces when
980
+ * the contract is later simulated. This is automatically called by aztec.js when deploying a contract.
613
981
  *
614
- * @param contract - A contract instance to register, with an optional artifact which can be omitted if the contract class has already been registered.
615
- */
616
- public async registerContract(contract: { instance: ContractInstanceWithAddress; artifact?: ContractArtifact }) {
617
- const { instance } = contract;
618
- let { artifact } = contract;
619
-
620
- if (artifact) {
621
- // If the user provides an artifact, validate it against the expected class id and register it
622
- const contractClass = await getContractClassFromArtifact(artifact);
623
- const contractClassId = contractClass.id;
624
- if (!contractClassId.equals(instance.currentContractClassId)) {
625
- throw new Error(
626
- `Artifact does not match expected class id (computed ${contractClassId} but instance refers to ${instance.currentContractClassId})`,
627
- );
628
- }
629
- const computedAddress = await computeContractAddressFromInstance(instance);
630
- if (!computedAddress.equals(instance.address)) {
631
- throw new Error('Added a contract in which the address does not match the contract instance.');
632
- }
633
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
634
-
635
- const publicFunctionSignatures = artifact.functions
636
- .filter(fn => fn.functionType === FunctionType.PUBLIC)
637
- .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
638
- await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
639
- } else {
640
- // Otherwise, make sure there is an artifact already registered for that class id
641
- artifact = await this.contractStore.getContractArtifact(instance.currentContractClassId);
642
- if (!artifact) {
643
- throw new Error(
644
- `Artifact not found when registering an instance. Contract class: ${instance.currentContractClassId}.`,
645
- );
646
- }
647
- }
648
-
649
- await this.contractStore.addContractInstance(instance);
650
- this.log.info(
651
- `Added contract ${artifact.name} at ${instance.address.toString()} with class ${instance.currentContractClassId}`,
652
- );
653
- }
654
-
655
- /**
656
- * Updates a deployed contract in the PXE. This is used to update the contract artifact when
657
- * an update has happened, so the new code can be used in the simulation of local transactions.
658
- * This is called by aztec.js when instantiating a contract in a given address with a mismatching artifact.
659
- * @param contractAddress - The address of the contract to update.
660
- * @param artifact - The updated artifact for the contract.
661
- * @throws If the artifact's contract class is not found in the PXE or if the contract class is different from
662
- * the current one (current one from the point of view of the node to which the PXE is connected).
982
+ * @param instance - The address preimage of the contract instance to register. The address is derived from it.
983
+ * @returns The address of the registered instance.
663
984
  */
664
- public updateContract(contractAddress: AztecAddress, artifact: ContractArtifact): Promise<void> {
665
- // We disable concurrently updating contracts to avoid concurrently syncing with the node, or changing a contract's
666
- // class while we're simulating it.
985
+ public registerContract(instance: ContractInstancePreimage): Promise<AztecAddress> {
986
+ // Run inside the job queue so we can't race a concurrent simulation while writing the instance to the store.
667
987
  return this.#putInJobQueue(async () => {
668
- const currentInstance = await this.contractStore.getContractInstance(contractAddress);
669
- if (!currentInstance) {
670
- throw new Error(`Instance not found when updating a contract. Contract address: ${contractAddress}.`);
671
- }
672
- const contractClass = await getContractClassFromArtifact(artifact);
673
- await this.blockStateSynchronizer.sync();
674
-
675
- const header = await this.anchorBlockStore.getBlockHeader();
676
-
677
- const currentClassId = await readCurrentClassId(contractAddress, currentInstance, this.node, header);
678
- if (!contractClass.id.equals(currentClassId)) {
679
- throw new Error('Could not update contract to a class different from the current one.');
680
- }
681
-
682
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
683
-
684
- const publicFunctionSignatures = artifact.functions
685
- .filter(fn => fn.functionType === FunctionType.PUBLIC)
686
- .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
687
- await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
688
-
689
- currentInstance.currentContractClassId = contractClass.id;
690
- await this.contractStore.addContractInstance(currentInstance);
691
- this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
988
+ const address = await computeContractAddressFromInstance(instance);
989
+ await this.contractStore.addContractInstance({ ...instance, address });
990
+ this.log.info(`Added contract at ${address}`, { address });
991
+ return address;
692
992
  });
693
993
  }
694
994
 
@@ -710,7 +1010,7 @@ export class PXE {
710
1010
  * @throws If contract code not found, or public simulation reverts.
711
1011
  * Also throws if simulatePublic is true and public simulation reverts.
712
1012
  */
713
- public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
1013
+ public proveTx(txRequest: TxExecutionRequest, { scopes, senderForTags }: ProveTxOpts): Promise<TxProvingResult> {
714
1014
  let privateExecutionResult: PrivateExecutionResult;
715
1015
  // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
716
1016
  // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
@@ -718,17 +1018,25 @@ export class PXE {
718
1018
  const totalTimer = new Timer();
719
1019
  try {
720
1020
  const syncTimer = new Timer();
721
- await this.blockStateSynchronizer.sync();
1021
+ await this.#maybeSync();
1022
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
722
1023
  const syncTime = syncTimer.ms();
723
1024
  const contractFunctionSimulator = this.#getSimulatorForTx();
724
- privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
1025
+ privateExecutionResult = await this.#executePrivate({
1026
+ contractFunctionSimulator,
1027
+ txRequest,
1028
+ anchorBlockHeader,
1029
+ scopes,
1030
+ jobId,
1031
+ senderForTags,
1032
+ });
725
1033
 
726
1034
  const {
727
1035
  publicInputs,
728
1036
  chonkProof,
729
1037
  executionSteps,
730
1038
  timings: { proving } = {},
731
- } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, {
1039
+ } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, anchorBlockHeader, {
732
1040
  simulate: false,
733
1041
  skipFeeEnforcement: false,
734
1042
  profileMode: 'none',
@@ -758,23 +1066,20 @@ export class PXE {
758
1066
  nodeRPCCalls: contractFunctionSimulator?.getStats().nodeRPCCalls,
759
1067
  });
760
1068
 
761
- // While not strictly necessary to store tagging cache contents in the DB since we sync tagging indexes from
762
- // chain before sending new logs, the sync can only see logs already included in blocks. If we send another
763
- // transaction before this one is included in a block from this PXE, and that transaction contains a log with
764
- // a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
765
- // storing the tags here prevents linkage of txs sent from the same PXE.
766
- const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
767
- if (preTagsUsedInTheTx.length > 0) {
768
- // TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
769
- const txHash = (await txProvingResult.toTx()).txHash;
770
-
771
- await this.senderTaggingStore.storePendingIndexes(preTagsUsedInTheTx, txHash, jobId);
772
- this.log.debug(`Stored used pre-tags as sender for the tx`, {
773
- preTagsUsedInTheTx,
774
- });
775
- } else {
776
- this.log.debug(`No pre-tags used in the tx`);
777
- }
1069
+ // We keep track of which tagging indices we've used in this tx so that we don't repeat them in future txs
1070
+ // (which would link them) without having to rely on this tx being mined (and us seeing the indices being used
1071
+ // onchain).
1072
+ // Note that this must happen _after_ proving as it requires the proof's public inputs, from which the kernels
1073
+ // may have removed some logs due to note-nullifier squashing - this may lead to range of tagging indices we've
1074
+ // actually used to being reduced.
1075
+ await persistSenderTaggingIndexRangesForTx(
1076
+ this.senderTaggingStore,
1077
+ privateExecutionResult.entrypoint.taggingIndexRanges,
1078
+ publicInputs,
1079
+ () => txProvingResult.getTxHash(),
1080
+ jobId,
1081
+ this.log,
1082
+ );
778
1083
 
779
1084
  return txProvingResult;
780
1085
  } catch (err: any) {
@@ -791,7 +1096,7 @@ export class PXE {
791
1096
  */
792
1097
  public profileTx(
793
1098
  txRequest: TxExecutionRequest,
794
- { profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
1099
+ { profileMode, skipProofGeneration = true, scopes, senderForTags }: ProfileTxOpts,
795
1100
  ): Promise<TxProfileResult> {
796
1101
  // We disable concurrent profiles for consistency with simulateTx.
797
1102
  return this.#putInJobQueue(async jobId => {
@@ -810,16 +1115,25 @@ export class PXE {
810
1115
  txInfo,
811
1116
  );
812
1117
  const syncTimer = new Timer();
813
- await this.blockStateSynchronizer.sync();
1118
+ await this.#maybeSync();
1119
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
814
1120
  const syncTime = syncTimer.ms();
815
1121
 
816
1122
  const contractFunctionSimulator = this.#getSimulatorForTx();
817
- const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
1123
+ const privateExecutionResult = await this.#executePrivate({
1124
+ contractFunctionSimulator,
1125
+ txRequest,
1126
+ anchorBlockHeader,
1127
+ scopes,
1128
+ jobId,
1129
+ senderForTags,
1130
+ });
818
1131
 
819
1132
  const { executionSteps, timings: { proving } = {} } = await this.#prove(
820
1133
  txRequest,
821
1134
  this.proofCreator,
822
1135
  privateExecutionResult,
1136
+ anchorBlockHeader,
823
1137
  {
824
1138
  simulate: skipProofGeneration,
825
1139
  skipFeeEnforcement: false,
@@ -880,7 +1194,15 @@ export class PXE {
880
1194
  */
881
1195
  public simulateTx(
882
1196
  txRequest: TxExecutionRequest,
883
- { simulatePublic, skipTxValidation = false, skipFeeEnforcement = false, overrides, scopes }: SimulateTxOpts,
1197
+ {
1198
+ simulatePublic,
1199
+ skipTxValidation = false,
1200
+ skipFeeEnforcement = false,
1201
+ skipKernels = true,
1202
+ overrides,
1203
+ scopes,
1204
+ senderForTags,
1205
+ }: SimulateTxOpts,
884
1206
  ): Promise<TxSimulationResult> {
885
1207
  // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
886
1208
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
@@ -901,24 +1223,26 @@ export class PXE {
901
1223
  txInfo,
902
1224
  );
903
1225
  const syncTimer = new Timer();
904
- await this.blockStateSynchronizer.sync();
1226
+ await this.#maybeSync();
1227
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
905
1228
  const syncTime = syncTimer.ms();
906
1229
 
907
- const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
908
- // Temporary: in case there are overrides, we have to skip the kernels or validations
909
- // will fail. Consider handing control to the user/wallet on whether they want to run them
910
- // or not.
911
- const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
912
- const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
913
- const skipKernels = hasOverriddenContracts;
914
-
915
- // Set overridden contracts on the sync service so it knows to skip syncing them
916
- if (hasOverriddenContracts) {
917
- this.contractSyncService.setOverriddenContracts(jobId, overriddenContracts);
1230
+ if (overrides?.contracts && Object.keys(overrides.contracts).length > 0 && !skipKernels) {
1231
+ throw new Error(
1232
+ 'Simulating with overridden contracts is not compatible with kernel execution. Please set skipKernels to true when simulating with overridden contracts.',
1233
+ );
918
1234
  }
1235
+ const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
919
1236
 
920
1237
  // Execution of private functions only; no proving, and no kernel logic.
921
- const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
1238
+ const privateExecutionResult = await this.#executePrivate({
1239
+ contractFunctionSimulator,
1240
+ txRequest,
1241
+ anchorBlockHeader,
1242
+ scopes,
1243
+ jobId,
1244
+ senderForTags,
1245
+ });
922
1246
 
923
1247
  let publicInputs: PrivateKernelTailCircuitPublicInputs | undefined;
924
1248
  let executionSteps: PrivateExecutionStep[] = [];
@@ -926,15 +1250,22 @@ export class PXE {
926
1250
  if (skipKernels) {
927
1251
  ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
928
1252
  privateExecutionResult,
929
- (addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
1253
+ (addr, sel) => this.#getDebugFunctionName(addr, sel, anchorBlockHeader),
1254
+ this.node,
930
1255
  ));
931
1256
  } else {
932
1257
  // Kernel logic, plus proving of all private functions and kernels.
933
- ({ publicInputs, executionSteps } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, {
934
- simulate: true,
935
- skipFeeEnforcement,
936
- profileMode: 'none',
937
- }));
1258
+ ({ publicInputs, executionSteps } = await this.#prove(
1259
+ txRequest,
1260
+ this.proofCreator,
1261
+ privateExecutionResult,
1262
+ anchorBlockHeader,
1263
+ {
1264
+ simulate: true,
1265
+ skipFeeEnforcement,
1266
+ profileMode: 'none',
1267
+ },
1268
+ ));
938
1269
  }
939
1270
 
940
1271
  const privateSimulationResult = new PrivateSimulationResult(privateExecutionResult, publicInputs);
@@ -943,8 +1274,11 @@ export class PXE {
943
1274
  let publicOutput: PublicSimulationOutput | undefined;
944
1275
  if (simulatePublic && publicInputs.forPublic) {
945
1276
  const publicSimulationTimer = new Timer();
946
- publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
1277
+ publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement, overrides);
947
1278
  publicSimulationTime = publicSimulationTimer.ms();
1279
+ if (publicOutput?.debugLogs?.length) {
1280
+ await displayDebugLogs(publicOutput.debugLogs, addr => this.#getDebugContractName(addr, anchorBlockHeader));
1281
+ }
948
1282
  }
949
1283
 
950
1284
  let validationTime: number | undefined;
@@ -953,7 +1287,8 @@ export class PXE {
953
1287
  const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
954
1288
  validationTime = validationTimer.ms();
955
1289
  if (validationResult.result === 'invalid') {
956
- throw new Error('The simulated transaction is unable to be added to state and is invalid.');
1290
+ const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
1291
+ throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
957
1292
  }
958
1293
  }
959
1294
 
@@ -1004,28 +1339,28 @@ export class PXE {
1004
1339
  inspect(txRequest),
1005
1340
  `simulatePublic=${simulatePublic}`,
1006
1341
  `skipTxValidation=${skipTxValidation}`,
1007
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1342
+ `scopes=${scopes.map(s => s.toString()).join(', ')}`,
1008
1343
  );
1009
1344
  }
1010
1345
  });
1011
1346
  }
1012
1347
 
1013
1348
  /**
1014
- * Simulates the execution of a contract utility function.
1349
+ * Executes a contract utility function.
1015
1350
  * @param call - The function call containing the function details, arguments, and target contract address.
1016
1351
  */
1017
- public simulateUtility(
1352
+ public executeUtility(
1018
1353
  call: FunctionCall,
1019
- { authwits, scopes }: SimulateUtilityOpts = {},
1020
- ): Promise<UtilitySimulationResult> {
1021
- // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
1354
+ { authwits, scopes }: ExecuteUtilityOpts = { scopes: [] },
1355
+ ): Promise<UtilityExecutionResult> {
1356
+ // We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
1022
1357
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
1023
- // delete the same read value, or reading values that another simulation is currently modifying).
1358
+ // delete the same read value, or reading values that another execution is currently modifying).
1024
1359
  return this.#putInJobQueue(async jobId => {
1025
1360
  try {
1026
1361
  const totalTimer = new Timer();
1027
1362
  const syncTimer = new Timer();
1028
- await this.blockStateSynchronizer.sync();
1363
+ await this.#maybeSync();
1029
1364
  const syncTime = syncTimer.ms();
1030
1365
  const functionTimer = new Timer();
1031
1366
  const contractFunctionSimulator = this.#getSimulatorForTx();
@@ -1035,13 +1370,13 @@ export class PXE {
1035
1370
  call.to,
1036
1371
  call.selector,
1037
1372
  (privateSyncCall, execScopes) =>
1038
- this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1373
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1039
1374
  anchorBlockHeader,
1040
1375
  jobId,
1041
1376
  scopes,
1042
1377
  );
1043
1378
 
1044
- const executionResult = await this.#simulateUtility(
1379
+ const { result: executionResult, offchainEffects } = await this.#executeUtility(
1045
1380
  contractFunctionSimulator,
1046
1381
  call,
1047
1382
  authwits ?? [],
@@ -1062,14 +1397,19 @@ export class PXE {
1062
1397
  };
1063
1398
 
1064
1399
  const simulationStats = contractFunctionSimulator.getStats();
1065
- return { result: executionResult, stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls } };
1400
+ return {
1401
+ result: executionResult,
1402
+ offchainEffects,
1403
+ anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
1404
+ stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
1405
+ };
1066
1406
  } catch (err: any) {
1067
1407
  const { to, name, args } = call;
1068
1408
  const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
1069
1409
  throw this.#contextualizeError(
1070
1410
  err,
1071
- `simulateUtility ${to}:${name}(${stringifiedArgs})`,
1072
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1411
+ `executeUtility ${to}:${name}(${stringifiedArgs})`,
1412
+ `scopes=${scopes.map(s => s.toString()).join(', ')}`,
1073
1413
  );
1074
1414
  }
1075
1415
  });
@@ -1095,7 +1435,7 @@ export class PXE {
1095
1435
  let anchorBlockNumber: BlockNumber;
1096
1436
 
1097
1437
  await this.#putInJobQueue(async jobId => {
1098
- await this.blockStateSynchronizer.sync();
1438
+ await this.#maybeSync();
1099
1439
 
1100
1440
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
1101
1441
  anchorBlockNumber = anchorBlockHeader.getBlockNumber();
@@ -1106,7 +1446,7 @@ export class PXE {
1106
1446
  filter.contractAddress,
1107
1447
  null,
1108
1448
  async (privateSyncCall, execScopes) =>
1109
- await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1449
+ await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1110
1450
  anchorBlockHeader,
1111
1451
  jobId,
1112
1452
  filter.scopes,
@@ -1124,9 +1464,11 @@ export class PXE {
1124
1464
  }
1125
1465
 
1126
1466
  /**
1127
- * Stops the PXE's job queue.
1467
+ * Stops the PXE's job queue and closes the backing store.
1128
1468
  */
1129
- public stop(): Promise<void> {
1130
- return this.jobQueue.end();
1469
+ public async stop(): Promise<void> {
1470
+ await this.jobQueue.end();
1471
+ await this.blockStateSynchronizer.stop();
1472
+ await this.db.close();
1131
1473
  }
1132
1474
  }