mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-01-29 09:08:05 -05:00
146 lines
3.8 KiB
Rust
146 lines
3.8 KiB
Rust
//! Version information for reth.
|
|
use reth_db_api::models::ClientVersion;
|
|
use reth_rpc_types::engine::ClientCode;
|
|
|
|
/// The client code for Reth
|
|
pub const CLIENT_CODE: ClientCode = ClientCode::RH;
|
|
|
|
/// The human readable name of the client
|
|
pub const NAME_CLIENT: &str = "Reth";
|
|
|
|
/// The latest version from Cargo.toml.
|
|
pub const CARGO_PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
|
|
|
|
/// The full SHA of the latest commit.
|
|
pub const VERGEN_GIT_SHA_LONG: &str = env!("VERGEN_GIT_SHA");
|
|
|
|
/// The 8 character short SHA of the latest commit.
|
|
pub const VERGEN_GIT_SHA: &str = const_format::str_index!(VERGEN_GIT_SHA_LONG, ..8);
|
|
|
|
/// The build timestamp.
|
|
pub const VERGEN_BUILD_TIMESTAMP: &str = env!("VERGEN_BUILD_TIMESTAMP");
|
|
|
|
/// The short version information for reth.
|
|
///
|
|
/// - The latest version from Cargo.toml
|
|
/// - The short SHA of the latest commit.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```text
|
|
/// 0.1.0 (defa64b2)
|
|
/// ```
|
|
pub const SHORT_VERSION: &str = const_format::concatcp!(
|
|
env!("CARGO_PKG_VERSION"),
|
|
env!("RETH_VERSION_SUFFIX"),
|
|
" (",
|
|
VERGEN_GIT_SHA,
|
|
")"
|
|
);
|
|
|
|
/// The long version information for reth.
|
|
///
|
|
/// - The latest version from Cargo.toml
|
|
/// - The long SHA of the latest commit.
|
|
/// - The build datetime
|
|
/// - The build features
|
|
/// - The build profile
|
|
///
|
|
/// # Example:
|
|
///
|
|
/// ```text
|
|
/// Version: 0.1.0
|
|
/// Commit SHA: defa64b2
|
|
/// Build Timestamp: 2023-05-19T01:47:19.815651705Z
|
|
/// Build Features: jemalloc
|
|
/// Build Profile: maxperf
|
|
/// ```
|
|
pub const LONG_VERSION: &str = const_format::concatcp!(
|
|
"Version: ",
|
|
env!("CARGO_PKG_VERSION"),
|
|
env!("RETH_VERSION_SUFFIX"),
|
|
"\n",
|
|
"Commit SHA: ",
|
|
VERGEN_GIT_SHA_LONG,
|
|
"\n",
|
|
"Build Timestamp: ",
|
|
env!("VERGEN_BUILD_TIMESTAMP"),
|
|
"\n",
|
|
"Build Features: ",
|
|
env!("VERGEN_CARGO_FEATURES"),
|
|
"\n",
|
|
"Build Profile: ",
|
|
build_profile_name()
|
|
);
|
|
|
|
/// The version information for reth formatted for P2P (devp2p).
|
|
///
|
|
/// - The latest version from Cargo.toml
|
|
/// - The target triple
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```text
|
|
/// reth/v{major}.{minor}.{patch}-{sha1}/{target}
|
|
/// ```
|
|
/// e.g.: `reth/v0.1.0-alpha.1-428a6dc2f/aarch64-apple-darwin`
|
|
pub(crate) const P2P_CLIENT_VERSION: &str = const_format::concatcp!(
|
|
"reth/v",
|
|
env!("CARGO_PKG_VERSION"),
|
|
"-",
|
|
VERGEN_GIT_SHA,
|
|
"/",
|
|
env!("VERGEN_CARGO_TARGET_TRIPLE")
|
|
);
|
|
|
|
/// The default extradata used for payload building.
|
|
///
|
|
/// - The latest version from Cargo.toml
|
|
/// - The OS identifier
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```text
|
|
/// reth/v{major}.{minor}.{patch}/{OS}
|
|
/// ```
|
|
pub fn default_extradata() -> String {
|
|
format!("reth/v{}/{}", env!("CARGO_PKG_VERSION"), std::env::consts::OS)
|
|
}
|
|
|
|
/// The default client version accessing the database.
|
|
pub fn default_client_version() -> ClientVersion {
|
|
ClientVersion {
|
|
version: CARGO_PKG_VERSION.to_string(),
|
|
git_sha: VERGEN_GIT_SHA.to_string(),
|
|
build_timestamp: VERGEN_BUILD_TIMESTAMP.to_string(),
|
|
}
|
|
}
|
|
|
|
pub(crate) const fn build_profile_name() -> &'static str {
|
|
// Derived from https://stackoverflow.com/questions/73595435/how-to-get-profile-from-cargo-toml-in-build-rs-or-at-runtime
|
|
// We split on the path separator of the *host* machine, which may be different from
|
|
// `std::path::MAIN_SEPARATOR_STR`.
|
|
const OUT_DIR: &str = env!("OUT_DIR");
|
|
let unix_parts = const_format::str_split!(OUT_DIR, '/');
|
|
if unix_parts.len() >= 4 {
|
|
unix_parts[unix_parts.len() - 4]
|
|
} else {
|
|
let win_parts = const_format::str_split!(OUT_DIR, '\\');
|
|
win_parts[win_parts.len() - 4]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn assert_extradata_less_32bytes() {
|
|
let extradata = default_extradata();
|
|
assert!(
|
|
extradata.as_bytes().len() <= 32,
|
|
"extradata must be less than 32 bytes: {extradata}"
|
|
)
|
|
}
|
|
}
|