From c3fb631ce4e3823478f31f81c8591fd4878a49bb Mon Sep 17 00:00:00 2001 From: sprites0 <199826320+sprites0@users.noreply.github.com> Date: Tue, 1 Jul 2025 03:15:24 +0000 Subject: [PATCH] doc: a little bit more docs for hl_node ingestion --- src/pseudo_peer/sources/hl_node.rs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/pseudo_peer/sources/hl_node.rs b/src/pseudo_peer/sources/hl_node.rs index f96b0eb39..6c5545def 100644 --- a/src/pseudo_peer/sources/hl_node.rs +++ b/src/pseudo_peer/sources/hl_node.rs @@ -22,9 +22,15 @@ const HOURLY_SUBDIR: &str = "hourly"; /// In normal situation, 0~1 blocks will be cached. const CACHE_SIZE: u32 = 1000; -/// Block source that tails the local ingest directory for the HL node. +/// Block source that monitors the local ingest directory for the HL node. /// -/// Originally written at https://github.com/hl-archive-node/nanoreth/pull/7 +/// In certain situations, the [hl-node][ref] may offer lower latency compared to S3. +/// This block source caches blocks from the HL node to minimize latency, +/// while still falling back to [super::LocalBlockSource] or [super::S3BlockSource] when needed. +/// +/// Originally introduced in https://github.com/hl-archive-node/nanoreth/pull/7 +/// +/// [ref]: https://github.com/hyperliquid-dex/node #[derive(Debug, Clone)] pub struct HlNodeBlockSource { pub fallback: BlockSourceBoxed,