Changes to rest_api (#480)

* Add half-finished rest api changes * Add basic, messy changes to rest api * Fix expect() in ApiRequest * Remove ApiRequest, add route for beacon state * Tidy rest api, add get state from root * Add api method for getting state roots by slot * Add test for URL helper * Simplify state_at_slot fn * Add tests for rest api helper fns * Add extra tests for parse root * Fix clippy lints * Fix compile error in rest api * Update test to new ethereum-types
2026-03-20 21:34:46 +00:00 · 2019-08-10 17:15:15 +10:00
parent 468015f9bb
commit 989e2727d7
12 changed files with 451 additions and 153 deletions
--- a/beacon_node/rest_api/src/beacon.rs
+++ b/beacon_node/rest_api/src/beacon.rs
@@ -0,0 +1,60 @@
+use super::{success_response, ApiResult};
+use crate::{helpers::*, ApiError, UrlQuery};
+use beacon_chain::{BeaconChain, BeaconChainTypes};
+use hyper::{Body, Request};
+use std::sync::Arc;
+use store::Store;
+use types::BeaconState;
+
+/// HTTP handler to return a `BeaconState` at a given `root` or `slot`.
+///
+/// Will not return a state if the request slot is in the future. Will return states higher than
+/// the current head by skipping slots.
+pub fn get_state<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult {
+    let beacon_chain = req
+        .extensions()
+        .get::<Arc<BeaconChain<T>>>()
+        .ok_or_else(|| ApiError::ServerError("Beacon chain extension missing".to_string()))?;
+
+    let query_params = ["root", "slot"];
+    let (key, value) = UrlQuery::from_request(&req)?.first_of(&query_params)?;
+
+    let state: BeaconState<T::EthSpec> = match (key.as_ref(), value) {
+        ("slot", value) => state_at_slot(&beacon_chain, parse_slot(&value)?)?,
+        ("root", value) => {
+            let root = &parse_root(&value)?;
+
+            beacon_chain
+                .store
+                .get(root)?
+                .ok_or_else(|| ApiError::NotFound(format!("No state for root: {}", root)))?
+        }
+        _ => unreachable!("Guarded by UrlQuery::from_request()"),
+    };
+
+    let json: String = serde_json::to_string(&state)
+        .map_err(|e| ApiError::ServerError(format!("Unable to serialize BeaconState: {:?}", e)))?;
+
+    Ok(success_response(Body::from(json)))
+}
+
+/// HTTP handler to return a `BeaconState` root at a given or `slot`.
+///
+/// Will not return a state if the request slot is in the future. Will return states higher than
+/// the current head by skipping slots.
+pub fn get_state_root<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult {
+    let beacon_chain = req
+        .extensions()
+        .get::<Arc<BeaconChain<T>>>()
+        .ok_or_else(|| ApiError::ServerError("Beacon chain extension missing".to_string()))?;
+
+    let slot_string = UrlQuery::from_request(&req)?.only_one("slot")?;
+    let slot = parse_slot(&slot_string)?;
+
+    let root = state_root_at_slot(&beacon_chain, slot)?;
+
+    let json: String = serde_json::to_string(&root)
+        .map_err(|e| ApiError::ServerError(format!("Unable to serialize root: {:?}", e)))?;
+
+    Ok(success_response(Body::from(json)))
+}