From 7f7205a13155643c980983b25dec3fcf2a537b25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Wed, 24 Jun 2026 10:28:20 -0300 Subject: [PATCH 1/3] refactor(rpc): compose api router from per-feature route modules Split the monolithic lib.rs API router into focused modules: core.rs holds the finalized-state/finalized-block/justified-checkpoint handlers and shared response helpers; blocks.rs, fork_choice.rs, and admin.rs each expose pub(crate) routes() -> Router. build_api_router merges them with .with_state(store). No behavior change. --- crates/net/rpc/src/admin.rs | 17 +++++- crates/net/rpc/src/blocks.rs | 12 +++- crates/net/rpc/src/core.rs | 73 ++++++++++++++++++++++++ crates/net/rpc/src/fork_choice.rs | 19 ++++--- crates/net/rpc/src/lib.rs | 93 ++++--------------------------- 5 files changed, 118 insertions(+), 96 deletions(-) create mode 100644 crates/net/rpc/src/core.rs 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..2886cf16 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,14 @@ 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; pub mod test_driver; +pub(crate) use core::json_response; + #[derive(Debug, Clone)] pub struct RpcConfig { pub http_address: IpAddr, @@ -100,32 +96,16 @@ 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()) .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 +114,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 +194,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; From 0d06dfa1ac18fea58d5d9985e1ee8b1d95845097 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Wed, 24 Jun 2026 10:52:11 -0300 Subject: [PATCH 2/3] feat(rpc): add GET /lean/v0/blocks range query for backfill --- crates/net/rpc/src/blocks.rs | 78 +++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/crates/net/rpc/src/blocks.rs b/crates/net/rpc/src/blocks.rs index 8110b99b..ed823039 100644 --- a/crates/net/rpc/src/blocks.rs +++ b/crates/net/rpc/src/blocks.rs @@ -1,18 +1,22 @@ use axum::{ Router, - extract::{Path, State}, + extract::{Path, Query, State}, http::StatusCode, response::IntoResponse, routing::get, }; use ethlambda_storage::Store; use ethlambda_types::primitives::H256; +use serde::Deserialize; use serde_json::json; use crate::json_response; +const MAX_RANGE_COUNT: u64 = 1024; + pub(crate) fn routes() -> Router { Router::new() + .route("/lean/v0/blocks", get(get_blocks_by_range)) .route("/lean/v0/blocks/{block_id}", get(get_block)) .route("/lean/v0/blocks/{block_id}/header", get(get_block_header)) } @@ -89,6 +93,34 @@ fn resolve_slot(store: &Store, slot: u64) -> Result { Ok(*root) } +#[derive(Deserialize)] +pub(crate) struct BlockRangeParams { + start_slot: u64, + count: u64, +} + +/// `GET /lean/v0/blocks?start_slot=&count=` — returns canonical blocks in the given slot range. +/// +/// Returns a JSON array of blocks. Slots with no canonical block (zero root) are silently +/// skipped. `count` is capped at [`MAX_RANGE_COUNT`]. +pub(crate) async fn get_blocks_by_range( + Query(params): Query, + State(store): State, +) -> impl IntoResponse { + let count = params.count.min(MAX_RANGE_COUNT); + let head_state = store.head_state(); + let mut blocks = Vec::new(); + for slot in params.start_slot..params.start_slot.saturating_add(count) { + if let Some(root) = head_state.historical_block_hashes.get(slot as usize) + && !root.is_zero() + && let Some(block) = store.get_block(root) + { + blocks.push(block); + } + } + json_response(blocks) +} + #[derive(Debug)] enum BlockIdError { Invalid, @@ -106,3 +138,47 @@ impl IntoResponse for BlockIdError { response } } + +#[cfg(test)] +mod range_tests { + use crate::test_utils::{create_test_state, insert_block_raw, make_block}; + use axum::{ + body::Body, + http::{Request, StatusCode}, + }; + use ethlambda_storage::{Store, backend::InMemoryBackend}; + use ethlambda_types::{primitives::H256, state::JustifiedSlots}; + use http_body_util::BodyExt; + use std::sync::Arc; + use tower::ServiceExt; + + fn store_with_block_at_slot_1() -> Store { + let backend = Arc::new(InMemoryBackend::new()); + let target = make_block(1, H256::ZERO); + let root = insert_block_raw(backend.as_ref(), &target); + let mut anchor = create_test_state(); + anchor.slot = 2; + anchor.historical_block_hashes = vec![H256::ZERO, root].try_into().unwrap(); + anchor.justified_slots = JustifiedSlots::with_length(2).unwrap(); + Store::from_anchor_state(backend, anchor) + } + + #[tokio::test] + async fn blocks_range_returns_canonical_blocks() { + let app = crate::build_api_router(store_with_block_at_slot_1()); + let resp = app + .oneshot( + Request::builder() + .uri("/lean/v0/blocks?start_slot=1&count=2") + .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_eq!(json.as_array().unwrap().len(), 1); + assert_eq!(json[0]["slot"], 1); + } +} From 6b075b17ef028344c4d6bc80217eca9316b70ef7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Gr=C3=BCner?= <47506558+MegaRedHand@users.noreply.github.com> Date: Wed, 24 Jun 2026 15:38:45 -0300 Subject: [PATCH 3/3] fix(rpc): address review feedback on blocks range (JSON errors, warn on storage gap, tests) - Return JSON 400 (not Axum plain-text 422) for missing/non-numeric query params by accepting Result, QueryRejection> and converting manually. - Emit tracing::warn! when a non-zero root in historical_block_hashes has no corresponding block in the store, making storage gaps observable in logs. - Add three new range_tests: count clamped to MAX_RANGE_COUNT, missing params return JSON 400, and start_slot beyond history length returns empty array. --- crates/net/rpc/src/blocks.rs | 89 +++++++++++++++++++++++++++++++++--- 1 file changed, 83 insertions(+), 6 deletions(-) diff --git a/crates/net/rpc/src/blocks.rs b/crates/net/rpc/src/blocks.rs index ed823039..c6fe0760 100644 --- a/crates/net/rpc/src/blocks.rs +++ b/crates/net/rpc/src/blocks.rs @@ -1,5 +1,6 @@ use axum::{ Router, + extract::rejection::QueryRejection, extract::{Path, Query, State}, http::StatusCode, response::IntoResponse, @@ -104,18 +105,34 @@ pub(crate) struct BlockRangeParams { /// Returns a JSON array of blocks. Slots with no canonical block (zero root) are silently /// skipped. `count` is capped at [`MAX_RANGE_COUNT`]. pub(crate) async fn get_blocks_by_range( - Query(params): Query, + params: Result, QueryRejection>, State(store): State, ) -> impl IntoResponse { + let Query(params) = match params { + Ok(p) => p, + Err(err) => { + let mut response = + json_response(json!({ "error": format!("invalid query parameters: {err}") })); + *response.status_mut() = StatusCode::BAD_REQUEST; + return response; + } + }; + let count = params.count.min(MAX_RANGE_COUNT); let head_state = store.head_state(); let mut blocks = Vec::new(); for slot in params.start_slot..params.start_slot.saturating_add(count) { - if let Some(root) = head_state.historical_block_hashes.get(slot as usize) - && !root.is_zero() - && let Some(block) = store.get_block(root) - { - blocks.push(block); + let Some(root) = head_state.historical_block_hashes.get(slot as usize) else { + break; + }; + if root.is_zero() { + continue; + } + match store.get_block(root) { + Some(block) => blocks.push(block), + None => { + tracing::warn!(%slot, %root, "block referenced by historical_block_hashes is missing from store"); + } } } json_response(blocks) @@ -181,4 +198,64 @@ mod range_tests { assert_eq!(json.as_array().unwrap().len(), 1); assert_eq!(json[0]["slot"], 1); } + + /// `count` larger than MAX_RANGE_COUNT is silently clamped to 1024. + #[tokio::test] + async fn blocks_range_clamps_count_to_max() { + let app = crate::build_api_router(store_with_block_at_slot_1()); + // count=9999 >> MAX_RANGE_COUNT=1024; only one block exists at slot 1 + let resp = app + .oneshot( + Request::builder() + .uri("/lean/v0/blocks?start_slot=0&count=9999") + .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(); + // Clamped to 1024 slots starting at 0; only slot 1 has a block. + assert_eq!(json.as_array().unwrap().len(), 1); + } + + /// Missing or non-numeric query params return JSON 400. + #[tokio::test] + async fn blocks_range_missing_params_returns_json_400() { + let app = crate::build_api_router(store_with_block_at_slot_1()); + let resp = app + .oneshot( + Request::builder() + .uri("/lean/v0/blocks?start_slot=&count=") + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(resp.status(), StatusCode::BAD_REQUEST); + let body = resp.into_body().collect().await.unwrap().to_bytes(); + let json: serde_json::Value = serde_json::from_slice(&body).unwrap(); + assert!(json["error"].is_string(), "expected JSON error field"); + } + + /// `start_slot` beyond the length of `historical_block_hashes` returns an empty array. + #[tokio::test] + async fn blocks_range_start_slot_beyond_history_returns_empty() { + let app = crate::build_api_router(store_with_block_at_slot_1()); + // historical_block_hashes has length 2 (slots 0-1); slot 999 is out of range. + let resp = app + .oneshot( + Request::builder() + .uri("/lean/v0/blocks?start_slot=999&count=10") + .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_eq!(json.as_array().unwrap().len(), 0); + } }