mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-03 00:31:50 +00:00
## Issue Addressed
NA
## Proposed Changes
- Introduces the `valdiator_definitions.yml` file which serves as an explicit list of validators that should be run by the validator client.
- Removes `--strict` flag, split into `--strict-lockfiles` and `--disable-auto-discover`
- Adds a "Validator Management" page to the book.
- Adds the `common/account_utils` crate which contains some logic that was starting to duplicate across the codebase.
The new docs for this feature are the best description of it (apart from the code, I guess): 9cb87e93ce/book/src/validator-management.md
## API Changes
This change should be transparent for *most* existing users. If the `valdiator_definitions.yml` doesn't exist then it will be automatically generated using a method that will detect all the validators in their `validators_dir`.
Users will have issues if they are:
1. Using `--strict`.
1. Have keystores in their `~/.lighthouse/validators` directory that weren't being detected by the current keystore discovery method.
For users with (1), the VC will refuse to start because the `--strict` flag has been removed. They will be forced to review `--help` and choose an equivalent flag.
For users with (2), this seems fairly unlikely and since we're only in testnets there's no *real* value on the line here. I'm happy to take the risk, it would be a different case for mainnet.
## Additional Info
This PR adds functionality we will need for #1347.
## TODO
- [x] Reconsider flags
- [x] Move doc into a more reasonable chapter.
- [x] Check for compile warnings.
170 lines
5.8 KiB
Rust
170 lines
5.8 KiB
Rust
use crate::{checks, LocalNetwork};
|
|
use clap::ArgMatches;
|
|
use futures::prelude::*;
|
|
use node_test_rig::{
|
|
environment::EnvironmentBuilder, testing_client_config, ClientGenesis, ValidatorConfig,
|
|
ValidatorFiles,
|
|
};
|
|
use rayon::prelude::*;
|
|
use std::net::{IpAddr, Ipv4Addr};
|
|
use std::time::{Duration, SystemTime, UNIX_EPOCH};
|
|
use tokio::time::{delay_until, Instant};
|
|
use types::{Epoch, EthSpec, MainnetEthSpec};
|
|
|
|
pub fn run_no_eth1_sim(matches: &ArgMatches) -> Result<(), String> {
|
|
let node_count = value_t!(matches, "nodes", usize).expect("missing nodes default");
|
|
let validators_per_node = value_t!(matches, "validators_per_node", usize)
|
|
.expect("missing validators_per_node default");
|
|
let speed_up_factor =
|
|
value_t!(matches, "speed_up_factor", u64).expect("missing speed_up_factor default");
|
|
let mut end_after_checks = true;
|
|
if matches.is_present("end_after_checks") {
|
|
end_after_checks = false;
|
|
}
|
|
|
|
println!("Beacon Chain Simulator:");
|
|
println!(" nodes:{}", node_count);
|
|
println!(" validators_per_node:{}", validators_per_node);
|
|
println!(" end_after_checks:{}", end_after_checks);
|
|
|
|
// Generate the directories and keystores required for the validator clients.
|
|
let validator_files = (0..node_count)
|
|
.into_par_iter()
|
|
.map(|i| {
|
|
println!(
|
|
"Generating keystores for validator {} of {}",
|
|
i + 1,
|
|
node_count
|
|
);
|
|
|
|
let indices =
|
|
(i * validators_per_node..(i + 1) * validators_per_node).collect::<Vec<_>>();
|
|
ValidatorFiles::with_keystores(&indices).unwrap()
|
|
})
|
|
.collect::<Vec<_>>();
|
|
|
|
let log_level = "debug";
|
|
let log_format = None;
|
|
|
|
let mut env = EnvironmentBuilder::mainnet()
|
|
.async_logger(log_level, log_format)?
|
|
.multi_threaded_tokio_runtime()?
|
|
.build()?;
|
|
|
|
let eth1_block_time = Duration::from_millis(15_000 / speed_up_factor);
|
|
|
|
let spec = &mut env.eth2_config.spec;
|
|
|
|
spec.milliseconds_per_slot /= speed_up_factor;
|
|
spec.eth1_follow_distance = 16;
|
|
spec.genesis_delay = eth1_block_time.as_secs() * spec.eth1_follow_distance * 2;
|
|
spec.min_genesis_time = 0;
|
|
spec.min_genesis_active_validator_count = 64;
|
|
spec.seconds_per_eth1_block = 1;
|
|
|
|
let genesis_delay = Duration::from_secs(5);
|
|
let genesis_time = SystemTime::now()
|
|
.duration_since(UNIX_EPOCH)
|
|
.map_err(|_| "should get system time")?
|
|
+ genesis_delay;
|
|
let genesis_instant = Instant::now() + genesis_delay;
|
|
|
|
let slot_duration = Duration::from_millis(spec.milliseconds_per_slot);
|
|
let total_validator_count = validators_per_node * node_count;
|
|
|
|
let context = env.core_context();
|
|
|
|
let mut beacon_config = testing_client_config();
|
|
|
|
beacon_config.genesis = ClientGenesis::Interop {
|
|
validator_count: total_validator_count,
|
|
genesis_time: genesis_time.as_secs(),
|
|
};
|
|
beacon_config.dummy_eth1_backend = true;
|
|
beacon_config.sync_eth1_chain = true;
|
|
|
|
beacon_config.network.enr_address = Some(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
|
|
|
|
let main_future = async {
|
|
let network = LocalNetwork::new(context, beacon_config.clone()).await?;
|
|
/*
|
|
* One by one, add beacon nodes to the network.
|
|
*/
|
|
|
|
for _ in 0..node_count - 1 {
|
|
network.add_beacon_node(beacon_config.clone()).await?;
|
|
}
|
|
|
|
/*
|
|
* Create a future that will add validator clients to the network. Each validator client is
|
|
* attached to a single corresponding beacon node.
|
|
*/
|
|
let add_validators_fut = async {
|
|
for (i, files) in validator_files.into_iter().enumerate() {
|
|
network
|
|
.add_validator_client(
|
|
ValidatorConfig {
|
|
disable_auto_discover: false,
|
|
..ValidatorConfig::default()
|
|
},
|
|
i,
|
|
files,
|
|
)
|
|
.await?;
|
|
}
|
|
|
|
Ok::<(), String>(())
|
|
};
|
|
|
|
/*
|
|
* The processes that will run checks on the network as it runs.
|
|
*/
|
|
let checks_fut = async {
|
|
delay_until(genesis_instant).await;
|
|
|
|
let (finalization, block_prod) = futures::join!(
|
|
// Check that the chain finalizes at the first given opportunity.
|
|
checks::verify_first_finalization(network.clone(), slot_duration),
|
|
// Check that a block is produced at every slot.
|
|
checks::verify_full_block_production_up_to(
|
|
network.clone(),
|
|
Epoch::new(4).start_slot(MainnetEthSpec::slots_per_epoch()),
|
|
slot_duration,
|
|
)
|
|
);
|
|
finalization?;
|
|
block_prod?;
|
|
|
|
Ok::<(), String>(())
|
|
};
|
|
|
|
let (add_validators, start_checks) = futures::join!(add_validators_fut, checks_fut);
|
|
|
|
add_validators?;
|
|
start_checks?;
|
|
|
|
// The `final_future` either completes immediately or never completes, depending on the value
|
|
// of `end_after_checks`.
|
|
|
|
if !end_after_checks {
|
|
future::pending::<()>().await;
|
|
}
|
|
/*
|
|
* End the simulation by dropping the network. This will kill all running beacon nodes and
|
|
* validator clients.
|
|
*/
|
|
println!(
|
|
"Simulation complete. Finished with {} beacon nodes and {} validator clients",
|
|
network.beacon_node_count(),
|
|
network.validator_client_count()
|
|
);
|
|
|
|
// Be explicit about dropping the network, as this kills all the nodes. This ensures
|
|
// all the checks have adequate time to pass.
|
|
drop(network);
|
|
Ok::<(), String>(())
|
|
};
|
|
|
|
Ok(env.runtime().block_on(main_future).unwrap())
|
|
}
|