1use crate::{
2 connection::ConnWrapper,
3 credentials::EthstatsCredentials,
4 error::EthStatsError,
5 events::{
6 AuthMsg, BlockMsg, BlockStats, HistoryMsg, LatencyMsg, NodeInfo, NodeStats, PayloadMsg,
7 PayloadStats, PendingMsg, PendingStats, PingMsg, StatsMsg, TxStats, UncleStats,
8 },
9};
10use alloy_consensus::{BlockHeader, Sealable};
11use alloy_primitives::U256;
12use reth_chain_state::{CanonStateNotification, CanonStateSubscriptions};
13use reth_network_api::{NetworkInfo, Peers};
14use reth_primitives_traits::{Block, BlockBody};
15use reth_storage_api::{BlockReader, BlockReaderIdExt, NodePrimitivesProvider};
16use reth_transaction_pool::TransactionPool;
17
18use chrono::Local;
19use serde_json::Value;
20use std::{
21 str::FromStr,
22 sync::Arc,
23 time::{Duration, Instant},
24};
25use tokio::{
26 sync::{mpsc, Mutex, RwLock},
27 time::{interval, sleep, timeout},
28};
29use tokio_stream::StreamExt;
30use tokio_tungstenite::connect_async;
31use tracing::{debug, info};
32use url::Url;
33
34const HISTORY_UPDATE_RANGE: u64 = 50;
36const RECONNECT_INTERVAL: Duration = Duration::from_secs(5);
38const PING_TIMEOUT: Duration = Duration::from_secs(5);
40const REPORT_INTERVAL: Duration = Duration::from_secs(15);
42const CONNECT_TIMEOUT: Duration = Duration::from_secs(10);
44const READ_TIMEOUT: Duration = Duration::from_secs(30);
46
47#[derive(Debug, Clone)]
54pub struct EthStatsService<Network, Provider, Pool> {
55 credentials: EthstatsCredentials,
57 conn: Arc<RwLock<Option<ConnWrapper>>>,
59 last_ping: Arc<Mutex<Option<Instant>>>,
61 network: Network,
63 provider: Provider,
65 pool: Pool,
67}
68
69impl<Network, Provider, Pool> EthStatsService<Network, Provider, Pool>
70where
71 Network: NetworkInfo + Peers,
72 Provider: BlockReaderIdExt + CanonStateSubscriptions,
73 Pool: TransactionPool,
74{
75 pub async fn new(
83 url: &str,
84 network: Network,
85 provider: Provider,
86 pool: Pool,
87 ) -> Result<Self, EthStatsError> {
88 let credentials = EthstatsCredentials::from_str(url)?;
89 let service = Self {
90 credentials,
91 conn: Arc::new(RwLock::new(None)),
92 last_ping: Arc::new(Mutex::new(None)),
93 network,
94 provider,
95 pool,
96 };
97 service.connect().await?;
98
99 Ok(service)
100 }
101
102 async fn connect(&self) -> Result<(), EthStatsError> {
108 debug!(
109 target: "ethstats",
110 "Attempting to connect to EthStats server at {}", self.credentials.host
111 );
112 let protocol = if self.credentials.use_tls { "wss" } else { "ws" };
113 let full_url = format!("{}://{}/api", protocol, self.credentials.host);
114 let url = Url::parse(&full_url).map_err(EthStatsError::Url)?;
115
116 match timeout(CONNECT_TIMEOUT, connect_async(url.as_str())).await {
117 Ok(Ok((ws_stream, _))) => {
118 debug!(
119 target: "ethstats",
120 "Successfully connected to EthStats server at {}", self.credentials.host
121 );
122 let conn: ConnWrapper = ConnWrapper::new(ws_stream);
123 *self.conn.write().await = Some(conn);
124 self.login().await?;
125 Ok(())
126 }
127 Ok(Err(e)) => Err(EthStatsError::WebSocket(e)),
128 Err(_) => {
129 debug!(target: "ethstats", "Connection to EthStats server timed out");
130 Err(EthStatsError::Timeout)
131 }
132 }
133 }
134
135 async fn login(&self) -> Result<(), EthStatsError> {
140 debug!(
141 target: "ethstats",
142 "Attempting to login to EthStats server as node_id {}", self.credentials.node_id
143 );
144 let conn = self.conn.read().await;
145 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
146
147 let network_status = self
148 .network
149 .network_status()
150 .await
151 .map_err(|e| EthStatsError::AuthError(e.to_string()))?;
152 let id = &self.credentials.node_id;
153 let secret = &self.credentials.secret;
154 let protocol = network_status
155 .capabilities
156 .iter()
157 .map(|cap| format!("{}/{}", cap.name, cap.version))
158 .collect::<Vec<_>>()
159 .join(", ");
160 let port = self.network.local_addr().port() as u64;
161
162 let auth = AuthMsg {
163 id: id.clone(),
164 secret: secret.clone(),
165 info: NodeInfo {
166 name: id.clone(),
167 node: network_status.client_version.clone(),
168 port,
169 network: self.network.chain_id().to_string(),
170 protocol,
171 api: "No".to_string(),
172 os: std::env::consts::OS.into(),
173 os_ver: std::env::consts::ARCH.into(),
174 client: "0.1.1".to_string(),
175 history: true,
176 },
177 };
178
179 let message = auth.generate_login_message();
180 conn.write_json(&message).await?;
181
182 let response =
183 timeout(READ_TIMEOUT, conn.read_json()).await.map_err(|_| EthStatsError::Timeout)??;
184
185 if let Some(ack) = response.get("emit") &&
186 ack.get(0) == Some(&Value::String("ready".to_string()))
187 {
188 info!(
189 target: "ethstats",
190 "Login successful to EthStats server as node_id {}", self.credentials.node_id
191 );
192 return Ok(());
193 }
194
195 debug!(target: "ethstats", "Login failed: Unauthorized or unexpected login response");
196 Err(EthStatsError::AuthError("Unauthorized or unexpected login response".into()))
197 }
198
199 async fn report_stats(&self) -> Result<(), EthStatsError> {
204 let conn = self.conn.read().await;
205 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
206
207 let stats_msg = StatsMsg {
208 id: self.credentials.node_id.clone(),
209 stats: NodeStats {
210 active: true,
211 syncing: self.network.is_syncing(),
212 peers: self.network.num_connected_peers() as u64,
213 gas_price: self.pool.block_info().pending_basefee,
214 uptime: 100,
215 },
216 };
217
218 let message = stats_msg.generate_stats_message();
219 conn.write_json(&message).await?;
220
221 Ok(())
222 }
223
224 async fn send_ping(&self) -> Result<(), EthStatsError> {
229 let conn = self.conn.read().await;
230 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
231
232 let ping_time = Instant::now();
233 *self.last_ping.lock().await = Some(ping_time);
234
235 let client_time = Local::now().format("%Y-%m-%d %H:%M:%S%.f %:z %Z").to_string();
236 let ping_msg = PingMsg { id: self.credentials.node_id.clone(), client_time };
237
238 let message = ping_msg.generate_ping_message();
239 conn.write_json(&message).await?;
240
241 let active_ping = self.last_ping.clone();
243 let conn_ref = self.conn.clone();
244 tokio::spawn(async move {
245 sleep(PING_TIMEOUT).await;
246 let timed_out = {
247 let mut active = active_ping.lock().await;
248 let timed_out = active.is_some();
249 if timed_out {
250 *active = None;
251 }
252 timed_out
253 };
254
255 if timed_out {
256 debug!(target: "ethstats", "Ping timeout");
257 if let Some(conn) = conn_ref.write().await.take() {
259 let _ = conn.close().await;
260 }
261 }
262 });
263
264 Ok(())
265 }
266
267 async fn report_latency(&self) -> Result<(), EthStatsError> {
272 let start = {
273 let mut active = self.last_ping.lock().await;
274 active.take()
275 };
276
277 if let Some(start) = start {
278 let latency = start.elapsed().as_millis() as u64 / 2;
279
280 debug!(target: "ethstats", "Reporting latency: {}ms", latency);
281
282 let latency_msg = LatencyMsg { id: self.credentials.node_id.clone(), latency };
283
284 let message = latency_msg.generate_latency_message();
285 let conn = self.conn.read().await;
286 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
287 conn.write_json(&message).await?;
288 }
289
290 Ok(())
291 }
292
293 async fn report_pending(&self) -> Result<(), EthStatsError> {
298 let conn = self.conn.read().await;
299 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
300 let pending = self.pool.pool_size().pending as u64;
301
302 debug!(target: "ethstats", "Reporting pending txs: {}", pending);
303
304 let pending_msg =
305 PendingMsg { id: self.credentials.node_id.clone(), stats: PendingStats { pending } };
306
307 let message = pending_msg.generate_pending_message();
308 conn.write_json(&message).await?;
309
310 Ok(())
311 }
312
313 async fn report_block(
322 &self,
323 head: Option<CanonStateNotification<<Provider as NodePrimitivesProvider>::Primitives>>,
324 ) -> Result<(), EthStatsError> {
325 let conn = self.conn.read().await;
326 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
327
328 let block_number = if let Some(head) = head {
329 head.tip().header().number()
330 } else {
331 self.provider
332 .best_block_number()
333 .map_err(|e| EthStatsError::DataFetchError(e.to_string()))?
334 };
335
336 match self.provider.block_by_id(block_number.into()) {
337 Ok(Some(block)) => {
338 let block_msg = BlockMsg {
339 id: self.credentials.node_id.clone(),
340 block: self.block_to_stats(&block)?,
341 };
342
343 debug!(target: "ethstats", "Reporting block: {}", block_number);
344
345 let message = block_msg.generate_block_message();
346 conn.write_json(&message).await?;
347 }
348 Ok(None) => {
349 debug!(target: "ethstats", "Block {} not found", block_number);
351 return Err(EthStatsError::BlockNotFound(block_number));
352 }
353 Err(e) => {
354 debug!(target: "ethstats", "Error fetching block {}: {}", block_number, e);
355 return Err(EthStatsError::DataFetchError(e.to_string()));
356 }
357 };
358
359 Ok(())
360 }
361
362 pub async fn report_new_payload(
367 &self,
368 block_hash: alloy_primitives::B256,
369 block_number: u64,
370 processing_time: Duration,
371 ) -> Result<(), EthStatsError> {
372 let conn = self.conn.read().await;
373 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
374
375 let payload_stats = PayloadStats {
376 number: U256::from(block_number),
377 hash: block_hash,
378 processing_time: processing_time.as_millis() as u64,
379 };
380
381 let payload_msg =
382 PayloadMsg { id: self.credentials.node_id.clone(), payload: payload_stats };
383
384 debug!(
385 target: "ethstats",
386 "Reporting new payload: block={}, hash={:?}, processing_time={}ms",
387 block_number,
388 block_hash,
389 processing_time.as_millis()
390 );
391
392 let message = payload_msg.generate_new_payload_message();
393 conn.write_json(&message).await?;
394
395 Ok(())
396 }
397
398 fn block_to_stats(
406 &self,
407 block: &<Provider as BlockReader>::Block,
408 ) -> Result<BlockStats, EthStatsError> {
409 let body = block.body();
410 let header = block.header();
411
412 let txs = body.transaction_hashes_iter().copied().map(|hash| TxStats { hash }).collect();
413
414 Ok(BlockStats {
415 number: U256::from(header.number()),
416 hash: header.hash_slow(),
417 parent_hash: header.parent_hash(),
418 timestamp: U256::from(header.timestamp()),
419 miner: header.beneficiary(),
420 gas_used: header.gas_used(),
421 gas_limit: header.gas_limit(),
422 diff: header.difficulty().to_string(),
423 total_diff: "0".into(),
424 txs,
425 tx_root: header.transactions_root(),
426 root: header.state_root(),
427 uncles: UncleStats(vec![]),
428 })
429 }
430
431 async fn report_history(&self, list: Option<&Vec<u64>>) -> Result<(), EthStatsError> {
440 let conn = self.conn.read().await;
441 let conn = conn.as_ref().ok_or(EthStatsError::NotConnected)?;
442
443 let indexes = if let Some(list) = list {
444 list
445 } else {
446 let best_block_number = self
447 .provider
448 .best_block_number()
449 .map_err(|e| EthStatsError::DataFetchError(e.to_string()))?;
450
451 let start = best_block_number.saturating_sub(HISTORY_UPDATE_RANGE);
452
453 &(start..=best_block_number).collect()
454 };
455
456 let mut blocks = Vec::with_capacity(indexes.len());
457 for &block_number in indexes {
458 match self.provider.block_by_id(block_number.into()) {
459 Ok(Some(block)) => {
460 blocks.push(block);
461 }
462 Ok(None) => {
463 debug!(target: "ethstats", "Block {} not found", block_number);
465 break;
466 }
467 Err(e) => {
468 debug!(target: "ethstats", "Error fetching block {}: {}", block_number, e);
469 break;
470 }
471 }
472 }
473
474 let history: Vec<BlockStats> =
475 blocks.iter().map(|block| self.block_to_stats(block)).collect::<Result<_, _>>()?;
476
477 if history.is_empty() {
478 debug!(target: "ethstats", "No history to send to stats server");
479 } else {
480 debug!(
481 target: "ethstats",
482 "Sending historical blocks to ethstats, first: {}, last: {}",
483 history.first().unwrap().number,
484 history.last().unwrap().number
485 );
486 }
487
488 let history_msg = HistoryMsg { id: self.credentials.node_id.clone(), history };
489
490 let message = history_msg.generate_history_message();
491 conn.write_json(&message).await?;
492
493 Ok(())
494 }
495
496 async fn report(&self) -> Result<(), EthStatsError> {
501 self.send_ping().await?;
502 self.report_block(None).await?;
503 self.report_pending().await?;
504 self.report_stats().await?;
505
506 Ok(())
507 }
508
509 async fn handle_message(&self, msg: Value) -> Result<(), EthStatsError> {
535 let emit = match msg.get("emit") {
536 Some(emit) => emit,
537 None => {
538 debug!(target: "ethstats", "Stats server sent non-broadcast, msg {}", msg);
539 return Err(EthStatsError::InvalidRequest);
540 }
541 };
542
543 let command = match emit.get(0) {
544 Some(Value::String(command)) => command.as_str(),
545 _ => {
546 debug!(target: "ethstats", "Invalid stats server message type, msg {}", msg);
547 return Err(EthStatsError::InvalidRequest);
548 }
549 };
550
551 match command {
552 "node-pong" => {
553 self.report_latency().await?;
554 }
555 "history" => {
556 let block_numbers = emit
557 .get(1)
558 .and_then(|v| v.as_object())
559 .and_then(|obj| obj.get("list"))
560 .and_then(|v| v.as_array());
561
562 if block_numbers.is_none() {
563 self.report_history(None).await?;
564
565 return Ok(());
566 }
567
568 let block_numbers = block_numbers
569 .unwrap()
570 .iter()
571 .map(|val| {
572 val.as_u64().ok_or_else(|| {
573 debug!(
574 target: "ethstats",
575 "Invalid stats history block number, msg {}", msg
576 );
577 EthStatsError::InvalidRequest
578 })
579 })
580 .collect::<Result<_, _>>()?;
581
582 self.report_history(Some(&block_numbers)).await?;
583 }
584 other => debug!(target: "ethstats", "Unhandled command: {}", other),
585 }
586
587 Ok(())
588 }
589
590 pub async fn run(self) {
602 let (shutdown_tx, mut shutdown_rx) = mpsc::channel(1);
604 let (message_tx, mut message_rx) = mpsc::channel(32);
605 let (head_tx, mut head_rx) = mpsc::channel(10);
606
607 let read_handle = {
609 let conn_arc = self.conn.clone();
610 let message_tx = message_tx.clone();
611 let shutdown_tx = shutdown_tx.clone();
612
613 tokio::spawn(async move {
614 loop {
615 let conn_guard = conn_arc.read().await;
616 if let Some(conn) = conn_guard.as_ref() {
617 match conn.read_json().await {
618 Ok(msg) => {
619 if message_tx.send(msg).await.is_err() {
620 break;
621 }
622 }
623 Err(e) => match e {
624 crate::error::ConnectionError::Serialization(err) => {
625 debug!(target: "ethstats", "JSON parse error from stats server: {}", err);
626 }
627 other => {
628 debug!(target: "ethstats", "Read error: {}", other);
629 drop(conn_guard);
630 if let Some(conn) = conn_arc.write().await.take() {
631 let _ = conn.close().await;
632 }
633 }
634 },
635 }
636 } else {
637 sleep(RECONNECT_INTERVAL).await;
638 }
639 }
640
641 let _ = shutdown_tx.send(()).await;
642 })
643 };
644
645 let canonical_stream_handle = {
646 let mut canonical_stream = self.provider.canonical_state_stream();
647 let head_tx = head_tx.clone();
648 let shutdown_tx = shutdown_tx.clone();
649
650 tokio::spawn(async move {
651 while let Some(head) = canonical_stream.next().await {
652 if head_tx.send(head).await.is_err() {
653 break;
654 }
655 }
656
657 let _ = shutdown_tx.send(()).await;
658 })
659 };
660
661 let mut pending_tx_receiver = self.pool.pending_transactions_listener();
662
663 let mut report_interval = interval(REPORT_INTERVAL);
665 let mut reconnect_interval = interval(RECONNECT_INTERVAL);
666
667 loop {
669 tokio::select! {
670 _ = shutdown_rx.recv() => {
672 info!(target: "ethstats", "Shutting down ethstats service");
673 break;
674 }
675
676 Some(msg) = message_rx.recv() => {
678 if let Err(e) = self.handle_message(msg).await {
679 debug!(target: "ethstats", "Error handling message: {}", e);
680 self.disconnect().await;
681 }
682 }
683
684 Some(head) = head_rx.recv() => {
686 if let Err(e) = self.report_block(Some(head)).await {
687 debug!(target: "ethstats", "Failed to report block: {}", e);
688 self.disconnect().await;
689 }
690
691 if let Err(e) = self.report_pending().await {
692 debug!(target: "ethstats", "Failed to report pending: {}", e);
693 self.disconnect().await;
694 }
695 }
696
697 _= pending_tx_receiver.recv() => {
699 if let Err(e) = self.report_pending().await {
700 debug!(target: "ethstats", "Failed to report pending: {}", e);
701 self.disconnect().await;
702 }
703 }
704
705 _ = report_interval.tick() => {
707 if let Err(e) = self.report().await {
708 debug!(target: "ethstats", "Failed to report: {}", e);
709 self.disconnect().await;
710 }
711 }
712
713 _ = reconnect_interval.tick() => {
715 if self.conn.read().await.is_none() {
716 match self.connect().await {
717 Ok(_) => info!(target: "ethstats", "Reconnected successfully"),
718 Err(e) => debug!(target: "ethstats", "Reconnect failed: {}", e),
719 }
720 }
721 }
722 }
723 }
724
725 self.disconnect().await;
727
728 read_handle.abort();
730 canonical_stream_handle.abort();
731 }
732
733 async fn disconnect(&self) {
738 if let Some(conn) = self.conn.write().await.take() &&
739 let Err(e) = conn.close().await
740 {
741 debug!(target: "ethstats", "Error closing connection: {}", e);
742 }
743 }
744
745 #[cfg(test)]
747 pub async fn is_connected(&self) -> bool {
748 self.conn.read().await.is_some()
749 }
750}
751
752#[cfg(test)]
753mod tests {
754 use super::*;
755 use futures_util::{SinkExt, StreamExt};
756 use reth_network_api::noop::NoopNetwork;
757 use reth_storage_api::noop::NoopProvider;
758 use reth_transaction_pool::noop::NoopTransactionPool;
759 use serde_json::json;
760 use tokio::{net::TcpListener, sync::Notify};
761 use tokio_tungstenite::tungstenite::protocol::{frame::Utf8Bytes, Message};
762
763 const TEST_HOST: &str = "127.0.0.1";
764 const TEST_PORT: u16 = 0; async fn setup_mock_server() -> (String, tokio::task::JoinHandle<()>) {
767 let listener = TcpListener::bind((TEST_HOST, TEST_PORT)).await.unwrap();
768 let addr = listener.local_addr().unwrap();
769
770 let handle = tokio::spawn(async move {
771 let (stream, _) = listener.accept().await.unwrap();
772 let mut ws_stream = tokio_tungstenite::accept_async(stream).await.unwrap();
773
774 if let Some(Ok(Message::Text(text))) = ws_stream.next().await {
776 let value: serde_json::Value = serde_json::from_str(&text).unwrap();
777 if value["emit"][0] == "hello" {
778 let response = json!({
779 "emit": ["ready", []]
780 });
781 ws_stream
782 .send(Message::Text(Utf8Bytes::from(response.to_string())))
783 .await
784 .unwrap();
785 }
786 }
787
788 while let Some(Ok(msg)) = ws_stream.next().await {
790 if let Message::Text(text) = msg &&
791 text.contains("node-ping")
792 {
793 let pong = json!({
794 "emit": ["node-pong", {"id": "test-node"}]
795 });
796 ws_stream.send(Message::Text(Utf8Bytes::from(pong.to_string()))).await.unwrap();
797 }
798 }
799 });
800
801 (addr.to_string(), handle)
802 }
803
804 #[tokio::test]
805 async fn test_connection_and_login() {
806 let (server_url, server_handle) = setup_mock_server().await;
807 let ethstats_url = format!("test-node:test-secret@{server_url}");
808
809 let network = NoopNetwork::default();
810 let provider = NoopProvider::default();
811 let pool = NoopTransactionPool::default();
812
813 let service = EthStatsService::new(ðstats_url, network, provider, pool)
814 .await
815 .expect("Service should connect");
816
817 assert!(service.is_connected().await, "Service should be connected");
819
820 server_handle.abort();
822 }
823
824 #[tokio::test]
825 async fn test_history_command_handling() {
826 let (server_url, server_handle) = setup_mock_server().await;
827 let ethstats_url = format!("test-node:test-secret@{server_url}");
828
829 let network = NoopNetwork::default();
830 let provider = NoopProvider::default();
831 let pool = NoopTransactionPool::default();
832
833 let service = EthStatsService::new(ðstats_url, network, provider, pool)
834 .await
835 .expect("Service should connect");
836
837 let history_cmd = json!({
839 "emit": ["history", {"list": [1, 2, 3]}]
840 });
841
842 service.handle_message(history_cmd).await.expect("History command should be handled");
843
844 server_handle.abort();
846 }
847
848 #[tokio::test]
849 async fn test_invalid_url_handling() {
850 let network = NoopNetwork::default();
851 let provider = NoopProvider::default();
852 let pool = NoopTransactionPool::default();
853
854 let result = EthStatsService::new(
856 "test-node@localhost",
857 network.clone(),
858 provider.clone(),
859 pool.clone(),
860 )
861 .await;
862 assert!(
863 matches!(result, Err(EthStatsError::InvalidUrl(_))),
864 "Should detect invalid URL format"
865 );
866
867 let result = EthStatsService::new("invalid-url", network, provider, pool).await;
869 assert!(
870 matches!(result, Err(EthStatsError::InvalidUrl(_))),
871 "Should detect invalid URL format"
872 );
873 }
874
875 #[tokio::test(flavor = "current_thread")]
876 async fn report_latency_lock_order_regression() {
877 let (server_url, server_handle) = setup_mock_server().await;
879 let ethstats_url = format!("test-node:test-secret@{server_url}");
880
881 let network = NoopNetwork::default();
882 let provider = NoopProvider::default();
883 let pool = NoopTransactionPool::default();
884
885 let service = EthStatsService::new(ðstats_url, network, provider, pool)
886 .await
887 .expect("Service should connect");
888
889 let mut last_ping_guard = service.last_ping.lock().await;
891 *last_ping_guard = Some(Instant::now());
892
893 let started = Arc::new(Notify::new());
894 let started_clone = started.clone();
895 let service_clone = service.clone();
896 let handle = tokio::spawn(async move {
897 started_clone.notify_one();
898 let _ = service_clone.report_latency().await;
899 });
900
901 started.notified().await;
903 tokio::task::yield_now().await;
904
905 let write_guard =
908 tokio::time::timeout(std::time::Duration::from_millis(100), service.conn.write())
909 .await
910 .expect(
911 "conn write lock should not be held while report_latency waits on last_ping",
912 );
913
914 drop(write_guard);
915 drop(last_ping_guard);
916
917 let _ = handle.await;
918 server_handle.abort();
919 }
920}