@aztec/pxe 0.0.1-commit.8afd444 → 0.0.1-commit.8cb2d04d8

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 (244) hide show
  1. package/dest/bin/check_oracle_version.js +4 -4
  2. package/dest/block_synchronizer/block_synchronizer.d.ts +9 -3
  3. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  4. package/dest/block_synchronizer/block_synchronizer.js +26 -2
  5. package/dest/config/index.d.ts +2 -2
  6. package/dest/config/index.d.ts.map +1 -1
  7. package/dest/config/index.js +8 -15
  8. package/dest/config/package_info.js +1 -1
  9. package/dest/contract_function_simulator/contract_function_simulator.d.ts +63 -29
  10. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  11. package/dest/contract_function_simulator/contract_function_simulator.js +206 -75
  12. package/dest/contract_function_simulator/ephemeral_array_service.d.ts +28 -0
  13. package/dest/contract_function_simulator/ephemeral_array_service.d.ts.map +1 -0
  14. package/dest/contract_function_simulator/ephemeral_array_service.js +78 -0
  15. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
  16. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
  18. package/dest/contract_function_simulator/index.d.ts +2 -1
  19. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/index.js +1 -0
  21. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +4 -6
  22. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  23. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +8 -10
  24. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts +1 -1
  25. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.js +1 -1
  26. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +2 -2
  27. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  28. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +2 -4
  29. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +4 -7
  30. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  31. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +6 -11
  32. package/dest/contract_function_simulator/oracle/interfaces.d.ts +61 -45
  33. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  34. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
  35. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
  36. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +47 -0
  37. package/dest/contract_function_simulator/oracle/oracle.d.ts +75 -44
  38. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  39. package/dest/contract_function_simulator/oracle/oracle.js +282 -97
  40. package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
  41. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +54 -78
  42. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  43. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +114 -86
  44. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +119 -64
  45. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  46. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +315 -123
  47. package/dest/contract_function_simulator/pick_notes.d.ts +1 -1
  48. package/dest/contract_function_simulator/pick_notes.d.ts.map +1 -1
  49. package/dest/contract_function_simulator/pick_notes.js +20 -3
  50. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts +1 -1
  51. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map +1 -1
  52. package/dest/contract_function_simulator/proxied_contract_data_source.js +3 -0
  53. package/dest/contract_logging.d.ts +27 -0
  54. package/dest/contract_logging.d.ts.map +1 -0
  55. package/dest/contract_logging.js +38 -0
  56. package/dest/contract_sync/contract_sync_service.d.ts +44 -0
  57. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  58. package/dest/contract_sync/contract_sync_service.js +116 -0
  59. package/dest/contract_sync/helpers.d.ts +28 -0
  60. package/dest/contract_sync/helpers.d.ts.map +1 -0
  61. package/dest/contract_sync/{index.js → helpers.js} +14 -15
  62. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  63. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  64. package/dest/debug/pxe_debug_utils.js +16 -15
  65. package/dest/entrypoints/client/bundle/index.d.ts +3 -1
  66. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  67. package/dest/entrypoints/client/bundle/index.js +2 -0
  68. package/dest/entrypoints/client/bundle/utils.d.ts +2 -2
  69. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  70. package/dest/entrypoints/client/bundle/utils.js +11 -3
  71. package/dest/entrypoints/client/lazy/index.d.ts +3 -1
  72. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  73. package/dest/entrypoints/client/lazy/index.js +2 -0
  74. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  75. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  76. package/dest/entrypoints/client/lazy/utils.js +11 -3
  77. package/dest/entrypoints/pxe_creation_options.d.ts +3 -1
  78. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  79. package/dest/entrypoints/pxe_creation_options.js +3 -1
  80. package/dest/entrypoints/server/index.d.ts +4 -3
  81. package/dest/entrypoints/server/index.d.ts.map +1 -1
  82. package/dest/entrypoints/server/index.js +3 -2
  83. package/dest/entrypoints/server/utils.d.ts +2 -2
  84. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  85. package/dest/entrypoints/server/utils.js +11 -3
  86. package/dest/events/event_service.d.ts +3 -2
  87. package/dest/events/event_service.d.ts.map +1 -1
  88. package/dest/events/event_service.js +26 -5
  89. package/dest/events/private_event_filter_validator.d.ts +3 -2
  90. package/dest/events/private_event_filter_validator.d.ts.map +1 -1
  91. package/dest/events/private_event_filter_validator.js +15 -0
  92. package/dest/logs/log_service.d.ts +7 -7
  93. package/dest/logs/log_service.d.ts.map +1 -1
  94. package/dest/logs/log_service.js +33 -48
  95. package/dest/messages/message_context_service.d.ts +17 -0
  96. package/dest/messages/message_context_service.d.ts.map +1 -0
  97. package/dest/messages/message_context_service.js +36 -0
  98. package/dest/notes/note_service.d.ts +4 -4
  99. package/dest/notes/note_service.d.ts.map +1 -1
  100. package/dest/notes/note_service.js +17 -7
  101. package/dest/notes_filter.d.ts +24 -0
  102. package/dest/notes_filter.d.ts.map +1 -0
  103. package/dest/notes_filter.js +4 -0
  104. package/dest/oracle_version.d.ts +4 -3
  105. package/dest/oracle_version.d.ts.map +1 -1
  106. package/dest/oracle_version.js +20 -10
  107. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  108. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  109. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  110. package/dest/private_kernel/hints/index.d.ts +1 -1
  111. package/dest/private_kernel/hints/index.js +1 -1
  112. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  113. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  114. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  115. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  116. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  117. package/dest/private_kernel/hints/test_utils.js +203 -0
  118. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  119. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  120. package/dest/private_kernel/private_kernel_execution_prover.js +18 -13
  121. package/dest/private_kernel/private_kernel_oracle.d.ts +10 -6
  122. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  123. package/dest/private_kernel/private_kernel_oracle.js +19 -18
  124. package/dest/pxe.d.ts +74 -24
  125. package/dest/pxe.d.ts.map +1 -1
  126. package/dest/pxe.js +134 -76
  127. package/dest/storage/anchor_block_store/anchor_block_store.js +1 -1
  128. package/dest/storage/capsule_store/capsule_service.d.ts +21 -0
  129. package/dest/storage/capsule_store/capsule_service.d.ts.map +1 -0
  130. package/dest/storage/capsule_store/capsule_service.js +50 -0
  131. package/dest/storage/capsule_store/capsule_store.d.ts +9 -9
  132. package/dest/storage/capsule_store/capsule_store.d.ts.map +1 -1
  133. package/dest/storage/capsule_store/capsule_store.js +36 -28
  134. package/dest/storage/capsule_store/index.d.ts +2 -1
  135. package/dest/storage/capsule_store/index.d.ts.map +1 -1
  136. package/dest/storage/capsule_store/index.js +1 -0
  137. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  138. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  139. package/dest/storage/contract_store/contract_store.js +148 -70
  140. package/dest/storage/metadata.d.ts +1 -1
  141. package/dest/storage/metadata.js +1 -1
  142. package/dest/storage/note_store/note_store.d.ts +3 -3
  143. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  144. package/dest/storage/note_store/note_store.js +6 -4
  145. package/dest/storage/private_event_store/private_event_store.d.ts +1 -1
  146. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  147. package/dest/storage/private_event_store/private_event_store.js +3 -0
  148. package/dest/storage/private_event_store/stored_private_event.js +1 -1
  149. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  150. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  151. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  152. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  153. package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
  154. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  155. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  156. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  157. package/dest/tagging/index.d.ts +3 -3
  158. package/dest/tagging/index.d.ts.map +1 -1
  159. package/dest/tagging/index.js +1 -1
  160. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  161. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  162. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +8 -22
  163. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  164. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  165. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  166. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  167. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  168. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  169. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
  170. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
  171. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  172. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
  173. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  174. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  175. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
  176. package/package.json +25 -16
  177. package/src/bin/check_oracle_version.ts +4 -4
  178. package/src/block_synchronizer/block_synchronizer.ts +28 -2
  179. package/src/config/index.ts +3 -9
  180. package/src/config/package_info.ts +1 -1
  181. package/src/contract_function_simulator/contract_function_simulator.ts +366 -136
  182. package/src/contract_function_simulator/ephemeral_array_service.ts +110 -0
  183. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
  184. package/src/contract_function_simulator/index.ts +1 -0
  185. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +9 -9
  186. package/src/contract_function_simulator/noir-structs/log_retrieval_request.ts +1 -1
  187. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +2 -5
  188. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +4 -10
  189. package/src/contract_function_simulator/oracle/interfaces.ts +82 -54
  190. package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +104 -0
  191. package/src/contract_function_simulator/oracle/oracle.ts +364 -140
  192. package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
  193. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +144 -178
  194. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +530 -153
  195. package/src/contract_function_simulator/pick_notes.ts +22 -3
  196. package/src/contract_function_simulator/proxied_contract_data_source.ts +8 -1
  197. package/src/contract_logging.ts +52 -0
  198. package/src/contract_sync/contract_sync_service.ts +176 -0
  199. package/src/contract_sync/{index.ts → helpers.ts} +14 -35
  200. package/src/debug/pxe_debug_utils.ts +48 -18
  201. package/src/entrypoints/client/bundle/index.ts +2 -0
  202. package/src/entrypoints/client/bundle/utils.ts +11 -4
  203. package/src/entrypoints/client/lazy/index.ts +2 -0
  204. package/src/entrypoints/client/lazy/utils.ts +11 -4
  205. package/src/entrypoints/pxe_creation_options.ts +7 -0
  206. package/src/entrypoints/server/index.ts +3 -2
  207. package/src/entrypoints/server/utils.ts +9 -10
  208. package/src/events/event_service.ts +30 -5
  209. package/src/events/private_event_filter_validator.ts +21 -1
  210. package/src/logs/log_service.ts +63 -91
  211. package/src/messages/message_context_service.ts +44 -0
  212. package/src/notes/note_service.ts +19 -8
  213. package/src/notes_filter.ts +24 -0
  214. package/src/oracle_version.ts +20 -10
  215. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  216. package/src/private_kernel/hints/index.ts +1 -1
  217. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  218. package/src/private_kernel/hints/test_utils.ts +325 -0
  219. package/src/private_kernel/private_kernel_execution_prover.ts +18 -16
  220. package/src/private_kernel/private_kernel_oracle.ts +21 -21
  221. package/src/pxe.ts +238 -129
  222. package/src/storage/anchor_block_store/anchor_block_store.ts +1 -1
  223. package/src/storage/capsule_store/capsule_service.ts +90 -0
  224. package/src/storage/capsule_store/capsule_store.ts +44 -26
  225. package/src/storage/capsule_store/index.ts +1 -0
  226. package/src/storage/contract_store/contract_store.ts +181 -80
  227. package/src/storage/metadata.ts +1 -1
  228. package/src/storage/note_store/note_store.ts +9 -5
  229. package/src/storage/private_event_store/private_event_store.ts +4 -0
  230. package/src/storage/private_event_store/stored_private_event.ts +1 -1
  231. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  232. package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
  233. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  234. package/src/tagging/index.ts +2 -2
  235. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +12 -25
  236. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  237. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  238. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
  239. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
  240. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
  241. package/dest/contract_sync/index.d.ts +0 -24
  242. package/dest/contract_sync/index.d.ts.map +0 -1
  243. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  244. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
package/src/pxe.ts CHANGED
@@ -18,6 +18,7 @@ import {
18
18
  } from '@aztec/stdlib/abi';
19
19
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
20
20
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
21
+ import type { L2TipsProvider } from '@aztec/stdlib/block';
21
22
  import {
22
23
  CompleteAddress,
23
24
  type ContractInstanceWithAddress,
@@ -33,6 +34,7 @@ import type {
33
34
  PrivateKernelTailCircuitPublicInputs,
34
35
  } from '@aztec/stdlib/kernel';
35
36
  import {
37
+ BlockHeader,
36
38
  type ContractOverrides,
37
39
  type InTx,
38
40
  PrivateExecutionResult,
@@ -46,7 +48,7 @@ import {
46
48
  TxProfileResult,
47
49
  TxProvingResult,
48
50
  TxSimulationResult,
49
- UtilitySimulationResult,
51
+ UtilityExecutionResult,
50
52
  } from '@aztec/stdlib/tx';
51
53
 
52
54
  import { inspect } from 'util';
@@ -59,11 +61,14 @@ import {
59
61
  generateSimulatedProvingResult,
60
62
  } from './contract_function_simulator/contract_function_simulator.js';
61
63
  import { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
62
- import { ensureContractSynced, readCurrentClassId } from './contract_sync/index.js';
64
+ import { displayDebugLogs } from './contract_logging.js';
65
+ import { ContractSyncService } from './contract_sync/contract_sync_service.js';
66
+ import { readCurrentClassId } from './contract_sync/helpers.js';
63
67
  import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
64
68
  import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
65
69
  import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
66
70
  import { JobCoordinator } from './job_coordinator/job_coordinator.js';
71
+ import { MessageContextService } from './messages/message_context_service.js';
67
72
  import {
68
73
  PrivateKernelExecutionProver,
69
74
  type PrivateKernelExecutionProverConfig,
@@ -84,6 +89,58 @@ export type PackedPrivateEvent = InTx & {
84
89
  eventSelector: EventSelector;
85
90
  };
86
91
 
92
+ /** Options for PXE.profileTx. */
93
+ export type ProfileTxOpts = {
94
+ /** The profiling mode to use. */
95
+ profileMode: 'full' | 'execution-steps' | 'gates';
96
+ /** If true, proof generation is skipped during profiling. Defaults to true. */
97
+ skipProofGeneration?: boolean;
98
+ /** Addresses whose private state and keys are accessible during private execution. */
99
+ scopes: AztecAddress[];
100
+ };
101
+
102
+ /** Options for PXE.simulateTx. */
103
+ export type SimulateTxOpts = {
104
+ /** Whether to simulate the public part of the transaction. */
105
+ simulatePublic: boolean;
106
+ /** If false, this function throws if the transaction is unable to be included in a block at the current state. */
107
+ skipTxValidation?: boolean;
108
+ /** If false, fees are enforced. */
109
+ skipFeeEnforcement?: boolean;
110
+ /** If true, kernel logic is emulated in TS for simulation */
111
+ skipKernels?: boolean;
112
+ /** State overrides for the simulation, such as contract instances and artifacts. Requires skipKernels: true */
113
+ overrides?: SimulationOverrides;
114
+ /** Addresses whose private state and keys are accessible during private execution */
115
+ scopes: AztecAddress[];
116
+ };
117
+
118
+ /** Options for PXE.executeUtility. */
119
+ export type ExecuteUtilityOpts = {
120
+ /** The authentication witnesses required for the function call. */
121
+ authwits?: AuthWitness[];
122
+ /** The accounts whose notes we can access in this call */
123
+ scopes: AztecAddress[];
124
+ };
125
+
126
+ /** Args for PXE.create. */
127
+ export type PXECreateArgs = {
128
+ /** The Aztec node to connect to. */
129
+ node: AztecNode;
130
+ /** The key-value store for persisting PXE state. */
131
+ store: AztecAsyncKVStore;
132
+ /** The prover for generating private kernel proofs. */
133
+ proofCreator: PrivateKernelProver;
134
+ /** The circuit simulator for executing ACIR circuits. */
135
+ simulator: CircuitSimulator;
136
+ /** Provider for protocol contract artifacts and instances. */
137
+ protocolContractsProvider: ProtocolContractsProvider;
138
+ /** PXE configuration options. */
139
+ config: PXEConfig;
140
+ /** Optional logger instance or string suffix for the logger name. */
141
+ loggerOrSuffix?: string | Logger;
142
+ };
143
+
87
144
  /**
88
145
  * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
89
146
  * manage private state of users.
@@ -91,6 +148,7 @@ export type PackedPrivateEvent = InTx & {
91
148
  export class PXE {
92
149
  private constructor(
93
150
  private node: AztecNode,
151
+ private db: AztecAsyncKVStore,
94
152
  private blockStateSynchronizer: BlockSynchronizer,
95
153
  private keyStore: KeyStore,
96
154
  private contractStore: ContractStore,
@@ -102,6 +160,9 @@ export class PXE {
102
160
  private recipientTaggingStore: RecipientTaggingStore,
103
161
  private addressStore: AddressStore,
104
162
  private privateEventStore: PrivateEventStore,
163
+ private contractSyncService: ContractSyncService,
164
+ private messageContextService: MessageContextService,
165
+ private l2TipsStore: L2TipsProvider,
105
166
  private simulator: CircuitSimulator,
106
167
  private proverEnabled: boolean,
107
168
  private proofCreator: PrivateKernelProver,
@@ -119,15 +180,15 @@ export class PXE {
119
180
  *
120
181
  * @returns A promise that resolves PXE is ready to be used.
121
182
  */
122
- public static async create(
123
- node: AztecNode,
124
- store: AztecAsyncKVStore,
125
- proofCreator: PrivateKernelProver,
126
- simulator: CircuitSimulator,
127
- protocolContractsProvider: ProtocolContractsProvider,
128
- config: PXEConfig,
129
- loggerOrSuffix?: string | Logger,
130
- ) {
183
+ public static async create({
184
+ node,
185
+ store,
186
+ proofCreator,
187
+ simulator,
188
+ protocolContractsProvider,
189
+ config,
190
+ loggerOrSuffix,
191
+ }: PXECreateArgs) {
131
192
  // Extract bindings from the logger, or use empty bindings if a string suffix is provided.
132
193
  const bindings: LoggerBindings | undefined =
133
194
  loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
@@ -137,7 +198,9 @@ export class PXE {
137
198
  ? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
138
199
  : loggerOrSuffix;
139
200
 
140
- const proverEnabled = !!config.proverEnabled;
201
+ const info = await node.getNodeInfo();
202
+
203
+ const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
141
204
  const addressStore = new AddressStore(store);
142
205
  const privateEventStore = new PrivateEventStore(store);
143
206
  const contractStore = new ContractStore(store);
@@ -149,6 +212,14 @@ export class PXE {
149
212
  const capsuleStore = new CapsuleStore(store);
150
213
  const keyStore = new KeyStore(store);
151
214
  const tipsStore = new L2TipsKVStore(store, 'pxe');
215
+ const contractSyncService = new ContractSyncService(
216
+ node,
217
+ contractStore,
218
+ noteStore,
219
+ createLogger('pxe:contract_sync', bindings),
220
+ );
221
+ const messageContextService = new MessageContextService(node);
222
+
152
223
  const synchronizer = new BlockSynchronizer(
153
224
  node,
154
225
  store,
@@ -156,6 +227,7 @@ export class PXE {
156
227
  noteStore,
157
228
  privateEventStore,
158
229
  tipsStore,
230
+ contractSyncService,
159
231
  config,
160
232
  bindings,
161
233
  );
@@ -167,14 +239,16 @@ export class PXE {
167
239
  recipientTaggingStore,
168
240
  privateEventStore,
169
241
  noteStore,
242
+ contractSyncService,
170
243
  ]);
171
244
 
172
- const debugUtils = new PXEDebugUtils(contractStore, noteStore, synchronizer, anchorBlockStore);
245
+ const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
173
246
 
174
247
  const jobQueue = new SerialQueue();
175
248
 
176
249
  const pxe = new PXE(
177
250
  node,
251
+ store,
178
252
  synchronizer,
179
253
  keyStore,
180
254
  contractStore,
@@ -186,6 +260,9 @@ export class PXE {
186
260
  recipientTaggingStore,
187
261
  addressStore,
188
262
  privateEventStore,
263
+ contractSyncService,
264
+ messageContextService,
265
+ tipsStore,
189
266
  simulator,
190
267
  proverEnabled,
191
268
  proofCreator,
@@ -196,12 +273,15 @@ export class PXE {
196
273
  debugUtils,
197
274
  );
198
275
 
199
- debugUtils.setPXE(pxe, pxe.#putInJobQueue.bind(pxe));
276
+ debugUtils.setPXEHelpers(
277
+ pxe.#putInJobQueue.bind(pxe),
278
+ pxe.#getSimulatorForTx.bind(pxe),
279
+ pxe.#executeUtility.bind(pxe),
280
+ );
200
281
 
201
282
  pxe.jobQueue.start();
202
283
 
203
284
  await pxe.#registerProtocolContracts();
204
- const info = await node.getNodeInfo();
205
285
  log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
206
286
  return pxe;
207
287
  }
@@ -211,19 +291,22 @@ export class PXE {
211
291
  #getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
212
292
  const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
213
293
 
214
- return new ContractFunctionSimulator(
215
- proxyContractStore,
216
- this.noteStore,
217
- this.keyStore,
218
- this.addressStore,
219
- BenchmarkedNodeFactory.create(this.node),
220
- this.senderTaggingStore,
221
- this.recipientTaggingStore,
222
- this.senderAddressBookStore,
223
- this.capsuleStore,
224
- this.privateEventStore,
225
- this.simulator,
226
- );
294
+ return new ContractFunctionSimulator({
295
+ contractStore: proxyContractStore,
296
+ noteStore: this.noteStore,
297
+ keyStore: this.keyStore,
298
+ addressStore: this.addressStore,
299
+ aztecNode: BenchmarkedNodeFactory.create(this.node),
300
+ l2TipsStore: this.l2TipsStore,
301
+ senderTaggingStore: this.senderTaggingStore,
302
+ recipientTaggingStore: this.recipientTaggingStore,
303
+ senderAddressBookStore: this.senderAddressBookStore,
304
+ capsuleStore: this.capsuleStore,
305
+ privateEventStore: this.privateEventStore,
306
+ simulator: this.simulator,
307
+ contractSyncService: this.contractSyncService,
308
+ messageContextService: this.messageContextService,
309
+ });
227
310
  }
228
311
 
229
312
  #contextualizeError(err: Error, ...context: string[]): Error {
@@ -275,9 +358,8 @@ export class PXE {
275
358
  async #registerProtocolContracts() {
276
359
  const registered: Record<string, string> = {};
277
360
  for (const name of protocolContractNames) {
278
- const { address, contractClass, instance, artifact } =
279
- await this.protocolContractsProvider.getProtocolContractArtifact(name);
280
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
361
+ const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
362
+ await this.contractStore.addContractArtifact(artifact);
281
363
  await this.contractStore.addContractInstance(instance);
282
364
  registered[name] = address.toString();
283
365
  }
@@ -289,7 +371,7 @@ export class PXE {
289
371
  async #executePrivate(
290
372
  contractFunctionSimulator: ContractFunctionSimulator,
291
373
  txRequest: TxExecutionRequest,
292
- scopes: AztecAddress[] | undefined,
374
+ scopes: AztecAddress[],
293
375
  jobId: string,
294
376
  ): Promise<PrivateExecutionResult> {
295
377
  const { origin: contractAddress, functionSelector } = txRequest;
@@ -297,29 +379,23 @@ export class PXE {
297
379
  try {
298
380
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
299
381
 
300
- await ensureContractSynced(
382
+ await this.contractSyncService.ensureContractSynced(
301
383
  contractAddress,
302
384
  functionSelector,
303
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
304
- this.node,
305
- this.contractStore,
306
- this.noteStore,
385
+ (privateSyncCall, execScopes) =>
386
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
307
387
  anchorBlockHeader,
308
388
  jobId,
389
+ scopes,
309
390
  );
310
391
 
311
- const result = await contractFunctionSimulator.run(
312
- txRequest,
392
+ const result = await contractFunctionSimulator.run(txRequest, {
313
393
  contractAddress,
314
- functionSelector,
315
- undefined,
394
+ selector: functionSelector,
316
395
  anchorBlockHeader,
317
- // The sender for tags is set by contracts, typically by an account
318
- // contract entrypoint
319
- undefined, // senderForTags
320
396
  scopes,
321
397
  jobId,
322
- );
398
+ });
323
399
  this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
324
400
  return result;
325
401
  } catch (err) {
@@ -331,25 +407,32 @@ export class PXE {
331
407
  }
332
408
 
333
409
  /**
334
- * Simulate a utility function call on the given contract.
410
+ * Execute a utility function call on the given contract.
335
411
  * @param contractFunctionSimulator - The simulator to use for the function call.
336
412
  * @param call - The function call to execute.
337
413
  * @param authWitnesses - Authentication witnesses required for the function call.
338
414
  * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
339
415
  * accounts if not specified.
340
416
  * @param jobId - The job ID for staged writes.
341
- * @returns The simulation result containing the outputs of the utility function.
417
+ * @returns The execution result containing the outputs of the utility function.
342
418
  */
343
- async #simulateUtility(
419
+ async #executeUtility(
344
420
  contractFunctionSimulator: ContractFunctionSimulator,
345
421
  call: FunctionCall,
346
422
  authWitnesses: AuthWitness[] | undefined,
347
- scopes: AztecAddress[] | undefined,
423
+ scopes: AztecAddress[],
348
424
  jobId: string,
349
425
  ) {
350
426
  try {
351
427
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
352
- return contractFunctionSimulator.runUtility(call, authWitnesses ?? [], anchorBlockHeader, scopes, jobId);
428
+ const { result, offchainEffects } = await contractFunctionSimulator.runUtility(
429
+ call,
430
+ authWitnesses ?? [],
431
+ anchorBlockHeader,
432
+ scopes,
433
+ jobId,
434
+ );
435
+ return { result, offchainEffects };
353
436
  } catch (err) {
354
437
  if (err instanceof SimulationError) {
355
438
  await enrichSimulationError(err, this.contractStore, this.log);
@@ -403,8 +486,7 @@ export class PXE {
403
486
  config: PrivateKernelExecutionProverConfig,
404
487
  ): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>> {
405
488
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
406
- const anchorBlockHash = await anchorBlockHeader.hash();
407
- const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHash);
489
+ const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHeader);
408
490
  const kernelTraceProver = new PrivateKernelExecutionProver(
409
491
  kernelOracle,
410
492
  proofCreator,
@@ -417,6 +499,21 @@ export class PXE {
417
499
 
418
500
  // Public API
419
501
 
502
+ /**
503
+ * Returns the block header up to which the PXE has synced.
504
+ * @returns The synced block header
505
+ */
506
+ public getSyncedBlockHeader(): Promise<BlockHeader> {
507
+ return this.#putInJobQueue(() => {
508
+ return this.anchorBlockStore.getBlockHeader();
509
+ });
510
+ }
511
+
512
+ /**
513
+ * Returns the contract instance for a given address, if it's registered in the PXE.
514
+ * @param address - The contract address.
515
+ * @returns The contract instance if found, undefined otherwise.
516
+ */
420
517
  public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
421
518
  return this.contractStore.getContractInstance(address);
422
519
  }
@@ -466,6 +563,12 @@ export class PXE {
466
563
  * TODO: It's strange that we return the address here and I (benesjan) think we should drop the return value.
467
564
  */
468
565
  public async registerSender(sender: AztecAddress): Promise<AztecAddress> {
566
+ if (!(await sender.isValid())) {
567
+ throw new Error(
568
+ `Address ${sender} is not valid: it does not correspond to a point on the Grumpkin curve. Cannot register it as a sender.`,
569
+ );
570
+ }
571
+
469
572
  const accounts = await this.keyStore.getAccounts();
470
573
  if (accounts.includes(sender)) {
471
574
  this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
@@ -476,6 +579,9 @@ export class PXE {
476
579
 
477
580
  if (wasAdded) {
478
581
  this.log.info(`Added sender:\n ${sender.toString()}`);
582
+ // Wipe the entire sync cache: the new sender's tagged logs could contain notes/events for any contract, so
583
+ // all contracts must re-sync to discover them. Queued to avoid wiping while a job is in flight.
584
+ await this.#putInJobQueue(() => Promise.resolve(this.contractSyncService.wipe()));
479
585
  } else {
480
586
  this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
481
587
  }
@@ -525,8 +631,7 @@ export class PXE {
525
631
  * @param artifact - The build artifact for the contract class.
526
632
  */
527
633
  public async registerContractClass(artifact: ContractArtifact): Promise<void> {
528
- const { id: contractClassId } = await getContractClassFromArtifact(artifact);
529
- await this.contractStore.addContractArtifact(contractClassId, artifact);
634
+ const contractClassId = await this.contractStore.addContractArtifact(artifact);
530
635
  this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
531
636
  }
532
637
 
@@ -545,17 +650,17 @@ export class PXE {
545
650
  if (artifact) {
546
651
  // If the user provides an artifact, validate it against the expected class id and register it
547
652
  const contractClass = await getContractClassFromArtifact(artifact);
548
- const contractClassId = contractClass.id;
549
- if (!contractClassId.equals(instance.currentContractClassId)) {
653
+ if (!contractClass.id.equals(instance.currentContractClassId)) {
550
654
  throw new Error(
551
- `Artifact does not match expected class id (computed ${contractClassId} but instance refers to ${instance.currentContractClassId})`,
655
+ `Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
552
656
  );
553
657
  }
554
658
  const computedAddress = await computeContractAddressFromInstance(instance);
555
659
  if (!computedAddress.equals(instance.address)) {
556
660
  throw new Error('Added a contract in which the address does not match the contract instance.');
557
661
  }
558
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
662
+
663
+ await this.contractStore.addContractArtifact(artifact, contractClass);
559
664
 
560
665
  const publicFunctionSignatures = artifact.functions
561
666
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
@@ -604,15 +709,16 @@ export class PXE {
604
709
  throw new Error('Could not update contract to a class different from the current one.');
605
710
  }
606
711
 
607
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
608
-
609
712
  const publicFunctionSignatures = artifact.functions
610
713
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
611
714
  .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
612
715
  await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
613
716
 
614
717
  currentInstance.currentContractClassId = contractClass.id;
615
- await this.contractStore.addContractInstance(currentInstance);
718
+ await Promise.all([
719
+ this.contractStore.addContractArtifact(artifact, contractClass),
720
+ this.contractStore.addContractInstance(currentInstance),
721
+ ]);
616
722
  this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
617
723
  });
618
724
  }
@@ -630,11 +736,12 @@ export class PXE {
630
736
  * (where validators prove the public portion).
631
737
  *
632
738
  * @param txRequest - An authenticated tx request ready for proving
739
+ * @param scopes - Addresses whose private state and keys are accessible during private execution.
633
740
  * @returns A result containing the proof and public inputs of the tail circuit.
634
741
  * @throws If contract code not found, or public simulation reverts.
635
742
  * Also throws if simulatePublic is true and public simulation reverts.
636
743
  */
637
- public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
744
+ public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
638
745
  let privateExecutionResult: PrivateExecutionResult;
639
746
  // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
640
747
  // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
@@ -645,7 +752,7 @@ export class PXE {
645
752
  await this.blockStateSynchronizer.sync();
646
753
  const syncTime = syncTimer.ms();
647
754
  const contractFunctionSimulator = this.#getSimulatorForTx();
648
- privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, undefined, jobId);
755
+ privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
649
756
 
650
757
  const {
651
758
  publicInputs,
@@ -687,17 +794,17 @@ export class PXE {
687
794
  // transaction before this one is included in a block from this PXE, and that transaction contains a log with
688
795
  // a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
689
796
  // storing the tags here prevents linkage of txs sent from the same PXE.
690
- const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
691
- if (preTagsUsedInTheTx.length > 0) {
797
+ const taggingIndexRangesUsedInTheTx = privateExecutionResult.entrypoint.taggingIndexRanges;
798
+ if (taggingIndexRangesUsedInTheTx.length > 0) {
692
799
  // TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
693
800
  const txHash = (await txProvingResult.toTx()).txHash;
694
801
 
695
- await this.senderTaggingStore.storePendingIndexes(preTagsUsedInTheTx, txHash, jobId);
696
- this.log.debug(`Stored used pre-tags as sender for the tx`, {
697
- preTagsUsedInTheTx,
802
+ await this.senderTaggingStore.storePendingIndexes(taggingIndexRangesUsedInTheTx, txHash, jobId);
803
+ this.log.debug(`Stored used tagging index ranges as sender for the tx`, {
804
+ taggingIndexRangesUsedInTheTx,
698
805
  });
699
806
  } else {
700
- this.log.debug(`No pre-tags used in the tx`);
807
+ this.log.debug(`No tagging index ranges used in the tx`);
701
808
  }
702
809
 
703
810
  return txProvingResult;
@@ -709,17 +816,13 @@ export class PXE {
709
816
 
710
817
  /**
711
818
  * Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
712
- *
713
- * @param txRequest - An authenticated tx request ready for simulation
714
- * @param msgSender - (Optional) The message sender to use for the simulation.
715
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
819
+ * @param txRequest - An authenticated tx request ready for simulation.
716
820
  * @returns A trace of the program execution with gate counts.
717
821
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
718
822
  */
719
823
  public profileTx(
720
824
  txRequest: TxExecutionRequest,
721
- profileMode: 'full' | 'execution-steps' | 'gates',
722
- skipProofGeneration: boolean = true,
825
+ { profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
723
826
  ): Promise<TxProfileResult> {
724
827
  // We disable concurrent profiles for consistency with simulateTx.
725
828
  return this.#putInJobQueue(async jobId => {
@@ -742,12 +845,7 @@ export class PXE {
742
845
  const syncTime = syncTimer.ms();
743
846
 
744
847
  const contractFunctionSimulator = this.#getSimulatorForTx();
745
- const privateExecutionResult = await this.#executePrivate(
746
- contractFunctionSimulator,
747
- txRequest,
748
- undefined,
749
- jobId,
750
- );
848
+ const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
751
849
 
752
850
  const { executionSteps, timings: { proving } = {} } = await this.#prove(
753
851
  txRequest,
@@ -804,12 +902,7 @@ export class PXE {
804
902
  * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
805
903
  *
806
904
  *
807
- * @param txRequest - An authenticated tx request ready for simulation
808
- * @param simulatePublic - Whether to simulate the public part of the transaction.
809
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
810
- * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
811
- * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
812
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
905
+ * @param txRequest - An authenticated tx request ready for simulation.
813
906
  * @returns A simulated transaction result object that includes public and private return values.
814
907
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
815
908
  * Also throws if simulatePublic is true and public simulation reverts.
@@ -818,11 +911,14 @@ export class PXE {
818
911
  */
819
912
  public simulateTx(
820
913
  txRequest: TxExecutionRequest,
821
- simulatePublic: boolean,
822
- skipTxValidation: boolean = false,
823
- skipFeeEnforcement: boolean = false,
824
- overrides?: SimulationOverrides,
825
- scopes?: AztecAddress[],
914
+ {
915
+ simulatePublic,
916
+ skipTxValidation = false,
917
+ skipFeeEnforcement = false,
918
+ skipKernels = true,
919
+ overrides,
920
+ scopes,
921
+ }: SimulateTxOpts,
826
922
  ): Promise<TxSimulationResult> {
827
923
  // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
828
924
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
@@ -846,11 +942,21 @@ export class PXE {
846
942
  await this.blockStateSynchronizer.sync();
847
943
  const syncTime = syncTimer.ms();
848
944
 
945
+ const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
946
+ const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
947
+
948
+ if (hasOverriddenContracts && !skipKernels) {
949
+ throw new Error(
950
+ 'Simulating with overridden contracts is not compatible with kernel execution. Please set skipKernels to true when simulating with overridden contracts.',
951
+ );
952
+ }
849
953
  const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
850
- // Temporary: in case there are overrides, we have to skip the kernels or validations
851
- // will fail. Consider handing control to the user/wallet on whether they want to run them
852
- // or not.
853
- const skipKernels = overrides?.contracts !== undefined && Object.keys(overrides.contracts ?? {}).length > 0;
954
+
955
+ if (hasOverriddenContracts) {
956
+ // Overridden contracts don't have a sync function, so calling sync on them would fail.
957
+ // We exclude them so the sync service skips them entirely.
958
+ this.contractSyncService.setExcludedFromSync(jobId, overriddenContracts);
959
+ }
854
960
 
855
961
  // Execution of private functions only; no proving, and no kernel logic.
856
962
  const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
@@ -861,7 +967,8 @@ export class PXE {
861
967
  if (skipKernels) {
862
968
  ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
863
969
  privateExecutionResult,
864
- this.contractStore,
970
+ (addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
971
+ this.node,
865
972
  ));
866
973
  } else {
867
974
  // Kernel logic, plus proving of all private functions and kernels.
@@ -880,6 +987,9 @@ export class PXE {
880
987
  const publicSimulationTimer = new Timer();
881
988
  publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
882
989
  publicSimulationTime = publicSimulationTimer.ms();
990
+ if (publicOutput?.debugLogs?.length) {
991
+ await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
992
+ }
883
993
  }
884
994
 
885
995
  let validationTime: number | undefined;
@@ -888,7 +998,8 @@ export class PXE {
888
998
  const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
889
999
  validationTime = validationTimer.ms();
890
1000
  if (validationResult.result === 'invalid') {
891
- throw new Error('The simulated transaction is unable to be added to state and is invalid.');
1001
+ const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
1002
+ throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
892
1003
  }
893
1004
  }
894
1005
 
@@ -939,29 +1050,23 @@ export class PXE {
939
1050
  inspect(txRequest),
940
1051
  `simulatePublic=${simulatePublic}`,
941
1052
  `skipTxValidation=${skipTxValidation}`,
942
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1053
+ `scopes=${scopes.map(s => s.toString()).join(', ')}`,
943
1054
  );
944
1055
  }
945
1056
  });
946
1057
  }
947
1058
 
948
1059
  /**
949
- * Simulate the execution of a contract utility function.
950
- *
1060
+ * Executes a contract utility function.
951
1061
  * @param call - The function call containing the function details, arguments, and target contract address.
952
- * @param authwits - (Optional) The authentication witnesses required for the function call.
953
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
954
- * default to all.
955
- * @returns The result of the utility function call, structured based on the function ABI.
956
1062
  */
957
- public simulateUtility(
1063
+ public executeUtility(
958
1064
  call: FunctionCall,
959
- authwits?: AuthWitness[],
960
- scopes?: AztecAddress[],
961
- ): Promise<UtilitySimulationResult> {
962
- // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
1065
+ { authwits, scopes }: ExecuteUtilityOpts = { scopes: [] },
1066
+ ): Promise<UtilityExecutionResult> {
1067
+ // We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
963
1068
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
964
- // delete the same read value, or reading values that another simulation is currently modifying).
1069
+ // delete the same read value, or reading values that another execution is currently modifying).
965
1070
  return this.#putInJobQueue(async jobId => {
966
1071
  try {
967
1072
  const totalTimer = new Timer();
@@ -972,18 +1077,17 @@ export class PXE {
972
1077
  const contractFunctionSimulator = this.#getSimulatorForTx();
973
1078
 
974
1079
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
975
- await ensureContractSynced(
1080
+ await this.contractSyncService.ensureContractSynced(
976
1081
  call.to,
977
1082
  call.selector,
978
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
979
- this.node,
980
- this.contractStore,
981
- this.noteStore,
1083
+ (privateSyncCall, execScopes) =>
1084
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
982
1085
  anchorBlockHeader,
983
1086
  jobId,
1087
+ scopes,
984
1088
  );
985
1089
 
986
- const executionResult = await this.#simulateUtility(
1090
+ const { result: executionResult, offchainEffects } = await this.#executeUtility(
987
1091
  contractFunctionSimulator,
988
1092
  call,
989
1093
  authwits ?? [],
@@ -1004,14 +1108,19 @@ export class PXE {
1004
1108
  };
1005
1109
 
1006
1110
  const simulationStats = contractFunctionSimulator.getStats();
1007
- return { result: executionResult, stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls } };
1111
+ return {
1112
+ result: executionResult,
1113
+ offchainEffects,
1114
+ anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
1115
+ stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
1116
+ };
1008
1117
  } catch (err: any) {
1009
1118
  const { to, name, args } = call;
1010
1119
  const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
1011
1120
  throw this.#contextualizeError(
1012
1121
  err,
1013
- `simulateUtility ${to}:${name}(${stringifiedArgs})`,
1014
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1122
+ `executeUtility ${to}:${name}(${stringifiedArgs})`,
1123
+ `scopes=${scopes.map(s => s.toString()).join(', ')}`,
1015
1124
  );
1016
1125
  }
1017
1126
  });
@@ -1044,16 +1153,14 @@ export class PXE {
1044
1153
 
1045
1154
  const contractFunctionSimulator = this.#getSimulatorForTx();
1046
1155
 
1047
- await ensureContractSynced(
1156
+ await this.contractSyncService.ensureContractSynced(
1048
1157
  filter.contractAddress,
1049
1158
  null,
1050
- async privateSyncCall =>
1051
- await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1052
- this.node,
1053
- this.contractStore,
1054
- this.noteStore,
1159
+ async (privateSyncCall, execScopes) =>
1160
+ await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1055
1161
  anchorBlockHeader,
1056
1162
  jobId,
1163
+ filter.scopes,
1057
1164
  );
1058
1165
  });
1059
1166
 
@@ -1068,9 +1175,11 @@ export class PXE {
1068
1175
  }
1069
1176
 
1070
1177
  /**
1071
- * Stops the PXE's job queue.
1178
+ * Stops the PXE's job queue and closes the backing store.
1072
1179
  */
1073
- public stop(): Promise<void> {
1074
- return this.jobQueue.end();
1180
+ public async stop(): Promise<void> {
1181
+ await this.jobQueue.end();
1182
+ await this.blockStateSynchronizer.stop();
1183
+ await this.db.close();
1075
1184
  }
1076
1185
  }