@aztec/pxe 0.0.1-commit.fcb71a6 → 0.0.1-commit.ff7989d6c

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 (266) hide show
  1. package/dest/access_scopes.d.ts +9 -0
  2. package/dest/access_scopes.d.ts.map +1 -0
  3. package/dest/access_scopes.js +6 -0
  4. package/dest/bin/check_oracle_version.js +1 -1
  5. package/dest/block_synchronizer/block_synchronizer.d.ts +13 -5
  6. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  7. package/dest/block_synchronizer/block_synchronizer.js +74 -20
  8. package/dest/config/index.d.ts +3 -1
  9. package/dest/config/index.d.ts.map +1 -1
  10. package/dest/config/index.js +17 -0
  11. package/dest/config/package_info.js +1 -1
  12. package/dest/contract_function_simulator/benchmarked_node.d.ts +9 -0
  13. package/dest/contract_function_simulator/benchmarked_node.d.ts.map +1 -0
  14. package/dest/contract_function_simulator/benchmarked_node.js +77 -0
  15. package/dest/contract_function_simulator/contract_function_simulator.d.ts +57 -34
  16. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/contract_function_simulator.js +197 -82
  18. package/dest/contract_function_simulator/execution_note_cache.d.ts +18 -9
  19. package/dest/contract_function_simulator/execution_note_cache.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/execution_note_cache.js +45 -28
  21. package/dest/contract_function_simulator/index.d.ts +2 -2
  22. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  23. package/dest/contract_function_simulator/index.js +1 -1
  24. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +4 -3
  25. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  26. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +7 -4
  27. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +3 -3
  28. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  29. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +2 -2
  30. package/dest/contract_function_simulator/noir-structs/utility_context.d.ts +4 -10
  31. package/dest/contract_function_simulator/noir-structs/utility_context.d.ts.map +1 -1
  32. package/dest/contract_function_simulator/noir-structs/utility_context.js +7 -18
  33. package/dest/contract_function_simulator/oracle/interfaces.d.ts +17 -13
  34. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  35. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.d.ts +3 -1
  36. package/dest/contract_function_simulator/oracle/message_load_oracle_inputs.d.ts.map +1 -1
  37. package/dest/contract_function_simulator/oracle/note_packing_utils.d.ts +6 -6
  38. package/dest/contract_function_simulator/oracle/note_packing_utils.d.ts.map +1 -1
  39. package/dest/contract_function_simulator/oracle/note_packing_utils.js +8 -8
  40. package/dest/contract_function_simulator/oracle/oracle.d.ts +12 -10
  41. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  42. package/dest/contract_function_simulator/oracle/oracle.js +67 -44
  43. package/dest/contract_function_simulator/oracle/private_execution.d.ts +2 -26
  44. package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
  45. package/dest/contract_function_simulator/oracle/private_execution.js +1 -37
  46. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +44 -50
  47. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  48. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +83 -54
  49. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +67 -33
  50. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  51. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +131 -110
  52. package/dest/contract_logging.d.ts +22 -0
  53. package/dest/contract_logging.d.ts.map +1 -0
  54. package/dest/contract_logging.js +23 -0
  55. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  56. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  57. package/dest/contract_sync/contract_sync_service.js +97 -0
  58. package/dest/contract_sync/helpers.d.ts +29 -0
  59. package/dest/contract_sync/helpers.d.ts.map +1 -0
  60. package/dest/contract_sync/helpers.js +55 -0
  61. package/dest/debug/pxe_debug_utils.d.ts +24 -10
  62. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  63. package/dest/debug/pxe_debug_utils.js +28 -17
  64. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  65. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  66. package/dest/entrypoints/client/bundle/index.js +3 -0
  67. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  68. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  69. package/dest/entrypoints/client/bundle/utils.js +31 -8
  70. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  71. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  72. package/dest/entrypoints/client/lazy/index.js +3 -0
  73. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  74. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  75. package/dest/entrypoints/client/lazy/utils.js +32 -9
  76. package/dest/entrypoints/pxe_creation_options.d.ts +5 -3
  77. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  78. package/dest/entrypoints/server/index.d.ts +5 -1
  79. package/dest/entrypoints/server/index.d.ts.map +1 -1
  80. package/dest/entrypoints/server/index.js +4 -0
  81. package/dest/entrypoints/server/utils.d.ts +1 -1
  82. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  83. package/dest/entrypoints/server/utils.js +39 -16
  84. package/dest/events/event_service.d.ts +6 -6
  85. package/dest/events/event_service.d.ts.map +1 -1
  86. package/dest/events/event_service.js +19 -22
  87. package/dest/events/private_event_filter_validator.d.ts +5 -5
  88. package/dest/events/private_event_filter_validator.d.ts.map +1 -1
  89. package/dest/events/private_event_filter_validator.js +5 -6
  90. package/dest/job_coordinator/job_coordinator.d.ts +75 -0
  91. package/dest/job_coordinator/job_coordinator.d.ts.map +1 -0
  92. package/dest/job_coordinator/job_coordinator.js +94 -0
  93. package/dest/logs/log_service.d.ts +8 -5
  94. package/dest/logs/log_service.d.ts.map +1 -1
  95. package/dest/logs/log_service.js +28 -30
  96. package/dest/notes/note_service.d.ts +10 -9
  97. package/dest/notes/note_service.d.ts.map +1 -1
  98. package/dest/notes/note_service.js +34 -38
  99. package/dest/notes_filter.d.ts +25 -0
  100. package/dest/notes_filter.d.ts.map +1 -0
  101. package/dest/notes_filter.js +4 -0
  102. package/dest/oracle_version.d.ts +3 -3
  103. package/dest/oracle_version.d.ts.map +1 -1
  104. package/dest/oracle_version.js +4 -3
  105. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  106. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  107. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  108. package/dest/private_kernel/hints/index.d.ts +3 -3
  109. package/dest/private_kernel/hints/index.d.ts.map +1 -1
  110. package/dest/private_kernel/hints/index.js +2 -2
  111. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +28 -0
  112. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -0
  113. package/dest/private_kernel/hints/{build_private_kernel_reset_private_inputs.js → private_kernel_reset_private_inputs_builder.js} +16 -10
  114. package/dest/private_kernel/private_kernel_execution_prover.d.ts +3 -2
  115. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  116. package/dest/private_kernel/private_kernel_execution_prover.js +12 -13
  117. package/dest/private_kernel/private_kernel_oracle.d.ts +24 -24
  118. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  119. package/dest/private_kernel/private_kernel_oracle.js +94 -2
  120. package/dest/pxe.d.ts +76 -58
  121. package/dest/pxe.d.ts.map +1 -1
  122. package/dest/pxe.js +149 -138
  123. package/dest/storage/address_store/address_store.d.ts +1 -1
  124. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  125. package/dest/storage/address_store/address_store.js +12 -11
  126. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
  127. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  128. package/dest/storage/anchor_block_store/anchor_block_store.js +8 -1
  129. package/dest/storage/capsule_store/capsule_store.d.ts +24 -9
  130. package/dest/storage/capsule_store/capsule_store.d.ts.map +1 -1
  131. package/dest/storage/capsule_store/capsule_store.js +130 -23
  132. package/dest/storage/contract_store/contract_store.d.ts +42 -16
  133. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  134. package/dest/storage/contract_store/contract_store.js +157 -84
  135. package/dest/storage/metadata.d.ts +1 -1
  136. package/dest/storage/metadata.js +1 -1
  137. package/dest/storage/note_store/note_store.d.ts +50 -51
  138. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  139. package/dest/storage/note_store/note_store.js +284 -263
  140. package/dest/storage/note_store/stored_note.d.ts +16 -0
  141. package/dest/storage/note_store/stored_note.d.ts.map +1 -0
  142. package/dest/storage/note_store/stored_note.js +43 -0
  143. package/dest/storage/private_event_store/private_event_store.d.ts +47 -7
  144. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  145. package/dest/storage/private_event_store/private_event_store.js +231 -73
  146. package/dest/storage/private_event_store/stored_private_event.d.ts +23 -0
  147. package/dest/storage/private_event_store/stored_private_event.d.ts.map +1 -0
  148. package/dest/storage/private_event_store/stored_private_event.js +56 -0
  149. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +15 -8
  150. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  151. package/dest/storage/tagging_store/recipient_tagging_store.js +88 -19
  152. package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
  153. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
  154. package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
  155. package/dest/storage/tagging_store/sender_tagging_store.d.ts +19 -9
  156. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  157. package/dest/storage/tagging_store/sender_tagging_store.js +253 -101
  158. package/dest/tagging/constants.d.ts +2 -0
  159. package/dest/tagging/constants.d.ts.map +1 -0
  160. package/dest/tagging/constants.js +10 -0
  161. package/dest/tagging/get_all_logs_by_tags.d.ts +24 -0
  162. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -0
  163. package/dest/tagging/get_all_logs_by_tags.js +60 -0
  164. package/dest/tagging/index.d.ts +3 -2
  165. package/dest/tagging/index.d.ts.map +1 -1
  166. package/dest/tagging/index.js +2 -10
  167. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +3 -2
  168. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  169. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +12 -12
  170. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  171. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +3 -2
  172. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  173. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +5 -2
  174. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +3 -2
  175. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  176. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +8 -8
  177. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +1 -1
  178. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  179. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +5 -8
  180. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -2
  181. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  182. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +10 -5
  183. package/package.json +27 -18
  184. package/src/access_scopes.ts +9 -0
  185. package/src/bin/check_oracle_version.ts +1 -0
  186. package/src/block_synchronizer/block_synchronizer.ts +93 -32
  187. package/src/config/index.ts +14 -0
  188. package/src/config/package_info.ts +1 -1
  189. package/src/contract_function_simulator/benchmarked_node.ts +103 -0
  190. package/src/contract_function_simulator/contract_function_simulator.ts +350 -143
  191. package/src/contract_function_simulator/execution_note_cache.ts +44 -25
  192. package/src/contract_function_simulator/index.ts +1 -1
  193. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +6 -2
  194. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +2 -2
  195. package/src/contract_function_simulator/noir-structs/utility_context.ts +6 -25
  196. package/src/contract_function_simulator/oracle/interfaces.ts +22 -12
  197. package/src/contract_function_simulator/oracle/note_packing_utils.ts +10 -10
  198. package/src/contract_function_simulator/oracle/oracle.ts +79 -47
  199. package/src/contract_function_simulator/oracle/private_execution.ts +1 -69
  200. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +119 -137
  201. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +198 -115
  202. package/src/contract_logging.ts +39 -0
  203. package/src/contract_sync/contract_sync_service.ts +152 -0
  204. package/src/contract_sync/helpers.ts +98 -0
  205. package/src/debug/pxe_debug_utils.ts +63 -18
  206. package/src/entrypoints/client/bundle/index.ts +3 -0
  207. package/src/entrypoints/client/bundle/utils.ts +23 -16
  208. package/src/entrypoints/client/lazy/index.ts +3 -0
  209. package/src/entrypoints/client/lazy/utils.ts +24 -17
  210. package/src/entrypoints/pxe_creation_options.ts +4 -2
  211. package/src/entrypoints/server/index.ts +4 -0
  212. package/src/entrypoints/server/utils.ts +33 -41
  213. package/src/events/event_service.ts +19 -25
  214. package/src/events/private_event_filter_validator.ts +3 -5
  215. package/src/job_coordinator/job_coordinator.ts +150 -0
  216. package/src/logs/log_service.ts +40 -34
  217. package/src/notes/note_service.ts +41 -45
  218. package/src/notes_filter.ts +26 -0
  219. package/src/oracle_version.ts +4 -3
  220. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  221. package/src/private_kernel/hints/index.ts +2 -2
  222. package/src/private_kernel/hints/{build_private_kernel_reset_private_inputs.ts → private_kernel_reset_private_inputs_builder.ts} +39 -28
  223. package/src/private_kernel/private_kernel_execution_prover.ts +15 -14
  224. package/src/private_kernel/private_kernel_oracle.ts +116 -36
  225. package/src/pxe.ts +280 -209
  226. package/src/storage/address_store/address_store.ts +15 -15
  227. package/src/storage/anchor_block_store/anchor_block_store.ts +8 -0
  228. package/src/storage/capsule_store/capsule_store.ts +159 -23
  229. package/src/storage/contract_store/contract_store.ts +186 -96
  230. package/src/storage/metadata.ts +1 -1
  231. package/src/storage/note_store/note_store.ts +326 -320
  232. package/src/storage/note_store/stored_note.ts +48 -0
  233. package/src/storage/private_event_store/private_event_store.ts +301 -79
  234. package/src/storage/private_event_store/stored_private_event.ts +73 -0
  235. package/src/storage/tagging_store/recipient_tagging_store.ts +106 -20
  236. package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
  237. package/src/storage/tagging_store/sender_tagging_store.ts +294 -109
  238. package/src/tagging/constants.ts +10 -0
  239. package/src/tagging/get_all_logs_by_tags.ts +92 -0
  240. package/src/tagging/index.ts +2 -11
  241. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +25 -11
  242. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  243. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +7 -1
  244. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +10 -7
  245. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +5 -13
  246. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +16 -4
  247. package/dest/contract_function_simulator/proxied_node.d.ts +0 -9
  248. package/dest/contract_function_simulator/proxied_node.d.ts.map +0 -1
  249. package/dest/contract_function_simulator/proxied_node.js +0 -27
  250. package/dest/private_kernel/hints/build_private_kernel_reset_private_inputs.d.ts +0 -28
  251. package/dest/private_kernel/hints/build_private_kernel_reset_private_inputs.d.ts.map +0 -1
  252. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  253. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
  254. package/dest/private_kernel/private_kernel_oracle_impl.d.ts +0 -46
  255. package/dest/private_kernel/private_kernel_oracle_impl.d.ts.map +0 -1
  256. package/dest/private_kernel/private_kernel_oracle_impl.js +0 -86
  257. package/dest/public_storage/public_storage_service.d.ts +0 -24
  258. package/dest/public_storage/public_storage_service.d.ts.map +0 -1
  259. package/dest/public_storage/public_storage_service.js +0 -26
  260. package/dest/tree_membership/tree_membership_service.d.ts +0 -52
  261. package/dest/tree_membership/tree_membership_service.d.ts.map +0 -1
  262. package/dest/tree_membership/tree_membership_service.js +0 -84
  263. package/src/contract_function_simulator/proxied_node.ts +0 -33
  264. package/src/private_kernel/private_kernel_oracle_impl.ts +0 -133
  265. package/src/public_storage/public_storage_service.ts +0 -33
  266. package/src/tree_membership/tree_membership_service.ts +0 -112
@@ -1,412 +1,418 @@
1
- import { toBufferBE } from '@aztec/foundation/bigint-buffer';
2
- import type { Fr } from '@aztec/foundation/curves/bn254';
3
- import { toArray } from '@aztec/foundation/iterable';
1
+ import { Semaphore } from '@aztec/foundation/queue';
2
+ import type { Fr } from '@aztec/foundation/schemas';
4
3
  import type { AztecAsyncKVStore, AztecAsyncMap, AztecAsyncMultiMap } from '@aztec/kv-store';
5
- import { AztecAddress } from '@aztec/stdlib/aztec-address';
4
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
6
5
  import type { DataInBlock } from '@aztec/stdlib/block';
7
- import { NoteStatus, type NotesFilter } from '@aztec/stdlib/note';
8
- import { NoteDao } from '@aztec/stdlib/note';
6
+ import { NoteDao, NoteStatus } from '@aztec/stdlib/note';
7
+
8
+ import type { StagedStore } from '../../job_coordinator/job_coordinator.js';
9
+ import type { NotesFilter } from '../../notes_filter.js';
10
+ import { StoredNote } from './stored_note.js';
9
11
 
10
12
  /**
11
13
  * NoteStore manages the storage and retrieval of notes.
12
14
  *
13
- * Notes can be active or nullified. This class processes new notes, nullifications,
14
- * and performs rollback handling in the case of a reorg.
15
+ * Notes can be active or nullified. This class processes new notes, nullifications, and performs rollback handling in
16
+ * the case of a reorg.
15
17
  **/
16
- export class NoteStore {
18
+ export class NoteStore implements StagedStore {
19
+ readonly storeName: string = 'note';
20
+
17
21
  #store: AztecAsyncKVStore;
18
- #notes: AztecAsyncMap<string, Buffer>;
19
- #nullifiedNotes: AztecAsyncMap<string, Buffer>;
20
- #nullifierToNoteId: AztecAsyncMap<string, string>;
21
- #nullifiersByBlockNumber: AztecAsyncMultiMap<number, string>;
22
22
 
23
- #nullifiedNotesToScope: AztecAsyncMultiMap<string, string>;
24
- #nullifiedNotesByContract: AztecAsyncMultiMap<string, string>;
25
- #nullifiedNotesByStorageSlot: AztecAsyncMultiMap<string, string>;
26
- #nullifiedNotesByNullifier: AztecAsyncMap<string, string>;
23
+ // Note that we use the siloedNullifier as the note id in the store as it's guaranteed to be unique.
27
24
 
28
- #scopes: AztecAsyncMap<string, true>;
29
- #notesToScope: AztecAsyncMultiMap<string, string>;
30
- #notesByContractAndScope: Map<string, AztecAsyncMultiMap<string, string>>;
31
- #notesByStorageSlotAndScope: Map<string, AztecAsyncMultiMap<string, string>>;
25
+ // Main storage for notes. Avoid performing full scans on it as it contains all notes PXE knows, use
26
+ // #nullifiersByContractAddress or #nullifiersByNullificationBlockNumber to find relevant note nullifiers that can be
27
+ // used to read into this map instead.
28
+ // nullifier => StoredNote (serialized)
29
+ #notes: AztecAsyncMap<string, Buffer>;
32
30
 
33
- private constructor(store: AztecAsyncKVStore) {
34
- this.#store = store;
35
- this.#notes = store.openMap('notes');
36
- this.#nullifiedNotes = store.openMap('nullified_notes');
37
- this.#nullifierToNoteId = store.openMap('nullifier_to_note');
38
- this.#nullifiersByBlockNumber = store.openMultiMap('nullifier_to_block_number');
39
-
40
- this.#nullifiedNotesToScope = store.openMultiMap('nullified_notes_to_scope');
41
- this.#nullifiedNotesByContract = store.openMultiMap('nullified_notes_by_contract');
42
- this.#nullifiedNotesByStorageSlot = store.openMultiMap('nullified_notes_by_storage_slot');
43
- this.#nullifiedNotesByNullifier = store.openMap('nullified_notes_by_nullifier');
44
-
45
- this.#scopes = store.openMap('scopes');
46
- this.#notesToScope = store.openMultiMap('notes_to_scope');
47
- this.#notesByContractAndScope = new Map<string, AztecAsyncMultiMap<string, string>>();
48
- this.#notesByStorageSlotAndScope = new Map<string, AztecAsyncMultiMap<string, string>>();
49
- }
31
+ // Indexes which notes (via their nullifiers) belong to a contract. Used in `getNotes` to reduce the amount of notes
32
+ // checked.
33
+ // contract address => nullifier
34
+ #nullifiersByContractAddress: AztecAsyncMultiMap<string, string>;
50
35
 
51
- /**
52
- * Creates and initializes a new NoteStore instance.
53
- *
54
- * This factory method creates a NoteStore and restores any existing
55
- * scope-specific indexes from the database.
56
- *
57
- * @param store - The key-value store to use for persistence
58
- * @returns Promise resolving to a fully initialized NoteStore instance
59
- */
60
- public static async create(store: AztecAsyncKVStore): Promise<NoteStore> {
61
- const pxeDB = new NoteStore(store);
62
- for await (const scope of pxeDB.#scopes.keysAsync()) {
63
- pxeDB.#notesByContractAndScope.set(scope, store.openMultiMap(`${scope}:notes_by_contract`));
64
- pxeDB.#notesByStorageSlotAndScope.set(scope, store.openMultiMap(`${scope}:notes_by_storage_slot`));
65
- }
66
- return pxeDB;
67
- }
36
+ // Groups note nullifiers by the block number they were added to the nullifier tree. Used in `rollback` to handle
37
+ // re-orgs.
38
+ // block number => nullifier (block number in which nullifier is included)
39
+ #nullifiersByNullificationBlockNumber: AztecAsyncMultiMap<number, string>;
68
40
 
69
- /**
70
- * Adds a new scope to the note data provider.
71
- *
72
- * Scopes provide privacy isolation by creating separate indexes for each user.
73
- * Each scope gets its own set of indexes for efficient note retrieval by various criteria.
74
- *
75
- * @param scope - The AztecAddress representing the scope/user to add
76
- * @returns Promise resolving to true if scope was added, false if it already existed
77
- */
78
- public async addScope(scope: AztecAddress): Promise<boolean> {
79
- const scopeString = scope.toString();
41
+ // In-memory changes performed during a not-yet committed job. When `commit` is called with said job's id, these
42
+ // changes are persisted in the DB maps specified above and cleared.
43
+ // jobId => nullifier => StoredNote (serialized)
44
+ #notesForJob: Map<string, Map<string, StoredNote>>;
80
45
 
81
- if (await this.#scopes.hasAsync(scopeString)) {
82
- return false;
83
- }
46
+ // Per job locks to prevent multiple concurrent writes to affect each other.
47
+ // jobId => lock
48
+ #jobLocks: Map<string, Semaphore>;
84
49
 
85
- await this.#scopes.set(scopeString, true);
86
- this.#notesByContractAndScope.set(scopeString, this.#store.openMultiMap(`${scopeString}:notes_by_contract`));
87
- this.#notesByStorageSlotAndScope.set(scopeString, this.#store.openMultiMap(`${scopeString}:notes_by_storage_slot`));
50
+ constructor(store: AztecAsyncKVStore) {
51
+ this.#store = store;
52
+ this.#notes = store.openMap('notes');
53
+ this.#nullifiersByContractAddress = store.openMultiMap('note_nullifiers_by_contract');
54
+ this.#nullifiersByNullificationBlockNumber = store.openMultiMap('note_block_number_to_nullifier');
88
55
 
89
- return true;
56
+ this.#jobLocks = new Map();
57
+ this.#notesForJob = new Map();
90
58
  }
91
59
 
92
60
  /**
93
- * Adds multiple notes to the data provider under the specified scope.
61
+ * Adds multiple notes to the notes store under the specified scope.
94
62
  *
95
- * Notes are stored using their index from the notes hash tree as the key, which provides
96
- * uniqueness and maintains creation order. Each note is indexed by multiple criteria
97
- * for efficient retrieval.
63
+ * Notes are stored using their siloedNullifier as the key, which provides uniqueness. Each note is indexed by
64
+ * multiple criteria for efficient retrieval.
98
65
  *
99
66
  * @param notes - Notes to store
100
67
  * @param scope - The scope (user/account) under which to store the notes
68
+ * @param jobId - The job context for staged writes
101
69
  */
102
- addNotes(notes: NoteDao[], scope: AztecAddress): Promise<void> {
103
- return this.#store.transactionAsync(async () => {
104
- if (!(await this.#scopes.hasAsync(scope.toString()))) {
105
- await this.addScope(scope);
106
- }
107
-
108
- for (const dao of notes) {
109
- const noteIndex = toBufferBE(dao.index, 32).toString('hex');
110
- await this.#notes.set(noteIndex, dao.toBuffer());
111
- await this.#notesToScope.set(noteIndex, scope.toString());
112
- await this.#nullifierToNoteId.set(dao.siloedNullifier.toString(), noteIndex);
113
-
114
- await this.#notesByContractAndScope.get(scope.toString())!.set(dao.contractAddress.toString(), noteIndex);
115
- await this.#notesByStorageSlotAndScope.get(scope.toString())!.set(dao.storageSlot.toString(), noteIndex);
116
- }
117
- });
118
- }
119
-
120
- /**
121
- * Synchronizes notes and nullifiers to a specific block number.
122
- *
123
- * This method ensures that the state of notes and nullifiers is consistent with the
124
- * specified block number. It restores any notes that were nullified after the given block
125
- * and deletes any active notes created after that block.
126
- *
127
- * @param blockNumber - The new chain tip after a reorg
128
- * @param synchedBlockNumber - The block number up to which PXE managed to sync before the reorg happened.
129
- */
130
- public async rollbackNotesAndNullifiers(blockNumber: number, synchedBlockNumber: number): Promise<void> {
131
- await this.#rewindNullifiersAfterBlock(blockNumber, synchedBlockNumber);
132
- await this.#deleteActiveNotesAfterBlock(blockNumber);
70
+ public addNotes(notes: NoteDao[], scope: AztecAddress, jobId: string): Promise<void[]> {
71
+ return this.#withJobLock(jobId, () =>
72
+ this.#store.transactionAsync(() =>
73
+ Promise.all(
74
+ notes.map(async note => {
75
+ const noteForJob =
76
+ (await this.#readNote(note.siloedNullifier.toString(), jobId)) ?? new StoredNote(note, new Set());
77
+ noteForJob.addScope(scope.toString());
78
+ this.#writeNote(noteForJob, jobId);
79
+ }),
80
+ ),
81
+ ),
82
+ );
133
83
  }
134
84
 
135
- /**
136
- * Deletes (removes) all active notes created after the specified block number.
137
- *
138
- * Permanently delete notes from the active notes store, e.g. during a reorg.
139
- * Note: This only affects #notes (active notes), not #nullifiedNotes.
140
- *
141
- * @param blockNumber - Notes created after this block number will be deleted
142
- */
143
- #deleteActiveNotesAfterBlock(blockNumber: number): Promise<void> {
144
- return this.#store.transactionAsync(async () => {
145
- const notes = await toArray(this.#notes.valuesAsync());
146
- for (const note of notes) {
147
- const noteDao = NoteDao.fromBuffer(note);
148
- if (noteDao.l2BlockNumber > blockNumber) {
149
- const noteIndex = toBufferBE(noteDao.index, 32).toString('hex');
150
- await this.#notes.delete(noteIndex);
151
- await this.#notesToScope.delete(noteIndex);
152
- await this.#nullifierToNoteId.delete(noteDao.siloedNullifier.toString());
153
- const scopes = await toArray(this.#scopes.keysAsync());
154
- for (const scope of scopes) {
155
- await this.#notesByContractAndScope.get(scope)!.deleteValue(noteDao.contractAddress.toString(), noteIndex);
156
- await this.#notesByStorageSlotAndScope.get(scope)!.deleteValue(noteDao.storageSlot.toString(), noteIndex);
157
- }
158
- }
159
- }
160
- });
85
+ async #readNote(nullifier: string, jobId: string): Promise<StoredNote | undefined> {
86
+ // Always issue DB read to keep IndexedDB transaction alive (they auto-commit when a new micro-task starts and there
87
+ // are no pending read requests). The staged value still takes precedence if it exists.
88
+ const noteBuffer = await this.#notes.getAsync(nullifier);
89
+ const noteForJob = this.#getNotesForJob(jobId).get(nullifier);
90
+ return noteForJob ?? (noteBuffer ? StoredNote.fromBuffer(noteBuffer) : undefined);
161
91
  }
162
92
 
163
- /**
164
- * Rewinds nullifications after a given block number.
165
- *
166
- * This operation "unnullifies" notes, rolling back nullifications that occurred
167
- * in orphaned blocks, e.g. during a reorg. The notes are restored to the
168
- * active notes store and removed from the nullified store.
169
- *
170
- * @param blockNumber - Revert nullifications that occurred after this block
171
- * @param synchedBlockNumber - Upper bound for the block range to process
172
- */
173
- async #rewindNullifiersAfterBlock(blockNumber: number, synchedBlockNumber: number): Promise<void> {
174
- await this.#store.transactionAsync(async () => {
175
- const nullifiersToUndo: string[] = [];
176
- const currentBlockNumber = blockNumber + 1;
177
- for (let i = currentBlockNumber; i <= synchedBlockNumber; i++) {
178
- nullifiersToUndo.push(...(await toArray(this.#nullifiersByBlockNumber.getValuesAsync(i))));
179
- }
180
- const notesIndexesToReinsert = await Promise.all(
181
- nullifiersToUndo.map(nullifier => this.#nullifiedNotesByNullifier.getAsync(nullifier)),
182
- );
183
- const notNullNoteIndexes = notesIndexesToReinsert.filter(noteIndex => noteIndex != undefined);
184
- const nullifiedNoteBuffers = await Promise.all(
185
- notNullNoteIndexes.map(noteIndex => this.#nullifiedNotes.getAsync(noteIndex!)),
186
- );
187
- const noteDaos = nullifiedNoteBuffers
188
- .filter(buffer => buffer != undefined)
189
- .map(buffer => NoteDao.fromBuffer(buffer!));
190
-
191
- for (const dao of noteDaos) {
192
- const noteIndex = toBufferBE(dao.index, 32).toString('hex');
193
- await this.#notes.set(noteIndex, dao.toBuffer());
194
- await this.#nullifierToNoteId.set(dao.siloedNullifier.toString(), noteIndex);
195
-
196
- const scopes = await toArray(this.#nullifiedNotesToScope.getValuesAsync(noteIndex));
197
-
198
- if (scopes.length === 0) {
199
- // We should never run into this error because notes always have a scope assigned to them - either on initial
200
- // insertion via `addNotes` or when removing their nullifiers.
201
- throw new Error(`No scopes found for nullified note with index ${noteIndex}`);
202
- }
203
-
204
- for (const scope of scopes) {
205
- await this.#notesByContractAndScope.get(scope.toString())!.set(dao.contractAddress.toString(), noteIndex);
206
- await this.#notesByStorageSlotAndScope.get(scope.toString())!.set(dao.storageSlot.toString(), noteIndex);
207
- await this.#notesToScope.set(noteIndex, scope);
208
- }
209
-
210
- await this.#nullifiedNotes.delete(noteIndex);
211
- await this.#nullifiedNotesToScope.delete(noteIndex);
212
- await this.#nullifiersByBlockNumber.deleteValue(dao.l2BlockNumber, dao.siloedNullifier.toString());
213
- await this.#nullifiedNotesByContract.deleteValue(dao.contractAddress.toString(), noteIndex);
214
- await this.#nullifiedNotesByStorageSlot.deleteValue(dao.storageSlot.toString(), noteIndex);
215
- await this.#nullifiedNotesByNullifier.delete(dao.siloedNullifier.toString());
216
- }
217
- });
93
+ #writeNote(note: StoredNote, jobId: string) {
94
+ this.#getNotesForJob(jobId).set(note.noteDao.siloedNullifier.toString(), note);
218
95
  }
219
96
 
220
97
  /**
221
98
  * Retrieves notes based on the provided filter criteria.
222
99
  *
223
- * This method queries both active and optionally nullified notes based on the filter
224
- * parameters.
100
+ * This method queries both active and optionally nullified notes based on the filter parameters.
225
101
  *
226
- * @param filter - Filter criteria including contractAddress (required), and optional
227
- * owner, storageSlot, status, scopes, and siloedNullifier.
102
+ * @param filter - Filter criteria including contractAddress (required), and optional owner,
103
+ * storageSlot, status, scopes, and siloedNullifier.
104
+ * @params jobId - the job context to read from.
228
105
  * @returns Filtered and deduplicated notes (a note might be present in multiple scopes - we ensure it is only
229
106
  * returned once if this is the case)
230
- * @throws If filtering by an empty scopes array. Scopes have to be set to undefined or to a non-empty array.
231
107
  */
232
- async getNotes(filter: NotesFilter): Promise<NoteDao[]> {
233
- filter.status = filter.status ?? NoteStatus.ACTIVE;
234
-
235
- // throw early if scopes is an empty array
236
- if (filter.scopes !== undefined && filter.scopes.length === 0) {
237
- throw new Error(
238
- 'Trying to get notes with an empty scopes array. Scopes have to be set to undefined if intending on not filtering by scopes.',
239
- );
108
+ getNotes(filter: NotesFilter, jobId: string): Promise<NoteDao[]> {
109
+ if (filter.scopes !== 'ALL_SCOPES' && filter.scopes.length === 0) {
110
+ return Promise.resolve([]);
240
111
  }
241
112
 
242
- const candidateNoteSources = [];
243
-
244
- filter.scopes ??= (await toArray(this.#scopes.keysAsync())).map(addressString =>
245
- AztecAddress.fromString(addressString),
246
- );
247
-
248
- const activeNoteIdsPerScope: string[][] = [];
249
-
250
- for (const scope of new Set(filter.scopes)) {
251
- const formattedScopeString = scope.toString();
252
- if (!(await this.#scopes.hasAsync(formattedScopeString))) {
253
- throw new Error('Trying to get incoming notes of a scope that is not in the PXE database');
113
+ return this.#store.transactionAsync(async () => {
114
+ const targetStatus = filter.status ?? NoteStatus.ACTIVE;
115
+
116
+ // The code below might read a bit unnatural, the reason is that we need to be careful in how we use `await` inside
117
+ // `transactionAsync`, otherwise browsers might choose to auto-commit the IndexedDB transaction forcing us to
118
+ // explicitly handle that condition. The rule we need to honor is: do not await unless you generate a database
119
+ // read or write or you're done using the DB for the remainder of the transaction. The following sequence is
120
+ // unsafe in IndexedDB:
121
+ //
122
+ // 1. start transactionAsync()
123
+ // 2. await readDb() <-- OK, transaction alive because we issued DB ops
124
+ // 3. run a bunch of computations (no await involved) <-- OK, tx alive because we are in the same microtask
125
+ // 4. await doSthNotInDb() <-- no DB ops issued in this task, browser's free to decide to commit the tx
126
+ // 5. await readDb() <-- BOOM, TransactionInactiveError
127
+ //
128
+ // Note that the real issue is in step number 5: we try to continue using a transaction that the browser might
129
+ // have already committed.
130
+ //
131
+ // We need to read candidate notes which are either indexed by contract address in the DB (in
132
+ // #nullifiersByContractAddress), or lie in memory for the not yet committed `jobId`.
133
+ // So we collect promises based on both sources without awaiting for them.
134
+ const noteReadPromises: Map<string, Promise<StoredNote | undefined>> = new Map();
135
+
136
+ // Awaiting the getValuesAsync iterator is fine because it's reading from the DB
137
+ for await (const nullifier of this.#nullifiersByContractAddress.getValuesAsync(
138
+ filter.contractAddress.toString(),
139
+ )) {
140
+ // Each #readNote will perform a DB read
141
+ noteReadPromises.set(nullifier, this.#readNote(nullifier, jobId));
254
142
  }
255
143
 
256
- activeNoteIdsPerScope.push(
257
- filter.storageSlot
258
- ? await toArray(
259
- this.#notesByStorageSlotAndScope.get(formattedScopeString)!.getValuesAsync(filter.storageSlot.toString()),
260
- )
261
- : await toArray(
262
- this.#notesByContractAndScope
263
- .get(formattedScopeString)!
264
- .getValuesAsync(filter.contractAddress.toString()),
265
- ),
266
- );
267
- }
268
-
269
- candidateNoteSources.push({
270
- ids: new Set(activeNoteIdsPerScope.flat()),
271
- notes: this.#notes,
272
- });
144
+ // Add staged nullifiers from job, no awaits involved, so we are fine
145
+ for (const storedNote of this.#getNotesForJob(jobId).values()) {
146
+ if (storedNote.noteDao.contractAddress.equals(filter.contractAddress)) {
147
+ const nullifier = storedNote.noteDao.siloedNullifier.toString();
148
+ if (!noteReadPromises.has(nullifier)) {
149
+ noteReadPromises.set(nullifier, Promise.resolve(storedNote));
150
+ }
151
+ }
152
+ }
273
153
 
274
- // If status is ACTIVE_OR_NULLIFIED we add nullified notes as candidates on top of the default active ones.
275
- if (filter.status === NoteStatus.ACTIVE_OR_NULLIFIED) {
276
- const nullifiedIds = filter.storageSlot
277
- ? await toArray(this.#nullifiedNotesByStorageSlot.getValuesAsync(filter.storageSlot.toString()))
278
- : await toArray(this.#nullifiedNotesByContract.getValuesAsync(filter.contractAddress.toString()));
154
+ // By now we have pending DB requests from all the #readNote calls. Await them all together.
155
+ const notes = await Promise.all(noteReadPromises.values());
279
156
 
280
- const setOfScopes = new Set(filter.scopes.map(s => s.toString() as string));
281
- const filteredNullifiedIds = new Set<string>();
157
+ // The rest of the function is await-free, and just deals with filtering and sorting our findings.
158
+ const foundNotes: Map<string, NoteDao> = new Map();
282
159
 
283
- for (const noteId of nullifiedIds) {
284
- const scopeList = await toArray(this.#nullifiedNotesToScope.getValuesAsync(noteId));
285
- if (scopeList.some(scope => setOfScopes.has(scope))) {
286
- filteredNullifiedIds.add(noteId);
160
+ for (const note of notes) {
161
+ // Defensive: hitting this case means we're mishandling contract indices or in-memory job data
162
+ if (!note) {
163
+ throw new Error('PXE note database is corrupted.');
287
164
  }
288
- }
289
165
 
290
- if (filteredNullifiedIds.size > 0) {
291
- candidateNoteSources.push({
292
- ids: filteredNullifiedIds,
293
- notes: this.#nullifiedNotes,
294
- });
295
- }
296
- }
297
-
298
- const result: NoteDao[] = [];
299
- for (const { ids, notes } of candidateNoteSources) {
300
- for (const id of ids) {
301
- const serializedNote = await notes.getAsync(id);
302
- if (!serializedNote) {
166
+ // Apply filters
167
+ if (targetStatus === NoteStatus.ACTIVE && note.isNullified()) {
303
168
  continue;
304
169
  }
305
170
 
306
- const note = NoteDao.fromBuffer(serializedNote);
307
- if (!note.contractAddress.equals(filter.contractAddress)) {
171
+ if (filter.owner && !note.noteDao.owner.equals(filter.owner)) {
308
172
  continue;
309
173
  }
310
174
 
311
- if (filter.owner && !note.owner.equals(filter.owner)) {
175
+ if (filter.storageSlot && !note.noteDao.storageSlot.equals(filter.storageSlot)) {
312
176
  continue;
313
177
  }
314
178
 
315
- if (filter.storageSlot && !note.storageSlot.equals(filter.storageSlot!)) {
179
+ if (filter.siloedNullifier && !note.noteDao.siloedNullifier.equals(filter.siloedNullifier)) {
316
180
  continue;
317
181
  }
318
182
 
319
- if (filter.siloedNullifier && !note.siloedNullifier.equals(filter.siloedNullifier)) {
183
+ if (
184
+ filter.scopes !== 'ALL_SCOPES' &&
185
+ note.scopes.intersection(new Set(filter.scopes.map(s => s.toString()))).size === 0
186
+ ) {
320
187
  continue;
321
188
  }
322
189
 
323
- result.push(note);
190
+ foundNotes.set(note.noteDao.siloedNullifier.toString(), note.noteDao);
324
191
  }
325
- }
326
-
327
- // A note might be present in multiple scopes - we ensure it is only returned once
328
- const deduplicated: NoteDao[] = [];
329
- for (const note of result) {
330
- if (!deduplicated.some(existing => existing.equals(note))) {
331
- deduplicated.push(note);
332
- }
333
- }
334
192
 
335
- return deduplicated;
193
+ // Sort by block number, then by tx index within block, then by note index within tx
194
+ return [...foundNotes.values()].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.noteIndexInTx - b.noteIndexInTx;
202
+ });
203
+ });
336
204
  }
337
205
 
338
206
  /**
339
207
  * Transitions notes from "active" to "nullified" state.
340
208
  *
341
- * This operation processes a batch of nullifiers to mark the corresponding notes
342
- * as spent/nullified. The operation is atomic - if any nullifier is not found,
343
- * the entire operation fails and no notes are modified.
209
+ * This operation processes a batch of nullifiers to mark the corresponding notes as spent/nullified.
210
+ * The operation is atomic - if any nullifier is not found, the entire operation fails and no notes are modified.
211
+ *
212
+ * applyNullifiers is idempotent: the same nullifier can be applied multiple times without error.
213
+ * This relaxes constraints on usage of NoteService#validateAndStoreNote, which can then be run concurrently in a Promise.all
214
+ * context without risking unnecessarily defensive checks failing.
344
215
  *
345
216
  * @param nullifiers - Array of nullifiers with their block numbers to process
346
- * @returns Promise resolving to array of nullified NoteDao objects
347
- * @throws Error if any nullifier is not found in the active notes
217
+ * @param jobId - The job context for staged writes
218
+ * @returns Array of NoteDao objects that were nullified
219
+ * @throws Error if any nullifier is not found in this notes store
348
220
  */
349
- applyNullifiers(nullifiers: DataInBlock<Fr>[]): Promise<NoteDao[]> {
221
+ applyNullifiers(nullifiers: DataInBlock<Fr>[], jobId: string): Promise<NoteDao[]> {
350
222
  if (nullifiers.length === 0) {
351
223
  return Promise.resolve([]);
352
224
  }
353
225
 
354
- return this.#store.transactionAsync(async () => {
355
- const nullifiedNotes: NoteDao[] = [];
356
-
357
- for (const blockScopedNullifier of nullifiers) {
358
- const { data: nullifier, l2BlockNumber: blockNumber } = blockScopedNullifier;
359
- const nullifierKey = nullifier.toString();
360
-
361
- const noteIndex = await this.#nullifierToNoteId.getAsync(nullifierKey);
362
- if (!noteIndex) {
363
- // Check if already nullified?
364
- const alreadyNullified = await this.#nullifiedNotesByNullifier.getAsync(nullifierKey);
365
- if (alreadyNullified) {
366
- throw new Error(`Nullifier already applied in applyNullifiers`);
226
+ if (nullifiers.some(n => n.l2BlockNumber === 0)) {
227
+ return Promise.reject(new Error('applyNullifiers: nullifiers cannot have been emitted at block 0'));
228
+ }
229
+
230
+ return this.#withJobLock(jobId, () =>
231
+ this.#store.transactionAsync(async () => {
232
+ const notesToNullify = await Promise.all(
233
+ nullifiers.map(async nullifierInBlock => {
234
+ const nullifier = nullifierInBlock.data.toString();
235
+
236
+ const storedNote = await this.#readNote(nullifier, jobId);
237
+ if (!storedNote) {
238
+ throw new Error(`Attempted to mark a note as nullified which does not exist in PXE DB`);
239
+ }
240
+
241
+ return { storedNote, blockNumber: nullifierInBlock.l2BlockNumber };
242
+ }),
243
+ );
244
+
245
+ const notesNullifiedInThisCall: Map<string, NoteDao> = new Map();
246
+ for (const noteToNullify of notesToNullify) {
247
+ const note = noteToNullify.storedNote;
248
+
249
+ // Skip already nullified notes
250
+ if (note.isNullified()) {
251
+ continue;
367
252
  }
368
- throw new Error('Nullifier not found in applyNullifiers');
253
+
254
+ note.markAsNullified(noteToNullify.blockNumber);
255
+ this.#writeNote(note, jobId);
256
+ notesNullifiedInThisCall.set(note.noteDao.siloedNullifier.toString(), note.noteDao);
369
257
  }
370
258
 
371
- const noteBuffer = noteIndex ? await this.#notes.getAsync(noteIndex) : undefined;
259
+ return [...notesNullifiedInThisCall.values()];
260
+ }),
261
+ );
262
+ }
372
263
 
264
+ /**
265
+ * Synchronizes notes and nullifiers to a specific block number.
266
+ *
267
+ * This method ensures that the state of notes and nullifiers is consistent with the specified block number.
268
+ * It restores any notes that were nullified after the given block and deletes any active notes created after that
269
+ * block.
270
+ *
271
+ * IMPORTANT: This method must be called within a transaction to ensure atomicity.
272
+ *
273
+ * @param blockNumber - The new chain tip after a reorg
274
+ * @param synchedBlockNumber - The block number up to which PXE managed to sync before the reorg happened.
275
+ */
276
+ public async rollback(blockNumber: number, synchedBlockNumber: number): Promise<void> {
277
+ if (this.#notesForJob.size > 0) {
278
+ throw new Error('PXE note store rollback is not allowed while jobs are running');
279
+ }
280
+ await this.#rewindNullifiedNotesAfterBlock(blockNumber, synchedBlockNumber);
281
+ await this.#deleteActiveNotesAfterBlock(blockNumber);
282
+ }
283
+
284
+ /**
285
+ * Deletes (removes) all notes created after the specified block number.
286
+ *
287
+ * Permanently delete notes from the notes store, e.g. during a reorg.
288
+ *
289
+ * @param blockNumber - Notes created after this block number will be deleted
290
+ */
291
+ async #deleteActiveNotesAfterBlock(blockNumber: number): Promise<void> {
292
+ // Collect notes to delete during iteration to keep IndexedDB transaction alive.
293
+ const notesToDelete: { nullifier: string; contractAddress: string }[] = [];
294
+ for await (const noteBuffer of this.#notes.valuesAsync()) {
295
+ const storedNote = StoredNote.fromBuffer(noteBuffer);
296
+ if (storedNote.noteDao.l2BlockNumber > blockNumber) {
297
+ notesToDelete.push({
298
+ nullifier: storedNote.noteDao.siloedNullifier.toString(),
299
+ contractAddress: storedNote.noteDao.contractAddress.toString(),
300
+ });
301
+ }
302
+ }
303
+
304
+ // Delete all collected notes. Each delete is a DB operation that keeps the transaction alive.
305
+ for (const { nullifier, contractAddress } of notesToDelete) {
306
+ await this.#notes.delete(nullifier);
307
+ await this.#nullifiersByContractAddress.deleteValue(contractAddress, nullifier);
308
+ }
309
+ }
310
+
311
+ /**
312
+ * Rewinds nullifications after a given block number.
313
+ *
314
+ * This operation "un-nullifies" notes, rolling back nullifications that occurred in orphaned blocks, e.g. during a
315
+ * reorg.
316
+ *
317
+ * @param blockNumber - Revert nullifications that occurred after this block
318
+ * @param anchorBlockNumber - Upper bound for the block range to process
319
+ */
320
+ async #rewindNullifiedNotesAfterBlock(blockNumber: number, anchorBlockNumber: number): Promise<void> {
321
+ // First pass: collect all nullifiers for all blocks, starting reads during iteration to keep tx alive.
322
+ const nullifiersByBlock: Map<number, { nullifier: string; noteReadPromise: Promise<Buffer | undefined> }[]> =
323
+ new Map();
324
+
325
+ for (let i = blockNumber + 1; i <= anchorBlockNumber; i++) {
326
+ const blockNullifiers: { nullifier: string; noteReadPromise: Promise<Buffer | undefined> }[] = [];
327
+ for await (const nullifier of this.#nullifiersByNullificationBlockNumber.getValuesAsync(i)) {
328
+ // Start read immediately during iteration to keep IndexedDB transaction alive
329
+ blockNullifiers.push({ nullifier, noteReadPromise: this.#notes.getAsync(nullifier) });
330
+ }
331
+ if (blockNullifiers.length > 0) {
332
+ nullifiersByBlock.set(i, blockNullifiers);
333
+ }
334
+ }
335
+
336
+ // Second pass: await reads and perform writes
337
+ for (const [block, nullifiers] of nullifiersByBlock) {
338
+ for (const { nullifier, noteReadPromise } of nullifiers) {
339
+ const noteBuffer = await noteReadPromise;
373
340
  if (!noteBuffer) {
374
- throw new Error('Note not found in applyNullifiers');
341
+ throw new Error(`PXE DB integrity error: no note found with nullifier ${nullifier}`);
375
342
  }
376
343
 
377
- const noteScopes = await toArray(this.#notesToScope.getValuesAsync(noteIndex));
378
- if (noteScopes.length === 0) {
379
- // We should never run into this error because notes always have a scope assigned to them - either on initial
380
- // insertion via `addNotes` or when removing their nullifiers.
381
- throw new Error('Note scopes are missing in applyNullifiers');
344
+ const storedNote = StoredNote.fromBuffer(noteBuffer);
345
+ if (storedNote.scopes.size === 0) {
346
+ throw new Error(`No scopes found for nullified note with nullifier ${nullifier}`);
382
347
  }
383
348
 
384
- const note = NoteDao.fromBuffer(noteBuffer);
349
+ storedNote.markAsActive();
385
350
 
386
- nullifiedNotes.push(note);
351
+ await Promise.all([
352
+ this.#notes.set(nullifier, storedNote.toBuffer()),
353
+ this.#nullifiersByNullificationBlockNumber.deleteValue(block, nullifier),
354
+ ]);
355
+ }
356
+ }
357
+ }
358
+
359
+ /**
360
+ * Commits in memory job data to persistent storage.
361
+ *
362
+ * Called by JobCoordinator when a job completes successfully.
363
+ *
364
+ * Note: JobCoordinator wraps all commits in a single transaction, so we don't need our own transactionAsync here
365
+ * (and using one would throw on IndexedDB as it does not support nested txs).
366
+ *
367
+ * @param jobId - The jobId identifying which staged data to commit
368
+ */
369
+ async commit(jobId: string): Promise<void> {
370
+ for (const [nullifier, storedNote] of this.#getNotesForJob(jobId)) {
371
+ await this.#notes.set(nullifier, storedNote.toBuffer());
372
+ await this.#nullifiersByContractAddress.set(storedNote.noteDao.contractAddress.toString(), nullifier);
373
+ if (storedNote.nullifiedAt !== undefined) {
374
+ await this.#nullifiersByNullificationBlockNumber.set(storedNote.nullifiedAt, nullifier);
375
+ }
376
+ }
387
377
 
388
- await this.#notes.delete(noteIndex);
389
- await this.#notesToScope.delete(noteIndex);
378
+ this.#clearJobData(jobId);
379
+ }
390
380
 
391
- const scopes = await toArray(this.#scopes.keysAsync());
381
+ discardStaged(jobId: string): Promise<void> {
382
+ this.#clearJobData(jobId);
383
+ return Promise.resolve();
384
+ }
392
385
 
393
- for (const scope of scopes) {
394
- await this.#notesByContractAndScope.get(scope)!.deleteValue(note.contractAddress.toString(), noteIndex);
395
- await this.#notesByStorageSlotAndScope.get(scope)!.deleteValue(note.storageSlot.toString(), noteIndex);
396
- }
386
+ #clearJobData(jobId: string) {
387
+ this.#notesForJob.delete(jobId);
388
+ this.#jobLocks.delete(jobId);
389
+ }
397
390
 
398
- for (const scope of noteScopes) {
399
- await this.#nullifiedNotesToScope.set(noteIndex, scope);
400
- }
401
- await this.#nullifiedNotes.set(noteIndex, note.toBuffer());
402
- await this.#nullifiersByBlockNumber.set(blockNumber, nullifier.toString());
403
- await this.#nullifiedNotesByContract.set(note.contractAddress.toString(), noteIndex);
404
- await this.#nullifiedNotesByStorageSlot.set(note.storageSlot.toString(), noteIndex);
405
- await this.#nullifiedNotesByNullifier.set(nullifier.toString(), noteIndex);
391
+ /**
392
+ * Functions run withJobLock are forced to wait for each other, i.e. if they share a `jobId`, they run serially
393
+ * instead of concurrently. This is needed because staged data is stored in memory, and concurrent async operations
394
+ * (e.g., Promise.all in `validateAndStoreNote`) could otherwise interleave and corrupt state.
395
+ */
396
+ async #withJobLock<T>(jobId: string, fn: () => Promise<T>): Promise<T> {
397
+ let lock = this.#jobLocks.get(jobId);
398
+ if (!lock) {
399
+ lock = new Semaphore(1);
400
+ this.#jobLocks.set(jobId, lock);
401
+ }
402
+ await lock.acquire();
403
+ try {
404
+ return await fn();
405
+ } finally {
406
+ lock.release();
407
+ }
408
+ }
406
409
 
407
- await this.#nullifierToNoteId.delete(nullifier.toString());
408
- }
409
- return nullifiedNotes;
410
- });
410
+ #getNotesForJob(jobId: string): Map<string, StoredNote> {
411
+ let notesForJob = this.#notesForJob.get(jobId);
412
+ if (!notesForJob) {
413
+ notesForJob = new Map();
414
+ this.#notesForJob.set(jobId, notesForJob);
415
+ }
416
+ return notesForJob;
411
417
  }
412
418
  }