Lighthouse v0.2.0 (Medalla) (#1452)

paulhauner · paulhauner · commit f26adc0a36a1 · 2020-08-04T07:44:53.000Z
## Issue Addressed NA ## Proposed Changes - Moves the git-based versioning we were doing into the `lighthouse_version` crate in `common`. - Removes the `beacon_node/version` crate, replacing it with `lighthouse_version`. - Bumps the version to `v0.2.0`. ## Additional Info There are now two types of version string: 1. `const VERSION: &str = Lighthouse/v0.2.0-1419501f2+` 1. `version_with_platform() = Lighthouse/v0.2.0-1419501f2+/x86_64-linux` (1) is handy cause it's a `const` and shorter. (2) has platform info so it's more useful. Note that the plus-sign (`+`) indicates the the git commit is dirty (it used to be `(modified)` but I had to shorten it to fit into graffiti). These version strings are now included on: - `lighthouse --version` - `lcli --version` - `curl localhost:5052/node/version` - p2p messages when we communicate our version You can update the version by changing this constant (version is not related to a `Cargo.toml`): https://github.com/sigp/lighthouse/blob/b9ad7102d56f4827b8b74447c7121174a3e97bbc/common/lighthouse_version/src/lib.rs#L4-L15
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,7 +11,6 @@ members = [
     "beacon_node/rest_api",
     "beacon_node/store",
     "beacon_node/timer",
-    "beacon_node/version",
     "beacon_node/websocket_server",
 
 	"boot_node",
@@ -27,6 +26,7 @@ members = [
     "common/eth2_wallet_manager",
     "common/hashset_delay",
     "common/lighthouse_metrics",
+    "common/lighthouse_version",
     "common/logging",
     "common/remote_beacon_node",
     "common/rest_types",
diff --git a/beacon_node/Cargo.toml b/beacon_node/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "beacon_node"
 version = "0.1.2"
-authors = ["Paul Hauner <paul@paulhauner.com>", "Age Manning <Age@AgeManning.com"]
+authors = ["Paul Hauner <paul@paulhauner.com>", "Sigma Prime <contact@sigmaprime.io>"]
 edition = "2018"
 
 [lib]
@@ -20,7 +20,6 @@ beacon_chain = { path = "beacon_chain" }
 types = { path = "../consensus/types" }
 store = { path = "./store" }
 client = { path = "client" }
-version = { path = "version" }
 clap = "2.33.0"
 rand = "0.7.3"
 slog = { version = "2.5.2", features = ["max_level_trace", "release_max_level_trace"] }
@@ -40,3 +39,4 @@ eth2_ssz = "0.1.2"
 serde = "1.0.110"
 clap_utils = { path = "../common/clap_utils" }
 hyper = "0.13.5"
+lighthouse_version = { path = "../common/lighthouse_version" }
diff --git a/beacon_node/beacon_chain/Cargo.toml b/beacon_node/beacon_chain/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "beacon_chain"
 version = "0.1.2"
-authors = ["Paul Hauner <paul@paulhauner.com>", "Age Manning <Age@AgeManning.com>"]
+authors = ["Paul Hauner <paul@paulhauner.com>"]
 edition = "2018"
 
 [features]
diff --git a/beacon_node/eth2_libp2p/Cargo.toml b/beacon_node/eth2_libp2p/Cargo.toml
@@ -14,7 +14,7 @@ serde_derive = "1.0.110"
 eth2_ssz = "0.1.2"
 eth2_ssz_derive = "0.1.0"
 slog = { version = "2.5.2", features = ["max_level_trace"] }
-version = { path = "../version" }
+lighthouse_version = { path = "../../common/lighthouse_version" }
 tokio = { version = "0.2.21", features = ["time", "macros"] }
 futures = "0.3.5"
 error-chain = "0.12.2"
diff --git a/beacon_node/eth2_libp2p/src/behaviour/mod.rs b/beacon_node/eth2_libp2p/src/behaviour/mod.rs
@@ -77,7 +77,7 @@ impl<TSpec: EthSpec> Behaviour<TSpec> {
 
         let identify = Identify::new(
             "lighthouse/libp2p".into(),
-            version::version(),
+            lighthouse_version::version_with_platform(),
             local_key.public(),
         );
 
diff --git a/beacon_node/eth2_libp2p/src/config.rs b/beacon_node/eth2_libp2p/src/config.rs
@@ -131,7 +131,7 @@ impl Default for Config {
             discv5_config,
             boot_nodes: vec![],
             libp2p_nodes: vec![],
-            client_version: version::version(),
+            client_version: lighthouse_version::version_with_platform(),
             disable_discovery: false,
             topics,
         }
diff --git a/beacon_node/rest_api/Cargo.toml b/beacon_node/rest_api/Cargo.toml
@@ -12,7 +12,6 @@ beacon_chain = { path = "../beacon_chain" }
 network = { path = "../network" }
 eth2_libp2p = { path = "../eth2_libp2p" }
 store = { path = "../store" }
-version = { path = "../version" }
 serde = { version = "1.0.110", features = ["derive"] }
 serde_json = "1.0.52"
 serde_yaml = "0.8.11"
@@ -40,6 +39,7 @@ environment = { path = "../../lighthouse/environment" }
 uhttp_sse = "0.5.1"
 bus = "2.2.3"
 itertools = "0.9.0"
+lighthouse_version = { path = "../../common/lighthouse_version" }
 
 [dev-dependencies]
 assert_matches = "1.3.0"
diff --git a/beacon_node/rest_api/src/node.rs b/beacon_node/rest_api/src/node.rs
@@ -2,13 +2,14 @@ use crate::response_builder::ResponseBuilder;
 use crate::{ApiError, ApiResult};
 use eth2_libp2p::{types::SyncState, NetworkGlobals};
 use hyper::{Body, Request};
+use lighthouse_version::version_with_platform;
 use rest_types::{Health, SyncingResponse, SyncingStatus};
 use std::sync::Arc;
 use types::{EthSpec, Slot};
 
 /// Read the version string from the current Lighthouse build.
 pub fn get_version(req: Request<Body>) -> ApiResult {
-    ResponseBuilder::new(&req)?.body_no_ssz(&version::version())
+    ResponseBuilder::new(&req)?.body_no_ssz(&version_with_platform())
 }
 
 pub fn syncing<T: EthSpec>(
diff --git a/beacon_node/rest_api/tests/test.rs b/beacon_node/rest_api/tests/test.rs
@@ -24,7 +24,6 @@ use types::{
     RelativeEpoch, Signature, SignedAggregateAndProof, SignedBeaconBlock, SignedRoot, Slot,
     SubnetId, Validator,
 };
-use version;
 
 type E = MinimalEthSpec;
 
@@ -764,7 +763,11 @@ fn get_version() {
         .block_on(remote_node.http.node().get_version())
         .expect("should fetch eth2 config from http api");
 
-    assert_eq!(version::version(), version, "result should be as expected");
+    assert_eq!(
+        lighthouse_version::version_with_platform(),
+        version,
+        "result should be as expected"
+    );
 }
 
 #[test]
diff --git a/beacon_node/src/cli.rs b/beacon_node/src/cli.rs
@@ -1,11 +1,5 @@
 use clap::{App, Arg};
 
-// Default text included in blocks.
-// Must be 32-bytes or will not build.
-//
-//                              |-------must be this long------|
-const DEFAULT_GRAFFITI: &str = "sigp/lighthouse-0.1.2-prerelease";
-
 pub fn cli_app<'a, 'b>() -> App<'a, 'b> {
     App::new("beacon_node")
         .visible_aliases(&["b", "bn", "beacon"])
@@ -248,9 +242,11 @@ pub fn cli_app<'a, 'b>() -> App<'a, 'b> {
         .arg(
             Arg::with_name("graffiti")
                 .long("graffiti")
-                .help("Specify your custom graffiti to be included in blocks.")
+                .help(
+                    "Specify your custom graffiti to be included in blocks. \
+                    Defaults to the current version and commit, truncated to fit in 32 bytes. "
+                )
                 .value_name("GRAFFITI")
-                .default_value(DEFAULT_GRAFFITI)
                 .takes_value(true)
         )
 }
diff --git a/beacon_node/src/config.rs b/beacon_node/src/config.rs
@@ -6,6 +6,7 @@ use eth2_libp2p::{Enr, Multiaddr};
 use eth2_testnet_config::Eth2TestnetConfig;
 use slog::{crit, info, Logger};
 use ssz::Encode;
+use std::cmp;
 use std::fs;
 use std::net::{IpAddr, Ipv4Addr, ToSocketAddrs};
 use std::net::{TcpListener, UdpSocket};
@@ -350,21 +351,22 @@ pub fn get_config<E: EthSpec>(
         client_config.genesis = ClientGenesis::DepositContract;
     }
 
-    if let Some(graffiti) = cli_args.value_of("graffiti") {
-        let graffiti_bytes = graffiti.as_bytes();
-        if graffiti_bytes.len() > GRAFFITI_BYTES_LEN {
+    let raw_graffiti = if let Some(graffiti) = cli_args.value_of("graffiti") {
+        if graffiti.len() > GRAFFITI_BYTES_LEN {
             return Err(format!(
                 "Your graffiti is too long! {} bytes maximum!",
                 GRAFFITI_BYTES_LEN
             ));
-        } else {
-            // `client_config.graffiti` is initialized by default to be all 0.
-            // We simply copy the bytes from `graffiti_bytes` in there.
-            //
-            // Panic-free because `graffiti_bytes.len()` <= `GRAFFITI_BYTES_LEN`.
-            client_config.graffiti[..graffiti_bytes.len()].copy_from_slice(graffiti_bytes);
         }
-    }
+
+        graffiti.as_bytes()
+    } else {
+        lighthouse_version::VERSION.as_bytes()
+    };
+
+    let trimmed_graffiti_len = cmp::min(raw_graffiti.len(), GRAFFITI_BYTES_LEN);
+    client_config.graffiti[..trimmed_graffiti_len]
+        .copy_from_slice(&raw_graffiti[..trimmed_graffiti_len]);
 
     Ok(client_config)
 }
diff --git a/beacon_node/version/Cargo.toml b/beacon_node/version/Cargo.toml
diff --git a/beacon_node/version/src/lib.rs b/beacon_node/version/src/lib.rs
diff --git a/common/lighthouse_version/Cargo.toml b/common/lighthouse_version/Cargo.toml
@@ -0,0 +1,11 @@
+[package]
+name = "lighthouse_version"
+version = "0.1.0"
+authors = ["Paul Hauner <paul@paulhauner.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+git-version = "0.3.4"
+target_info = "0.1.0"
diff --git a/common/lighthouse_version/src/lib.rs b/common/lighthouse_version/src/lib.rs
@@ -0,0 +1,24 @@
+use git_version::git_version;
+use target_info::Target;
+
+/// Returns the current version of this build of Lighthouse.
+///
+/// A plus-sign (`+`) is appended to the git commit if the tree is dirty.
+///
+/// ## Example
+///
+/// `Lighthouse/v0.2.0-1419501f2+`
+pub const VERSION: &str = git_version!(
+    args = ["--always", "--dirty=+"],
+    prefix = "Lighthouse/v0.2.0/",
+    fallback = "unknown"
+);
+
+/// Returns `VERSION`, but with platform information appended to the end.
+///
+/// ## Example
+///
+/// `Lighthouse/v0.2.0-1419501f2+/x86_64-linux`
+pub fn version_with_platform() -> String {
+    format!("{}/{}-{}", VERSION, Target::arch(), Target::os())
+}
diff --git a/lcli/Cargo.toml b/lcli/Cargo.toml
@@ -34,3 +34,4 @@ eth2_libp2p = { path = "../beacon_node/eth2_libp2p" }
 validator_dir = { path = "../common/validator_dir", features = ["insecure_keys"] }
 rand = "0.7.2"
 eth2_keystore = { path = "../crypto/eth2_keystore" }
+lighthouse_version = { path = "../common/lighthouse_version" }
diff --git a/lcli/src/main.rs b/lcli/src/main.rs
@@ -1,6 +1,5 @@
 #[macro_use]
 extern crate log;
-
 mod change_genesis_time;
 mod check_deposit_data;
 mod deploy_deposit_contract;
@@ -29,6 +28,7 @@ fn main() {
     simple_logger::init_with_level(Level::Info).expect("logger should initialize");
 
     let matches = App::new("Lighthouse CLI Tool")
+        .version(lighthouse_version::VERSION)
         .about(
             "Performs various testing-related tasks, including defining testnets.",
         )
diff --git a/lighthouse/Cargo.toml b/lighthouse/Cargo.toml
@@ -31,7 +31,7 @@ validator_client = { "path" = "../validator_client" }
 account_manager = { "path" = "../account_manager" }
 clap_utils = { path = "../common/clap_utils" }
 eth2_testnet_config = { path = "../common/eth2_testnet_config" }
-git-version = "0.3.4"
+lighthouse_version = { path = "../common/lighthouse_version" }
 
 [dev-dependencies]
 tempfile = "3.1.0"
diff --git a/lighthouse/src/main.rs b/lighthouse/src/main.rs

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ impl Default for Config {`
`131`	`131`	`discv5_config,`
`132`	`132`	`boot_nodes: vec![],`
`133`	`133`	`libp2p_nodes: vec![],`
`134`		`- client_version: version::version(),`
	`134`	`+ client_version: lighthouse_version::version_with_platform(),`
`135`	`135`	`disable_discovery: false,`
`136`	`136`	`topics,`
`137`	`137`	`}`