@aztec/pxe 0.0.1-commit.3469e52 → 0.0.1-commit.59e663cd

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 (127) hide show
  1. package/dest/bin/check_oracle_version.js +1 -1
  2. package/dest/block_synchronizer/block_synchronizer.d.ts +6 -4
  3. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  4. package/dest/block_synchronizer/block_synchronizer.js +53 -13
  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 +1 -4
  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 +34 -36
  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/server/index.d.ts +2 -1
  36. package/dest/entrypoints/server/index.d.ts.map +1 -1
  37. package/dest/entrypoints/server/index.js +1 -0
  38. package/dest/events/event_service.d.ts +2 -2
  39. package/dest/events/event_service.d.ts.map +1 -1
  40. package/dest/events/event_service.js +1 -1
  41. package/dest/logs/log_service.d.ts +1 -1
  42. package/dest/logs/log_service.d.ts.map +1 -1
  43. package/dest/logs/log_service.js +17 -11
  44. package/dest/notes/note_service.d.ts +4 -3
  45. package/dest/notes/note_service.d.ts.map +1 -1
  46. package/dest/notes/note_service.js +11 -10
  47. package/dest/oracle_version.d.ts +3 -3
  48. package/dest/oracle_version.d.ts.map +1 -1
  49. package/dest/oracle_version.js +4 -3
  50. package/dest/private_kernel/private_kernel_oracle.d.ts +3 -3
  51. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  52. package/dest/pxe.d.ts +1 -1
  53. package/dest/pxe.d.ts.map +1 -1
  54. package/dest/pxe.js +13 -11
  55. package/dest/storage/contract_store/contract_store.d.ts +1 -2
  56. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  57. package/dest/storage/contract_store/contract_store.js +0 -12
  58. package/dest/storage/note_store/note_store.d.ts +43 -55
  59. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  60. package/dest/storage/note_store/note_store.js +238 -252
  61. package/dest/storage/note_store/stored_note.d.ts +16 -0
  62. package/dest/storage/note_store/stored_note.d.ts.map +1 -0
  63. package/dest/storage/note_store/stored_note.js +43 -0
  64. package/dest/storage/private_event_store/private_event_store.d.ts +17 -4
  65. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  66. package/dest/storage/private_event_store/private_event_store.js +163 -135
  67. package/dest/storage/private_event_store/stored_private_event.d.ts +23 -0
  68. package/dest/storage/private_event_store/stored_private_event.d.ts.map +1 -0
  69. package/dest/storage/private_event_store/stored_private_event.js +56 -0
  70. package/dest/tagging/get_all_logs_by_tags.d.ts +24 -0
  71. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -0
  72. package/dest/tagging/get_all_logs_by_tags.js +46 -0
  73. package/dest/tagging/index.d.ts +2 -1
  74. package/dest/tagging/index.d.ts.map +1 -1
  75. package/dest/tagging/index.js +1 -0
  76. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +3 -2
  77. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  78. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +2 -2
  79. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +3 -2
  80. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  81. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +5 -2
  82. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +3 -2
  83. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  84. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +2 -2
  85. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +1 -1
  86. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  87. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +5 -8
  88. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +3 -2
  89. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  90. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +7 -4
  91. package/package.json +16 -16
  92. package/src/bin/check_oracle_version.ts +1 -0
  93. package/src/block_synchronizer/block_synchronizer.ts +55 -21
  94. package/src/config/index.ts +14 -0
  95. package/src/contract_function_simulator/contract_function_simulator.ts +1 -9
  96. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  97. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  98. package/src/contract_function_simulator/oracle/interfaces.ts +18 -9
  99. package/src/contract_function_simulator/oracle/oracle.ts +34 -21
  100. package/src/contract_function_simulator/oracle/private_execution.ts +1 -60
  101. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +32 -6
  102. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +53 -45
  103. package/src/contract_sync/index.ts +98 -0
  104. package/src/debug/pxe_debug_utils.ts +26 -11
  105. package/src/entrypoints/server/index.ts +1 -0
  106. package/src/events/event_service.ts +1 -1
  107. package/src/logs/log_service.ts +24 -8
  108. package/src/notes/note_service.ts +18 -15
  109. package/src/oracle_version.ts +4 -3
  110. package/src/private_kernel/private_kernel_oracle.ts +2 -2
  111. package/src/pxe.ts +35 -12
  112. package/src/storage/contract_store/contract_store.ts +0 -20
  113. package/src/storage/note_store/note_store.ts +279 -313
  114. package/src/storage/note_store/stored_note.ts +48 -0
  115. package/src/storage/private_event_store/private_event_store.ts +214 -175
  116. package/src/storage/private_event_store/stored_private_event.ts +73 -0
  117. package/src/tagging/get_all_logs_by_tags.ts +68 -0
  118. package/src/tagging/index.ts +1 -0
  119. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +11 -1
  120. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +7 -1
  121. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +3 -1
  122. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +5 -17
  123. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +12 -3
  124. package/dest/tree_membership/tree_membership_service.d.ts +0 -50
  125. package/dest/tree_membership/tree_membership_service.d.ts.map +0 -1
  126. package/dest/tree_membership/tree_membership_service.js +0 -75
  127. package/src/tree_membership/tree_membership_service.ts +0 -97
@@ -0,0 +1,48 @@
1
+ import { BlockNumber } from '@aztec/foundation/branded-types';
2
+ import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
3
+ import { NoteDao } from '@aztec/stdlib/note';
4
+
5
+ export class StoredNote {
6
+ constructor(
7
+ readonly noteDao: NoteDao,
8
+ readonly scopes: Set<string>,
9
+ private _nullifiedAt: BlockNumber | undefined = undefined,
10
+ ) {}
11
+
12
+ static fromBuffer(buffer: Buffer) {
13
+ const reader = BufferReader.asReader(buffer);
14
+
15
+ const noteDao = NoteDao.fromBuffer(reader);
16
+ const scopes = reader.readVector({ fromBuffer: (r: BufferReader) => r.readString() });
17
+
18
+ const nullifiedAtRaw = reader.readNumber();
19
+ const nullifiedAt = nullifiedAtRaw === 0 ? undefined : (nullifiedAtRaw as BlockNumber);
20
+
21
+ return new StoredNote(noteDao, new Set(scopes), nullifiedAt);
22
+ }
23
+
24
+ toBuffer(): Buffer {
25
+ const scopesArray = [...this.scopes];
26
+ return serializeToBuffer(this.noteDao, scopesArray.length, ...scopesArray, this._nullifiedAt ?? 0);
27
+ }
28
+
29
+ addScope(scope: string) {
30
+ this.scopes.add(scope);
31
+ }
32
+
33
+ markAsNullified(blockNumber: BlockNumber) {
34
+ this._nullifiedAt = blockNumber;
35
+ }
36
+
37
+ markAsActive() {
38
+ this._nullifiedAt = undefined;
39
+ }
40
+
41
+ isNullified() {
42
+ return this._nullifiedAt !== undefined;
43
+ }
44
+
45
+ get nullifiedAt() {
46
+ return this._nullifiedAt;
47
+ }
48
+ }
@@ -1,15 +1,16 @@
1
1
  import { BlockNumber } from '@aztec/foundation/branded-types';
2
2
  import { Fr } from '@aztec/foundation/curves/bn254';
3
+ import { toArray } from '@aztec/foundation/iterable';
3
4
  import { createLogger } from '@aztec/foundation/log';
4
- import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
5
+ import { Semaphore } from '@aztec/foundation/queue';
5
6
  import type { AztecAsyncKVStore, AztecAsyncMap, AztecAsyncMultiMap } from '@aztec/kv-store';
6
7
  import type { EventSelector } from '@aztec/stdlib/abi';
7
8
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
8
- import { L2BlockHash } from '@aztec/stdlib/block';
9
- import { type InTx, TxHash } from '@aztec/stdlib/tx';
9
+ import type { InTx, TxHash } from '@aztec/stdlib/tx';
10
10
 
11
11
  import type { StagedStore } from '../../job_coordinator/job_coordinator.js';
12
12
  import type { PackedPrivateEvent } from '../../pxe.js';
13
+ import { StoredPrivateEvent } from './stored_private_event.js';
13
14
 
14
15
  export type PrivateEventStoreFilter = {
15
16
  contractAddress: AztecAddress;
@@ -19,20 +20,6 @@ export type PrivateEventStoreFilter = {
19
20
  txHash?: TxHash;
20
21
  };
21
22
 
22
- type PrivateEventEntry = {
23
- randomness: Fr; // Note that this value is currently not being returned on queries and is therefore temporarily unused
24
- msgContent: Buffer;
25
- l2BlockNumber: number;
26
- l2BlockHash: Buffer;
27
- txHash: Buffer;
28
- /** The index of the tx within the block, used for ordering events */
29
- txIndexInBlock: number;
30
- /** The index of the event within the tx (based on nullifier position), used for ordering events */
31
- eventIndexInTx: number;
32
- /** The lookup key for #eventsByContractScopeSelector, used for cleanup during rollback */
33
- lookupKey: string;
34
- };
35
-
36
23
  type PrivateEventMetadata = InTx & {
37
24
  contractAddress: AztecAddress;
38
25
  scope: AztecAddress;
@@ -49,104 +36,29 @@ export class PrivateEventStore implements StagedStore {
49
36
  readonly storeName: string = 'private_event';
50
37
 
51
38
  #store: AztecAsyncKVStore;
52
- /** Map storing the actual private event log entries, keyed by siloedEventCommitment */
53
- #eventLogs: AztecAsyncMap<string, PrivateEventEntry>;
54
- /** Multi-map from contractAddress_scope_eventSelector to siloedEventCommitment for efficient lookup */
55
- #eventsByContractScopeSelector: AztecAsyncMultiMap<string, string>;
39
+ /** Actual private event log entries, keyed by siloedEventCommitment */
40
+ #events: AztecAsyncMap<string, Buffer>;
41
+ /** Multi-map from contractAddress_eventSelector to siloedEventCommitment for efficient lookup */
42
+ #eventsByContractAndEventSelector: AztecAsyncMultiMap<string, string>;
56
43
  /** Multi-map from block number to siloedEventCommitment for rollback support */
57
44
  #eventsByBlockNumber: AztecAsyncMultiMap<number, string>;
58
- /** Map from siloedEventCommitment to boolean indicating if log has been seen. */
59
- #seenLogs: AztecAsyncMap<string, boolean>;
60
45
 
61
- /** jobId => eventId (event siloed nullifier) => PrivateEventEntry */
62
- #eventLogsInJobStage: Map<string, Map<string, PrivateEventEntry>>;
46
+ /** jobId => eventId (event siloed nullifier) => StoredPrivateEvent */
47
+ #eventsForJob: Map<string, Map<string, StoredPrivateEvent>>;
48
+
49
+ /** Per-job locks to prevent concurrent writes from affecting each other. */
50
+ #jobLocks: Map<string, Semaphore>;
63
51
 
64
52
  logger = createLogger('private_event_store');
65
53
 
66
54
  constructor(store: AztecAsyncKVStore) {
67
55
  this.#store = store;
68
- this.#eventLogs = this.#store.openMap('private_event_logs');
69
- this.#eventsByContractScopeSelector = this.#store.openMultiMap('events_by_contract_scope_selector');
70
- this.#seenLogs = this.#store.openMap('seen_logs');
56
+ this.#events = this.#store.openMap('private_event_logs');
57
+ this.#eventsByContractAndEventSelector = this.#store.openMultiMap('events_by_contract_selector');
71
58
  this.#eventsByBlockNumber = this.#store.openMultiMap('events_by_block_number');
72
59
 
73
- this.#eventLogsInJobStage = new Map();
74
- }
75
-
76
- #keyFor(contractAddress: AztecAddress, scope: AztecAddress, eventSelector: EventSelector): string {
77
- return `${contractAddress.toString()}_${scope.toString()}_${eventSelector.toString()}`;
78
- }
79
-
80
- async commit(jobId: string): Promise<void> {
81
- await Promise.all(
82
- [...this.#getEventLogsInJobStage(jobId).entries()].map(async ([eventId, eventEntry]) => {
83
- this.logger.verbose('storing private event log (KV store)', eventEntry);
84
-
85
- await Promise.all([
86
- this.#eventLogs.set(eventId, eventEntry),
87
- this.#eventsByContractScopeSelector.set(eventEntry.lookupKey, eventId),
88
- this.#eventsByBlockNumber.set(eventEntry.l2BlockNumber, eventId),
89
- this.#seenLogs.set(eventId, true),
90
- ]);
91
- }),
92
- );
93
-
94
- return this.discardStaged(jobId);
95
- }
96
-
97
- discardStaged(jobId: string): Promise<void> {
98
- this.#eventLogsInJobStage.delete(jobId);
99
- return Promise.resolve();
100
- }
101
-
102
- #getEventLogsInJobStage(jobId: string): Map<string, PrivateEventEntry> {
103
- let jobStage = this.#eventLogsInJobStage.get(jobId);
104
- if (jobStage === undefined) {
105
- jobStage = new Map();
106
- this.#eventLogsInJobStage.set(jobId, jobStage);
107
- }
108
- return jobStage;
109
- }
110
-
111
- async #isSeenLog(jobId: string, eventId: string): Promise<boolean> {
112
- const eventLogsInJobStage = this.#getEventLogsInJobStage(jobId).get(eventId);
113
- return !!eventLogsInJobStage || !!(await this.#seenLogs.getAsync(eventId));
114
- }
115
-
116
- #addEventLogToStage(jobId: string, eventId: string, eventEntry: PrivateEventEntry) {
117
- this.#getEventLogsInJobStage(jobId).set(eventId, eventEntry);
118
- }
119
-
120
- async #getEventSiloedNullifiers(
121
- contractAddress: AztecAddress,
122
- scope: AztecAddress,
123
- eventSelector: EventSelector,
124
- jobId?: string,
125
- ): Promise<string[]> {
126
- const key = this.#keyFor(contractAddress, scope, eventSelector);
127
- const eventSiloedNullifiersInStorage: string[] = [];
128
- for await (const eventId of this.#eventsByContractScopeSelector.getValuesAsync(key)) {
129
- eventSiloedNullifiersInStorage.push(eventId);
130
- }
131
-
132
- if (!jobId) {
133
- return eventSiloedNullifiersInStorage;
134
- }
135
-
136
- const eventSiloedNullifiersInJobStage = new Set(
137
- [...this.#getEventLogsInJobStage(jobId).entries()]
138
- .filter(([_, entry]) => entry.lookupKey === key)
139
- .map(([idx, _]) => idx),
140
- );
141
- return [...new Set(eventSiloedNullifiersInStorage).union(eventSiloedNullifiersInJobStage)];
142
- }
143
-
144
- async #getEventLogBySiloedNullifier(eventId: string, jobId?: string): Promise<PrivateEventEntry | undefined> {
145
- if (jobId) {
146
- return this.#getEventLogsInJobStage(jobId).get(eventId) ?? (await this.#eventLogs.getAsync(eventId));
147
- } else {
148
- return await this.#eventLogs.getAsync(eventId);
149
- }
60
+ this.#eventsForJob = new Map();
61
+ this.#jobLocks = new Map();
150
62
  }
151
63
 
152
64
  /**
@@ -168,39 +80,43 @@ export class PrivateEventStore implements StagedStore {
168
80
  siloedEventCommitment: Fr,
169
81
  metadata: PrivateEventMetadata,
170
82
  jobId: string,
171
- ): Promise<void> {
172
- const { contractAddress, scope, txHash, l2BlockNumber, l2BlockHash, txIndexInBlock, eventIndexInTx } = metadata;
173
-
174
- return this.#store.transactionAsync(async () => {
175
- const key = this.#keyFor(contractAddress, scope, eventSelector);
176
-
177
- // The siloed event commitment is guaranteed to be unique as it's inserted into the nullifier tree. For this
178
- // reason we use it as id.
83
+ ) {
84
+ return this.#withJobLock(jobId, async () => {
85
+ const { contractAddress, scope, txHash, l2BlockNumber, l2BlockHash, txIndexInBlock, eventIndexInTx } = metadata;
179
86
  const eventId = siloedEventCommitment.toString();
180
87
 
181
- const hasBeenSeen = await this.#isSeenLog(jobId, eventId);
182
- if (hasBeenSeen) {
183
- this.logger.verbose('Ignoring duplicate event log', { txHash: txHash.toString(), siloedEventCommitment });
184
- return;
185
- }
186
-
187
88
  this.logger.verbose('storing private event log (job stage)', {
89
+ eventId,
188
90
  contractAddress,
189
91
  scope,
190
92
  msgContent,
191
93
  l2BlockNumber,
192
94
  });
193
95
 
194
- this.#addEventLogToStage(jobId, eventId, {
195
- randomness,
196
- msgContent: serializeToBuffer(msgContent),
197
- l2BlockNumber,
198
- l2BlockHash: l2BlockHash.toBuffer(),
199
- txHash: txHash.toBuffer(),
200
- txIndexInBlock,
201
- eventIndexInTx,
202
- lookupKey: key,
203
- });
96
+ const existing = await this.#readEvent(eventId, jobId);
97
+
98
+ if (existing) {
99
+ // If we already stored this event, we still want to make sure to track it for the given scope
100
+ existing.addScope(scope.toString());
101
+ this.#writeEvent(eventId, existing, jobId);
102
+ } else {
103
+ this.#writeEvent(
104
+ eventId,
105
+ new StoredPrivateEvent(
106
+ randomness,
107
+ msgContent,
108
+ l2BlockNumber,
109
+ l2BlockHash,
110
+ txHash,
111
+ txIndexInBlock,
112
+ eventIndexInTx,
113
+ contractAddress,
114
+ eventSelector,
115
+ new Set([scope.toString()]),
116
+ ),
117
+ jobId,
118
+ );
119
+ }
204
120
  });
205
121
  }
206
122
 
@@ -215,64 +131,78 @@ export class PrivateEventStore implements StagedStore {
215
131
  * @returns - The event log contents, augmented with metadata about the transaction and block in which the event was
216
132
  * included.
217
133
  */
218
- public async getPrivateEvents(
134
+ public getPrivateEvents(
219
135
  eventSelector: EventSelector,
220
136
  filter: PrivateEventStoreFilter,
221
137
  ): Promise<PackedPrivateEvent[]> {
222
- const events: Array<{
223
- l2BlockNumber: number;
224
- txIndexInBlock: number;
225
- eventIndexInTx: number;
226
- event: PackedPrivateEvent;
227
- }> = [];
138
+ return this.#store.transactionAsync(async () => {
139
+ const events: Array<{
140
+ l2BlockNumber: number;
141
+ txIndexInBlock: number;
142
+ eventIndexInTx: number;
143
+ event: PackedPrivateEvent;
144
+ }> = [];
228
145
 
229
- for (const scope of filter.scopes) {
230
- const eventIds = await this.#getEventSiloedNullifiers(filter.contractAddress, scope, eventSelector);
146
+ const key = this.#keyFor(filter.contractAddress, eventSelector);
147
+ const targetScopes = new Set(filter.scopes.map(s => s.toString()));
148
+
149
+ const eventIds: string[] = await toArray(this.#eventsByContractAndEventSelector.getValuesAsync(key));
231
150
 
232
151
  for (const eventId of eventIds) {
233
- const entry = await this.#getEventLogBySiloedNullifier(eventId);
152
+ const eventBuffer = await this.#events.getAsync(eventId);
153
+
154
+ // Defensive, if it happens, there's a problem with how we're handling #eventsByContractAndEventSelector
155
+ if (!eventBuffer) {
156
+ this.logger.verbose(
157
+ `EventId ${eventId} does not exist in main index but it is referenced from contract event selector index`,
158
+ );
159
+ continue;
160
+ }
161
+
162
+ const storedPrivateEvent = StoredPrivateEvent.fromBuffer(eventBuffer);
234
163
 
235
- if (!entry || entry.l2BlockNumber < filter.fromBlock || entry.l2BlockNumber >= filter.toBlock) {
164
+ // Filter by block range
165
+ if (storedPrivateEvent.l2BlockNumber < filter.fromBlock || storedPrivateEvent.l2BlockNumber >= filter.toBlock) {
236
166
  continue;
237
167
  }
238
168
 
239
- // Convert buffer back to Fr array
240
- const reader = BufferReader.asReader(entry.msgContent);
241
- const numFields = entry.msgContent.length / Fr.SIZE_IN_BYTES;
242
- const msgContent = reader.readArray(numFields, Fr);
243
- const txHash = TxHash.fromBuffer(entry.txHash);
244
- const l2BlockHash = L2BlockHash.fromBuffer(entry.l2BlockHash);
169
+ // Filter by scopes
170
+ if (storedPrivateEvent.scopes.intersection(targetScopes).size === 0) {
171
+ continue;
172
+ }
245
173
 
246
- if (filter.txHash && !txHash.equals(filter.txHash)) {
174
+ // Filter by txHash
175
+ if (filter.txHash && !storedPrivateEvent.txHash.equals(filter.txHash)) {
247
176
  continue;
248
177
  }
249
178
 
250
179
  events.push({
251
- l2BlockNumber: entry.l2BlockNumber,
252
- txIndexInBlock: entry.txIndexInBlock,
253
- eventIndexInTx: entry.eventIndexInTx,
180
+ l2BlockNumber: storedPrivateEvent.l2BlockNumber,
181
+ txIndexInBlock: storedPrivateEvent.txIndexInBlock,
182
+ eventIndexInTx: storedPrivateEvent.eventIndexInTx,
254
183
  event: {
255
- packedEvent: msgContent,
256
- l2BlockNumber: BlockNumber(entry.l2BlockNumber),
257
- txHash,
258
- l2BlockHash,
184
+ packedEvent: storedPrivateEvent.msgContent,
185
+ l2BlockNumber: BlockNumber(storedPrivateEvent.l2BlockNumber),
186
+ txHash: storedPrivateEvent.txHash,
187
+ l2BlockHash: storedPrivateEvent.l2BlockHash,
259
188
  eventSelector,
260
189
  },
261
190
  });
262
191
  }
263
- }
264
192
 
265
- // Sort by block number, then by tx index within block, then by event index within tx
266
- events.sort((a, b) => {
267
- if (a.l2BlockNumber !== b.l2BlockNumber) {
268
- return a.l2BlockNumber - b.l2BlockNumber;
269
- }
270
- if (a.txIndexInBlock !== b.txIndexInBlock) {
271
- return a.txIndexInBlock - b.txIndexInBlock;
272
- }
273
- return a.eventIndexInTx - b.eventIndexInTx;
193
+ // Sort by block number, then by tx index within block, then by event index within tx
194
+ events.sort((a, b) => {
195
+ if (a.l2BlockNumber !== b.l2BlockNumber) {
196
+ return a.l2BlockNumber - b.l2BlockNumber;
197
+ }
198
+ if (a.txIndexInBlock !== b.txIndexInBlock) {
199
+ return a.txIndexInBlock - b.txIndexInBlock;
200
+ }
201
+ return a.eventIndexInTx - b.eventIndexInTx;
202
+ });
203
+
204
+ return events.map(ev => ev.event);
274
205
  });
275
- return events.map(ev => ev.event);
276
206
  }
277
207
 
278
208
  /**
@@ -296,23 +226,23 @@ export class PrivateEventStore implements StagedStore {
296
226
  let removedCount = 0;
297
227
 
298
228
  for (let block = blockNumber + 1; block <= synchedBlockNumber; block++) {
299
- const eventIds: string[] = [];
300
- for await (const eventId of this.#eventsByBlockNumber.getValuesAsync(block)) {
301
- eventIds.push(eventId);
302
- }
229
+ const eventIds: string[] = await toArray(this.#eventsByBlockNumber.getValuesAsync(block));
303
230
 
304
231
  if (eventIds.length > 0) {
305
232
  await this.#eventsByBlockNumber.delete(block);
306
233
 
307
234
  for (const eventId of eventIds) {
308
- const entry = await this.#eventLogs.getAsync(eventId);
309
- if (!entry) {
310
- throw new Error(`Event log not found for eventId ${eventId}`);
235
+ const buffer = await this.#events.getAsync(eventId);
236
+ if (!buffer) {
237
+ throw new Error(`Event not found for eventId ${eventId}`);
311
238
  }
312
239
 
313
- await this.#eventLogs.delete(eventId);
314
- await this.#seenLogs.delete(eventId);
315
- await this.#eventsByContractScopeSelector.deleteValue(entry.lookupKey, eventId);
240
+ const entry = StoredPrivateEvent.fromBuffer(buffer);
241
+ await this.#events.delete(eventId);
242
+ await this.#eventsByContractAndEventSelector.deleteValue(
243
+ this.#keyFor(entry.contractAddress, entry.eventSelector),
244
+ eventId,
245
+ );
316
246
 
317
247
  removedCount++;
318
248
  }
@@ -321,4 +251,113 @@ export class PrivateEventStore implements StagedStore {
321
251
 
322
252
  this.logger.verbose(`Rolled back ${removedCount} private events after block ${blockNumber}`);
323
253
  }
254
+
255
+ /**
256
+ * Commits in memory job data to persistent storage.
257
+ *
258
+ * Called by JobCoordinator when a job completes successfully.
259
+ *
260
+ * Note: JobCoordinator wraps all commits in a single transaction, so we don't need our own transactionAsync here
261
+ * (and using one would throw on IndexedDB as it does not support nested txs).
262
+ *
263
+ * @param jobId - The jobId identifying which staged data to commit
264
+ */
265
+ commit(jobId: string): Promise<void> {
266
+ return this.#withJobLock(jobId, async () => {
267
+ for (const [eventId, entry] of this.#getEventsForJob(jobId).entries()) {
268
+ const lookupKey = this.#keyFor(entry.contractAddress, entry.eventSelector);
269
+ this.logger.verbose('storing private event log', { eventId, lookupKey });
270
+
271
+ await Promise.all([
272
+ this.#events.set(eventId, entry.toBuffer()),
273
+ this.#eventsByContractAndEventSelector.set(lookupKey, eventId),
274
+ this.#eventsByBlockNumber.set(entry.l2BlockNumber, eventId),
275
+ ]);
276
+ }
277
+
278
+ this.#clearJobData(jobId);
279
+ });
280
+ }
281
+
282
+ /**
283
+ * Discards in memory job data without persisting it.
284
+ */
285
+ discardStaged(jobId: string): Promise<void> {
286
+ return this.#withJobLock(jobId, () => Promise.resolve(this.#clearJobData(jobId)));
287
+ }
288
+
289
+ /**
290
+ * Reads an event from in-memory job data first, falling back to persistent storage if not found.
291
+ *
292
+ * Returns undefined if the event does not exist in the store overall.
293
+ */
294
+ async #readEvent(eventId: string, jobId: string): Promise<StoredPrivateEvent | undefined> {
295
+ const eventForJob = this.#getEventsForJob(jobId).get(eventId);
296
+ if (eventForJob) {
297
+ return eventForJob;
298
+ }
299
+
300
+ const buffer = await this.#events.getAsync(eventId);
301
+ return buffer ? StoredPrivateEvent.fromBuffer(buffer) : undefined;
302
+ }
303
+
304
+ /**
305
+ * Writes an event to in-memory job data.
306
+ *
307
+ * Writes are only allowed in a job context. Events modified during a job will only be persisted when `commit` is
308
+ * called.
309
+ */
310
+ #writeEvent(eventId: string, entry: StoredPrivateEvent, jobId: string) {
311
+ this.#getEventsForJob(jobId).set(eventId, entry);
312
+ }
313
+
314
+ /**
315
+ * Get in-memory data only visible to @param jobId
316
+ */
317
+ #getEventsForJob(jobId: string): Map<string, StoredPrivateEvent> {
318
+ let eventsForJob = this.#eventsForJob.get(jobId);
319
+ if (eventsForJob === undefined) {
320
+ eventsForJob = new Map();
321
+ this.#eventsForJob.set(jobId, eventsForJob);
322
+ }
323
+ return eventsForJob;
324
+ }
325
+
326
+ /**
327
+ * Clear data structures supporting a specific job.
328
+ */
329
+ #clearJobData(jobId: string) {
330
+ this.#eventsForJob.delete(jobId);
331
+ this.#jobLocks.delete(jobId);
332
+ }
333
+
334
+ /**
335
+ * Ensures a function can only run once it acquires a unique per-job lock, and handles proper lock release after it
336
+ * runs.
337
+ *
338
+ * This primitive allows concurrent writes on this store without risking data corruption due to unsound write
339
+ * interleaving.
340
+ */
341
+ async #withJobLock<T>(jobId: string, fn: () => Promise<T>): Promise<T> {
342
+ let lock = this.#jobLocks.get(jobId);
343
+ if (!lock) {
344
+ lock = new Semaphore(1);
345
+ this.#jobLocks.set(jobId, lock);
346
+ }
347
+ await lock.acquire();
348
+ try {
349
+ return await fn();
350
+ } finally {
351
+ lock.release();
352
+ }
353
+ }
354
+
355
+ /**
356
+ * Returns a string key based on @param contractAddress and @param eventSelector.
357
+ *
358
+ * The returned key is meant to be used when interacting with index #eventsByContractAndEventSelector.
359
+ */
360
+ #keyFor(contractAddress: AztecAddress, eventSelector: EventSelector): string {
361
+ return `${contractAddress.toString()}_${eventSelector.toString()}`;
362
+ }
324
363
  }
@@ -0,0 +1,73 @@
1
+ import { Fr } from '@aztec/foundation/curves/bn254';
2
+ import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
3
+ import { EventSelector } from '@aztec/stdlib/abi';
4
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
5
+ import { BlockHash } from '@aztec/stdlib/block';
6
+ import { TxHash } from '@aztec/stdlib/tx';
7
+
8
+ /** Serializable private event entry with scope tracking. */
9
+ export class StoredPrivateEvent {
10
+ constructor(
11
+ readonly randomness: Fr,
12
+ readonly msgContent: Fr[],
13
+ readonly l2BlockNumber: number,
14
+ readonly l2BlockHash: BlockHash,
15
+ readonly txHash: TxHash,
16
+ readonly txIndexInBlock: number,
17
+ readonly eventIndexInTx: number,
18
+ readonly contractAddress: AztecAddress,
19
+ readonly eventSelector: EventSelector,
20
+ readonly scopes: Set<string>,
21
+ ) {}
22
+
23
+ addScope(scope: string) {
24
+ this.scopes.add(scope);
25
+ }
26
+
27
+ toBuffer(): Buffer {
28
+ const scopesArray = [...this.scopes];
29
+ return serializeToBuffer(
30
+ this.randomness,
31
+ this.msgContent.length,
32
+ ...this.msgContent,
33
+ this.l2BlockNumber,
34
+ this.l2BlockHash,
35
+ this.txHash,
36
+ this.txIndexInBlock,
37
+ this.eventIndexInTx,
38
+ this.contractAddress,
39
+ this.eventSelector.toBuffer(),
40
+ scopesArray.length,
41
+ ...scopesArray,
42
+ );
43
+ }
44
+
45
+ static fromBuffer(buffer: Buffer): StoredPrivateEvent {
46
+ const reader = BufferReader.asReader(buffer);
47
+
48
+ const randomness = Fr.fromBuffer(reader);
49
+ const msgContentLength = reader.readNumber();
50
+ const msgContent = reader.readArray(msgContentLength, Fr);
51
+ const l2BlockNumber = reader.readNumber();
52
+ const l2BlockHash = BlockHash.fromBuffer(reader);
53
+ const txHash = TxHash.fromBuffer(reader);
54
+ const txIndexInBlock = reader.readNumber();
55
+ const eventIndexInTx = reader.readNumber();
56
+ const contractAddress = AztecAddress.fromBuffer(reader);
57
+ const eventSelector = EventSelector.fromBuffer(reader);
58
+ const scopes = reader.readVector({ fromBuffer: (r: BufferReader) => r.readString() });
59
+
60
+ return new StoredPrivateEvent(
61
+ randomness,
62
+ msgContent,
63
+ l2BlockNumber,
64
+ l2BlockHash,
65
+ txHash,
66
+ txIndexInBlock,
67
+ eventIndexInTx,
68
+ contractAddress,
69
+ eventSelector,
70
+ new Set(scopes),
71
+ );
72
+ }
73
+ }
@@ -0,0 +1,68 @@
1
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
2
+ import type { BlockHash } from '@aztec/stdlib/block';
3
+ import { MAX_LOGS_PER_TAG } from '@aztec/stdlib/interfaces/api-limit';
4
+ import type { AztecNode } from '@aztec/stdlib/interfaces/client';
5
+ import type { SiloedTag, Tag, TxScopedL2Log } from '@aztec/stdlib/logs';
6
+
7
+ /**
8
+ * Generic pagination helper that fetches all pages of results.
9
+ * @param numTags - The number of tags being queried (determines result array size).
10
+ * @param fetchPage - Function that fetches a single page of results given a page number.
11
+ * @returns An array of arrays, one per tag, containing all results across all pages.
12
+ */
13
+ async function getAllPages<T>(numTags: number, fetchPage: (page: number) => Promise<T[][]>): Promise<T[][]> {
14
+ const allResultsPerTag: T[][] = Array.from({ length: numTags }, () => []);
15
+ let page = 0;
16
+ let hasMore = true;
17
+
18
+ while (hasMore) {
19
+ const resultsPage = await fetchPage(page);
20
+ hasMore = false;
21
+
22
+ for (let i = 0; i < resultsPage.length; i++) {
23
+ allResultsPerTag[i].push(...resultsPage[i]);
24
+ if (resultsPage[i].length === MAX_LOGS_PER_TAG) {
25
+ hasMore = true;
26
+ }
27
+ }
28
+ page++;
29
+ }
30
+
31
+ return allResultsPerTag;
32
+ }
33
+
34
+ /**
35
+ * Fetches all private logs for the given tags, automatically paginating through all pages.
36
+ * @param aztecNode - The Aztec node to query.
37
+ * @param tags - The siloed tags to search for.
38
+ * @param anchorBlockHash - reference block for the Aztec node query, throws if block is not found there (typically
39
+ * because of reorgs).
40
+ * @returns An array of log arrays, one per tag, containing all logs across all pages.
41
+ */
42
+ export function getAllPrivateLogsByTags(
43
+ aztecNode: AztecNode,
44
+ tags: SiloedTag[],
45
+ anchorBlockHash: BlockHash,
46
+ ): Promise<TxScopedL2Log[][]> {
47
+ return getAllPages(tags.length, page => aztecNode.getPrivateLogsByTags(tags, page, anchorBlockHash));
48
+ }
49
+
50
+ /**
51
+ * Fetches all public logs for the given tags from a contract, automatically paginating through all pages.
52
+ * @param aztecNode - The Aztec node to query.
53
+ * @param contractAddress - The contract address to search logs for.
54
+ * @param tags - The tags to search for.
55
+ * @param anchorBlockHash - reference block for the Aztec node query, throws if block is not found there (typically
56
+ * because of reorgs).
57
+ * @returns An array of log arrays, one per tag, containing all logs across all pages.
58
+ */
59
+ export function getAllPublicLogsByTagsFromContract(
60
+ aztecNode: AztecNode,
61
+ contractAddress: AztecAddress,
62
+ tags: Tag[],
63
+ anchorBlockHash: BlockHash,
64
+ ): Promise<TxScopedL2Log[][]> {
65
+ return getAllPages(tags.length, page =>
66
+ aztecNode.getPublicLogsByTagsFromContract(contractAddress, tags, page, anchorBlockHash),
67
+ );
68
+ }
@@ -12,6 +12,7 @@
12
12
  export { loadPrivateLogsForSenderRecipientPair } from './recipient_sync/load_private_logs_for_sender_recipient_pair.js';
13
13
  export { syncSenderTaggingIndexes } from './sender_sync/sync_sender_tagging_indexes.js';
14
14
  export { UNFINALIZED_TAGGING_INDEXES_WINDOW_LEN } from './constants.js';
15
+ export { getAllPrivateLogsByTags, getAllPublicLogsByTagsFromContract } from './get_all_logs_by_tags.js';
15
16
 
16
17
  // Re-export tagging-related types from stdlib
17
18
  export { DirectionalAppTaggingSecret, Tag, SiloedTag } from '@aztec/stdlib/logs';