reformat and update readme

Author: gregcusack

Diff for: README.md

@@ -9,6 +9,17 @@ In Validator Lab we can deploy and test new validator features quickly and easil
 
 ## How to run
 
+### Requirements
+1) Docker. Create `docker` group add user to `docker` group
+```
+sudo usermod -aG docker $USER
+newgrp docker
+```
+2) jq
+```
+sudo apt install jq
+```
+
 ### Setup
 Ensure you have the proper permissions to connect to the Monogon Kubernetes endpoint. Reach out to Leo on slack if you need the key (you do if you haven't asked him in the past).
 
@@ -107,6 +118,10 @@ For client Version >= 2.0.0
 --bench-tps-args 'tx-count=5000 keypair-multiplier=4 threads=16 num-lamports-per-account=200000000 sustained tpu-connection-pool-size=8 thread-batch-sleep-ms=0 commitment-config=processed'
 ```
 
+## Baking Validator Stakes into Genesis
+- By default, validator stakes are baked into genesis on genesis creation. That way when the cluster boots up, all validators will consistently be in the leader schedule.
+- If you do not want this and instead want the stake to warm up after deplyoyment, pass in the flag `--skip-primordial-stakes`. 
+
 ## Metrics
 1) Setup metrics database:
 ```
@@ -155,7 +170,9 @@ cargo run --bin cluster -- -n <namespace> --registry <registry> --release-channe
 
 For steps (2) and (3), when using `--no-bootstrap`, we assume that the directory at `--cluster-data-path <directory>` has the correct genesis, bootstrap identity, and faucet account stored. These are all created in step (1).
 
-Note: We can't deploy heterogeneous clusters across v1.17 and v1.18 due to feature differences. Hope to fix this in the future. Have something where we can specifically define which features to enable.
+Notes: 
+1) We can't deploy heterogeneous clusters across v1.17 and v1.18 due to feature differences. Hope to fix this in the future. Have something where we can specifically define which features to enable.
+2) Heterogenous clusters with primordial stakes baked into genesis is not supported yet
 
 ## Querying the RPC from outside the cluster
 The cluster now has an external IP/port that can be queried to reach the cluster RPC. The external RPC port will be logged during cluster boot, e.g.:

Diff for: src/genesis.rs

@@ -283,7 +283,11 @@ impl Genesis {
         Ok(child)
     }
 
-    fn setup_genesis_flags(&self, num_validators: usize, image_tag: &str) -> Result<Vec<String>, Box<dyn Error>> {
+    fn setup_genesis_flags(
+        &self,
+        num_validators: usize,
+        image_tag: &str,
+    ) -> Result<Vec<String>, Box<dyn Error>> {
         let mut args = vec![
             "--bootstrap-validator-lamports".to_string(),
             sol_to_lamports(
@@ -406,11 +410,11 @@ impl Genesis {
         let progress_bar = new_spinner_progress_bar();
         progress_bar.set_message(format!("{SUN}Building Genesis..."));
 
-        info!("genesis args:");
+        debug!("genesis args:");
         for arg in &args {
-            info!("{arg}");
+            debug!("{arg}");
         }
-        let executable_path: PathBuf = exec_path.join("solana-genesis");
+        let executable_path = exec_path.join("solana-genesis");
         let output = Command::new(executable_path)
             .args(&args)
             .output()
@@ -430,67 +434,75 @@ impl Genesis {
         Ok(())
     }
 
-    pub fn create_snapshot(
-        &self,
-        exec_path: &Path,
-    ) -> Result<(), Box<dyn Error>> {
+    pub fn create_snapshot(&self, exec_path: &Path) -> Result<(), Box<dyn Error>> {
         let warp_slot = 1;
         let executable_path: PathBuf = exec_path.join("agave-ledger-tool");
         let args = vec![
             "-l".to_string(),
-            self.config_dir.join("bootstrap-validator").into_os_string().into_string().unwrap(),
+            self.config_dir
+                .join("bootstrap-validator")
+                .into_os_string()
+                .into_string()
+                .unwrap(),
             "create-snapshot".to_string(),
             "0".to_string(),
-            self.config_dir.join("bootstrap-validator").into_os_string().into_string().unwrap(),
+            self.config_dir
+                .join("bootstrap-validator")
+                .into_os_string()
+                .into_string()
+                .unwrap(),
             "--warp-slot".to_string(),
             warp_slot.to_string(),
         ];
         let output = Command::new(executable_path)
             .args(&args)
+            .stdout(Stdio::null())
+            .stderr(Stdio::piped())
             .output()
-            .expect("Failed to execute agave-ledger-tool");
+            .map_err(Box::new)?;
+
         if !output.status.success() {
-            return Err(format!(
-                "Failed to create snapshot. err: {:?}",
-                String::from_utf8(output.stderr)
-            )
-            .into());
+            return Err(String::from_utf8_lossy(&output.stderr).into());
         }
         info!("Snapshot creation complete");
         Ok(())
     }
 
-    pub fn get_bank_hash(
-        &self,
-    ) -> Result<String, Box<dyn Error>> {
+    pub fn get_bank_hash(&self) -> Result<String, Box<dyn Error>> {
         let agave_output = Command::new("agave-ledger-tool")
-            .args(&[
-                "-l", 
-                self.config_dir.join("bootstrap-validator").into_os_string().into_string().unwrap().as_str(),
+            .args([
+                "-l",
+                self.config_dir
+                    .join("bootstrap-validator")
+                    .into_os_string()
+                    .into_string()
+                    .unwrap()
+                    .as_str(),
                 "verify",
-                "--halt-at-slot", "0",
+                "--halt-at-slot",
+                "0",
                 "--print-bank-hash",
-                "--output", "json"
+                "--output",
+                "json",
             ])
             .stdout(Stdio::piped())
             .spawn()?
             .stdout
             .expect("Failed to capture agave-ledger-tool output");
 
-        // Use `jq` to filter the JSON output and extract the `.hash` value
+        // get bank hash
         let jq_output = Command::new("jq")
             .arg("-r")
             .arg(".hash")
             .stdin(agave_output)
             .output()?;
 
-        // Convert the output to a String
-        let bank_hash = String::from_utf8_lossy(&jq_output.stdout).trim().to_string();
+        let bank_hash = String::from_utf8_lossy(&jq_output.stdout)
+            .trim()
+            .to_string();
 
-        // Print or use the bank hash
-        info!("bankHash: {}", bank_hash);
+        info!("bankHash: {bank_hash}");
 
         Ok(bank_hash)
     }
-
 }

Diff for: src/kubernetes.rs

@@ -303,10 +303,6 @@ impl<'a> Kubernetes<'a> {
         let mut command = vec![command_path];
         command.extend(self.generate_bootstrap_command_flags());
 
-        for c in &command {
-            info!("command: {:?}", c);
-        }
-
         k8s_helpers::create_replica_set(
             format!("{}-{}", image.node_type(), image.tag()),
             self.namespace.clone(),

Diff for: src/main.rs

@@ -557,7 +557,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let internal_node_stake_sol = value_t_or_exit!(matches, "internal_node_stake_sol", f64);
     let internal_node_sol =
         value_t_or_exit!(matches, "internal_node_sol", f64) + internal_node_stake_sol;
-        
+
     let skip_primordial_stakes = matches.is_present("skip_primordial_stakes");
 
     let genesis_flags = GenesisFlags {
@@ -620,7 +620,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         internal_node_stake_sol,
         commission,
         shred_version: None, // set after genesis created
-        bank_hash: None, //set after snapshot created
+        bank_hash: None,     //set after snapshot created
         max_ledger_size: if limit_ledger_size < DEFAULT_MIN_MAX_LEDGER_SHREDS {
             clap::Error::with_description(
                     format!("The provided --limit-ledger-size value was too small, the minimum value is {DEFAULT_MIN_MAX_LEDGER_SHREDS}"),
@@ -705,7 +705,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
         // creates genesis and writes to binary file
         genesis
-            .generate(cluster_data_root.get_root_path(), &exec_path, num_validators, &image_tag)
+            .generate(
+                cluster_data_root.get_root_path(),
+                &exec_path,
+                num_validators,
+                &image_tag,
+            )
             .await?;
         info!("Genesis created");