feat(l1): properly format client version

cmd/ethrex/Cargo.toml

@@ -2,6 +2,7 @@
 name = "ethrex"
 version = "0.1.0"
 edition = "2021"
+build = "build.rs"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -21,7 +22,7 @@ hex.workspace = true
 tracing.workspace = true
 tracing-subscriber.workspace = true
 k256.workspace = true
-clap = { version = "4.3", features = ["derive", "env"] }
+clap = { version = "4.3", features = ["derive", "env", "string"] }
 clap_complete = "4.5.17"
 eyre = "0.6.12"
 directories = "5.0.1"
@@ -83,3 +84,6 @@ criterion = { version = "0.5.1", features = ["html_reports"] }
 path = "../../bench/criterion_benchmark.rs"
 name = "criterion_benchmark"
 harness = false
+
+[build-dependencies]
+vergen = { version = "9.0.0", features = ["rustc"] }    

cmd/ethrex/build.rs

@@ -0,0 +1,14 @@
+use std::error::Error;
+use vergen::{Emitter, RustcBuilder};
+
+// This build code is needed to add some env vars in order to construct the node client version
+// VERGEN_RUSTC_COMMIT_HASH to get the commit hash
+// VERGEN_RUSTC_HOST_TRIPLE to get the build OS
+// VERGEN_RUSTC_SEMVER to get the rustc version
+
+fn main() -> Result<(), Box<dyn Error>> {
+    let rustc = RustcBuilder::all_rustc()?;
+
+    Emitter::default().add_instructions(&rustc)?.emit()?;
+    Ok(())
+}

cmd/ethrex/cli.rs

@@ -12,18 +12,16 @@ use tracing::{info, warn, Level};
 
 use crate::{
     initializers::{init_blockchain, init_store},
-    utils::{self, set_datadir},
+    utils::{self, get_client_version, set_datadir},
     DEFAULT_DATADIR,
 };
 
 #[cfg(any(feature = "l2", feature = "based"))]
 use crate::l2;
 
-pub const VERSION_STRING: &str = env!("CARGO_PKG_VERSION");
-
 #[allow(clippy::upper_case_acronyms)]
 #[derive(ClapParser)]
-#[command(name="ethrex", author = "Lambdaclass", version=VERSION_STRING, about, about = "ethrex Execution client")]
+#[command(name="ethrex", author = "Lambdaclass", version=get_client_version(), about, about = "ethrex Execution client")]
 pub struct CLI {
     #[command(flatten)]
     pub opts: Options,

cmd/ethrex/initializers.rs

@@ -1,7 +1,10 @@
 use crate::{
     cli::Options,
     networks,
-    utils::{parse_socket_addr, read_genesis_file, read_jwtsecret_file, read_known_peers},
+    utils::{
+        get_client_version, parse_socket_addr, read_genesis_file, read_jwtsecret_file,
+        read_known_peers,
+    },
 };
 use ethrex_blockchain::Blockchain;
 use ethrex_p2p::{
@@ -157,6 +160,7 @@ pub async fn init_rpc_api(
         local_p2p_node,
         local_node_record,
         syncer,
+        get_client_version(),
         #[cfg(feature = "based")]
         get_gateway_http_client(&l2_opts.based_opts),
         #[cfg(feature = "based")]
@@ -229,6 +233,7 @@ pub async fn init_network(
         peer_table.clone(),
         store,
         blockchain,
+        get_client_version(),
     )
     .await
     .expect("Network starts");

cmd/ethrex/utils.rs

@@ -135,3 +135,14 @@ pub fn parse_hex(s: &str) -> eyre::Result<Bytes, FromHexError> {
         None => hex::decode(s).map(Into::into),
     }
 }
+
+pub fn get_client_version() -> String {
+    format!(
+        "{}/v{}-develop-{}/{}/rustc-v{}",
+        env!("CARGO_PKG_NAME"),
+        env!("CARGO_PKG_VERSION"),
+        &env!("VERGEN_RUSTC_COMMIT_HASH")[0..6],
+        env!("VERGEN_RUSTC_HOST_TRIPLE"),
+        env!("VERGEN_RUSTC_SEMVER")
+    )
+}

crates/networking/p2p/discv4/server.rs

@@ -701,6 +701,7 @@ pub(super) mod tests {
             storage,
             blockchain,
             broadcast,
+            client_version: "ethrex/test".to_string(),
         };
 
         let discv4 = Discv4Server::try_new(ctx.clone()).await?;

crates/networking/p2p/network.rs

@@ -52,8 +52,10 @@ pub struct P2PContext {
     pub(crate) broadcast: RLPxConnBroadcastSender,
     pub local_node: Node,
     pub enr_seq: u64,
+    pub client_version: String,
 }
 
+#[allow(clippy::too_many_arguments)]
 pub async fn start_network(
     local_node: Node,
     tracker: TaskTracker,
@@ -62,6 +64,7 @@ pub async fn start_network(
     peer_table: Arc<Mutex<KademliaTable>>,
     storage: Store,
     blockchain: Arc<Blockchain>,
+    client_version: String,
 ) -> Result<(), NetworkError> {
     let (channel_broadcast_send_end, _) = tokio::sync::broadcast::channel::<(
         tokio::task::Id,
@@ -80,6 +83,7 @@ pub async fn start_network(
         storage,
         blockchain,
         broadcast: channel_broadcast_send_end,
+        client_version,
     };
     let discovery = Discv4Server::try_new(context.clone())
         .await

crates/networking/p2p/rlpx/connection.rs

@@ -84,6 +84,7 @@ pub(crate) struct RLPxConnection<S> {
     next_periodic_ping: Instant,
     next_tx_broadcast: Instant,
     broadcasted_txs: HashSet<H256>,
+    client_version: String,
     /// Send end of the channel used to broadcast messages
     /// to other connected peers, is ok to have it here,
     /// since internally it's an Arc.
@@ -96,13 +97,15 @@ pub(crate) struct RLPxConnection<S> {
 }
 
 impl<S: AsyncWrite + AsyncRead + std::marker::Unpin> RLPxConnection<S> {
+    #[allow(clippy::too_many_arguments)]
     pub fn new(
         signer: SigningKey,
         node: Node,
         stream: S,
         codec: RLPxCodec,
         storage: Store,
         blockchain: Arc<Blockchain>,
+        client_version: String,
         connection_broadcast: RLPxConnBroadcastSender,
     ) -> Self {
         Self {
@@ -117,6 +120,7 @@ impl<S: AsyncWrite + AsyncRead + std::marker::Unpin> RLPxConnection<S> {
             next_periodic_ping: Instant::now() + PERIODIC_TASKS_CHECK_INTERVAL,
             next_tx_broadcast: Instant::now() + PERIODIC_TX_BROADCAST_INTERVAL,
             broadcasted_txs: HashSet::new(),
+            client_version,
             connection_broadcast_send: connection_broadcast,
         }
     }
@@ -245,6 +249,7 @@ impl<S: AsyncWrite + AsyncRead + std::marker::Unpin> RLPxConnection<S> {
         let hello_msg = Message::Hello(p2p::HelloMessage::new(
             SUPPORTED_CAPABILITIES.to_vec(),
             PublicKey::from(self.signer.verifying_key()),
+            self.client_version.clone(),
         ));
 
         self.send(hello_msg).await?;

crates/networking/p2p/rlpx/handshake.rs

@@ -59,6 +59,7 @@ where
         codec,
         context.storage,
         context.blockchain,
+        context.client_version,
         context.broadcast,
     ))
 }
@@ -86,6 +87,7 @@ where
         codec,
         context.storage,
         context.blockchain,
+        context.client_version,
         context.broadcast,
     ))
 }

crates/networking/p2p/rlpx/p2p.rs

@@ -50,13 +50,15 @@ impl RLPDecode for Capability {
 pub(crate) struct HelloMessage {
     pub(crate) capabilities: Vec<(Capability, u8)>,
     pub(crate) node_id: PublicKey,
+    pub(crate) client_id: String,
 }
 
 impl HelloMessage {
-    pub fn new(capabilities: Vec<(Capability, u8)>, node_id: PublicKey) -> Self {
+    pub fn new(capabilities: Vec<(Capability, u8)>, node_id: PublicKey, client_id: String) -> Self {
         Self {
             capabilities,
             node_id,
+            client_id,
         }
     }
 }
@@ -66,7 +68,7 @@ impl RLPxMessage for HelloMessage {
     fn encode(&self, mut buf: &mut dyn BufMut) -> Result<(), RLPEncodeError> {
         Encoder::new(&mut buf)
             .encode_field(&5_u8) // protocolVersion
-            .encode_field(&"Ethrex/0.1.0") // clientId
+            .encode_field(&self.client_id) // clientId
             .encode_field(&self.capabilities) // capabilities
             .encode_field(&0u8) // listenPort (ignored)
             .encode_field(&pubkey2id(&self.node_id)) // nodeKey
@@ -81,8 +83,7 @@ impl RLPxMessage for HelloMessage {
 
         assert_eq!(protocol_version, 5, "only protocol version 5 is supported");
 
-        let (_client_id, decoder): (String, _) = decoder.decode_field("clientId")?;
-        // TODO: store client id for debugging purposes
+        let (client_id, decoder): (String, _) = decoder.decode_field("clientId")?;
 
         // [[cap1, capVersion1], [cap2, capVersion2], ...]
         let (capabilities, decoder): (Vec<(Capability, u8)>, _) =
@@ -99,6 +100,7 @@ impl RLPxMessage for HelloMessage {
         Ok(Self::new(
             capabilities,
             id2pubkey(node_id).ok_or(RLPDecodeError::MalformedData)?,
+            client_id,
         ))
     }
 }

crates/networking/rpc/admin/mod.rs

@@ -35,6 +35,7 @@ pub fn node_info(
     storage: Store,
     local_node: Node,
     local_node_record: NodeRecord,
+    client_version: String,
 ) -> Result<Value, RpcErr> {
     let enode_url = local_node.enode_url();
     let enr_url = match local_node_record.enr_url() {
@@ -52,7 +53,7 @@ pub fn node_info(
         enode: enode_url,
         enr: enr_url,
         id: hex::encode(Keccak256::digest(local_node.node_id.as_bytes())),
-        name: "ethrex/0.1.0/rust1.82".to_string(),
+        name: client_version,
         ip: local_node.ip.to_string(),
         ports: Ports {
             discovery: local_node.udp_port,

crates/networking/rpc/eth/gas_price.rs

@@ -1,5 +1,4 @@
 use crate::eth::fee_calculator::estimate_gas_tip;
-
 use crate::rpc::{RpcApiContext, RpcHandler};
 use crate::utils::RpcErr;
 use serde_json::Value;

crates/networking/rpc/eth/max_priority_fee.rs

@@ -67,6 +67,7 @@ mod tests {
             local_node_record: example_local_node_record(),
             active_filters: Default::default(),
             syncer: Arc::new(SyncManager::dummy()),
+            client_version: "ethrex/test".to_string(),
             #[cfg(feature = "based")]
             gateway_eth_client: EthClient::new(""),
             #[cfg(feature = "based")]

crates/networking/rpc/lib.rs

@@ -8,7 +8,6 @@ mod eth;
 pub mod l2;
 mod net;
 mod rpc;
-mod web3;
 
 pub mod clients;
 pub mod types;