@aztec/pxe 0.0.1-commit.b468ad8 → 0.0.1-commit.b64cb54f6

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 (200) 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/index.d.ts +2 -2
  8. package/dest/config/index.d.ts.map +1 -1
  9. package/dest/config/index.js +1 -1
  10. package/dest/config/package_info.js +1 -1
  11. package/dest/contract_function_simulator/contract_function_simulator.d.ts +57 -28
  12. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/contract_function_simulator.js +181 -71
  14. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
  15. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
  17. package/dest/contract_function_simulator/index.d.ts +2 -1
  18. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/index.js +1 -0
  20. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +2 -3
  21. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +5 -4
  23. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +1 -1
  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 +1 -3
  26. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts +16 -0
  27. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts.map +1 -0
  28. package/dest/contract_function_simulator/noir-structs/message_tx_context.js +57 -0
  29. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -4
  30. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  31. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +3 -5
  32. package/dest/contract_function_simulator/oracle/interfaces.d.ts +49 -45
  33. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  34. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
  35. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
  36. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +52 -0
  37. package/dest/contract_function_simulator/oracle/oracle.d.ts +44 -44
  38. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  39. package/dest/contract_function_simulator/oracle/oracle.js +160 -100
  40. package/dest/contract_function_simulator/oracle/private_execution.js +3 -3
  41. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +58 -71
  42. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  43. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +103 -76
  44. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +70 -44
  45. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  46. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +136 -83
  47. package/dest/contract_logging.d.ts +22 -0
  48. package/dest/contract_logging.d.ts.map +1 -0
  49. package/dest/contract_logging.js +23 -0
  50. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  51. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  52. package/dest/contract_sync/contract_sync_service.js +97 -0
  53. package/dest/contract_sync/helpers.d.ts +29 -0
  54. package/dest/contract_sync/helpers.d.ts.map +1 -0
  55. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  56. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  57. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  58. package/dest/debug/pxe_debug_utils.js +16 -15
  59. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  60. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  61. package/dest/entrypoints/client/bundle/index.js +3 -0
  62. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  63. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  64. package/dest/entrypoints/client/bundle/utils.js +9 -1
  65. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  66. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  67. package/dest/entrypoints/client/lazy/index.js +3 -0
  68. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  69. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  70. package/dest/entrypoints/client/lazy/utils.js +9 -1
  71. package/dest/entrypoints/server/index.d.ts +4 -2
  72. package/dest/entrypoints/server/index.d.ts.map +1 -1
  73. package/dest/entrypoints/server/index.js +3 -1
  74. package/dest/entrypoints/server/utils.js +9 -1
  75. package/dest/logs/log_service.d.ts +3 -2
  76. package/dest/logs/log_service.d.ts.map +1 -1
  77. package/dest/logs/log_service.js +11 -18
  78. package/dest/messages/message_context_service.d.ts +17 -0
  79. package/dest/messages/message_context_service.d.ts.map +1 -0
  80. package/dest/messages/message_context_service.js +36 -0
  81. package/dest/notes/note_service.d.ts +4 -3
  82. package/dest/notes/note_service.d.ts.map +1 -1
  83. package/dest/notes/note_service.js +3 -2
  84. package/dest/notes_filter.d.ts +25 -0
  85. package/dest/notes_filter.d.ts.map +1 -0
  86. package/dest/notes_filter.js +4 -0
  87. package/dest/oracle_version.d.ts +2 -2
  88. package/dest/oracle_version.js +3 -3
  89. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  90. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  91. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  92. package/dest/private_kernel/hints/index.d.ts +1 -1
  93. package/dest/private_kernel/hints/index.js +1 -1
  94. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  95. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  96. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  97. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  98. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  99. package/dest/private_kernel/hints/test_utils.js +203 -0
  100. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  101. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  102. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  103. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  104. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  105. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  106. package/dest/pxe.d.ts +72 -24
  107. package/dest/pxe.d.ts.map +1 -1
  108. package/dest/pxe.js +111 -70
  109. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  110. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  111. package/dest/storage/contract_store/contract_store.js +145 -69
  112. package/dest/storage/metadata.d.ts +1 -1
  113. package/dest/storage/metadata.js +1 -1
  114. package/dest/storage/note_store/note_store.d.ts +3 -3
  115. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  116. package/dest/storage/note_store/note_store.js +6 -4
  117. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  118. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  119. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  120. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  121. package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
  122. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  123. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  124. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  125. package/dest/tagging/index.d.ts +3 -3
  126. package/dest/tagging/index.d.ts.map +1 -1
  127. package/dest/tagging/index.js +1 -1
  128. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  129. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  130. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  131. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  132. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  133. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  134. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  135. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  136. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  137. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
  138. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
  139. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  140. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
  141. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  142. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  143. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
  144. package/package.json +25 -16
  145. package/src/access_scopes.ts +9 -0
  146. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  147. package/src/config/index.ts +1 -1
  148. package/src/config/package_info.ts +1 -1
  149. package/src/contract_function_simulator/contract_function_simulator.ts +332 -131
  150. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
  151. package/src/contract_function_simulator/index.ts +1 -0
  152. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +8 -5
  153. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +1 -4
  154. package/src/contract_function_simulator/noir-structs/message_tx_context.ts +55 -0
  155. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +3 -6
  156. package/src/contract_function_simulator/oracle/interfaces.ts +53 -54
  157. package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +77 -0
  158. package/src/contract_function_simulator/oracle/oracle.ts +164 -140
  159. package/src/contract_function_simulator/oracle/private_execution.ts +3 -3
  160. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +130 -167
  161. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +211 -91
  162. package/src/contract_logging.ts +39 -0
  163. package/src/contract_sync/contract_sync_service.ts +152 -0
  164. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  165. package/src/debug/pxe_debug_utils.ts +48 -18
  166. package/src/entrypoints/client/bundle/index.ts +3 -0
  167. package/src/entrypoints/client/bundle/utils.ts +9 -1
  168. package/src/entrypoints/client/lazy/index.ts +3 -0
  169. package/src/entrypoints/client/lazy/utils.ts +9 -1
  170. package/src/entrypoints/server/index.ts +3 -1
  171. package/src/entrypoints/server/utils.ts +7 -7
  172. package/src/logs/log_service.ts +18 -25
  173. package/src/messages/message_context_service.ts +45 -0
  174. package/src/notes/note_service.ts +4 -3
  175. package/src/notes_filter.ts +26 -0
  176. package/src/oracle_version.ts +3 -3
  177. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  178. package/src/private_kernel/hints/index.ts +1 -1
  179. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  180. package/src/private_kernel/hints/test_utils.ts +325 -0
  181. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  182. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  183. package/src/pxe.ts +196 -119
  184. package/src/storage/contract_store/contract_store.ts +174 -75
  185. package/src/storage/metadata.ts +1 -1
  186. package/src/storage/note_store/note_store.ts +12 -5
  187. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  188. package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
  189. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  190. package/src/tagging/index.ts +2 -2
  191. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  192. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  193. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  194. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
  195. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
  196. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
  197. package/dest/contract_sync/index.d.ts +0 -23
  198. package/dest/contract_sync/index.d.ts.map +0 -1
  199. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  200. 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,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,56 @@ 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: 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
+ /** State overrides for the simulation, such as contract instances and artifacts. */
111
+ overrides?: SimulationOverrides;
112
+ /** Addresses whose private state and keys are accessible during private execution */
113
+ scopes: AccessScopes;
114
+ };
115
+
116
+ /** Options for PXE.executeUtility. */
117
+ export type ExecuteUtilityOpts = {
118
+ /** The authentication witnesses required for the function call. */
119
+ authwits?: AuthWitness[];
120
+ /** The accounts whose notes we can access in this call */
121
+ scopes: AccessScopes;
122
+ };
123
+
124
+ /** Args for PXE.create. */
125
+ export type PXECreateArgs = {
126
+ /** The Aztec node to connect to. */
127
+ node: AztecNode;
128
+ /** The key-value store for persisting PXE state. */
129
+ store: AztecAsyncKVStore;
130
+ /** The prover for generating private kernel proofs. */
131
+ proofCreator: PrivateKernelProver;
132
+ /** The circuit simulator for executing ACIR circuits. */
133
+ simulator: CircuitSimulator;
134
+ /** Provider for protocol contract artifacts and instances. */
135
+ protocolContractsProvider: ProtocolContractsProvider;
136
+ /** PXE configuration options. */
137
+ config: PXEConfig;
138
+ /** Optional logger instance or string suffix for the logger name. */
139
+ loggerOrSuffix?: string | Logger;
140
+ };
141
+
87
142
  /**
88
143
  * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
89
144
  * manage private state of users.
@@ -91,6 +146,7 @@ export type PackedPrivateEvent = InTx & {
91
146
  export class PXE {
92
147
  private constructor(
93
148
  private node: AztecNode,
149
+ private db: AztecAsyncKVStore,
94
150
  private blockStateSynchronizer: BlockSynchronizer,
95
151
  private keyStore: KeyStore,
96
152
  private contractStore: ContractStore,
@@ -102,6 +158,8 @@ export class PXE {
102
158
  private recipientTaggingStore: RecipientTaggingStore,
103
159
  private addressStore: AddressStore,
104
160
  private privateEventStore: PrivateEventStore,
161
+ private contractSyncService: ContractSyncService,
162
+ private messageContextService: MessageContextService,
105
163
  private simulator: CircuitSimulator,
106
164
  private proverEnabled: boolean,
107
165
  private proofCreator: PrivateKernelProver,
@@ -119,15 +177,15 @@ export class PXE {
119
177
  *
120
178
  * @returns A promise that resolves PXE is ready to be used.
121
179
  */
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
- ) {
180
+ public static async create({
181
+ node,
182
+ store,
183
+ proofCreator,
184
+ simulator,
185
+ protocolContractsProvider,
186
+ config,
187
+ loggerOrSuffix,
188
+ }: PXECreateArgs) {
131
189
  // Extract bindings from the logger, or use empty bindings if a string suffix is provided.
132
190
  const bindings: LoggerBindings | undefined =
133
191
  loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
@@ -137,7 +195,9 @@ export class PXE {
137
195
  ? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
138
196
  : loggerOrSuffix;
139
197
 
140
- const proverEnabled = !!config.proverEnabled;
198
+ const info = await node.getNodeInfo();
199
+
200
+ const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
141
201
  const addressStore = new AddressStore(store);
142
202
  const privateEventStore = new PrivateEventStore(store);
143
203
  const contractStore = new ContractStore(store);
@@ -149,6 +209,14 @@ export class PXE {
149
209
  const capsuleStore = new CapsuleStore(store);
150
210
  const keyStore = new KeyStore(store);
151
211
  const tipsStore = new L2TipsKVStore(store, 'pxe');
212
+ const contractSyncService = new ContractSyncService(
213
+ node,
214
+ contractStore,
215
+ noteStore,
216
+ createLogger('pxe:contract_sync', bindings),
217
+ );
218
+ const messageContextService = new MessageContextService(node);
219
+
152
220
  const synchronizer = new BlockSynchronizer(
153
221
  node,
154
222
  store,
@@ -156,6 +224,7 @@ export class PXE {
156
224
  noteStore,
157
225
  privateEventStore,
158
226
  tipsStore,
227
+ contractSyncService,
159
228
  config,
160
229
  bindings,
161
230
  );
@@ -167,14 +236,16 @@ export class PXE {
167
236
  recipientTaggingStore,
168
237
  privateEventStore,
169
238
  noteStore,
239
+ contractSyncService,
170
240
  ]);
171
241
 
172
- const debugUtils = new PXEDebugUtils(contractStore, noteStore, synchronizer, anchorBlockStore);
242
+ const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
173
243
 
174
244
  const jobQueue = new SerialQueue();
175
245
 
176
246
  const pxe = new PXE(
177
247
  node,
248
+ store,
178
249
  synchronizer,
179
250
  keyStore,
180
251
  contractStore,
@@ -186,6 +257,8 @@ export class PXE {
186
257
  recipientTaggingStore,
187
258
  addressStore,
188
259
  privateEventStore,
260
+ contractSyncService,
261
+ messageContextService,
189
262
  simulator,
190
263
  proverEnabled,
191
264
  proofCreator,
@@ -196,12 +269,15 @@ export class PXE {
196
269
  debugUtils,
197
270
  );
198
271
 
199
- debugUtils.setPXE(pxe, pxe.#putInJobQueue.bind(pxe));
272
+ debugUtils.setPXEHelpers(
273
+ pxe.#putInJobQueue.bind(pxe),
274
+ pxe.#getSimulatorForTx.bind(pxe),
275
+ pxe.#executeUtility.bind(pxe),
276
+ );
200
277
 
201
278
  pxe.jobQueue.start();
202
279
 
203
280
  await pxe.#registerProtocolContracts();
204
- const info = await node.getNodeInfo();
205
281
  log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
206
282
  return pxe;
207
283
  }
@@ -211,19 +287,21 @@ export class PXE {
211
287
  #getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
212
288
  const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
213
289
 
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
- );
290
+ return new ContractFunctionSimulator({
291
+ contractStore: proxyContractStore,
292
+ noteStore: this.noteStore,
293
+ keyStore: this.keyStore,
294
+ addressStore: this.addressStore,
295
+ aztecNode: BenchmarkedNodeFactory.create(this.node),
296
+ senderTaggingStore: this.senderTaggingStore,
297
+ recipientTaggingStore: this.recipientTaggingStore,
298
+ senderAddressBookStore: this.senderAddressBookStore,
299
+ capsuleStore: this.capsuleStore,
300
+ privateEventStore: this.privateEventStore,
301
+ simulator: this.simulator,
302
+ contractSyncService: this.contractSyncService,
303
+ messageContextService: this.messageContextService,
304
+ });
227
305
  }
228
306
 
229
307
  #contextualizeError(err: Error, ...context: string[]): Error {
@@ -275,9 +353,8 @@ export class PXE {
275
353
  async #registerProtocolContracts() {
276
354
  const registered: Record<string, string> = {};
277
355
  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);
356
+ const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
357
+ await this.contractStore.addContractArtifact(artifact);
281
358
  await this.contractStore.addContractInstance(instance);
282
359
  registered[name] = address.toString();
283
360
  }
@@ -289,7 +366,7 @@ export class PXE {
289
366
  async #executePrivate(
290
367
  contractFunctionSimulator: ContractFunctionSimulator,
291
368
  txRequest: TxExecutionRequest,
292
- scopes: AztecAddress[] | undefined,
369
+ scopes: AccessScopes,
293
370
  jobId: string,
294
371
  ): Promise<PrivateExecutionResult> {
295
372
  const { origin: contractAddress, functionSelector } = txRequest;
@@ -297,27 +374,23 @@ export class PXE {
297
374
  try {
298
375
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
299
376
 
300
- await ensureContractSynced(
377
+ await this.contractSyncService.ensureContractSynced(
301
378
  contractAddress,
302
379
  functionSelector,
303
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
304
- this.node,
305
- this.contractStore,
380
+ (privateSyncCall, execScopes) =>
381
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
306
382
  anchorBlockHeader,
383
+ jobId,
384
+ scopes,
307
385
  );
308
386
 
309
- const result = await contractFunctionSimulator.run(
310
- txRequest,
387
+ const result = await contractFunctionSimulator.run(txRequest, {
311
388
  contractAddress,
312
- functionSelector,
313
- undefined,
389
+ selector: functionSelector,
314
390
  anchorBlockHeader,
315
- // The sender for tags is set by contracts, typically by an account
316
- // contract entrypoint
317
- undefined, // senderForTags
318
391
  scopes,
319
392
  jobId,
320
- );
393
+ });
321
394
  this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
322
395
  return result;
323
396
  } catch (err) {
@@ -329,20 +402,20 @@ export class PXE {
329
402
  }
330
403
 
331
404
  /**
332
- * Simulate a utility function call on the given contract.
405
+ * Execute a utility function call on the given contract.
333
406
  * @param contractFunctionSimulator - The simulator to use for the function call.
334
407
  * @param call - The function call to execute.
335
408
  * @param authWitnesses - Authentication witnesses required for the function call.
336
409
  * @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
337
410
  * accounts if not specified.
338
411
  * @param jobId - The job ID for staged writes.
339
- * @returns The simulation result containing the outputs of the utility function.
412
+ * @returns The execution result containing the outputs of the utility function.
340
413
  */
341
- async #simulateUtility(
414
+ async #executeUtility(
342
415
  contractFunctionSimulator: ContractFunctionSimulator,
343
416
  call: FunctionCall,
344
417
  authWitnesses: AuthWitness[] | undefined,
345
- scopes: AztecAddress[] | undefined,
418
+ scopes: AccessScopes,
346
419
  jobId: string,
347
420
  ) {
348
421
  try {
@@ -415,6 +488,19 @@ export class PXE {
415
488
 
416
489
  // Public API
417
490
 
491
+ /**
492
+ * Returns the block header up to which the PXE has synced.
493
+ * @returns The synced block header
494
+ */
495
+ public getSyncedBlockHeader(): Promise<BlockHeader> {
496
+ return this.anchorBlockStore.getBlockHeader();
497
+ }
498
+
499
+ /**
500
+ * Returns the contract instance for a given address, if it's registered in the PXE.
501
+ * @param address - The contract address.
502
+ * @returns The contract instance if found, undefined otherwise.
503
+ */
418
504
  public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
419
505
  return this.contractStore.getContractInstance(address);
420
506
  }
@@ -523,8 +609,7 @@ export class PXE {
523
609
  * @param artifact - The build artifact for the contract class.
524
610
  */
525
611
  public async registerContractClass(artifact: ContractArtifact): Promise<void> {
526
- const { id: contractClassId } = await getContractClassFromArtifact(artifact);
527
- await this.contractStore.addContractArtifact(contractClassId, artifact);
612
+ const contractClassId = await this.contractStore.addContractArtifact(artifact);
528
613
  this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
529
614
  }
530
615
 
@@ -543,17 +628,17 @@ export class PXE {
543
628
  if (artifact) {
544
629
  // If the user provides an artifact, validate it against the expected class id and register it
545
630
  const contractClass = await getContractClassFromArtifact(artifact);
546
- const contractClassId = contractClass.id;
547
- if (!contractClassId.equals(instance.currentContractClassId)) {
631
+ if (!contractClass.id.equals(instance.currentContractClassId)) {
548
632
  throw new Error(
549
- `Artifact does not match expected class id (computed ${contractClassId} but instance refers to ${instance.currentContractClassId})`,
633
+ `Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
550
634
  );
551
635
  }
552
636
  const computedAddress = await computeContractAddressFromInstance(instance);
553
637
  if (!computedAddress.equals(instance.address)) {
554
638
  throw new Error('Added a contract in which the address does not match the contract instance.');
555
639
  }
556
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
640
+
641
+ await this.contractStore.addContractArtifact(artifact, contractClass);
557
642
 
558
643
  const publicFunctionSignatures = artifact.functions
559
644
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
@@ -602,15 +687,16 @@ export class PXE {
602
687
  throw new Error('Could not update contract to a class different from the current one.');
603
688
  }
604
689
 
605
- await this.contractStore.addContractArtifact(contractClass.id, artifact);
606
-
607
690
  const publicFunctionSignatures = artifact.functions
608
691
  .filter(fn => fn.functionType === FunctionType.PUBLIC)
609
692
  .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
610
693
  await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
611
694
 
612
695
  currentInstance.currentContractClassId = contractClass.id;
613
- await this.contractStore.addContractInstance(currentInstance);
696
+ await Promise.all([
697
+ this.contractStore.addContractArtifact(artifact, contractClass),
698
+ this.contractStore.addContractInstance(currentInstance),
699
+ ]);
614
700
  this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
615
701
  });
616
702
  }
@@ -628,11 +714,12 @@ export class PXE {
628
714
  * (where validators prove the public portion).
629
715
  *
630
716
  * @param txRequest - An authenticated tx request ready for proving
717
+ * @param scopes - Addresses whose private state and keys are accessible during private execution.
631
718
  * @returns A result containing the proof and public inputs of the tail circuit.
632
719
  * @throws If contract code not found, or public simulation reverts.
633
720
  * Also throws if simulatePublic is true and public simulation reverts.
634
721
  */
635
- public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
722
+ public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
636
723
  let privateExecutionResult: PrivateExecutionResult;
637
724
  // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
638
725
  // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
@@ -643,7 +730,7 @@ export class PXE {
643
730
  await this.blockStateSynchronizer.sync();
644
731
  const syncTime = syncTimer.ms();
645
732
  const contractFunctionSimulator = this.#getSimulatorForTx();
646
- privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, undefined, jobId);
733
+ privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
647
734
 
648
735
  const {
649
736
  publicInputs,
@@ -685,17 +772,17 @@ export class PXE {
685
772
  // transaction before this one is included in a block from this PXE, and that transaction contains a log with
686
773
  // a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
687
774
  // storing the tags here prevents linkage of txs sent from the same PXE.
688
- const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
689
- if (preTagsUsedInTheTx.length > 0) {
775
+ const taggingIndexRangesUsedInTheTx = privateExecutionResult.entrypoint.taggingIndexRanges;
776
+ if (taggingIndexRangesUsedInTheTx.length > 0) {
690
777
  // TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
691
778
  const txHash = (await txProvingResult.toTx()).txHash;
692
779
 
693
- await this.senderTaggingStore.storePendingIndexes(preTagsUsedInTheTx, txHash, jobId);
694
- this.log.debug(`Stored used pre-tags as sender for the tx`, {
695
- preTagsUsedInTheTx,
780
+ await this.senderTaggingStore.storePendingIndexes(taggingIndexRangesUsedInTheTx, txHash, jobId);
781
+ this.log.debug(`Stored used tagging index ranges as sender for the tx`, {
782
+ taggingIndexRangesUsedInTheTx,
696
783
  });
697
784
  } else {
698
- this.log.debug(`No pre-tags used in the tx`);
785
+ this.log.debug(`No tagging index ranges used in the tx`);
699
786
  }
700
787
 
701
788
  return txProvingResult;
@@ -707,17 +794,13 @@ export class PXE {
707
794
 
708
795
  /**
709
796
  * Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
710
- *
711
- * @param txRequest - An authenticated tx request ready for simulation
712
- * @param msgSender - (Optional) The message sender to use for the simulation.
713
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
797
+ * @param txRequest - An authenticated tx request ready for simulation.
714
798
  * @returns A trace of the program execution with gate counts.
715
799
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
716
800
  */
717
801
  public profileTx(
718
802
  txRequest: TxExecutionRequest,
719
- profileMode: 'full' | 'execution-steps' | 'gates',
720
- skipProofGeneration: boolean = true,
803
+ { profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
721
804
  ): Promise<TxProfileResult> {
722
805
  // We disable concurrent profiles for consistency with simulateTx.
723
806
  return this.#putInJobQueue(async jobId => {
@@ -740,12 +823,7 @@ export class PXE {
740
823
  const syncTime = syncTimer.ms();
741
824
 
742
825
  const contractFunctionSimulator = this.#getSimulatorForTx();
743
- const privateExecutionResult = await this.#executePrivate(
744
- contractFunctionSimulator,
745
- txRequest,
746
- undefined,
747
- jobId,
748
- );
826
+ const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
749
827
 
750
828
  const { executionSteps, timings: { proving } = {} } = await this.#prove(
751
829
  txRequest,
@@ -802,12 +880,7 @@ export class PXE {
802
880
  * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
803
881
  *
804
882
  *
805
- * @param txRequest - An authenticated tx request ready for simulation
806
- * @param simulatePublic - Whether to simulate the public part of the transaction.
807
- * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
808
- * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
809
- * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
810
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
883
+ * @param txRequest - An authenticated tx request ready for simulation.
811
884
  * @returns A simulated transaction result object that includes public and private return values.
812
885
  * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
813
886
  * Also throws if simulatePublic is true and public simulation reverts.
@@ -816,11 +889,7 @@ export class PXE {
816
889
  */
817
890
  public simulateTx(
818
891
  txRequest: TxExecutionRequest,
819
- simulatePublic: boolean,
820
- skipTxValidation: boolean = false,
821
- skipFeeEnforcement: boolean = false,
822
- overrides?: SimulationOverrides,
823
- scopes?: AztecAddress[],
892
+ { simulatePublic, skipTxValidation = false, skipFeeEnforcement = false, overrides, scopes }: SimulateTxOpts,
824
893
  ): Promise<TxSimulationResult> {
825
894
  // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
826
895
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
@@ -848,7 +917,14 @@ export class PXE {
848
917
  // Temporary: in case there are overrides, we have to skip the kernels or validations
849
918
  // will fail. Consider handing control to the user/wallet on whether they want to run them
850
919
  // or not.
851
- const skipKernels = overrides?.contracts !== undefined && Object.keys(overrides.contracts ?? {}).length > 0;
920
+ const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
921
+ const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
922
+ const skipKernels = hasOverriddenContracts;
923
+
924
+ // Set overridden contracts on the sync service so it knows to skip syncing them
925
+ if (hasOverriddenContracts) {
926
+ this.contractSyncService.setOverriddenContracts(jobId, overriddenContracts);
927
+ }
852
928
 
853
929
  // Execution of private functions only; no proving, and no kernel logic.
854
930
  const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
@@ -859,7 +935,8 @@ export class PXE {
859
935
  if (skipKernels) {
860
936
  ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
861
937
  privateExecutionResult,
862
- this.contractStore,
938
+ (addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
939
+ this.node,
863
940
  ));
864
941
  } else {
865
942
  // Kernel logic, plus proving of all private functions and kernels.
@@ -878,6 +955,9 @@ export class PXE {
878
955
  const publicSimulationTimer = new Timer();
879
956
  publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
880
957
  publicSimulationTime = publicSimulationTimer.ms();
958
+ if (publicOutput?.debugLogs?.length) {
959
+ await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
960
+ }
881
961
  }
882
962
 
883
963
  let validationTime: number | undefined;
@@ -886,7 +966,8 @@ export class PXE {
886
966
  const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
887
967
  validationTime = validationTimer.ms();
888
968
  if (validationResult.result === 'invalid') {
889
- throw new Error('The simulated transaction is unable to be added to state and is invalid.');
969
+ const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
970
+ throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
890
971
  }
891
972
  }
892
973
 
@@ -937,29 +1018,23 @@ export class PXE {
937
1018
  inspect(txRequest),
938
1019
  `simulatePublic=${simulatePublic}`,
939
1020
  `skipTxValidation=${skipTxValidation}`,
940
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1021
+ `scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
941
1022
  );
942
1023
  }
943
1024
  });
944
1025
  }
945
1026
 
946
1027
  /**
947
- * Simulate the execution of a contract utility function.
948
- *
1028
+ * Executes a contract utility function.
949
1029
  * @param call - The function call containing the function details, arguments, and target contract address.
950
- * @param authwits - (Optional) The authentication witnesses required for the function call.
951
- * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
952
- * default to all.
953
- * @returns The result of the utility function call, structured based on the function ABI.
954
1030
  */
955
- public simulateUtility(
1031
+ public executeUtility(
956
1032
  call: FunctionCall,
957
- authwits?: AuthWitness[],
958
- scopes?: AztecAddress[],
959
- ): Promise<UtilitySimulationResult> {
960
- // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
1033
+ { authwits, scopes }: ExecuteUtilityOpts = { scopes: 'ALL_SCOPES' },
1034
+ ): Promise<UtilityExecutionResult> {
1035
+ // We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
961
1036
  // to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
962
- // delete the same read value, or reading values that another simulation is currently modifying).
1037
+ // delete the same read value, or reading values that another execution is currently modifying).
963
1038
  return this.#putInJobQueue(async jobId => {
964
1039
  try {
965
1040
  const totalTimer = new Timer();
@@ -970,16 +1045,17 @@ export class PXE {
970
1045
  const contractFunctionSimulator = this.#getSimulatorForTx();
971
1046
 
972
1047
  const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
973
- await ensureContractSynced(
1048
+ await this.contractSyncService.ensureContractSynced(
974
1049
  call.to,
975
1050
  call.selector,
976
- privateSyncCall => this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
977
- this.node,
978
- this.contractStore,
1051
+ (privateSyncCall, execScopes) =>
1052
+ this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
979
1053
  anchorBlockHeader,
1054
+ jobId,
1055
+ scopes,
980
1056
  );
981
1057
 
982
- const executionResult = await this.#simulateUtility(
1058
+ const executionResult = await this.#executeUtility(
983
1059
  contractFunctionSimulator,
984
1060
  call,
985
1061
  authwits ?? [],
@@ -1006,8 +1082,8 @@ export class PXE {
1006
1082
  const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
1007
1083
  throw this.#contextualizeError(
1008
1084
  err,
1009
- `simulateUtility ${to}:${name}(${stringifiedArgs})`,
1010
- `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
1085
+ `executeUtility ${to}:${name}(${stringifiedArgs})`,
1086
+ `scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
1011
1087
  );
1012
1088
  }
1013
1089
  });
@@ -1040,14 +1116,14 @@ export class PXE {
1040
1116
 
1041
1117
  const contractFunctionSimulator = this.#getSimulatorForTx();
1042
1118
 
1043
- await ensureContractSynced(
1119
+ await this.contractSyncService.ensureContractSynced(
1044
1120
  filter.contractAddress,
1045
1121
  null,
1046
- async privateSyncCall =>
1047
- await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], undefined, jobId),
1048
- this.node,
1049
- this.contractStore,
1122
+ async (privateSyncCall, execScopes) =>
1123
+ await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
1050
1124
  anchorBlockHeader,
1125
+ jobId,
1126
+ filter.scopes,
1051
1127
  );
1052
1128
  });
1053
1129
 
@@ -1062,9 +1138,10 @@ export class PXE {
1062
1138
  }
1063
1139
 
1064
1140
  /**
1065
- * Stops the PXE's job queue.
1141
+ * Stops the PXE's job queue and closes the backing store.
1066
1142
  */
1067
- public stop(): Promise<void> {
1068
- return this.jobQueue.end();
1143
+ public async stop(): Promise<void> {
1144
+ await this.jobQueue.end();
1145
+ await this.db.close();
1069
1146
  }
1070
1147
  }