@aztec/pxe 0.0.1-commit.023c3e5 → 0.0.1-commit.033589e

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 (167) 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 -28
  9. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  10. package/dest/contract_function_simulator/contract_function_simulator.js +177 -71
  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 +44 -44
  19. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/oracle/oracle.d.ts +44 -44
  21. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/oracle.js +151 -96
  23. package/dest/contract_function_simulator/oracle/private_execution.js +1 -1
  24. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +55 -54
  25. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  26. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +100 -55
  27. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +60 -42
  28. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  29. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +91 -80
  30. package/dest/contract_logging.d.ts +22 -0
  31. package/dest/contract_logging.d.ts.map +1 -0
  32. package/dest/contract_logging.js +23 -0
  33. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  34. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  35. package/dest/contract_sync/contract_sync_service.js +97 -0
  36. package/dest/contract_sync/helpers.d.ts +29 -0
  37. package/dest/contract_sync/helpers.d.ts.map +1 -0
  38. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  39. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  40. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  41. package/dest/debug/pxe_debug_utils.js +16 -15
  42. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  43. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  44. package/dest/entrypoints/client/bundle/index.js +3 -0
  45. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  46. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  47. package/dest/entrypoints/client/bundle/utils.js +9 -1
  48. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  49. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  50. package/dest/entrypoints/client/lazy/index.js +3 -0
  51. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  52. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  53. package/dest/entrypoints/client/lazy/utils.js +9 -1
  54. package/dest/entrypoints/server/index.d.ts +4 -2
  55. package/dest/entrypoints/server/index.d.ts.map +1 -1
  56. package/dest/entrypoints/server/index.js +3 -1
  57. package/dest/entrypoints/server/utils.js +9 -1
  58. package/dest/logs/log_service.d.ts +3 -2
  59. package/dest/logs/log_service.d.ts.map +1 -1
  60. package/dest/logs/log_service.js +11 -18
  61. package/dest/notes/note_service.d.ts +4 -3
  62. package/dest/notes/note_service.d.ts.map +1 -1
  63. package/dest/notes/note_service.js +3 -2
  64. package/dest/notes_filter.d.ts +25 -0
  65. package/dest/notes_filter.d.ts.map +1 -0
  66. package/dest/notes_filter.js +4 -0
  67. package/dest/oracle_version.d.ts +2 -2
  68. package/dest/oracle_version.js +3 -3
  69. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  70. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  71. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  72. package/dest/private_kernel/hints/index.d.ts +1 -1
  73. package/dest/private_kernel/hints/index.js +1 -1
  74. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  75. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  76. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  77. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  78. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  79. package/dest/private_kernel/hints/test_utils.js +203 -0
  80. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  81. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  82. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  83. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  84. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  85. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  86. package/dest/pxe.d.ts +71 -24
  87. package/dest/pxe.d.ts.map +1 -1
  88. package/dest/pxe.js +100 -64
  89. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  90. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  91. package/dest/storage/contract_store/contract_store.js +145 -69
  92. package/dest/storage/note_store/note_store.d.ts +3 -3
  93. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  94. package/dest/storage/note_store/note_store.js +6 -4
  95. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  96. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  97. package/dest/storage/tagging_store/sender_tagging_store.d.ts +5 -5
  98. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  99. package/dest/storage/tagging_store/sender_tagging_store.js +4 -4
  100. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  101. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  102. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  103. package/dest/tagging/index.d.ts +2 -2
  104. package/dest/tagging/index.d.ts.map +1 -1
  105. package/dest/tagging/index.js +1 -1
  106. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  107. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  108. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  109. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  110. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  111. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  112. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  113. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  114. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  115. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +3 -6
  116. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +4 -7
  117. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  118. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +14 -15
  119. package/package.json +25 -16
  120. package/src/access_scopes.ts +9 -0
  121. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  122. package/src/config/package_info.ts +1 -1
  123. package/src/contract_function_simulator/contract_function_simulator.ts +326 -131
  124. package/src/contract_function_simulator/execution_tagging_index_cache.ts +5 -5
  125. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  126. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  127. package/src/contract_function_simulator/oracle/interfaces.ts +43 -43
  128. package/src/contract_function_simulator/oracle/oracle.ts +145 -110
  129. package/src/contract_function_simulator/oracle/private_execution.ts +1 -1
  130. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +126 -132
  131. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +136 -86
  132. package/src/contract_logging.ts +39 -0
  133. package/src/contract_sync/contract_sync_service.ts +152 -0
  134. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  135. package/src/debug/pxe_debug_utils.ts +48 -18
  136. package/src/entrypoints/client/bundle/index.ts +3 -0
  137. package/src/entrypoints/client/bundle/utils.ts +9 -1
  138. package/src/entrypoints/client/lazy/index.ts +3 -0
  139. package/src/entrypoints/client/lazy/utils.ts +9 -1
  140. package/src/entrypoints/server/index.ts +3 -1
  141. package/src/entrypoints/server/utils.ts +7 -7
  142. package/src/logs/log_service.ts +18 -25
  143. package/src/notes/note_service.ts +4 -3
  144. package/src/notes_filter.ts +26 -0
  145. package/src/oracle_version.ts +3 -3
  146. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  147. package/src/private_kernel/hints/index.ts +1 -1
  148. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  149. package/src/private_kernel/hints/test_utils.ts +325 -0
  150. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  151. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  152. package/src/pxe.ts +184 -113
  153. package/src/storage/contract_store/contract_store.ts +174 -75
  154. package/src/storage/note_store/note_store.ts +12 -5
  155. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  156. package/src/storage/tagging_store/sender_tagging_store.ts +8 -8
  157. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  158. package/src/tagging/index.ts +1 -1
  159. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  160. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  161. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  162. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +4 -9
  163. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +11 -20
  164. package/dest/contract_sync/index.d.ts +0 -23
  165. package/dest/contract_sync/index.d.ts.map +0 -1
  166. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  167. 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, 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,6 +20,8 @@ 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';
24
+ import { createContractLogger, logContractMessage } from '../../contract_logging.js';
23
25
  import { EventService } from '../../events/event_service.js';
24
26
  import { LogService } from '../../logs/log_service.js';
25
27
  import { NoteService } from '../../notes/note_service.js';
@@ -40,6 +42,27 @@ import { pickNotes } from '../pick_notes.js';
40
42
  import type { IMiscOracle, IUtilityExecutionOracle, NoteData } from './interfaces.js';
41
43
  import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
42
44
 
45
+ /** Args for UtilityExecutionOracle constructor. */
46
+ export type UtilityExecutionOracleArgs = {
47
+ contractAddress: AztecAddress;
48
+ /** List of transient auth witnesses to be used during this simulation */
49
+ authWitnesses: AuthWitness[];
50
+ capsules: Capsule[]; // TODO(#12425): Rename to transientCapsules
51
+ anchorBlockHeader: BlockHeader;
52
+ contractStore: ContractStore;
53
+ noteStore: NoteStore;
54
+ keyStore: KeyStore;
55
+ addressStore: AddressStore;
56
+ aztecNode: AztecNode;
57
+ recipientTaggingStore: RecipientTaggingStore;
58
+ senderAddressBookStore: SenderAddressBookStore;
59
+ capsuleStore: CapsuleStore;
60
+ privateEventStore: PrivateEventStore;
61
+ jobId: string;
62
+ log?: ReturnType<typeof createLogger>;
63
+ scopes: AccessScopes;
64
+ };
65
+
43
66
  /**
44
67
  * The oracle for an execution of utility contract functions.
45
68
  */
@@ -47,39 +70,55 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
47
70
  isMisc = true as const;
48
71
  isUtility = true as const;
49
72
 
50
- private aztecNrDebugLog = createLogger('aztec-nr:debug_log');
51
-
52
- constructor(
53
- protected readonly contractAddress: AztecAddress,
54
- /** List of transient auth witnesses to be used during this simulation */
55
- protected readonly authWitnesses: AuthWitness[],
56
- protected readonly capsules: Capsule[], // TODO(#12425): Rename to transientCapsules
57
- protected readonly anchorBlockHeader: BlockHeader,
58
- protected readonly contractStore: ContractStore,
59
- protected readonly noteStore: NoteStore,
60
- protected readonly keyStore: KeyStore,
61
- protected readonly addressStore: AddressStore,
62
- protected readonly aztecNode: AztecNode,
63
- protected readonly recipientTaggingStore: RecipientTaggingStore,
64
- protected readonly senderAddressBookStore: SenderAddressBookStore,
65
- protected readonly capsuleStore: CapsuleStore,
66
- protected readonly privateEventStore: PrivateEventStore,
67
- protected readonly jobId: string,
68
- protected log = createLogger('simulator:client_view_context'),
69
- protected readonly scopes?: AztecAddress[],
70
- ) {}
71
-
72
- public utilityAssertCompatibleOracleVersion(version: number): void {
73
+ private contractLogger: Logger | undefined;
74
+
75
+ protected readonly contractAddress: AztecAddress;
76
+ protected readonly authWitnesses: AuthWitness[];
77
+ protected readonly capsules: Capsule[];
78
+ protected readonly anchorBlockHeader: BlockHeader;
79
+ protected readonly contractStore: ContractStore;
80
+ protected readonly noteStore: NoteStore;
81
+ protected readonly keyStore: KeyStore;
82
+ protected readonly addressStore: AddressStore;
83
+ protected readonly aztecNode: AztecNode;
84
+ protected readonly recipientTaggingStore: RecipientTaggingStore;
85
+ protected readonly senderAddressBookStore: SenderAddressBookStore;
86
+ protected readonly capsuleStore: CapsuleStore;
87
+ protected readonly privateEventStore: PrivateEventStore;
88
+ protected readonly jobId: string;
89
+ protected logger: ReturnType<typeof createLogger>;
90
+ protected readonly scopes: AccessScopes;
91
+
92
+ constructor(args: UtilityExecutionOracleArgs) {
93
+ this.contractAddress = args.contractAddress;
94
+ this.authWitnesses = args.authWitnesses;
95
+ this.capsules = args.capsules;
96
+ this.anchorBlockHeader = args.anchorBlockHeader;
97
+ this.contractStore = args.contractStore;
98
+ this.noteStore = args.noteStore;
99
+ this.keyStore = args.keyStore;
100
+ this.addressStore = args.addressStore;
101
+ this.aztecNode = args.aztecNode;
102
+ this.recipientTaggingStore = args.recipientTaggingStore;
103
+ this.senderAddressBookStore = args.senderAddressBookStore;
104
+ this.capsuleStore = args.capsuleStore;
105
+ this.privateEventStore = args.privateEventStore;
106
+ this.jobId = args.jobId;
107
+ this.logger = args.log ?? createLogger('simulator:client_view_context');
108
+ this.scopes = args.scopes;
109
+ }
110
+
111
+ public assertCompatibleOracleVersion(version: number): void {
73
112
  if (version !== ORACLE_VERSION) {
74
113
  throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
75
114
  }
76
115
  }
77
116
 
78
- public utilityGetRandomField(): Fr {
117
+ public getRandomField(): Fr {
79
118
  return Fr.random();
80
119
  }
81
120
 
82
- public utilityGetUtilityContext(): UtilityContext {
121
+ public getUtilityContext(): UtilityContext {
83
122
  return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
84
123
  }
85
124
 
@@ -88,8 +127,21 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
88
127
  * @param pkMHash - The master public key hash.
89
128
  * @returns A Promise that resolves to nullifier keys.
90
129
  * @throws If the keys are not registered in the key store.
130
+ * @throws If scopes are defined and the account is not in the scopes.
91
131
  */
92
- public utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
132
+ public async getKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
133
+ // If scopes are defined, check that the key belongs to an account in the scopes.
134
+ if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
135
+ let hasAccess = false;
136
+ for (let i = 0; i < this.scopes.length && !hasAccess; i++) {
137
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
138
+ hasAccess = true;
139
+ }
140
+ }
141
+ if (!hasAccess) {
142
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
143
+ }
144
+ }
93
145
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
94
146
  }
95
147
 
@@ -100,7 +152,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
100
152
  * @param noteHash - The note hash to find in the note hash tree.
101
153
  * @returns The membership witness containing the leaf index and sibling path
102
154
  */
103
- public utilityGetNoteHashMembershipWitness(
155
+ public getNoteHashMembershipWitness(
104
156
  anchorBlockHash: BlockHash,
105
157
  noteHash: Fr,
106
158
  ): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT> | undefined> {
@@ -118,7 +170,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
118
170
  * @param blockHash - The block hash to find in the archive tree.
119
171
  * @returns The membership witness containing the leaf index and sibling path
120
172
  */
121
- public utilityGetBlockHashMembershipWitness(
173
+ public getBlockHashMembershipWitness(
122
174
  anchorBlockHash: BlockHash,
123
175
  blockHash: BlockHash,
124
176
  ): Promise<MembershipWitness<typeof ARCHIVE_HEIGHT> | undefined> {
@@ -131,7 +183,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
131
183
  * @param nullifier - Nullifier we try to find witness for.
132
184
  * @returns The nullifier membership witness (if found).
133
185
  */
134
- public utilityGetNullifierMembershipWitness(
186
+ public getNullifierMembershipWitness(
135
187
  blockHash: BlockHash,
136
188
  nullifier: Fr,
137
189
  ): Promise<NullifierMembershipWitness | undefined> {
@@ -147,7 +199,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
147
199
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
148
200
  * we are trying to prove non-inclusion for.
149
201
  */
150
- public utilityGetLowNullifierMembershipWitness(
202
+ public getLowNullifierMembershipWitness(
151
203
  blockHash: BlockHash,
152
204
  nullifier: Fr,
153
205
  ): Promise<NullifierMembershipWitness | undefined> {
@@ -160,7 +212,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
160
212
  * @param leafSlot - The slot of the public data tree to get the witness for.
161
213
  * @returns - The witness
162
214
  */
163
- public utilityGetPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
215
+ public getPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
164
216
  return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
165
217
  }
166
218
 
@@ -169,7 +221,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
169
221
  * @param blockNumber - The number of a block of which to get the block header.
170
222
  * @returns Block extracted from a block with block number `blockNumber`.
171
223
  */
172
- public async utilityGetBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
224
+ public async getBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
173
225
  const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
174
226
  if (blockNumber > anchorBlockNumber) {
175
227
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
@@ -182,14 +234,13 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
182
234
  /**
183
235
  * Retrieve the complete address associated to a given address.
184
236
  * @param account - The account address.
185
- * @returns A complete address associated with the input address.
186
- * @throws An error if the account is not registered in the database.
237
+ * @returns A complete address associated with the input address, or `undefined` if not registered.
187
238
  */
188
- public utilityGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress> {
189
- return this.getCompleteAddress(account);
239
+ public tryGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress | undefined> {
240
+ return this.addressStore.getCompleteAddress(account);
190
241
  }
191
242
 
192
- protected async getCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
243
+ protected async getCompleteAddressOrFail(account: AztecAddress): Promise<CompleteAddress> {
193
244
  const completeAddress = await this.addressStore.getCompleteAddress(account);
194
245
  if (!completeAddress) {
195
246
  throw new Error(
@@ -205,11 +256,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
205
256
  * @param address - Address.
206
257
  * @returns A contract instance.
207
258
  */
208
- public utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance> {
209
- return this.getContractInstance(address);
210
- }
211
-
212
- protected async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
259
+ public async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
213
260
  const instance = await this.contractStore.getContractInstance(address);
214
261
  if (!instance) {
215
262
  throw new Error(`No contract instance found for address ${address.toString()}`);
@@ -223,7 +270,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
223
270
  * @param messageHash - Hash of the message to authenticate.
224
271
  * @returns Authentication witness for the requested message hash.
225
272
  */
226
- public utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
273
+ public getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
227
274
  return Promise.resolve(this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness);
228
275
  }
229
276
 
@@ -249,7 +296,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
249
296
  * @param status - The status of notes to fetch.
250
297
  * @returns Array of note data.
251
298
  */
252
- public async utilityGetNotes(
299
+ public async getNotes(
253
300
  owner: AztecAddress | undefined,
254
301
  storageSlot: Fr,
255
302
  numSelects: number,
@@ -289,9 +336,14 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
289
336
  * @param innerNullifier - The inner nullifier.
290
337
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
291
338
  */
292
- public async utilityCheckNullifierExists(innerNullifier: Fr) {
293
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
294
- const [leafIndex] = await this.aztecNode.findLeavesIndexes('latest', MerkleTreeId.NULLIFIER_TREE, [nullifier]);
339
+ public async checkNullifierExists(innerNullifier: Fr) {
340
+ const [nullifier, anchorBlockHash] = await Promise.all([
341
+ siloNullifier(this.contractAddress, innerNullifier!),
342
+ this.anchorBlockHeader.hash(),
343
+ ]);
344
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
345
+ nullifier,
346
+ ]);
295
347
  return leafIndex?.data !== undefined;
296
348
  }
297
349
 
@@ -303,7 +355,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
303
355
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
304
356
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
305
357
  */
306
- public async utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
358
+ public async getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
307
359
  const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(
308
360
  this.aztecNode,
309
361
  contractAddress,
@@ -321,7 +373,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
321
373
  * @param startStorageSlot - The starting storage slot.
322
374
  * @param numberOfElements - Number of elements to read from the starting storage slot.
323
375
  */
324
- public async utilityStorageRead(
376
+ public async storageRead(
325
377
  blockHash: BlockHash,
326
378
  contractAddress: AztecAddress,
327
379
  startStorageSlot: Fr,
@@ -335,22 +387,38 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
335
387
  slots.map(storageSlot => this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)),
336
388
  );
337
389
 
338
- this.log.debug(
390
+ this.logger.debug(
339
391
  `Oracle storage read: slots=[${slots.map(slot => slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`,
340
392
  );
341
393
 
342
394
  return values;
343
395
  }
344
396
 
345
- public utilityDebugLog(level: number, message: string, fields: Fr[]): void {
397
+ /**
398
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
399
+ */
400
+ async #getContractLogger(): Promise<Logger> {
401
+ if (!this.contractLogger) {
402
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
403
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
404
+ this.contractLogger = await createContractLogger(
405
+ this.contractAddress,
406
+ addr => this.contractStore.getDebugContractName(addr),
407
+ { instanceId: this.jobId },
408
+ );
409
+ }
410
+ return this.contractLogger;
411
+ }
412
+
413
+ public async log(level: number, message: string, fields: Fr[]): Promise<void> {
346
414
  if (!LogLevels[level]) {
347
- throw new Error(`Invalid debug log level: ${level}`);
415
+ throw new Error(`Invalid log level: ${level}`);
348
416
  }
349
- const levelName = LogLevels[level];
350
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
417
+ const logger = await this.#getContractLogger();
418
+ logContractMessage(logger, LogLevels[level], message, fields);
351
419
  }
352
420
 
353
- public async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
421
+ public async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
354
422
  const logService = new LogService(
355
423
  this.aztecNode,
356
424
  this.anchorBlockHeader,
@@ -360,19 +428,10 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
360
428
  this.senderAddressBookStore,
361
429
  this.addressStore,
362
430
  this.jobId,
363
- this.log.getBindings(),
431
+ this.logger.getBindings(),
364
432
  );
365
433
 
366
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
367
-
368
- // It is acceptable to run the following operations in parallel for several reasons:
369
- // 1. syncTaggedLogs does not write to the note store — it only stores the pending tagged logs in a capsule array,
370
- // which is then processed in Noir after this handler returns.
371
- // 2. Even if syncTaggedLogs did write to the note store, it would not cause inconsistent state.
372
- await Promise.all([
373
- logService.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes),
374
- noteService.syncNoteNullifiers(this.contractAddress),
375
- ]);
434
+ await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
376
435
  }
377
436
 
378
437
  /**
@@ -385,7 +444,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
385
444
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
386
445
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
387
446
  */
388
- public async utilityValidateAndStoreEnqueuedNotesAndEvents(
447
+ public async validateAndStoreEnqueuedNotesAndEvents(
389
448
  contractAddress: AztecAddress,
390
449
  noteValidationRequestsArrayBaseSlot: Fr,
391
450
  eventValidationRequestsArrayBaseSlot: Fr,
@@ -441,7 +500,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
441
500
  await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
442
501
  }
443
502
 
444
- public async utilityBulkRetrieveLogs(
503
+ public async bulkRetrieveLogs(
445
504
  contractAddress: AztecAddress,
446
505
  logRetrievalRequestsArrayBaseSlot: Fr,
447
506
  logRetrievalResponsesArrayBaseSlot: Fr,
@@ -466,7 +525,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
466
525
  this.senderAddressBookStore,
467
526
  this.addressStore,
468
527
  this.jobId,
469
- this.log.getBindings(),
528
+ this.logger.getBindings(),
470
529
  );
471
530
 
472
531
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
@@ -483,7 +542,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
483
542
  );
484
543
  }
485
544
 
486
- public utilityStoreCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
545
+ public storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
487
546
  if (!contractAddress.equals(this.contractAddress)) {
488
547
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
489
548
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -492,7 +551,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
492
551
  return Promise.resolve();
493
552
  }
494
553
 
495
- public async utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
554
+ public async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
496
555
  if (!contractAddress.equals(this.contractAddress)) {
497
556
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
498
557
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -504,7 +563,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
504
563
  );
505
564
  }
506
565
 
507
- public utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
566
+ public deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
508
567
  if (!contractAddress.equals(this.contractAddress)) {
509
568
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
510
569
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -513,12 +572,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
513
572
  return Promise.resolve();
514
573
  }
515
574
 
516
- public utilityCopyCapsule(
517
- contractAddress: AztecAddress,
518
- srcSlot: Fr,
519
- dstSlot: Fr,
520
- numEntries: number,
521
- ): Promise<void> {
575
+ public copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void> {
522
576
  if (!contractAddress.equals(this.contractAddress)) {
523
577
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
524
578
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -527,7 +581,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
527
581
  }
528
582
 
529
583
  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
530
- public utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
584
+ public aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
531
585
  const aes128 = new Aes128();
532
586
  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
533
587
  }
@@ -538,13 +592,9 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
538
592
  * @param ephPk - The ephemeral public key to get the secret for.
539
593
  * @returns The secret for the given address.
540
594
  */
541
- public utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
542
- return this.getSharedSecret(address, ephPk);
543
- }
544
-
545
- protected async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
595
+ public async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
546
596
  // TODO(#12656): return an app-siloed secret
547
- const recipientCompleteAddress = await this.getCompleteAddress(address);
597
+ const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
548
598
  const ivskM = await this.keyStore.getMasterSecretKey(
549
599
  recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey,
550
600
  );
@@ -0,0 +1,39 @@
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
+ import { type LogLevel, type Logger, applyStringFormatting, createLogger } from '@aztec/foundation/log';
3
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
+ import type { DebugLog } from '@aztec/stdlib/logs';
5
+
6
+ /** Resolves a contract address to a human-readable name, if available. */
7
+ export type ContractNameResolver = (address: AztecAddress) => Promise<string | undefined>;
8
+
9
+ /**
10
+ * Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
11
+ */
12
+ export async function createContractLogger(
13
+ contractAddress: AztecAddress,
14
+ getContractName: ContractNameResolver,
15
+ options?: { instanceId?: string },
16
+ ): Promise<Logger> {
17
+ const addrAbbrev = contractAddress.toString().slice(0, 10);
18
+ const name = await getContractName(contractAddress);
19
+ const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::Unknown(${addrAbbrev})`;
20
+ return createLogger(module, options);
21
+ }
22
+
23
+ /**
24
+ * Formats and emits a single contract log message through the given logger.
25
+ */
26
+ export function logContractMessage(logger: Logger, level: LogLevel, message: string, fields: Fr[]): void {
27
+ logger[level](applyStringFormatting(message, fields));
28
+ }
29
+
30
+ /**
31
+ * Displays debug logs collected during public function simulation,
32
+ * using the `contract_log::` prefixed logger format.
33
+ */
34
+ export async function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void> {
35
+ for (const log of debugLogs) {
36
+ const logger = await createContractLogger(log.contractAddress, getContractName);
37
+ logContractMessage(logger, log.level, log.message, log.fields);
38
+ }
39
+ }
@@ -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
+ }