Split keygen into a create and a binary (#1426)

Split so it can be inherited from other binaries
FuelLabs/sway#5170

.github/workflows/ci.yml

@@ -478,13 +478,13 @@ jobs:
       - name: Build fuel-core and fuel-core-keygen
         run: |
           cross build --profile=release --target ${{ matrix.job.target }} --no-default-features --features "production" -p fuel-core-bin
-          cross build --profile=release --target ${{ matrix.job.target }} -p fuel-core-keygen
+          cross build --profile=release --target ${{ matrix.job.target }} -p fuel-core-keygen-bin
 
       - name: Strip release binary linux x86_64
         if: matrix.job.platform == 'linux'
         run: |
           strip "target/${{ matrix.job.target }}/release/fuel-core"
-          strip "target/${{ matrix.job.target }}/release/fuel-core-keygen"
+          strip "target/${{ matrix.job.target }}/release/fuel-core-keygen-bin"
 
       - name: Strip release binary aarch64-linux-gnu
         if: matrix.job.target == 'aarch64-unknown-linux-gnu'
@@ -498,13 +498,13 @@ jobs:
           "$PWD/target:/target:Z" \
           aarch64-linux-gnu:latest \
           aarch64-linux-gnu-strip \
-          /target/aarch64-unknown-linux-gnu/release/fuel-core-keygen
+          /target/aarch64-unknown-linux-gnu/release/fuel-core-keygen-bin
 
       - name: Strip release binary mac
         if: matrix.job.os == 'macos-latest'
         run: |
           strip -x "target/${{ matrix.job.target }}/release/fuel-core"
-          strip -x "target/${{ matrix.job.target }}/release/fuel-core-keygen"
+          strip -x "target/${{ matrix.job.target }}/release/fuel-core-keygen-bin"
 
       - name: Prepare Binary Artifact
         env:
@@ -523,7 +523,7 @@ jobs:
           # create zip file
           mkdir -pv "$ARTIFACT"
           cp "target/${{ matrix.job.target }}/release/fuel-core" "$ARTIFACT"
-          cp "target/${{ matrix.job.target }}/release/fuel-core-keygen" "$ARTIFACT"
+          cp "target/${{ matrix.job.target }}/release/fuel-core-keygen-bin" "$ARTIFACT"
           tar -czvf "$ZIP_FILE_NAME" "$ARTIFACT"
 
       - name: Upload Binary Artifact
@@ -604,4 +604,4 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions-rs/audit-check@v1
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -13,6 +13,7 @@ Description of the upcoming release here.
 - [#1436](https://github.com/FuelLabs/fuel-core/pull/1436): Add a github action to continuously test beta-4.
 - [#1430](https://github.com/FuelLabs/fuel-core/pull/1430): Add "sanity" benchmarks for crypto opcodes.
 - [#1432](https://github.com/FuelLabs/fuel-core/pull/1432): Add a new `--api-request-timeout` argument to control TTL for GraphQL requests.
+- [#1426](https://github.com/FuelLabs/fuel-core/pull/1426) Split keygen into a create and a binary
 - [#1419](https://github.com/FuelLabs/fuel-core/pull/1419): Add additional "sanity" benchmarks for arithmetic op code instructions.
 - [#1411](https://github.com/FuelLabs/fuel-core/pull/1411): Added WASM and `no_std` compatibility.
 - [#1400](https://github.com/FuelLabs/fuel-core/pull/1400): Add releasy beta to fuel-core so that new commits to fuel-core master triggers fuels-rs.

Cargo.toml

@@ -10,6 +10,7 @@ members = [
   "crates/client",
   "crates/database",
   "crates/fuel-core",
+  "crates/keygen",
   "crates/metrics",
   "crates/services",
   "crates/services/consensus_module",
@@ -52,7 +53,8 @@ version = "0.20.4"
 fuel-core = { version = "0.20.4", path = "./crates/fuel-core", default-features = false }
 fuel-core-client-bin = { version = "0.20.4", path = "./bin/client" }
 fuel-core-bin = { version = "0.20.4", path = "./bin/fuel-core" }
-fuel-core-keygen = { version = "0.20.4", path = "./bin/keygen" }
+fuel-core-keygen = { version = "0.20.4", path = "./crates/keygen" }
+fuel-core-keygen-bin = { version = "0.20.4", path = "./bin/keygen" }
 fuel-core-chain-config = { version = "0.20.4", path = "./crates/chain-config" }
 fuel-core-client = { version = "0.20.4", path = "./crates/client" }
 fuel-core-database = { version = "0.20.4", path = "./crates/database" }

bin/keygen/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "fuel-core-keygen"
+name = "fuel-core-keygen-bin"
 version = { workspace = true }
 edition = { workspace = true }
 homepage = { workspace = true }
@@ -12,6 +12,4 @@ description = "Command line utilities for fuel-core key management"
 [dependencies]
 anyhow = { workspace = true }
 clap = { workspace = true, features = ["derive", "env"] }
-fuel-core-types = { workspace = true, features = ["serde", "random"] }
-libp2p-identity = { version = "0.2.4", features = ["secp256k1", "peerid"] }
-serde_json = { workspace = true, features = ["raw_value"] }
+fuel-core-keygen = { workspace = true }

crates/keygen/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "fuel-core-keygen"
+authors = { workspace = true }
+categories = { workspace = true }
+version = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+description = "Create to create command line utilities for fuel-core key management"
+
+[dependencies]
+anyhow = { workspace = true }
+atty = "0.2.14"
+clap = { workspace = true, features = ["derive", "env"] }
+fuel-core-types = { workspace = true, features = ["serde", "random"] }
+libp2p-identity = { version = "0.2.4", features = ["secp256k1", "peerid"] }
+serde_json = { workspace = true, features = ["raw_value"] }
+termion = "2.0.1"

bin/keygen/src/keygen.rs → crates/keygen/src/keygen.rs

@@ -2,6 +2,7 @@ use crate::{
     BLOCK_PRODUCTION,
     P2P,
 };
+use atty::Stream;
 use clap::ValueEnum;
 use fuel_core_types::{
     fuel_crypto::{
@@ -20,9 +21,16 @@ use libp2p_identity::{
 };
 use serde_json::json;
 use std::{
+    io::{
+        stdin,
+        stdout,
+        Read,
+        Write,
+    },
     ops::Deref,
     str::FromStr,
 };
+use termion::screen::IntoAlternateScreen;
 
 /// Generate a random new secret & public key in the format expected by fuel-core
 #[derive(Debug, clap::Args)]
@@ -126,13 +134,38 @@ impl ParseSecret {
     }
 }
 
+fn wait_for_keypress() {
+    let mut single_key = [0u8];
+    stdin().read_exact(&mut single_key).unwrap();
+}
+
+fn display_string_discreetly(
+    discreet_string: &str,
+    continue_message: &str,
+) -> anyhow::Result<()> {
+    if atty::is(Stream::Stdout) {
+        let mut screen = stdout().into_alternate_screen()?;
+        writeln!(screen, "{discreet_string}")?;
+        screen.flush()?;
+        println!("{continue_message}");
+        wait_for_keypress();
+    } else {
+        println!("{discreet_string}");
+    }
+    Ok(())
+}
+
 fn print_value(output: serde_json::Value, pretty: bool) -> anyhow::Result<()> {
     let output = if pretty {
         serde_json::to_string_pretty(&output)
     } else {
         serde_json::to_string(&output)
     }
     .map_err(anyhow::Error::msg);
-    println!("{}", output?);
+
+    let _ = display_string_discreetly(
+        &output?,
+        "### Do not share or lose this private key! Press any key to complete. ###",
+    );
     Ok(())
 }

docs/developers/debugging.md

@@ -50,10 +50,10 @@ Using environment variables for CLI arguments allows these values to be reused a
 
 When running the client with the P2P service enabled, i.e., building the binary with the `p2p` feature and supplying the runtime argument `--enable-p2p`, the client will connect to a Fuel network. This requires additional CLI arguments, including the `--keypair` and `--network` arguments.
 
-A key pair can be generated by running the utility binary `fuel-core-keygen`:
+A key pair can be generated by running the utility binary `fuel-core-keygen-bin`:
 
 ```bash
-cargo run --bin fuel-core-keygen new
+cargo run --bin fuel-core-keygen-bin new
 ```
 
 The resulting key pair printed to the console contains an address and secret. The `secret` can be provided to the `--keypair` argument when running the node.