mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-16 03:12:41 +00:00
f229bbba1c
* Refactor to cache Eth1Data * Fix merge conflicts and minor refactorings * Rename Eth1Cache to Eth1DataCache * Refactor events subscription * Add deposits module to interface with BeaconChain deposits * Remove utils * Rename to types.rs and add trait constraints to Eth1DataFetcher * Confirm to trait constraints. Make Web3DataFetcher cloneable * Make fetcher object member of deposit and eth1_data cache and other fixes * Fix update_cache function * Move fetch_eth1_data to impl block * Fix deposit tests * Create Eth1 object for interfacing with Beacon chain * Add `run` function for running update_cache and subscribe_deposit_logs tasks * Add logging * Run `cargo fmt` and make tests pass * Convert sync functions to async * Add timeouts to web3 functions * Return futures from cache functions * Add failed chaining of futures * Working cache updation * Clean up tests and `update_cache` function * Refactor `get_eth1_data` functions to work with future returning functions * Refactor eth1 `run` function to work with modified `update_cache` api * Minor changes * Add distance parameter to `update_cache` * Fix tests and other minor fixes * Working integration with cache and deposits * Add merkle_tree construction, proof generation and verification code * Add function to construct and fetch Deposits for BeaconNode * Add error handling * Import ssz * Add error handling to eth1 cache and fix minor errors * Run rustfmt * Fix minor bug * Rename Eth1Error and change to Result<T> * Change deposit fetching mechanism from notification based to poll based * Add deposits from eth1 chain in a given range every `x` blocks * Modify `run` function to accommodate changes * Minor fixes * Fix formatting * Initial commit. web3 api working. * Tidied up lib. Add function for fetching logs. * Refactor with `Eth1DataFetcher` trait * Add parsing for deposit contract logs and get_eth1_data function * Add `get_eth1_votes` function * Refactor to cache Eth1Data * Fix merge conflicts and minor refactorings * Rename Eth1Cache to Eth1DataCache * Refactor events subscription * Add deposits module to interface with BeaconChain deposits * Remove utils * Rename to types.rs and add trait constraints to Eth1DataFetcher * Confirm to trait constraints. Make Web3DataFetcher cloneable * Make fetcher object member of deposit and eth1_data cache and other fixes * Fix update_cache function * Move fetch_eth1_data to impl block * Fix deposit tests * Create Eth1 object for interfacing with Beacon chain * Add `run` function for running update_cache and subscribe_deposit_logs tasks * Add logging * Run `cargo fmt` and make tests pass * Convert sync functions to async * Add timeouts to web3 functions * Return futures from cache functions * Add failed chaining of futures * Working cache updation * Clean up tests and `update_cache` function * Refactor `get_eth1_data` functions to work with future returning functions * Refactor eth1 `run` function to work with modified `update_cache` api * Minor changes * Add distance parameter to `update_cache` * Fix tests and other minor fixes * Working integration with cache and deposits * Add merkle_tree construction, proof generation and verification code * Add function to construct and fetch Deposits for BeaconNode * Add error handling * Import ssz * Add error handling to eth1 cache and fix minor errors * Run rustfmt * Fix minor bug * Rename Eth1Error and change to Result<T> * Change deposit fetching mechanism from notification based to poll based * Add deposits from eth1 chain in a given range every `x` blocks * Modify `run` function to accommodate changes * Minor fixes * Fix formatting * Fix merge issue * Refactor with `Config` struct. Remote `ContractConfig` * Rename eth1_chain crate to eth1 * Rename files and read abi file using `fs::read` * Move eth1 to lib * Remove unnecessary mutability constraint * Add `Web3Backend` for returning actual eth1 data * Refactor `get_eth1_votes` to return a Result * Delete `eth1_chain` crate * Return `Result` from `get_deposits` * Fix range of deposits to return to beacon chain * Add `get_block_height_by_hash` trait function * Add naive method for getting `previous_eth1_distance` * Add eth1 config params to main config * Add instructions for setting up eth1 testing environment * Add build script to fetch deposit contract abi * Contract ABI is part of compiled binary * Fix minor bugs * Move docs to lib * Add timeout to config * Remove print statements * Change warn to error * Fix typos * Removed prints in test and get timeout value from config * Fixed error types * Added logging to web3_fetcher * Refactor for modified web3 api * Fix minor stuff * Add build script * Tidy, hide eth1 integration tests behind flag * Add http crate * Add first stages of eth1_test_rig * Fix deposits on test rig * Fix bug with deposit count method * Add block hash getter to http eth1 * Clean eth1 http crate and tests * Add script to start ganache * Adds deposit tree to eth1-http * Extend deposit tree tests * Tidy tests in eth1-http * Add more detail to get block request * Add block cache to eth1-http * Rename deposit tree to deposit cache * Add inital updating to eth1-http * Tidy updater * Fix compile bugs in tests * Adds an Eth1DataCache builder * Reorg eth1-http files * Add (failing) tests for eth1 updater * Rename files, fix bug in eth1-http * Ensure that ganache timestamps are increasing * Fix bugs with getting eth1data ancestors * Improve eth1 testing, fix bugs * Add truncate method to block cache * Add pruning to block cache update process * Add tests for block pruning * Allow for dropping an expired cache. * Add more comments * Add first compiling version of deposit updater * Add common fn for getting range of required blocks * Add passing deposit update test * Improve tests * Fix block pruning bug * Add tests for running two updates at once * Add updater services to eth1 * Add deposit collection to beacon chain * Add incomplete builder experiments * Add first working version of beacon chain builder * Update test harness to new beacon chain type * Rename builder file, tidy * Add first working client builder * Progress further on client builder * Update becaon node binary to use client builder * Ensure release tests compile * Remove old eth1 crate * Add first pass of new lighthouse binary * Fix websocket server startup * Remove old binary code from beacon_node crate * Add first working beacon node tests * Add genesis crate, new eth1 cache_2 * Add Serivce to Eth1Cache * Refactor with general eth1 improvements * Add passing genesis test * Tidy, add comments * Add more comments to eth1 service * Add further eth1 progress * Fix some bugs with genesis * Fix eth1 bugs, make eth1 linking more efficient * Shift logic in genesis service * Add more comments to genesis service * Add gzip, max request values, timeouts to http * Update testnet parameters to suit goerli testnet * Add ability to vary Fork, fix custom spec * Be more explicit about deposit fork version * Start adding beacon chain eth1 option * Add more flexibility to prod client * Further runtime refactoring * Allow for starting from store * Add bootstrapping to client config * Add remote_beacon_node crate * Update eth1 service for more configurability * Update eth1 tests to use less runtimes * Patch issues with tests using too many files * Move dummy eth1 backend flag * Ensure all tests pass * Add ganache-cli to Dockerfile * Use a special docker hub image for testing * Appease clippy * Move validator client into lighthouse binary * Allow starting with dummy eth1 backend * Improve logging * Fix dummy eth1 backend from cli * Add extra testnet command * Ensure consistent spec in beacon node * Update eth1 rig to work on goerli * Tidy lcli, start adding support for yaml config * Add incomplete YamlConfig struct * Remove efforts at YamlConfig * Add incomplete eth1 voting. Blocked on spec issues * Add (untested) first pass at eth1 vote algo * Add tests for winning vote * Add more tests for eth1 chain * Add more eth1 voting tests * Added more eth1 voting testing * Change test name * Add more tests to eth1 chain * Tidy eth1 generics, add more tests * Improve comments * Tidy beacon_node tests * Tidy, rename JsonRpc.. to Caching.. * Tidy voting logic * Tidy builder docs * Add comments, tidy eth1 * Add more comments to eth1 * Fix bug with winning_vote * Add doc comments to the `ClientBuilder` * Remove commented-out code * Improve `ClientBuilder` docs * Add comments to client config * Add decoding test for `ClientConfig` * Remove unused `DepositSet` struct * Tidy `block_cache` * Remove commented out lines * Remove unused code in `eth1` crate * Remove old validator binary `main.rs` * Tidy, fix tests compile error * Add initial tests for get_deposits * Remove dead code in eth1_test_rig * Update TestingDepositBuilder * Add testing for getting eth1 deposits * Fix duplicate rand dep * Remove dead code * Remove accidentally-added files * Fix comment in eth1_genesis_service * Add .gitignore for eth1_test_rig * Fix bug in eth1_genesis_service * Remove dead code from eth2_config * Fix tabs/spaces in root Cargo.toml * Tidy eth1 crate * Allow for re-use of eth1 service after genesis * Update docs for new CLI * Change README gif * Tidy eth1 http module * Tidy eth1 service * Tidy environment crate * Remove unused file * Tidy, add comments * Remove commented-out code * Address majority of Michael's comments * Address other PR comments * Add link to issue alongside TODO
274 lines
9.8 KiB
Rust
274 lines
9.8 KiB
Rust
#[macro_use]
|
|
mod macros;
|
|
#[macro_use]
|
|
extern crate lazy_static;
|
|
extern crate network as client_network;
|
|
|
|
mod beacon;
|
|
mod config;
|
|
mod error;
|
|
mod helpers;
|
|
mod metrics;
|
|
mod network;
|
|
mod node;
|
|
mod response_builder;
|
|
mod spec;
|
|
mod url_query;
|
|
mod validator;
|
|
|
|
use beacon_chain::{BeaconChain, BeaconChainTypes};
|
|
use client_network::NetworkMessage;
|
|
use client_network::Service as NetworkService;
|
|
use error::{ApiError, ApiResult};
|
|
use eth2_config::Eth2Config;
|
|
use futures::future::IntoFuture;
|
|
use hyper::rt::Future;
|
|
use hyper::service::Service;
|
|
use hyper::{Body, Method, Request, Response, Server};
|
|
use parking_lot::RwLock;
|
|
use slog::{info, warn};
|
|
use std::net::SocketAddr;
|
|
use std::ops::Deref;
|
|
use std::path::PathBuf;
|
|
use std::sync::Arc;
|
|
use tokio::runtime::TaskExecutor;
|
|
use tokio::sync::mpsc;
|
|
use url_query::UrlQuery;
|
|
|
|
pub use beacon::{BlockResponse, HeadResponse, StateResponse};
|
|
pub use config::Config;
|
|
|
|
type BoxFut = Box<dyn Future<Item = Response<Body>, Error = ApiError> + Send>;
|
|
|
|
pub struct ApiService<T: BeaconChainTypes + 'static> {
|
|
log: slog::Logger,
|
|
beacon_chain: Arc<BeaconChain<T>>,
|
|
db_path: DBPath,
|
|
network_service: Arc<NetworkService<T>>,
|
|
network_channel: Arc<RwLock<mpsc::UnboundedSender<NetworkMessage>>>,
|
|
eth2_config: Arc<Eth2Config>,
|
|
}
|
|
|
|
pub struct NetworkInfo<T: BeaconChainTypes> {
|
|
pub network_service: Arc<NetworkService<T>>,
|
|
pub network_chan: mpsc::UnboundedSender<NetworkMessage>,
|
|
}
|
|
|
|
fn into_boxfut<F: IntoFuture + 'static>(item: F) -> BoxFut
|
|
where
|
|
F: IntoFuture<Item = Response<Body>, Error = ApiError>,
|
|
F::Future: Send,
|
|
{
|
|
Box::new(item.into_future())
|
|
}
|
|
|
|
impl<T: BeaconChainTypes> Service for ApiService<T> {
|
|
type ReqBody = Body;
|
|
type ResBody = Body;
|
|
type Error = ApiError;
|
|
type Future = BoxFut;
|
|
|
|
fn call(&mut self, mut req: Request<Body>) -> Self::Future {
|
|
metrics::inc_counter(&metrics::REQUEST_COUNT);
|
|
let timer = metrics::start_timer(&metrics::REQUEST_RESPONSE_TIME);
|
|
|
|
// Add all the useful bits into the request, so that we can pull them out in the individual
|
|
// functions.
|
|
req.extensions_mut()
|
|
.insert::<slog::Logger>(self.log.clone());
|
|
req.extensions_mut()
|
|
.insert::<Arc<BeaconChain<T>>>(self.beacon_chain.clone());
|
|
req.extensions_mut().insert::<DBPath>(self.db_path.clone());
|
|
req.extensions_mut()
|
|
.insert::<Arc<NetworkService<T>>>(self.network_service.clone());
|
|
req.extensions_mut()
|
|
.insert::<Arc<RwLock<mpsc::UnboundedSender<NetworkMessage>>>>(
|
|
self.network_channel.clone(),
|
|
);
|
|
req.extensions_mut()
|
|
.insert::<Arc<Eth2Config>>(self.eth2_config.clone());
|
|
|
|
let path = req.uri().path().to_string();
|
|
|
|
// Route the request to the correct handler.
|
|
let result = match (req.method(), path.as_ref()) {
|
|
// Methods for Client
|
|
(&Method::GET, "/node/version") => into_boxfut(node::get_version(req)),
|
|
(&Method::GET, "/node/genesis_time") => into_boxfut(node::get_genesis_time::<T>(req)),
|
|
(&Method::GET, "/node/syncing") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
|
|
// Methods for Network
|
|
(&Method::GET, "/network/enr") => into_boxfut(network::get_enr::<T>(req)),
|
|
(&Method::GET, "/network/peer_count") => into_boxfut(network::get_peer_count::<T>(req)),
|
|
(&Method::GET, "/network/peer_id") => into_boxfut(network::get_peer_id::<T>(req)),
|
|
(&Method::GET, "/network/peers") => into_boxfut(network::get_peer_list::<T>(req)),
|
|
(&Method::GET, "/network/listen_port") => {
|
|
into_boxfut(network::get_listen_port::<T>(req))
|
|
}
|
|
(&Method::GET, "/network/listen_addresses") => {
|
|
into_boxfut(network::get_listen_addresses::<T>(req))
|
|
}
|
|
|
|
// Methods for Beacon Node
|
|
(&Method::GET, "/beacon/head") => into_boxfut(beacon::get_head::<T>(req)),
|
|
(&Method::GET, "/beacon/block") => into_boxfut(beacon::get_block::<T>(req)),
|
|
(&Method::GET, "/beacon/block_root") => into_boxfut(beacon::get_block_root::<T>(req)),
|
|
(&Method::GET, "/beacon/blocks") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
(&Method::GET, "/beacon/fork") => into_boxfut(beacon::get_fork::<T>(req)),
|
|
(&Method::GET, "/beacon/attestations") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
(&Method::GET, "/beacon/attestations/pending") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
|
|
(&Method::GET, "/beacon/validators") => into_boxfut(beacon::get_validators::<T>(req)),
|
|
(&Method::GET, "/beacon/validators/indicies") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
(&Method::GET, "/beacon/validators/pubkeys") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
|
|
// Methods for Validator
|
|
(&Method::GET, "/beacon/validator/duties") => {
|
|
into_boxfut(validator::get_validator_duties::<T>(req))
|
|
}
|
|
(&Method::GET, "/beacon/validator/block") => {
|
|
into_boxfut(validator::get_new_beacon_block::<T>(req))
|
|
}
|
|
(&Method::POST, "/beacon/validator/block") => validator::publish_beacon_block::<T>(req),
|
|
(&Method::GET, "/beacon/validator/attestation") => {
|
|
into_boxfut(validator::get_new_attestation::<T>(req))
|
|
}
|
|
(&Method::POST, "/beacon/validator/attestation") => {
|
|
validator::publish_attestation::<T>(req)
|
|
}
|
|
|
|
(&Method::GET, "/beacon/state") => into_boxfut(beacon::get_state::<T>(req)),
|
|
(&Method::GET, "/beacon/state_root") => into_boxfut(beacon::get_state_root::<T>(req)),
|
|
(&Method::GET, "/beacon/state/current_finalized_checkpoint") => {
|
|
into_boxfut(beacon::get_current_finalized_checkpoint::<T>(req))
|
|
}
|
|
(&Method::GET, "/beacon/state/genesis") => {
|
|
into_boxfut(beacon::get_genesis_state::<T>(req))
|
|
}
|
|
//TODO: Add aggreggate/filtered state lookups here, e.g. /beacon/validators/balances
|
|
|
|
// Methods for bootstrap and checking configuration
|
|
(&Method::GET, "/spec") => into_boxfut(spec::get_spec::<T>(req)),
|
|
(&Method::GET, "/spec/slots_per_epoch") => {
|
|
into_boxfut(spec::get_slots_per_epoch::<T>(req))
|
|
}
|
|
(&Method::GET, "/spec/deposit_contract") => {
|
|
into_boxfut(helpers::implementation_pending_response(req))
|
|
}
|
|
(&Method::GET, "/spec/eth2_config") => into_boxfut(spec::get_eth2_config::<T>(req)),
|
|
|
|
(&Method::GET, "/metrics") => into_boxfut(metrics::get_prometheus::<T>(req)),
|
|
|
|
_ => Box::new(futures::future::err(ApiError::NotFound(
|
|
"Request path and/or method not found.".to_owned(),
|
|
))),
|
|
};
|
|
|
|
let response = match result.wait() {
|
|
// Return the `hyper::Response`.
|
|
Ok(response) => {
|
|
metrics::inc_counter(&metrics::SUCCESS_COUNT);
|
|
slog::debug!(self.log, "Request successful: {:?}", path);
|
|
response
|
|
}
|
|
// Map the `ApiError` into `hyper::Response`.
|
|
Err(e) => {
|
|
slog::debug!(self.log, "Request failure: {:?}", path);
|
|
e.into()
|
|
}
|
|
};
|
|
|
|
metrics::stop_timer(timer);
|
|
|
|
Box::new(futures::future::ok(response))
|
|
}
|
|
}
|
|
|
|
pub fn start_server<T: BeaconChainTypes>(
|
|
config: &Config,
|
|
executor: &TaskExecutor,
|
|
beacon_chain: Arc<BeaconChain<T>>,
|
|
network_info: NetworkInfo<T>,
|
|
db_path: PathBuf,
|
|
eth2_config: Eth2Config,
|
|
log: slog::Logger,
|
|
) -> Result<(exit_future::Signal, SocketAddr), hyper::Error> {
|
|
// build a channel to kill the HTTP server
|
|
let (exit_signal, exit) = exit_future::signal();
|
|
|
|
let exit_log = log.clone();
|
|
let server_exit = exit.and_then(move |_| {
|
|
info!(exit_log, "API service shutdown");
|
|
Ok(())
|
|
});
|
|
|
|
let db_path = DBPath(db_path);
|
|
|
|
// Get the address to bind to
|
|
let bind_addr = (config.listen_address, config.port).into();
|
|
|
|
// Clone our stateful objects, for use in service closure.
|
|
let server_log = log.clone();
|
|
let server_bc = beacon_chain.clone();
|
|
let eth2_config = Arc::new(eth2_config);
|
|
|
|
let service = move || -> futures::future::FutureResult<ApiService<T>, String> {
|
|
futures::future::ok(ApiService {
|
|
log: server_log.clone(),
|
|
beacon_chain: server_bc.clone(),
|
|
db_path: db_path.clone(),
|
|
network_service: network_info.network_service.clone(),
|
|
network_channel: Arc::new(RwLock::new(network_info.network_chan.clone())),
|
|
eth2_config: eth2_config.clone(),
|
|
})
|
|
};
|
|
|
|
let log_clone = log.clone();
|
|
let server = Server::bind(&bind_addr).serve(service);
|
|
|
|
let actual_listen_addr = server.local_addr();
|
|
|
|
let server_future = server
|
|
.with_graceful_shutdown(server_exit)
|
|
.map_err(move |e| {
|
|
warn!(
|
|
log_clone,
|
|
"API failed to start, Unable to bind"; "address" => format!("{:?}", e)
|
|
)
|
|
});
|
|
|
|
info!(
|
|
log,
|
|
"REST API started";
|
|
"address" => format!("{}", actual_listen_addr.ip()),
|
|
"port" => actual_listen_addr.port(),
|
|
);
|
|
|
|
executor.spawn(server_future);
|
|
|
|
Ok((exit_signal, actual_listen_addr))
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
pub struct DBPath(PathBuf);
|
|
|
|
impl Deref for DBPath {
|
|
type Target = PathBuf;
|
|
|
|
fn deref(&self) -> &Self::Target {
|
|
&self.0
|
|
}
|
|
}
|