@aztec/pxe 0.0.1-commit.d1f2d6c → 0.0.1-commit.d431d1c
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.
- package/dest/block_synchronizer/block_synchronizer.d.ts +4 -6
- package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
- package/dest/block_synchronizer/block_synchronizer.js +11 -51
- package/dest/config/index.d.ts +1 -3
- package/dest/config/index.d.ts.map +1 -1
- package/dest/config/index.js +0 -17
- package/dest/contract_function_simulator/contract_function_simulator.d.ts +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.js +4 -1
- package/dest/contract_function_simulator/oracle/interfaces.d.ts +4 -7
- package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.d.ts +2 -4
- package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.js +9 -19
- package/dest/contract_function_simulator/oracle/private_execution.d.ts +6 -5
- package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution.js +1 -10
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +1 -9
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.js +5 -17
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +6 -14
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +33 -31
- package/dest/debug/pxe_debug_utils.d.ts +1 -1
- package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
- package/dest/debug/pxe_debug_utils.js +1 -2
- package/dest/logs/log_service.d.ts +1 -1
- package/dest/logs/log_service.d.ts.map +1 -1
- package/dest/logs/log_service.js +11 -18
- package/dest/notes/note_service.d.ts +2 -3
- package/dest/notes/note_service.d.ts.map +1 -1
- package/dest/notes/note_service.js +6 -8
- package/dest/oracle_version.d.ts +3 -3
- package/dest/oracle_version.d.ts.map +1 -1
- package/dest/oracle_version.js +3 -4
- package/dest/pxe.d.ts +1 -1
- package/dest/pxe.d.ts.map +1 -1
- package/dest/pxe.js +7 -10
- package/dest/storage/note_store/note_store.d.ts +55 -43
- package/dest/storage/note_store/note_store.d.ts.map +1 -1
- package/dest/storage/note_store/note_store.js +252 -238
- package/dest/storage/private_event_store/private_event_store.d.ts +4 -17
- package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
- package/dest/storage/private_event_store/private_event_store.js +135 -163
- package/dest/tagging/index.d.ts +1 -2
- package/dest/tagging/index.d.ts.map +1 -1
- package/dest/tagging/index.js +0 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +2 -3
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +2 -2
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +2 -3
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +2 -5
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +2 -3
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +2 -2
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +1 -1
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +8 -5
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +2 -3
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +4 -7
- package/dest/tree_membership/tree_membership_service.d.ts +50 -0
- package/dest/tree_membership/tree_membership_service.d.ts.map +1 -0
- package/dest/tree_membership/tree_membership_service.js +75 -0
- package/package.json +16 -16
- package/src/block_synchronizer/block_synchronizer.ts +14 -53
- package/src/config/index.ts +0 -14
- package/src/contract_function_simulator/contract_function_simulator.ts +9 -1
- package/src/contract_function_simulator/oracle/interfaces.ts +3 -12
- package/src/contract_function_simulator/oracle/oracle.ts +13 -26
- package/src/contract_function_simulator/oracle/private_execution.ts +1 -20
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +6 -33
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +38 -46
- package/src/debug/pxe_debug_utils.ts +1 -2
- package/src/logs/log_service.ts +8 -25
- package/src/notes/note_service.ts +11 -15
- package/src/oracle_version.ts +3 -4
- package/src/pxe.ts +8 -32
- package/src/storage/note_store/note_store.ts +313 -279
- package/src/storage/private_event_store/private_event_store.ts +175 -214
- package/src/tagging/index.ts +0 -1
- package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +1 -11
- package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +1 -7
- package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +1 -3
- package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +17 -5
- package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +3 -12
- package/src/tree_membership/tree_membership_service.ts +97 -0
- package/dest/storage/note_store/stored_note.d.ts +0 -16
- package/dest/storage/note_store/stored_note.d.ts.map +0 -1
- package/dest/storage/note_store/stored_note.js +0 -43
- package/dest/storage/private_event_store/stored_private_event.d.ts +0 -23
- package/dest/storage/private_event_store/stored_private_event.d.ts.map +0 -1
- package/dest/storage/private_event_store/stored_private_event.js +0 -56
- package/dest/tagging/get_all_logs_by_tags.d.ts +0 -24
- package/dest/tagging/get_all_logs_by_tags.d.ts.map +0 -1
- package/dest/tagging/get_all_logs_by_tags.js +0 -46
- package/src/storage/note_store/stored_note.ts +0 -48
- package/src/storage/private_event_store/stored_private_event.ts +0 -73
- package/src/tagging/get_all_logs_by_tags.ts +0 -68
|
@@ -1,232 +1,134 @@
|
|
|
1
|
+
import type { Fr } from '@aztec/foundation/curves/bn254';
|
|
1
2
|
import { toArray } from '@aztec/foundation/iterable';
|
|
2
|
-
import { Semaphore } from '@aztec/foundation/queue';
|
|
3
|
-
import type { Fr } from '@aztec/foundation/schemas';
|
|
4
3
|
import type { AztecAsyncKVStore, AztecAsyncMap, AztecAsyncMultiMap } from '@aztec/kv-store';
|
|
5
|
-
import
|
|
4
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
6
5
|
import type { DataInBlock } from '@aztec/stdlib/block';
|
|
7
|
-
import {
|
|
8
|
-
|
|
9
|
-
import type { StagedStore } from '../../job_coordinator/job_coordinator.js';
|
|
10
|
-
import { StoredNote } from './stored_note.js';
|
|
6
|
+
import { NoteStatus, type NotesFilter } from '@aztec/stdlib/note';
|
|
7
|
+
import { NoteDao } from '@aztec/stdlib/note';
|
|
11
8
|
|
|
12
9
|
/**
|
|
13
10
|
* NoteStore manages the storage and retrieval of notes.
|
|
14
11
|
*
|
|
15
|
-
* Notes can be active or nullified. This class processes new notes, nullifications,
|
|
16
|
-
* the case of a reorg.
|
|
12
|
+
* Notes can be active or nullified. This class processes new notes, nullifications,
|
|
13
|
+
* and performs rollback handling in the case of a reorg.
|
|
17
14
|
**/
|
|
18
|
-
export class NoteStore
|
|
19
|
-
readonly storeName: string = 'note';
|
|
20
|
-
|
|
15
|
+
export class NoteStore {
|
|
21
16
|
#store: AztecAsyncKVStore;
|
|
22
17
|
|
|
23
18
|
// Note that we use the siloedNullifier as the note id in the store as it's guaranteed to be unique.
|
|
24
19
|
|
|
25
|
-
|
|
26
|
-
// #nullifiersByContractAddress or #nullifiersByNullificationBlockNumber to find relevant note nullifiers that can be
|
|
27
|
-
// used to read into this map instead.
|
|
28
|
-
// nullifier => StoredNote (serialized)
|
|
20
|
+
/** noteId (siloedNullifier) -> NoteDao (serialized) */
|
|
29
21
|
#notes: AztecAsyncMap<string, Buffer>;
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
22
|
+
/** noteId (siloedNullifier) -> NoteDao (serialized) */
|
|
23
|
+
#nullifiedNotes: AztecAsyncMap<string, Buffer>;
|
|
24
|
+
/** blockNumber -> siloedNullifier */
|
|
25
|
+
#nullifiersByBlockNumber: AztecAsyncMultiMap<number, string>;
|
|
26
|
+
|
|
27
|
+
/** noteId (siloedNullifier) -> scope */
|
|
28
|
+
#nullifiedNotesToScope: AztecAsyncMultiMap<string, string>;
|
|
29
|
+
/** contractAddress -> noteId (siloedNullifier) */
|
|
30
|
+
#nullifiedNotesByContract: AztecAsyncMultiMap<string, string>;
|
|
31
|
+
/** storageSlot -> noteId (siloedNullifier) */
|
|
32
|
+
#nullifiedNotesByStorageSlot: AztecAsyncMultiMap<string, string>;
|
|
33
|
+
|
|
34
|
+
/** scope (AztecAddress) -> true */
|
|
35
|
+
#scopes: AztecAsyncMap<string, true>;
|
|
36
|
+
/** noteId (siloedNullifier) -> scope */
|
|
37
|
+
#notesToScope: AztecAsyncMultiMap<string, string>;
|
|
38
|
+
/** scope -> MultiMap(contractAddress -> noteId) */
|
|
39
|
+
#notesByContractAndScope: Map<string, AztecAsyncMultiMap<string, string>>;
|
|
40
|
+
/** scope -> MultiMap(storageSlot -> noteId) */
|
|
41
|
+
#notesByStorageSlotAndScope: Map<string, AztecAsyncMultiMap<string, string>>;
|
|
42
|
+
|
|
43
|
+
private constructor(store: AztecAsyncKVStore) {
|
|
51
44
|
this.#store = store;
|
|
52
45
|
this.#notes = store.openMap('notes');
|
|
53
|
-
this.#
|
|
54
|
-
this.#
|
|
46
|
+
this.#nullifiedNotes = store.openMap('nullified_notes');
|
|
47
|
+
this.#nullifiersByBlockNumber = store.openMultiMap('nullifier_to_block_number');
|
|
48
|
+
|
|
49
|
+
this.#nullifiedNotesToScope = store.openMultiMap('nullified_notes_to_scope');
|
|
50
|
+
this.#nullifiedNotesByContract = store.openMultiMap('nullified_notes_by_contract');
|
|
51
|
+
this.#nullifiedNotesByStorageSlot = store.openMultiMap('nullified_notes_by_storage_slot');
|
|
55
52
|
|
|
56
|
-
this.#
|
|
57
|
-
this.#
|
|
53
|
+
this.#scopes = store.openMap('scopes');
|
|
54
|
+
this.#notesToScope = store.openMultiMap('notes_to_scope');
|
|
55
|
+
this.#notesByContractAndScope = new Map<string, AztecAsyncMultiMap<string, string>>();
|
|
56
|
+
this.#notesByStorageSlotAndScope = new Map<string, AztecAsyncMultiMap<string, string>>();
|
|
58
57
|
}
|
|
59
58
|
|
|
60
59
|
/**
|
|
61
|
-
*
|
|
60
|
+
* Creates and initializes a new NoteStore instance.
|
|
62
61
|
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
62
|
+
* This factory method creates a NoteStore and restores any existing
|
|
63
|
+
* scope-specific indexes from the database.
|
|
65
64
|
*
|
|
66
|
-
* @param
|
|
67
|
-
* @
|
|
68
|
-
* @param jobId - The job context for staged writes
|
|
65
|
+
* @param store - The key-value store to use for persistence
|
|
66
|
+
* @returns Promise resolving to a fully initialized NoteStore instance
|
|
69
67
|
*/
|
|
70
|
-
public
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
const noteForJob =
|
|
76
|
-
(await this.#readNote(note.siloedNullifier.toString(), jobId)) ?? new StoredNote(note, new Set());
|
|
77
|
-
|
|
78
|
-
// Make sure the note is linked to the scope and staged for this job
|
|
79
|
-
noteForJob.addScope(scope.toString());
|
|
80
|
-
this.#writeNote(noteForJob, jobId);
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
async #readNote(nullifier: string, jobId: string): Promise<StoredNote | undefined> {
|
|
84
|
-
// First check staged notes for this job
|
|
85
|
-
const noteForJob = this.#getNotesForJob(jobId).get(nullifier);
|
|
86
|
-
if (noteForJob) {
|
|
87
|
-
return noteForJob;
|
|
68
|
+
public static async create(store: AztecAsyncKVStore): Promise<NoteStore> {
|
|
69
|
+
const pxeDB = new NoteStore(store);
|
|
70
|
+
for await (const scope of pxeDB.#scopes.keysAsync()) {
|
|
71
|
+
pxeDB.#notesByContractAndScope.set(scope, store.openMultiMap(`${scope}:notes_by_contract`));
|
|
72
|
+
pxeDB.#notesByStorageSlotAndScope.set(scope, store.openMultiMap(`${scope}:notes_by_storage_slot`));
|
|
88
73
|
}
|
|
89
|
-
|
|
90
|
-
// Then check persistent storage
|
|
91
|
-
const noteBuffer = await this.#notes.getAsync(nullifier);
|
|
92
|
-
if (noteBuffer) {
|
|
93
|
-
return StoredNote.fromBuffer(noteBuffer);
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
return undefined;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
#writeNote(note: StoredNote, jobId: string) {
|
|
100
|
-
this.#getNotesForJob(jobId).set(note.noteDao.siloedNullifier.toString(), note);
|
|
74
|
+
return pxeDB;
|
|
101
75
|
}
|
|
102
76
|
|
|
103
77
|
/**
|
|
104
|
-
*
|
|
78
|
+
* Adds a new scope to the note data provider.
|
|
105
79
|
*
|
|
106
|
-
*
|
|
80
|
+
* Scopes provide privacy isolation by creating separate indexes for each user.
|
|
81
|
+
* Each scope gets its own set of indexes for efficient note retrieval by various criteria.
|
|
107
82
|
*
|
|
108
|
-
* @param
|
|
109
|
-
*
|
|
110
|
-
* @params jobId - the job context to read from.
|
|
111
|
-
* @returns Filtered and deduplicated notes (a note might be present in multiple scopes - we ensure it is only
|
|
112
|
-
* returned once if this is the case)
|
|
113
|
-
* @throws If filtering by an empty scopes array. Scopes have to be set to undefined or to a non-empty array.
|
|
83
|
+
* @param scope - The AztecAddress representing the scope/user to add
|
|
84
|
+
* @returns Promise resolving to true if scope was added, false if it already existed
|
|
114
85
|
*/
|
|
115
|
-
async
|
|
116
|
-
|
|
117
|
-
throw new Error('Trying to get notes with an empty scopes array');
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
const targetStatus = filter.status ?? NoteStatus.ACTIVE;
|
|
121
|
-
|
|
122
|
-
const foundNotes: Map<string, NoteDao> = new Map();
|
|
123
|
-
|
|
124
|
-
const nullifiersOfContract = await this.#nullifiersOfContract(filter.contractAddress, jobId);
|
|
125
|
-
for (const nullifier of nullifiersOfContract) {
|
|
126
|
-
const note = await this.#readNote(nullifier, jobId);
|
|
127
|
-
|
|
128
|
-
// Defensive: hitting this case means we're mishandling contract indices or in-memory job data
|
|
129
|
-
if (!note) {
|
|
130
|
-
throw new Error('PXE note database is corrupted.');
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
// Apply filters
|
|
134
|
-
if (targetStatus === NoteStatus.ACTIVE && note.isNullified()) {
|
|
135
|
-
continue;
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
if (filter.owner && !note.noteDao.owner.equals(filter.owner)) {
|
|
139
|
-
continue;
|
|
140
|
-
}
|
|
86
|
+
public async addScope(scope: AztecAddress): Promise<boolean> {
|
|
87
|
+
const scopeString = scope.toString();
|
|
141
88
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
if (filter.siloedNullifier && !note.noteDao.siloedNullifier.equals(filter.siloedNullifier)) {
|
|
147
|
-
continue;
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
if (filter.scopes && note.scopes.intersection(new Set(filter.scopes.map(s => s.toString()))).size === 0) {
|
|
151
|
-
continue;
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
foundNotes.set(note.noteDao.siloedNullifier.toString(), note.noteDao);
|
|
89
|
+
if (await this.#scopes.hasAsync(scopeString)) {
|
|
90
|
+
return false;
|
|
155
91
|
}
|
|
156
92
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
if (a.txIndexInBlock !== b.txIndexInBlock) {
|
|
163
|
-
return a.txIndexInBlock - b.txIndexInBlock;
|
|
164
|
-
}
|
|
165
|
-
return a.noteIndexInTx - b.noteIndexInTx;
|
|
166
|
-
});
|
|
93
|
+
await this.#scopes.set(scopeString, true);
|
|
94
|
+
this.#notesByContractAndScope.set(scopeString, this.#store.openMultiMap(`${scopeString}:notes_by_contract`));
|
|
95
|
+
this.#notesByStorageSlotAndScope.set(scopeString, this.#store.openMultiMap(`${scopeString}:notes_by_storage_slot`));
|
|
96
|
+
|
|
97
|
+
return true;
|
|
167
98
|
}
|
|
168
99
|
|
|
169
100
|
/**
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
* This operation processes a batch of nullifiers to mark the corresponding notes as spent/nullified.
|
|
173
|
-
* The operation is atomic - if any nullifier is not found, the entire operation fails and no notes are modified.
|
|
101
|
+
* Adds multiple notes to the data provider under the specified scope.
|
|
174
102
|
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* context without risking unnecessarily defensive checks failing.
|
|
103
|
+
* Notes are stored using their siloedNullifier as the key, which provides uniqueness. Each note is indexed
|
|
104
|
+
* by multiple criteria for efficient retrieval.
|
|
178
105
|
*
|
|
179
|
-
* @param
|
|
180
|
-
* @param
|
|
181
|
-
* @returns Array of NoteDao objects that were nullified
|
|
182
|
-
* @throws Error if any nullifier is not found in this notes store
|
|
106
|
+
* @param notes - Notes to store
|
|
107
|
+
* @param scope - The scope (user/account) under which to store the notes
|
|
183
108
|
*/
|
|
184
|
-
|
|
185
|
-
return this.#
|
|
186
|
-
this.#
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
const notesToNullify = await Promise.all(
|
|
192
|
-
nullifiers.map(async nullifierInBlock => {
|
|
193
|
-
const nullifier = nullifierInBlock.data.toString();
|
|
194
|
-
|
|
195
|
-
const storedNote = await this.#readNote(nullifier, jobId);
|
|
196
|
-
if (!storedNote) {
|
|
197
|
-
throw new Error(`Attempted to mark a note as nullified which does not exist in PXE DB`);
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
return { storedNote: await this.#readNote(nullifier, jobId), blockNumber: nullifierInBlock.l2BlockNumber };
|
|
201
|
-
}),
|
|
202
|
-
);
|
|
203
|
-
|
|
204
|
-
const notesNullifiedInThisCall: Map<string, NoteDao> = new Map();
|
|
205
|
-
for (const noteToNullify of notesToNullify) {
|
|
206
|
-
// Safe to coerce (!) because we throw if we find any undefined above
|
|
207
|
-
const note = noteToNullify.storedNote!;
|
|
208
|
-
|
|
209
|
-
// Skip already nullified notes
|
|
210
|
-
if (note.isNullified()) {
|
|
211
|
-
continue;
|
|
212
|
-
}
|
|
109
|
+
addNotes(notes: NoteDao[], scope: AztecAddress): Promise<void> {
|
|
110
|
+
return this.#store.transactionAsync(async () => {
|
|
111
|
+
if (!(await this.#scopes.hasAsync(scope.toString()))) {
|
|
112
|
+
await this.addScope(scope);
|
|
113
|
+
}
|
|
213
114
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
115
|
+
for (const dao of notes) {
|
|
116
|
+
const noteId = dao.siloedNullifier.toString();
|
|
117
|
+
await this.#notes.set(noteId, dao.toBuffer());
|
|
118
|
+
await this.#notesToScope.set(noteId, scope.toString());
|
|
218
119
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
120
|
+
await this.#notesByContractAndScope.get(scope.toString())!.set(dao.contractAddress.toString(), noteId);
|
|
121
|
+
await this.#notesByStorageSlotAndScope.get(scope.toString())!.set(dao.storageSlot.toString(), noteId);
|
|
122
|
+
}
|
|
123
|
+
});
|
|
222
124
|
}
|
|
223
125
|
|
|
224
126
|
/**
|
|
225
127
|
* Synchronizes notes and nullifiers to a specific block number.
|
|
226
128
|
*
|
|
227
|
-
* This method ensures that the state of notes and nullifiers is consistent with the
|
|
228
|
-
* It restores any notes that were nullified after the given block
|
|
229
|
-
* block.
|
|
129
|
+
* This method ensures that the state of notes and nullifiers is consistent with the
|
|
130
|
+
* specified block number. It restores any notes that were nullified after the given block
|
|
131
|
+
* and deletes any active notes created after that block.
|
|
230
132
|
*
|
|
231
133
|
* IMPORTANT: This method must be called within a transaction to ensure atomicity.
|
|
232
134
|
*
|
|
@@ -234,31 +136,31 @@ export class NoteStore implements StagedStore {
|
|
|
234
136
|
* @param synchedBlockNumber - The block number up to which PXE managed to sync before the reorg happened.
|
|
235
137
|
*/
|
|
236
138
|
public async rollback(blockNumber: number, synchedBlockNumber: number): Promise<void> {
|
|
237
|
-
|
|
238
|
-
throw new Error('PXE note store rollback is not allowed while jobs are running');
|
|
239
|
-
}
|
|
240
|
-
await this.#rewindNullifiedNotesAfterBlock(blockNumber, synchedBlockNumber);
|
|
139
|
+
await this.#rewindNullifiersAfterBlock(blockNumber, synchedBlockNumber);
|
|
241
140
|
await this.#deleteActiveNotesAfterBlock(blockNumber);
|
|
242
141
|
}
|
|
243
142
|
|
|
244
143
|
/**
|
|
245
|
-
* Deletes (removes) all notes created after the specified block number.
|
|
144
|
+
* Deletes (removes) all active notes created after the specified block number.
|
|
246
145
|
*
|
|
247
|
-
* Permanently delete notes from the notes store, e.g. during a reorg.
|
|
146
|
+
* Permanently delete notes from the active notes store, e.g. during a reorg.
|
|
147
|
+
* Note: This only affects #notes (active notes), not #nullifiedNotes.
|
|
248
148
|
*
|
|
249
149
|
* @param blockNumber - Notes created after this block number will be deleted
|
|
250
150
|
*/
|
|
251
151
|
async #deleteActiveNotesAfterBlock(blockNumber: number): Promise<void> {
|
|
252
152
|
const notes = await toArray(this.#notes.valuesAsync());
|
|
253
|
-
for (const
|
|
254
|
-
const
|
|
255
|
-
if (
|
|
256
|
-
const
|
|
257
|
-
await this.#notes.delete(
|
|
258
|
-
await this.#
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
153
|
+
for (const note of notes) {
|
|
154
|
+
const noteDao = NoteDao.fromBuffer(note);
|
|
155
|
+
if (noteDao.l2BlockNumber > blockNumber) {
|
|
156
|
+
const noteId = noteDao.siloedNullifier.toString();
|
|
157
|
+
await this.#notes.delete(noteId);
|
|
158
|
+
await this.#notesToScope.delete(noteId);
|
|
159
|
+
const scopes = await toArray(this.#scopes.keysAsync());
|
|
160
|
+
for (const scope of scopes) {
|
|
161
|
+
await this.#notesByContractAndScope.get(scope)!.deleteValue(noteDao.contractAddress.toString(), noteId);
|
|
162
|
+
await this.#notesByStorageSlotAndScope.get(scope)!.deleteValue(noteDao.storageSlot.toString(), noteId);
|
|
163
|
+
}
|
|
262
164
|
}
|
|
263
165
|
}
|
|
264
166
|
}
|
|
@@ -266,116 +168,248 @@ export class NoteStore implements StagedStore {
|
|
|
266
168
|
/**
|
|
267
169
|
* Rewinds nullifications after a given block number.
|
|
268
170
|
*
|
|
269
|
-
* This operation "
|
|
270
|
-
* reorg.
|
|
171
|
+
* This operation "unnullifies" notes, rolling back nullifications that occurred
|
|
172
|
+
* in orphaned blocks, e.g. during a reorg. The notes are restored to the
|
|
173
|
+
* active notes store and removed from the nullified store.
|
|
271
174
|
*
|
|
272
175
|
* @param blockNumber - Revert nullifications that occurred after this block
|
|
273
|
-
* @param
|
|
176
|
+
* @param synchedBlockNumber - Upper bound for the block range to process
|
|
274
177
|
*/
|
|
275
|
-
async #
|
|
178
|
+
async #rewindNullifiersAfterBlock(blockNumber: number, synchedBlockNumber: number): Promise<void> {
|
|
179
|
+
const noteIdsToReinsert: string[] = [];
|
|
276
180
|
const currentBlockNumber = blockNumber + 1;
|
|
277
|
-
for (let i = currentBlockNumber; i <=
|
|
278
|
-
|
|
279
|
-
|
|
181
|
+
for (let i = currentBlockNumber; i <= synchedBlockNumber; i++) {
|
|
182
|
+
// noteId === siloedNullifier.toString(), so we can use nullifiers directly as noteIds
|
|
183
|
+
noteIdsToReinsert.push(...(await toArray(this.#nullifiersByBlockNumber.getValuesAsync(i))));
|
|
184
|
+
}
|
|
185
|
+
const nullifiedNoteBuffers = await Promise.all(
|
|
186
|
+
noteIdsToReinsert.map(noteId => this.#nullifiedNotes.getAsync(noteId)),
|
|
187
|
+
);
|
|
188
|
+
const noteDaos = nullifiedNoteBuffers
|
|
189
|
+
.filter(buffer => buffer != undefined)
|
|
190
|
+
.map(buffer => NoteDao.fromBuffer(buffer!));
|
|
191
|
+
|
|
192
|
+
for (const dao of noteDaos) {
|
|
193
|
+
const noteId = dao.siloedNullifier.toString();
|
|
194
|
+
|
|
195
|
+
const scopes = await toArray(this.#nullifiedNotesToScope.getValuesAsync(noteId));
|
|
196
|
+
|
|
197
|
+
if (scopes.length === 0) {
|
|
198
|
+
// We should never run into this error because notes always have a scope assigned to them - either on initial
|
|
199
|
+
// insertion via `addNotes` or when removing their nullifiers.
|
|
200
|
+
throw new Error(`No scopes found for nullified note with nullifier ${noteId}`);
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
for (const scope of scopes) {
|
|
204
|
+
await Promise.all([
|
|
205
|
+
this.#notesByContractAndScope.get(scope.toString())!.set(dao.contractAddress.toString(), noteId),
|
|
206
|
+
this.#notesByStorageSlotAndScope.get(scope.toString())!.set(dao.storageSlot.toString(), noteId),
|
|
207
|
+
this.#notesToScope.set(noteId, scope),
|
|
208
|
+
]);
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
await Promise.all([
|
|
212
|
+
this.#notes.set(noteId, dao.toBuffer()),
|
|
213
|
+
this.#nullifiedNotes.delete(noteId),
|
|
214
|
+
this.#nullifiedNotesToScope.delete(noteId),
|
|
215
|
+
this.#nullifiersByBlockNumber.deleteValue(dao.l2BlockNumber, dao.siloedNullifier.toString()),
|
|
216
|
+
this.#nullifiedNotesByContract.deleteValue(dao.contractAddress.toString(), noteId),
|
|
217
|
+
this.#nullifiedNotesByStorageSlot.deleteValue(dao.storageSlot.toString(), noteId),
|
|
218
|
+
]);
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Retrieves notes based on the provided filter criteria.
|
|
224
|
+
*
|
|
225
|
+
* This method queries both active and optionally nullified notes based on the filter
|
|
226
|
+
* parameters.
|
|
227
|
+
*
|
|
228
|
+
* @param filter - Filter criteria including contractAddress (required), and optional
|
|
229
|
+
* owner, storageSlot, status, scopes, and siloedNullifier.
|
|
230
|
+
* @returns Filtered and deduplicated notes (a note might be present in multiple scopes - we ensure it is only
|
|
231
|
+
* returned once if this is the case)
|
|
232
|
+
* @throws If filtering by an empty scopes array. Scopes have to be set to undefined or to a non-empty array.
|
|
233
|
+
*/
|
|
234
|
+
async getNotes(filter: NotesFilter): Promise<NoteDao[]> {
|
|
235
|
+
filter.status = filter.status ?? NoteStatus.ACTIVE;
|
|
236
|
+
|
|
237
|
+
// throw early if scopes is an empty array
|
|
238
|
+
if (filter.scopes !== undefined && filter.scopes.length === 0) {
|
|
239
|
+
throw new Error(
|
|
240
|
+
'Trying to get notes with an empty scopes array. Scopes have to be set to undefined if intending on not filtering by scopes.',
|
|
280
241
|
);
|
|
242
|
+
}
|
|
281
243
|
|
|
282
|
-
|
|
283
|
-
noteNullifiersToReinsert.map(async noteNullifier => {
|
|
284
|
-
const note = await this.#notes.getAsync(noteNullifier);
|
|
244
|
+
const candidateNoteSources = [];
|
|
285
245
|
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
246
|
+
filter.scopes ??= (await toArray(this.#scopes.keysAsync())).map(addressString =>
|
|
247
|
+
AztecAddress.fromString(addressString),
|
|
248
|
+
);
|
|
249
|
+
|
|
250
|
+
const activeNoteIdsPerScope: string[][] = [];
|
|
251
|
+
|
|
252
|
+
for (const scope of new Set(filter.scopes)) {
|
|
253
|
+
const formattedScopeString = scope.toString();
|
|
254
|
+
if (!(await this.#scopes.hasAsync(formattedScopeString))) {
|
|
255
|
+
throw new Error('Trying to get incoming notes of a scope that is not in the PXE database');
|
|
256
|
+
}
|
|
289
257
|
|
|
290
|
-
|
|
291
|
-
|
|
258
|
+
activeNoteIdsPerScope.push(
|
|
259
|
+
filter.storageSlot
|
|
260
|
+
? await toArray(
|
|
261
|
+
this.#notesByStorageSlotAndScope.get(formattedScopeString)!.getValuesAsync(filter.storageSlot.toString()),
|
|
262
|
+
)
|
|
263
|
+
: await toArray(
|
|
264
|
+
this.#notesByContractAndScope
|
|
265
|
+
.get(formattedScopeString)!
|
|
266
|
+
.getValuesAsync(filter.contractAddress.toString()),
|
|
267
|
+
),
|
|
292
268
|
);
|
|
269
|
+
}
|
|
293
270
|
|
|
294
|
-
|
|
271
|
+
candidateNoteSources.push({
|
|
272
|
+
ids: new Set(activeNoteIdsPerScope.flat()),
|
|
273
|
+
notes: this.#notes,
|
|
274
|
+
});
|
|
295
275
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
276
|
+
// If status is ACTIVE_OR_NULLIFIED we add nullified notes as candidates on top of the default active ones.
|
|
277
|
+
if (filter.status === NoteStatus.ACTIVE_OR_NULLIFIED) {
|
|
278
|
+
const nullifiedIds = filter.storageSlot
|
|
279
|
+
? await toArray(this.#nullifiedNotesByStorageSlot.getValuesAsync(filter.storageSlot.toString()))
|
|
280
|
+
: await toArray(this.#nullifiedNotesByContract.getValuesAsync(filter.contractAddress.toString()));
|
|
299
281
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
// insertion via `addNotes` or when removing their nullifiers.
|
|
303
|
-
throw new Error(`No scopes found for nullified note with nullifier ${noteNullifier}`);
|
|
304
|
-
}
|
|
282
|
+
const setOfScopes = new Set(filter.scopes.map(s => s.toString() as string));
|
|
283
|
+
const filteredNullifiedIds = new Set<string>();
|
|
305
284
|
|
|
306
|
-
|
|
285
|
+
for (const noteId of nullifiedIds) {
|
|
286
|
+
const scopeList = await toArray(this.#nullifiedNotesToScope.getValuesAsync(noteId));
|
|
287
|
+
if (scopeList.some(scope => setOfScopes.has(scope))) {
|
|
288
|
+
filteredNullifiedIds.add(noteId);
|
|
289
|
+
}
|
|
290
|
+
}
|
|
307
291
|
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
292
|
+
if (filteredNullifiedIds.size > 0) {
|
|
293
|
+
candidateNoteSources.push({
|
|
294
|
+
ids: filteredNullifiedIds,
|
|
295
|
+
notes: this.#nullifiedNotes,
|
|
296
|
+
});
|
|
312
297
|
}
|
|
313
298
|
}
|
|
314
|
-
}
|
|
315
299
|
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
for (const
|
|
319
|
-
await
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
300
|
+
const result: NoteDao[] = [];
|
|
301
|
+
for (const { ids, notes } of candidateNoteSources) {
|
|
302
|
+
for (const id of ids) {
|
|
303
|
+
const serializedNote = await notes.getAsync(id);
|
|
304
|
+
if (!serializedNote) {
|
|
305
|
+
continue;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
const note = NoteDao.fromBuffer(serializedNote);
|
|
309
|
+
if (!note.contractAddress.equals(filter.contractAddress)) {
|
|
310
|
+
continue;
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
if (filter.owner && !note.owner.equals(filter.owner)) {
|
|
314
|
+
continue;
|
|
323
315
|
}
|
|
316
|
+
|
|
317
|
+
if (filter.storageSlot && !note.storageSlot.equals(filter.storageSlot!)) {
|
|
318
|
+
continue;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
if (filter.siloedNullifier && !note.siloedNullifier.equals(filter.siloedNullifier)) {
|
|
322
|
+
continue;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
result.push(note);
|
|
324
326
|
}
|
|
327
|
+
}
|
|
325
328
|
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
+
// A note might be present in multiple scopes - we ensure it is only returned once
|
|
330
|
+
const deduplicated: NoteDao[] = [];
|
|
331
|
+
for (const note of result) {
|
|
332
|
+
if (!deduplicated.some(existing => existing.equals(note))) {
|
|
333
|
+
deduplicated.push(note);
|
|
334
|
+
}
|
|
335
|
+
}
|
|
329
336
|
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
337
|
+
// Sort by block number, then by tx index within block, then by note index within tx
|
|
338
|
+
deduplicated.sort((a, b) => {
|
|
339
|
+
if (a.l2BlockNumber !== b.l2BlockNumber) {
|
|
340
|
+
return a.l2BlockNumber - b.l2BlockNumber;
|
|
341
|
+
}
|
|
342
|
+
if (a.txIndexInBlock !== b.txIndexInBlock) {
|
|
343
|
+
return a.txIndexInBlock - b.txIndexInBlock;
|
|
344
|
+
}
|
|
345
|
+
return a.noteIndexInTx - b.noteIndexInTx;
|
|
346
|
+
});
|
|
333
347
|
|
|
334
|
-
|
|
335
|
-
this.#notesForJob.delete(jobId);
|
|
336
|
-
this.#jobLocks.delete(jobId);
|
|
348
|
+
return deduplicated;
|
|
337
349
|
}
|
|
338
350
|
|
|
339
351
|
/**
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
352
|
+
* Transitions notes from "active" to "nullified" state.
|
|
353
|
+
*
|
|
354
|
+
* This operation processes a batch of nullifiers to mark the corresponding notes
|
|
355
|
+
* as spent/nullified. The operation is atomic - if any nullifier is not found,
|
|
356
|
+
* the entire operation fails and no notes are modified.
|
|
357
|
+
*
|
|
358
|
+
* @param nullifiers - Array of nullifiers with their block numbers to process
|
|
359
|
+
* @returns Promise resolving to array of nullified NoteDao objects
|
|
360
|
+
* @throws Error if any nullifier is not found in the active notes
|
|
343
361
|
*/
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
lock = new Semaphore(1);
|
|
348
|
-
this.#jobLocks.set(jobId, lock);
|
|
349
|
-
}
|
|
350
|
-
await lock.acquire();
|
|
351
|
-
try {
|
|
352
|
-
return await fn();
|
|
353
|
-
} finally {
|
|
354
|
-
lock.release();
|
|
362
|
+
applyNullifiers(nullifiers: DataInBlock<Fr>[]): Promise<NoteDao[]> {
|
|
363
|
+
if (nullifiers.length === 0) {
|
|
364
|
+
return Promise.resolve([]);
|
|
355
365
|
}
|
|
356
|
-
}
|
|
357
366
|
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
if (!notesForJob) {
|
|
361
|
-
notesForJob = new Map();
|
|
362
|
-
this.#notesForJob.set(jobId, notesForJob);
|
|
363
|
-
}
|
|
364
|
-
return notesForJob;
|
|
365
|
-
}
|
|
367
|
+
return this.#store.transactionAsync(async () => {
|
|
368
|
+
const nullifiedNotes: NoteDao[] = [];
|
|
366
369
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
370
|
+
for (const blockScopedNullifier of nullifiers) {
|
|
371
|
+
const { data: nullifier, l2BlockNumber: blockNumber } = blockScopedNullifier;
|
|
372
|
+
const noteId = nullifier.toString();
|
|
373
|
+
|
|
374
|
+
const noteBuffer = await this.#notes.getAsync(noteId);
|
|
375
|
+
if (!noteBuffer) {
|
|
376
|
+
// Check if already nullified (noteId === siloedNullifier, so we can check #nullifiedNotes directly)
|
|
377
|
+
if (await this.#nullifiedNotes.hasAsync(noteId)) {
|
|
378
|
+
throw new Error(`Nullifier already applied in applyNullifiers`);
|
|
379
|
+
}
|
|
380
|
+
throw new Error('Nullifier not found in applyNullifiers');
|
|
381
|
+
}
|
|
372
382
|
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
383
|
+
const noteScopes = await toArray(this.#notesToScope.getValuesAsync(noteId));
|
|
384
|
+
if (noteScopes.length === 0) {
|
|
385
|
+
// We should never run into this error because notes always have a scope assigned to them - either on initial
|
|
386
|
+
// insertion via `addNotes` or when removing their nullifiers.
|
|
387
|
+
throw new Error('Note scopes are missing in applyNullifiers');
|
|
388
|
+
}
|
|
378
389
|
|
|
379
|
-
|
|
390
|
+
const note = NoteDao.fromBuffer(noteBuffer);
|
|
391
|
+
|
|
392
|
+
nullifiedNotes.push(note);
|
|
393
|
+
|
|
394
|
+
await this.#notes.delete(noteId);
|
|
395
|
+
await this.#notesToScope.delete(noteId);
|
|
396
|
+
|
|
397
|
+
const scopes = await toArray(this.#scopes.keysAsync());
|
|
398
|
+
|
|
399
|
+
for (const scope of scopes) {
|
|
400
|
+
await this.#notesByContractAndScope.get(scope)!.deleteValue(note.contractAddress.toString(), noteId);
|
|
401
|
+
await this.#notesByStorageSlotAndScope.get(scope)!.deleteValue(note.storageSlot.toString(), noteId);
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
for (const scope of noteScopes) {
|
|
405
|
+
await this.#nullifiedNotesToScope.set(noteId, scope);
|
|
406
|
+
}
|
|
407
|
+
await this.#nullifiedNotes.set(noteId, note.toBuffer());
|
|
408
|
+
await this.#nullifiersByBlockNumber.set(blockNumber, noteId);
|
|
409
|
+
await this.#nullifiedNotesByContract.set(note.contractAddress.toString(), noteId);
|
|
410
|
+
await this.#nullifiedNotesByStorageSlot.set(note.storageSlot.toString(), noteId);
|
|
411
|
+
}
|
|
412
|
+
return nullifiedNotes;
|
|
413
|
+
});
|
|
380
414
|
}
|
|
381
415
|
}
|