(feat) Make z2 work again by providing a bootstrap addres

z2/src/node_spec.rs

@@ -1,5 +1,5 @@
 use std::{
-    collections::{HashMap, HashSet},
+    collections::{BTreeMap, HashSet},
     default::Default,
     fmt,
 };
@@ -15,7 +15,7 @@ pub struct NodeDesc {
 
 #[derive(Clone, Debug, Serialize, Deserialize, Default)]
 pub struct Composition {
-    pub nodes: HashMap<u64, NodeDesc>,
+    pub nodes: BTreeMap<u64, NodeDesc>,
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize, Default)]
@@ -63,7 +63,7 @@ fn indices_from_string(input: &str) -> Result<HashSet<u64>> {
 impl Composition {
     pub fn parse(from: &str) -> Result<Self> {
         let mut components = from.split('/');
-        let mut nodes = HashMap::new();
+        let mut nodes = BTreeMap::new();
         if let Some(val) = components.next() {
             for v in indices_from_string(val)? {
                 nodes.insert(v, NodeDesc { is_validator: true });
@@ -73,13 +73,13 @@ impl Composition {
     }
 
     pub fn single_node(is_validator: bool) -> Self {
-        let mut nodes = HashMap::new();
+        let mut nodes = BTreeMap::new();
         nodes.insert(0, NodeDesc { is_validator });
         Self { nodes }
     }
 
     pub fn small_network() -> Self {
-        let mut nodes = HashMap::new();
+        let mut nodes = BTreeMap::new();
         for i in 0..4 {
             nodes.insert(i, NodeDesc { is_validator: true });
         }

z2/src/setup.rs

@@ -10,6 +10,7 @@ use alloy::{
 };
 use anyhow::{anyhow, Context, Result};
 use k256::ecdsa::SigningKey;
+use libp2p::{Multiaddr, PeerId};
 use serde::{Deserialize, Serialize};
 use serde_yaml;
 use tera::Tera;
@@ -296,6 +297,10 @@ impl Setup {
         self.config.base_port + 2002
     }
 
+    pub fn get_p2p_port(&self, index: u16) -> u16 {
+        index + 401 + self.config.base_port
+    }
+
     pub fn get_explorer_url(&self) -> String {
         format!("http://localhost:{0}", self.get_otterscan_port())
     }
@@ -308,8 +313,31 @@ impl Setup {
         format!("0.0.0.0:{0}", self.get_docs_port())
     }
 
+    pub fn get_p2p_multiaddr(&self, index: u16) -> Multiaddr {
+        // unwrap() is safe because this is a constant string - it's a bug in the program if
+        // it fails to parse.
+        format!("/ip4/127.0.0.1/tcp/{0}", self.get_p2p_port(index))
+            .parse()
+            .unwrap()
+    }
+
+    pub fn get_peer_id(&self, index: u16) -> Result<PeerId> {
+        let node_data = self
+            .config
+            .node_data
+            .get(&u64::from(index))
+            .ok_or(anyhow!("Cannot find node data for node {index}"))?;
+        let node_key = SecretKey::from_hex(&node_data.secret_key)?;
+        let libp2p_keypair = node_key.to_libp2p_keypair();
+        Ok(PeerId::from_public_key(&libp2p_keypair.public()))
+    }
+
     pub fn get_port_map(&self) -> String {
         let mut result = String::new();
+        result.push_str(&format!(
+            "🦏  p2p ports are at {0}+<node_index>\n",
+            self.get_p2p_port(0)
+        ));
         result.push_str(&format!(
             "🦏  JSON-RPC ports are at {0}+<node_index>\n",
             self.get_json_rpc_port(0, false)
@@ -495,13 +523,33 @@ impl Setup {
             self.config.shape.nodes.len(),
             &self.config_dir
         );
+
+        let bootstrap_address =
+            if let Some((first_index, _)) = self.config.shape.nodes.iter().next() {
+                let idx = u16::try_from(*first_index)?;
+                println!(
+                    "Bootstrap_address has idx {idx} with node_data {0:?}",
+                    self.config.node_data.get(&u64::from(idx))
+                );
+
+                Some((self.get_peer_id(idx)?, self.get_p2p_multiaddr(idx)))
+            } else {
+                None
+            };
+
         for (node_index, _node_desc) in self.config.shape.nodes.iter() {
             println!("🎱 Generating configuration for node {node_index}...");
+            let node_index_u16 = u16::try_from(*node_index)?;
             let mut cfg = zilliqa::cfg::Config {
                 otlp_collector_endpoint: Some("http://localhost:4317".to_string()),
-                bootstrap_address: None,
+                bootstrap_address: bootstrap_address.clone(),
                 nodes: Vec::new(),
-                p2p_port: 0,
+                p2p_port: self.get_p2p_port(node_index_u16),
+                // No external address is needed right now, because tcp connections can be
+                // called back, so can act as an autonat server. Effectively, this means the
+                // bootstrap_address specifies the external address. If this is ever not the
+                // case, we will need an external_address to be specified here.
+                // - rrw 2024-12-02
                 external_address: None,
             };
             // @todo should pass this in!
@@ -581,7 +629,6 @@ impl Setup {
 
             cfg.nodes = Vec::new();
             cfg.nodes.push(node_config);
-            cfg.p2p_port = 0;
             // Now write the config.
             let config_path = self.get_config_path(*node_index)?;
             println!("🪅 Writing configuration file for node {0} .. ", node_index);