@aztec/pxe 0.0.1-commit.87a0206 → 0.0.1-commit.88e6f9396

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 (194) hide show
  1. package/dest/access_scopes.d.ts +9 -0
  2. package/dest/access_scopes.d.ts.map +1 -0
  3. package/dest/access_scopes.js +6 -0
  4. package/dest/config/index.d.ts +2 -2
  5. package/dest/config/index.d.ts.map +1 -1
  6. package/dest/config/index.js +1 -1
  7. package/dest/config/package_info.js +1 -1
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts +60 -30
  9. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  10. package/dest/contract_function_simulator/contract_function_simulator.js +198 -72
  11. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
  12. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
  14. package/dest/contract_function_simulator/index.d.ts +2 -1
  15. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/index.js +1 -0
  17. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +2 -3
  18. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +5 -4
  20. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +1 -1
  21. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +1 -3
  23. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts +16 -0
  24. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts.map +1 -0
  25. package/dest/contract_function_simulator/noir-structs/message_tx_context.js +57 -0
  26. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -4
  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 +3 -5
  29. package/dest/contract_function_simulator/oracle/interfaces.d.ts +50 -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 +42 -0
  34. package/dest/contract_function_simulator/oracle/oracle.d.ts +45 -44
  35. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  36. package/dest/contract_function_simulator/oracle/oracle.js +164 -95
  37. package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
  38. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +54 -80
  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 +98 -85
  41. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +81 -43
  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 +148 -75
  44. package/dest/contract_logging.d.ts +22 -0
  45. package/dest/contract_logging.d.ts.map +1 -0
  46. package/dest/contract_logging.js +23 -0
  47. package/dest/contract_sync/contract_sync_service.d.ts +8 -4
  48. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -1
  49. package/dest/contract_sync/contract_sync_service.js +61 -29
  50. package/dest/contract_sync/helpers.d.ts +3 -2
  51. package/dest/contract_sync/helpers.d.ts.map +1 -1
  52. package/dest/contract_sync/helpers.js +3 -3
  53. package/dest/debug/pxe_debug_utils.d.ts +5 -4
  54. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  55. package/dest/debug/pxe_debug_utils.js +4 -4
  56. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  57. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  58. package/dest/entrypoints/client/bundle/index.js +3 -0
  59. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  60. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  61. package/dest/entrypoints/client/bundle/utils.js +9 -1
  62. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  63. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  64. package/dest/entrypoints/client/lazy/index.js +3 -0
  65. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  66. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  67. package/dest/entrypoints/client/lazy/utils.js +9 -1
  68. package/dest/entrypoints/server/index.d.ts +3 -1
  69. package/dest/entrypoints/server/index.d.ts.map +1 -1
  70. package/dest/entrypoints/server/index.js +2 -0
  71. package/dest/entrypoints/server/utils.js +9 -1
  72. package/dest/logs/log_service.d.ts +3 -2
  73. package/dest/logs/log_service.d.ts.map +1 -1
  74. package/dest/logs/log_service.js +9 -14
  75. package/dest/messages/message_context_service.d.ts +17 -0
  76. package/dest/messages/message_context_service.d.ts.map +1 -0
  77. package/dest/messages/message_context_service.js +36 -0
  78. package/dest/notes/note_service.d.ts +4 -3
  79. package/dest/notes/note_service.d.ts.map +1 -1
  80. package/dest/notes/note_service.js +3 -2
  81. package/dest/notes_filter.d.ts +25 -0
  82. package/dest/notes_filter.d.ts.map +1 -0
  83. package/dest/notes_filter.js +4 -0
  84. package/dest/oracle_version.d.ts +2 -2
  85. package/dest/oracle_version.js +3 -3
  86. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  87. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  88. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  89. package/dest/private_kernel/hints/index.d.ts +1 -1
  90. package/dest/private_kernel/hints/index.js +1 -1
  91. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  92. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  93. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  94. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  95. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  96. package/dest/private_kernel/hints/test_utils.js +203 -0
  97. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  98. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  99. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  100. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  101. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  102. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  103. package/dest/pxe.d.ts +63 -24
  104. package/dest/pxe.d.ts.map +1 -1
  105. package/dest/pxe.js +101 -72
  106. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  107. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  108. package/dest/storage/contract_store/contract_store.js +140 -64
  109. package/dest/storage/metadata.d.ts +1 -1
  110. package/dest/storage/metadata.js +1 -1
  111. package/dest/storage/note_store/note_store.d.ts +3 -3
  112. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  113. package/dest/storage/note_store/note_store.js +3 -4
  114. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  115. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  116. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  117. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  118. package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
  119. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  120. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  121. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  122. package/dest/tagging/index.d.ts +3 -3
  123. package/dest/tagging/index.d.ts.map +1 -1
  124. package/dest/tagging/index.js +1 -1
  125. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  126. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  127. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  128. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  129. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  130. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  131. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  132. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  133. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  134. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
  135. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
  136. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  137. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
  138. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  139. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  140. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
  141. package/package.json +16 -16
  142. package/src/access_scopes.ts +9 -0
  143. package/src/config/index.ts +1 -1
  144. package/src/config/package_info.ts +1 -1
  145. package/src/contract_function_simulator/contract_function_simulator.ts +357 -133
  146. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
  147. package/src/contract_function_simulator/index.ts +1 -0
  148. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +8 -5
  149. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +1 -4
  150. package/src/contract_function_simulator/noir-structs/message_tx_context.ts +55 -0
  151. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +3 -6
  152. package/src/contract_function_simulator/oracle/interfaces.ts +54 -54
  153. package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +135 -0
  154. package/src/contract_function_simulator/oracle/oracle.ts +177 -139
  155. package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
  156. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +122 -177
  157. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +225 -82
  158. package/src/contract_logging.ts +39 -0
  159. package/src/contract_sync/contract_sync_service.ts +87 -35
  160. package/src/contract_sync/helpers.ts +7 -2
  161. package/src/debug/pxe_debug_utils.ts +11 -9
  162. package/src/entrypoints/client/bundle/index.ts +3 -0
  163. package/src/entrypoints/client/bundle/utils.ts +9 -1
  164. package/src/entrypoints/client/lazy/index.ts +3 -0
  165. package/src/entrypoints/client/lazy/utils.ts +9 -1
  166. package/src/entrypoints/server/index.ts +2 -0
  167. package/src/entrypoints/server/utils.ts +7 -7
  168. package/src/logs/log_service.ts +17 -24
  169. package/src/messages/message_context_service.ts +45 -0
  170. package/src/notes/note_service.ts +4 -3
  171. package/src/notes_filter.ts +26 -0
  172. package/src/oracle_version.ts +3 -3
  173. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  174. package/src/private_kernel/hints/index.ts +1 -1
  175. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  176. package/src/private_kernel/hints/test_utils.ts +325 -0
  177. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  178. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  179. package/src/pxe.ts +186 -116
  180. package/src/storage/contract_store/contract_store.ts +170 -71
  181. package/src/storage/metadata.ts +1 -1
  182. package/src/storage/note_store/note_store.ts +8 -5
  183. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  184. package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
  185. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  186. package/src/tagging/index.ts +2 -2
  187. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  188. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  189. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  190. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
  191. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
  192. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
  193. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  194. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
package/src/pxe.ts CHANGED
@@ -47,11 +47,12 @@ import {
47
47
  TxProfileResult,
48
48
  TxProvingResult,
49
49
  TxSimulationResult,
50
- UtilitySimulationResult,
50
+ UtilityExecutionResult,
51
51
  } from '@aztec/stdlib/tx';
52
52
 
53
53
  import { inspect } from 'util';
54
54
 
55
+ import type { AccessScopes } from './access_scopes.js';
55
56
  import { BlockSynchronizer } from './block_synchronizer/index.js';
56
57
  import type { PXEConfig } from './config/index.js';
57
58
  import { BenchmarkedNodeFactory } from './contract_function_simulator/benchmarked_node.js';
@@ -60,12 +61,14 @@ import {
60
61
  generateSimulatedProvingResult,
61
62
  } from './contract_function_simulator/contract_function_simulator.js';
62
63
  import { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
64
+ import { displayDebugLogs } from './contract_logging.js';
63
65
  import { ContractSyncService } from './contract_sync/contract_sync_service.js';
64
66
  import { readCurrentClassId } from './contract_sync/helpers.js';
65
67
  import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
66
68
  import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
67
69
  import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
68
70
  import { JobCoordinator } from './job_coordinator/job_coordinator.js';
71
+ import { MessageContextService } from './messages/message_context_service.js';
69
72
  import {
70
73
  PrivateKernelExecutionProver,
71
74
  type PrivateKernelExecutionProverConfig,
@@ -86,6 +89,58 @@ export type PackedPrivateEvent = InTx & {
86
89
  eventSelector: EventSelector;
87
90
  };
88
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: AccessScopes;
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: AccessScopes;
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: AccessScopes;
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
+
89
144
  /**
90
145
  * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
91
146
  * manage private state of users.
@@ -93,6 +148,7 @@ export type PackedPrivateEvent = InTx & {
93
148
  export class PXE {
94
149
  private constructor(
95
150
  private node: AztecNode,
151
+ private db: AztecAsyncKVStore,
96
152
  private blockStateSynchronizer: BlockSynchronizer,
97
153
  private keyStore: KeyStore,
98
154
  private contractStore: ContractStore,
@@ -105,6 +161,7 @@ export class PXE {
105
161
  private addressStore: AddressStore,
106
162
  private privateEventStore: PrivateEventStore,
107
163
  private contractSyncService: ContractSyncService,
164
+ private messageContextService: MessageContextService,
108
165
  private simulator: CircuitSimulator,
109
166
  private proverEnabled: boolean,
110
167
  private proofCreator: PrivateKernelProver,
@@ -122,15 +179,15 @@ export class PXE {
122
179
  *
123
180
  * @returns A promise that resolves PXE is ready to be used.
124
181
  */
125
- public static async create(
126
- node: AztecNode,
127
- store: AztecAsyncKVStore,
128
- proofCreator: PrivateKernelProver,
129
- simulator: CircuitSimulator,
130
- protocolContractsProvider: ProtocolContractsProvider,
131
- config: PXEConfig,
132
- loggerOrSuffix?: string | Logger,
133
- ) {
182
+ public static async create({
183
+ node,
184
+ store,
185
+ proofCreator,
186
+ simulator,
187
+ protocolContractsProvider,
188
+ config,
189
+ loggerOrSuffix,
190
+ }: PXECreateArgs) {
134
191
  // Extract bindings from the logger, or use empty bindings if a string suffix is provided.
135
192
  const bindings: LoggerBindings | undefined =
136
193
  loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
@@ -140,7 +197,9 @@ export class PXE {
140
197
  ? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
141
198
  : loggerOrSuffix;
142
199
 
143
- const proverEnabled = !!config.proverEnabled;
200
+ const info = await node.getNodeInfo();
201
+
202
+ const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
144
203
  const addressStore = new AddressStore(store);
145
204
  const privateEventStore = new PrivateEventStore(store);
146
205
  const contractStore = new ContractStore(store);
@@ -158,6 +217,8 @@ export class PXE {
158
217
  noteStore,
159
218
  createLogger('pxe:contract_sync', bindings),
160
219
  );
220
+ const messageContextService = new MessageContextService(node);
221
+
161
222
  const synchronizer = new BlockSynchronizer(
162
223
  node,
163
224
  store,
@@ -186,6 +247,7 @@ export class PXE {
186
247
 
187
248
  const pxe = new PXE(
188
249
  node,
250
+ store,
189
251
  synchronizer,
190
252
  keyStore,
191
253
  contractStore,
@@ -198,6 +260,7 @@ export class PXE {
198
260
  addressStore,
199
261
  privateEventStore,
200
262
  contractSyncService,
263
+ messageContextService,
201
264
  simulator,
202
265
  proverEnabled,
203
266
  proofCreator,
@@ -211,13 +274,12 @@ export class PXE {
211
274
  debugUtils.setPXEHelpers(
212
275
  pxe.#putInJobQueue.bind(pxe),
213
276
  pxe.#getSimulatorForTx.bind(pxe),
214
- pxe.#simulateUtility.bind(pxe),
277
+ pxe.#executeUtility.bind(pxe),
215
278
  );
216
279
 
217
280
  pxe.jobQueue.start();
218
281
 
219
282
  await pxe.#registerProtocolContracts();
220
- const info = await node.getNodeInfo();
221
283
  log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
222
284
  return pxe;
223
285
  }
@@ -227,20 +289,21 @@ export class PXE {
227
289
  #getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
228
290
  const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
229
291
 
230
- return new ContractFunctionSimulator(
231
- proxyContractStore,
232
- this.noteStore,
233
- this.keyStore,
234
- this.addressStore,
235
- BenchmarkedNodeFactory.create(this.node),
236
- this.senderTaggingStore,
237
- this.recipientTaggingStore,
238
- this.senderAddressBookStore,
239
- this.capsuleStore,
240
- this.privateEventStore,
241
- this.simulator,
242
- this.contractSyncService,
243
- );
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
+ senderTaggingStore: this.senderTaggingStore,
299
+ recipientTaggingStore: this.recipientTaggingStore,
300
+ senderAddressBookStore: this.senderAddressBookStore,
301
+ capsuleStore: this.capsuleStore,
302
+ privateEventStore: this.privateEventStore,
303
+ simulator: this.simulator,
304
+ contractSyncService: this.contractSyncService,
305
+ messageContextService: this.messageContextService,
306
+ });
244
307
  }
245
308
 
246
309
  #contextualizeError(err: Error, ...context: string[]): Error {
@@ -292,9 +355,8 @@ export class PXE {
292
355
  async #registerProtocolContracts() {
293
356
  const registered: Record<string, string> = {};
294
357
  for (const name of protocolContractNames) {
295
- const { address, contractClass, instance, artifact } =
296
- await this.protocolContractsProvider.getProtocolContractArtifact(name);
297
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
358
+ const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
359
+ await this.contractStore.addContractArtifact(artifact);
298
360
  await this.contractStore.addContractInstance(instance);
299
361
  registered[name] = address.toString();
300
362
  }
@@ -306,7 +368,7 @@ export class PXE {
306
368
  async #executePrivate(
307
369
  contractFunctionSimulator: ContractFunctionSimulator,
308
370
  txRequest: TxExecutionRequest,
309
- scopes: AztecAddress[] | undefined,
371
+ scopes: AccessScopes,
310
372
  jobId: string,
311
373
  ): Promise<PrivateExecutionResult> {
312
374
  const { origin: contractAddress, functionSelector } = txRequest;
@@ -317,23 +379,20 @@ export class PXE {
317
379
  await this.contractSyncService.ensureContractSynced(
318
380
  contractAddress,
319
381
  functionSelector,
320
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
382
+ (privateSyncCall, execScopes) =>
383
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
321
384
  anchorBlockHeader,
322
385
  jobId,
386
+ scopes,
323
387
  );
324
388
 
325
- const result = await contractFunctionSimulator.run(
326
- txRequest,
389
+ const result = await contractFunctionSimulator.run(txRequest, {
327
390
  contractAddress,
328
- functionSelector,
329
- undefined,
391
+ selector: functionSelector,
330
392
  anchorBlockHeader,
331
- // The sender for tags is set by contracts, typically by an account
332
- // contract entrypoint
333
- undefined, // senderForTags
334
393
  scopes,
335
394
  jobId,
336
- );
395
+ });
337
396
  this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
338
397
  return result;
339
398
  } catch (err) {
@@ -345,25 +404,32 @@ export class PXE {
345
404
  }
346
405
 
347
406
  /**
348
- * Simulate a utility function call on the given contract.
407
+ * Execute a utility function call on the given contract.
349
408
  * @param contractFunctionSimulator - The simulator to use for the function call.
350
409
  * @param call - The function call to execute.
351
410
  * @param authWitnesses - Authentication witnesses required for the function call.
352
411
  * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
353
412
  * accounts if not specified.
354
413
  * @param jobId - The job ID for staged writes.
355
- * @returns The simulation result containing the outputs of the utility function.
414
+ * @returns The execution result containing the outputs of the utility function.
356
415
  */
357
- async #simulateUtility(
416
+ async #executeUtility(
358
417
  contractFunctionSimulator: ContractFunctionSimulator,
359
418
  call: FunctionCall,
360
419
  authWitnesses: AuthWitness[] | undefined,
361
- scopes: AztecAddress[] | undefined,
420
+ scopes: AccessScopes,
362
421
  jobId: string,
363
422
  ) {
364
423
  try {
365
424
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
366
- return contractFunctionSimulator.runUtility(call, authWitnesses ?? [], anchorBlockHeader, scopes, jobId);
425
+ const { result, offchainEffects } = await contractFunctionSimulator.runUtility(
426
+ call,
427
+ authWitnesses ?? [],
428
+ anchorBlockHeader,
429
+ scopes,
430
+ jobId,
431
+ );
432
+ return { result, offchainEffects };
367
433
  } catch (err) {
368
434
  if (err instanceof SimulationError) {
369
435
  await enrichSimulationError(err, this.contractStore, this.log);
@@ -503,6 +569,9 @@ export class PXE {
503
569
 
504
570
  if (wasAdded) {
505
571
  this.log.info(`Added sender:\n ${sender.toString()}`);
572
+ // Wipe the entire sync cache: the new sender's tagged logs could contain notes/events for any contract, so
573
+ // all contracts must re-sync to discover them.
574
+ this.contractSyncService.wipe();
506
575
  } else {
507
576
  this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
508
577
  }
@@ -552,8 +621,7 @@ export class PXE {
552
621
  * @param artifact - The build artifact for the contract class.
553
622
  */
554
623
  public async registerContractClass(artifact: ContractArtifact): Promise<void> {
555
- const { id: contractClassId } = await getContractClassFromArtifact(artifact);
556
- await this.contractStore.addContractArtifact(contractClassId, artifact);
624
+ const contractClassId = await this.contractStore.addContractArtifact(artifact);
557
625
  this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
558
626
  }
559
627
 
@@ -572,17 +640,17 @@ export class PXE {
572
640
  if (artifact) {
573
641
  // If the user provides an artifact, validate it against the expected class id and register it
574
642
  const contractClass = await getContractClassFromArtifact(artifact);
575
- const contractClassId = contractClass.id;
576
- if (!contractClassId.equals(instance.currentContractClassId)) {
643
+ if (!contractClass.id.equals(instance.currentContractClassId)) {
577
644
  throw new Error(
578
- `Artifact does not match expected class id (computed ${contractClassId} but instance refers to ${instance.currentContractClassId})`,
645
+ `Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
579
646
  );
580
647
  }
581
648
  const computedAddress = await computeContractAddressFromInstance(instance);
582
649
  if (!computedAddress.equals(instance.address)) {
583
650
  throw new Error('Added a contract in which the address does not match the contract instance.');
584
651
  }
585
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
652
+
653
+ await this.contractStore.addContractArtifact(artifact, contractClass);
586
654
 
587
655
  const publicFunctionSignatures = artifact.functions
588
656
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
@@ -631,15 +699,16 @@ export class PXE {
631
699
  throw new Error('Could not update contract to a class different from the current one.');
632
700
  }
633
701
 
634
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
635
-
636
702
  const publicFunctionSignatures = artifact.functions
637
703
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
638
704
  .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
639
705
  await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
640
706
 
641
707
  currentInstance.currentContractClassId = contractClass.id;
642
- await this.contractStore.addContractInstance(currentInstance);
708
+ await Promise.all([
709
+ this.contractStore.addContractArtifact(artifact, contractClass),
710
+ this.contractStore.addContractInstance(currentInstance),
711
+ ]);
643
712
  this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
644
713
  });
645
714
  }
@@ -657,11 +726,12 @@ export class PXE {
657
726
  * (where validators prove the public portion).
658
727
  *
659
728
  * @param txRequest - An authenticated tx request ready for proving
729
+ * @param scopes - Addresses whose private state and keys are accessible during private execution.
660
730
  * @returns A result containing the proof and public inputs of the tail circuit.
661
731
  * @throws If contract code not found, or public simulation reverts.
662
732
  * Also throws if simulatePublic is true and public simulation reverts.
663
733
  */
664
- public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
734
+ public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
665
735
  let privateExecutionResult: PrivateExecutionResult;
666
736
  // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
667
737
  // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
@@ -672,7 +742,7 @@ export class PXE {
672
742
  await this.blockStateSynchronizer.sync();
673
743
  const syncTime = syncTimer.ms();
674
744
  const contractFunctionSimulator = this.#getSimulatorForTx();
675
- privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, undefined, jobId);
745
+ privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
676
746
 
677
747
  const {
678
748
  publicInputs,
@@ -714,17 +784,17 @@ export class PXE {
714
784
  // transaction before this one is included in a block from this PXE, and that transaction contains a log with
715
785
  // a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
716
786
  // storing the tags here prevents linkage of txs sent from the same PXE.
717
- const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
718
- if (preTagsUsedInTheTx.length > 0) {
787
+ const taggingIndexRangesUsedInTheTx = privateExecutionResult.entrypoint.taggingIndexRanges;
788
+ if (taggingIndexRangesUsedInTheTx.length > 0) {
719
789
  // TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
720
790
  const txHash = (await txProvingResult.toTx()).txHash;
721
791
 
722
- await this.senderTaggingStore.storePendingIndexes(preTagsUsedInTheTx, txHash, jobId);
723
- this.log.debug(`Stored used pre-tags as sender for the tx`, {
724
- preTagsUsedInTheTx,
792
+ await this.senderTaggingStore.storePendingIndexes(taggingIndexRangesUsedInTheTx, txHash, jobId);
793
+ this.log.debug(`Stored used tagging index ranges as sender for the tx`, {
794
+ taggingIndexRangesUsedInTheTx,
725
795
  });
726
796
  } else {
727
- this.log.debug(`No pre-tags used in the tx`);
797
+ this.log.debug(`No tagging index ranges used in the tx`);
728
798
  }
729
799
 
730
800
  return txProvingResult;
@@ -736,17 +806,13 @@ export class PXE {
736
806
 
737
807
  /**
738
808
  * Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
739
- *
740
- * @param txRequest - An authenticated tx request ready for simulation
741
- * @param msgSender - (Optional) The message sender to use for the simulation.
742
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
809
+ * @param txRequest - An authenticated tx request ready for simulation.
743
810
  * @returns A trace of the program execution with gate counts.
744
811
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
745
812
  */
746
813
  public profileTx(
747
814
  txRequest: TxExecutionRequest,
748
- profileMode: 'full' | 'execution-steps' | 'gates',
749
- skipProofGeneration: boolean = true,
815
+ { profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
750
816
  ): Promise<TxProfileResult> {
751
817
  // We disable concurrent profiles for consistency with simulateTx.
752
818
  return this.#putInJobQueue(async jobId => {
@@ -769,12 +835,7 @@ export class PXE {
769
835
  const syncTime = syncTimer.ms();
770
836
 
771
837
  const contractFunctionSimulator = this.#getSimulatorForTx();
772
- const privateExecutionResult = await this.#executePrivate(
773
- contractFunctionSimulator,
774
- txRequest,
775
- undefined,
776
- jobId,
777
- );
838
+ const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
778
839
 
779
840
  const { executionSteps, timings: { proving } = {} } = await this.#prove(
780
841
  txRequest,
@@ -831,12 +892,7 @@ export class PXE {
831
892
  * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
832
893
  *
833
894
  *
834
- * @param txRequest - An authenticated tx request ready for simulation
835
- * @param simulatePublic - Whether to simulate the public part of the transaction.
836
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
837
- * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
838
- * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
839
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
895
+ * @param txRequest - An authenticated tx request ready for simulation.
840
896
  * @returns A simulated transaction result object that includes public and private return values.
841
897
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
842
898
  * Also throws if simulatePublic is true and public simulation reverts.
@@ -845,11 +901,14 @@ export class PXE {
845
901
  */
846
902
  public simulateTx(
847
903
  txRequest: TxExecutionRequest,
848
- simulatePublic: boolean,
849
- skipTxValidation: boolean = false,
850
- skipFeeEnforcement: boolean = false,
851
- overrides?: SimulationOverrides,
852
- scopes?: AztecAddress[],
904
+ {
905
+ simulatePublic,
906
+ skipTxValidation = false,
907
+ skipFeeEnforcement = false,
908
+ skipKernels = true,
909
+ overrides,
910
+ scopes,
911
+ }: SimulateTxOpts,
853
912
  ): Promise<TxSimulationResult> {
854
913
  // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
855
914
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
@@ -873,17 +932,20 @@ export class PXE {
873
932
  await this.blockStateSynchronizer.sync();
874
933
  const syncTime = syncTimer.ms();
875
934
 
876
- const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
877
- // Temporary: in case there are overrides, we have to skip the kernels or validations
878
- // will fail. Consider handing control to the user/wallet on whether they want to run them
879
- // or not.
880
935
  const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
881
936
  const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
882
- const skipKernels = hasOverriddenContracts;
883
937
 
884
- // Set overridden contracts on the sync service so it knows to skip syncing them
938
+ if (hasOverriddenContracts && !skipKernels) {
939
+ throw new Error(
940
+ 'Simulating with overridden contracts is not compatible with kernel execution. Please set skipKernels to true when simulating with overridden contracts.',
941
+ );
942
+ }
943
+ const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
944
+
885
945
  if (hasOverriddenContracts) {
886
- this.contractSyncService.setOverriddenContracts(jobId, overriddenContracts);
946
+ // Overridden contracts don't have a sync function, so calling sync on them would fail.
947
+ // We exclude them so the sync service skips them entirely.
948
+ this.contractSyncService.setExcludedFromSync(jobId, overriddenContracts);
887
949
  }
888
950
 
889
951
  // Execution of private functions only; no proving, and no kernel logic.
@@ -896,6 +958,7 @@ export class PXE {
896
958
  ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
897
959
  privateExecutionResult,
898
960
  (addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
961
+ this.node,
899
962
  ));
900
963
  } else {
901
964
  // Kernel logic, plus proving of all private functions and kernels.
@@ -914,6 +977,9 @@ export class PXE {
914
977
  const publicSimulationTimer = new Timer();
915
978
  publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
916
979
  publicSimulationTime = publicSimulationTimer.ms();
980
+ if (publicOutput?.debugLogs?.length) {
981
+ await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
982
+ }
917
983
  }
918
984
 
919
985
  let validationTime: number | undefined;
@@ -922,7 +988,8 @@ export class PXE {
922
988
  const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
923
989
  validationTime = validationTimer.ms();
924
990
  if (validationResult.result === 'invalid') {
925
- throw new Error('The simulated transaction is unable to be added to state and is invalid.');
991
+ const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
992
+ throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
926
993
  }
927
994
  }
928
995
 
@@ -973,29 +1040,23 @@ export class PXE {
973
1040
  inspect(txRequest),
974
1041
  `simulatePublic=${simulatePublic}`,
975
1042
  `skipTxValidation=${skipTxValidation}`,
976
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1043
+ `scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
977
1044
  );
978
1045
  }
979
1046
  });
980
1047
  }
981
1048
 
982
1049
  /**
983
- * Simulate the execution of a contract utility function.
984
- *
1050
+ * Executes a contract utility function.
985
1051
  * @param call - The function call containing the function details, arguments, and target contract address.
986
- * @param authwits - (Optional) The authentication witnesses required for the function call.
987
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
988
- * default to all.
989
- * @returns The result of the utility function call, structured based on the function ABI.
990
1052
  */
991
- public simulateUtility(
1053
+ public executeUtility(
992
1054
  call: FunctionCall,
993
- authwits?: AuthWitness[],
994
- scopes?: AztecAddress[],
995
- ): Promise<UtilitySimulationResult> {
996
- // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
1055
+ { authwits, scopes }: ExecuteUtilityOpts = { scopes: 'ALL_SCOPES' },
1056
+ ): Promise<UtilityExecutionResult> {
1057
+ // We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
997
1058
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
998
- // delete the same read value, or reading values that another simulation is currently modifying).
1059
+ // delete the same read value, or reading values that another execution is currently modifying).
999
1060
  return this.#putInJobQueue(async jobId => {
1000
1061
  try {
1001
1062
  const totalTimer = new Timer();
@@ -1009,12 +1070,14 @@ export class PXE {
1009
1070
  await this.contractSyncService.ensureContractSynced(
1010
1071
  call.to,
1011
1072
  call.selector,
1012
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1073
+ (privateSyncCall, execScopes) =>
1074
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1013
1075
  anchorBlockHeader,
1014
1076
  jobId,
1077
+ scopes,
1015
1078
  );
1016
1079
 
1017
- const executionResult = await this.#simulateUtility(
1080
+ const { result: executionResult, offchainEffects } = await this.#executeUtility(
1018
1081
  contractFunctionSimulator,
1019
1082
  call,
1020
1083
  authwits ?? [],
@@ -1035,14 +1098,19 @@ export class PXE {
1035
1098
  };
1036
1099
 
1037
1100
  const simulationStats = contractFunctionSimulator.getStats();
1038
- return { result: executionResult, stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls } };
1101
+ return {
1102
+ result: executionResult,
1103
+ offchainEffects,
1104
+ anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
1105
+ stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
1106
+ };
1039
1107
  } catch (err: any) {
1040
1108
  const { to, name, args } = call;
1041
1109
  const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
1042
1110
  throw this.#contextualizeError(
1043
1111
  err,
1044
- `simulateUtility ${to}:${name}(${stringifiedArgs})`,
1045
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1112
+ `executeUtility ${to}:${name}(${stringifiedArgs})`,
1113
+ `scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
1046
1114
  );
1047
1115
  }
1048
1116
  });
@@ -1078,10 +1146,11 @@ export class PXE {
1078
1146
  await this.contractSyncService.ensureContractSynced(
1079
1147
  filter.contractAddress,
1080
1148
  null,
1081
- async privateSyncCall =>
1082
- await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1149
+ async (privateSyncCall, execScopes) =>
1150
+ await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1083
1151
  anchorBlockHeader,
1084
1152
  jobId,
1153
+ filter.scopes,
1085
1154
  );
1086
1155
  });
1087
1156
 
@@ -1096,9 +1165,10 @@ export class PXE {
1096
1165
  }
1097
1166
 
1098
1167
  /**
1099
- * Stops the PXE's job queue.
1168
+ * Stops the PXE's job queue and closes the backing store.
1100
1169
  */
1101
- public stop(): Promise<void> {
1102
- return this.jobQueue.end();
1170
+ public async stop(): Promise<void> {
1171
+ await this.jobQueue.end();
1172
+ await this.db.close();
1103
1173
  }
1104
1174
  }