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
350 lines
14 KiB
Rust
350 lines
14 KiB
Rust
use clap::{App, Arg, SubCommand};
|
|
|
|
pub fn cli_app<'a, 'b>() -> App<'a, 'b> {
|
|
App::new("Beacon Node")
|
|
.visible_aliases(&["b", "bn", "beacon", "beacon_node"])
|
|
.version(crate_version!())
|
|
.author("Sigma Prime <contact@sigmaprime.io>")
|
|
.about("Eth 2.0 Client")
|
|
/*
|
|
* Configuration directory locations.
|
|
*/
|
|
.arg(
|
|
Arg::with_name("datadir")
|
|
.long("datadir")
|
|
.value_name("DIR")
|
|
.help("Data directory for keys and databases.")
|
|
.takes_value(true)
|
|
.global(true)
|
|
)
|
|
.arg(
|
|
Arg::with_name("network-dir")
|
|
.long("network-dir")
|
|
.value_name("DIR")
|
|
.help("Data directory for network keys.")
|
|
.takes_value(true)
|
|
.global(true)
|
|
)
|
|
/*
|
|
* Network parameters.
|
|
*/
|
|
.arg(
|
|
Arg::with_name("port-bump")
|
|
.long("port-bump")
|
|
.short("b")
|
|
.value_name("INCREMENT")
|
|
.help("Sets all listening TCP/UDP ports to default values, but with each port increased by \
|
|
INCREMENT. Useful when starting multiple nodes on a single machine. Using increments \
|
|
in multiples of 10 is recommended.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("listen-address")
|
|
.long("listen-address")
|
|
.value_name("ADDRESS")
|
|
.help("The address lighthouse will listen for UDP and TCP connections. (default 127.0.0.1).")
|
|
.takes_value(true)
|
|
)
|
|
.arg(
|
|
Arg::with_name("port")
|
|
.long("port")
|
|
.value_name("PORT")
|
|
.help("The TCP/UDP port to listen on. The UDP port can be modified by the --discovery-port flag.")
|
|
.conflicts_with("port-bump")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("maxpeers")
|
|
.long("maxpeers")
|
|
.help("The maximum number of peers (default 10).")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("boot-nodes")
|
|
.long("boot-nodes")
|
|
.allow_hyphen_values(true)
|
|
.value_name("ENR-LIST")
|
|
.help("One or more comma-delimited base64-encoded ENR's to bootstrap the p2p network.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("discovery-port")
|
|
.long("disc-port")
|
|
.value_name("PORT")
|
|
.help("The discovery UDP port.")
|
|
.conflicts_with("port-bump")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("discovery-address")
|
|
.long("discovery-address")
|
|
.value_name("ADDRESS")
|
|
.help("The IP address to broadcast to other peers on how to reach this node.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("topics")
|
|
.long("topics")
|
|
.value_name("STRING")
|
|
.help("One or more comma-delimited gossipsub topic strings to subscribe to.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("libp2p-addresses")
|
|
.long("libp2p-addresses")
|
|
.value_name("MULTIADDR")
|
|
.help("One or more comma-delimited multiaddrs to manually connect to a libp2p peer without an ENR.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("p2p-priv-key")
|
|
.long("p2p-priv-key")
|
|
.value_name("HEX")
|
|
.help("A secp256k1 secret key, represented as ASCII-encoded hex bytes (with or without 0x prefix).")
|
|
.takes_value(true),
|
|
)
|
|
/*
|
|
* gRPC parameters.
|
|
*/
|
|
.arg(
|
|
Arg::with_name("no-grpc")
|
|
.long("no-grpc")
|
|
.help("Disable the gRPC server.")
|
|
.takes_value(false),
|
|
)
|
|
.arg(
|
|
Arg::with_name("rpc-address")
|
|
.long("rpc-address")
|
|
.value_name("ADDRESS")
|
|
.help("Listen address for RPC endpoint.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("rpc-port")
|
|
.long("rpc-port")
|
|
.value_name("PORT")
|
|
.help("Listen port for RPC endpoint.")
|
|
.conflicts_with("port-bump")
|
|
.takes_value(true),
|
|
)
|
|
/* REST API related arguments */
|
|
.arg(
|
|
Arg::with_name("no-api")
|
|
.long("no-api")
|
|
.help("Disable RESTful HTTP API server.")
|
|
.takes_value(false),
|
|
)
|
|
.arg(
|
|
Arg::with_name("api-address")
|
|
.long("api-address")
|
|
.value_name("ADDRESS")
|
|
.help("Set the listen address for the RESTful HTTP API server.")
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("api-port")
|
|
.long("api-port")
|
|
.value_name("PORT")
|
|
.help("Set the listen TCP port for the RESTful HTTP API server.")
|
|
.conflicts_with("port-bump")
|
|
.takes_value(true),
|
|
)
|
|
/* Websocket related arguments */
|
|
.arg(
|
|
Arg::with_name("no-ws")
|
|
.long("no-ws")
|
|
.help("Disable websocket server.")
|
|
.takes_value(false),
|
|
)
|
|
.arg(
|
|
Arg::with_name("ws-address")
|
|
.long("ws-address")
|
|
.value_name("ADDRESS")
|
|
.help("Set the listen address for the websocket server.")
|
|
.conflicts_with_all(&["no-ws"])
|
|
.takes_value(true),
|
|
)
|
|
.arg(
|
|
Arg::with_name("ws-port")
|
|
.long("ws-port")
|
|
.value_name("PORT")
|
|
.help("Set the listen TCP port for the websocket server.")
|
|
.conflicts_with_all(&["no-ws", "port-bump"])
|
|
.takes_value(true),
|
|
)
|
|
|
|
/*
|
|
* Eth1 Integration
|
|
*/
|
|
.arg(
|
|
Arg::with_name("dummy-eth1")
|
|
.long("dummy-eth1")
|
|
.help("If present, uses an eth1 backend that generates static dummy data.\
|
|
Identical to the method used at the 2019 Canada interop.")
|
|
)
|
|
.arg(
|
|
Arg::with_name("eth1-endpoint")
|
|
.long("eth1-endpoint")
|
|
.value_name("HTTP-ENDPOINT")
|
|
.help("Specifies the server for a web3 connection to the Eth1 chain.")
|
|
.takes_value(true)
|
|
.default_value("http://localhost:8545")
|
|
)
|
|
.arg(
|
|
Arg::with_name("eth1-follow")
|
|
.long("eth1-follow")
|
|
.value_name("BLOCK_COUNT")
|
|
.help("Specifies how many blocks we should cache behind the eth1 head. A larger number means a smaller cache.")
|
|
.takes_value(true)
|
|
// TODO: set this higher once we're not using testnets all the time.
|
|
.default_value("0")
|
|
)
|
|
.arg(
|
|
Arg::with_name("deposit-contract")
|
|
.long("deposit-contract")
|
|
.short("e")
|
|
.value_name("DEPOSIT-CONTRACT")
|
|
.help("Specifies the deposit contract address on the Eth1 chain.")
|
|
.takes_value(true)
|
|
)
|
|
.arg(
|
|
Arg::with_name("deposit-contract-deploy")
|
|
.long("deposit-contract-deploy")
|
|
.value_name("BLOCK_NUMBER")
|
|
.help("Specifies the block number that the deposit contract was deployed at.")
|
|
.takes_value(true)
|
|
// TODO: set this higher once we're not using testnets all the time.
|
|
.default_value("0")
|
|
)
|
|
/*
|
|
* The "testnet" sub-command.
|
|
*
|
|
* Allows for creating a new datadir with testnet-specific configs.
|
|
*/
|
|
.subcommand(SubCommand::with_name("testnet")
|
|
.about("Create a new Lighthouse datadir using a testnet strategy.")
|
|
.arg(
|
|
Arg::with_name("eth2-config")
|
|
.long("eth2-config")
|
|
.value_name("TOML_FILE")
|
|
.help("A existing eth2_spec TOML file (e.g., eth2_spec.toml).")
|
|
.takes_value(true)
|
|
.conflicts_with("spec")
|
|
)
|
|
.arg(
|
|
Arg::with_name("client-config")
|
|
.long("client-config")
|
|
.value_name("TOML_FILE")
|
|
.help("An existing beacon_node TOML file (e.g., beacon_node.toml).")
|
|
.takes_value(true)
|
|
)
|
|
.arg(
|
|
Arg::with_name("random-datadir")
|
|
.long("random-datadir")
|
|
.short("r")
|
|
.help("If present, append a random string to the datadir path. Useful for fast development \
|
|
iteration.")
|
|
)
|
|
.arg(
|
|
Arg::with_name("force")
|
|
.long("force")
|
|
.short("f")
|
|
.help("If present, will create new config and database files and move the any existing to a \
|
|
backup directory.")
|
|
.conflicts_with("random-datadir")
|
|
)
|
|
.arg(
|
|
Arg::with_name("slot-time")
|
|
.long("slot-time")
|
|
.short("t")
|
|
.value_name("MILLISECONDS")
|
|
.help("Defines the slot time when creating a new testnet.")
|
|
)
|
|
/*
|
|
* `boostrap`
|
|
*
|
|
* Start a new node by downloading genesis and network info from another node via the
|
|
* HTTP API.
|
|
*/
|
|
.subcommand(SubCommand::with_name("bootstrap")
|
|
.about("Connects to the given HTTP server, downloads a genesis state and attempts to peer with it.")
|
|
.arg(Arg::with_name("server")
|
|
.value_name("HTTP_SERVER")
|
|
.required(true)
|
|
.default_value("http://localhost:5052")
|
|
.help("A HTTP server, with a http:// prefix"))
|
|
.arg(Arg::with_name("libp2p-port")
|
|
.short("p")
|
|
.long("port")
|
|
.value_name("TCP_PORT")
|
|
.help("A libp2p listen port used to peer with the bootstrap server. This flag is useful \
|
|
when port-fowarding is used: you may connect using a different port than \
|
|
the one the server is immediately listening on."))
|
|
)
|
|
/*
|
|
* `recent`
|
|
*
|
|
* Start a new node, with a specified number of validators with a genesis time in the last
|
|
* 30-minutes.
|
|
*/
|
|
.subcommand(SubCommand::with_name("recent")
|
|
.about("Creates a new genesis state where the genesis time was at the previous \
|
|
MINUTES boundary (e.g., when MINUTES == 30; 12:00, 12:30, 13:00, etc.)")
|
|
.arg(Arg::with_name("validator_count")
|
|
.value_name("VALIDATOR_COUNT")
|
|
.required(true)
|
|
.help("The number of validators in the genesis state"))
|
|
.arg(Arg::with_name("minutes")
|
|
.long("minutes")
|
|
.short("m")
|
|
.value_name("MINUTES")
|
|
.required(true)
|
|
.default_value("15")
|
|
.help("The maximum number of minutes that will have elapsed before genesis"))
|
|
)
|
|
/*
|
|
* `quick`
|
|
*
|
|
* Start a new node, specifying the number of validators and genesis time
|
|
*/
|
|
.subcommand(SubCommand::with_name("quick")
|
|
.about("Creates a new genesis state from the specified validator count and genesis time. \
|
|
Compatible with the `quick-start genesis` defined in the eth2.0-pm repo.")
|
|
.arg(Arg::with_name("validator_count")
|
|
.value_name("VALIDATOR_COUNT")
|
|
.required(true)
|
|
.help("The number of validators in the genesis state"))
|
|
.arg(Arg::with_name("genesis_time")
|
|
.value_name("UNIX_EPOCH_SECONDS")
|
|
.required(true)
|
|
.help("The genesis time for the given state."))
|
|
)
|
|
/*
|
|
* `yaml`
|
|
*
|
|
* Start a new node, using a genesis state loaded from a YAML file
|
|
*/
|
|
.subcommand(SubCommand::with_name("file")
|
|
.about("Creates a new datadir where the genesis state is read from file. May fail to parse \
|
|
a file that was generated to a different spec than that specified by --spec.")
|
|
.arg(Arg::with_name("format")
|
|
.value_name("FORMAT")
|
|
.required(true)
|
|
.possible_values(&["ssz"])
|
|
.help("The encoding of the state in the file."))
|
|
.arg(Arg::with_name("file")
|
|
.value_name("FILE")
|
|
.required(true)
|
|
.help("A file from which to read the state"))
|
|
)
|
|
/*
|
|
* `prysm`
|
|
*
|
|
* Connect to the Prysmatic Labs testnet.
|
|
*/
|
|
.subcommand(SubCommand::with_name("prysm")
|
|
.about("Connect to the Prysmatic Labs testnet on Goerli.")
|
|
)
|
|
)
|
|
}
|