feat: use versions.yaml with a build script

Author: hstove

Cargo.lock

@@ -68,7 +68,7 @@ The timing of the next Stacking cycle can be found [here](https://stx.eco/dao/to
 
    - Create a chore branch from `release/X.Y.Z.A.n`, ex: `chore/X.Y.Z.A.n-changelog`.
    - Add summaries of all Pull Requests to the `Added`, `Changed` and `Fixed` sections.
-   - Update the `STACKS_VERSION` string in [stackslib/src/lib.rs](../stackslib/src/lib.rs) to match this release.
+   - Update the `stacks_node_version` string in [versions.toml](../versions.toml) to match this release.
 
      - Pull requests merged into `develop` can be found [here](https://github.com/stacks-network/stacks-core/pulls?q=is%3Apr+is%3Aclosed+base%3Adevelop+sort%3Aupdated-desc).
 

docs/release-process.md

@@ -53,6 +53,7 @@ use blockstack_lib::version_string;
 use clarity::codec::StacksMessageCodec;
 use clarity::vm::types::QualifiedContractIdentifier;
 use lazy_static::lazy_static;
+use stacks_common::versions::STACKS_SIGNER_VERSION;
 
 pub use crate::error::{EventError, RPCError};
 pub use crate::events::{
@@ -63,9 +64,6 @@ pub use crate::runloop::{RunningSigner, Signer, SignerRunLoop};
 pub use crate::session::{SignerSession, StackerDBSession};
 pub use crate::signer_set::{Error as ParseSignerEntriesError, SignerEntries};
 
-/// The version string for the signer
-pub const SIGNER_VERSION: &str = "3.0.0.0.0.1";
-
 /// A trait for message slots used for signer communication
 pub trait MessageSlotID: Sized + Eq + Hash + Debug + Copy {
     /// The contract identifier for the message slot in stacker db
@@ -83,7 +81,7 @@ pub trait SignerMessage<T: MessageSlotID>: StacksMessageCodec {
 lazy_static! {
     /// The version string for the signer
     pub static ref VERSION_STRING: String = {
-        let pkg_version = option_env!("STACKS_NODE_VERSION").or(Some(SIGNER_VERSION));
+        let pkg_version = option_env!("STACKS_NODE_VERSION").or(Some(STACKS_SIGNER_VERSION));
         version_string("stacks-signer", pkg_version)
     };
 }
@@ -92,7 +90,7 @@ lazy_static! {
 fn test_version_string() {
     let version = VERSION_STRING.to_string();
     assert_eq!(
-        version.contains(format!("stacks-signer {}", SIGNER_VERSION).as_str()),
+        version.contains(format!("stacks-signer {}", STACKS_SIGNER_VERSION).as_str()),
         true
     );
 }

libsigner/src/libsigner.rs

@@ -12,6 +12,7 @@ keywords = [ "stacks", "stx", "bitcoin", "crypto", "blockstack", "decentralized"
 readme = "README.md"
 resolver = "2"
 edition = "2021"
+build = "build.rs"
 
 [lib]
 name = "stacks_common"
@@ -79,6 +80,9 @@ bech32_std = []
 bech32_strict = []
 strason = []
 
+[build-dependencies]
+toml = "0.5.6"
+
 [target.'cfg(all(any(target_arch = "x86_64", target_arch = "x86", target_arch = "aarch64"), not(any(target_os="windows"))))'.dependencies]
 sha2 = { version = "0.10", features = ["asm"] }
 

stacks-common/Cargo.toml

@@ -0,0 +1,71 @@
+use std::path::Path;
+use std::{env, fs};
+use toml::Value;
+
+fn main() {
+    let toml_content =
+        fs::read_to_string("../versions.toml").expect("Failed to read versions.toml");
+
+    let config: Value = toml::from_str(&toml_content).expect("Failed to parse TOML");
+
+    let mut rust_code = String::from("// Auto-generated code from versions.toml\n\n");
+
+    fn generate_constants(value: &Value, prefix: &str, code: &mut String) {
+        match value {
+            Value::Table(table) => {
+                for (key, val) in table {
+                    let new_prefix = if prefix.is_empty() {
+                        key.to_string()
+                    } else {
+                        format!("{}_{}", prefix, key)
+                    };
+                    generate_constants(val, &new_prefix, code);
+                }
+            }
+            Value::Array(arr) => {
+                code.push_str(&format!(
+                    "pub const {}: &[&str] = &[{}];\n",
+                    prefix.to_uppercase(),
+                    arr.iter()
+                        .map(|v| format!("\"{}\"", v.as_str().unwrap_or("")))
+                        .collect::<Vec<_>>()
+                        .join(", ")
+                ));
+            }
+            _ => {
+                let const_value = match value {
+                    Value::String(s) => format!("\"{}\"", s),
+                    Value::Integer(n) => n.to_string(),
+                    Value::Float(f) => f.to_string(),
+                    Value::Boolean(b) => b.to_string(),
+                    _ => "\"\"".to_string(),
+                };
+                code.push_str(&format!(
+                    "pub const {}: {} = {};\n",
+                    prefix.to_uppercase(),
+                    if value.is_str() {
+                        "&str"
+                    } else if value.is_integer() {
+                        "i64"
+                    } else if value.is_float() {
+                        "f64"
+                    } else if value.is_bool() {
+                        "bool"
+                    } else {
+                        "&str"
+                    },
+                    const_value
+                ));
+            }
+        }
+    }
+
+    generate_constants(&config, "", &mut rust_code);
+
+    let out_dir = env::var_os("OUT_DIR").unwrap();
+    let dest_path = Path::new(&out_dir).join("versions.rs");
+    fs::write(&dest_path, rust_code).expect("Failed to write generated code");
+
+    // Tell Cargo to rerun this script if the TOML file changes
+    println!("cargo:rerun-if-changed=../versions.toml");
+}

stacks-common/build.rs

@@ -95,6 +95,10 @@ pub mod consts {
     pub const NETWORK_ID_TESTNET: u32 = 0xff000000;
 }
 
+pub mod versions {
+    include!(concat!(env!("OUT_DIR"), "/versions.rs"));
+}
+
 /// This test asserts that the constant above doesn't change.
 /// This exists because the constant above is used by Epoch 2.5 instantiation code.
 ///

stacks-common/src/libcommon.rs

@@ -67,7 +67,7 @@ The timing of the next Stacking cycle can be found [here](https://stx.eco/dao/to
 
    - Create a chore branch from `release/signer-X.Y.Z.A.n.x`, ex: `chore/signer-X.Y.Z.A.n.x-changelog`.
    - Add summaries of all Pull Requests to the `Added`, `Changed` and `Fixed` sections.
-   - Update the `SIGNER_VERSION` string in [libsigner/src/libsigner.rs](../libsigner/src/libsigner.rs) to match this release.
+   - Update the `stacks_signer_version` string in [versions.toml](../versions.toml) to match this release.
 
      - Pull requests merged into `develop` can be found [here](https://github.com/stacks-network/stacks-core/pulls?q=is%3Apr+is%3Aclosed+base%3Adevelop+sort%3Aupdated-desc).
 

stacks-signer/release-process.md

@@ -45,6 +45,7 @@ extern crate stacks_common;
 #[macro_use]
 pub extern crate clarity;
 
+use stacks_common::versions::STACKS_NODE_VERSION;
 pub use stacks_common::{address, codec, types, util};
 
 #[macro_use]
@@ -78,11 +79,8 @@ const BUILD_TYPE: &'static str = "debug";
 #[cfg(not(debug_assertions))]
 const BUILD_TYPE: &'static str = "release";
 
-/// The version string for the stackslib
-pub const STACKS_VERSION: &str = "3.0.0.0.0";
-
 pub fn version_string(pkg_name: &str, pkg_version: Option<&str>) -> String {
-    let pkg_version = pkg_version.unwrap_or(STACKS_VERSION);
+    let pkg_version = pkg_version.unwrap_or(STACKS_NODE_VERSION);
     let git_branch = GIT_BRANCH
         .map(|x| format!("{}", x))
         .unwrap_or("".to_string());

stackslib/src/lib.rs

@@ -0,0 +1,4 @@
+# Update these values when a new release is created.
+# `stacks-common/build.rs` will automatically update `versions.rs` with these values.
+stacks_node_version = "3.0.0.0.2"
+stacks_signer_version = "3.0.0.0.2.0"