Merge pull request #408 from plebhash/2026-04-04-reintroduce-mining-device-bin

reintroduce `mining_device` bin

Author: plebhash

integration-tests/Cargo.lock

@@ -26,6 +26,7 @@ tokio-util = { version = "0.7", default-features = false }
 tracing = { version = "0.1.41", default-features = false }
 tracing-subscriber = { version = "0.3.19", default-features = false }
 hex = "0.4.3"
+clap = { version = "^4.5.4", features = ["derive"] }
 
 # Direct dependencies kept only for the embedded `mining_device` module.
 # Remove this block when removing:
@@ -48,6 +49,11 @@ num_cpus = "1"
 [lib]
 path = "lib/mod.rs"
 
+# Binary target preserved from the former standalone `mining_device` crate.
+[[bin]]
+name = "mining_device"
+path = "bin/mining_device.rs"
+
 # Bench targets preserved from the former standalone `mining_device` crate.
 # Remove these entries when the embedded `mining_device` module is deprecated.
 [[bench]]

integration-tests/Cargo.toml

@@ -33,6 +33,27 @@ Note: during the execution of the tests, the `template-provider` directory holds
 binaries (Bitcoin Core and sv2-tp), while test data directories are created in the system temp
 directory.
 
+## Standalone `mining_device` Binary
+
+The embedded `integration_tests_sv2::mining_device` module also exposes a standalone executable
+binary again.
+
+To build it:
+
+```bash
+cargo build --manifest-path=integration-tests/Cargo.toml --release --bin mining_device
+```
+
+The executable will be available at `integration-tests/target/release/mining_device`.
+
+To run it directly through Cargo:
+
+```bash
+cargo run --manifest-path=integration-tests/Cargo.toml --release --bin mining_device -- \
+  --address-pool 127.0.0.1:3333 \
+  --id-device test
+```
+
 ## Writing Custom Integration Tests
 
  - To write your own integration tests using this library, you can install the library as follows:

integration-tests/README.md

@@ -0,0 +1,88 @@
+use clap::Parser;
+use integration_tests_sv2::mining_device::{self, Secp256k1PublicKey};
+use tracing::{info, Level};
+use tracing_subscriber::fmt;
+
+#[derive(Parser, Debug)]
+#[command(version, about, long_about = None)]
+struct Args {
+    #[arg(
+        short,
+        long,
+        help = "Pool pub key, when left empty the pool certificate is not checked"
+    )]
+    pubkey_pool: Option<Secp256k1PublicKey>,
+    #[arg(
+        short,
+        long,
+        help = "Sometimes used by the pool to identify the device"
+    )]
+    id_device: Option<String>,
+    #[arg(
+        short,
+        long,
+        help = "Address of the pool in this format ip:port or domain:port"
+    )]
+    address_pool: String,
+    #[arg(
+        long,
+        help = "This value is used to slow down the cpu miner, it represents the number of micro-seconds that are awaited between hashes",
+        default_value = "0"
+    )]
+    handicap: u32,
+    #[arg(
+        long,
+        help = "User id, used when a new channel is opened, it can be used by the pool to identify the miner"
+    )]
+    id_user: Option<String>,
+    #[arg(
+        long,
+        help = "This floating point number is used to modify the advertised nominal hashrate when opening a channel with the upstream.\
+         \nIf 0.0 < nominal_hashrate_multiplier < 1.0, the CPU miner will advertise a nominal hashrate that is smaller than its real capacity.\
+         \nIf nominal_hashrate_multiplier > 1.0, the CPU miner will advertise a nominal hashrate that is bigger than its real capacity.\
+         \nIf empty, the CPU miner will simply advertise its real capacity."
+    )]
+    nominal_hashrate_multiplier: Option<f32>,
+    #[arg(
+        long,
+        help = "Number of nonces to try per mining loop iteration when fast hashing is available (micro-batching)",
+        default_value = "32"
+    )]
+    nonces_per_call: u32,
+    #[arg(
+        long,
+        help = "Number of worker threads to use for mining. Defaults to logical CPUs minus one (leaves one core free)."
+    )]
+    cores: Option<u32>,
+}
+
+#[tokio::main(flavor = "current_thread")]
+async fn main() {
+    let args = Args::parse();
+    fmt().with_max_level(Level::INFO).init();
+    info!("start");
+
+    mining_device::set_nonces_per_call(args.nonces_per_call);
+
+    if let Some(n) = args.cores {
+        mining_device::set_cores(n);
+    }
+
+    let used = mining_device::effective_worker_count();
+    let total = mining_device::total_logical_cpus();
+    info!(
+        "Using {} worker threads out of {} logical CPUs",
+        used, total
+    );
+
+    mining_device::connect(
+        args.address_pool,
+        args.pubkey_pool,
+        args.id_device,
+        args.id_user,
+        args.handicap,
+        args.nominal_hashrate_multiplier,
+        false,
+    )
+    .await;
+}