//! This crate should eventually represent the structure at this repo: //! //! https://github.com/eth2-clients/eth2-testnets/tree/master/nimbus/testnet1 //! //! It is not accurate at the moment, we include extra files and we also don't support a few //! others. We are unable to confirm to the repo until we have the following PR merged: //! //! https://github.com/sigp/lighthouse/pull/605 use eth2_libp2p::Enr; use std::fs::{create_dir_all, File}; use std::path::PathBuf; use types::{Address, BeaconState, EthSpec, YamlConfig}; pub const ADDRESS_FILE: &str = "deposit_contract.txt"; pub const DEPLOY_BLOCK_FILE: &str = "deploy_block.txt"; pub const BOOT_NODES_FILE: &str = "boot_enr.yaml"; pub const GENESIS_STATE_FILE: &str = "genesis.ssz"; pub const YAML_CONFIG_FILE: &str = "config.yaml"; #[derive(Clone, PartialEq, Debug)] pub struct Eth2TestnetDir { pub deposit_contract_address: String, pub deposit_contract_deploy_block: u64, pub boot_enr: Option>, pub genesis_state: Option>, pub yaml_config: Option, } impl Eth2TestnetDir { // Write the files to the directory, only if the directory doesn't already exist. pub fn write_to_file(&self, base_dir: PathBuf) -> Result<(), String> { if base_dir.exists() { return Err("Testnet directory already exists".to_string()); } self.force_write_to_file(base_dir) } // Write the files to the directory, even if the directory already exists. pub fn force_write_to_file(&self, base_dir: PathBuf) -> Result<(), String> { create_dir_all(&base_dir) .map_err(|e| format!("Unable to create testnet directory: {:?}", e))?; macro_rules! write_to_file { ($file: ident, $variable: expr) => { File::create(base_dir.join($file)) .map_err(|e| format!("Unable to create {}: {:?}", $file, e)) .and_then(|file| { serde_yaml::to_writer(file, &$variable) .map_err(|e| format!("Unable to write {}: {:?}", $file, e)) })?; }; } write_to_file!(ADDRESS_FILE, self.deposit_contract_address); write_to_file!(DEPLOY_BLOCK_FILE, self.deposit_contract_deploy_block); if let Some(boot_enr) = &self.boot_enr { write_to_file!(BOOT_NODES_FILE, boot_enr); } if let Some(genesis_state) = &self.genesis_state { write_to_file!(GENESIS_STATE_FILE, genesis_state); } if let Some(yaml_config) = &self.yaml_config { write_to_file!(YAML_CONFIG_FILE, yaml_config); } Ok(()) } pub fn load(base_dir: PathBuf) -> Result { macro_rules! load_from_file { ($file: ident) => { File::open(base_dir.join($file)) .map_err(|e| format!("Unable to open {}: {:?}", $file, e)) .and_then(|file| { serde_yaml::from_reader(file) .map_err(|e| format!("Unable to parse {}: {:?}", $file, e)) })?; }; } macro_rules! optional_load_from_file { ($file: ident) => { if base_dir.join($file).exists() { Some(load_from_file!($file)) } else { None } }; } let deposit_contract_address = load_from_file!(ADDRESS_FILE); let deposit_contract_deploy_block = load_from_file!(DEPLOY_BLOCK_FILE); let boot_enr = optional_load_from_file!(BOOT_NODES_FILE); let genesis_state = optional_load_from_file!(GENESIS_STATE_FILE); let yaml_config = optional_load_from_file!(YAML_CONFIG_FILE); Ok(Self { deposit_contract_address, deposit_contract_deploy_block, boot_enr, genesis_state, yaml_config, }) } pub fn deposit_contract_address(&self) -> Result { if self.deposit_contract_address.starts_with("0x") { self.deposit_contract_address[2..] .parse() .map_err(|e| format!("Corrupted address, unable to parse: {:?}", e)) } else { Err("Corrupted address, must start with 0x".to_string()) } } } #[cfg(test)] mod tests { use super::*; use tempdir::TempDir; use types::MinimalEthSpec; type E = MinimalEthSpec; #[test] fn round_trip() { let temp_dir = TempDir::new("eth2_testnet_test").expect("should create temp dir"); let base_dir = PathBuf::from(temp_dir.path().join("my_testnet")); let deposit_contract_address = "0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413".to_string(); let deposit_contract_deploy_block = 42; let testnet: Eth2TestnetDir = Eth2TestnetDir { deposit_contract_address: deposit_contract_address.clone(), deposit_contract_deploy_block: deposit_contract_deploy_block, // TODO: add some Enr for testing. boot_enr: None, // TODO: add a genesis state for testing. genesis_state: None, // TODO: add a yaml config for testing. yaml_config: None, }; testnet .write_to_file(base_dir.clone()) .expect("should write to file"); let decoded = Eth2TestnetDir::load(base_dir).expect("should load struct"); assert_eq!( decoded.deposit_contract_address, deposit_contract_address, "deposit_contract_address" ); assert_eq!( decoded.deposit_contract_deploy_block, deposit_contract_deploy_block, "deposit_contract_deploy_block" ); assert_eq!(testnet, decoded, "should decode as encoded"); } }