@aztec/pxe 0.0.1-commit.c80b6263 → 0.0.1-commit.c949de6bc

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/block_synchronizer/block_synchronizer.d.ts +4 -2
  5. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  6. package/dest/block_synchronizer/block_synchronizer.js +7 -1
  7. package/dest/config/package_info.js +1 -1
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts +54 -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 +174 -70
  11. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +5 -5
  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 +3 -3
  14. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  15. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -2
  16. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  18. package/dest/contract_function_simulator/oracle/interfaces.d.ts +9 -9
  19. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/oracle/oracle.d.ts +5 -5
  21. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/oracle.js +32 -20
  23. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +36 -36
  24. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +74 -29
  26. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +48 -24
  27. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  28. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +84 -63
  29. package/dest/contract_logging.d.ts +22 -0
  30. package/dest/contract_logging.d.ts.map +1 -0
  31. package/dest/contract_logging.js +23 -0
  32. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  33. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  34. package/dest/contract_sync/contract_sync_service.js +97 -0
  35. package/dest/contract_sync/helpers.d.ts +29 -0
  36. package/dest/contract_sync/helpers.d.ts.map +1 -0
  37. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  38. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  39. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  40. package/dest/debug/pxe_debug_utils.js +16 -15
  41. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  42. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  43. package/dest/entrypoints/client/bundle/index.js +3 -0
  44. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  45. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  46. package/dest/entrypoints/client/bundle/utils.js +11 -2
  47. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  48. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  49. package/dest/entrypoints/client/lazy/index.js +3 -0
  50. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  51. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  52. package/dest/entrypoints/client/lazy/utils.js +11 -2
  53. package/dest/entrypoints/server/index.d.ts +4 -2
  54. package/dest/entrypoints/server/index.d.ts.map +1 -1
  55. package/dest/entrypoints/server/index.js +3 -1
  56. package/dest/entrypoints/server/utils.js +9 -1
  57. package/dest/events/event_service.d.ts +4 -5
  58. package/dest/events/event_service.d.ts.map +1 -1
  59. package/dest/events/event_service.js +5 -6
  60. package/dest/logs/log_service.d.ts +6 -5
  61. package/dest/logs/log_service.d.ts.map +1 -1
  62. package/dest/logs/log_service.js +18 -28
  63. package/dest/notes/note_service.d.ts +7 -7
  64. package/dest/notes/note_service.d.ts.map +1 -1
  65. package/dest/notes/note_service.js +9 -9
  66. package/dest/notes_filter.d.ts +25 -0
  67. package/dest/notes_filter.d.ts.map +1 -0
  68. package/dest/notes_filter.js +4 -0
  69. package/dest/oracle_version.d.ts +3 -3
  70. package/dest/oracle_version.d.ts.map +1 -1
  71. package/dest/oracle_version.js +2 -2
  72. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  73. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  74. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  75. package/dest/private_kernel/hints/index.d.ts +1 -1
  76. package/dest/private_kernel/hints/index.js +1 -1
  77. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  78. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  79. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  80. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  81. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  82. package/dest/private_kernel/hints/test_utils.js +203 -0
  83. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  84. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  85. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  86. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  87. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  88. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  89. package/dest/pxe.d.ts +69 -23
  90. package/dest/pxe.d.ts.map +1 -1
  91. package/dest/pxe.js +94 -61
  92. package/dest/storage/address_store/address_store.d.ts +1 -1
  93. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  94. package/dest/storage/address_store/address_store.js +12 -11
  95. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
  96. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  97. package/dest/storage/anchor_block_store/anchor_block_store.js +8 -1
  98. package/dest/storage/capsule_store/capsule_store.js +6 -8
  99. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  100. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  101. package/dest/storage/contract_store/contract_store.js +157 -72
  102. package/dest/storage/metadata.d.ts +1 -1
  103. package/dest/storage/metadata.js +1 -1
  104. package/dest/storage/note_store/note_store.d.ts +13 -3
  105. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  106. package/dest/storage/note_store/note_store.js +147 -107
  107. package/dest/storage/private_event_store/private_event_store.d.ts +1 -1
  108. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  109. package/dest/storage/private_event_store/private_event_store.js +84 -61
  110. package/dest/storage/private_event_store/stored_private_event.js +1 -1
  111. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  112. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  113. package/dest/storage/tagging_store/recipient_tagging_store.js +31 -19
  114. package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
  115. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
  116. package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
  117. package/dest/storage/tagging_store/sender_tagging_store.d.ts +5 -5
  118. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  119. package/dest/storage/tagging_store/sender_tagging_store.js +184 -114
  120. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  121. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  122. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  123. package/dest/tagging/index.d.ts +2 -2
  124. package/dest/tagging/index.d.ts.map +1 -1
  125. package/dest/tagging/index.js +1 -1
  126. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  127. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  128. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  129. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  130. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  131. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  132. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  133. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  134. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  135. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +3 -6
  136. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +4 -7
  137. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  138. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +14 -15
  139. package/package.json +25 -16
  140. package/src/access_scopes.ts +9 -0
  141. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  142. package/src/config/package_info.ts +1 -1
  143. package/src/contract_function_simulator/contract_function_simulator.ts +323 -128
  144. package/src/contract_function_simulator/execution_tagging_index_cache.ts +5 -5
  145. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  146. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  147. package/src/contract_function_simulator/oracle/interfaces.ts +10 -10
  148. package/src/contract_function_simulator/oracle/oracle.ts +35 -18
  149. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +100 -110
  150. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +131 -64
  151. package/src/contract_logging.ts +39 -0
  152. package/src/contract_sync/contract_sync_service.ts +152 -0
  153. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  154. package/src/debug/pxe_debug_utils.ts +48 -18
  155. package/src/entrypoints/client/bundle/index.ts +3 -0
  156. package/src/entrypoints/client/bundle/utils.ts +12 -2
  157. package/src/entrypoints/client/lazy/index.ts +3 -0
  158. package/src/entrypoints/client/lazy/utils.ts +12 -2
  159. package/src/entrypoints/server/index.ts +3 -1
  160. package/src/entrypoints/server/utils.ts +7 -7
  161. package/src/events/event_service.ts +4 -6
  162. package/src/logs/log_service.ts +25 -35
  163. package/src/notes/note_service.ts +9 -10
  164. package/src/notes_filter.ts +26 -0
  165. package/src/oracle_version.ts +2 -2
  166. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  167. package/src/private_kernel/hints/index.ts +1 -1
  168. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  169. package/src/private_kernel/hints/test_utils.ts +325 -0
  170. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  171. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  172. package/src/pxe.ts +178 -111
  173. package/src/storage/address_store/address_store.ts +15 -15
  174. package/src/storage/anchor_block_store/anchor_block_store.ts +8 -0
  175. package/src/storage/capsule_store/capsule_store.ts +8 -8
  176. package/src/storage/contract_store/contract_store.ts +186 -76
  177. package/src/storage/metadata.ts +1 -1
  178. package/src/storage/note_store/note_store.ts +169 -132
  179. package/src/storage/private_event_store/private_event_store.ts +102 -81
  180. package/src/storage/private_event_store/stored_private_event.ts +1 -1
  181. package/src/storage/tagging_store/recipient_tagging_store.ts +38 -24
  182. package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
  183. package/src/storage/tagging_store/sender_tagging_store.ts +214 -130
  184. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  185. package/src/tagging/index.ts +1 -1
  186. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  187. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  188. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  189. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +4 -9
  190. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +11 -20
  191. package/dest/contract_sync/index.d.ts +0 -23
  192. package/dest/contract_sync/index.d.ts.map +0 -1
  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
@@ -33,6 +33,7 @@ import type {
33
33
  PrivateKernelTailCircuitPublicInputs,
34
34
  } from '@aztec/stdlib/kernel';
35
35
  import {
36
+ BlockHeader,
36
37
  type ContractOverrides,
37
38
  type InTx,
38
39
  PrivateExecutionResult,
@@ -46,11 +47,12 @@ import {
46
47
  TxProfileResult,
47
48
  TxProvingResult,
48
49
  TxSimulationResult,
49
- UtilitySimulationResult,
50
+ UtilityExecutionResult,
50
51
  } from '@aztec/stdlib/tx';
51
52
 
52
53
  import { inspect } from 'util';
53
54
 
55
+ import type { AccessScopes } from './access_scopes.js';
54
56
  import { BlockSynchronizer } from './block_synchronizer/index.js';
55
57
  import type { PXEConfig } from './config/index.js';
56
58
  import { BenchmarkedNodeFactory } from './contract_function_simulator/benchmarked_node.js';
@@ -59,7 +61,9 @@ 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';
@@ -84,6 +88,56 @@ export type PackedPrivateEvent = InTx & {
84
88
  eventSelector: EventSelector;
85
89
  };
86
90
 
91
+ /** Options for PXE.profileTx. */
92
+ export type ProfileTxOpts = {
93
+ /** The profiling mode to use. */
94
+ profileMode: 'full' | 'execution-steps' | 'gates';
95
+ /** If true, proof generation is skipped during profiling. Defaults to true. */
96
+ skipProofGeneration?: boolean;
97
+ /** Addresses whose private state and keys are accessible during private execution. */
98
+ scopes: AccessScopes;
99
+ };
100
+
101
+ /** Options for PXE.simulateTx. */
102
+ export type SimulateTxOpts = {
103
+ /** Whether to simulate the public part of the transaction. */
104
+ simulatePublic: boolean;
105
+ /** If false, this function throws if the transaction is unable to be included in a block at the current state. */
106
+ skipTxValidation?: boolean;
107
+ /** If false, fees are enforced. */
108
+ skipFeeEnforcement?: boolean;
109
+ /** State overrides for the simulation, such as contract instances and artifacts. */
110
+ overrides?: SimulationOverrides;
111
+ /** Addresses whose private state and keys are accessible during private execution */
112
+ scopes: AccessScopes;
113
+ };
114
+
115
+ /** Options for PXE.executeUtility. */
116
+ export type ExecuteUtilityOpts = {
117
+ /** The authentication witnesses required for the function call. */
118
+ authwits?: AuthWitness[];
119
+ /** The accounts whose notes we can access in this call */
120
+ scopes: AccessScopes;
121
+ };
122
+
123
+ /** Args for PXE.create. */
124
+ export type PXECreateArgs = {
125
+ /** The Aztec node to connect to. */
126
+ node: AztecNode;
127
+ /** The key-value store for persisting PXE state. */
128
+ store: AztecAsyncKVStore;
129
+ /** The prover for generating private kernel proofs. */
130
+ proofCreator: PrivateKernelProver;
131
+ /** The circuit simulator for executing ACIR circuits. */
132
+ simulator: CircuitSimulator;
133
+ /** Provider for protocol contract artifacts and instances. */
134
+ protocolContractsProvider: ProtocolContractsProvider;
135
+ /** PXE configuration options. */
136
+ config: PXEConfig;
137
+ /** Optional logger instance or string suffix for the logger name. */
138
+ loggerOrSuffix?: string | Logger;
139
+ };
140
+
87
141
  /**
88
142
  * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
89
143
  * manage private state of users.
@@ -102,6 +156,7 @@ export class PXE {
102
156
  private recipientTaggingStore: RecipientTaggingStore,
103
157
  private addressStore: AddressStore,
104
158
  private privateEventStore: PrivateEventStore,
159
+ private contractSyncService: ContractSyncService,
105
160
  private simulator: CircuitSimulator,
106
161
  private proverEnabled: boolean,
107
162
  private proofCreator: PrivateKernelProver,
@@ -119,15 +174,15 @@ export class PXE {
119
174
  *
120
175
  * @returns A promise that resolves PXE is ready to be used.
121
176
  */
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
- ) {
177
+ public static async create({
178
+ node,
179
+ store,
180
+ proofCreator,
181
+ simulator,
182
+ protocolContractsProvider,
183
+ config,
184
+ loggerOrSuffix,
185
+ }: PXECreateArgs) {
131
186
  // Extract bindings from the logger, or use empty bindings if a string suffix is provided.
132
187
  const bindings: LoggerBindings | undefined =
133
188
  loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
@@ -137,7 +192,9 @@ export class PXE {
137
192
  ? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
138
193
  : loggerOrSuffix;
139
194
 
140
- const proverEnabled = !!config.proverEnabled;
195
+ const info = await node.getNodeInfo();
196
+
197
+ const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
141
198
  const addressStore = new AddressStore(store);
142
199
  const privateEventStore = new PrivateEventStore(store);
143
200
  const contractStore = new ContractStore(store);
@@ -149,6 +206,12 @@ export class PXE {
149
206
  const capsuleStore = new CapsuleStore(store);
150
207
  const keyStore = new KeyStore(store);
151
208
  const tipsStore = new L2TipsKVStore(store, 'pxe');
209
+ const contractSyncService = new ContractSyncService(
210
+ node,
211
+ contractStore,
212
+ noteStore,
213
+ createLogger('pxe:contract_sync', bindings),
214
+ );
152
215
  const synchronizer = new BlockSynchronizer(
153
216
  node,
154
217
  store,
@@ -156,6 +219,7 @@ export class PXE {
156
219
  noteStore,
157
220
  privateEventStore,
158
221
  tipsStore,
222
+ contractSyncService,
159
223
  config,
160
224
  bindings,
161
225
  );
@@ -167,9 +231,10 @@ export class PXE {
167
231
  recipientTaggingStore,
168
232
  privateEventStore,
169
233
  noteStore,
234
+ contractSyncService,
170
235
  ]);
171
236
 
172
- const debugUtils = new PXEDebugUtils(contractStore, noteStore, synchronizer, anchorBlockStore);
237
+ const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
173
238
 
174
239
  const jobQueue = new SerialQueue();
175
240
 
@@ -186,6 +251,7 @@ export class PXE {
186
251
  recipientTaggingStore,
187
252
  addressStore,
188
253
  privateEventStore,
254
+ contractSyncService,
189
255
  simulator,
190
256
  proverEnabled,
191
257
  proofCreator,
@@ -196,12 +262,15 @@ export class PXE {
196
262
  debugUtils,
197
263
  );
198
264
 
199
- debugUtils.setPXE(pxe, pxe.#putInJobQueue.bind(pxe));
265
+ debugUtils.setPXEHelpers(
266
+ pxe.#putInJobQueue.bind(pxe),
267
+ pxe.#getSimulatorForTx.bind(pxe),
268
+ pxe.#executeUtility.bind(pxe),
269
+ );
200
270
 
201
271
  pxe.jobQueue.start();
202
272
 
203
273
  await pxe.#registerProtocolContracts();
204
- const info = await node.getNodeInfo();
205
274
  log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
206
275
  return pxe;
207
276
  }
@@ -211,20 +280,20 @@ export class PXE {
211
280
  #getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
212
281
  const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
213
282
 
214
- return new ContractFunctionSimulator(
215
- proxyContractStore,
216
- this.noteStore,
217
- this.keyStore,
218
- this.addressStore,
219
- BenchmarkedNodeFactory.create(this.node),
220
- this.anchorBlockStore,
221
- this.senderTaggingStore,
222
- this.recipientTaggingStore,
223
- this.senderAddressBookStore,
224
- this.capsuleStore,
225
- this.privateEventStore,
226
- this.simulator,
227
- );
283
+ return new ContractFunctionSimulator({
284
+ contractStore: proxyContractStore,
285
+ noteStore: this.noteStore,
286
+ keyStore: this.keyStore,
287
+ addressStore: this.addressStore,
288
+ aztecNode: BenchmarkedNodeFactory.create(this.node),
289
+ senderTaggingStore: this.senderTaggingStore,
290
+ recipientTaggingStore: this.recipientTaggingStore,
291
+ senderAddressBookStore: this.senderAddressBookStore,
292
+ capsuleStore: this.capsuleStore,
293
+ privateEventStore: this.privateEventStore,
294
+ simulator: this.simulator,
295
+ contractSyncService: this.contractSyncService,
296
+ });
228
297
  }
229
298
 
230
299
  #contextualizeError(err: Error, ...context: string[]): Error {
@@ -276,9 +345,8 @@ export class PXE {
276
345
  async #registerProtocolContracts() {
277
346
  const registered: Record<string, string> = {};
278
347
  for (const name of protocolContractNames) {
279
- const { address, contractClass, instance, artifact } =
280
- await this.protocolContractsProvider.getProtocolContractArtifact(name);
281
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
348
+ const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
349
+ await this.contractStore.addContractArtifact(artifact);
282
350
  await this.contractStore.addContractInstance(instance);
283
351
  registered[name] = address.toString();
284
352
  }
@@ -290,7 +358,7 @@ export class PXE {
290
358
  async #executePrivate(
291
359
  contractFunctionSimulator: ContractFunctionSimulator,
292
360
  txRequest: TxExecutionRequest,
293
- scopes: AztecAddress[] | undefined,
361
+ scopes: AccessScopes,
294
362
  jobId: string,
295
363
  ): Promise<PrivateExecutionResult> {
296
364
  const { origin: contractAddress, functionSelector } = txRequest;
@@ -298,27 +366,23 @@ export class PXE {
298
366
  try {
299
367
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
300
368
 
301
- await ensureContractSynced(
369
+ await this.contractSyncService.ensureContractSynced(
302
370
  contractAddress,
303
371
  functionSelector,
304
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
305
- this.node,
306
- this.contractStore,
372
+ (privateSyncCall, execScopes) =>
373
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
307
374
  anchorBlockHeader,
375
+ jobId,
376
+ scopes,
308
377
  );
309
378
 
310
- const result = await contractFunctionSimulator.run(
311
- txRequest,
379
+ const result = await contractFunctionSimulator.run(txRequest, {
312
380
  contractAddress,
313
- functionSelector,
314
- undefined,
381
+ selector: functionSelector,
315
382
  anchorBlockHeader,
316
- // The sender for tags is set by contracts, typically by an account
317
- // contract entrypoint
318
- undefined, // senderForTags
319
383
  scopes,
320
384
  jobId,
321
- );
385
+ });
322
386
  this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
323
387
  return result;
324
388
  } catch (err) {
@@ -330,20 +394,20 @@ export class PXE {
330
394
  }
331
395
 
332
396
  /**
333
- * Simulate a utility function call on the given contract.
397
+ * Execute a utility function call on the given contract.
334
398
  * @param contractFunctionSimulator - The simulator to use for the function call.
335
399
  * @param call - The function call to execute.
336
400
  * @param authWitnesses - Authentication witnesses required for the function call.
337
401
  * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
338
402
  * accounts if not specified.
339
403
  * @param jobId - The job ID for staged writes.
340
- * @returns The simulation result containing the outputs of the utility function.
404
+ * @returns The execution result containing the outputs of the utility function.
341
405
  */
342
- async #simulateUtility(
406
+ async #executeUtility(
343
407
  contractFunctionSimulator: ContractFunctionSimulator,
344
408
  call: FunctionCall,
345
409
  authWitnesses: AuthWitness[] | undefined,
346
- scopes: AztecAddress[] | undefined,
410
+ scopes: AccessScopes,
347
411
  jobId: string,
348
412
  ) {
349
413
  try {
@@ -416,6 +480,19 @@ export class PXE {
416
480
 
417
481
  // Public API
418
482
 
483
+ /**
484
+ * Returns the block header up to which the PXE has synced.
485
+ * @returns The synced block header
486
+ */
487
+ public getSyncedBlockHeader(): Promise<BlockHeader> {
488
+ return this.anchorBlockStore.getBlockHeader();
489
+ }
490
+
491
+ /**
492
+ * Returns the contract instance for a given address, if it's registered in the PXE.
493
+ * @param address - The contract address.
494
+ * @returns The contract instance if found, undefined otherwise.
495
+ */
419
496
  public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
420
497
  return this.contractStore.getContractInstance(address);
421
498
  }
@@ -524,8 +601,7 @@ export class PXE {
524
601
  * @param artifact - The build artifact for the contract class.
525
602
  */
526
603
  public async registerContractClass(artifact: ContractArtifact): Promise<void> {
527
- const { id: contractClassId } = await getContractClassFromArtifact(artifact);
528
- await this.contractStore.addContractArtifact(contractClassId, artifact);
604
+ const contractClassId = await this.contractStore.addContractArtifact(artifact);
529
605
  this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
530
606
  }
531
607
 
@@ -544,17 +620,17 @@ export class PXE {
544
620
  if (artifact) {
545
621
  // If the user provides an artifact, validate it against the expected class id and register it
546
622
  const contractClass = await getContractClassFromArtifact(artifact);
547
- const contractClassId = contractClass.id;
548
- if (!contractClassId.equals(instance.currentContractClassId)) {
623
+ if (!contractClass.id.equals(instance.currentContractClassId)) {
549
624
  throw new Error(
550
- `Artifact does not match expected class id (computed ${contractClassId} but instance refers to ${instance.currentContractClassId})`,
625
+ `Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
551
626
  );
552
627
  }
553
628
  const computedAddress = await computeContractAddressFromInstance(instance);
554
629
  if (!computedAddress.equals(instance.address)) {
555
630
  throw new Error('Added a contract in which the address does not match the contract instance.');
556
631
  }
557
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
632
+
633
+ await this.contractStore.addContractArtifact(artifact, contractClass);
558
634
 
559
635
  const publicFunctionSignatures = artifact.functions
560
636
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
@@ -603,15 +679,16 @@ export class PXE {
603
679
  throw new Error('Could not update contract to a class different from the current one.');
604
680
  }
605
681
 
606
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
607
-
608
682
  const publicFunctionSignatures = artifact.functions
609
683
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
610
684
  .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
611
685
  await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
612
686
 
613
687
  currentInstance.currentContractClassId = contractClass.id;
614
- await this.contractStore.addContractInstance(currentInstance);
688
+ await Promise.all([
689
+ this.contractStore.addContractArtifact(artifact, contractClass),
690
+ this.contractStore.addContractInstance(currentInstance),
691
+ ]);
615
692
  this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
616
693
  });
617
694
  }
@@ -629,11 +706,12 @@ export class PXE {
629
706
  * (where validators prove the public portion).
630
707
  *
631
708
  * @param txRequest - An authenticated tx request ready for proving
709
+ * @param scopes - Addresses whose private state and keys are accessible during private execution.
632
710
  * @returns A result containing the proof and public inputs of the tail circuit.
633
711
  * @throws If contract code not found, or public simulation reverts.
634
712
  * Also throws if simulatePublic is true and public simulation reverts.
635
713
  */
636
- public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
714
+ public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
637
715
  let privateExecutionResult: PrivateExecutionResult;
638
716
  // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
639
717
  // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
@@ -644,7 +722,7 @@ export class PXE {
644
722
  await this.blockStateSynchronizer.sync();
645
723
  const syncTime = syncTimer.ms();
646
724
  const contractFunctionSimulator = this.#getSimulatorForTx();
647
- privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, undefined, jobId);
725
+ privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
648
726
 
649
727
  const {
650
728
  publicInputs,
@@ -708,17 +786,13 @@ export class PXE {
708
786
 
709
787
  /**
710
788
  * Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
711
- *
712
- * @param txRequest - An authenticated tx request ready for simulation
713
- * @param msgSender - (Optional) The message sender to use for the simulation.
714
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
789
+ * @param txRequest - An authenticated tx request ready for simulation.
715
790
  * @returns A trace of the program execution with gate counts.
716
791
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
717
792
  */
718
793
  public profileTx(
719
794
  txRequest: TxExecutionRequest,
720
- profileMode: 'full' | 'execution-steps' | 'gates',
721
- skipProofGeneration: boolean = true,
795
+ { profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
722
796
  ): Promise<TxProfileResult> {
723
797
  // We disable concurrent profiles for consistency with simulateTx.
724
798
  return this.#putInJobQueue(async jobId => {
@@ -741,12 +815,7 @@ export class PXE {
741
815
  const syncTime = syncTimer.ms();
742
816
 
743
817
  const contractFunctionSimulator = this.#getSimulatorForTx();
744
- const privateExecutionResult = await this.#executePrivate(
745
- contractFunctionSimulator,
746
- txRequest,
747
- undefined,
748
- jobId,
749
- );
818
+ const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
750
819
 
751
820
  const { executionSteps, timings: { proving } = {} } = await this.#prove(
752
821
  txRequest,
@@ -803,12 +872,7 @@ export class PXE {
803
872
  * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
804
873
  *
805
874
  *
806
- * @param txRequest - An authenticated tx request ready for simulation
807
- * @param simulatePublic - Whether to simulate the public part of the transaction.
808
- * @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 skipFeeEnforcement - (Optional) If false, fees are enforced.
810
- * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
811
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
875
+ * @param txRequest - An authenticated tx request ready for simulation.
812
876
  * @returns A simulated transaction result object that includes public and private return values.
813
877
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
814
878
  * Also throws if simulatePublic is true and public simulation reverts.
@@ -817,11 +881,7 @@ export class PXE {
817
881
  */
818
882
  public simulateTx(
819
883
  txRequest: TxExecutionRequest,
820
- simulatePublic: boolean,
821
- skipTxValidation: boolean = false,
822
- skipFeeEnforcement: boolean = false,
823
- overrides?: SimulationOverrides,
824
- scopes?: AztecAddress[],
884
+ { simulatePublic, skipTxValidation = false, skipFeeEnforcement = false, overrides, scopes }: SimulateTxOpts,
825
885
  ): Promise<TxSimulationResult> {
826
886
  // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
827
887
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
@@ -849,7 +909,14 @@ export class PXE {
849
909
  // Temporary: in case there are overrides, we have to skip the kernels or validations
850
910
  // will fail. Consider handing control to the user/wallet on whether they want to run them
851
911
  // or not.
852
- const skipKernels = overrides?.contracts !== undefined && Object.keys(overrides.contracts ?? {}).length > 0;
912
+ const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
913
+ const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
914
+ const skipKernels = hasOverriddenContracts;
915
+
916
+ // Set overridden contracts on the sync service so it knows to skip syncing them
917
+ if (hasOverriddenContracts) {
918
+ this.contractSyncService.setOverriddenContracts(jobId, overriddenContracts);
919
+ }
853
920
 
854
921
  // Execution of private functions only; no proving, and no kernel logic.
855
922
  const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
@@ -860,7 +927,8 @@ export class PXE {
860
927
  if (skipKernels) {
861
928
  ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
862
929
  privateExecutionResult,
863
- this.contractStore,
930
+ (addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
931
+ this.node,
864
932
  ));
865
933
  } else {
866
934
  // Kernel logic, plus proving of all private functions and kernels.
@@ -879,6 +947,9 @@ export class PXE {
879
947
  const publicSimulationTimer = new Timer();
880
948
  publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
881
949
  publicSimulationTime = publicSimulationTimer.ms();
950
+ if (publicOutput?.debugLogs?.length) {
951
+ await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
952
+ }
882
953
  }
883
954
 
884
955
  let validationTime: number | undefined;
@@ -887,7 +958,8 @@ export class PXE {
887
958
  const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
888
959
  validationTime = validationTimer.ms();
889
960
  if (validationResult.result === 'invalid') {
890
- throw new Error('The simulated transaction is unable to be added to state and is invalid.');
961
+ const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
962
+ throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
891
963
  }
892
964
  }
893
965
 
@@ -938,29 +1010,23 @@ export class PXE {
938
1010
  inspect(txRequest),
939
1011
  `simulatePublic=${simulatePublic}`,
940
1012
  `skipTxValidation=${skipTxValidation}`,
941
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1013
+ `scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
942
1014
  );
943
1015
  }
944
1016
  });
945
1017
  }
946
1018
 
947
1019
  /**
948
- * Simulate the execution of a contract utility function.
949
- *
1020
+ * Executes a contract utility function.
950
1021
  * @param call - The function call containing the function details, arguments, and target contract address.
951
- * @param authwits - (Optional) The authentication witnesses required for the function call.
952
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
953
- * default to all.
954
- * @returns The result of the utility function call, structured based on the function ABI.
955
1022
  */
956
- public simulateUtility(
1023
+ public executeUtility(
957
1024
  call: FunctionCall,
958
- authwits?: AuthWitness[],
959
- scopes?: AztecAddress[],
960
- ): Promise<UtilitySimulationResult> {
961
- // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
1025
+ { authwits, scopes }: ExecuteUtilityOpts = { scopes: 'ALL_SCOPES' },
1026
+ ): Promise<UtilityExecutionResult> {
1027
+ // We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
962
1028
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
963
- // delete the same read value, or reading values that another simulation is currently modifying).
1029
+ // delete the same read value, or reading values that another execution is currently modifying).
964
1030
  return this.#putInJobQueue(async jobId => {
965
1031
  try {
966
1032
  const totalTimer = new Timer();
@@ -971,16 +1037,17 @@ export class PXE {
971
1037
  const contractFunctionSimulator = this.#getSimulatorForTx();
972
1038
 
973
1039
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
974
- await ensureContractSynced(
1040
+ await this.contractSyncService.ensureContractSynced(
975
1041
  call.to,
976
1042
  call.selector,
977
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
978
- this.node,
979
- this.contractStore,
1043
+ (privateSyncCall, execScopes) =>
1044
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
980
1045
  anchorBlockHeader,
1046
+ jobId,
1047
+ scopes,
981
1048
  );
982
1049
 
983
- const executionResult = await this.#simulateUtility(
1050
+ const executionResult = await this.#executeUtility(
984
1051
  contractFunctionSimulator,
985
1052
  call,
986
1053
  authwits ?? [],
@@ -1007,8 +1074,8 @@ export class PXE {
1007
1074
  const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
1008
1075
  throw this.#contextualizeError(
1009
1076
  err,
1010
- `simulateUtility ${to}:${name}(${stringifiedArgs})`,
1011
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1077
+ `executeUtility ${to}:${name}(${stringifiedArgs})`,
1078
+ `scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
1012
1079
  );
1013
1080
  }
1014
1081
  });
@@ -1041,14 +1108,14 @@ export class PXE {
1041
1108
 
1042
1109
  const contractFunctionSimulator = this.#getSimulatorForTx();
1043
1110
 
1044
- await ensureContractSynced(
1111
+ await this.contractSyncService.ensureContractSynced(
1045
1112
  filter.contractAddress,
1046
1113
  null,
1047
- async privateSyncCall =>
1048
- await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1049
- this.node,
1050
- this.contractStore,
1114
+ async (privateSyncCall, execScopes) =>
1115
+ await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1051
1116
  anchorBlockHeader,
1117
+ jobId,
1118
+ filter.scopes,
1052
1119
  );
1053
1120
  });
1054
1121
 
@@ -43,23 +43,23 @@ export class AddressStore {
43
43
  });
44
44
  }
45
45
 
46
- async #getCompleteAddress(address: AztecAddress): Promise<CompleteAddress | undefined> {
47
- const index = await this.#completeAddressIndex.getAsync(address.toString());
48
- if (index === undefined) {
49
- return undefined;
50
- }
51
-
52
- const value = await this.#completeAddresses.atAsync(index);
53
- return value ? await CompleteAddress.fromBuffer(value) : undefined;
54
- }
55
-
56
46
  getCompleteAddress(account: AztecAddress): Promise<CompleteAddress | undefined> {
57
- return this.#getCompleteAddress(account);
47
+ return this.#store.transactionAsync(async () => {
48
+ const index = await this.#completeAddressIndex.getAsync(account.toString());
49
+ if (index === undefined) {
50
+ return undefined;
51
+ }
52
+
53
+ const value = await this.#completeAddresses.atAsync(index);
54
+ return value ? await CompleteAddress.fromBuffer(value) : undefined;
55
+ });
58
56
  }
59
57
 
60
- async getCompleteAddresses(): Promise<CompleteAddress[]> {
61
- return await Promise.all(
62
- (await toArray(this.#completeAddresses.valuesAsync())).map(v => CompleteAddress.fromBuffer(v)),
63
- );
58
+ getCompleteAddresses(): Promise<CompleteAddress[]> {
59
+ return this.#store.transactionAsync(async () => {
60
+ return await Promise.all(
61
+ (await toArray(this.#completeAddresses.valuesAsync())).map(v => CompleteAddress.fromBuffer(v)),
62
+ );
63
+ });
64
64
  }
65
65
  }
@@ -10,6 +10,14 @@ export class AnchorBlockStore {
10
10
  this.#synchronizedHeader = this.#store.openSingleton('header');
11
11
  }
12
12
 
13
+ /**
14
+ * Sets the currently synchronized block
15
+ *
16
+ * Important: this method is only called from BlockSynchronizer, and since we need it to run atomically with other
17
+ * stores in the case of a reorg, it MUST NOT be wrapped in a `transactionAsync` call. Doing so would result in a
18
+ * deadlock when the backend is IndexedDB, because `transactionAsync` is not designed to support reentrancy.
19
+ *
20
+ */
13
21
  async setHeader(header: BlockHeader): Promise<void> {
14
22
  await this.#synchronizedHeader.set(header.toBuffer());
15
23
  }
@@ -57,14 +57,14 @@ export class CapsuleStore implements StagedStore {
57
57
  */
58
58
  async #getFromStage(jobId: string, dbSlotKey: string): Promise<Buffer | null | undefined> {
59
59
  const jobStagedCapsules = this.#getJobStagedCapsules(jobId);
60
- let staged: Buffer | null | undefined = jobStagedCapsules.get(dbSlotKey);
61
- // Note that if staged === null, we marked it for deletion, so we don't want to
62
- // re-read it from DB
63
- if (staged === undefined) {
64
- // If we don't have a staged version of this dbSlotKey, first we check if there's one in DB
65
- staged = await this.#loadCapsuleFromDb(dbSlotKey);
66
- }
67
- return staged;
60
+ const staged: Buffer | null | undefined = jobStagedCapsules.get(dbSlotKey);
61
+
62
+ // Always issue DB read to keep IndexedDB transaction alive, even if the value is in the job staged data. This
63
+ // keeps IndexedDB transactions alive (they auto-commit when a new micro-task starts and there are no pending read
64
+ // requests). The staged value still takes precedence if it exists (including null for deletions).
65
+ const dbValue = await this.#loadCapsuleFromDb(dbSlotKey);
66
+
67
+ return staged !== undefined ? staged : dbValue;
68
68
  }
69
69
 
70
70
  /**