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
142 lines
4.2 KiB
Rust
142 lines
4.2 KiB
Rust
//! Provides a `RemoteBeaconNode` which interacts with a HTTP API on another Lighthouse (or
|
|
//! compatible) instance.
|
|
//!
|
|
//! Presently, this is only used for testing but it _could_ become a user-facing library.
|
|
|
|
use futures::{Future, IntoFuture};
|
|
use reqwest::r#async::{Client, RequestBuilder};
|
|
use serde::Deserialize;
|
|
use std::marker::PhantomData;
|
|
use std::net::SocketAddr;
|
|
use types::{BeaconBlock, BeaconState, EthSpec};
|
|
use types::{Hash256, Slot};
|
|
use url::Url;
|
|
|
|
/// Connects to a remote Lighthouse (or compatible) node via HTTP.
|
|
pub struct RemoteBeaconNode<E: EthSpec> {
|
|
pub http: HttpClient<E>,
|
|
}
|
|
|
|
impl<E: EthSpec> RemoteBeaconNode<E> {
|
|
pub fn new(http_endpoint: SocketAddr) -> Result<Self, String> {
|
|
Ok(Self {
|
|
http: HttpClient::new(format!("http://{}", http_endpoint.to_string()))
|
|
.map_err(|e| format!("Unable to create http client: {:?}", e))?,
|
|
})
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub enum Error {
|
|
UrlParseError(url::ParseError),
|
|
ReqwestError(reqwest::Error),
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
pub struct HttpClient<E> {
|
|
client: Client,
|
|
url: Url,
|
|
_phantom: PhantomData<E>,
|
|
}
|
|
|
|
impl<E: EthSpec> HttpClient<E> {
|
|
/// Creates a new instance (without connecting to the node).
|
|
pub fn new(server_url: String) -> Result<Self, Error> {
|
|
Ok(Self {
|
|
client: Client::new(),
|
|
url: Url::parse(&server_url)?,
|
|
_phantom: PhantomData,
|
|
})
|
|
}
|
|
|
|
pub fn beacon(&self) -> Beacon<E> {
|
|
Beacon(self.clone())
|
|
}
|
|
|
|
fn url(&self, path: &str) -> Result<Url, Error> {
|
|
self.url.join(path).map_err(|e| e.into())
|
|
}
|
|
|
|
pub fn get(&self, path: &str) -> Result<RequestBuilder, Error> {
|
|
self.url(path)
|
|
.map(|url| Client::new().get(&url.to_string()))
|
|
}
|
|
}
|
|
|
|
/// Provides the functions on the `/beacon` endpoint of the node.
|
|
#[derive(Clone)]
|
|
pub struct Beacon<E>(HttpClient<E>);
|
|
|
|
impl<E: EthSpec> Beacon<E> {
|
|
fn url(&self, path: &str) -> Result<Url, Error> {
|
|
self.0
|
|
.url("beacon/")
|
|
.and_then(move |url| url.join(path).map_err(Error::from))
|
|
.map_err(Into::into)
|
|
}
|
|
|
|
/// Returns the block and block root at the given slot.
|
|
pub fn block_at_slot(
|
|
&self,
|
|
slot: Slot,
|
|
) -> impl Future<Item = (BeaconBlock<E>, Hash256), Error = Error> {
|
|
let client = self.0.clone();
|
|
self.url("block")
|
|
.into_future()
|
|
.and_then(move |mut url| {
|
|
url.query_pairs_mut()
|
|
.append_pair("slot", &format!("{}", slot.as_u64()));
|
|
client.get(&url.to_string())
|
|
})
|
|
.and_then(|builder| builder.send().map_err(Error::from))
|
|
.and_then(|response| response.error_for_status().map_err(Error::from))
|
|
.and_then(|mut success| success.json::<BlockResponse<E>>().map_err(Error::from))
|
|
.map(|response| (response.beacon_block, response.root))
|
|
}
|
|
|
|
/// Returns the state and state root at the given slot.
|
|
pub fn state_at_slot(
|
|
&self,
|
|
slot: Slot,
|
|
) -> impl Future<Item = (BeaconState<E>, Hash256), Error = Error> {
|
|
let client = self.0.clone();
|
|
self.url("state")
|
|
.into_future()
|
|
.and_then(move |mut url| {
|
|
url.query_pairs_mut()
|
|
.append_pair("slot", &format!("{}", slot.as_u64()));
|
|
client.get(&url.to_string())
|
|
})
|
|
.and_then(|builder| builder.send().map_err(Error::from))
|
|
.and_then(|response| response.error_for_status().map_err(Error::from))
|
|
.and_then(|mut success| success.json::<StateResponse<E>>().map_err(Error::from))
|
|
.map(|response| (response.beacon_state, response.root))
|
|
}
|
|
}
|
|
|
|
#[derive(Deserialize)]
|
|
#[serde(bound = "T: EthSpec")]
|
|
pub struct BlockResponse<T: EthSpec> {
|
|
pub beacon_block: BeaconBlock<T>,
|
|
pub root: Hash256,
|
|
}
|
|
|
|
#[derive(Deserialize)]
|
|
#[serde(bound = "T: EthSpec")]
|
|
pub struct StateResponse<T: EthSpec> {
|
|
pub beacon_state: BeaconState<T>,
|
|
pub root: Hash256,
|
|
}
|
|
|
|
impl From<reqwest::Error> for Error {
|
|
fn from(e: reqwest::Error) -> Error {
|
|
Error::ReqwestError(e)
|
|
}
|
|
}
|
|
|
|
impl From<url::ParseError> for Error {
|
|
fn from(e: url::ParseError) -> Error {
|
|
Error::UrlParseError(e)
|
|
}
|
|
}
|