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

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