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

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 (154) 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/contract_function_simulator/contract_function_simulator.d.ts +54 -30
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  9. package/dest/contract_function_simulator/contract_function_simulator.js +170 -66
  10. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  11. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -2
  12. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  14. package/dest/contract_function_simulator/oracle/interfaces.d.ts +9 -9
  15. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/oracle/oracle.d.ts +5 -5
  17. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  18. package/dest/contract_function_simulator/oracle/oracle.js +32 -20
  19. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +36 -36
  20. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  21. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +74 -21
  22. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +48 -24
  23. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  24. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +85 -61
  25. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  26. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  27. package/dest/contract_sync/contract_sync_service.js +97 -0
  28. package/dest/contract_sync/helpers.d.ts +29 -0
  29. package/dest/contract_sync/helpers.d.ts.map +1 -0
  30. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  31. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  32. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  33. package/dest/debug/pxe_debug_utils.js +16 -15
  34. package/dest/entrypoints/client/bundle/index.d.ts +3 -1
  35. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  36. package/dest/entrypoints/client/bundle/index.js +2 -0
  37. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  38. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  39. package/dest/entrypoints/client/bundle/utils.js +11 -2
  40. package/dest/entrypoints/client/lazy/index.d.ts +3 -1
  41. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  42. package/dest/entrypoints/client/lazy/index.js +2 -0
  43. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  44. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  45. package/dest/entrypoints/client/lazy/utils.js +11 -2
  46. package/dest/entrypoints/server/index.d.ts +4 -2
  47. package/dest/entrypoints/server/index.d.ts.map +1 -1
  48. package/dest/entrypoints/server/index.js +3 -1
  49. package/dest/entrypoints/server/utils.js +9 -1
  50. package/dest/events/event_service.d.ts +4 -5
  51. package/dest/events/event_service.d.ts.map +1 -1
  52. package/dest/events/event_service.js +5 -6
  53. package/dest/logs/log_service.d.ts +6 -5
  54. package/dest/logs/log_service.d.ts.map +1 -1
  55. package/dest/logs/log_service.js +14 -24
  56. package/dest/notes/note_service.d.ts +7 -7
  57. package/dest/notes/note_service.d.ts.map +1 -1
  58. package/dest/notes/note_service.js +9 -9
  59. package/dest/notes_filter.d.ts +25 -0
  60. package/dest/notes_filter.d.ts.map +1 -0
  61. package/dest/notes_filter.js +4 -0
  62. package/dest/oracle_version.d.ts +3 -3
  63. package/dest/oracle_version.d.ts.map +1 -1
  64. package/dest/oracle_version.js +2 -2
  65. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  66. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  67. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  68. package/dest/private_kernel/hints/index.d.ts +1 -1
  69. package/dest/private_kernel/hints/index.js +1 -1
  70. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +4 -4
  71. package/dest/private_kernel/private_kernel_execution_prover.js +6 -6
  72. package/dest/pxe.d.ts +69 -23
  73. package/dest/pxe.d.ts.map +1 -1
  74. package/dest/pxe.js +72 -44
  75. package/dest/storage/address_store/address_store.d.ts +1 -1
  76. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  77. package/dest/storage/address_store/address_store.js +12 -11
  78. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
  79. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  80. package/dest/storage/anchor_block_store/anchor_block_store.js +8 -1
  81. package/dest/storage/capsule_store/capsule_store.js +6 -8
  82. package/dest/storage/contract_store/contract_store.d.ts +1 -1
  83. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  84. package/dest/storage/contract_store/contract_store.js +27 -18
  85. package/dest/storage/metadata.d.ts +1 -1
  86. package/dest/storage/metadata.js +1 -1
  87. package/dest/storage/note_store/note_store.d.ts +13 -3
  88. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  89. package/dest/storage/note_store/note_store.js +147 -107
  90. package/dest/storage/private_event_store/private_event_store.d.ts +1 -1
  91. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  92. package/dest/storage/private_event_store/private_event_store.js +84 -61
  93. package/dest/storage/private_event_store/stored_private_event.js +1 -1
  94. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +1 -1
  95. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  96. package/dest/storage/tagging_store/recipient_tagging_store.js +31 -19
  97. package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
  98. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
  99. package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
  100. package/dest/storage/tagging_store/sender_tagging_store.d.ts +1 -1
  101. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  102. package/dest/storage/tagging_store/sender_tagging_store.js +183 -113
  103. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  104. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  105. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  106. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +4 -4
  107. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  108. package/package.json +25 -16
  109. package/src/access_scopes.ts +9 -0
  110. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  111. package/src/contract_function_simulator/contract_function_simulator.ts +318 -121
  112. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  113. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  114. package/src/contract_function_simulator/oracle/interfaces.ts +10 -10
  115. package/src/contract_function_simulator/oracle/oracle.ts +35 -18
  116. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +97 -101
  117. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +129 -63
  118. package/src/contract_sync/contract_sync_service.ts +152 -0
  119. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  120. package/src/debug/pxe_debug_utils.ts +48 -18
  121. package/src/entrypoints/client/bundle/index.ts +2 -0
  122. package/src/entrypoints/client/bundle/utils.ts +12 -2
  123. package/src/entrypoints/client/lazy/index.ts +2 -0
  124. package/src/entrypoints/client/lazy/utils.ts +12 -2
  125. package/src/entrypoints/server/index.ts +3 -1
  126. package/src/entrypoints/server/utils.ts +7 -7
  127. package/src/events/event_service.ts +4 -6
  128. package/src/logs/log_service.ts +14 -29
  129. package/src/notes/note_service.ts +9 -10
  130. package/src/notes_filter.ts +26 -0
  131. package/src/oracle_version.ts +2 -2
  132. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  133. package/src/private_kernel/hints/index.ts +1 -1
  134. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +7 -7
  135. package/src/private_kernel/private_kernel_execution_prover.ts +6 -6
  136. package/src/pxe.ts +151 -88
  137. package/src/storage/address_store/address_store.ts +15 -15
  138. package/src/storage/anchor_block_store/anchor_block_store.ts +8 -0
  139. package/src/storage/capsule_store/capsule_store.ts +8 -8
  140. package/src/storage/contract_store/contract_store.ts +26 -15
  141. package/src/storage/metadata.ts +1 -1
  142. package/src/storage/note_store/note_store.ts +169 -132
  143. package/src/storage/private_event_store/private_event_store.ts +102 -81
  144. package/src/storage/private_event_store/stored_private_event.ts +1 -1
  145. package/src/storage/tagging_store/recipient_tagging_store.ts +31 -21
  146. package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
  147. package/src/storage/tagging_store/sender_tagging_store.ts +210 -126
  148. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  149. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +4 -4
  150. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  151. package/dest/contract_sync/index.d.ts +0 -23
  152. package/dest/contract_sync/index.d.ts.map +0 -1
  153. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  154. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
@@ -3,7 +3,7 @@ import type { BlockNumber } from '@aztec/foundation/branded-types';
3
3
  import { Aes128 } from '@aztec/foundation/crypto/aes128';
4
4
  import { Fr } from '@aztec/foundation/curves/bn254';
5
5
  import { Point } from '@aztec/foundation/curves/grumpkin';
6
- import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundation/log';
6
+ import { LogLevels, type Logger, applyStringFormatting, createLogger } from '@aztec/foundation/log';
7
7
  import type { MembershipWitness } from '@aztec/foundation/trees';
8
8
  import type { KeyStore } from '@aztec/key-store';
9
9
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
@@ -20,12 +20,12 @@ import type { NoteStatus } from '@aztec/stdlib/note';
20
20
  import { MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
21
21
  import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
22
22
 
23
+ import type { AccessScopes } from '../../access_scopes.js';
23
24
  import { EventService } from '../../events/event_service.js';
24
25
  import { LogService } from '../../logs/log_service.js';
25
26
  import { NoteService } from '../../notes/note_service.js';
26
27
  import { ORACLE_VERSION } from '../../oracle_version.js';
27
28
  import type { AddressStore } from '../../storage/address_store/address_store.js';
28
- import type { AnchorBlockStore } from '../../storage/anchor_block_store/anchor_block_store.js';
29
29
  import type { CapsuleStore } from '../../storage/capsule_store/capsule_store.js';
30
30
  import type { ContractStore } from '../../storage/contract_store/contract_store.js';
31
31
  import type { NoteStore } from '../../storage/note_store/note_store.js';
@@ -41,6 +41,27 @@ import { pickNotes } from '../pick_notes.js';
41
41
  import type { IMiscOracle, IUtilityExecutionOracle, NoteData } from './interfaces.js';
42
42
  import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
43
43
 
44
+ /** Args for UtilityExecutionOracle constructor. */
45
+ export type UtilityExecutionOracleArgs = {
46
+ contractAddress: AztecAddress;
47
+ /** List of transient auth witnesses to be used during this simulation */
48
+ authWitnesses: AuthWitness[];
49
+ capsules: Capsule[]; // TODO(#12425): Rename to transientCapsules
50
+ anchorBlockHeader: BlockHeader;
51
+ contractStore: ContractStore;
52
+ noteStore: NoteStore;
53
+ keyStore: KeyStore;
54
+ addressStore: AddressStore;
55
+ aztecNode: AztecNode;
56
+ recipientTaggingStore: RecipientTaggingStore;
57
+ senderAddressBookStore: SenderAddressBookStore;
58
+ capsuleStore: CapsuleStore;
59
+ privateEventStore: PrivateEventStore;
60
+ jobId: string;
61
+ log?: ReturnType<typeof createLogger>;
62
+ scopes: AccessScopes;
63
+ };
64
+
44
65
  /**
45
66
  * The oracle for an execution of utility contract functions.
46
67
  */
@@ -48,28 +69,43 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
48
69
  isMisc = true as const;
49
70
  isUtility = true as const;
50
71
 
51
- private aztecNrDebugLog = createLogger('aztec-nr:debug_log');
52
-
53
- constructor(
54
- protected readonly contractAddress: AztecAddress,
55
- /** List of transient auth witnesses to be used during this simulation */
56
- protected readonly authWitnesses: AuthWitness[],
57
- protected readonly capsules: Capsule[], // TODO(#12425): Rename to transientCapsules
58
- protected readonly anchorBlockHeader: BlockHeader,
59
- protected readonly contractStore: ContractStore,
60
- protected readonly noteStore: NoteStore,
61
- protected readonly keyStore: KeyStore,
62
- protected readonly addressStore: AddressStore,
63
- protected readonly aztecNode: AztecNode,
64
- protected readonly anchorBlockStore: AnchorBlockStore,
65
- protected readonly recipientTaggingStore: RecipientTaggingStore,
66
- protected readonly senderAddressBookStore: SenderAddressBookStore,
67
- protected readonly capsuleStore: CapsuleStore,
68
- protected readonly privateEventStore: PrivateEventStore,
69
- protected readonly jobId: string,
70
- protected log = createLogger('simulator:client_view_context'),
71
- protected readonly scopes?: AztecAddress[],
72
- ) {}
72
+ private contractLogger: Logger | undefined;
73
+
74
+ protected readonly contractAddress: AztecAddress;
75
+ protected readonly authWitnesses: AuthWitness[];
76
+ protected readonly capsules: Capsule[];
77
+ protected readonly anchorBlockHeader: BlockHeader;
78
+ protected readonly contractStore: ContractStore;
79
+ protected readonly noteStore: NoteStore;
80
+ protected readonly keyStore: KeyStore;
81
+ protected readonly addressStore: AddressStore;
82
+ protected readonly aztecNode: AztecNode;
83
+ protected readonly recipientTaggingStore: RecipientTaggingStore;
84
+ protected readonly senderAddressBookStore: SenderAddressBookStore;
85
+ protected readonly capsuleStore: CapsuleStore;
86
+ protected readonly privateEventStore: PrivateEventStore;
87
+ protected readonly jobId: string;
88
+ protected log: ReturnType<typeof createLogger>;
89
+ protected readonly scopes: AccessScopes;
90
+
91
+ constructor(args: UtilityExecutionOracleArgs) {
92
+ this.contractAddress = args.contractAddress;
93
+ this.authWitnesses = args.authWitnesses;
94
+ this.capsules = args.capsules;
95
+ this.anchorBlockHeader = args.anchorBlockHeader;
96
+ this.contractStore = args.contractStore;
97
+ this.noteStore = args.noteStore;
98
+ this.keyStore = args.keyStore;
99
+ this.addressStore = args.addressStore;
100
+ this.aztecNode = args.aztecNode;
101
+ this.recipientTaggingStore = args.recipientTaggingStore;
102
+ this.senderAddressBookStore = args.senderAddressBookStore;
103
+ this.capsuleStore = args.capsuleStore;
104
+ this.privateEventStore = args.privateEventStore;
105
+ this.jobId = args.jobId;
106
+ this.log = args.log ?? createLogger('simulator:client_view_context');
107
+ this.scopes = args.scopes;
108
+ }
73
109
 
74
110
  public utilityAssertCompatibleOracleVersion(version: number): void {
75
111
  if (version !== ORACLE_VERSION) {
@@ -90,35 +126,54 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
90
126
  * @param pkMHash - The master public key hash.
91
127
  * @returns A Promise that resolves to nullifier keys.
92
128
  * @throws If the keys are not registered in the key store.
129
+ * @throws If scopes are defined and the account is not in the scopes.
93
130
  */
94
- public utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
131
+ public async utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
132
+ // If scopes are defined, check that the key belongs to an account in the scopes.
133
+ if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
134
+ let hasAccess = false;
135
+ for (let i = 0; i < this.scopes.length && !hasAccess; i++) {
136
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
137
+ hasAccess = true;
138
+ }
139
+ }
140
+ if (!hasAccess) {
141
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
142
+ }
143
+ }
95
144
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
96
145
  }
97
146
 
98
147
  /**
99
148
  * Fetches the index and sibling path of a leaf at a given block from the note hash tree.
100
- * @param blockHash - The block hash at which to get the membership witness.
101
- * @param leafValue - The leaf value
149
+ * @param anchorBlockHash - The hash of a block that contains the note hash tree root in which to find the membership
150
+ * witness.
151
+ * @param noteHash - The note hash to find in the note hash tree.
102
152
  * @returns The membership witness containing the leaf index and sibling path
103
153
  */
104
154
  public utilityGetNoteHashMembershipWitness(
105
- blockHash: BlockHash,
106
- leafValue: Fr,
155
+ anchorBlockHash: BlockHash,
156
+ noteHash: Fr,
107
157
  ): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT> | undefined> {
108
- return this.aztecNode.getNoteHashMembershipWitness(blockHash, leafValue);
158
+ return this.aztecNode.getNoteHashMembershipWitness(anchorBlockHash, noteHash);
109
159
  }
110
160
 
111
161
  /**
112
- * Fetches the index and sibling path of a leaf at a given block from the archive tree.
113
- * @param blockHash - The block hash at which to get the membership witness.
114
- * @param leafValue - The leaf value
162
+ * Fetches the index and sibling path of a block hash in the archive tree.
163
+ *
164
+ * Block hashes are the leaves of the archive tree. Each time a new block is added to the chain,
165
+ * its block hash is appended as a new leaf to the archive tree.
166
+ *
167
+ * @param anchorBlockHash - The hash of a block that contains the archive tree root in which to find the membership
168
+ * witness.
169
+ * @param blockHash - The block hash to find in the archive tree.
115
170
  * @returns The membership witness containing the leaf index and sibling path
116
171
  */
117
- public utilityGetArchiveMembershipWitness(
172
+ public utilityGetBlockHashMembershipWitness(
173
+ anchorBlockHash: BlockHash,
118
174
  blockHash: BlockHash,
119
- leafValue: Fr,
120
175
  ): Promise<MembershipWitness<typeof ARCHIVE_HEIGHT> | undefined> {
121
- return this.aztecNode.getArchiveMembershipWitness(blockHash, leafValue);
176
+ return this.aztecNode.getBlockHashMembershipWitness(anchorBlockHash, blockHash);
122
177
  }
123
178
 
124
179
  /**
@@ -166,7 +221,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
166
221
  * @returns Block extracted from a block with block number `blockNumber`.
167
222
  */
168
223
  public async utilityGetBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
169
- const anchorBlockNumber = (await this.anchorBlockStore.getBlockHeader()).getBlockNumber();
224
+ const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
170
225
  if (blockNumber > anchorBlockNumber) {
171
226
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
172
227
  }
@@ -178,14 +233,13 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
178
233
  /**
179
234
  * Retrieve the complete address associated to a given address.
180
235
  * @param account - The account address.
181
- * @returns A complete address associated with the input address.
182
- * @throws An error if the account is not registered in the database.
236
+ * @returns A complete address associated with the input address, or `undefined` if not registered.
183
237
  */
184
- public utilityGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress> {
185
- return this.getCompleteAddress(account);
238
+ public utilityTryGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress | undefined> {
239
+ return this.addressStore.getCompleteAddress(account);
186
240
  }
187
241
 
188
- protected async getCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
242
+ protected async getCompleteAddressOrFail(account: AztecAddress): Promise<CompleteAddress> {
189
243
  const completeAddress = await this.addressStore.getCompleteAddress(account);
190
244
  if (!completeAddress) {
191
245
  throw new Error(
@@ -262,7 +316,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
262
316
  offset: number,
263
317
  status: NoteStatus,
264
318
  ): Promise<NoteData[]> {
265
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore, this.jobId);
319
+ const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
266
320
 
267
321
  const dbNotes = await noteService.getNotes(this.contractAddress, owner, storageSlot, status, this.scopes);
268
322
  return pickNotes<NoteData>(dbNotes, {
@@ -286,8 +340,13 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
286
340
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
287
341
  */
288
342
  public async utilityCheckNullifierExists(innerNullifier: Fr) {
289
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
290
- const [leafIndex] = await this.aztecNode.findLeavesIndexes('latest', MerkleTreeId.NULLIFIER_TREE, [nullifier]);
343
+ const [nullifier, anchorBlockHash] = await Promise.all([
344
+ siloNullifier(this.contractAddress, innerNullifier!),
345
+ this.anchorBlockHeader.hash(),
346
+ ]);
347
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
348
+ nullifier,
349
+ ]);
291
350
  return leafIndex?.data !== undefined;
292
351
  }
293
352
 
@@ -338,18 +397,34 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
338
397
  return values;
339
398
  }
340
399
 
341
- public utilityDebugLog(level: number, message: string, fields: Fr[]): void {
400
+ /**
401
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
402
+ */
403
+ async #getContractLogger(): Promise<Logger> {
404
+ if (!this.contractLogger) {
405
+ const addrAbbrev = this.contractAddress.toString().slice(0, 10);
406
+ const name = await this.contractStore.getDebugContractName(this.contractAddress);
407
+ const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::${addrAbbrev}`;
408
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
409
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
410
+ this.contractLogger = createLogger(module, { instanceId: this.jobId });
411
+ }
412
+ return this.contractLogger;
413
+ }
414
+
415
+ public async utilityLog(level: number, message: string, fields: Fr[]): Promise<void> {
342
416
  if (!LogLevels[level]) {
343
- throw new Error(`Invalid debug log level: ${level}`);
417
+ throw new Error(`Invalid log level: ${level}`);
344
418
  }
345
419
  const levelName = LogLevels[level];
346
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
420
+ const logger = await this.#getContractLogger();
421
+ logger[levelName](`${applyStringFormatting(message, fields)}`);
347
422
  }
348
423
 
349
424
  public async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
350
425
  const logService = new LogService(
351
426
  this.aztecNode,
352
- this.anchorBlockStore,
427
+ this.anchorBlockHeader,
353
428
  this.keyStore,
354
429
  this.capsuleStore,
355
430
  this.recipientTaggingStore,
@@ -359,16 +434,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
359
434
  this.log.getBindings(),
360
435
  );
361
436
 
362
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore, this.jobId);
363
-
364
- // It is acceptable to run the following operations in parallel for several reasons:
365
- // 1. syncTaggedLogs does not write to the note store — it only stores the pending tagged logs in a capsule array,
366
- // which is then processed in Noir after this handler returns.
367
- // 2. Even if syncTaggedLogs did write to the note store, it would not cause inconsistent state.
368
- await Promise.all([
369
- logService.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes),
370
- noteService.syncNoteNullifiers(this.contractAddress),
371
- ]);
437
+ await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
372
438
  }
373
439
 
374
440
  /**
@@ -401,7 +467,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
401
467
  await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)
402
468
  ).map(EventValidationRequest.fromFields);
403
469
 
404
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore, this.jobId);
470
+ const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
405
471
  const noteStorePromises = noteValidationRequests.map(request =>
406
472
  noteService.validateAndStoreNote(
407
473
  request.contractAddress,
@@ -417,7 +483,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
417
483
  ),
418
484
  );
419
485
 
420
- const eventService = new EventService(this.anchorBlockStore, this.aztecNode, this.privateEventStore, this.jobId);
486
+ const eventService = new EventService(this.anchorBlockHeader, this.aztecNode, this.privateEventStore, this.jobId);
421
487
  const eventStorePromises = eventValidationRequests.map(request =>
422
488
  eventService.validateAndStoreEvent(
423
489
  request.contractAddress,
@@ -455,7 +521,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
455
521
 
456
522
  const logService = new LogService(
457
523
  this.aztecNode,
458
- this.anchorBlockStore,
524
+ this.anchorBlockHeader,
459
525
  this.keyStore,
460
526
  this.capsuleStore,
461
527
  this.recipientTaggingStore,
@@ -540,7 +606,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
540
606
 
541
607
  protected async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
542
608
  // TODO(#12656): return an app-siloed secret
543
- const recipientCompleteAddress = await this.getCompleteAddress(address);
609
+ const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
544
610
  const ivskM = await this.keyStore.getMasterSecretKey(
545
611
  recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey,
546
612
  );
@@ -0,0 +1,152 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+ import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
3
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
+ import type { AztecNode } from '@aztec/stdlib/interfaces/client';
5
+ import type { BlockHeader } from '@aztec/stdlib/tx';
6
+
7
+ import type { AccessScopes } from '../access_scopes.js';
8
+ import type { StagedStore } from '../job_coordinator/job_coordinator.js';
9
+ import type { ContractStore } from '../storage/contract_store/contract_store.js';
10
+ import type { NoteStore } from '../storage/note_store/note_store.js';
11
+ import { syncState, verifyCurrentClassId } from './helpers.js';
12
+
13
+ /**
14
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
15
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
16
+ *
17
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
18
+ */
19
+ export class ContractSyncService implements StagedStore {
20
+ readonly storeName = 'contract_sync';
21
+
22
+ // Tracks contracts synced since last wipe. The cache is keyed per individual scope address
23
+ // (`contractAddress:scopeAddress`), or `contractAddress:*` for undefined scopes (all accounts).
24
+ // The value is a promise that resolves when the contract is synced.
25
+ private syncedContracts: Map<string, Promise<void>> = new Map();
26
+
27
+ // Per-job overridden contract addresses - these contracts should not be synced.
28
+ private overriddenContracts: Map<string, Set<string>> = new Map();
29
+
30
+ constructor(
31
+ private aztecNode: AztecNode,
32
+ private contractStore: ContractStore,
33
+ private noteStore: NoteStore,
34
+ private log: Logger,
35
+ ) {}
36
+
37
+ /** Sets contracts that should be skipped during sync for a specific job. */
38
+ setOverriddenContracts(jobId: string, addresses: Set<string>): void {
39
+ this.overriddenContracts.set(jobId, addresses);
40
+ }
41
+
42
+ /**
43
+ * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
44
+ * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
45
+ * @param contractAddress - The address of the contract to sync.
46
+ * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
47
+ * not sync_state itself).
48
+ * @param utilityExecutor - Executor function for running the sync_state utility function.
49
+ * @param scopes - Access scopes to pass through to the utility executor (affects whose account's private state is discovered).
50
+ */
51
+ async ensureContractSynced(
52
+ contractAddress: AztecAddress,
53
+ functionToInvokeAfterSync: FunctionSelector | null,
54
+ utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<any>,
55
+ anchorBlockHeader: BlockHeader,
56
+ jobId: string,
57
+ scopes: AccessScopes,
58
+ ): Promise<void> {
59
+ // Skip sync if this contract has an override for this job (overrides are keyed by contract address only)
60
+ const overrides = this.overriddenContracts.get(jobId);
61
+ if (overrides?.has(contractAddress.toString())) {
62
+ return;
63
+ }
64
+
65
+ // Skip sync if we already synced for "all scopes", or if we have an empty list of scopes
66
+ const allScopesKey = toKey(contractAddress, 'ALL_SCOPES');
67
+ const allScopesExisting = this.syncedContracts.get(allScopesKey);
68
+ if (allScopesExisting || (scopes !== 'ALL_SCOPES' && scopes.length == 0)) {
69
+ return;
70
+ }
71
+
72
+ const unsyncedScopes =
73
+ scopes === 'ALL_SCOPES'
74
+ ? scopes
75
+ : scopes.filter(scope => !this.syncedContracts.has(toKey(contractAddress, scope)));
76
+ const unsyncedScopesKeys = toKeys(contractAddress, unsyncedScopes);
77
+
78
+ if (unsyncedScopesKeys.length > 0) {
79
+ // Start sync and store the promise for all unsynced scopes
80
+ const promise = this.#doSync(
81
+ contractAddress,
82
+ functionToInvokeAfterSync,
83
+ utilityExecutor,
84
+ anchorBlockHeader,
85
+ jobId,
86
+ unsyncedScopes,
87
+ ).catch(err => {
88
+ // There was an error syncing the contract, so we remove it from the cache so that it can be retried.
89
+ unsyncedScopesKeys.forEach(key => this.syncedContracts.delete(key));
90
+ throw err;
91
+ });
92
+ unsyncedScopesKeys.forEach(key => this.syncedContracts.set(key, promise));
93
+ }
94
+
95
+ const promises = toKeys(contractAddress, scopes).map(key => this.syncedContracts.get(key)!);
96
+ await Promise.all(promises);
97
+ }
98
+
99
+ async #doSync(
100
+ contractAddress: AztecAddress,
101
+ functionToInvokeAfterSync: FunctionSelector | null,
102
+ utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<any>,
103
+ anchorBlockHeader: BlockHeader,
104
+ jobId: string,
105
+ scopes: AccessScopes,
106
+ ): Promise<void> {
107
+ this.log.debug(`Syncing contract ${contractAddress}`);
108
+ await Promise.all([
109
+ syncState(
110
+ contractAddress,
111
+ this.contractStore,
112
+ functionToInvokeAfterSync,
113
+ utilityExecutor,
114
+ this.noteStore,
115
+ this.aztecNode,
116
+ anchorBlockHeader,
117
+ jobId,
118
+ scopes,
119
+ ),
120
+ verifyCurrentClassId(contractAddress, this.aztecNode, this.contractStore, anchorBlockHeader),
121
+ ]);
122
+ this.log.debug(`Contract ${contractAddress} synced`);
123
+ }
124
+
125
+ /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */
126
+ wipe(): void {
127
+ this.log.debug(`Wiping contract sync cache (${this.syncedContracts.size} entries)`);
128
+ this.syncedContracts.clear();
129
+ }
130
+
131
+ commit(jobId: string): Promise<void> {
132
+ // Clear overridden contracts for this job
133
+ this.overriddenContracts.delete(jobId);
134
+ return Promise.resolve();
135
+ }
136
+
137
+ discardStaged(jobId: string): Promise<void> {
138
+ // We clear the synced contracts cache here because, when the job is discarded, any associated database writes from
139
+ // the sync are also undone.
140
+ this.syncedContracts.clear();
141
+ this.overriddenContracts.delete(jobId);
142
+ return Promise.resolve();
143
+ }
144
+ }
145
+
146
+ function toKeys(contract: AztecAddress, scopes: AccessScopes) {
147
+ return scopes === 'ALL_SCOPES' ? [toKey(contract, scopes)] : scopes.map(scope => toKey(contract, scope));
148
+ }
149
+
150
+ function toKey(contract: AztecAddress, scope: AztecAddress | 'ALL_SCOPES') {
151
+ return scope === 'ALL_SCOPES' ? `${contract.toString()}:*` : `${contract.toString()}:${scope.toString()}`;
152
+ }
@@ -6,7 +6,10 @@ import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '
6
6
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
7
7
  import type { BlockHeader } from '@aztec/stdlib/tx';
8
8
 
9
+ import type { AccessScopes } from '../access_scopes.js';
10
+ import { NoteService } from '../notes/note_service.js';
9
11
  import type { ContractStore } from '../storage/contract_store/contract_store.js';
12
+ import type { NoteStore } from '../storage/note_store/note_store.js';
10
13
 
11
14
  /**
12
15
  * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
@@ -40,7 +43,12 @@ export async function syncState(
40
43
  contractAddress: AztecAddress,
41
44
  contractStore: ContractStore,
42
45
  functionToInvokeAfterSync: FunctionSelector | null,
43
- utilityExecutor: (privateSyncCall: FunctionCall) => Promise<any>,
46
+ utilityExecutor: (privateSyncCall: FunctionCall, scopes: AccessScopes) => Promise<any>,
47
+ noteStore: NoteStore,
48
+ aztecNode: AztecNode,
49
+ anchorBlockHeader: BlockHeader,
50
+ jobId: string,
51
+ scopes: AccessScopes,
44
52
  ) {
45
53
  // Protocol contracts don't have private state to sync
46
54
  if (!isProtocolContract(contractAddress)) {
@@ -51,16 +59,26 @@ export async function syncState(
51
59
  );
52
60
  }
53
61
 
54
- return utilityExecutor(syncStateFunctionCall);
62
+ const noteService = new NoteService(noteStore, aztecNode, anchorBlockHeader, jobId);
63
+
64
+ // Both sync_state and syncNoteNullifiers interact with the note store, but running them in parallel is safe
65
+ // because note store is designed to handle concurrent operations.
66
+ await Promise.all([
67
+ utilityExecutor(syncStateFunctionCall, scopes),
68
+ noteService.syncNoteNullifiers(contractAddress, scopes),
69
+ ]);
55
70
  }
56
71
  }
57
72
 
58
73
  /**
59
74
  * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
60
75
  * provider (i.e. PXE's own storage).
76
+ * @param contractAddress - The address of the contract to verify.
77
+ * @param aztecNode - The Aztec node to query for storage.
78
+ * @param contractStore - The contract store to fetch the local instance from.
61
79
  * @param header - The header of the block at which to verify the current class id.
62
80
  */
63
- async function verifyCurrentClassId(
81
+ export async function verifyCurrentClassId(
64
82
  contractAddress: AztecAddress,
65
83
  aztecNode: AztecNode,
66
84
  contractStore: ContractStore,
@@ -78,21 +96,3 @@ async function verifyCurrentClassId(
78
96
  );
79
97
  }
80
98
  }
81
-
82
- /**
83
- * Ensures the contract's private state is synchronized and that the PXE holds the current class artifact for
84
- * the contract.
85
- */
86
- export async function ensureContractSynced(
87
- contractAddress: AztecAddress,
88
- functionToInvokeAfterSync: FunctionSelector | null,
89
- utilityExecutor: (call: FunctionCall) => Promise<any>,
90
- aztecNode: AztecNode,
91
- contractStore: ContractStore,
92
- header: BlockHeader,
93
- ): Promise<void> {
94
- await Promise.all([
95
- syncState(contractAddress, contractStore, functionToInvokeAfterSync, utilityExecutor),
96
- verifyCurrentClassId(contractAddress, aztecNode, contractStore, header),
97
- ]);
98
- }
@@ -1,10 +1,13 @@
1
- import { randomBytes } from '@aztec/foundation/crypto/random';
2
- import type { NoteDao, NotesFilter } from '@aztec/stdlib/note';
3
- import type { BlockHeader } from '@aztec/stdlib/tx';
1
+ import type { FunctionCall } from '@aztec/stdlib/abi';
2
+ import type { AuthWitness } from '@aztec/stdlib/auth-witness';
3
+ import type { NoteDao } from '@aztec/stdlib/note';
4
+ import type { ContractOverrides } from '@aztec/stdlib/tx';
4
5
 
6
+ import type { AccessScopes } from '../access_scopes.js';
5
7
  import type { BlockSynchronizer } from '../block_synchronizer/block_synchronizer.js';
6
- import type { PXE } from '../pxe.js';
7
- import type { ContractStore } from '../storage/contract_store/contract_store.js';
8
+ import type { ContractFunctionSimulator } from '../contract_function_simulator/contract_function_simulator.js';
9
+ import type { ContractSyncService } from '../contract_sync/contract_sync_service.js';
10
+ import type { NotesFilter } from '../notes_filter.js';
8
11
  import type { AnchorBlockStore } from '../storage/index.js';
9
12
  import type { NoteStore } from '../storage/note_store/note_store.js';
10
13
 
@@ -13,20 +16,38 @@ import type { NoteStore } from '../storage/note_store/note_store.js';
13
16
  * No backwards compatibility or API stability should be expected. Use at your own risk.
14
17
  */
15
18
  export class PXEDebugUtils {
16
- #pxe!: PXE;
17
19
  #putJobInQueue!: <T>(job: (jobId: string) => Promise<T>) => Promise<T>;
20
+ #getSimulatorForTx!: (overrides?: { contracts?: ContractOverrides }) => ContractFunctionSimulator;
21
+ #simulateUtility!: (
22
+ contractFunctionSimulator: ContractFunctionSimulator,
23
+ call: FunctionCall,
24
+ authWitnesses: AuthWitness[] | undefined,
25
+ scopes: AccessScopes,
26
+ jobId: string,
27
+ ) => Promise<any>;
18
28
 
19
29
  constructor(
20
- private contractStore: ContractStore,
30
+ private contractSyncService: ContractSyncService,
21
31
  private noteStore: NoteStore,
22
32
  private blockStateSynchronizer: BlockSynchronizer,
23
33
  private anchorBlockStore: AnchorBlockStore,
24
34
  ) {}
25
35
 
26
36
  /** Not injected through constructor since they're are co-dependant */
27
- public setPXE(pxe: PXE, putJobInQueue: <T>(job: (jobId: string) => Promise<T>) => Promise<T>) {
28
- this.#pxe = pxe;
37
+ public setPXEHelpers(
38
+ putJobInQueue: <T>(job: (jobId: string) => Promise<T>) => Promise<T>,
39
+ getSimulatorForTx: (overrides?: { contracts?: ContractOverrides }) => ContractFunctionSimulator,
40
+ simulateUtility: (
41
+ contractFunctionSimulator: ContractFunctionSimulator,
42
+ call: FunctionCall,
43
+ authWitnesses: AuthWitness[] | undefined,
44
+ scopes: AccessScopes,
45
+ jobId: string,
46
+ ) => Promise<any>,
47
+ ) {
29
48
  this.#putJobInQueue = putJobInQueue;
49
+ this.#getSimulatorForTx = getSimulatorForTx;
50
+ this.#simulateUtility = simulateUtility;
30
51
  }
31
52
 
32
53
  /**
@@ -40,17 +61,26 @@ export class PXEDebugUtils {
40
61
  * @param filter - The filter to apply to the notes.
41
62
  * @returns The requested notes.
42
63
  */
43
- public async getNotes(filter: NotesFilter): Promise<NoteDao[]> {
44
- // We need to manually trigger private state sync to have a guarantee that all the notes are available.
45
- const call = await this.contractStore.getFunctionCall('sync_state', [], filter.contractAddress);
46
- await this.#pxe.simulateUtility(call);
64
+ public getNotes(filter: NotesFilter): Promise<NoteDao[]> {
65
+ return this.#putJobInQueue(async (jobId: string) => {
66
+ await this.blockStateSynchronizer.sync();
47
67
 
48
- return this.noteStore.getNotes(filter, randomBytes(8).toString('hex'));
49
- }
68
+ const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
69
+
70
+ const contractFunctionSimulator = this.#getSimulatorForTx();
71
+
72
+ await this.contractSyncService.ensureContractSynced(
73
+ filter.contractAddress,
74
+ null,
75
+ async (privateSyncCall, execScopes) =>
76
+ await this.#simulateUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
77
+ anchorBlockHeader,
78
+ jobId,
79
+ filter.scopes,
80
+ );
50
81
 
51
- /** Returns the block header up to which the PXE has synced. */
52
- public getSyncedBlockHeader(): Promise<BlockHeader> {
53
- return this.anchorBlockStore.getBlockHeader();
82
+ return this.noteStore.getNotes(filter, jobId);
83
+ });
54
84
  }
55
85
 
56
86
  /**
@@ -1,3 +1,5 @@
1
+ export * from '../../../access_scopes.js';
2
+ export * from '../../../notes_filter.js';
1
3
  export * from '../../../pxe.js';
2
4
  export * from '../../../config/index.js';
3
5
  export * from '../../../error_enriching.js';