@aztec/pxe 0.0.1-commit.3469e52 → 0.0.1-commit.54489865

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 (150) hide show
  1. package/dest/bin/check_oracle_version.js +1 -1
  2. package/dest/block_synchronizer/block_synchronizer.d.ts +7 -5
  3. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  4. package/dest/block_synchronizer/block_synchronizer.js +56 -16
  5. package/dest/config/index.d.ts +3 -1
  6. package/dest/config/index.d.ts.map +1 -1
  7. package/dest/config/index.js +17 -0
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts +1 -1
  9. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  10. package/dest/contract_function_simulator/contract_function_simulator.js +5 -8
  11. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +1 -1
  12. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  13. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +1 -1
  14. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  15. package/dest/contract_function_simulator/oracle/interfaces.d.ts +13 -10
  16. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/oracle/oracle.d.ts +5 -3
  18. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/oracle/oracle.js +27 -17
  20. package/dest/contract_function_simulator/oracle/private_execution.d.ts +2 -22
  21. package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/private_execution.js +0 -37
  23. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +9 -1
  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 +16 -5
  26. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +20 -12
  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 +36 -38
  29. package/dest/contract_sync/index.d.ts +23 -0
  30. package/dest/contract_sync/index.d.ts.map +1 -0
  31. package/dest/contract_sync/index.js +54 -0
  32. package/dest/debug/pxe_debug_utils.d.ts +16 -6
  33. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  34. package/dest/debug/pxe_debug_utils.js +20 -10
  35. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  36. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  37. package/dest/entrypoints/client/bundle/utils.js +10 -5
  38. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  39. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  40. package/dest/entrypoints/client/lazy/utils.js +11 -6
  41. package/dest/entrypoints/pxe_creation_options.d.ts +3 -2
  42. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  43. package/dest/entrypoints/server/index.d.ts +2 -1
  44. package/dest/entrypoints/server/index.d.ts.map +1 -1
  45. package/dest/entrypoints/server/index.js +1 -0
  46. package/dest/entrypoints/server/utils.d.ts +1 -1
  47. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  48. package/dest/entrypoints/server/utils.js +19 -8
  49. package/dest/events/event_service.d.ts +2 -2
  50. package/dest/events/event_service.d.ts.map +1 -1
  51. package/dest/events/event_service.js +1 -1
  52. package/dest/job_coordinator/job_coordinator.d.ts +3 -2
  53. package/dest/job_coordinator/job_coordinator.d.ts.map +1 -1
  54. package/dest/job_coordinator/job_coordinator.js +3 -2
  55. package/dest/logs/log_service.d.ts +3 -2
  56. package/dest/logs/log_service.d.ts.map +1 -1
  57. package/dest/logs/log_service.js +19 -13
  58. package/dest/notes/note_service.d.ts +4 -3
  59. package/dest/notes/note_service.d.ts.map +1 -1
  60. package/dest/notes/note_service.js +11 -10
  61. package/dest/oracle_version.d.ts +3 -3
  62. package/dest/oracle_version.d.ts.map +1 -1
  63. package/dest/oracle_version.js +4 -3
  64. package/dest/private_kernel/private_kernel_execution_prover.d.ts +3 -2
  65. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  66. package/dest/private_kernel/private_kernel_execution_prover.js +2 -2
  67. package/dest/private_kernel/private_kernel_oracle.d.ts +3 -3
  68. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  69. package/dest/pxe.d.ts +1 -1
  70. package/dest/pxe.d.ts.map +1 -1
  71. package/dest/pxe.js +18 -14
  72. package/dest/storage/contract_store/contract_store.d.ts +1 -2
  73. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  74. package/dest/storage/contract_store/contract_store.js +0 -12
  75. package/dest/storage/note_store/note_store.d.ts +43 -55
  76. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  77. package/dest/storage/note_store/note_store.js +235 -251
  78. package/dest/storage/note_store/stored_note.d.ts +16 -0
  79. package/dest/storage/note_store/stored_note.d.ts.map +1 -0
  80. package/dest/storage/note_store/stored_note.js +43 -0
  81. package/dest/storage/private_event_store/private_event_store.d.ts +17 -4
  82. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  83. package/dest/storage/private_event_store/private_event_store.js +158 -132
  84. package/dest/storage/private_event_store/stored_private_event.d.ts +23 -0
  85. package/dest/storage/private_event_store/stored_private_event.d.ts.map +1 -0
  86. package/dest/storage/private_event_store/stored_private_event.js +56 -0
  87. package/dest/tagging/get_all_logs_by_tags.d.ts +24 -0
  88. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -0
  89. package/dest/tagging/get_all_logs_by_tags.js +46 -0
  90. package/dest/tagging/index.d.ts +2 -1
  91. package/dest/tagging/index.d.ts.map +1 -1
  92. package/dest/tagging/index.js +1 -0
  93. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +3 -2
  94. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  95. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +2 -2
  96. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +3 -2
  97. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  98. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +5 -2
  99. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +3 -2
  100. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  101. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +2 -2
  102. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +1 -1
  103. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  104. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +5 -8
  105. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +3 -2
  106. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  107. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +7 -4
  108. package/package.json +16 -16
  109. package/src/bin/check_oracle_version.ts +1 -0
  110. package/src/block_synchronizer/block_synchronizer.ts +70 -33
  111. package/src/config/index.ts +14 -0
  112. package/src/contract_function_simulator/contract_function_simulator.ts +7 -11
  113. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  114. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  115. package/src/contract_function_simulator/oracle/interfaces.ts +18 -9
  116. package/src/contract_function_simulator/oracle/oracle.ts +34 -21
  117. package/src/contract_function_simulator/oracle/private_execution.ts +1 -60
  118. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +32 -6
  119. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +55 -45
  120. package/src/contract_sync/index.ts +98 -0
  121. package/src/debug/pxe_debug_utils.ts +26 -11
  122. package/src/entrypoints/client/bundle/utils.ts +4 -13
  123. package/src/entrypoints/client/lazy/utils.ts +5 -13
  124. package/src/entrypoints/pxe_creation_options.ts +2 -1
  125. package/src/entrypoints/server/index.ts +1 -0
  126. package/src/entrypoints/server/utils.ts +15 -19
  127. package/src/events/event_service.ts +1 -1
  128. package/src/job_coordinator/job_coordinator.ts +4 -3
  129. package/src/logs/log_service.ts +30 -11
  130. package/src/notes/note_service.ts +18 -15
  131. package/src/oracle_version.ts +4 -3
  132. package/src/private_kernel/private_kernel_execution_prover.ts +6 -3
  133. package/src/private_kernel/private_kernel_oracle.ts +2 -2
  134. package/src/pxe.ts +48 -16
  135. package/src/storage/contract_store/contract_store.ts +0 -20
  136. package/src/storage/note_store/note_store.ts +273 -312
  137. package/src/storage/note_store/stored_note.ts +48 -0
  138. package/src/storage/private_event_store/private_event_store.ts +204 -167
  139. package/src/storage/private_event_store/stored_private_event.ts +73 -0
  140. package/src/tagging/get_all_logs_by_tags.ts +68 -0
  141. package/src/tagging/index.ts +1 -0
  142. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +11 -1
  143. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +7 -1
  144. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +3 -1
  145. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +5 -17
  146. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +12 -3
  147. package/dest/tree_membership/tree_membership_service.d.ts +0 -50
  148. package/dest/tree_membership/tree_membership_service.d.ts.map +0 -1
  149. package/dest/tree_membership/tree_membership_service.js +0 -75
  150. package/src/tree_membership/tree_membership_service.ts +0 -97
@@ -1,317 +1,301 @@
1
1
  import { toArray } from '@aztec/foundation/iterable';
2
- import { AztecAddress } from '@aztec/stdlib/aztec-address';
2
+ import { Semaphore } from '@aztec/foundation/queue';
3
3
  import { NoteStatus } from '@aztec/stdlib/note';
4
- import { NoteDao } from '@aztec/stdlib/note';
4
+ import { StoredNote } from './stored_note.js';
5
5
  /**
6
6
  * NoteStore manages the storage and retrieval of notes.
7
7
  *
8
- * Notes can be active or nullified. This class processes new notes, nullifications,
9
- * and performs rollback handling in the case of a reorg.
8
+ * Notes can be active or nullified. This class processes new notes, nullifications, and performs rollback handling in
9
+ * the case of a reorg.
10
10
  **/ export class NoteStore {
11
- #store;
11
+ storeName = 'note';
12
12
  // Note that we use the siloedNullifier as the note id in the store as it's guaranteed to be unique.
13
- /** noteId (siloedNullifier) -> NoteDao (serialized) */ #notes;
14
- /** noteId (siloedNullifier) -> NoteDao (serialized) */ #nullifiedNotes;
15
- /** blockNumber -> siloedNullifier */ #nullifiersByBlockNumber;
16
- /** noteId (siloedNullifier) -> scope */ #nullifiedNotesToScope;
17
- /** contractAddress -> noteId (siloedNullifier) */ #nullifiedNotesByContract;
18
- /** storageSlot -> noteId (siloedNullifier) */ #nullifiedNotesByStorageSlot;
19
- /** scope (AztecAddress) -> true */ #scopes;
20
- /** noteId (siloedNullifier) -> scope */ #notesToScope;
21
- /** scope -> MultiMap(contractAddress -> noteId) */ #notesByContractAndScope;
22
- /** scope -> MultiMap(storageSlot -> noteId) */ #notesByStorageSlotAndScope;
13
+ // Main storage for notes. Avoid performing full scans on it as it contains all notes PXE knows, use
14
+ // #nullifiersByContractAddress or #nullifiersByNullificationBlockNumber to find relevant note nullifiers that can be
15
+ // used to read into this map instead.
16
+ // nullifier => StoredNote (serialized)
17
+ #notes;
18
+ // Indexes which notes (via their nullifiers) belong to a contract. Used in `getNotes` to reduce the amount of notes
19
+ // checked.
20
+ // contract address => nullifier
21
+ #nullifiersByContractAddress;
22
+ // Groups note nullifiers by the block number they were added to the nullifier tree. Used in `rollback` to handle
23
+ // re-orgs.
24
+ // block number => nullifier (block number in which nullifier is included)
25
+ #nullifiersByNullificationBlockNumber;
26
+ // In-memory changes performed during a not-yet committed job. When `commit` is called with said job's id, these
27
+ // changes are persisted in the DB maps specified above and cleared.
28
+ // jobId => nullifier => StoredNote (serialized)
29
+ #notesForJob;
30
+ // Per job locks to prevent multiple concurrent writes to affect each other.
31
+ // jobId => lock
32
+ #jobLocks;
23
33
  constructor(store){
24
- this.#store = store;
25
34
  this.#notes = store.openMap('notes');
26
- this.#nullifiedNotes = store.openMap('nullified_notes');
27
- this.#nullifiersByBlockNumber = store.openMultiMap('nullifier_to_block_number');
28
- this.#nullifiedNotesToScope = store.openMultiMap('nullified_notes_to_scope');
29
- this.#nullifiedNotesByContract = store.openMultiMap('nullified_notes_by_contract');
30
- this.#nullifiedNotesByStorageSlot = store.openMultiMap('nullified_notes_by_storage_slot');
31
- this.#scopes = store.openMap('scopes');
32
- this.#notesToScope = store.openMultiMap('notes_to_scope');
33
- this.#notesByContractAndScope = new Map();
34
- this.#notesByStorageSlotAndScope = new Map();
35
+ this.#nullifiersByContractAddress = store.openMultiMap('note_nullifiers_by_contract');
36
+ this.#nullifiersByNullificationBlockNumber = store.openMultiMap('note_block_number_to_nullifier');
37
+ this.#jobLocks = new Map();
38
+ this.#notesForJob = new Map();
35
39
  }
36
40
  /**
37
- * Creates and initializes a new NoteStore instance.
41
+ * Adds multiple notes to the notes store under the specified scope.
38
42
  *
39
- * This factory method creates a NoteStore and restores any existing
40
- * scope-specific indexes from the database.
43
+ * Notes are stored using their siloedNullifier as the key, which provides uniqueness. Each note is indexed by
44
+ * multiple criteria for efficient retrieval.
41
45
  *
42
- * @param store - The key-value store to use for persistence
43
- * @returns Promise resolving to a fully initialized NoteStore instance
44
- */ static async create(store) {
45
- const pxeDB = new NoteStore(store);
46
- for await (const scope of pxeDB.#scopes.keysAsync()){
47
- pxeDB.#notesByContractAndScope.set(scope, store.openMultiMap(`${scope}:notes_by_contract`));
48
- pxeDB.#notesByStorageSlotAndScope.set(scope, store.openMultiMap(`${scope}:notes_by_storage_slot`));
46
+ * @param notes - Notes to store
47
+ * @param scope - The scope (user/account) under which to store the notes
48
+ * @param jobId - The job context for staged writes
49
+ */ addNotes(notes, scope, jobId) {
50
+ return this.#withJobLock(jobId, ()=>Promise.all(notes.map((noteDao)=>this.#addNote(noteDao, scope, jobId))));
51
+ }
52
+ async #addNote(note, scope, jobId) {
53
+ const noteForJob = await this.#readNote(note.siloedNullifier.toString(), jobId) ?? new StoredNote(note, new Set());
54
+ // Make sure the note is linked to the scope and staged for this job
55
+ noteForJob.addScope(scope.toString());
56
+ this.#writeNote(noteForJob, jobId);
57
+ }
58
+ async #readNote(nullifier, jobId) {
59
+ // First check staged notes for this job
60
+ const noteForJob = this.#getNotesForJob(jobId).get(nullifier);
61
+ if (noteForJob) {
62
+ return noteForJob;
49
63
  }
50
- return pxeDB;
64
+ // Then check persistent storage
65
+ const noteBuffer = await this.#notes.getAsync(nullifier);
66
+ if (noteBuffer) {
67
+ return StoredNote.fromBuffer(noteBuffer);
68
+ }
69
+ return undefined;
70
+ }
71
+ #writeNote(note, jobId) {
72
+ this.#getNotesForJob(jobId).set(note.noteDao.siloedNullifier.toString(), note);
51
73
  }
52
74
  /**
53
- * Adds a new scope to the note data provider.
75
+ * Retrieves notes based on the provided filter criteria.
54
76
  *
55
- * Scopes provide privacy isolation by creating separate indexes for each user.
56
- * Each scope gets its own set of indexes for efficient note retrieval by various criteria.
77
+ * This method queries both active and optionally nullified notes based on the filter parameters.
57
78
  *
58
- * @param scope - The AztecAddress representing the scope/user to add
59
- * @returns Promise resolving to true if scope was added, false if it already existed
60
- */ async addScope(scope) {
61
- const scopeString = scope.toString();
62
- if (await this.#scopes.hasAsync(scopeString)) {
63
- return false;
79
+ * @param filter - Filter criteria including contractAddress (required), and optional owner,
80
+ * storageSlot, status, scopes, and siloedNullifier.
81
+ * @params jobId - the job context to read from.
82
+ * @returns Filtered and deduplicated notes (a note might be present in multiple scopes - we ensure it is only
83
+ * returned once if this is the case)
84
+ * @throws If filtering by an empty scopes array. Scopes have to be set to undefined or to a non-empty array.
85
+ */ async getNotes(filter, jobId) {
86
+ if (filter.scopes !== undefined && filter.scopes.length === 0) {
87
+ throw new Error('Trying to get notes with an empty scopes array');
64
88
  }
65
- await this.#scopes.set(scopeString, true);
66
- this.#notesByContractAndScope.set(scopeString, this.#store.openMultiMap(`${scopeString}:notes_by_contract`));
67
- this.#notesByStorageSlotAndScope.set(scopeString, this.#store.openMultiMap(`${scopeString}:notes_by_storage_slot`));
68
- return true;
89
+ const targetStatus = filter.status ?? NoteStatus.ACTIVE;
90
+ const foundNotes = new Map();
91
+ const nullifiersOfContract = await this.#nullifiersOfContract(filter.contractAddress, jobId);
92
+ for (const nullifier of nullifiersOfContract){
93
+ const note = await this.#readNote(nullifier, jobId);
94
+ // Defensive: hitting this case means we're mishandling contract indices or in-memory job data
95
+ if (!note) {
96
+ throw new Error('PXE note database is corrupted.');
97
+ }
98
+ // Apply filters
99
+ if (targetStatus === NoteStatus.ACTIVE && note.isNullified()) {
100
+ continue;
101
+ }
102
+ if (filter.owner && !note.noteDao.owner.equals(filter.owner)) {
103
+ continue;
104
+ }
105
+ if (filter.storageSlot && !note.noteDao.storageSlot.equals(filter.storageSlot)) {
106
+ continue;
107
+ }
108
+ if (filter.siloedNullifier && !note.noteDao.siloedNullifier.equals(filter.siloedNullifier)) {
109
+ continue;
110
+ }
111
+ if (filter.scopes && note.scopes.intersection(new Set(filter.scopes.map((s)=>s.toString()))).size === 0) {
112
+ continue;
113
+ }
114
+ foundNotes.set(note.noteDao.siloedNullifier.toString(), note.noteDao);
115
+ }
116
+ // Sort by block number, then by tx index within block, then by note index within tx
117
+ return [
118
+ ...foundNotes.values()
119
+ ].sort((a, b)=>{
120
+ if (a.l2BlockNumber !== b.l2BlockNumber) {
121
+ return a.l2BlockNumber - b.l2BlockNumber;
122
+ }
123
+ if (a.txIndexInBlock !== b.txIndexInBlock) {
124
+ return a.txIndexInBlock - b.txIndexInBlock;
125
+ }
126
+ return a.noteIndexInTx - b.noteIndexInTx;
127
+ });
69
128
  }
70
129
  /**
71
- * Adds multiple notes to the data provider under the specified scope.
130
+ * Transitions notes from "active" to "nullified" state.
72
131
  *
73
- * Notes are stored using their siloedNullifier as the key, which provides uniqueness. Each note is indexed
74
- * by multiple criteria for efficient retrieval.
132
+ * This operation processes a batch of nullifiers to mark the corresponding notes as spent/nullified.
133
+ * The operation is atomic - if any nullifier is not found, the entire operation fails and no notes are modified.
75
134
  *
76
- * @param notes - Notes to store
77
- * @param scope - The scope (user/account) under which to store the notes
78
- */ addNotes(notes, scope) {
79
- return this.#store.transactionAsync(async ()=>{
80
- if (!await this.#scopes.hasAsync(scope.toString())) {
81
- await this.addScope(scope);
135
+ * applyNullifiers is idempotent: the same nullifier can be applied multiple times without error.
136
+ * This relaxes constraints on usage of NoteService#validateAndStoreNote, which can then be run concurrently in a Promise.all
137
+ * context without risking unnecessarily defensive checks failing.
138
+ *
139
+ * @param nullifiers - Array of nullifiers with their block numbers to process
140
+ * @param jobId - The job context for staged writes
141
+ * @returns Array of NoteDao objects that were nullified
142
+ * @throws Error if any nullifier is not found in this notes store
143
+ */ applyNullifiers(nullifiers, jobId) {
144
+ return this.#withJobLock(jobId, async ()=>{
145
+ if (nullifiers.length === 0) {
146
+ return [];
82
147
  }
83
- for (const dao of notes){
84
- const noteId = dao.siloedNullifier.toString();
85
- await this.#notes.set(noteId, dao.toBuffer());
86
- await this.#notesToScope.set(noteId, scope.toString());
87
- await this.#notesByContractAndScope.get(scope.toString()).set(dao.contractAddress.toString(), noteId);
88
- await this.#notesByStorageSlotAndScope.get(scope.toString()).set(dao.storageSlot.toString(), noteId);
148
+ const notesToNullify = await Promise.all(nullifiers.map(async (nullifierInBlock)=>{
149
+ const nullifier = nullifierInBlock.data.toString();
150
+ const storedNote = await this.#readNote(nullifier, jobId);
151
+ if (!storedNote) {
152
+ throw new Error(`Attempted to mark a note as nullified which does not exist in PXE DB`);
153
+ }
154
+ return {
155
+ storedNote: await this.#readNote(nullifier, jobId),
156
+ blockNumber: nullifierInBlock.l2BlockNumber
157
+ };
158
+ }));
159
+ const notesNullifiedInThisCall = new Map();
160
+ for (const noteToNullify of notesToNullify){
161
+ // Safe to coerce (!) because we throw if we find any undefined above
162
+ const note = noteToNullify.storedNote;
163
+ // Skip already nullified notes
164
+ if (note.isNullified()) {
165
+ continue;
166
+ }
167
+ note.markAsNullified(noteToNullify.blockNumber);
168
+ this.#writeNote(note, jobId);
169
+ notesNullifiedInThisCall.set(note.noteDao.siloedNullifier.toString(), note.noteDao);
89
170
  }
171
+ return [
172
+ ...notesNullifiedInThisCall.values()
173
+ ];
90
174
  });
91
175
  }
92
176
  /**
93
177
  * Synchronizes notes and nullifiers to a specific block number.
94
178
  *
95
- * This method ensures that the state of notes and nullifiers is consistent with the
96
- * specified block number. It restores any notes that were nullified after the given block
97
- * and deletes any active notes created after that block.
179
+ * This method ensures that the state of notes and nullifiers is consistent with the specified block number.
180
+ * It restores any notes that were nullified after the given block and deletes any active notes created after that
181
+ * block.
98
182
  *
99
183
  * IMPORTANT: This method must be called within a transaction to ensure atomicity.
100
184
  *
101
185
  * @param blockNumber - The new chain tip after a reorg
102
186
  * @param synchedBlockNumber - The block number up to which PXE managed to sync before the reorg happened.
103
187
  */ async rollback(blockNumber, synchedBlockNumber) {
104
- await this.#rewindNullifiersAfterBlock(blockNumber, synchedBlockNumber);
188
+ if (this.#notesForJob.size > 0) {
189
+ throw new Error('PXE note store rollback is not allowed while jobs are running');
190
+ }
191
+ await this.#rewindNullifiedNotesAfterBlock(blockNumber, synchedBlockNumber);
105
192
  await this.#deleteActiveNotesAfterBlock(blockNumber);
106
193
  }
107
194
  /**
108
- * Deletes (removes) all active notes created after the specified block number.
195
+ * Deletes (removes) all notes created after the specified block number.
109
196
  *
110
- * Permanently delete notes from the active notes store, e.g. during a reorg.
111
- * Note: This only affects #notes (active notes), not #nullifiedNotes.
197
+ * Permanently delete notes from the notes store, e.g. during a reorg.
112
198
  *
113
199
  * @param blockNumber - Notes created after this block number will be deleted
114
200
  */ async #deleteActiveNotesAfterBlock(blockNumber) {
115
201
  const notes = await toArray(this.#notes.valuesAsync());
116
- for (const note of notes){
117
- const noteDao = NoteDao.fromBuffer(note);
118
- if (noteDao.l2BlockNumber > blockNumber) {
119
- const noteId = noteDao.siloedNullifier.toString();
120
- await this.#notes.delete(noteId);
121
- await this.#notesToScope.delete(noteId);
122
- const scopes = await toArray(this.#scopes.keysAsync());
123
- for (const scope of scopes){
124
- await this.#notesByContractAndScope.get(scope).deleteValue(noteDao.contractAddress.toString(), noteId);
125
- await this.#notesByStorageSlotAndScope.get(scope).deleteValue(noteDao.storageSlot.toString(), noteId);
126
- }
202
+ for (const noteBuffer of notes){
203
+ const storedNote = StoredNote.fromBuffer(noteBuffer);
204
+ if (storedNote.noteDao.l2BlockNumber > blockNumber) {
205
+ const noteNullifier = storedNote.noteDao.siloedNullifier.toString();
206
+ await this.#notes.delete(noteNullifier);
207
+ await this.#nullifiersByContractAddress.deleteValue(storedNote.noteDao.contractAddress.toString(), noteNullifier);
127
208
  }
128
209
  }
129
210
  }
130
211
  /**
131
212
  * Rewinds nullifications after a given block number.
132
213
  *
133
- * This operation "unnullifies" notes, rolling back nullifications that occurred
134
- * in orphaned blocks, e.g. during a reorg. The notes are restored to the
135
- * active notes store and removed from the nullified store.
214
+ * This operation "un-nullifies" notes, rolling back nullifications that occurred in orphaned blocks, e.g. during a
215
+ * reorg.
136
216
  *
137
217
  * @param blockNumber - Revert nullifications that occurred after this block
138
- * @param synchedBlockNumber - Upper bound for the block range to process
139
- */ async #rewindNullifiersAfterBlock(blockNumber, synchedBlockNumber) {
140
- const noteIdsToReinsert = [];
218
+ * @param anchorBlockNumber - Upper bound for the block range to process
219
+ */ async #rewindNullifiedNotesAfterBlock(blockNumber, anchorBlockNumber) {
141
220
  const currentBlockNumber = blockNumber + 1;
142
- for(let i = currentBlockNumber; i <= synchedBlockNumber; i++){
143
- // noteId === siloedNullifier.toString(), so we can use nullifiers directly as noteIds
144
- noteIdsToReinsert.push(...await toArray(this.#nullifiersByBlockNumber.getValuesAsync(i)));
145
- }
146
- const nullifiedNoteBuffers = await Promise.all(noteIdsToReinsert.map((noteId)=>this.#nullifiedNotes.getAsync(noteId)));
147
- const noteDaos = nullifiedNoteBuffers.filter((buffer)=>buffer != undefined).map((buffer)=>NoteDao.fromBuffer(buffer));
148
- for (const dao of noteDaos){
149
- const noteId = dao.siloedNullifier.toString();
150
- const scopes = await toArray(this.#nullifiedNotesToScope.getValuesAsync(noteId));
151
- if (scopes.length === 0) {
152
- // We should never run into this error because notes always have a scope assigned to them - either on initial
153
- // insertion via `addNotes` or when removing their nullifiers.
154
- throw new Error(`No scopes found for nullified note with nullifier ${noteId}`);
155
- }
156
- for (const scope of scopes){
221
+ for(let i = currentBlockNumber; i <= anchorBlockNumber; i++){
222
+ const noteNullifiersToReinsert = await toArray(this.#nullifiersByNullificationBlockNumber.getValuesAsync(i));
223
+ const nullifiedNoteBuffers = await Promise.all(noteNullifiersToReinsert.map(async (noteNullifier)=>{
224
+ const note = await this.#notes.getAsync(noteNullifier);
225
+ if (!note) {
226
+ throw new Error(`PXE DB integrity error: no note found with nullifier ${noteNullifier}`);
227
+ }
228
+ return note;
229
+ }));
230
+ const storedNotes = nullifiedNoteBuffers.map((buffer)=>StoredNote.fromBuffer(buffer));
231
+ for (const storedNote of storedNotes){
232
+ const noteNullifier = storedNote.noteDao.siloedNullifier.toString();
233
+ const scopes = storedNote.scopes;
234
+ if (scopes.size === 0) {
235
+ // We should never run into this error because notes always have a scope assigned to them - either on initial
236
+ // insertion via `addNotes` or when removing their nullifiers.
237
+ throw new Error(`No scopes found for nullified note with nullifier ${noteNullifier}`);
238
+ }
239
+ storedNote.markAsActive();
157
240
  await Promise.all([
158
- this.#notesByContractAndScope.get(scope.toString()).set(dao.contractAddress.toString(), noteId),
159
- this.#notesByStorageSlotAndScope.get(scope.toString()).set(dao.storageSlot.toString(), noteId),
160
- this.#notesToScope.set(noteId, scope)
241
+ this.#notes.set(noteNullifier, storedNote.toBuffer()),
242
+ this.#nullifiersByNullificationBlockNumber.deleteValue(i, noteNullifier)
161
243
  ]);
162
244
  }
163
- await Promise.all([
164
- this.#notes.set(noteId, dao.toBuffer()),
165
- this.#nullifiedNotes.delete(noteId),
166
- this.#nullifiedNotesToScope.delete(noteId),
167
- this.#nullifiersByBlockNumber.deleteValue(dao.l2BlockNumber, dao.siloedNullifier.toString()),
168
- this.#nullifiedNotesByContract.deleteValue(dao.contractAddress.toString(), noteId),
169
- this.#nullifiedNotesByStorageSlot.deleteValue(dao.storageSlot.toString(), noteId)
170
- ]);
171
245
  }
172
246
  }
173
- /**
174
- * Retrieves notes based on the provided filter criteria.
175
- *
176
- * This method queries both active and optionally nullified notes based on the filter
177
- * parameters.
178
- *
179
- * @param filter - Filter criteria including contractAddress (required), and optional
180
- * owner, storageSlot, status, scopes, and siloedNullifier.
181
- * @returns Filtered and deduplicated notes (a note might be present in multiple scopes - we ensure it is only
182
- * returned once if this is the case)
183
- * @throws If filtering by an empty scopes array. Scopes have to be set to undefined or to a non-empty array.
184
- */ async getNotes(filter) {
185
- filter.status = filter.status ?? NoteStatus.ACTIVE;
186
- // throw early if scopes is an empty array
187
- if (filter.scopes !== undefined && filter.scopes.length === 0) {
188
- throw new Error('Trying to get notes with an empty scopes array. Scopes have to be set to undefined if intending on not filtering by scopes.');
189
- }
190
- const candidateNoteSources = [];
191
- filter.scopes ??= (await toArray(this.#scopes.keysAsync())).map((addressString)=>AztecAddress.fromString(addressString));
192
- const activeNoteIdsPerScope = [];
193
- for (const scope of new Set(filter.scopes)){
194
- const formattedScopeString = scope.toString();
195
- if (!await this.#scopes.hasAsync(formattedScopeString)) {
196
- throw new Error('Trying to get incoming notes of a scope that is not in the PXE database');
197
- }
198
- activeNoteIdsPerScope.push(filter.storageSlot ? await toArray(this.#notesByStorageSlotAndScope.get(formattedScopeString).getValuesAsync(filter.storageSlot.toString())) : await toArray(this.#notesByContractAndScope.get(formattedScopeString).getValuesAsync(filter.contractAddress.toString())));
199
- }
200
- candidateNoteSources.push({
201
- ids: new Set(activeNoteIdsPerScope.flat()),
202
- notes: this.#notes
203
- });
204
- // If status is ACTIVE_OR_NULLIFIED we add nullified notes as candidates on top of the default active ones.
205
- if (filter.status === NoteStatus.ACTIVE_OR_NULLIFIED) {
206
- const nullifiedIds = filter.storageSlot ? await toArray(this.#nullifiedNotesByStorageSlot.getValuesAsync(filter.storageSlot.toString())) : await toArray(this.#nullifiedNotesByContract.getValuesAsync(filter.contractAddress.toString()));
207
- const setOfScopes = new Set(filter.scopes.map((s)=>s.toString()));
208
- const filteredNullifiedIds = new Set();
209
- for (const noteId of nullifiedIds){
210
- const scopeList = await toArray(this.#nullifiedNotesToScope.getValuesAsync(noteId));
211
- if (scopeList.some((scope)=>setOfScopes.has(scope))) {
212
- filteredNullifiedIds.add(noteId);
213
- }
214
- }
215
- if (filteredNullifiedIds.size > 0) {
216
- candidateNoteSources.push({
217
- ids: filteredNullifiedIds,
218
- notes: this.#nullifiedNotes
219
- });
220
- }
221
- }
222
- const result = [];
223
- for (const { ids, notes } of candidateNoteSources){
224
- for (const id of ids){
225
- const serializedNote = await notes.getAsync(id);
226
- if (!serializedNote) {
227
- continue;
228
- }
229
- const note = NoteDao.fromBuffer(serializedNote);
230
- if (!note.contractAddress.equals(filter.contractAddress)) {
231
- continue;
232
- }
233
- if (filter.owner && !note.owner.equals(filter.owner)) {
234
- continue;
235
- }
236
- if (filter.storageSlot && !note.storageSlot.equals(filter.storageSlot)) {
237
- continue;
238
- }
239
- if (filter.siloedNullifier && !note.siloedNullifier.equals(filter.siloedNullifier)) {
240
- continue;
247
+ commit(jobId) {
248
+ return this.#withJobLock(jobId, async ()=>{
249
+ for (const [nullifier, storedNote] of this.#getNotesForJob(jobId)){
250
+ await this.#notes.set(nullifier, storedNote.toBuffer());
251
+ await this.#nullifiersByContractAddress.set(storedNote.noteDao.contractAddress.toString(), nullifier);
252
+ if (storedNote.nullifiedAt !== undefined) {
253
+ await this.#nullifiersByNullificationBlockNumber.set(storedNote.nullifiedAt, nullifier);
241
254
  }
242
- result.push(note);
243
- }
244
- }
245
- // A note might be present in multiple scopes - we ensure it is only returned once
246
- const deduplicated = [];
247
- for (const note of result){
248
- if (!deduplicated.some((existing)=>existing.equals(note))) {
249
- deduplicated.push(note);
250
- }
251
- }
252
- // Sort by block number, then by tx index within block, then by note index within tx
253
- deduplicated.sort((a, b)=>{
254
- if (a.l2BlockNumber !== b.l2BlockNumber) {
255
- return a.l2BlockNumber - b.l2BlockNumber;
256
- }
257
- if (a.txIndexInBlock !== b.txIndexInBlock) {
258
- return a.txIndexInBlock - b.txIndexInBlock;
259
255
  }
260
- return a.noteIndexInTx - b.noteIndexInTx;
256
+ this.#clearJobData(jobId);
261
257
  });
262
- return deduplicated;
258
+ }
259
+ discardStaged(jobId) {
260
+ return this.#withJobLock(jobId, ()=>Promise.resolve(this.#clearJobData(jobId)));
261
+ }
262
+ #clearJobData(jobId) {
263
+ this.#notesForJob.delete(jobId);
264
+ this.#jobLocks.delete(jobId);
263
265
  }
264
266
  /**
265
- * Transitions notes from "active" to "nullified" state.
266
- *
267
- * This operation processes a batch of nullifiers to mark the corresponding notes
268
- * as spent/nullified. The operation is atomic - if any nullifier is not found,
269
- * the entire operation fails and no notes are modified.
270
- *
271
- * @param nullifiers - Array of nullifiers with their block numbers to process
272
- * @returns Promise resolving to array of nullified NoteDao objects
273
- * @throws Error if any nullifier is not found in the active notes
274
- */ applyNullifiers(nullifiers) {
275
- if (nullifiers.length === 0) {
276
- return Promise.resolve([]);
267
+ * Functions run withJobLock are forced to wait for each other, i.e. if they share a `jobId`, they run serially
268
+ * instead of concurrently. This is needed because staged data is stored in memory, and concurrent async operations
269
+ * (e.g., Promise.all in `validateAndStoreNote`) could otherwise interleave and corrupt state.
270
+ */ async #withJobLock(jobId, fn) {
271
+ let lock = this.#jobLocks.get(jobId);
272
+ if (!lock) {
273
+ lock = new Semaphore(1);
274
+ this.#jobLocks.set(jobId, lock);
277
275
  }
278
- return this.#store.transactionAsync(async ()=>{
279
- const nullifiedNotes = [];
280
- for (const blockScopedNullifier of nullifiers){
281
- const { data: nullifier, l2BlockNumber: blockNumber } = blockScopedNullifier;
282
- const noteId = nullifier.toString();
283
- const noteBuffer = await this.#notes.getAsync(noteId);
284
- if (!noteBuffer) {
285
- // Check if already nullified (noteId === siloedNullifier, so we can check #nullifiedNotes directly)
286
- if (await this.#nullifiedNotes.hasAsync(noteId)) {
287
- throw new Error(`Nullifier already applied in applyNullifiers`);
288
- }
289
- throw new Error('Nullifier not found in applyNullifiers');
290
- }
291
- const noteScopes = await toArray(this.#notesToScope.getValuesAsync(noteId));
292
- if (noteScopes.length === 0) {
293
- // We should never run into this error because notes always have a scope assigned to them - either on initial
294
- // insertion via `addNotes` or when removing their nullifiers.
295
- throw new Error('Note scopes are missing in applyNullifiers');
296
- }
297
- const note = NoteDao.fromBuffer(noteBuffer);
298
- nullifiedNotes.push(note);
299
- await this.#notes.delete(noteId);
300
- await this.#notesToScope.delete(noteId);
301
- const scopes = await toArray(this.#scopes.keysAsync());
302
- for (const scope of scopes){
303
- await this.#notesByContractAndScope.get(scope).deleteValue(note.contractAddress.toString(), noteId);
304
- await this.#notesByStorageSlotAndScope.get(scope).deleteValue(note.storageSlot.toString(), noteId);
305
- }
306
- for (const scope of noteScopes){
307
- await this.#nullifiedNotesToScope.set(noteId, scope);
308
- }
309
- await this.#nullifiedNotes.set(noteId, note.toBuffer());
310
- await this.#nullifiersByBlockNumber.set(blockNumber, noteId);
311
- await this.#nullifiedNotesByContract.set(note.contractAddress.toString(), noteId);
312
- await this.#nullifiedNotesByStorageSlot.set(note.storageSlot.toString(), noteId);
313
- }
314
- return nullifiedNotes;
315
- });
276
+ await lock.acquire();
277
+ try {
278
+ return await fn();
279
+ } finally{
280
+ lock.release();
281
+ }
282
+ }
283
+ #getNotesForJob(jobId) {
284
+ let notesForJob = this.#notesForJob.get(jobId);
285
+ if (!notesForJob) {
286
+ notesForJob = new Map();
287
+ this.#notesForJob.set(jobId, notesForJob);
288
+ }
289
+ return notesForJob;
290
+ }
291
+ async #nullifiersOfContract(contractAddress, jobId) {
292
+ // Collect persisted nullifiers for this contract
293
+ const persistedNullifiers = await toArray(this.#nullifiersByContractAddress.getValuesAsync(contractAddress.toString()));
294
+ // Collect staged nullifiers from the job where the note's contract matches
295
+ const stagedNullifiers = this.#getNotesForJob(jobId).values().filter((storedNote)=>storedNote.noteDao.contractAddress.equals(contractAddress)).map((storedNote)=>storedNote.noteDao.siloedNullifier.toString());
296
+ return new Set([
297
+ ...persistedNullifiers,
298
+ ...stagedNullifiers
299
+ ]);
316
300
  }
317
301
  }
@@ -0,0 +1,16 @@
1
+ import { BlockNumber } from '@aztec/foundation/branded-types';
2
+ import { NoteDao } from '@aztec/stdlib/note';
3
+ export declare class StoredNote {
4
+ readonly noteDao: NoteDao;
5
+ readonly scopes: Set<string>;
6
+ private _nullifiedAt;
7
+ constructor(noteDao: NoteDao, scopes: Set<string>, _nullifiedAt?: BlockNumber | undefined);
8
+ static fromBuffer(buffer: Buffer): StoredNote;
9
+ toBuffer(): Buffer;
10
+ addScope(scope: string): void;
11
+ markAsNullified(blockNumber: BlockNumber): void;
12
+ markAsActive(): void;
13
+ isNullified(): boolean;
14
+ get nullifiedAt(): BlockNumber | undefined;
15
+ }
16
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcmVkX25vdGUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdG9yYWdlL25vdGVfc3RvcmUvc3RvcmVkX25vdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBRTlELE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUU3QyxxQkFBYSxVQUFVO0lBRW5CLFFBQVEsQ0FBQyxPQUFPLEVBQUUsT0FBTztJQUN6QixRQUFRLENBQUMsTUFBTSxFQUFFLEdBQUcsQ0FBQyxNQUFNLENBQUM7SUFDNUIsT0FBTyxDQUFDLFlBQVk7SUFIdEIsWUFDVyxPQUFPLEVBQUUsT0FBTyxFQUNoQixNQUFNLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxFQUNwQixZQUFZLEdBQUUsV0FBVyxHQUFHLFNBQXFCLEVBQ3ZEO0lBRUosTUFBTSxDQUFDLFVBQVUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxjQVUvQjtJQUVELFFBQVEsSUFBSSxNQUFNLENBR2pCO0lBRUQsUUFBUSxDQUFDLEtBQUssRUFBRSxNQUFNLFFBRXJCO0lBRUQsZUFBZSxDQUFDLFdBQVcsRUFBRSxXQUFXLFFBRXZDO0lBRUQsWUFBWSxTQUVYO0lBRUQsV0FBVyxZQUVWO0lBRUQsSUFBSSxXQUFXLDRCQUVkO0NBQ0YifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stored_note.d.ts","sourceRoot":"","sources":["../../../src/storage/note_store/stored_note.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,qBAAa,UAAU;IAEnB,QAAQ,CAAC,OAAO,EAAE,OAAO;IACzB,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IAC5B,OAAO,CAAC,YAAY;IAHtB,YACW,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,EACpB,YAAY,GAAE,WAAW,GAAG,SAAqB,EACvD;IAEJ,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,cAU/B;IAED,QAAQ,IAAI,MAAM,CAGjB;IAED,QAAQ,CAAC,KAAK,EAAE,MAAM,QAErB;IAED,eAAe,CAAC,WAAW,EAAE,WAAW,QAEvC;IAED,YAAY,SAEX;IAED,WAAW,YAEV;IAED,IAAI,WAAW,4BAEd;CACF"}
@@ -0,0 +1,43 @@
1
+ import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
2
+ import { NoteDao } from '@aztec/stdlib/note';
3
+ export class StoredNote {
4
+ noteDao;
5
+ scopes;
6
+ _nullifiedAt;
7
+ constructor(noteDao, scopes, _nullifiedAt = undefined){
8
+ this.noteDao = noteDao;
9
+ this.scopes = scopes;
10
+ this._nullifiedAt = _nullifiedAt;
11
+ }
12
+ static fromBuffer(buffer) {
13
+ const reader = BufferReader.asReader(buffer);
14
+ const noteDao = NoteDao.fromBuffer(reader);
15
+ const scopes = reader.readVector({
16
+ fromBuffer: (r)=>r.readString()
17
+ });
18
+ const nullifiedAtRaw = reader.readNumber();
19
+ const nullifiedAt = nullifiedAtRaw === 0 ? undefined : nullifiedAtRaw;
20
+ return new StoredNote(noteDao, new Set(scopes), nullifiedAt);
21
+ }
22
+ toBuffer() {
23
+ const scopesArray = [
24
+ ...this.scopes
25
+ ];
26
+ return serializeToBuffer(this.noteDao, scopesArray.length, ...scopesArray, this._nullifiedAt ?? 0);
27
+ }
28
+ addScope(scope) {
29
+ this.scopes.add(scope);
30
+ }
31
+ markAsNullified(blockNumber) {
32
+ this._nullifiedAt = blockNumber;
33
+ }
34
+ markAsActive() {
35
+ this._nullifiedAt = undefined;
36
+ }
37
+ isNullified() {
38
+ return this._nullifiedAt !== undefined;
39
+ }
40
+ get nullifiedAt() {
41
+ return this._nullifiedAt;
42
+ }
43
+ }