Refactor into jcli-lib crate

Cargo.toml

@@ -3,6 +3,7 @@ members = [
   "jormungandr-lib",
   "jormungandr",
   "jcli",
+  "jcli-lib",
   "modules/settings",
   "modules/blockchain",
   "testing/jormungandr-testing-utils",

jcli-lib/Cargo.toml

@@ -0,0 +1,62 @@
+[package]
+name = "jcli-lib"
+version = "0.11.1"
+authors = [ "[email protected]" ]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/input-output-hk/jormungandr"
+homepage = "https://github.com/input-output-hk/jormungandr#README.md"
+documentation = "https://github.com/input-output-hk/jormungandr#USAGE.md"
+description = """
+Midgard Serpent
+"""
+edition = "2018"
+
+[dependencies]
+rand = "0.8"
+rand_chacha = "0.3"
+serde = "1.0"
+serde_derive = "1.0"
+serde_json = "1.0.59"
+serde_yaml = "0.8"
+bincode = "1.3.3"
+mime = "^0.3.7"
+bech32 = "0.7"
+hex = "0.4.2"
+rayon = "1.5"
+base64 = "0.13.0"
+chain-core      = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
+chain-impl-mockchain = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
+chain-addr      = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
+chain-crypto    = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
+chain-time    = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master" }
+chain-vote = { git = "https://github.com/input-output-hk/chain-libs.git", branch = "master", features = ["p256k1"] }
+jormungandr-lib = { path = "../jormungandr-lib" }
+gtmpl = "0.6.0"
+valico = "3.5.0"
+ed25519-bip32 = "0.3"
+thiserror = "1.0"
+bytes = "1.0"
+
+[dependencies.structopt]
+version = "^0.3"
+optional = true
+
+[dependencies.clap]
+version = "2.33"
+default-features = false
+features = [ "suggestions", "color", "wrap_help" ]
+
+[dependencies.reqwest]
+version = "0.11"
+default-features = false
+features = ["blocking", "rustls-tls", "json"]
+
+[dev-dependencies]
+assert_fs = "1.0"
+predicates = "1.0"
+
+[build-dependencies]
+versionisator = "1.0.2"
+
+[features]
+default = ["structopt"]

jcli-lib/build.rs

@@ -0,0 +1,19 @@
+fn main() {
+    let pkg_version = if let Ok(date) = std::env::var("DATE") {
+        format!("{}.{}", env!("CARGO_PKG_VERSION"), date)
+    } else {
+        env!("CARGO_PKG_VERSION").to_string()
+    };
+
+    println!("cargo:rustc-env=CARGO_PKG_VERSION={}", pkg_version);
+
+    let version = versionisator::Version::new(
+        env!("CARGO_MANIFEST_DIR"),
+        env!("CARGO_PKG_NAME").to_string(),
+        pkg_version,
+    );
+
+    println!("cargo:rustc-env=FULL_VERSION={}", version.full());
+    println!("cargo:rustc-env=SIMPLE_VERSION={}", version.simple());
+    println!("cargo:rustc-env=SOURCE_VERSION={}", version.hash());
+}

jcli/src/jcli_lib/address.rs → jcli-lib/src/address.rs

@@ -1,11 +1,16 @@
-use crate::jcli_lib::utils::key_parser::parse_pub_key;
+//! Bech32 segregated witness address tooling and helper.
+use crate::utils::key_parser::parse_pub_key;
 use chain_addr::{AddressReadable, Discrimination, Kind};
 use chain_crypto::{bech32::Bech32 as _, AsymmetricPublicKey, Ed25519, PublicKey};
+#[cfg(feature = "structopt")]
 use structopt::StructOpt;
 use thiserror::Error;
 
-#[derive(StructOpt)]
-#[structopt(name = "address", rename_all = "kebab-case")]
+#[cfg_attr(
+    feature = "structopt",
+    derive(StructOpt),
+    structopt(name = "address", rename_all = "kebab-case")
+)]
 pub enum Address {
     /// Display the content and info of a bech32 formatted address.
     Info(InfoArgs),
@@ -18,48 +23,51 @@ pub enum Address {
     Account(AccountArgs),
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct InfoArgs {
     /// An address, in bech32 format, to display the content
     /// and info that can be extracted from.
-    #[structopt(name = "ADDRESS")]
+    #[cfg_attr(feature = "structopt", structopt(name = "ADDRESS"))]
     address: AddressReadable,
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct DiscriminationData {
     /// Set the discrimination type to testing (default is production).
-    #[structopt(long = "testing")]
+    #[cfg_attr(feature = "structopt", structopt(long = "testing"))]
     testing: bool,
 
     /// Set the prefix to use to describe the address. This is only available
     /// on the human readable representation of the address and will not be
     /// used or checked by the node.
-    #[structopt(long = "prefix", default_value = "ca")]
+    #[cfg_attr(
+        feature = "structopt",
+        structopt(long = "prefix", default_value = "ca")
+    )]
     prefix: String,
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct SingleArgs {
     /// A public key in bech32 encoding with the key type prefix.
-    #[structopt(name = "PUBLIC_KEY", parse(try_from_str = parse_pub_key))]
+    #[cfg_attr(feature = "structopt", structopt(name = "PUBLIC_KEY", parse(try_from_str = parse_pub_key)))]
     key: PublicKey<Ed25519>,
 
     /// A public key in bech32 encoding with the key type prefix.
-    #[structopt(name = "DELEGATION_KEY", parse(try_from_str = parse_pub_key))]
+    #[cfg_attr(feature = "structopt", structopt(name = "DELEGATION_KEY", parse(try_from_str = parse_pub_key)))]
     delegation: Option<PublicKey<Ed25519>>,
 
-    #[structopt(flatten)]
+    #[cfg_attr(feature = "structopt", structopt(flatten))]
     discrimination_data: DiscriminationData,
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct AccountArgs {
     /// A public key in bech32 encoding with the key type prefix.
-    #[structopt(name = "PUBLIC_KEY", parse(try_from_str = parse_pub_key))]
+    #[cfg_attr(feature = "structopt", structopt(name = "PUBLIC_KEY", parse(try_from_str = parse_pub_key)))]
     key: PublicKey<Ed25519>,
 
-    #[structopt(flatten)]
+    #[cfg_attr(feature = "structopt", structopt(flatten))]
     discrimination_data: DiscriminationData,
 }
 

jcli/src/jcli_lib/auto_completion.rs → jcli-lib/src/auto_completion.rs

@@ -1,17 +1,24 @@
+//! Generated auto-completions for supported shells supported by `structopt` via `clap`.
 use std::path::{Path, PathBuf};
+#[cfg(feature = "structopt")]
 use structopt::{clap::Shell, StructOpt};
 use thiserror::Error;
 
-#[derive(StructOpt)]
-#[structopt(rename_all = "kebab-case")]
+#[cfg_attr(
+    feature = "structopt",
+    derive(StructOpt),
+    structopt(rename_all = "kebab-case")
+)]
 pub struct AutoCompletion {
+    #[cfg(feature = "structopt")]
     /// set the type shell for the auto completion output (bash, zsh...)
     shell: Shell,
 
     /// path to the directory to write the generated auto completion files
     output: PathBuf,
 }
 
+#[cfg(feature = "structopt")]
 impl AutoCompletion {
     pub fn exec<S: StructOpt>(self) -> Result<(), Error> {
         validate_output(&self.output)?;

jcli/src/jcli_lib/block/mod.rs → jcli-lib/src/block/mod.rs

@@ -1,4 +1,5 @@
-use crate::jcli_lib::utils::io;
+//! Chain-block tooling and helper.
+use crate::utils::io;
 use chain_core::property::{Block as _, Deserialize, Serialize};
 use chain_impl_mockchain::{
     block::Block,
@@ -11,6 +12,7 @@ use std::{
     io::{BufRead, Write},
     path::PathBuf,
 };
+#[cfg(feature = "structopt")]
 use structopt::StructOpt;
 use thiserror::Error;
 
@@ -85,8 +87,11 @@ fn print_hash(input: Input) -> Result<(), Error> {
 }
 
 /// create block 0 of the blockchain (i.e. the genesis block)
-#[derive(StructOpt)]
-#[structopt(name = "genesis", rename_all = "kebab-case")]
+#[cfg_attr(
+    feature = "structopt",
+    derive(StructOpt),
+    structopt(name = "genesis", rename_all = "kebab-case")
+)]
 pub enum Genesis {
     /// Create a default Genesis file with appropriate documentation
     /// to help creating the YAML file
@@ -104,13 +109,16 @@ pub enum Genesis {
     Hash(Input),
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct Input {
     /// the file path to the genesis file defining the block 0
     ///
     /// If not available the command will expect to read the configuration from
     /// the standard input.
-    #[structopt(long = "input", parse(from_os_str), name = "FILE_INPUT")]
+    #[cfg_attr(
+        feature = "structopt",
+        structopt(long = "input", parse(from_os_str), name = "FILE_INPUT")
+    )]
     input_file: Option<std::path::PathBuf>,
 }
 
@@ -128,16 +136,19 @@ impl Input {
     }
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct Common {
-    #[structopt(flatten)]
+    #[cfg_attr(feature = "structopt", structopt(flatten))]
     pub input: Input,
 
     /// the file path to the block to create
     ///
     /// If not available the command will expect to write the block to
     /// to the standard output
-    #[structopt(long = "output", parse(from_os_str), name = "FILE_OUTPUT")]
+    #[cfg_attr(
+        feature = "structopt",
+        structopt(long = "output", parse(from_os_str), name = "FILE_OUTPUT")
+    )]
     pub output_file: Option<std::path::PathBuf>,
 }
 

jcli/src/jcli_lib/certificate/mod.rs → jcli-lib/src/certificate/mod.rs

@@ -1,3 +1,4 @@
+//! Certificate generation tool.
 mod new_encrypted_vote_tally;
 mod new_owner_stake_delegation;
 mod new_stake_delegation;
@@ -15,7 +16,7 @@ pub(crate) use self::sign::{
     pool_owner_sign, stake_delegation_account_binding_sign,
 };
 
-use crate::jcli_lib::utils::{
+use crate::utils::{
     io, key_parser,
     vote::{SharesError, VotePlanError},
 };
@@ -26,6 +27,7 @@ use std::{
     io::{BufRead, BufReader, Write},
     path::{Path, PathBuf},
 };
+#[cfg(feature = "structopt")]
 use structopt::StructOpt;
 use thiserror::Error;
 
@@ -114,8 +116,11 @@ pub enum Error {
 }
 
 #[allow(clippy::large_enum_variant)]
-#[derive(StructOpt)]
-#[structopt(rename_all = "kebab-case")]
+#[cfg_attr(
+    feature = "structopt",
+    derive(StructOpt),
+    structopt(rename_all = "kebab-case")
+)]
 pub enum Certificate {
     /// Build certificate
     New(NewArgs),
@@ -129,8 +134,11 @@ pub enum Certificate {
 }
 
 #[allow(clippy::large_enum_variant)]
-#[derive(StructOpt)]
-#[structopt(rename_all = "kebab-case")]
+#[cfg_attr(
+    feature = "structopt",
+    derive(StructOpt),
+    structopt(rename_all = "kebab-case")
+)]
 pub enum NewArgs {
     /// create the stake pool registration certificate.
     ///
@@ -167,21 +175,24 @@ pub enum NewArgs {
     VoteCast(new_vote_cast::VoteCastCmd),
 }
 
-#[derive(StructOpt)]
-#[structopt(rename_all = "kebab-case")]
+#[cfg_attr(
+    feature = "structopt",
+    derive(StructOpt),
+    structopt(rename_all = "kebab-case")
+)]
 pub struct PrintArgs {
     /// get the certificate to sign from the given file. If no file
     /// provided, it will be read from the standard input
     pub input: Option<PathBuf>,
 }
 
-#[derive(StructOpt)]
+#[cfg_attr(feature = "structopt", derive(StructOpt))]
 pub struct StakeDelegationArgs {
-    #[structopt(name = "PUBLIC_KEY")]
+    #[cfg_attr(feature = "structopt", structopt(name = "PUBLIC_KEY"))]
     pub key: String,
-    #[structopt(name = "POOL_ID")]
+    #[cfg_attr(feature = "structopt", structopt(name = "POOL_ID"))]
     pub pool_id: String,
-    #[structopt(name = "SIGNING_KEY")]
+    #[cfg_attr(feature = "structopt", structopt(name = "SIGNING_KEY"))]
     pub private_key: PathBuf,
 }