@aztec/pxe 0.0.1-commit.9372f48 → 0.0.1-commit.967fc6998

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 (165) 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 +174 -68
  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 +3 -3
  19. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/oracle/oracle.d.ts +3 -3
  21. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/oracle.js +23 -11
  23. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +36 -35
  24. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +73 -28
  26. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +35 -15
  27. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  28. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +63 -46
  29. package/dest/contract_logging.d.ts +22 -0
  30. package/dest/contract_logging.d.ts.map +1 -0
  31. package/dest/contract_logging.js +23 -0
  32. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  33. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  34. package/dest/contract_sync/contract_sync_service.js +97 -0
  35. package/dest/contract_sync/helpers.d.ts +29 -0
  36. package/dest/contract_sync/helpers.d.ts.map +1 -0
  37. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  38. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  39. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  40. package/dest/debug/pxe_debug_utils.js +16 -15
  41. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  42. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  43. package/dest/entrypoints/client/bundle/index.js +3 -0
  44. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  45. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  46. package/dest/entrypoints/client/bundle/utils.js +9 -1
  47. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  48. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  49. package/dest/entrypoints/client/lazy/index.js +3 -0
  50. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  51. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  52. package/dest/entrypoints/client/lazy/utils.js +9 -1
  53. package/dest/entrypoints/server/index.d.ts +4 -2
  54. package/dest/entrypoints/server/index.d.ts.map +1 -1
  55. package/dest/entrypoints/server/index.js +3 -1
  56. package/dest/entrypoints/server/utils.js +9 -1
  57. package/dest/logs/log_service.d.ts +3 -2
  58. package/dest/logs/log_service.d.ts.map +1 -1
  59. package/dest/logs/log_service.js +11 -18
  60. package/dest/notes/note_service.d.ts +4 -3
  61. package/dest/notes/note_service.d.ts.map +1 -1
  62. package/dest/notes/note_service.js +3 -2
  63. package/dest/notes_filter.d.ts +25 -0
  64. package/dest/notes_filter.d.ts.map +1 -0
  65. package/dest/notes_filter.js +4 -0
  66. package/dest/oracle_version.d.ts +2 -2
  67. package/dest/oracle_version.js +2 -2
  68. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  69. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  70. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  71. package/dest/private_kernel/hints/index.d.ts +1 -1
  72. package/dest/private_kernel/hints/index.js +1 -1
  73. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  74. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  75. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  76. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  77. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  78. package/dest/private_kernel/hints/test_utils.js +203 -0
  79. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  80. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  81. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  82. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  83. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  84. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  85. package/dest/pxe.d.ts +71 -24
  86. package/dest/pxe.d.ts.map +1 -1
  87. package/dest/pxe.js +100 -64
  88. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  89. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  90. package/dest/storage/contract_store/contract_store.js +145 -69
  91. package/dest/storage/note_store/note_store.d.ts +3 -3
  92. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  93. package/dest/storage/note_store/note_store.js +6 -4
  94. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  95. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  96. package/dest/storage/tagging_store/sender_tagging_store.d.ts +5 -5
  97. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  98. package/dest/storage/tagging_store/sender_tagging_store.js +4 -4
  99. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  100. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  101. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  102. package/dest/tagging/index.d.ts +2 -2
  103. package/dest/tagging/index.d.ts.map +1 -1
  104. package/dest/tagging/index.js +1 -1
  105. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  106. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  107. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  108. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  109. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  110. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  111. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  112. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  113. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  114. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +3 -6
  115. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +4 -7
  116. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  117. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +14 -15
  118. package/package.json +25 -16
  119. package/src/access_scopes.ts +9 -0
  120. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  121. package/src/config/package_info.ts +1 -1
  122. package/src/contract_function_simulator/contract_function_simulator.ts +323 -128
  123. package/src/contract_function_simulator/execution_tagging_index_cache.ts +5 -5
  124. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  125. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  126. package/src/contract_function_simulator/oracle/interfaces.ts +2 -2
  127. package/src/contract_function_simulator/oracle/oracle.ts +14 -7
  128. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +99 -105
  129. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +108 -45
  130. package/src/contract_logging.ts +39 -0
  131. package/src/contract_sync/contract_sync_service.ts +152 -0
  132. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  133. package/src/debug/pxe_debug_utils.ts +48 -18
  134. package/src/entrypoints/client/bundle/index.ts +3 -0
  135. package/src/entrypoints/client/bundle/utils.ts +9 -1
  136. package/src/entrypoints/client/lazy/index.ts +3 -0
  137. package/src/entrypoints/client/lazy/utils.ts +9 -1
  138. package/src/entrypoints/server/index.ts +3 -1
  139. package/src/entrypoints/server/utils.ts +7 -7
  140. package/src/logs/log_service.ts +18 -25
  141. package/src/notes/note_service.ts +4 -3
  142. package/src/notes_filter.ts +26 -0
  143. package/src/oracle_version.ts +2 -2
  144. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  145. package/src/private_kernel/hints/index.ts +1 -1
  146. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  147. package/src/private_kernel/hints/test_utils.ts +325 -0
  148. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  149. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  150. package/src/pxe.ts +184 -113
  151. package/src/storage/contract_store/contract_store.ts +174 -75
  152. package/src/storage/note_store/note_store.ts +12 -5
  153. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  154. package/src/storage/tagging_store/sender_tagging_store.ts +8 -8
  155. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  156. package/src/tagging/index.ts +1 -1
  157. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  158. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  159. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  160. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +4 -9
  161. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +11 -20
  162. package/dest/contract_sync/index.d.ts +0 -23
  163. package/dest/contract_sync/index.d.ts.map +0 -1
  164. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  165. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
@@ -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
+ }
@@ -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
+ #executeUtility!: (
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
+ executeUtility: (
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.#executeUtility = executeUtility;
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.#executeUtility(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,6 +1,9 @@
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';
6
+ export * from '../../../contract_logging.js';
4
7
  export * from '../../../storage/index.js';
5
8
  export * from './utils.js';
6
9
  export type { PXECreationOptions } from '../../pxe_creation_options.js';
@@ -52,6 +52,14 @@ export async function createPXE(
52
52
  const protocolContractsProvider = new BundledProtocolContractsProvider();
53
53
 
54
54
  const pxeLogger = loggers.pxe ?? createLogger('pxe:service', { actor });
55
- const pxe = await PXE.create(aztecNode, store, prover, simulator, protocolContractsProvider, config, pxeLogger);
55
+ const pxe = await PXE.create({
56
+ node: aztecNode,
57
+ store,
58
+ proofCreator: prover,
59
+ simulator,
60
+ protocolContractsProvider,
61
+ config,
62
+ loggerOrSuffix: pxeLogger,
63
+ });
56
64
  return pxe;
57
65
  }
@@ -1,6 +1,9 @@
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 '../../../storage/index.js';
4
6
  export * from '../../../error_enriching.js';
7
+ export * from '../../../contract_logging.js';
5
8
  export * from './utils.js';
6
9
  export { type PXECreationOptions } from '../../pxe_creation_options.js';
@@ -52,6 +52,14 @@ export async function createPXE(
52
52
  const protocolContractsProvider = new LazyProtocolContractsProvider();
53
53
 
54
54
  const pxeLogger = loggers.pxe ?? createLogger('pxe:service', { actor });
55
- const pxe = await PXE.create(aztecNode, store, prover, simulator, protocolContractsProvider, config, pxeLogger);
55
+ const pxe = await PXE.create({
56
+ node: aztecNode,
57
+ store,
58
+ proofCreator: prover,
59
+ simulator,
60
+ protocolContractsProvider,
61
+ config,
62
+ loggerOrSuffix: pxeLogger,
63
+ });
56
64
  return pxe;
57
65
  }
@@ -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';
@@ -7,4 +9,4 @@ export { NoteService } from '../../notes/note_service.js';
7
9
  export { ORACLE_VERSION } from '../../oracle_version.js';
8
10
  export { type PXECreationOptions } from '../pxe_creation_options.js';
9
11
  export { JobCoordinator } from '../../job_coordinator/job_coordinator.js';
10
- export { syncState } from '../../contract_sync/index.js';
12
+ export { ContractSyncService } from '../../contract_sync/contract_sync_service.js';
@@ -58,14 +58,14 @@ export async function createPXE(
58
58
  const protocolContractsProvider = new BundledProtocolContractsProvider();
59
59
 
60
60
  const pxeLogger = loggers.pxe ?? createLogger('pxe:service', { actor });
61
- const pxe = await PXE.create(
62
- aztecNode,
63
- options.store,
64
- prover,
61
+ const pxe = await PXE.create({
62
+ node: aztecNode,
63
+ store: options.store,
64
+ proofCreator: prover,
65
65
  simulator,
66
66
  protocolContractsProvider,
67
- configWithContracts,
68
- pxeLogger,
69
- );
67
+ config: configWithContracts,
68
+ loggerOrSuffix: pxeLogger,
69
+ });
70
70
  return pxe;
71
71
  }
@@ -2,11 +2,17 @@ import type { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
3
3
  import type { KeyStore } from '@aztec/key-store';
4
4
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
5
- import type { CompleteAddress } from '@aztec/stdlib/contract';
6
5
  import type { AztecNode } from '@aztec/stdlib/interfaces/server';
7
- import { DirectionalAppTaggingSecret, PendingTaggedLog, SiloedTag, Tag, TxScopedL2Log } from '@aztec/stdlib/logs';
6
+ import {
7
+ ExtendedDirectionalAppTaggingSecret,
8
+ PendingTaggedLog,
9
+ SiloedTag,
10
+ Tag,
11
+ TxScopedL2Log,
12
+ } from '@aztec/stdlib/logs';
8
13
  import type { BlockHeader } from '@aztec/stdlib/tx';
9
14
 
15
+ import type { AccessScopes } from '../access_scopes.js';
10
16
  import type { LogRetrievalRequest } from '../contract_function_simulator/noir-structs/log_retrieval_request.js';
11
17
  import { LogRetrievalResponse } from '../contract_function_simulator/noir-structs/log_retrieval_response.js';
12
18
  import { AddressStore } from '../storage/address_store/address_store.js';
@@ -41,7 +47,7 @@ export class LogService {
41
47
  logRetrievalRequests.map(async request => {
42
48
  const [publicLog, privateLog] = await Promise.all([
43
49
  this.#getPublicLogByTag(request.tag, request.contractAddress),
44
- this.#getPrivateLogByTag(await SiloedTag.compute(request.tag, request.contractAddress)),
50
+ this.#getPrivateLogByTag(await SiloedTag.computeFromTagAndApp(request.tag, request.contractAddress)),
45
51
  ]);
46
52
 
47
53
  if (publicLog !== null && privateLog !== null) {
@@ -108,19 +114,15 @@ export class LogService {
108
114
  );
109
115
  }
110
116
 
111
- public async syncTaggedLogs(
112
- contractAddress: AztecAddress,
113
- pendingTaggedLogArrayBaseSlot: Fr,
114
- scopes?: AztecAddress[],
115
- ) {
116
- this.log.verbose('Searching for tagged logs', { contract: contractAddress });
117
+ public async fetchTaggedLogs(contractAddress: AztecAddress, pendingTaggedLogArrayBaseSlot: Fr, scopes: AccessScopes) {
118
+ this.log.verbose(`Fetching tagged logs for ${contractAddress.toString()}`);
117
119
 
118
120
  // We only load logs from block up to and including the anchor block number
119
121
  const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
120
122
  const anchorBlockHash = await this.anchorBlockHeader.hash();
121
123
 
122
124
  // Determine recipients: use scopes if provided, otherwise get all accounts
123
- const recipients = scopes && scopes.length > 0 ? scopes : await this.keyStore.getAccounts();
125
+ const recipients = scopes !== 'ALL_SCOPES' && scopes.length > 0 ? scopes : await this.keyStore.getAccounts();
124
126
 
125
127
  // For each recipient, fetch secrets, load logs, and store them.
126
128
  // We run these per-recipient tasks in parallel so that logs are loaded for all recipients concurrently.
@@ -134,7 +136,6 @@ export class LogService {
134
136
  secrets.map(secret =>
135
137
  loadPrivateLogsForSenderRecipientPair(
136
138
  secret,
137
- contractAddress,
138
139
  this.aztecNode,
139
140
  this.recipientTaggingStore,
140
141
  anchorBlockNumber,
@@ -158,8 +159,11 @@ export class LogService {
158
159
  async #getSecretsForSenders(
159
160
  contractAddress: AztecAddress,
160
161
  recipient: AztecAddress,
161
- ): Promise<DirectionalAppTaggingSecret[]> {
162
- const recipientCompleteAddress = await this.#getCompleteAddress(recipient);
162
+ ): Promise<ExtendedDirectionalAppTaggingSecret[]> {
163
+ const recipientCompleteAddress = await this.addressStore.getCompleteAddress(recipient);
164
+ if (!recipientCompleteAddress) {
165
+ return [];
166
+ }
163
167
  const recipientIvsk = await this.keyStore.getMasterIncomingViewingSecretKey(recipient);
164
168
 
165
169
  // We implicitly add all PXE accounts as senders, this helps us decrypt tags on notes that we send to ourselves
@@ -173,7 +177,7 @@ export class LogService {
173
177
 
174
178
  return Promise.all(
175
179
  deduplicatedSenders.map(sender => {
176
- return DirectionalAppTaggingSecret.compute(
180
+ return ExtendedDirectionalAppTaggingSecret.compute(
177
181
  recipientCompleteAddress,
178
182
  recipientIvsk,
179
183
  sender,
@@ -206,15 +210,4 @@ export class LogService {
206
210
  // TODO: This looks like it could belong more at the oracle interface level
207
211
  return this.capsuleStore.appendToCapsuleArray(contractAddress, capsuleArrayBaseSlot, pendingTaggedLogs, this.jobId);
208
212
  }
209
-
210
- async #getCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
211
- const completeAddress = await this.addressStore.getCompleteAddress(account);
212
- if (!completeAddress) {
213
- throw new Error(
214
- `No public key registered for address ${account}.
215
- Register it by calling pxe.addAccount(...).\nSee docs for context: https://docs.aztec.network/developers/resources/debugging/aztecnr-errors#simulation-error-no-public-key-registered-for-address-0x0-register-it-by-calling-pxeregisterrecipient-or-pxeregisteraccount`,
216
- );
217
- }
218
- return completeAddress;
219
- }
220
213
  }
@@ -7,6 +7,7 @@ import { Note, NoteDao, NoteStatus } from '@aztec/stdlib/note';
7
7
  import { MerkleTreeId } from '@aztec/stdlib/trees';
8
8
  import type { BlockHeader, TxHash } from '@aztec/stdlib/tx';
9
9
 
10
+ import type { AccessScopes } from '../access_scopes.js';
10
11
  import type { NoteStore } from '../storage/note_store/note_store.js';
11
12
 
12
13
  export class NoteService {
@@ -31,7 +32,7 @@ export class NoteService {
31
32
  owner: AztecAddress | undefined,
32
33
  storageSlot: Fr,
33
34
  status: NoteStatus,
34
- scopes?: AztecAddress[],
35
+ scopes: AccessScopes,
35
36
  ) {
36
37
  const noteDaos = await this.noteStore.getNotes(
37
38
  {
@@ -70,10 +71,10 @@ export class NoteService {
70
71
  *
71
72
  * @param contractAddress - The contract whose notes should be checked and nullified.
72
73
  */
73
- public async syncNoteNullifiers(contractAddress: AztecAddress): Promise<void> {
74
+ public async syncNoteNullifiers(contractAddress: AztecAddress, scopes: AccessScopes): Promise<void> {
74
75
  const anchorBlockHash = await this.anchorBlockHeader.hash();
75
76
 
76
- const contractNotes = await this.noteStore.getNotes({ contractAddress }, this.jobId);
77
+ const contractNotes = await this.noteStore.getNotes({ contractAddress, scopes }, this.jobId);
77
78
 
78
79
  if (contractNotes.length === 0) {
79
80
  return;
@@ -0,0 +1,26 @@
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
+ import type { NoteStatus } from '@aztec/stdlib/note';
4
+
5
+ import type { AccessScopes } from './access_scopes.js';
6
+
7
+ /**
8
+ * A filter used to fetch notes.
9
+ * @remarks This filter is applied as an intersection of all its params.
10
+ */
11
+ export type NotesFilter = {
12
+ /**
13
+ * The contract address the note belongs to.
14
+ * @remarks Providing a contract address is required as we need that information to trigger private state sync.
15
+ */
16
+ contractAddress: AztecAddress;
17
+ /** The owner of the note. */
18
+ owner?: AztecAddress;
19
+ /** The specific storage location of the note on the contract. */
20
+ storageSlot?: Fr;
21
+ /** The status of the note. Defaults to 'ACTIVE'. */
22
+ status?: NoteStatus;
23
+ /** The siloed nullifier for the note. */
24
+ siloedNullifier?: Fr;
25
+ scopes: AccessScopes;
26
+ };
@@ -4,9 +4,9 @@
4
4
  ///
5
5
  /// @dev Whenever a contract function or Noir test is run, the `utilityAssertCompatibleOracleVersion` oracle is called
6
6
  /// and if the oracle version is incompatible an error is thrown.
7
- export const ORACLE_VERSION = 10;
7
+ export const ORACLE_VERSION = 12;
8
8
 
9
9
  /// This hash is computed as by hashing the Oracle interface and it is used to detect when the Oracle interface changes,
10
10
  /// which in turn implies that you need to update the ORACLE_VERSION constant in this file and in
11
11
  /// `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
12
- export const ORACLE_INTERFACE_HASH = 'a3b284ee5abff0509986d6d2fa78a3e6e2ec212325674de78355c5e70b05784c';
12
+ export const ORACLE_INTERFACE_HASH = '666a8a7fc697f72b29dbf0ae7464db269cf5afa019acac8861f814543147dbb4';