ci: add check for consts and stacks-inspect command to dump constants

Author: kantai

.github/workflows/ci.yml

@@ -164,6 +164,38 @@ jobs:
       - check-release
     uses: ./.github/workflows/stacks-core-tests.yml
 
+  ## Checks to run on built binaries
+  ##
+  ## Runs when:
+  ##   - it is a release run
+  ##   or:
+  ##     - it is not a release run
+  ##       and any of:
+  ##         - this workflow is called manually
+  ##         - PR is opened
+  ##         - PR added to merge queue
+  ##         - commit to either (development, next, master) branch
+  stacks-core-build-tests:
+    if: |
+      needs.check-release.outputs.is_release == 'true' || (
+        github.event_name == 'workflow_dispatch' ||
+        github.event_name == 'pull_request' ||
+        github.event_name == 'merge_group' ||
+        (
+          contains('
+            refs/heads/master
+            refs/heads/develop
+            refs/heads/next
+          ', github.event.pull_request.head.ref) &&
+          github.event_name == 'push'
+        )
+      )
+    name: Stacks Core Build Tests
+    needs:
+      - rustfmt
+      - check-release
+    uses: ./.github/workflows/core-build-tests.yml
+
   bitcoin-tests:
     if: |
       needs.check-release.outputs.is_release == 'true' || (

.github/workflows/core-build-tests.yml

@@ -0,0 +1,33 @@
+name: Core build tests
+
+# Only run when:
+#   - PRs are (re)opened against develop branch
+on:
+  workflow_call:
+
+jobs:
+  check-consts:
+    name: Check the constants from stacks-inspect
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the latest code
+        id: git_checkout
+        uses: actions/checkout@v3
+      - name: Define Rust Toolchain
+        id: define_rust_toolchain
+        run: echo "RUST_TOOLCHAIN=$(cat ./rust-toolchain)" >> $GITHUB_ENV
+      - name: Setup Rust Toolchain
+        id: setup_rust_toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
+      - name: Build the binaries
+        id: build
+        run: |
+          cargo build
+      - name: Dump constants JSON
+        id: consts-dump
+        run: cargo run --bin stacks-inspect -- dump-consts | tee out.json
+      - name: Set expected constants JSON
+        id: expects-json
+        run: diff out.json ./sample/expected_consts.json

sample/expected_consts.json

@@ -0,0 +1,12 @@
+{
+  "chain_id_mainnet": 1,
+  "chain_id_testnet": 2147483648,
+  "microstacks_per_stacks": 1000000,
+  "miner_reward_maturity": 100,
+  "network_id_mainnet": 385875968,
+  "network_id_testnet": 4278190080,
+  "peer_version_mainnet_major": 402653184,
+  "peer_version_testnet_major": 4207599104,
+  "signer_slots_per_user": 13,
+  "stacks_epoch_max": 9223372036854775807
+}

stackslib/src/main.rs

@@ -1614,12 +1614,35 @@ check if the associated microblocks can be downloaded
         process::exit(0);
     }
 
+    if argv[1] == "dump-consts" {
+        dump_consts();
+    }
+
     if argv.len() < 4 {
         eprintln!("Usage: {} blockchain network working_dir", argv[0]);
         process::exit(1);
     }
 }
 
+#[cfg_attr(test, mutants::skip)]
+pub fn dump_consts() {
+    use stacks_common::consts;
+    let json_out = json!({
+        "miner_reward_maturity": consts::MINER_REWARD_MATURITY,
+        "chain_id_mainnet": consts::CHAIN_ID_MAINNET,
+        "chain_id_testnet": consts::CHAIN_ID_TESTNET,
+        "signer_slots_per_user": consts::SIGNER_SLOTS_PER_USER,
+        "network_id_mainnet": consts::NETWORK_ID_MAINNET,
+        "network_id_testnet": consts::NETWORK_ID_TESTNET,
+        "microstacks_per_stacks": consts::MICROSTACKS_PER_STACKS,
+        "stacks_epoch_max": consts::STACKS_EPOCH_MAX,
+        "peer_version_mainnet_major": consts::PEER_VERSION_MAINNET_MAJOR,
+        "peer_version_testnet_major": consts::PEER_VERSION_TESTNET_MAJOR,
+    });
+    println!("{}", serde_json::to_string_pretty(&json_out).unwrap());
+    process::exit(0);
+}
+
 #[cfg_attr(test, mutants::skip)]
 pub fn tip_mine() {
     let argv: Vec<String> = env::args().collect();