Merge pull request #3742 from ChorusOne/feat-add-version-endpoint

Add version endpoint to get build info

Author: vicsn

Cargo.lock

@@ -54,6 +54,10 @@ default-features = false
 [workspace.dependencies.anyhow]
 version = "1.0"
 
+[workspace.dependencies.built]
+version = "0.8"
+features = ["git2"]
+
 [workspace.dependencies.clap]
 version = "4.4"
 default-features = false

Cargo.toml

@@ -113,3 +113,6 @@ workspace = true
 
 [dev-dependencies.base64]
 workspace = true
+
+[build-dependencies.built]
+workspace = true

node/rest/Cargo.toml

@@ -0,0 +1,18 @@
+// Copyright (c) 2019-2025 Provable Inc.
+// This file is part of the snarkOS library.
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at:
+
+// http://www.apache.org/licenses/LICENSE-2.0
+
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+fn main() {
+    built::write_built_file().expect("Failed to acquire build-time information");
+}

node/rest/build.rs

@@ -23,6 +23,8 @@ pub use helpers::*;
 
 mod routes;
 
+mod version;
+
 use snarkos_node_cdn::CdnBlockSync;
 use snarkos_node_consensus::Consensus;
 use snarkos_node_router::{
@@ -212,6 +214,7 @@ impl<N: Network, C: ConsensusStorage<N>, R: Routing<N>> Rest<N, C, R> {
             .route(&format!("/{network}/sync/requests/list"), get(Self::get_sync_requests_list))
 
             // GET misc endpoints.
+            .route(&format!("/{network}/version"), get(Self::get_version))
             .route(&format!("/{network}/blocks"), get(Self::get_blocks))
             .route(&format!("/{network}/height/{{hash}}"), get(Self::get_height))
             .route(&format!("/{network}/memoryPool/transmissions"), get(Self::get_memory_pool_transmissions))

node/rest/src/lib.rs

@@ -29,6 +29,8 @@ use std::collections::HashMap;
 #[cfg(not(feature = "serial"))]
 use rayon::prelude::*;
 
+use version::VersionInfo;
+
 /// The `get_blocks` query object.
 #[derive(Deserialize, Serialize)]
 pub(crate) struct BlockRange {
@@ -70,6 +72,11 @@ struct SyncStatus<'a> {
 }
 
 impl<N: Network, C: ConsensusStorage<N>, R: Routing<N>> Rest<N, C, R> {
+    // GET /<network>/version
+    pub(crate) async fn get_version() -> ErasedJson {
+        ErasedJson::pretty(VersionInfo::get())
+    }
+
     // Get /<network>/consensus_version
     pub(crate) async fn get_consensus_version(State(rest): State<Self>) -> Result<ErasedJson, RestError> {
         Ok(ErasedJson::pretty(N::CONSENSUS_VERSION(rest.ledger.latest_height())? as u16))

node/rest/src/routes.rs

@@ -0,0 +1,46 @@
+// Copyright (c) 2019-2025 Provable Inc.
+// This file is part of the snarkOS library.
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at:
+
+// http://www.apache.org/licenses/LICENSE-2.0
+
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use serde::Serialize;
+use std::sync::OnceLock;
+
+// Include the generated build information
+mod built_info {
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}
+
+// Cache for version info to avoid repeated string allocations
+static VERSION_INFO: OnceLock<VersionInfo> = OnceLock::new();
+
+#[derive(Clone, Debug, Serialize)]
+pub struct VersionInfo {
+    /// The version from Cargo.toml
+    pub version: String,
+    /// Git commit hash
+    pub git_commit: String,
+    /// Git branch name
+    pub git_branch: String,
+}
+
+impl VersionInfo {
+    /// Get the cached version information
+    pub fn get() -> &'static VersionInfo {
+        VERSION_INFO.get_or_init(|| VersionInfo {
+            version: built_info::PKG_VERSION.to_string(),
+            git_commit: built_info::GIT_COMMIT_HASH.unwrap_or("unknown").to_string(),
+            git_branch: built_info::GIT_HEAD_REF.unwrap_or("unknown").to_string(),
+        })
+    }
+}