@aztec/pxe 0.0.1-commit.54489865 → 0.0.1-commit.5914bae

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 (249) hide show
  1. package/dest/bin/check_oracle_version.js +4 -4
  2. package/dest/block_synchronizer/block_synchronizer.d.ts +4 -2
  3. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  4. package/dest/block_synchronizer/block_synchronizer.js +13 -1
  5. package/dest/config/package_info.js +1 -1
  6. package/dest/contract_function_simulator/contract_function_simulator.d.ts +63 -31
  7. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  8. package/dest/contract_function_simulator/contract_function_simulator.js +203 -72
  9. package/dest/contract_function_simulator/ephemeral_array_service.d.ts +28 -0
  10. package/dest/contract_function_simulator/ephemeral_array_service.d.ts.map +1 -0
  11. package/dest/contract_function_simulator/ephemeral_array_service.js +78 -0
  12. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
  13. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  14. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
  15. package/dest/contract_function_simulator/index.d.ts +2 -1
  16. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/index.js +1 -0
  18. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +4 -6
  19. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +8 -10
  21. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts +1 -1
  22. package/dest/contract_function_simulator/noir-structs/log_retrieval_request.js +1 -1
  23. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +2 -2
  24. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +2 -4
  26. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +4 -7
  27. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  28. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +6 -11
  29. package/dest/contract_function_simulator/oracle/interfaces.d.ts +61 -45
  30. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  31. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
  32. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
  33. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +47 -0
  34. package/dest/contract_function_simulator/oracle/oracle.d.ts +75 -44
  35. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  36. package/dest/contract_function_simulator/oracle/oracle.js +305 -108
  37. package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
  38. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +53 -79
  39. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  40. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +110 -87
  41. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +126 -67
  42. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  43. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +328 -140
  44. package/dest/contract_function_simulator/pick_notes.d.ts +1 -1
  45. package/dest/contract_function_simulator/pick_notes.d.ts.map +1 -1
  46. package/dest/contract_function_simulator/pick_notes.js +14 -3
  47. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts +1 -1
  48. package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map +1 -1
  49. package/dest/contract_function_simulator/proxied_contract_data_source.js +3 -0
  50. package/dest/contract_logging.d.ts +27 -0
  51. package/dest/contract_logging.d.ts.map +1 -0
  52. package/dest/contract_logging.js +38 -0
  53. package/dest/contract_sync/contract_sync_service.d.ts +44 -0
  54. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  55. package/dest/contract_sync/contract_sync_service.js +116 -0
  56. package/dest/contract_sync/helpers.d.ts +28 -0
  57. package/dest/contract_sync/helpers.d.ts.map +1 -0
  58. package/dest/contract_sync/{index.js → helpers.js} +19 -13
  59. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  60. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  61. package/dest/debug/pxe_debug_utils.js +16 -15
  62. package/dest/entrypoints/client/bundle/index.d.ts +3 -1
  63. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  64. package/dest/entrypoints/client/bundle/index.js +2 -0
  65. package/dest/entrypoints/client/bundle/utils.d.ts +2 -2
  66. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  67. package/dest/entrypoints/client/bundle/utils.js +13 -4
  68. package/dest/entrypoints/client/lazy/index.d.ts +3 -1
  69. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  70. package/dest/entrypoints/client/lazy/index.js +2 -0
  71. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  72. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  73. package/dest/entrypoints/client/lazy/utils.js +13 -4
  74. package/dest/entrypoints/pxe_creation_options.d.ts +3 -1
  75. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  76. package/dest/entrypoints/pxe_creation_options.js +3 -1
  77. package/dest/entrypoints/server/index.d.ts +4 -3
  78. package/dest/entrypoints/server/index.d.ts.map +1 -1
  79. package/dest/entrypoints/server/index.js +3 -2
  80. package/dest/entrypoints/server/utils.d.ts +2 -2
  81. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  82. package/dest/entrypoints/server/utils.js +11 -3
  83. package/dest/events/event_service.d.ts +5 -5
  84. package/dest/events/event_service.d.ts.map +1 -1
  85. package/dest/events/event_service.js +20 -9
  86. package/dest/events/private_event_filter_validator.d.ts +3 -2
  87. package/dest/events/private_event_filter_validator.d.ts.map +1 -1
  88. package/dest/events/private_event_filter_validator.js +15 -0
  89. package/dest/logs/log_service.d.ts +9 -9
  90. package/dest/logs/log_service.d.ts.map +1 -1
  91. package/dest/logs/log_service.js +40 -60
  92. package/dest/messages/message_context_service.d.ts +17 -0
  93. package/dest/messages/message_context_service.d.ts.map +1 -0
  94. package/dest/messages/message_context_service.js +36 -0
  95. package/dest/notes/note_service.d.ts +7 -8
  96. package/dest/notes/note_service.d.ts.map +1 -1
  97. package/dest/notes/note_service.js +23 -14
  98. package/dest/notes_filter.d.ts +24 -0
  99. package/dest/notes_filter.d.ts.map +1 -0
  100. package/dest/notes_filter.js +4 -0
  101. package/dest/oracle_version.d.ts +4 -3
  102. package/dest/oracle_version.d.ts.map +1 -1
  103. package/dest/oracle_version.js +20 -10
  104. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  105. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  106. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  107. package/dest/private_kernel/hints/index.d.ts +1 -1
  108. package/dest/private_kernel/hints/index.js +1 -1
  109. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  110. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  111. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  112. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  113. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  114. package/dest/private_kernel/hints/test_utils.js +203 -0
  115. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  116. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  117. package/dest/private_kernel/private_kernel_execution_prover.js +18 -13
  118. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  119. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  120. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  121. package/dest/pxe.d.ts +72 -23
  122. package/dest/pxe.d.ts.map +1 -1
  123. package/dest/pxe.js +126 -71
  124. package/dest/storage/address_store/address_store.d.ts +1 -1
  125. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  126. package/dest/storage/address_store/address_store.js +12 -11
  127. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
  128. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  129. package/dest/storage/anchor_block_store/anchor_block_store.js +9 -2
  130. package/dest/storage/capsule_store/capsule_service.d.ts +21 -0
  131. package/dest/storage/capsule_store/capsule_service.d.ts.map +1 -0
  132. package/dest/storage/capsule_store/capsule_service.js +50 -0
  133. package/dest/storage/capsule_store/capsule_store.d.ts +9 -9
  134. package/dest/storage/capsule_store/capsule_store.d.ts.map +1 -1
  135. package/dest/storage/capsule_store/capsule_store.js +42 -36
  136. package/dest/storage/capsule_store/index.d.ts +2 -1
  137. package/dest/storage/capsule_store/index.d.ts.map +1 -1
  138. package/dest/storage/capsule_store/index.js +1 -0
  139. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  140. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  141. package/dest/storage/contract_store/contract_store.js +160 -73
  142. package/dest/storage/metadata.d.ts +1 -1
  143. package/dest/storage/metadata.js +1 -1
  144. package/dest/storage/note_store/note_store.d.ts +13 -3
  145. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  146. package/dest/storage/note_store/note_store.js +173 -131
  147. package/dest/storage/private_event_store/private_event_store.d.ts +1 -1
  148. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  149. package/dest/storage/private_event_store/private_event_store.js +126 -101
  150. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  151. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  152. package/dest/storage/tagging_store/recipient_tagging_store.js +31 -19
  153. package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
  154. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
  155. package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
  156. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  157. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  158. package/dest/storage/tagging_store/sender_tagging_store.js +233 -137
  159. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  160. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  161. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  162. package/dest/tagging/index.d.ts +3 -3
  163. package/dest/tagging/index.d.ts.map +1 -1
  164. package/dest/tagging/index.js +1 -1
  165. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  166. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  167. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -21
  168. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  169. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  170. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  171. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  172. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  173. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  174. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
  175. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
  176. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  177. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
  178. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  179. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  180. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
  181. package/package.json +25 -16
  182. package/src/bin/check_oracle_version.ts +4 -4
  183. package/src/block_synchronizer/block_synchronizer.ts +12 -0
  184. package/src/config/package_info.ts +1 -1
  185. package/src/contract_function_simulator/contract_function_simulator.ts +363 -135
  186. package/src/contract_function_simulator/ephemeral_array_service.ts +110 -0
  187. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
  188. package/src/contract_function_simulator/index.ts +1 -0
  189. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +9 -9
  190. package/src/contract_function_simulator/noir-structs/log_retrieval_request.ts +1 -1
  191. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +2 -5
  192. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +4 -10
  193. package/src/contract_function_simulator/oracle/interfaces.ts +88 -60
  194. package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +104 -0
  195. package/src/contract_function_simulator/oracle/oracle.ts +385 -144
  196. package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
  197. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +136 -184
  198. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +543 -171
  199. package/src/contract_function_simulator/pick_notes.ts +14 -3
  200. package/src/contract_function_simulator/proxied_contract_data_source.ts +8 -1
  201. package/src/contract_logging.ts +52 -0
  202. package/src/contract_sync/contract_sync_service.ts +176 -0
  203. package/src/contract_sync/{index.ts → helpers.ts} +22 -22
  204. package/src/debug/pxe_debug_utils.ts +48 -18
  205. package/src/entrypoints/client/bundle/index.ts +2 -0
  206. package/src/entrypoints/client/bundle/utils.ts +14 -5
  207. package/src/entrypoints/client/lazy/index.ts +2 -0
  208. package/src/entrypoints/client/lazy/utils.ts +14 -5
  209. package/src/entrypoints/pxe_creation_options.ts +7 -0
  210. package/src/entrypoints/server/index.ts +3 -2
  211. package/src/entrypoints/server/utils.ts +9 -10
  212. package/src/events/event_service.ts +21 -10
  213. package/src/events/private_event_filter_validator.ts +21 -1
  214. package/src/logs/log_service.ts +71 -102
  215. package/src/messages/message_context_service.ts +44 -0
  216. package/src/notes/note_service.ts +24 -15
  217. package/src/notes_filter.ts +24 -0
  218. package/src/oracle_version.ts +20 -10
  219. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  220. package/src/private_kernel/hints/index.ts +1 -1
  221. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  222. package/src/private_kernel/hints/test_utils.ts +325 -0
  223. package/src/private_kernel/private_kernel_execution_prover.ts +18 -16
  224. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  225. package/src/pxe.ts +233 -122
  226. package/src/storage/address_store/address_store.ts +15 -15
  227. package/src/storage/anchor_block_store/anchor_block_store.ts +9 -1
  228. package/src/storage/capsule_store/capsule_service.ts +90 -0
  229. package/src/storage/capsule_store/capsule_store.ts +52 -34
  230. package/src/storage/capsule_store/index.ts +1 -0
  231. package/src/storage/contract_store/contract_store.ts +193 -81
  232. package/src/storage/metadata.ts +1 -1
  233. package/src/storage/note_store/note_store.ts +192 -153
  234. package/src/storage/private_event_store/private_event_store.ts +151 -128
  235. package/src/storage/tagging_store/recipient_tagging_store.ts +38 -24
  236. package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
  237. package/src/storage/tagging_store/sender_tagging_store.ts +287 -156
  238. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  239. package/src/tagging/index.ts +2 -2
  240. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +9 -24
  241. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  242. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  243. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
  244. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
  245. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
  246. package/dest/contract_sync/index.d.ts +0 -23
  247. package/dest/contract_sync/index.d.ts.map +0 -1
  248. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  249. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
@@ -1,19 +1,20 @@
1
1
  import type { Fr } from '@aztec/foundation/curves/bn254';
2
+ import { createLogger } from '@aztec/foundation/log';
2
3
  import type { EventSelector } from '@aztec/stdlib/abi';
3
4
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
5
  import { siloNullifier } from '@aztec/stdlib/hash';
5
6
  import type { AztecNode } from '@aztec/stdlib/interfaces/server';
6
- import type { TxHash } from '@aztec/stdlib/tx';
7
+ import type { BlockHeader, TxHash } from '@aztec/stdlib/tx';
7
8
 
8
- import { AnchorBlockStore } from '../storage/anchor_block_store/anchor_block_store.js';
9
9
  import { PrivateEventStore } from '../storage/private_event_store/private_event_store.js';
10
10
 
11
11
  export class EventService {
12
12
  constructor(
13
- private readonly anchorBlockStore: AnchorBlockStore,
13
+ private readonly anchorBlockHeader: BlockHeader,
14
14
  private readonly aztecNode: AztecNode,
15
15
  private readonly privateEventStore: PrivateEventStore,
16
16
  private readonly jobId: string,
17
+ private readonly log = createLogger('pxe:event_service'),
17
18
  ) {}
18
19
 
19
20
  public async validateAndStoreEvent(
@@ -29,28 +30,38 @@ export class EventService {
29
30
  // (and thus we're less concerned about being ahead of the synced block), we use the synced block number to
30
31
  // maintain consistent behavior in the PXE. Additionally, events should never be ahead of the synced block here
31
32
  // since `fetchTaggedLogs` only processes logs up to the synced block.
32
- const [anchorBlockHeader, siloedEventCommitment, txEffect] = await Promise.all([
33
- this.anchorBlockStore.getBlockHeader(),
33
+ const [siloedEventCommitment, txEffect] = await Promise.all([
34
34
  siloNullifier(contractAddress, eventCommitment),
35
35
  this.aztecNode.getTxEffect(txHash),
36
36
  ]);
37
37
 
38
- const anchorBlockNumber = anchorBlockHeader.getBlockNumber();
38
+ const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
39
39
 
40
40
  if (!txEffect) {
41
- throw new Error(`Could not find tx effect for tx hash ${txHash}`);
41
+ // We error out instead of just logging a warning and skipping the event because this would indicate a bug. This
42
+ // is because the node has already served info about this tx either when obtaining the log (TxScopedL2Log contain
43
+ // tx info) or when getting metadata for the offchain message (before the message got passed to `process_log`).
44
+ throw new Error(`Could not find tx effect for tx hash ${txHash} when processing an event.`);
42
45
  }
43
46
 
44
47
  if (txEffect.l2BlockNumber > anchorBlockNumber) {
45
- throw new Error(`Could not find tx effect for tx hash ${txHash} as of block number ${anchorBlockNumber}`);
48
+ // We should never process a message from a tx past the anchor block. If we got here, a preprocessing step made
49
+ // a mistake.
50
+ throw new Error(
51
+ `Obtained a newer tx effect for ${txHash} for an event validation request than the anchor block ${anchorBlockNumber}. This is a bug as smart contracts should not issue event validation requests for events from blocks newer than the anchor block.`,
52
+ );
46
53
  }
47
54
 
48
55
  // Find the index of the event commitment in the nullifiers array to determine event ordering within the tx
49
56
  const eventIndexInTx = txEffect.data.nullifiers.findIndex(n => n.equals(siloedEventCommitment));
50
57
  if (eventIndexInTx === -1) {
51
- throw new Error(
52
- `Event commitment ${eventCommitment} (siloed as ${siloedEventCommitment}) is not present in tx ${txHash}`,
58
+ // Unlike in NoteService, this might not be a bug since the commitment hasn't been verified yet in the message
59
+ // processing pipeline. A malformed or malicious message could trigger this condition. Because of this we don't
60
+ // error out and we just show a warning.
61
+ this.log.warn(
62
+ `Skipping event whose commitment is not present in its tx. siloedEventCommitment=${siloedEventCommitment}, contract=${contractAddress}, selector=${selector}, eventCommitment=${eventCommitment}, txHash=${txHash}`,
53
63
  );
64
+ return;
54
65
  }
55
66
 
56
67
  return this.privateEventStore.storePrivateEventLog(
@@ -1,11 +1,14 @@
1
1
  import type { PrivateEventFilter } from '@aztec/aztec.js/wallet';
2
2
  import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
3
3
  import { BlockNumber } from '@aztec/foundation/branded-types';
4
+ import { createLogger } from '@aztec/foundation/log';
4
5
 
5
6
  import type { PrivateEventStoreFilter } from '../storage/private_event_store/private_event_store.js';
6
7
 
7
8
  export class PrivateEventFilterValidator {
8
- constructor(private lastBlock: BlockNumber) {}
9
+ private readonly log = createLogger('pxe:private_event_filter_validator');
10
+
11
+ constructor(private readonly lastBlock: BlockNumber) {}
9
12
 
10
13
  validate(filter: PrivateEventFilter): PrivateEventStoreFilter {
11
14
  let { fromBlock, toBlock } = filter;
@@ -35,6 +38,23 @@ export class PrivateEventFilterValidator {
35
38
  throw new Error('toBlock must be strictly greater than fromBlock');
36
39
  }
37
40
 
41
+ // Cap the requested range to the synced block range. Without this, callers that pass a large
42
+ // toBlock (e.g. Number.MAX_SAFE_INTEGER as a "give me everything" idiom) would silently receive
43
+ // only the events that happen to be synced and believe they have complete coverage.
44
+ // We warn + cap rather than throw so callers don't need to query the last synced block before
45
+ // every request (which would also be unreliable, as the block can advance between the two calls).
46
+ const syncedUpperBound = BlockNumber(this.lastBlock + 1);
47
+ if (fromBlock >= syncedUpperBound) {
48
+ this.log.warn(
49
+ `Requested fromBlock ${fromBlock} is past last synced block ${this.lastBlock}; no events will be returned until PXE syncs further.`,
50
+ );
51
+ } else if (toBlock > syncedUpperBound) {
52
+ this.log.warn(
53
+ `Requested toBlock ${toBlock} exceeds last synced block ${this.lastBlock}; capping to ${syncedUpperBound}. Retry once PXE is further synced for complete coverage.`,
54
+ );
55
+ toBlock = syncedUpperBound;
56
+ }
57
+
38
58
  return {
39
59
  contractAddress: filter.contractAddress,
40
60
  scopes: filter.scopes,
@@ -1,16 +1,14 @@
1
- import type { Fr } from '@aztec/foundation/curves/bn254';
2
1
  import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
3
2
  import type { KeyStore } from '@aztec/key-store';
4
3
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
5
- import type { CompleteAddress } from '@aztec/stdlib/contract';
4
+ import type { L2TipsProvider } from '@aztec/stdlib/block';
6
5
  import type { AztecNode } from '@aztec/stdlib/interfaces/server';
7
- import { DirectionalAppTaggingSecret, PendingTaggedLog, SiloedTag, Tag, TxScopedL2Log } from '@aztec/stdlib/logs';
6
+ import { ExtendedDirectionalAppTaggingSecret, PendingTaggedLog, SiloedTag, Tag } from '@aztec/stdlib/logs';
7
+ import type { BlockHeader } from '@aztec/stdlib/tx';
8
8
 
9
9
  import type { LogRetrievalRequest } from '../contract_function_simulator/noir-structs/log_retrieval_request.js';
10
10
  import { LogRetrievalResponse } from '../contract_function_simulator/noir-structs/log_retrieval_response.js';
11
11
  import { AddressStore } from '../storage/address_store/address_store.js';
12
- import { AnchorBlockStore } from '../storage/anchor_block_store/anchor_block_store.js';
13
- import { CapsuleStore } from '../storage/capsule_store/capsule_store.js';
14
12
  import type { RecipientTaggingStore } from '../storage/tagging_store/recipient_tagging_store.js';
15
13
  import type { SenderAddressBookStore } from '../storage/tagging_store/sender_address_book_store.js';
16
14
  import {
@@ -24,9 +22,9 @@ export class LogService {
24
22
 
25
23
  constructor(
26
24
  private readonly aztecNode: AztecNode,
27
- private readonly anchorBlockStore: AnchorBlockStore,
25
+ private readonly anchorBlockHeader: BlockHeader,
26
+ private readonly l2TipsStore: L2TipsProvider,
28
27
  private readonly keyStore: KeyStore,
29
- private readonly capsuleStore: CapsuleStore,
30
28
  private readonly recipientTaggingStore: RecipientTaggingStore,
31
29
  private readonly senderAddressBookStore: SenderAddressBookStore,
32
30
  private readonly addressStore: AddressStore,
@@ -36,17 +34,26 @@ export class LogService {
36
34
  this.log = createLogger('pxe:log_service', bindings);
37
35
  }
38
36
 
39
- public async bulkRetrieveLogs(logRetrievalRequests: LogRetrievalRequest[]): Promise<(LogRetrievalResponse | null)[]> {
37
+ public async fetchLogsByTag(
38
+ contractAddress: AztecAddress,
39
+ logRetrievalRequests: LogRetrievalRequest[],
40
+ ): Promise<(LogRetrievalResponse | null)[]> {
41
+ for (const request of logRetrievalRequests) {
42
+ if (!contractAddress.equals(request.contractAddress)) {
43
+ throw new Error(`Got a log retrieval request from ${request.contractAddress}, expected ${contractAddress}`);
44
+ }
45
+ }
46
+
40
47
  return await Promise.all(
41
48
  logRetrievalRequests.map(async request => {
42
49
  const [publicLog, privateLog] = await Promise.all([
43
50
  this.#getPublicLogByTag(request.tag, request.contractAddress),
44
- this.#getPrivateLogByTag(await SiloedTag.compute(request.tag, request.contractAddress)),
51
+ this.#getPrivateLogByTag(await SiloedTag.computeFromTagAndApp(request.tag, request.contractAddress)),
45
52
  ]);
46
53
 
47
54
  if (publicLog !== null && privateLog !== null) {
48
- throw new Error(
49
- `Found both a public and private log when searching for tag ${request.tag} from contract ${request.contractAddress}`,
55
+ this.log.warn(
56
+ `Found both a public and private log for tag ${request.tag} from contract ${request.contractAddress}. This may indicate a contract bug. Returning the public log.`,
50
57
  );
51
58
  }
52
59
 
@@ -56,8 +63,7 @@ export class LogService {
56
63
  }
57
64
 
58
65
  async #getPublicLogByTag(tag: Tag, contractAddress: AztecAddress): Promise<LogRetrievalResponse | null> {
59
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
60
- const anchorBlockHash = await anchorBlockHeader.hash();
66
+ const anchorBlockHash = await this.anchorBlockHeader.hash();
61
67
  const allLogsPerTag = await getAllPublicLogsByTagsFromContract(
62
68
  this.aztecNode,
63
69
  contractAddress,
@@ -69,9 +75,8 @@ export class LogService {
69
75
  if (logsForTag.length === 0) {
70
76
  return null;
71
77
  } else if (logsForTag.length > 1) {
72
- // TODO(#11627): handle this case
73
- throw new Error(
74
- `Got ${logsForTag.length} logs for tag ${tag} and contract ${contractAddress.toString()}. getPublicLogByTag currently only supports a single log per tag`,
78
+ this.log.warn(
79
+ `Expected at most 1 public log for tag ${tag} and contract ${contractAddress.toString()}, got ${logsForTag.length}. This may indicate a contract bug. Returning the first log.`,
75
80
  );
76
81
  }
77
82
 
@@ -86,17 +91,15 @@ export class LogService {
86
91
  }
87
92
 
88
93
  async #getPrivateLogByTag(siloedTag: SiloedTag): Promise<LogRetrievalResponse | null> {
89
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
90
- const anchorBlockHash = await anchorBlockHeader.hash();
94
+ const anchorBlockHash = await this.anchorBlockHeader.hash();
91
95
  const allLogsPerTag = await getAllPrivateLogsByTags(this.aztecNode, [siloedTag], anchorBlockHash);
92
96
  const logsForTag = allLogsPerTag[0];
93
97
 
94
98
  if (logsForTag.length === 0) {
95
99
  return null;
96
100
  } else if (logsForTag.length > 1) {
97
- // TODO(#11627): handle this case
98
- throw new Error(
99
- `Got ${logsForTag.length} logs for tag ${siloedTag}. getPrivateLogByTag currently only supports a single log per tag`,
101
+ this.log.warn(
102
+ `Expected at most 1 private log for tag ${siloedTag}, got ${logsForTag.length}. This may indicate a contract bug. Returning the first log.`,
100
103
  );
101
104
  }
102
105
 
@@ -110,59 +113,50 @@ export class LogService {
110
113
  );
111
114
  }
112
115
 
113
- public async syncTaggedLogs(
114
- contractAddress: AztecAddress,
115
- pendingTaggedLogArrayBaseSlot: Fr,
116
- scopes?: AztecAddress[],
117
- ) {
118
- this.log.verbose('Searching for tagged logs', { contract: contractAddress });
116
+ public async fetchTaggedLogs(contractAddress: AztecAddress, recipient: AztecAddress): Promise<PendingTaggedLog[]> {
117
+ this.log.verbose(`Fetching tagged logs for ${contractAddress.toString()}`);
119
118
 
120
119
  // We only load logs from block up to and including the anchor block number
121
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
122
- const anchorBlockNumber = anchorBlockHeader.getBlockNumber();
123
- const anchorBlockHash = await anchorBlockHeader.hash();
124
-
125
- // Determine recipients: use scopes if provided, otherwise get all accounts
126
- const recipients = scopes && scopes.length > 0 ? scopes : await this.keyStore.getAccounts();
127
-
128
- // For each recipient, fetch secrets, load logs, and store them.
129
- // We run these per-recipient tasks in parallel so that logs are loaded for all recipients concurrently.
130
- await Promise.all(
131
- recipients.map(async recipient => {
132
- // Get all secrets for this recipient (one per sender)
133
- const secrets = await this.#getSecretsForSenders(contractAddress, recipient);
134
-
135
- // Load logs for all sender-recipient pairs in parallel
136
- const logArrays = await Promise.all(
137
- secrets.map(secret =>
138
- loadPrivateLogsForSenderRecipientPair(
139
- secret,
140
- contractAddress,
141
- this.aztecNode,
142
- this.recipientTaggingStore,
143
- anchorBlockNumber,
144
- anchorBlockHash,
145
- this.jobId,
146
- ),
147
- ),
148
- );
149
-
150
- // Flatten all logs from all secrets
151
- const allLogs = logArrays.flat();
152
-
153
- // Store the logs for this recipient
154
- if (allLogs.length > 0) {
155
- await this.#storePendingTaggedLogs(contractAddress, pendingTaggedLogArrayBaseSlot, recipient, allLogs);
156
- }
157
- }),
120
+ const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
121
+ const anchorBlockHash = await this.anchorBlockHeader.hash();
122
+
123
+ const l2Tips = await this.l2TipsStore.getL2Tips();
124
+ const currentTimestamp = this.anchorBlockHeader.globalVariables.timestamp;
125
+ // Get all secrets for this recipient (one per sender)
126
+ const secrets = await this.#getSecretsForSenders(contractAddress, recipient);
127
+
128
+ // Load logs for all sender-recipient pairs in parallel
129
+ const logArrays = await Promise.all(
130
+ secrets.map(secret =>
131
+ loadPrivateLogsForSenderRecipientPair(
132
+ secret,
133
+ this.aztecNode,
134
+ this.recipientTaggingStore,
135
+ anchorBlockNumber,
136
+ anchorBlockHash,
137
+ currentTimestamp,
138
+ l2Tips.finalized.block.number,
139
+ this.jobId,
140
+ ),
141
+ ),
158
142
  );
143
+
144
+ return logArrays
145
+ .flat()
146
+ .map(
147
+ scopedLog =>
148
+ new PendingTaggedLog(scopedLog.logData, scopedLog.txHash, scopedLog.noteHashes, scopedLog.firstNullifier),
149
+ );
159
150
  }
160
151
 
161
152
  async #getSecretsForSenders(
162
153
  contractAddress: AztecAddress,
163
154
  recipient: AztecAddress,
164
- ): Promise<DirectionalAppTaggingSecret[]> {
165
- const recipientCompleteAddress = await this.#getCompleteAddress(recipient);
155
+ ): Promise<ExtendedDirectionalAppTaggingSecret[]> {
156
+ const recipientCompleteAddress = await this.addressStore.getCompleteAddress(recipient);
157
+ if (!recipientCompleteAddress) {
158
+ return [];
159
+ }
166
160
  const recipientIvsk = await this.keyStore.getMasterIncomingViewingSecretKey(recipient);
167
161
 
168
162
  // We implicitly add all PXE accounts as senders, this helps us decrypt tags on notes that we send to ourselves
@@ -175,49 +169,24 @@ export class LogService {
175
169
  );
176
170
 
177
171
  return Promise.all(
178
- deduplicatedSenders.map(sender => {
179
- return DirectionalAppTaggingSecret.compute(
172
+ deduplicatedSenders.map(async sender => {
173
+ const secret = await ExtendedDirectionalAppTaggingSecret.compute(
180
174
  recipientCompleteAddress,
181
175
  recipientIvsk,
182
176
  sender,
183
177
  contractAddress,
184
178
  recipient,
185
179
  );
186
- }),
187
- );
188
- }
189
-
190
- #storePendingTaggedLogs(
191
- contractAddress: AztecAddress,
192
- capsuleArrayBaseSlot: Fr,
193
- recipient: AztecAddress,
194
- privateLogs: TxScopedL2Log[],
195
- ) {
196
- // Build all pending tagged logs from the scoped logs
197
- const pendingTaggedLogs = privateLogs.map(scopedLog => {
198
- const pendingTaggedLog = new PendingTaggedLog(
199
- scopedLog.logData,
200
- scopedLog.txHash,
201
- scopedLog.noteHashes,
202
- scopedLog.firstNullifier,
203
- recipient,
204
- );
205
180
 
206
- return pendingTaggedLog.toFields();
207
- });
208
-
209
- // TODO: This looks like it could belong more at the oracle interface level
210
- return this.capsuleStore.appendToCapsuleArray(contractAddress, capsuleArrayBaseSlot, pendingTaggedLogs, this.jobId);
211
- }
181
+ if (!secret) {
182
+ // Note that all senders originate from either the SenderAddressBookStore or the KeyStore.
183
+ throw new Error(
184
+ `Failed to compute a tagging secret for sender ${sender} - this implies this is an invalid address, which should not happen as they have been previously registered in PXE.`,
185
+ );
186
+ }
212
187
 
213
- async #getCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
214
- const completeAddress = await this.addressStore.getCompleteAddress(account);
215
- if (!completeAddress) {
216
- throw new Error(
217
- `No public key registered for address ${account}.
218
- Register it by calling pxe.addAccount(...).\nSee docs for context: https://docs.aztec.network/developers/resources/debugging/aztecnr-errors#simulation-error-no-public-key-registered-for-address-0x0-register-it-by-calling-pxeregisterrecipient-or-pxeregisteraccount`,
219
- );
220
- }
221
- return completeAddress;
188
+ return secret;
189
+ }),
190
+ );
222
191
  }
223
192
  }
@@ -0,0 +1,44 @@
1
+ import { Fr } from '@aztec/foundation/curves/bn254';
2
+ import type { AztecNode } from '@aztec/stdlib/interfaces/server';
3
+ import { MessageContext } from '@aztec/stdlib/logs';
4
+ import { TxHash } from '@aztec/stdlib/tx';
5
+
6
+ /** Resolves transaction hashes into the context needed to process messages. */
7
+ export class MessageContextService {
8
+ constructor(private readonly aztecNode: AztecNode) {}
9
+
10
+ /**
11
+ * Resolves a list of tx hashes into their message contexts.
12
+ *
13
+ * For each tx hash, looks up the corresponding tx effect and extracts the note hashes and first nullifier needed to
14
+ * process messages that originated from that transaction. Returns `null` for tx hashes that are zero, not yet
15
+ * available, or in blocks beyond the anchor block.
16
+ */
17
+ getMessageContextsByTxHash(txHashes: Fr[], anchorBlockNumber: number): Promise<(MessageContext | null)[]> {
18
+ // TODO: optimize, we might be hitting the node to get the same txHash repeatedly
19
+ return Promise.all(
20
+ txHashes.map(async txHashField => {
21
+ // A zero tx hash indicates a tx-less offchain message (e.g. one not tied to any onchain transaction).
22
+ // These messages don't have a transaction context to resolve, so we return null.
23
+ if (txHashField.isZero()) {
24
+ return null;
25
+ }
26
+
27
+ const txHash = TxHash.fromField(txHashField);
28
+ const txEffect = await this.aztecNode.getTxEffect(txHash);
29
+ if (!txEffect || txEffect.l2BlockNumber > anchorBlockNumber) {
30
+ return null;
31
+ }
32
+
33
+ // Every tx has at least one nullifier (the first nullifier derived from the tx hash). Hitting this condition
34
+ // would mean a buggy node, but since we need to access data.nullifiers[0], the defensive check does no harm.
35
+ const data = txEffect.data;
36
+ if (data.nullifiers.length === 0) {
37
+ throw new Error(`Tx effect for ${txHash} has no nullifiers`);
38
+ }
39
+
40
+ return new MessageContext(data.txHash, data.noteHashes, data.nullifiers[0]);
41
+ }),
42
+ );
43
+ }
44
+ }
@@ -5,16 +5,15 @@ import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdli
5
5
  import { type AztecNode, MAX_RPC_LEN } from '@aztec/stdlib/interfaces/client';
6
6
  import { Note, NoteDao, NoteStatus } from '@aztec/stdlib/note';
7
7
  import { MerkleTreeId } from '@aztec/stdlib/trees';
8
- import type { TxHash } from '@aztec/stdlib/tx';
8
+ import type { BlockHeader, TxHash } from '@aztec/stdlib/tx';
9
9
 
10
- import type { AnchorBlockStore } from '../storage/anchor_block_store/anchor_block_store.js';
11
10
  import type { NoteStore } from '../storage/note_store/note_store.js';
12
11
 
13
12
  export class NoteService {
14
13
  constructor(
15
14
  private readonly noteStore: NoteStore,
16
15
  private readonly aztecNode: AztecNode,
17
- private readonly anchorBlockStore: AnchorBlockStore,
16
+ private readonly anchorBlockHeader: BlockHeader,
18
17
  private readonly jobId: string,
19
18
  ) {}
20
19
 
@@ -32,7 +31,7 @@ export class NoteService {
32
31
  owner: AztecAddress | undefined,
33
32
  storageSlot: Fr,
34
33
  status: NoteStatus,
35
- scopes?: AztecAddress[],
34
+ scopes: AztecAddress[],
36
35
  ) {
37
36
  const noteDaos = await this.noteStore.getNotes(
38
37
  {
@@ -71,10 +70,10 @@ export class NoteService {
71
70
  *
72
71
  * @param contractAddress - The contract whose notes should be checked and nullified.
73
72
  */
74
- public async syncNoteNullifiers(contractAddress: AztecAddress): Promise<void> {
75
- const anchorBlockHash = await (await this.anchorBlockStore.getBlockHeader()).hash();
73
+ public async syncNoteNullifiers(contractAddress: AztecAddress, scopes: AztecAddress[]): Promise<void> {
74
+ const anchorBlockHash = await this.anchorBlockHeader.hash();
76
75
 
77
- const contractNotes = await this.noteStore.getNotes({ contractAddress }, this.jobId);
76
+ const contractNotes = await this.noteStore.getNotes({ contractAddress, scopes }, this.jobId);
78
77
 
79
78
  if (contractNotes.length === 0) {
80
79
  return;
@@ -121,7 +120,7 @@ export class NoteService {
121
120
  noteHash: Fr,
122
121
  nullifier: Fr,
123
122
  txHash: TxHash,
124
- recipient: AztecAddress,
123
+ scope: AztecAddress,
125
124
  ): Promise<void> {
126
125
  // We are going to store the new note in the NoteStore, which will let us later return it via `getNotes`.
127
126
  // There's two things we need to check before we do this however:
@@ -142,9 +141,8 @@ export class NoteService {
142
141
  // number which *should* be recent enough to be available, even for non-archive nodes.
143
142
  // Also note that the note should never be ahead of the synced block here since `fetchTaggedLogs` only processes
144
143
  // logs up to the synced block making this only an additional safety check.
145
- const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
146
- const anchorBlockNumber = anchorBlockHeader.getBlockNumber();
147
- const anchorBlockHash = await anchorBlockHeader.hash();
144
+ const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
145
+ const anchorBlockHash = await this.anchorBlockHeader.hash();
148
146
 
149
147
  // By computing siloed and unique note hashes ourselves we prevent contracts from interfering with the note storage
150
148
  // of other contracts, which would constitute a security breach.
@@ -156,16 +154,28 @@ export class NoteService {
156
154
  this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [siloedNullifier]),
157
155
  ]);
158
156
  if (!txEffect) {
159
- throw new Error(`Could not find tx effect for tx hash ${txHash}`);
157
+ // We error out instead of just logging a warning and skipping the note because this would indicate a bug. This
158
+ // is because the node has already served info about this tx either when obtaining the log (TxScopedL2Log contain
159
+ // tx info) or when getting metadata for the offchain message (before the message got passed to `process_log`).
160
+ throw new Error(`Could not find tx effect for tx hash ${txHash} when processing a note.`);
160
161
  }
161
162
 
162
163
  if (txEffect.l2BlockNumber > anchorBlockNumber) {
163
- throw new Error(`Could not find tx effect for tx hash ${txHash} as of block number ${anchorBlockNumber}`);
164
+ // If the message was delivered onchain, this would indicate a bug: log sync should never load logs from blocks
165
+ // newer than the anchor block. If the note came via an offchain message, it would likely also be a bug, since we
166
+ // sync a new anchor block before calling `process_message`. For this not to be a bug, the message would need to
167
+ // come from a newer block than the anchor served by the node, implying the node isn't properly synced.
168
+ // We therefore error out here rather than assuming the offchain message was constructed by a malicious
169
+ // sender with the intention of bricking recipient's PXE (if we assumed that we would just ignore the message).
170
+ throw new Error(
171
+ `Obtained a newer tx effect for ${txHash} for a note validation request than the anchor block ${anchorBlockNumber}. This is a bug as we should not ever be processing a note from a newer block than the anchor block.`,
172
+ );
164
173
  }
165
174
 
166
175
  // Find the index of the note hash in the noteHashes array to determine note ordering within the tx
167
176
  const noteIndexInTx = txEffect.data.noteHashes.findIndex(nh => nh.equals(uniqueNoteHash));
168
177
  if (noteIndexInTx === -1) {
178
+ // Similar to the comment above - we error out as this would indicate a bug in nonce discovery.
169
179
  throw new Error(`Note hash ${noteHash} (uniqued as ${uniqueNoteHash}) is not present in tx ${txHash}`);
170
180
  }
171
181
 
@@ -185,8 +195,7 @@ export class NoteService {
185
195
  noteIndexInTx,
186
196
  );
187
197
 
188
- // The note was found by `recipient`, so we use that as the scope when storing the note.
189
- await this.noteStore.addNotes([noteDao], recipient, this.jobId);
198
+ await this.noteStore.addNotes([noteDao], scope, this.jobId);
190
199
 
191
200
  if (nullifierIndex !== undefined) {
192
201
  // We found nullifier index which implies that the note has already been nullified.
@@ -0,0 +1,24 @@
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
+ import type { NoteStatus } from '@aztec/stdlib/note';
4
+
5
+ /**
6
+ * A filter used to fetch notes.
7
+ * @remarks This filter is applied as an intersection of all its params.
8
+ */
9
+ export type NotesFilter = {
10
+ /**
11
+ * The contract address the note belongs to.
12
+ * @remarks Providing a contract address is required as we need that information to trigger private state sync.
13
+ */
14
+ contractAddress: AztecAddress;
15
+ /** The owner of the note. */
16
+ owner?: AztecAddress;
17
+ /** The specific storage location of the note on the contract. */
18
+ storageSlot?: Fr;
19
+ /** The status of the note. Defaults to 'ACTIVE'. */
20
+ status?: NoteStatus;
21
+ /** The siloed nullifier for the note. */
22
+ siloedNullifier?: Fr;
23
+ scopes: AztecAddress[];
24
+ };
@@ -1,12 +1,22 @@
1
- /// The ORACLE_VERSION constant is used to check that the oracle interface is in sync between PXE and Aztec.nr. We need
2
- /// to version the oracle interface to ensure that developers get a reasonable error message if they use incompatible
3
- /// versions of Aztec.nr and PXE. The Noir counterpart is in `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
1
+ /// The oracle version constants are used to check that the oracle interface is in sync between PXE and Aztec.nr.
2
+ /// We version the oracle interface as `major.minor` where:
3
+ /// - `major` = backward-breaking changes (must match exactly between PXE and Aztec.nr)
4
+ /// - `minor` = oracle additions (non-breaking; PXE minor >= contract minor)
4
5
  ///
5
- /// @dev Whenever a contract function or Noir test is run, the `utilityAssertCompatibleOracleVersion` oracle is called
6
- /// and if the oracle version is incompatible an error is thrown.
7
- export const ORACLE_VERSION = 9;
6
+ /// The Noir counterparts are in `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
7
+ ///
8
+ /// @dev Whenever a contract function or Noir test is run, the `aztec_utl_assertCompatibleOracleVersion` oracle is called.
9
+ /// If the major version is incompatible, an error is thrown immediately. The minor version is recorded by the PXE and
10
+ /// used to provide helpful error messages if a contract calls an oracle that doesn't exist. We don't throw immediately
11
+ /// if AZTEC_NR_MINOR > PXE_MINOR because if a contract is updated to use a newer Aztec.nr dependency without actually
12
+ /// using any of the new oracles then there is no reason to throw.
13
+ export const ORACLE_VERSION_MAJOR = 22;
14
+ export const ORACLE_VERSION_MINOR = 1;
8
15
 
9
- /// This hash is computed as by hashing the Oracle interface and it is used to detect when the Oracle interface changes,
10
- /// which in turn implies that you need to update the ORACLE_VERSION constant in this file and in
11
- /// `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
12
- export const ORACLE_INTERFACE_HASH = '9866cc52510acaef75a3d47a0ed501fd9ff92b9d53b2c8a88c8a3ffd04ced81f';
16
+ /// This hash is computed from the Oracle interface and is used to detect when that interface changes. When it does,
17
+ /// you need to either:
18
+ /// - increment `ORACLE_VERSION_MAJOR` and reset `ORACLE_VERSION_MINOR` to zero if the change is breaking, or
19
+ /// - increment only `ORACLE_VERSION_MINOR` if the change is additive (a new oracle was added).
20
+ ///
21
+ /// These constants must be kept in sync between this file and `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
22
+ export const ORACLE_INTERFACE_HASH = 'efafa0db2cc1f94e26d794d0079c8f71115261df0c3d0fa8cb5b64f17a12db92';
@@ -1,4 +1,4 @@
1
- import { MAX_INCLUDE_BY_TIMESTAMP_DURATION } from '@aztec/constants';
1
+ import { MAX_TX_LIFETIME } from '@aztec/constants';
2
2
  import type { PrivateKernelCircuitPublicInputs } from '@aztec/stdlib/kernel';
3
3
  import type { UInt64 } from '@aztec/stdlib/types';
4
4
 
@@ -8,12 +8,12 @@ const ROUNDED_DURATIONS = [
8
8
  1, // 1 second
9
9
  ];
10
10
 
11
- function roundTimestamp(blockTimestamp: bigint, includeByTimestamp: bigint): UInt64 {
11
+ function roundTimestamp(blockTimestamp: bigint, expirationTimestamp: bigint): UInt64 {
12
12
  return ROUNDED_DURATIONS.reduce((timestamp, duration) => {
13
13
  if (timestamp <= blockTimestamp) {
14
14
  // The timestamp must be greater than the block timestamp.
15
15
  // If it is too small, round it down again using a smaller duration.
16
- const totalDuration = includeByTimestamp - blockTimestamp;
16
+ const totalDuration = expirationTimestamp - blockTimestamp;
17
17
  const roundedDuration = totalDuration - (totalDuration % BigInt(duration));
18
18
  return blockTimestamp + roundedDuration;
19
19
  }
@@ -21,36 +21,36 @@ function roundTimestamp(blockTimestamp: bigint, includeByTimestamp: bigint): UIn
21
21
  }, 0n);
22
22
  }
23
23
 
24
- export function computeTxIncludeByTimestamp(
24
+ export function computeTxExpirationTimestamp(
25
25
  previousKernel: PrivateKernelCircuitPublicInputs,
26
- maxDuration = MAX_INCLUDE_BY_TIMESTAMP_DURATION,
26
+ txLifetime = MAX_TX_LIFETIME,
27
27
  ): UInt64 {
28
- if (maxDuration > MAX_INCLUDE_BY_TIMESTAMP_DURATION) {
28
+ if (txLifetime > MAX_TX_LIFETIME) {
29
29
  throw new Error(
30
- `Custom max duration cannot be greater than the max allowed. Max allowed: ${MAX_INCLUDE_BY_TIMESTAMP_DURATION}. Custom value: ${maxDuration}.`,
30
+ `Custom tx lifetime cannot be greater than the max allowed. Max allowed: ${MAX_TX_LIFETIME}. Custom value: ${txLifetime}.`,
31
31
  );
32
32
  }
33
33
 
34
34
  const anchorBlockTimestamp = previousKernel.constants.anchorBlockHeader.globalVariables.timestamp;
35
- const maxTimestamp = anchorBlockTimestamp + BigInt(maxDuration);
36
- const includeByTimestamp = previousKernel.includeByTimestamp;
35
+ const maxTimestamp = anchorBlockTimestamp + BigInt(txLifetime);
36
+ const expirationTimestamp = previousKernel.expirationTimestamp;
37
37
 
38
- // If the includeByTimestamp set during the tx execution is greater than or equal to the max allowed duration,
38
+ // If the expirationTimestamp set during the tx execution is greater than or equal to the max allowed duration,
39
39
  // use the maximum allowed timestamp.
40
40
  // Note: It shouldn't be larger than the max allowed duration, but we check for it anyway.
41
- if (includeByTimestamp >= maxTimestamp) {
41
+ if (expirationTimestamp >= maxTimestamp) {
42
42
  return maxTimestamp;
43
43
  }
44
44
 
45
45
  // Round it down to the nearest hour/min/second to reduce precision and avoid revealing the exact value.
46
46
  // This makes it harder for others to infer what function calls may have been used to produce a specific timestamp.
47
- const roundedTimestamp = roundTimestamp(anchorBlockTimestamp, includeByTimestamp);
47
+ const roundedTimestamp = roundTimestamp(anchorBlockTimestamp, expirationTimestamp);
48
48
 
49
49
  // The tx can't be published if the timestamp is the same or less than the anchor block's timestamp.
50
50
  // Future blocks will have a greater timestamp, so the tx would never be included.
51
51
  if (roundedTimestamp <= anchorBlockTimestamp) {
52
52
  throw new Error(
53
- `Include-by timestamp must be greater than the anchor block timestamp. Anchor block timestamp: ${anchorBlockTimestamp}. Include-by timestamp: ${includeByTimestamp}.`,
53
+ `Include-by timestamp must be greater than the anchor block timestamp. Anchor block timestamp: ${anchorBlockTimestamp}. Include-by timestamp: ${expirationTimestamp}.`,
54
54
  );
55
55
  }
56
56