Merge pull request #6519 from Jiloc/chore/move-stacks-inspect-to-contrib

chore: move `stacks-inspect` to contrib

Author: Jiloc

Cargo.lock

@@ -11,6 +11,7 @@ members = [
     "libsigner",
     "stacks-signer",
     "stacks-node",
+    "contrib/stacks-inspect"
 ]
 
 exclude = ["contrib/tools/config-docs-generator"]

Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "stacks-inspect"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+stackslib = { package = "stackslib", path = "../../stackslib", default-features = false }
+clarity = { path = "../../clarity", default-features = false }
+libstackerdb = { path = "../../libstackerdb", default-features = false }
+stacks-common = { path = "../../stacks-common", default-features = false }
+rusqlite = { workspace = true }
+serde_json = { workspace = true }
+slog = { workspace = true }
+
+[target.'cfg(not(any(target_os = "macos", target_os = "windows", target_arch = "arm")))'.dependencies]
+tikv-jemallocator = { workspace = true }
+
+[dev-dependencies]
+mutants = "0.0.3"

contrib/stacks-inspect/Cargo.toml

@@ -0,0 +1,36 @@
+# stacks-inspect
+
+A multifunction inspection CLI for Stacks chain data and networking.
+
+Highlights:
+- Decode primitives: Bitcoin headers/txs/blocks, Stacks blocks/microblocks, P2P net messages
+- Chain queries: ancestors, MARF lookups, tenure info, PoX anchor evaluation
+- Mining helpers: `try-mine`, `tip-mine`, sortition (anti-MEV) analysis
+- Shadow chain tools: build, patch, repair, and verify shadow chainstate
+- Replay: re-execute blocks and microblocks for diagnostics
+
+Build:
+```bash
+cargo build -p stacks-inspect
+```
+
+Basic usage:
+```bash
+# Show version
+./target/debug/stacks-inspect --version
+
+# Example: decode a bitcoin header from file
+./target/debug/stacks-inspect decode-bitcoin-header <HEIGHT> <PATH>
+
+# Example: analyze anti-MEV behavior over a height range
+./target/debug/stacks-inspect analyze-sortition-mev <burn_db> <sort_db> <chainstate_db> <start> <end> [miner advantage ...]
+```
+
+For detailed commands and flags, run:
+```bash
+./target/debug/stacks-inspect --help
+```
+
+Notes:
+- Some commands expect mainnet data paths by default and may require specific network contexts.
+- Operations that write data (e.g., shadow chain tools) are destructive—use copies of data directories when experimenting.