@aztec/stdlib 0.0.1-commit.ff7989d6c → 0.0.1-commit.fff30aa

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 (372) hide show
  1. package/dest/abi/abi.d.ts +57 -85
  2. package/dest/abi/abi.d.ts.map +1 -1
  3. package/dest/abi/abi.js +55 -6
  4. package/dest/abi/buffer.d.ts +14 -4
  5. package/dest/abi/buffer.d.ts.map +1 -1
  6. package/dest/abi/buffer.js +25 -4
  7. package/dest/abi/decoder.d.ts +6 -45
  8. package/dest/abi/decoder.d.ts.map +1 -1
  9. package/dest/abi/decoder.js +17 -70
  10. package/dest/abi/encoder.d.ts +1 -1
  11. package/dest/abi/encoder.d.ts.map +1 -1
  12. package/dest/abi/encoder.js +37 -6
  13. package/dest/abi/event_metadata_definition.d.ts +3 -1
  14. package/dest/abi/event_metadata_definition.d.ts.map +1 -1
  15. package/dest/abi/event_metadata_definition.js +1 -1
  16. package/dest/abi/function_selector.js +1 -1
  17. package/dest/abi/function_signature_decoder.d.ts +43 -0
  18. package/dest/abi/function_signature_decoder.d.ts.map +1 -0
  19. package/dest/abi/function_signature_decoder.js +66 -0
  20. package/dest/abi/index.d.ts +2 -1
  21. package/dest/abi/index.d.ts.map +1 -1
  22. package/dest/abi/index.js +1 -0
  23. package/dest/abi/selector.d.ts +2 -2
  24. package/dest/abi/selector.d.ts.map +1 -1
  25. package/dest/abi/selector.js +1 -1
  26. package/dest/abi/utils.d.ts +14 -1
  27. package/dest/abi/utils.d.ts.map +1 -1
  28. package/dest/abi/utils.js +15 -0
  29. package/dest/avm/avm.d.ts +300 -300
  30. package/dest/avm/avm_accumulated_data.js +2 -2
  31. package/dest/avm/avm_circuit_public_inputs.js +2 -2
  32. package/dest/avm/avm_proving_request.d.ts +166 -166
  33. package/dest/avm/revert_code.d.ts +9 -4
  34. package/dest/avm/revert_code.d.ts.map +1 -1
  35. package/dest/avm/revert_code.js +16 -21
  36. package/dest/block/l2_block.d.ts +9 -1
  37. package/dest/block/l2_block.d.ts.map +1 -1
  38. package/dest/block/l2_block.js +12 -2
  39. package/dest/block/l2_block_source.d.ts +16 -8
  40. package/dest/block/l2_block_source.d.ts.map +1 -1
  41. package/dest/block/l2_block_stream/interfaces.d.ts +6 -3
  42. package/dest/block/l2_block_stream/interfaces.d.ts.map +1 -1
  43. package/dest/block/l2_block_stream/l2_block_stream.d.ts +1 -1
  44. package/dest/block/l2_block_stream/l2_block_stream.d.ts.map +1 -1
  45. package/dest/block/l2_block_stream/l2_block_stream.js +10 -0
  46. package/dest/checkpoint/checkpoint.d.ts +2 -1
  47. package/dest/checkpoint/checkpoint.d.ts.map +1 -1
  48. package/dest/checkpoint/checkpoint.js +9 -4
  49. package/dest/checkpoint/index.d.ts +2 -1
  50. package/dest/checkpoint/index.d.ts.map +1 -1
  51. package/dest/checkpoint/index.js +1 -0
  52. package/dest/checkpoint/validate.d.ts +36 -0
  53. package/dest/checkpoint/validate.d.ts.map +1 -0
  54. package/dest/checkpoint/validate.js +120 -0
  55. package/dest/config/sequencer-config.d.ts +2 -2
  56. package/dest/config/sequencer-config.d.ts.map +1 -1
  57. package/dest/config/sequencer-config.js +5 -0
  58. package/dest/epoch-helpers/index.d.ts +9 -1
  59. package/dest/epoch-helpers/index.d.ts.map +1 -1
  60. package/dest/epoch-helpers/index.js +13 -2
  61. package/dest/gas/gas_fees.d.ts +1 -1
  62. package/dest/gas/gas_fees.d.ts.map +1 -1
  63. package/dest/gas/gas_fees.js +4 -1
  64. package/dest/gas/gas_settings.d.ts +40 -3
  65. package/dest/gas/gas_settings.d.ts.map +1 -1
  66. package/dest/gas/gas_settings.js +50 -6
  67. package/dest/hash/hash.d.ts +19 -1
  68. package/dest/hash/hash.d.ts.map +1 -1
  69. package/dest/hash/hash.js +29 -0
  70. package/dest/interfaces/allowed_element.d.ts +26 -20
  71. package/dest/interfaces/allowed_element.d.ts.map +1 -1
  72. package/dest/interfaces/allowed_element.js +8 -8
  73. package/dest/interfaces/archiver.d.ts +1 -1
  74. package/dest/interfaces/archiver.d.ts.map +1 -1
  75. package/dest/interfaces/archiver.js +3 -2
  76. package/dest/interfaces/aztec-node-admin.d.ts +64 -27
  77. package/dest/interfaces/aztec-node-admin.d.ts.map +1 -1
  78. package/dest/interfaces/aztec-node-debug.d.ts +21 -0
  79. package/dest/interfaces/aztec-node-debug.d.ts.map +1 -0
  80. package/dest/interfaces/aztec-node-debug.js +18 -0
  81. package/dest/interfaces/aztec-node.d.ts +12 -6
  82. package/dest/interfaces/aztec-node.d.ts.map +1 -1
  83. package/dest/interfaces/aztec-node.js +5 -2
  84. package/dest/interfaces/block-builder.d.ts +38 -11
  85. package/dest/interfaces/block-builder.d.ts.map +1 -1
  86. package/dest/interfaces/block-builder.js +13 -6
  87. package/dest/interfaces/client.d.ts +2 -1
  88. package/dest/interfaces/client.d.ts.map +1 -1
  89. package/dest/interfaces/client.js +1 -0
  90. package/dest/interfaces/configs.d.ts +62 -32
  91. package/dest/interfaces/configs.d.ts.map +1 -1
  92. package/dest/interfaces/configs.js +6 -2
  93. package/dest/interfaces/merkle_tree_operations.d.ts +9 -19
  94. package/dest/interfaces/merkle_tree_operations.d.ts.map +1 -1
  95. package/dest/interfaces/p2p.d.ts +3 -8
  96. package/dest/interfaces/p2p.d.ts.map +1 -1
  97. package/dest/interfaces/prover-client.d.ts +6 -1
  98. package/dest/interfaces/prover-client.d.ts.map +1 -1
  99. package/dest/interfaces/prover-client.js +7 -1
  100. package/dest/interfaces/validator.d.ts +68 -26
  101. package/dest/interfaces/validator.d.ts.map +1 -1
  102. package/dest/interfaces/validator.js +7 -3
  103. package/dest/interfaces/world_state.d.ts +5 -4
  104. package/dest/interfaces/world_state.d.ts.map +1 -1
  105. package/dest/kernel/claimed_length_array.js +1 -1
  106. package/dest/kernel/hints/build_note_hash_read_request_hints.d.ts +3 -3
  107. package/dest/kernel/hints/build_note_hash_read_request_hints.d.ts.map +1 -1
  108. package/dest/kernel/hints/build_note_hash_read_request_hints.js +13 -10
  109. package/dest/kernel/hints/build_nullifier_read_request_hints.d.ts +3 -3
  110. package/dest/kernel/hints/build_nullifier_read_request_hints.d.ts.map +1 -1
  111. package/dest/kernel/hints/build_nullifier_read_request_hints.js +13 -10
  112. package/dest/kernel/hints/build_transient_data_hints.d.ts +5 -2
  113. package/dest/kernel/hints/build_transient_data_hints.d.ts.map +1 -1
  114. package/dest/kernel/hints/build_transient_data_hints.js +9 -3
  115. package/dest/kernel/hints/private_kernel_reset_hints.d.ts +1 -1
  116. package/dest/kernel/hints/private_kernel_reset_hints.d.ts.map +1 -1
  117. package/dest/kernel/padded_side_effects.js +1 -1
  118. package/dest/kernel/private_kernel_tail_circuit_public_inputs.d.ts +2 -1
  119. package/dest/kernel/private_kernel_tail_circuit_public_inputs.d.ts.map +1 -1
  120. package/dest/kernel/private_kernel_tail_circuit_public_inputs.js +4 -0
  121. package/dest/kernel/private_to_avm_accumulated_data.js +2 -2
  122. package/dest/kernel/private_to_public_accumulated_data.js +2 -2
  123. package/dest/kernel/private_to_rollup_accumulated_data.js +1 -1
  124. package/dest/logs/debug_log_store.d.ts +30 -0
  125. package/dest/logs/debug_log_store.d.ts.map +1 -0
  126. package/dest/logs/debug_log_store.js +30 -0
  127. package/dest/logs/extended_directional_app_tagging_secret.d.ts +47 -0
  128. package/dest/logs/extended_directional_app_tagging_secret.d.ts.map +1 -0
  129. package/dest/logs/{directional_app_tagging_secret.js → extended_directional_app_tagging_secret.js} +35 -20
  130. package/dest/logs/index.d.ts +4 -2
  131. package/dest/logs/index.d.ts.map +1 -1
  132. package/dest/logs/index.js +3 -1
  133. package/dest/logs/log_filter.d.ts +4 -1
  134. package/dest/logs/log_filter.d.ts.map +1 -1
  135. package/dest/logs/log_filter.js +2 -1
  136. package/dest/logs/message_context.d.ts +4 -7
  137. package/dest/logs/message_context.d.ts.map +1 -1
  138. package/dest/logs/message_context.js +23 -9
  139. package/dest/logs/pending_tagged_log.d.ts +2 -3
  140. package/dest/logs/pending_tagged_log.d.ts.map +1 -1
  141. package/dest/logs/pending_tagged_log.js +2 -2
  142. package/dest/logs/pre_tag.d.ts +16 -11
  143. package/dest/logs/pre_tag.d.ts.map +1 -1
  144. package/dest/logs/pre_tag.js +2 -2
  145. package/dest/logs/private_log.js +1 -1
  146. package/dest/logs/public_log.d.ts +4 -3
  147. package/dest/logs/public_log.d.ts.map +1 -1
  148. package/dest/logs/public_log.js +9 -2
  149. package/dest/logs/shared_secret_derivation.d.ts +11 -10
  150. package/dest/logs/shared_secret_derivation.d.ts.map +1 -1
  151. package/dest/logs/shared_secret_derivation.js +15 -9
  152. package/dest/logs/siloed_tag.d.ts +8 -3
  153. package/dest/logs/siloed_tag.d.ts.map +1 -1
  154. package/dest/logs/siloed_tag.js +11 -2
  155. package/dest/logs/tag.js +1 -1
  156. package/dest/logs/tagging_index_range.d.ts +40 -0
  157. package/dest/logs/tagging_index_range.d.ts.map +1 -0
  158. package/dest/logs/tagging_index_range.js +8 -0
  159. package/dest/logs/tx_scoped_l2_log.d.ts +3 -1
  160. package/dest/logs/tx_scoped_l2_log.d.ts.map +1 -1
  161. package/dest/logs/tx_scoped_l2_log.js +7 -0
  162. package/dest/messaging/l1_to_l2_message.d.ts +3 -2
  163. package/dest/messaging/l1_to_l2_message.d.ts.map +1 -1
  164. package/dest/messaging/l1_to_l2_message.js +11 -13
  165. package/dest/messaging/l2_to_l1_membership.d.ts +32 -6
  166. package/dest/messaging/l2_to_l1_membership.d.ts.map +1 -1
  167. package/dest/messaging/l2_to_l1_membership.js +69 -26
  168. package/dest/noir/index.d.ts +3 -3
  169. package/dest/noir/index.d.ts.map +1 -1
  170. package/dest/note/note_dao.d.ts +1 -1
  171. package/dest/note/note_dao.d.ts.map +1 -1
  172. package/dest/note/note_dao.js +1 -4
  173. package/dest/p2p/attestation_utils.d.ts +11 -1
  174. package/dest/p2p/attestation_utils.d.ts.map +1 -1
  175. package/dest/p2p/attestation_utils.js +45 -0
  176. package/dest/p2p/block_proposal.d.ts +2 -2
  177. package/dest/p2p/block_proposal.d.ts.map +1 -1
  178. package/dest/p2p/block_proposal.js +1 -1
  179. package/dest/p2p/checkpoint_proposal.d.ts +2 -7
  180. package/dest/p2p/checkpoint_proposal.d.ts.map +1 -1
  181. package/dest/p2p/checkpoint_proposal.js +14 -24
  182. package/dest/p2p/client_type.d.ts +2 -5
  183. package/dest/p2p/client_type.d.ts.map +1 -1
  184. package/dest/p2p/client_type.js +0 -7
  185. package/dest/p2p/index.d.ts +1 -2
  186. package/dest/p2p/index.d.ts.map +1 -1
  187. package/dest/p2p/index.js +0 -1
  188. package/dest/p2p/peer_error.d.ts +3 -1
  189. package/dest/p2p/peer_error.d.ts.map +1 -1
  190. package/dest/p2p/peer_error.js +5 -0
  191. package/dest/p2p/topic_type.d.ts +3 -4
  192. package/dest/p2p/topic_type.d.ts.map +1 -1
  193. package/dest/p2p/topic_type.js +7 -24
  194. package/dest/parity/parity_base_private_inputs.js +1 -1
  195. package/dest/proofs/chonk_proof.d.ts +1 -1
  196. package/dest/proofs/chonk_proof.d.ts.map +1 -1
  197. package/dest/proofs/chonk_proof.js +7 -1
  198. package/dest/rollup/base_rollup_hints.js +2 -2
  199. package/dest/rollup/block_root_rollup_private_inputs.js +5 -5
  200. package/dest/rollup/checkpoint_rollup_public_inputs.js +1 -1
  201. package/dest/rollup/checkpoint_root_rollup_private_inputs.js +3 -3
  202. package/dest/rollup/root_rollup_public_inputs.js +1 -1
  203. package/dest/rollup/tree_snapshot_diff_hints.js +2 -2
  204. package/dest/slashing/tally.d.ts +7 -2
  205. package/dest/slashing/tally.d.ts.map +1 -1
  206. package/dest/slashing/tally.js +30 -2
  207. package/dest/tests/factories.d.ts +3 -1
  208. package/dest/tests/factories.d.ts.map +1 -1
  209. package/dest/tests/factories.js +9 -1
  210. package/dest/tests/mocks.d.ts +5 -3
  211. package/dest/tests/mocks.d.ts.map +1 -1
  212. package/dest/tests/mocks.js +20 -15
  213. package/dest/tx/block_header.d.ts +3 -1
  214. package/dest/tx/block_header.d.ts.map +1 -1
  215. package/dest/tx/block_header.js +4 -0
  216. package/dest/tx/capsule.d.ts +6 -2
  217. package/dest/tx/capsule.d.ts.map +1 -1
  218. package/dest/tx/capsule.js +9 -3
  219. package/dest/tx/private_execution_result.d.ts +6 -6
  220. package/dest/tx/private_execution_result.d.ts.map +1 -1
  221. package/dest/tx/private_execution_result.js +6 -6
  222. package/dest/tx/profiling.d.ts +14 -2
  223. package/dest/tx/profiling.d.ts.map +1 -1
  224. package/dest/tx/profiling.js +13 -3
  225. package/dest/tx/protocol_contracts.js +2 -2
  226. package/dest/tx/simulated_tx.d.ts +63 -77
  227. package/dest/tx/simulated_tx.d.ts.map +1 -1
  228. package/dest/tx/simulated_tx.js +7 -4
  229. package/dest/tx/tx.d.ts +6 -5
  230. package/dest/tx/tx.d.ts.map +1 -1
  231. package/dest/tx/tx.js +18 -6
  232. package/dest/tx/tx_receipt.d.ts +29 -6
  233. package/dest/tx/tx_receipt.d.ts.map +1 -1
  234. package/dest/tx/tx_receipt.js +23 -19
  235. package/dest/tx/validator/error_texts.d.ts +9 -1
  236. package/dest/tx/validator/error_texts.d.ts.map +1 -1
  237. package/dest/tx/validator/error_texts.js +10 -0
  238. package/dest/update-checker/index.d.ts +3 -2
  239. package/dest/update-checker/index.d.ts.map +1 -1
  240. package/dest/update-checker/index.js +2 -1
  241. package/dest/update-checker/package_version.d.ts +3 -0
  242. package/dest/update-checker/package_version.d.ts.map +1 -0
  243. package/dest/update-checker/package_version.js +24 -0
  244. package/dest/update-checker/version_checker.d.ts +25 -0
  245. package/dest/update-checker/version_checker.d.ts.map +1 -0
  246. package/dest/update-checker/version_checker.js +50 -0
  247. package/dest/validators/errors.d.ts +6 -1
  248. package/dest/validators/errors.d.ts.map +1 -1
  249. package/dest/validators/errors.js +7 -0
  250. package/dest/versioning/versioning.d.ts +4 -2
  251. package/dest/versioning/versioning.d.ts.map +1 -1
  252. package/dest/versioning/versioning.js +4 -1
  253. package/dest/vks/vk_data.js +1 -1
  254. package/package.json +10 -10
  255. package/src/abi/abi.ts +78 -2
  256. package/src/abi/buffer.ts +25 -4
  257. package/src/abi/decoder.ts +36 -82
  258. package/src/abi/encoder.ts +49 -6
  259. package/src/abi/event_metadata_definition.ts +2 -0
  260. package/src/abi/function_selector.ts +1 -1
  261. package/src/abi/function_signature_decoder.ts +77 -0
  262. package/src/abi/index.ts +1 -0
  263. package/src/abi/selector.ts +1 -1
  264. package/src/abi/utils.ts +25 -0
  265. package/src/avm/avm_accumulated_data.ts +6 -6
  266. package/src/avm/avm_circuit_public_inputs.ts +4 -4
  267. package/src/avm/revert_code.ts +26 -25
  268. package/src/block/l2_block.ts +13 -1
  269. package/src/block/l2_block_source.ts +16 -7
  270. package/src/block/l2_block_stream/interfaces.ts +6 -2
  271. package/src/block/l2_block_stream/l2_block_stream.ts +21 -0
  272. package/src/checkpoint/checkpoint.ts +12 -3
  273. package/src/checkpoint/index.ts +1 -0
  274. package/src/checkpoint/validate.ts +230 -0
  275. package/src/config/sequencer-config.ts +6 -1
  276. package/src/epoch-helpers/index.ts +22 -0
  277. package/src/gas/README.md +123 -0
  278. package/src/gas/gas_fees.ts +7 -1
  279. package/src/gas/gas_settings.ts +65 -12
  280. package/src/hash/hash.ts +34 -0
  281. package/src/interfaces/allowed_element.ts +29 -9
  282. package/src/interfaces/archiver.ts +3 -2
  283. package/src/interfaces/aztec-node-debug.ts +40 -0
  284. package/src/interfaces/aztec-node.ts +24 -5
  285. package/src/interfaces/block-builder.ts +60 -14
  286. package/src/interfaces/client.ts +1 -0
  287. package/src/interfaces/configs.ts +25 -8
  288. package/src/interfaces/merkle_tree_operations.ts +8 -18
  289. package/src/interfaces/p2p.ts +2 -13
  290. package/src/interfaces/prover-client.ts +8 -0
  291. package/src/interfaces/validator.ts +19 -3
  292. package/src/interfaces/world_state.ts +4 -3
  293. package/src/kernel/claimed_length_array.ts +2 -2
  294. package/src/kernel/hints/build_note_hash_read_request_hints.ts +14 -18
  295. package/src/kernel/hints/build_nullifier_read_request_hints.ts +15 -18
  296. package/src/kernel/hints/build_transient_data_hints.ts +17 -2
  297. package/src/kernel/hints/private_kernel_reset_hints.ts +5 -2
  298. package/src/kernel/hints/read_request_hints.ts +3 -3
  299. package/src/kernel/padded_side_effects.ts +3 -3
  300. package/src/kernel/private_kernel_tail_circuit_public_inputs.ts +9 -0
  301. package/src/kernel/private_to_avm_accumulated_data.ts +4 -4
  302. package/src/kernel/private_to_public_accumulated_data.ts +10 -10
  303. package/src/kernel/private_to_rollup_accumulated_data.ts +5 -5
  304. package/src/logs/debug_log_store.ts +54 -0
  305. package/src/logs/{directional_app_tagging_secret.ts → extended_directional_app_tagging_secret.ts} +41 -22
  306. package/src/logs/index.ts +3 -1
  307. package/src/logs/log_filter.ts +5 -0
  308. package/src/logs/message_context.ts +17 -7
  309. package/src/logs/pending_tagged_log.ts +1 -3
  310. package/src/logs/pre_tag.ts +5 -5
  311. package/src/logs/private_log.ts +1 -1
  312. package/src/logs/public_log.ts +15 -3
  313. package/src/logs/shared_secret_derivation.ts +21 -10
  314. package/src/logs/siloed_tag.ts +14 -3
  315. package/src/logs/tag.ts +1 -1
  316. package/src/logs/tagging_index_range.ts +24 -0
  317. package/src/logs/tx_scoped_l2_log.ts +16 -0
  318. package/src/messaging/l1_to_l2_message.ts +12 -9
  319. package/src/messaging/l2_to_l1_membership.ts +98 -33
  320. package/src/noir/index.ts +2 -2
  321. package/src/note/note_dao.ts +1 -4
  322. package/src/p2p/attestation_utils.ts +56 -0
  323. package/src/p2p/block_proposal.ts +1 -1
  324. package/src/p2p/checkpoint_proposal.ts +24 -38
  325. package/src/p2p/client_type.ts +0 -6
  326. package/src/p2p/index.ts +0 -1
  327. package/src/p2p/peer_error.ts +7 -0
  328. package/src/p2p/topic_type.ts +8 -15
  329. package/src/parity/parity_base_private_inputs.ts +1 -1
  330. package/src/proofs/chonk_proof.ts +9 -1
  331. package/src/rollup/base_rollup_hints.ts +2 -2
  332. package/src/rollup/block_root_rollup_private_inputs.ts +8 -8
  333. package/src/rollup/checkpoint_rollup_public_inputs.ts +2 -2
  334. package/src/rollup/checkpoint_root_rollup_private_inputs.ts +4 -4
  335. package/src/rollup/root_rollup_public_inputs.ts +2 -2
  336. package/src/rollup/tree_snapshot_diff_hints.ts +5 -5
  337. package/src/slashing/tally.ts +34 -1
  338. package/src/tests/factories.ts +10 -1
  339. package/src/tests/mocks.ts +26 -11
  340. package/src/tx/block_header.ts +6 -0
  341. package/src/tx/capsule.ts +10 -2
  342. package/src/tx/private_execution_result.ts +5 -5
  343. package/src/tx/profiling.ts +11 -2
  344. package/src/tx/protocol_contracts.ts +2 -2
  345. package/src/tx/simulated_tx.ts +14 -3
  346. package/src/tx/tx.ts +20 -11
  347. package/src/tx/tx_receipt.ts +28 -16
  348. package/src/tx/validator/error_texts.ts +12 -0
  349. package/src/update-checker/index.ts +2 -1
  350. package/src/update-checker/package_version.ts +30 -0
  351. package/src/update-checker/version_checker.ts +65 -0
  352. package/src/validators/errors.ts +9 -0
  353. package/src/versioning/versioning.ts +4 -1
  354. package/src/vks/vk_data.ts +1 -1
  355. package/dest/ha-signing/config.d.ts +0 -101
  356. package/dest/ha-signing/config.d.ts.map +0 -1
  357. package/dest/ha-signing/config.js +0 -92
  358. package/dest/ha-signing/index.d.ts +0 -3
  359. package/dest/ha-signing/index.d.ts.map +0 -1
  360. package/dest/ha-signing/index.js +0 -2
  361. package/dest/ha-signing/types.d.ts +0 -85
  362. package/dest/ha-signing/types.d.ts.map +0 -1
  363. package/dest/ha-signing/types.js +0 -32
  364. package/dest/logs/directional_app_tagging_secret.d.ts +0 -40
  365. package/dest/logs/directional_app_tagging_secret.d.ts.map +0 -1
  366. package/dest/update-checker/update-checker.d.ts +0 -49
  367. package/dest/update-checker/update-checker.d.ts.map +0 -1
  368. package/dest/update-checker/update-checker.js +0 -130
  369. package/src/ha-signing/config.ts +0 -149
  370. package/src/ha-signing/index.ts +0 -18
  371. package/src/ha-signing/types.ts +0 -112
  372. package/src/update-checker/update-checker.ts +0 -166
@@ -1,49 +0,0 @@
1
- import type { ViemClient } from '@aztec/ethereum/types';
2
- import { EthAddress } from '@aztec/foundation/eth-address';
3
- import { EventEmitter } from 'events';
4
- export type EventMap = {
5
- newRollupVersion: [{
6
- currentVersion: bigint;
7
- latestVersion: bigint;
8
- }];
9
- newNodeVersion: [{
10
- currentVersion: string;
11
- latestVersion: string;
12
- }];
13
- updateNodeConfig: [object];
14
- updatePublicTelemetryConfig: [object];
15
- };
16
- type Config = {
17
- baseURL: URL;
18
- nodeVersion?: string;
19
- checkIntervalMs?: number;
20
- registryContractAddress: EthAddress;
21
- publicClient: ViemClient;
22
- fetch?: typeof fetch;
23
- };
24
- export declare class UpdateChecker extends EventEmitter<EventMap> {
25
- private updatesUrl;
26
- private nodeVersion;
27
- private rollupVersion;
28
- private fetch;
29
- private getLatestRollupVersion;
30
- private checkIntervalMs;
31
- private log;
32
- private runningPromise;
33
- private lastPatchedConfig;
34
- private lastPatchedPublicTelemetryConfig;
35
- constructor(updatesUrl: URL, nodeVersion: string | undefined, rollupVersion: bigint, fetch: typeof globalThis.fetch, getLatestRollupVersion: () => Promise<bigint>, checkIntervalMs?: number, log?: import("@aztec/foundation/log").Logger);
36
- static new(config: Config): Promise<UpdateChecker>;
37
- start(): void;
38
- stop(): Promise<void>;
39
- trigger(): Promise<void>;
40
- private runChecks;
41
- private checkRollupVersion;
42
- private checkConfig;
43
- }
44
- /**
45
- * Returns package version.
46
- */
47
- export declare function getPackageVersion(): string | undefined;
48
- export {};
49
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXBkYXRlLWNoZWNrZXIuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91cGRhdGUtY2hlY2tlci91cGRhdGUtY2hlY2tlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxVQUFVLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUN4RCxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFLM0QsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLFFBQVEsQ0FBQztBQVl0QyxNQUFNLE1BQU0sUUFBUSxHQUFHO0lBQ3JCLGdCQUFnQixFQUFFLENBQUM7UUFBRSxjQUFjLEVBQUUsTUFBTSxDQUFDO1FBQUMsYUFBYSxFQUFFLE1BQU0sQ0FBQTtLQUFFLENBQUMsQ0FBQztJQUN0RSxjQUFjLEVBQUUsQ0FBQztRQUFFLGNBQWMsRUFBRSxNQUFNLENBQUM7UUFBQyxhQUFhLEVBQUUsTUFBTSxDQUFBO0tBQUUsQ0FBQyxDQUFDO0lBQ3BFLGdCQUFnQixFQUFFLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDM0IsMkJBQTJCLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQztDQUN2QyxDQUFDO0FBRUYsS0FBSyxNQUFNLEdBQUc7SUFDWixPQUFPLEVBQUUsR0FBRyxDQUFDO0lBQ2IsV0FBVyxDQUFDLEVBQUUsTUFBTSxDQUFDO0lBQ3JCLGVBQWUsQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUN6Qix1QkFBdUIsRUFBRSxVQUFVLENBQUM7SUFDcEMsWUFBWSxFQUFFLFVBQVUsQ0FBQztJQUN6QixLQUFLLENBQUMsRUFBRSxPQUFPLEtBQUssQ0FBQztDQUN0QixDQUFDO0FBRUYscUJBQWEsYUFBYyxTQUFRLFlBQVksQ0FBQyxRQUFRLENBQUM7SUFNckQsT0FBTyxDQUFDLFVBQVU7SUFDbEIsT0FBTyxDQUFDLFdBQVc7SUFDbkIsT0FBTyxDQUFDLGFBQWE7SUFDckIsT0FBTyxDQUFDLEtBQUs7SUFDYixPQUFPLENBQUMsc0JBQXNCO0lBQzlCLE9BQU8sQ0FBQyxlQUFlO0lBQ3ZCLE9BQU8sQ0FBQyxHQUFHO0lBWGIsT0FBTyxDQUFDLGNBQWMsQ0FBaUI7SUFDdkMsT0FBTyxDQUFDLGlCQUFpQixDQUFjO0lBQ3ZDLE9BQU8sQ0FBQyxnQ0FBZ0MsQ0FBYztJQUV0RCxZQUNVLFVBQVUsRUFBRSxHQUFHLEVBQ2YsV0FBVyxFQUFFLE1BQU0sR0FBRyxTQUFTLEVBQy9CLGFBQWEsRUFBRSxNQUFNLEVBQ3JCLEtBQUssRUFBRSxPQUFPLFVBQVUsQ0FBQyxLQUFLLEVBQzlCLHNCQUFzQixFQUFFLE1BQU0sT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUM3QyxlQUFlLFNBQWMsRUFDN0IsR0FBRyx5Q0FBMEMsRUFJdEQ7SUFFRCxPQUFvQixHQUFHLENBQUMsTUFBTSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsYUFBYSxDQUFDLENBWTlEO0lBRU0sS0FBSyxJQUFJLElBQUksQ0FXbkI7SUFFTSxJQUFJLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQU0zQjtJQUVNLE9BQU8sSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLENBRTlCO0lBRUQsT0FBTyxDQUFDLFNBQVMsQ0FFZjtZQUVZLGtCQUFrQjtZQWVsQixXQUFXO0NBc0MxQjtBQUVEOztHQUVHO0FBQ0gsd0JBQWdCLGlCQUFpQixJQUFJLE1BQU0sR0FBRyxTQUFTLENBV3REIn0=
@@ -1 +0,0 @@
1
- {"version":3,"file":"update-checker.d.ts","sourceRoot":"","sources":["../../src/update-checker/update-checker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAK3D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAYtC,MAAM,MAAM,QAAQ,GAAG;IACrB,gBAAgB,EAAE,CAAC;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACtE,cAAc,EAAE,CAAC;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpE,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3B,2BAA2B,EAAE,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,KAAK,MAAM,GAAG;IACZ,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uBAAuB,EAAE,UAAU,CAAC;IACpC,YAAY,EAAE,UAAU,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB,CAAC;AAEF,qBAAa,aAAc,SAAQ,YAAY,CAAC,QAAQ,CAAC;IAMrD,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,sBAAsB;IAC9B,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,GAAG;IAXb,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,iBAAiB,CAAc;IACvC,OAAO,CAAC,gCAAgC,CAAc;IAEtD,YACU,UAAU,EAAE,GAAG,EACf,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,EAC9B,sBAAsB,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAC7C,eAAe,SAAc,EAC7B,GAAG,yCAA0C,EAItD;IAED,OAAoB,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAY9D;IAEM,KAAK,IAAI,IAAI,CAWnB;IAEM,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAM3B;IAEM,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAE9B;IAED,OAAO,CAAC,SAAS,CAEf;YAEY,kBAAkB;YAelB,WAAW;CAsC1B;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAWtD"}
@@ -1,130 +0,0 @@
1
- import { RegistryContract } from '@aztec/ethereum/contracts';
2
- import { createLogger } from '@aztec/foundation/log';
3
- import { RunningPromise } from '@aztec/foundation/running-promise';
4
- import { fileURLToPath } from '@aztec/foundation/url';
5
- import { EventEmitter } from 'events';
6
- import { readFileSync } from 'fs';
7
- import { dirname, resolve } from 'path';
8
- import { isDeepStrictEqual } from 'util';
9
- import { z } from 'zod';
10
- const updateConfigSchema = z.object({
11
- version: z.string().optional(),
12
- publicTelemetry: z.any().optional(),
13
- config: z.any().optional()
14
- });
15
- export class UpdateChecker extends EventEmitter {
16
- updatesUrl;
17
- nodeVersion;
18
- rollupVersion;
19
- fetch;
20
- getLatestRollupVersion;
21
- checkIntervalMs;
22
- log;
23
- runningPromise;
24
- lastPatchedConfig;
25
- lastPatchedPublicTelemetryConfig;
26
- constructor(updatesUrl, nodeVersion, rollupVersion, fetch1, getLatestRollupVersion, checkIntervalMs = 10 * 60_000, log = createLogger('foundation:update-check')){
27
- super(), this.updatesUrl = updatesUrl, this.nodeVersion = nodeVersion, this.rollupVersion = rollupVersion, this.fetch = fetch1, this.getLatestRollupVersion = getLatestRollupVersion, this.checkIntervalMs = checkIntervalMs, this.log = log, this.lastPatchedConfig = {}, this.lastPatchedPublicTelemetryConfig = {}, this.runChecks = async ()=>{
28
- await Promise.all([
29
- this.checkRollupVersion(),
30
- this.checkConfig()
31
- ]);
32
- };
33
- this.runningPromise = new RunningPromise(this.runChecks, this.log, this.checkIntervalMs);
34
- }
35
- static async new(config) {
36
- const registryContract = new RegistryContract(config.publicClient, config.registryContractAddress);
37
- const getLatestRollupVersion = ()=>registryContract.getRollupVersions().then((versions)=>versions.at(-1));
38
- return new UpdateChecker(config.baseURL, config.nodeVersion ?? getPackageVersion(), await getLatestRollupVersion(), config.fetch ?? fetch, getLatestRollupVersion, config.checkIntervalMs);
39
- }
40
- start() {
41
- if (this.runningPromise.isRunning()) {
42
- this.log.debug(`Can't start update checker again`);
43
- return;
44
- }
45
- this.log.info('Starting update checker', {
46
- nodeVersion: this.nodeVersion,
47
- rollupVersion: this.rollupVersion
48
- });
49
- this.runningPromise.start();
50
- }
51
- stop() {
52
- if (!this.runningPromise.isRunning()) {
53
- this.log.debug(`Can't stop update checker because it is not running`);
54
- return Promise.resolve();
55
- }
56
- return this.runningPromise.stop();
57
- }
58
- trigger() {
59
- return this.runningPromise.trigger();
60
- }
61
- runChecks;
62
- async checkRollupVersion() {
63
- try {
64
- const canonicalRollupVersion = await this.getLatestRollupVersion();
65
- if (canonicalRollupVersion !== this.rollupVersion) {
66
- this.log.debug('New canonical rollup version', {
67
- currentVersion: this.rollupVersion,
68
- latestVersion: canonicalRollupVersion
69
- });
70
- this.emit('newRollupVersion', {
71
- currentVersion: this.rollupVersion,
72
- latestVersion: canonicalRollupVersion
73
- });
74
- }
75
- } catch (err) {
76
- this.log.warn(`Failed to check if there is a new rollup`, err);
77
- }
78
- }
79
- async checkConfig() {
80
- try {
81
- const response = await this.fetch(this.updatesUrl);
82
- const body = await response.json();
83
- if (!response.ok) {
84
- this.log.warn(`Unexpected HTTP response checking for updates`, {
85
- status: response.status,
86
- body: await response.text(),
87
- url: this.updatesUrl
88
- });
89
- }
90
- const { version, config, publicTelemetry } = updateConfigSchema.parse(body);
91
- if (this.nodeVersion && version && version !== this.nodeVersion) {
92
- this.log.debug('New node version', {
93
- currentVersion: this.nodeVersion,
94
- latestVersion: version
95
- });
96
- this.emit('newNodeVersion', {
97
- currentVersion: this.nodeVersion,
98
- latestVersion: version
99
- });
100
- }
101
- if (config && Object.keys(config).length > 0 && !isDeepStrictEqual(config, this.lastPatchedConfig)) {
102
- this.log.debug('New node config', {
103
- config
104
- });
105
- this.lastPatchedConfig = config;
106
- this.emit('updateNodeConfig', config);
107
- }
108
- if (publicTelemetry && Object.keys(publicTelemetry).length > 0 && !isDeepStrictEqual(publicTelemetry, this.lastPatchedPublicTelemetryConfig)) {
109
- this.log.debug('New metrics config', {
110
- config
111
- });
112
- this.lastPatchedPublicTelemetryConfig = publicTelemetry;
113
- this.emit('updatePublicTelemetryConfig', publicTelemetry);
114
- }
115
- } catch (err) {
116
- this.log.warn(`Failed to check if there is an update`, err);
117
- }
118
- }
119
- }
120
- /**
121
- * Returns package version.
122
- */ export function getPackageVersion() {
123
- try {
124
- const releasePleaseManifestPath = resolve(dirname(fileURLToPath(import.meta.url)), '../../../../.release-please-manifest.json');
125
- const version = JSON.parse(readFileSync(releasePleaseManifestPath).toString())['.'];
126
- return version;
127
- } catch {
128
- return undefined;
129
- }
130
- }
@@ -1,149 +0,0 @@
1
- import type { L1ContractAddresses } from '@aztec/ethereum/l1-contract-addresses';
2
- import {
3
- type ConfigMappingsType,
4
- booleanConfigHelper,
5
- getConfigFromMappings,
6
- getDefaultConfig,
7
- numberConfigHelper,
8
- optionalNumberConfigHelper,
9
- } from '@aztec/foundation/config';
10
- import { EthAddress } from '@aztec/foundation/eth-address';
11
- import type { ZodFor } from '@aztec/foundation/schemas';
12
-
13
- import { z } from 'zod';
14
-
15
- /**
16
- * Configuration for the Validator HA Signer
17
- *
18
- * This config is used for distributed locking and slashing protection
19
- * when running multiple validator nodes in a high-availability setup.
20
- */
21
- export interface ValidatorHASignerConfig {
22
- /** Whether HA signing / slashing protection is enabled */
23
- haSigningEnabled: boolean;
24
- /** L1 contract addresses (rollup address required) */
25
- l1Contracts: Pick<L1ContractAddresses, 'rollupAddress'>;
26
- /** Unique identifier for this node */
27
- nodeId: string;
28
- /** How long to wait between polls when a duty is being signed (ms) */
29
- pollingIntervalMs: number;
30
- /** Maximum time to wait for a duty being signed to complete (ms) */
31
- signingTimeoutMs: number;
32
- /** Maximum age of a stuck duty in ms (defaults to 2x hardcoded Aztec slot duration if not set) */
33
- maxStuckDutiesAgeMs?: number;
34
- /** Optional: clean up old duties after this many hours (disabled if not set) */
35
- cleanupOldDutiesAfterHours?: number;
36
- /**
37
- * PostgreSQL connection string
38
- * Format: postgresql://user:password@host:port/database
39
- */
40
- databaseUrl?: string;
41
- /**
42
- * PostgreSQL connection pool configuration
43
- */
44
- /** Maximum number of clients in the pool (default: 10) */
45
- poolMaxCount?: number;
46
- /** Minimum number of clients in the pool (default: 0) */
47
- poolMinCount?: number;
48
- /** Idle timeout in milliseconds (default: 10000) */
49
- poolIdleTimeoutMs?: number;
50
- /** Connection timeout in milliseconds (default: 0, no timeout) */
51
- poolConnectionTimeoutMs?: number;
52
- }
53
-
54
- export const validatorHASignerConfigMappings: ConfigMappingsType<ValidatorHASignerConfig> = {
55
- haSigningEnabled: {
56
- env: 'VALIDATOR_HA_SIGNING_ENABLED',
57
- description: 'Whether HA signing / slashing protection is enabled',
58
- ...booleanConfigHelper(false),
59
- },
60
- l1Contracts: {
61
- description: 'L1 contract addresses (rollup address required)',
62
- nested: {
63
- rollupAddress: {
64
- description: 'The Ethereum address of the rollup contract (must be set programmatically)',
65
- parseEnv: (val: string) => EthAddress.fromString(val),
66
- },
67
- },
68
- },
69
- nodeId: {
70
- env: 'VALIDATOR_HA_NODE_ID',
71
- description: 'The unique identifier for this node',
72
- defaultValue: '',
73
- },
74
- pollingIntervalMs: {
75
- env: 'VALIDATOR_HA_POLLING_INTERVAL_MS',
76
- description: 'The number of ms to wait between polls when a duty is being signed',
77
- ...numberConfigHelper(100),
78
- },
79
- signingTimeoutMs: {
80
- env: 'VALIDATOR_HA_SIGNING_TIMEOUT_MS',
81
- description: 'The maximum time to wait for a duty being signed to complete',
82
- ...numberConfigHelper(3_000),
83
- },
84
- maxStuckDutiesAgeMs: {
85
- env: 'VALIDATOR_HA_MAX_STUCK_DUTIES_AGE_MS',
86
- description: 'The maximum age of a stuck duty in ms (defaults to 2x Aztec slot duration)',
87
- ...optionalNumberConfigHelper(),
88
- },
89
- cleanupOldDutiesAfterHours: {
90
- env: 'VALIDATOR_HA_OLD_DUTIES_MAX_AGE_H',
91
- description: 'Optional: clean up old duties after this many hours (disabled if not set)',
92
- ...optionalNumberConfigHelper(),
93
- },
94
- databaseUrl: {
95
- env: 'VALIDATOR_HA_DATABASE_URL',
96
- description:
97
- 'PostgreSQL connection string for validator HA signer (format: postgresql://user:password@host:port/database)',
98
- },
99
- poolMaxCount: {
100
- env: 'VALIDATOR_HA_POOL_MAX',
101
- description: 'Maximum number of clients in the pool',
102
- ...numberConfigHelper(10),
103
- },
104
- poolMinCount: {
105
- env: 'VALIDATOR_HA_POOL_MIN',
106
- description: 'Minimum number of clients in the pool',
107
- ...numberConfigHelper(0),
108
- },
109
- poolIdleTimeoutMs: {
110
- env: 'VALIDATOR_HA_POOL_IDLE_TIMEOUT_MS',
111
- description: 'Idle timeout in milliseconds',
112
- ...numberConfigHelper(10_000),
113
- },
114
- poolConnectionTimeoutMs: {
115
- env: 'VALIDATOR_HA_POOL_CONNECTION_TIMEOUT_MS',
116
- description: 'Connection timeout in milliseconds (0 means no timeout)',
117
- ...numberConfigHelper(0),
118
- },
119
- };
120
-
121
- export const defaultValidatorHASignerConfig: ValidatorHASignerConfig = getDefaultConfig(
122
- validatorHASignerConfigMappings,
123
- );
124
-
125
- /**
126
- * Returns the validator HA signer configuration from environment variables.
127
- * Note: If an environment variable is not set, the default value is used.
128
- * @returns The validator HA signer configuration.
129
- */
130
- export function getConfigEnvVars(): ValidatorHASignerConfig {
131
- return getConfigFromMappings<ValidatorHASignerConfig>(validatorHASignerConfigMappings);
132
- }
133
-
134
- export const ValidatorHASignerConfigSchema = z.object({
135
- haSigningEnabled: z.boolean(),
136
- l1Contracts: z.object({
137
- rollupAddress: z.instanceof(EthAddress),
138
- }),
139
- nodeId: z.string(),
140
- pollingIntervalMs: z.number().min(0),
141
- signingTimeoutMs: z.number().min(0),
142
- maxStuckDutiesAgeMs: z.number().min(0).optional(),
143
- cleanupOldDutiesAfterHours: z.number().min(0).optional(),
144
- databaseUrl: z.string().optional(),
145
- poolMaxCount: z.number().min(0).optional(),
146
- poolMinCount: z.number().min(0).optional(),
147
- poolIdleTimeoutMs: z.number().min(0).optional(),
148
- poolConnectionTimeoutMs: z.number().min(0).optional(),
149
- }) satisfies ZodFor<ValidatorHASignerConfig>;
@@ -1,18 +0,0 @@
1
- export {
2
- type ValidatorHASignerConfig,
3
- ValidatorHASignerConfigSchema,
4
- defaultValidatorHASignerConfig,
5
- getConfigEnvVars,
6
- validatorHASignerConfigMappings,
7
- } from './config.js';
8
- export {
9
- DutyType,
10
- type BlockProposalSigningContext,
11
- type HAProtectedSigningContext,
12
- type NoHAProtectionSigningContext,
13
- type OtherSigningContext,
14
- type SigningContext,
15
- type VoteSigningContext,
16
- getBlockNumberFromSigningContext,
17
- isHAProtectedContext,
18
- } from './types.js';
@@ -1,112 +0,0 @@
1
- import {
2
- BlockNumber,
3
- type CheckpointNumber,
4
- type IndexWithinCheckpoint,
5
- type SlotNumber,
6
- } from '@aztec/foundation/branded-types';
7
-
8
- /**
9
- * Type of validator duty being performed
10
- */
11
- export enum DutyType {
12
- BLOCK_PROPOSAL = 'BLOCK_PROPOSAL',
13
- CHECKPOINT_PROPOSAL = 'CHECKPOINT_PROPOSAL',
14
- ATTESTATION = 'ATTESTATION',
15
- ATTESTATIONS_AND_SIGNERS = 'ATTESTATIONS_AND_SIGNERS',
16
- GOVERNANCE_VOTE = 'GOVERNANCE_VOTE',
17
- SLASHING_VOTE = 'SLASHING_VOTE',
18
- AUTH_REQUEST = 'AUTH_REQUEST',
19
- TXS = 'TXS',
20
- }
21
-
22
- /**
23
- * Base context for signing operations
24
- */
25
- interface BaseSigningContext {
26
- /** Slot number for this duty */
27
- slot: SlotNumber;
28
- /**
29
- * Block or checkpoint number for this duty.
30
- * For block proposals, this is the block number.
31
- * For checkpoint proposals, this is the checkpoint number.
32
- */
33
- blockNumber: BlockNumber | CheckpointNumber;
34
- }
35
-
36
- /**
37
- * Signing context for block proposals.
38
- * blockIndexWithinCheckpoint is REQUIRED and must be >= 0.
39
- */
40
- export interface BlockProposalSigningContext extends BaseSigningContext {
41
- /** Block index within checkpoint (0, 1, 2...). Required for block proposals. */
42
- blockIndexWithinCheckpoint: IndexWithinCheckpoint;
43
- dutyType: DutyType.BLOCK_PROPOSAL;
44
- }
45
-
46
- /**
47
- * Signing context for non-block-proposal duties that require HA protection.
48
- * blockIndexWithinCheckpoint is not applicable (internally always -1).
49
- */
50
- export interface OtherSigningContext extends BaseSigningContext {
51
- dutyType: DutyType.CHECKPOINT_PROPOSAL | DutyType.ATTESTATION | DutyType.ATTESTATIONS_AND_SIGNERS;
52
- }
53
-
54
- /**
55
- * Signing context for governance/slashing votes which only need slot for HA protection.
56
- * blockNumber is not applicable (internally always 0).
57
- */
58
- export interface VoteSigningContext {
59
- slot: SlotNumber;
60
- dutyType: DutyType.GOVERNANCE_VOTE | DutyType.SLASHING_VOTE;
61
- }
62
-
63
- /**
64
- * Signing context for duties which don't require slot/blockNumber
65
- * as they don't need HA protection (AUTH_REQUEST, TXS).
66
- */
67
- export interface NoHAProtectionSigningContext {
68
- dutyType: DutyType.AUTH_REQUEST | DutyType.TXS;
69
- }
70
-
71
- /**
72
- * Signing contexts that require HA protection (excludes AUTH_REQUEST).
73
- * Used by the HA signer's signWithProtection method.
74
- */
75
- export type HAProtectedSigningContext = BlockProposalSigningContext | OtherSigningContext | VoteSigningContext;
76
-
77
- /**
78
- * Context required for slashing protection during signing operations.
79
- * Uses discriminated union to enforce type safety:
80
- * - BLOCK_PROPOSAL duties MUST have blockIndexWithinCheckpoint >= 0
81
- * - Other duty types do NOT have blockIndexWithinCheckpoint (internally -1)
82
- * - Vote duties only need slot (blockNumber is internally 0)
83
- * - AUTH_REQUEST and TXS duties don't need slot/blockNumber (no HA protection needed)
84
- */
85
- export type SigningContext = HAProtectedSigningContext | NoHAProtectionSigningContext;
86
-
87
- /**
88
- * Type guard to check if a SigningContext requires HA protection.
89
- * Returns true for contexts that need HA protection, false for AUTH_REQUEST and TXS.
90
- */
91
- export function isHAProtectedContext(context: SigningContext): context is HAProtectedSigningContext {
92
- return context.dutyType !== DutyType.AUTH_REQUEST && context.dutyType !== DutyType.TXS;
93
- }
94
-
95
- /**
96
- * Gets the block number from a signing context.
97
- * - Vote duties (GOVERNANCE_VOTE, SLASHING_VOTE): returns BlockNumber(0)
98
- * - Other duties: returns the blockNumber from the context
99
- */
100
- export function getBlockNumberFromSigningContext(context: HAProtectedSigningContext): BlockNumber | CheckpointNumber {
101
- // Check for duty types that have blockNumber
102
- if (
103
- context.dutyType === DutyType.BLOCK_PROPOSAL ||
104
- context.dutyType === DutyType.CHECKPOINT_PROPOSAL ||
105
- context.dutyType === DutyType.ATTESTATION ||
106
- context.dutyType === DutyType.ATTESTATIONS_AND_SIGNERS
107
- ) {
108
- return context.blockNumber;
109
- }
110
- // Vote duties (GOVERNANCE_VOTE, SLASHING_VOTE) don't have blockNumber
111
- return BlockNumber(0);
112
- }
@@ -1,166 +0,0 @@
1
- import { RegistryContract } from '@aztec/ethereum/contracts';
2
- import type { ViemClient } from '@aztec/ethereum/types';
3
- import { EthAddress } from '@aztec/foundation/eth-address';
4
- import { createLogger } from '@aztec/foundation/log';
5
- import { RunningPromise } from '@aztec/foundation/running-promise';
6
- import { fileURLToPath } from '@aztec/foundation/url';
7
-
8
- import { EventEmitter } from 'events';
9
- import { readFileSync } from 'fs';
10
- import { dirname, resolve } from 'path';
11
- import { isDeepStrictEqual } from 'util';
12
- import { z } from 'zod';
13
-
14
- const updateConfigSchema = z.object({
15
- version: z.string().optional(),
16
- publicTelemetry: z.any().optional(),
17
- config: z.any().optional(),
18
- });
19
-
20
- export type EventMap = {
21
- newRollupVersion: [{ currentVersion: bigint; latestVersion: bigint }];
22
- newNodeVersion: [{ currentVersion: string; latestVersion: string }];
23
- updateNodeConfig: [object];
24
- updatePublicTelemetryConfig: [object];
25
- };
26
-
27
- type Config = {
28
- baseURL: URL;
29
- nodeVersion?: string;
30
- checkIntervalMs?: number;
31
- registryContractAddress: EthAddress;
32
- publicClient: ViemClient;
33
- fetch?: typeof fetch;
34
- };
35
-
36
- export class UpdateChecker extends EventEmitter<EventMap> {
37
- private runningPromise: RunningPromise;
38
- private lastPatchedConfig: object = {};
39
- private lastPatchedPublicTelemetryConfig: object = {};
40
-
41
- constructor(
42
- private updatesUrl: URL,
43
- private nodeVersion: string | undefined,
44
- private rollupVersion: bigint,
45
- private fetch: typeof globalThis.fetch,
46
- private getLatestRollupVersion: () => Promise<bigint>,
47
- private checkIntervalMs = 10 * 60_000, // every 10 mins
48
- private log = createLogger('foundation:update-check'),
49
- ) {
50
- super();
51
- this.runningPromise = new RunningPromise(this.runChecks, this.log, this.checkIntervalMs);
52
- }
53
-
54
- public static async new(config: Config): Promise<UpdateChecker> {
55
- const registryContract = new RegistryContract(config.publicClient, config.registryContractAddress);
56
- const getLatestRollupVersion = () => registryContract.getRollupVersions().then(versions => versions.at(-1)!);
57
-
58
- return new UpdateChecker(
59
- config.baseURL,
60
- config.nodeVersion ?? getPackageVersion(),
61
- await getLatestRollupVersion(),
62
- config.fetch ?? fetch,
63
- getLatestRollupVersion,
64
- config.checkIntervalMs,
65
- );
66
- }
67
-
68
- public start(): void {
69
- if (this.runningPromise.isRunning()) {
70
- this.log.debug(`Can't start update checker again`);
71
- return;
72
- }
73
-
74
- this.log.info('Starting update checker', {
75
- nodeVersion: this.nodeVersion,
76
- rollupVersion: this.rollupVersion,
77
- });
78
- this.runningPromise.start();
79
- }
80
-
81
- public stop(): Promise<void> {
82
- if (!this.runningPromise.isRunning()) {
83
- this.log.debug(`Can't stop update checker because it is not running`);
84
- return Promise.resolve();
85
- }
86
- return this.runningPromise.stop();
87
- }
88
-
89
- public trigger(): Promise<void> {
90
- return this.runningPromise.trigger();
91
- }
92
-
93
- private runChecks = async (): Promise<void> => {
94
- await Promise.all([this.checkRollupVersion(), this.checkConfig()]);
95
- };
96
-
97
- private async checkRollupVersion(): Promise<void> {
98
- try {
99
- const canonicalRollupVersion = await this.getLatestRollupVersion();
100
- if (canonicalRollupVersion !== this.rollupVersion) {
101
- this.log.debug('New canonical rollup version', {
102
- currentVersion: this.rollupVersion,
103
- latestVersion: canonicalRollupVersion,
104
- });
105
- this.emit('newRollupVersion', { currentVersion: this.rollupVersion, latestVersion: canonicalRollupVersion });
106
- }
107
- } catch (err) {
108
- this.log.warn(`Failed to check if there is a new rollup`, err);
109
- }
110
- }
111
-
112
- private async checkConfig(): Promise<void> {
113
- try {
114
- const response = await this.fetch(this.updatesUrl);
115
- const body = await response.json();
116
- if (!response.ok) {
117
- this.log.warn(`Unexpected HTTP response checking for updates`, {
118
- status: response.status,
119
- body: await response.text(),
120
- url: this.updatesUrl,
121
- });
122
- }
123
-
124
- const { version, config, publicTelemetry } = updateConfigSchema.parse(body);
125
-
126
- if (this.nodeVersion && version && version !== this.nodeVersion) {
127
- this.log.debug('New node version', { currentVersion: this.nodeVersion, latestVersion: version });
128
- this.emit('newNodeVersion', { currentVersion: this.nodeVersion, latestVersion: version });
129
- }
130
-
131
- if (config && Object.keys(config).length > 0 && !isDeepStrictEqual(config, this.lastPatchedConfig)) {
132
- this.log.debug('New node config', { config });
133
- this.lastPatchedConfig = config;
134
- this.emit('updateNodeConfig', config);
135
- }
136
-
137
- if (
138
- publicTelemetry &&
139
- Object.keys(publicTelemetry).length > 0 &&
140
- !isDeepStrictEqual(publicTelemetry, this.lastPatchedPublicTelemetryConfig)
141
- ) {
142
- this.log.debug('New metrics config', { config });
143
- this.lastPatchedPublicTelemetryConfig = publicTelemetry;
144
- this.emit('updatePublicTelemetryConfig', publicTelemetry);
145
- }
146
- } catch (err) {
147
- this.log.warn(`Failed to check if there is an update`, err);
148
- }
149
- }
150
- }
151
-
152
- /**
153
- * Returns package version.
154
- */
155
- export function getPackageVersion(): string | undefined {
156
- try {
157
- const releasePleaseManifestPath = resolve(
158
- dirname(fileURLToPath(import.meta.url)),
159
- '../../../../.release-please-manifest.json',
160
- );
161
- const version = JSON.parse(readFileSync(releasePleaseManifestPath).toString())['.'];
162
- return version;
163
- } catch {
164
- return undefined;
165
- }
166
- }