GH-146: More rebranding, merging in master

Author: dnwiebe

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,8 +7,8 @@ assignees: ''
 
 ---
 
-**SubstratumNode Version**
-Need the full version of SubstratumNode (e.g. SubstratumNode 0.4.2)
+**MASQ Node Version**
+Need the full version of MASQ Node (e.g. MASQNode 0.4.2)
 
 **Describe the bug**
 A clear and concise description of what the bug is.
@@ -27,7 +27,7 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Log files**
-Include any relavent logging information. (e.g. /tmp/SubstratumNode.log on Ubuntu)
+Include any relevant logging information.
 
 **Device Details (please complete the following information):**
  - Device Type [e.g. laptop, desktop, mobile phone, router, IoT]

CODE-OF-CONDUCT.md

@@ -1,4 +1,4 @@
-# Substratum Network Code of Conduct
+# MASQ Network Code of Conduct
 
 ## Our Pledge
 
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [[email protected]](mailto:[email protected]). 
+reported by contacting the project team. 
 All complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

@@ -52,9 +52,12 @@ cat README.md.clean | sed -n '/\(Results Marker\)/,$p' | tail -n+2 >> README.md
 
 mkdir -p "results/$RESULTS_LABEL"
 cp ../generated.tar.gz "results/$RESULTS_LABEL/$GENERATED_NAME.tar.gz"
-git add README.md "results/$RESULTS_LABEL/$GENERATED_NAME.tar.gz"
+git checkout --orphan new-master
+git add README.md results
 git commit -m "Latest results for $RESULTS_LABEL ($GENERATED_TYPE) - $STATUS"
-git pull
-git push
+git branch -D master
+git branch -M new-master master
+git checkout master
+git push -f -u origin HEAD
 
 popd

README.md

@@ -13,6 +13,7 @@ base64 = "0.10.1"
 ethereum-types = "0.6.0"
 ethsign-crypto = "0.1.0"
 futures = "0.1.28"
+itertools = "0.8.0"
 pretty-hex = "0.1.0"
 primitive-types = {version = "0.5.0", default-features = false, features = ["default", "rlp", "serde"] }
 regex = "1.2.1"

ci/publish_results.sh

@@ -3,9 +3,6 @@
 pub mod blockchain;
 pub mod command;
 pub mod main;
-pub mod multinode_gossip;
-pub mod neighborhood_constructor;
-pub mod rest_utils;
 pub mod masq_cores_client;
 pub mod masq_cores_server;
 pub mod masq_mock_node;
@@ -14,4 +11,7 @@ pub mod masq_node_client;
 pub mod masq_node_cluster;
 pub mod masq_node_server;
 pub mod masq_real_node;
+pub mod multinode_gossip;
+pub mod neighborhood_constructor;
+pub mod rest_utils;
 pub mod utils;

multinode_integration_tests/Cargo.toml

@@ -132,7 +132,10 @@ impl MASQCoresServer {
     pub fn node_reference(&self) -> NodeReference {
         NodeReference {
             public_key: self.cryptde.public_key().clone(),
-            node_addr: NodeAddr::new(&self.socket_addr.ip(), &vec![self.socket_addr.port()]),
+            node_addr_opt: Some(NodeAddr::new(
+                &self.socket_addr.ip(),
+                &vec![self.socket_addr.port()],
+            )),
         }
     }
 
@@ -144,8 +147,8 @@ impl MASQCoresServer {
         self.node_reference().public_key.clone()
     }
 
-    pub fn node_addr(&self) -> NodeAddr {
-        self.node_reference().node_addr.clone()
+    pub fn node_addr_opt(&self) -> Option<NodeAddr> {
+        self.node_reference().node_addr_opt.clone()
     }
 
     pub fn private_key(&self) -> &PrivateKey {

multinode_integration_tests/src/lib.rs

@@ -1,11 +1,11 @@
 // Copyright (c) 2017-2019, Substratum LLC (https://substratum.net) and/or its affiliates. All rights reserved.
 use crate::command::Command;
 use crate::main::CONTROL_STREAM_PORT;
-use crate::multinode_gossip::{Introduction, MultinodeGossip, SingleNode};
-use crate::masq_node::NodeReference;
-use crate::masq_node::PortSelector;
 use crate::masq_node::MASQNode;
 use crate::masq_node::MASQNodeUtils;
+use crate::masq_node::NodeReference;
+use crate::masq_node::PortSelector;
+use crate::multinode_gossip::{Introduction, MultinodeGossip, SingleNode};
 use node_lib::hopper::live_cores_package::LiveCoresPackage;
 use node_lib::json_masquerader::JsonMasquerader;
 use node_lib::masquerader::{MasqueradeError, Masquerader};
@@ -65,7 +65,7 @@ impl MASQNode for MASQMockNode {
     fn node_reference(&self) -> NodeReference {
         NodeReference::new(
             self.signing_cryptde().unwrap().public_key().clone(),
-            self.node_addr().ip_addr(),
+            Some(self.node_addr().ip_addr()),
             self.node_addr().ports(),
         )
     }
@@ -119,6 +119,14 @@ impl MASQNode for MASQMockNode {
     fn chain(&self) -> Option<String> {
         self.guts.chain.clone()
     }
+
+    fn accepts_connections(&self) -> bool {
+        true // just a guess
+    }
+
+    fn routes_data(&self) -> bool {
+        true // just a guess
+    }
 }
 
 impl MASQMockNode {
@@ -343,7 +351,7 @@ impl MASQMockNode {
         match self.wait_for_package(&masquerader, timeout) {
             Ok((from, _, package)) => {
                 let incoming_cores_package = package
-                    .to_expired(from.ip(), self.signing_cryptde().unwrap())
+                    .to_expired(from, self.signing_cryptde().unwrap())
                     .unwrap();
                 match incoming_cores_package.payload {
                     MessageType::Gossip(g) => Some((g, from.ip())),

multinode_integration_tests/src/masq_cores_server.rs

@@ -28,7 +28,7 @@ use std::time::Instant;
 #[derive(PartialEq, Clone, Debug)]
 pub struct NodeReference {
     pub public_key: PublicKey,
-    pub node_addr: NodeAddr,
+    pub node_addr_opt: Option<NodeAddr>,
 }
 
 impl FromStr for NodeReference {
@@ -49,14 +49,19 @@ impl FromStr for NodeReference {
 impl fmt::Display for NodeReference {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let public_key_string = base64::encode_config(&self.public_key.as_slice(), STANDARD_NO_PAD);
-        let ip_addr_string = format!("{}", self.node_addr.ip_addr());
-        let port_list_string = self
-            .node_addr
-            .ports()
-            .iter()
-            .map(|port| port.to_string())
-            .collect::<Vec<String>>()
-            .join(",");
+        let ip_addr_string = match &self.node_addr_opt {
+            Some(node_addr) => format!("{}", node_addr.ip_addr()),
+            None => String::new(),
+        };
+        let port_list_string = match &self.node_addr_opt {
+            Some(node_addr) => node_addr
+                .ports()
+                .iter()
+                .map(|port| port.to_string())
+                .collect::<Vec<String>>()
+                .join(","),
+            None => String::new(),
+        };
         write!(
             f,
             "{}:{}:{}",
@@ -68,10 +73,20 @@ impl fmt::Display for NodeReference {
 }
 
 impl NodeReference {
-    pub fn new(public_key: PublicKey, ip_addr: IpAddr, ports: Vec<u16>) -> NodeReference {
-        NodeReference {
-            public_key,
-            node_addr: NodeAddr::new(&ip_addr, &ports),
+    pub fn new(
+        public_key: PublicKey,
+        ip_addr_opt: Option<IpAddr>,
+        ports: Vec<u16>,
+    ) -> NodeReference {
+        match ip_addr_opt {
+            Some(ip_addr) => NodeReference {
+                public_key,
+                node_addr_opt: Some(NodeAddr::new(&ip_addr, &ports)),
+            },
+            None => NodeReference {
+                public_key,
+                node_addr_opt: None,
+            },
         }
     }
 
@@ -82,14 +97,18 @@ impl NodeReference {
         }
     }
 
-    fn extract_ip_addr(slice: &str) -> Result<IpAddr, String> {
-        match IpAddr::from_str(slice) {
-            Ok(ip_addr) => Ok(ip_addr),
-            Err(_) => {
-                return Err(format!(
-                    "The IP address of a NodeReference must be valid, not '{}'",
-                    slice
-                ));
+    fn extract_ip_addr(slice: &str) -> Result<Option<IpAddr>, String> {
+        if slice.is_empty() {
+            Ok(None)
+        } else {
+            match IpAddr::from_str(slice) {
+                Ok(ip_addr) => Ok(Some(ip_addr)),
+                Err(_) => {
+                    return Err(format!(
+                        "The IP address of a NodeReference must be valid, not '{}'",
+                        slice
+                    ));
+                }
             }
         }
     }
@@ -159,6 +178,8 @@ pub trait MASQNode: Any {
     fn rate_pack(&self) -> RatePack;
     // Valid values are "dev, "ropsten" for now. Add "mainnet" when it's time.
     fn chain(&self) -> Option<String>;
+    fn accepts_connections(&self) -> bool;
+    fn routes_data(&self) -> bool;
 }
 
 pub struct MASQNodeUtils {}
@@ -319,8 +340,11 @@ mod tests {
 
         assert_eq!(result.public_key, key);
         assert_eq!(
-            result.node_addr,
-            NodeAddr::new(&IpAddr::from_str("12.34.56.78").unwrap(), &vec!(1234, 2345))
+            result.node_addr_opt,
+            Some(NodeAddr::new(
+                &IpAddr::from_str("12.34.56.78").unwrap(),
+                &vec!(1234, 2345)
+            ))
         );
     }
 
@@ -333,16 +357,19 @@ mod tests {
 
         assert_eq!(result.public_key, key);
         assert_eq!(
-            result.node_addr,
-            NodeAddr::new(&IpAddr::from_str("12.34.56.78").unwrap(), &vec!())
+            result.node_addr_opt,
+            Some(NodeAddr::new(
+                &IpAddr::from_str("12.34.56.78").unwrap(),
+                &vec!()
+            ))
         );
     }
 
     #[test]
     fn node_reference_can_display_itself() {
         let subject = NodeReference::new(
             PublicKey::new(&b"Booga"[..]),
-            IpAddr::from_str("12.34.56.78").unwrap(),
+            Some(IpAddr::from_str("12.34.56.78").unwrap()),
             vec![1234, 5678],
         );
 

multinode_integration_tests/src/masq_mock_node.rs

@@ -2,8 +2,8 @@
 use crate::command::Command;
 use crate::masq_mock_node::MASQMockNode;
 use crate::masq_node::{MASQNode, MASQNodeUtils};
-use crate::masq_real_node::NodeStartupConfig;
 use crate::masq_real_node::MASQRealNode;
+use crate::masq_real_node::NodeStartupConfig;
 use node_lib::sub_lib::cryptde::PublicKey;
 use node_lib::test_utils::DEFAULT_CHAIN_ID;
 use std::collections::HashMap;