diff --git a/crates/blockchain/src/lib.rs b/crates/blockchain/src/lib.rs index 4360377d..46f99899 100644 --- a/crates/blockchain/src/lib.rs +++ b/crates/blockchain/src/lib.rs @@ -49,6 +49,8 @@ pub const INTERVALS_PER_SLOT: u64 = 5; /// Milliseconds in a slot (derived from interval duration and count). pub const MILLISECONDS_PER_SLOT: u64 = MILLISECONDS_PER_INTERVAL * INTERVALS_PER_SLOT; pub use ethlambda_types::block::MAX_ATTESTATIONS_DATA; +/// Slots of head-vs-wall-clock lag above which a node is considered syncing. +pub use sync_status::SYNC_LAG_THRESHOLD; /// Future-slot tolerance for gossip attestations, expressed in intervals. /// /// Bounds the clock skew the time check is willing to absorb when admitting a diff --git a/crates/blockchain/src/sync_status.rs b/crates/blockchain/src/sync_status.rs index 02c71c9f..9130e278 100644 --- a/crates/blockchain/src/sync_status.rs +++ b/crates/blockchain/src/sync_status.rs @@ -5,7 +5,7 @@ use crate::metrics::SyncStatus; /// Local head lag beyond which the node is considered to be syncing. /// /// See: leanSpec PR #708. -const SYNC_LAG_THRESHOLD: u64 = 4; +pub const SYNC_LAG_THRESHOLD: u64 = 4; /// Freshest-known block lag beyond which the network is considered stalled. /// /// During a network-wide stall the node remains synced so validators can help diff --git a/crates/net/rpc/src/admin.rs b/crates/net/rpc/src/admin.rs index 43804d02..679a636d 100644 --- a/crates/net/rpc/src/admin.rs +++ b/crates/net/rpc/src/admin.rs @@ -12,10 +12,12 @@ //! the role (hot-standby model). See leanSpec PR #636 for the full rationale. use axum::{ - Extension, Json, + Extension, Json, Router, http::StatusCode, response::{IntoResponse, Response}, + routing::get, }; +use ethlambda_storage::Store; use ethlambda_types::aggregator::AggregatorController; use serde::Serialize; use serde_json::Value; @@ -23,6 +25,13 @@ use tracing::info; use crate::json_response; +pub(crate) fn routes() -> Router { + Router::new().route( + "/lean/v0/admin/aggregator", + get(get_aggregator).post(post_aggregator), + ) +} + #[derive(Serialize)] struct StatusResponse { is_aggregator: bool, @@ -44,7 +53,9 @@ struct ToggleResponse { /// `Extension` would cause axum to short-circuit with a 500 when the /// extension is missing, whereas `Option` yields `None` and lets us return /// a clean 503 with a useful message. -pub async fn get_aggregator(controller: Option>) -> Response { +pub(crate) async fn get_aggregator( + controller: Option>, +) -> Response { match controller { Some(Extension(controller)) => json_response(StatusResponse { is_aggregator: controller.is_enabled(), @@ -62,7 +73,7 @@ pub async fn get_aggregator(controller: Option>) /// `Extension` would cause axum to short-circuit with a 500 when the /// extension is missing, whereas `Option` yields `None` and lets us return /// a clean 503 with a useful message. -pub async fn post_aggregator( +pub(crate) async fn post_aggregator( controller: Option>, body: Option>, ) -> Response { diff --git a/crates/net/rpc/src/blocks.rs b/crates/net/rpc/src/blocks.rs index edfa1737..8110b99b 100644 --- a/crates/net/rpc/src/blocks.rs +++ b/crates/net/rpc/src/blocks.rs @@ -1,7 +1,9 @@ use axum::{ + Router, extract::{Path, State}, http::StatusCode, response::IntoResponse, + routing::get, }; use ethlambda_storage::Store; use ethlambda_types::primitives::H256; @@ -9,10 +11,16 @@ use serde_json::json; use crate::json_response; +pub(crate) fn routes() -> Router { + Router::new() + .route("/lean/v0/blocks/{block_id}", get(get_block)) + .route("/lean/v0/blocks/{block_id}/header", get(get_block_header)) +} + /// `GET /lean/v0/blocks/:block_id` — returns the block as JSON. /// /// `block_id` can be a `0x`-prefixed 32-byte hex root or a decimal slot. -pub async fn get_block( +pub(crate) async fn get_block( Path(block_id): Path, State(store): State, ) -> impl IntoResponse { @@ -28,7 +36,7 @@ pub async fn get_block( } /// `GET /lean/v0/blocks/:block_id/header` — returns the block header as JSON. -pub async fn get_block_header( +pub(crate) async fn get_block_header( Path(block_id): Path, State(store): State, ) -> impl IntoResponse { diff --git a/crates/net/rpc/src/core.rs b/crates/net/rpc/src/core.rs new file mode 100644 index 00000000..4ccd1f9a --- /dev/null +++ b/crates/net/rpc/src/core.rs @@ -0,0 +1,73 @@ +use axum::{ + Json, Router, + http::{HeaderValue, header}, + response::IntoResponse, + routing::get, +}; +use ethlambda_storage::Store; +use ethlambda_types::primitives::H256; +use libssz::SszEncode; + +pub(crate) fn routes() -> Router { + Router::new() + .route("/lean/v0/health", get(crate::metrics::get_health)) + .route("/lean/v0/states/finalized", get(get_latest_finalized_state)) + .route("/lean/v0/blocks/finalized", get(get_latest_finalized_block)) + .route( + "/lean/v0/checkpoints/justified", + get(get_latest_justified_state), + ) +} + +pub(crate) async fn get_latest_finalized_state( + axum::extract::State(store): axum::extract::State, +) -> impl IntoResponse { + let finalized = store.latest_finalized(); + let mut state = store + .get_state(&finalized.root) + .expect("finalized state exists"); + + // Zero state_root to match the canonical post-state representation. + // The spec's state_transition sets state_root to zero during process_block_header, + // and only fills it in lazily at the next slot's process_slots. + // Serving the canonical form ensures checkpoint sync interoperability. + state.latest_block_header.state_root = H256::ZERO; + + ssz_response(state.to_ssz()) +} + +pub(crate) async fn get_latest_finalized_block( + axum::extract::State(store): axum::extract::State, +) -> impl IntoResponse { + let finalized = store.latest_finalized(); + // Returns 404 for genesis since it doesn't have a valid signature + match store.get_signed_block(&finalized.root) { + Some(block) => ssz_response(block.to_ssz()), + None => axum::http::StatusCode::NOT_FOUND.into_response(), + } +} + +pub(crate) async fn get_latest_justified_state( + axum::extract::State(store): axum::extract::State, +) -> impl IntoResponse { + let checkpoint = store.latest_justified(); + json_response(checkpoint) +} + +pub(crate) fn json_response(value: T) -> axum::response::Response { + let mut response = Json(value).into_response(); + response.headers_mut().insert( + header::CONTENT_TYPE, + HeaderValue::from_static(crate::JSON_CONTENT_TYPE), + ); + response +} + +fn ssz_response(bytes: Vec) -> axum::response::Response { + let mut response = bytes.into_response(); + response.headers_mut().insert( + header::CONTENT_TYPE, + HeaderValue::from_static(crate::SSZ_CONTENT_TYPE), + ); + response +} diff --git a/crates/net/rpc/src/fork_choice.rs b/crates/net/rpc/src/fork_choice.rs index 75fb2702..19f368d4 100644 --- a/crates/net/rpc/src/fork_choice.rs +++ b/crates/net/rpc/src/fork_choice.rs @@ -1,10 +1,16 @@ -use axum::{http::HeaderValue, http::header, response::IntoResponse}; +use axum::{Router, http::HeaderValue, http::header, response::IntoResponse, routing::get}; use ethlambda_storage::Store; use ethlambda_types::{checkpoint::Checkpoint, primitives::H256}; use serde::Serialize; use crate::json_response; +pub(crate) fn routes() -> Router { + Router::new() + .route("/lean/v0/fork_choice", get(get_fork_choice)) + .route("/lean/v0/fork_choice/ui", get(get_fork_choice_ui)) +} + const HTML_CONTENT_TYPE: &str = "text/html; charset=utf-8"; const FORK_CHOICE_HTML: &str = include_str!("../static/fork_choice.html"); @@ -27,7 +33,7 @@ pub struct ForkChoiceNode { weight: u64, } -pub async fn get_fork_choice( +pub(crate) async fn get_fork_choice( axum::extract::State(store): axum::extract::State, ) -> impl IntoResponse { let blocks = store.get_live_chain(); @@ -75,7 +81,7 @@ pub async fn get_fork_choice( json_response(response) } -pub async fn get_fork_choice_ui() -> impl IntoResponse { +pub(crate) async fn get_fork_choice_ui() -> impl IntoResponse { let mut response = FORK_CHOICE_HTML.into_response(); response.headers_mut().insert( header::CONTENT_TYPE, @@ -87,7 +93,7 @@ pub async fn get_fork_choice_ui() -> impl IntoResponse { #[cfg(test)] mod tests { use super::*; - use axum::{Router, body::Body, http::Request, http::StatusCode, routing::get}; + use axum::{Router, body::Body, http::Request, http::StatusCode}; use ethlambda_storage::{Store, backend::InMemoryBackend}; use http_body_util::BodyExt; use std::sync::Arc; @@ -96,10 +102,7 @@ mod tests { use crate::test_utils::create_test_state; fn build_test_router(store: Store) -> Router { - Router::new() - .route("/lean/v0/fork_choice", get(get_fork_choice)) - .route("/lean/v0/fork_choice/ui", get(get_fork_choice_ui)) - .with_state(store) + routes().with_state(store) } #[tokio::test] diff --git a/crates/net/rpc/src/lib.rs b/crates/net/rpc/src/lib.rs index 9906bfb9..246e53ff 100644 --- a/crates/net/rpc/src/lib.rs +++ b/crates/net/rpc/src/lib.rs @@ -1,15 +1,8 @@ use std::net::{IpAddr, SocketAddr}; -use axum::{ - Extension, Json, Router, - http::{HeaderValue, StatusCode, header}, - response::IntoResponse, - routing::get, -}; +use axum::{Extension, Router}; use ethlambda_storage::Store; use ethlambda_types::aggregator::AggregatorController; -use ethlambda_types::primitives::H256; -use libssz::SszEncode; use tokio_util::sync::CancellationToken; pub(crate) const JSON_CONTENT_TYPE: &str = "application/json; charset=utf-8"; @@ -17,11 +10,15 @@ pub(crate) const SSZ_CONTENT_TYPE: &str = "application/octet-stream"; mod admin; mod blocks; +mod core; mod fork_choice; mod heap_profiling; pub mod metrics; +mod node; pub mod test_driver; +pub(crate) use core::json_response; + #[derive(Debug, Clone)] pub struct RpcConfig { pub http_address: IpAddr, @@ -100,32 +97,17 @@ pub async fn start_rpc_server( /// know about it and admin handlers extract it independently. fn build_api_router(store: Store) -> Router { Router::new() - .route("/lean/v0/health", get(metrics::get_health)) - .route("/lean/v0/states/finalized", get(get_latest_finalized_state)) - .route("/lean/v0/blocks/finalized", get(get_latest_finalized_block)) - .route( - "/lean/v0/checkpoints/justified", - get(get_latest_justified_state), - ) - .route("/lean/v0/fork_choice", get(fork_choice::get_fork_choice)) - .route( - "/lean/v0/fork_choice/ui", - get(fork_choice::get_fork_choice_ui), - ) - .route("/lean/v0/blocks/{block_id}", get(blocks::get_block)) - .route( - "/lean/v0/blocks/{block_id}/header", - get(blocks::get_block_header), - ) - .route( - "/lean/v0/admin/aggregator", - get(admin::get_aggregator).post(admin::post_aggregator), - ) + .merge(core::routes()) + .merge(blocks::routes()) + .merge(fork_choice::routes()) + .merge(admin::routes()) + .merge(node::routes()) .with_state(store) } /// Build the debug router for profiling endpoints. fn build_debug_router() -> Router { + use axum::routing::get; Router::new() .route("/debug/pprof/allocs", get(heap_profiling::handle_get_heap)) .route( @@ -134,59 +116,6 @@ fn build_debug_router() -> Router { ) } -async fn get_latest_finalized_state( - axum::extract::State(store): axum::extract::State, -) -> impl IntoResponse { - let finalized = store.latest_finalized(); - let mut state = store - .get_state(&finalized.root) - .expect("finalized state exists"); - - // Zero state_root to match the canonical post-state representation. - // The spec's state_transition sets state_root to zero during process_block_header, - // and only fills it in lazily at the next slot's process_slots. - // Serving the canonical form ensures checkpoint sync interoperability. - state.latest_block_header.state_root = H256::ZERO; - - ssz_response(state.to_ssz()) -} - -async fn get_latest_finalized_block( - axum::extract::State(store): axum::extract::State, -) -> impl IntoResponse { - let finalized = store.latest_finalized(); - // Returns 404 for genesis since it doesn't have a valid signature - match store.get_signed_block(&finalized.root) { - Some(block) => ssz_response(block.to_ssz()), - None => StatusCode::NOT_FOUND.into_response(), - } -} - -async fn get_latest_justified_state( - axum::extract::State(store): axum::extract::State, -) -> impl IntoResponse { - let checkpoint = store.latest_justified(); - json_response(checkpoint) -} - -fn json_response(value: T) -> axum::response::Response { - let mut response = Json(value).into_response(); - response.headers_mut().insert( - header::CONTENT_TYPE, - HeaderValue::from_static(JSON_CONTENT_TYPE), - ); - response -} - -fn ssz_response(bytes: Vec) -> axum::response::Response { - let mut response = bytes.into_response(); - response.headers_mut().insert( - header::CONTENT_TYPE, - HeaderValue::from_static(SSZ_CONTENT_TYPE), - ); - response -} - #[cfg(test)] pub(crate) mod test_utils { use ethlambda_storage::{StorageBackend, Table}; @@ -267,7 +196,7 @@ pub(crate) mod test_utils { #[cfg(test)] mod tests { use super::*; - use axum::{body::Body, http::Request}; + use axum::{body::Body, http::Request, http::StatusCode, http::header}; use ethlambda_storage::{ForkCheckpoints, Store, backend::InMemoryBackend}; use http_body_util::BodyExt; use serde_json::json; diff --git a/crates/net/rpc/src/node.rs b/crates/net/rpc/src/node.rs new file mode 100644 index 00000000..1b0103b6 --- /dev/null +++ b/crates/net/rpc/src/node.rs @@ -0,0 +1,136 @@ +use axum::{Router, extract::State, response::IntoResponse, routing::get}; +use ethlambda_blockchain::{MILLISECONDS_PER_SLOT, SYNC_LAG_THRESHOLD}; +use ethlambda_storage::Store; +use serde::Serialize; + +use crate::json_response; + +#[derive(Serialize)] +struct SyncingResponse { + is_syncing: bool, + head_slot: u64, + sync_distance: u64, + finalized_slot: u64, +} + +#[derive(Serialize)] +struct IdentityResponse { + version: &'static str, +} + +/// Simplified sync status: head-vs-wall-clock lag only. Unlike `SyncStatusTracker` +/// it has no hysteresis or stall-override (it is stateless). Sync distance is the +/// number of slots between the node's current head and the current wall-clock slot. +async fn get_syncing(State(store): State) -> impl IntoResponse { + let genesis_ms = store.config().genesis_time.saturating_mul(1000); + let now_ms = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_millis() as u64) + .unwrap_or(genesis_ms); + let wall_slot = now_ms.saturating_sub(genesis_ms) / MILLISECONDS_PER_SLOT; + let head_slot = store.head_slot(); + let sync_distance = wall_slot.saturating_sub(head_slot); + let finalized_slot = store.latest_finalized().slot; + json_response(SyncingResponse { + is_syncing: sync_distance > SYNC_LAG_THRESHOLD, + head_slot, + sync_distance, + finalized_slot, + }) +} + +async fn get_identity() -> impl IntoResponse { + json_response(IdentityResponse { + version: env!("CARGO_PKG_VERSION"), + }) +} + +pub(crate) fn routes() -> Router { + Router::new() + .route("/lean/v0/node/syncing", get(get_syncing)) + .route("/lean/v0/node/identity", get(get_identity)) +} + +#[cfg(test)] +mod tests { + use axum::{ + body::Body, + http::{Request, StatusCode}, + }; + use ethlambda_blockchain::SYNC_LAG_THRESHOLD; + use ethlambda_storage::{Store, backend::InMemoryBackend}; + use ethlambda_types::state::ChainConfig; + use http_body_util::BodyExt; + use std::sync::Arc; + use tower::ServiceExt; + + use crate::test_utils::create_test_state; + + /// Helper: GET /lean/v0/node/syncing and parse JSON body. + async fn get_syncing_json(store: Store) -> serde_json::Value { + let app = crate::build_api_router(store); + let resp = app + .oneshot( + Request::builder() + .uri("/lean/v0/node/syncing") + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(resp.status(), StatusCode::OK); + let body = resp.into_body().collect().await.unwrap().to_bytes(); + serde_json::from_slice(&body).unwrap() + } + + #[tokio::test] + async fn node_syncing_far_behind_wall_clock() { + // create_test_state() has genesis_time=1000 (year 1970), so wall_slot is huge. + // head_slot=0 → sync_distance is large → is_syncing=true. + let store = Store::from_anchor_state(Arc::new(InMemoryBackend::new()), create_test_state()); + let json = get_syncing_json(store).await; + assert_eq!(json["head_slot"], 0); + assert_eq!(json["finalized_slot"], 0); + assert!( + json["sync_distance"].as_u64().unwrap() > SYNC_LAG_THRESHOLD, + "expected large sync_distance, got {}", + json["sync_distance"] + ); + assert_eq!(json["is_syncing"], true); + } + + #[tokio::test] + async fn node_syncing_up_to_date() { + // Set genesis_time to far future so wall_slot=0 and head_slot=0 → not syncing. + let mut state = create_test_state(); + // Unix timestamp ~year 2100 (4102444800 seconds), well beyond any test run. + state.config = ChainConfig { + genesis_time: 4_102_444_800, + }; + let store = Store::from_anchor_state(Arc::new(InMemoryBackend::new()), state); + let json = get_syncing_json(store).await; + assert_eq!(json["head_slot"], 0); + assert_eq!(json["finalized_slot"], 0); + assert_eq!(json["sync_distance"], 0); + assert_eq!(json["is_syncing"], false); + } + + #[tokio::test] + async fn node_identity_reports_version() { + let store = Store::from_anchor_state(Arc::new(InMemoryBackend::new()), create_test_state()); + let app = crate::build_api_router(store); + let resp = app + .oneshot( + Request::builder() + .uri("/lean/v0/node/identity") + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(resp.status(), StatusCode::OK); + let body = resp.into_body().collect().await.unwrap().to_bytes(); + let json: serde_json::Value = serde_json::from_slice(&body).unwrap(); + assert!(json["version"].is_string()); + } +}