Merge pull request #746 from input-output-hk/etcm-202-mantis-cli

[ETCM-202] Provide Mantis command-line interface

Author: Michał Mrożek

README.md

@@ -29,6 +29,23 @@ Example:
 
 Possible networks: `etc`, `eth`, `mordor`, `testnet-internal`
 
+### Command Line Interface
+
+`cli` is a tool that can be used to:
+ 
+ - generate a new private key
+ ```
+./bin/mantis cli generate-private-key
+```
+ - derive an address from private key
+```
+./bin/mantis cli derive-address 00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d0
+```
+ - generate genesis allocs (using private keys and/or addresses)
+```
+`./bin/mantis cli generate-alloc --balance=42 --address=8b196738d90cf3d9fc299e0ec28e15ebdcbb0bdcb281d9d5084182c9c66d5d12 --key=00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d1`
+```
+
 ### Building the client
 
 #### SBT
@@ -86,7 +103,7 @@ This patch will update the lock files for you.
 
 - `repo.nix`                 : generated by the `sbtix-gen` command and includes only the build dependencies for the project.
 - `project/repo.nix`         : generated by the `sbtix-gen-all` command and includes only the plugin dependencies. Also generates `repo.nix`.
-- `project/project/repo.nix` : generated by the `sbtix-gen-all2` command and includes only the pluginplugin dependencies. Also generates `repo.nix` and `project/repo.nix`.
+- `project/project/repo.nix` : generated by the `sbtix-gen-all2` command and includes only the plugin dependencies. Also generates `repo.nix` and `project/repo.nix`.
 
 ##### error: unsupported argument 'submodules' to 'fetchGit'
 

build.sbt

@@ -42,6 +42,7 @@ val dep = {
     Dependencies.apacheCommons,
     Dependencies.micrometer,
     Dependencies.prometheus,
+    Dependencies.cli,
     Dependencies.dependencies
   ).flatten ++ malletDeps
 }

project/Dependencies.scala

@@ -83,6 +83,8 @@ object Dependencies {
 
   val scopt = Seq("com.github.scopt" % "scopt_2.12" % "3.7.1")
 
+  val cli = Seq("com.monovore" %% "decline" % "1.3.0")
+
   val apacheCommons = Seq(
     "commons-io" % "commons-io" % "2.8.0"
   )

repo.nix

@@ -784,6 +784,22 @@
       url = "https://repo1.maven.org/maven2/com/miguno/akka/akka-mock-scheduler_2.12/0.5.5/akka-mock-scheduler_2.12-0.5.5.pom";
       sha256 = "00641F962CB8D1BED3C64FFA635CB0562DFD6D52A9B5DD614536EAC864CBD948";
     };
+    "nix-public/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0-javadoc.jar" = {
+      url = "https://repo1.maven.org/maven2/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0-javadoc.jar";
+      sha256 = "9D0962E8AAB7D02EB20B50C428C9D7044B6886E8436FABFC2571DE22E5BD909E";
+    };
+    "nix-public/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0-sources.jar" = {
+      url = "https://repo1.maven.org/maven2/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0-sources.jar";
+      sha256 = "1554EA9939430010D27F9EAF22BFA770402F14C33CFAEF6DB52FCD79FA176EA2";
+    };
+    "nix-public/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0.jar" = {
+      url = "https://repo1.maven.org/maven2/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0.jar";
+      sha256 = "F2854BF74AE59AB7E19745CA312181DF3EFA2A1A3DA796E8FEC41E2B9C870FB4";
+    };
+    "nix-public/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0.pom" = {
+      url = "https://repo1.maven.org/maven2/com/monovore/decline_2.12/1.3.0/decline_2.12-1.3.0.pom";
+      sha256 = "8806217334913555CE9E8F844EA4561767CD850457945E552838F1B2F85A9C86";
+    };
     "nix-public/com/squareup/okhttp3/logging-interceptor/4.3.1/logging-interceptor-4.3.1-javadoc.jar" = {
       url = "https://repo1.maven.org/maven2/com/squareup/okhttp3/logging-interceptor/4.3.1/logging-interceptor-4.3.1-javadoc.jar";
       sha256 = "1FDD287ADDB6301F3D16274ADBDF55C7129E2C675DA61EF087A62740EAB49EAF";

src/main/scala/io/iohk/ethereum/App.scala

@@ -1,5 +1,6 @@
 package io.iohk.ethereum
 
+import io.iohk.ethereum.cli.CliLauncher
 import io.iohk.ethereum.crypto.EcKeyGen
 import io.iohk.ethereum.extvm.VmServerApp
 import io.iohk.ethereum.faucet.Faucet
@@ -17,6 +18,7 @@ object App extends Logger {
     val mallet = "mallet"
     val faucet = "faucet"
     val ecKeyGen = "eckeygen"
+    val cli = "cli"
 
     args.headOption match {
       case None => Mantis.main(args)
@@ -31,11 +33,12 @@ object App extends Logger {
       case Some(`mallet`) => Mallet.main(args.tail)
       case Some(`faucet`) => Faucet.main(args.tail)
       case Some(`ecKeyGen`) => EcKeyGen.main(args.tail)
+      case Some(`cli`) => CliLauncher.main(args.tail)
       case Some(unknown) =>
         log.error(
           s"Unrecognised launcher option, " +
             s"first parameter must be $launchKeytool, $downloadBootstrap, $launchMantis, " +
-            s"$mallet, $faucet, $vmServer or $ecKeyGen"
+            s"$mallet, $faucet, $vmServer, $ecKeyGen or $cli"
         )
     }
 

src/main/scala/io/iohk/ethereum/cli/CliCommands.scala

@@ -0,0 +1,72 @@
+package io.iohk.ethereum.cli
+
+import cats.implicits._
+import com.monovore.decline.{Command, Opts}
+import io.iohk.ethereum.crypto
+import io.iohk.ethereum.crypto._
+import io.iohk.ethereum.utils.ByteStringUtils
+import java.security.SecureRandom
+import org.bouncycastle.util.encoders.Hex
+
+object CliCommands {
+
+  val generatePrivateKeyCommand = "generate-private-key"
+  val deriveAddressCommand = "derive-address"
+  val generateAllocsCommand = "generate-allocs"
+  val balanceOption = "balance"
+  val keyOption = "key"
+  val addressOption = "address"
+
+  private val GeneratePrivateKeyCommand: Command[String] =
+    Command(name = generatePrivateKeyCommand, header = "Generate private key") {
+      Opts.unit.map { _ =>
+        val keyPair = generateKeyPair(new SecureRandom())
+        val (prvKey, _) = keyPairToByteStrings(keyPair)
+        ByteStringUtils.hash2string(prvKey)
+      }
+    }
+
+  private val DeriveAddressFromPrivateKey: Command[String] =
+    Command(name = deriveAddressCommand, header = "Derive address from private key") {
+
+      Opts
+        .argument[String]("private-key")
+        .map(Hex.decode)
+        .map(privKeyToAddress)
+    }
+
+  private val GenerateAllocs: Command[String] =
+    Command(name = generateAllocsCommand, header = "Generate genesis allocs") {
+
+      val keysOpt: Opts[List[String]] =
+        Opts
+          .options[String](long = keyOption, help = "Private key")
+          .map(_.map(key => privKeyToAddress(Hex.decode(key))))
+          .orEmpty
+
+      val addressesOpt: Opts[List[String]] =
+        Opts.options[String](long = addressOption, help = "Address").orEmpty
+
+      val balanceOpt =
+        Opts.option[BigInt](long = balanceOption, help = "Initial balance for account", metavar = "balance")
+
+      (keysOpt, addressesOpt, balanceOpt).mapN { (addressesFromKeys, addresses, balance) =>
+        allocs(addresses ++ addressesFromKeys, balance)
+      }
+    }
+
+  private def allocs(addresses: List[String], balance: BigInt): String =
+    s""""alloc": ${addresses
+      .map(address => s"""$address: { "balance": $balance }""")
+      .mkString("{", ", ", "}")}"""
+
+  private def privKeyToAddress(privKey: Array[Byte]): String = {
+    val pubKey = pubKeyFromPrvKey(privKey)
+    val address = crypto.kec256(pubKey)
+    Hex.toHexString(address)
+  }
+
+  val api: Command[String] = Command.apply(name = "cli", header = "Mantis CLI") {
+    Opts.subcommands(GeneratePrivateKeyCommand, DeriveAddressFromPrivateKey, GenerateAllocs)
+  }
+}

src/main/scala/io/iohk/ethereum/cli/CliLauncher.scala

@@ -0,0 +1,13 @@
+package io.iohk.ethereum.cli
+
+import com.monovore.decline._
+
+//scalastyle:off
+object CliLauncher extends App {
+
+  CliCommands.api.map(println).parse(PlatformApp.ambientArgs getOrElse args, sys.env) match {
+    case Left(help) => System.err.println(help)
+    case Right(_) => ()
+  }
+
+}

src/test/scala/io/iohk/ethereum/cli/CliCommandsSpec.scala

@@ -0,0 +1,99 @@
+package io.iohk.ethereum.cli
+
+import org.scalatest.EitherValues
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+
+class CliCommandsSpec extends AnyFlatSpec with Matchers with EitherValues {
+
+  import CliCommands._
+  import Fixture._
+
+  behavior of generatePrivateKeyCommand
+  it should "generate correct private key" in {
+    api.parse(Seq(generatePrivateKeyCommand)) shouldBe a[Right[_, _]]
+  }
+
+  behavior of deriveAddressCommand
+  it should "derive address from private key" in {
+    api.parse(Seq(deriveAddressCommand, privateKey)).right.value shouldBe address
+  }
+
+  it should "return an error when called without private key" in {
+    api.parse(Seq(deriveAddressCommand)) shouldBe a[Left[_, _]]
+  }
+
+  behavior of generateAllocsCommand
+  it should "generate correct alloc using private key" in {
+    api
+      .parse(
+        Seq(
+          generateAllocsCommand,
+          argument(keyOption, Some(privateKey)),
+          argument(balanceOption, Some(requestedBalance))
+        )
+      )
+      .right
+      .value shouldBe s""""alloc": {$address: { "balance": $requestedBalance }}"""
+  }
+
+  it should "generate more than one alloc" in {
+    api
+      .parse(
+        Seq(
+          generateAllocsCommand,
+          argument(keyOption, Some(privateKey)),
+          argument(keyOption, Some(privateKey2)),
+          argument(balanceOption, Some(requestedBalance))
+        )
+      )
+      .right
+      .value shouldBe s""""alloc": {$address: { "balance": $requestedBalance }, $address2: { "balance": $requestedBalance }}"""
+  }
+
+  it should "generate allocs using addresses" in {
+    api
+      .parse(
+        Seq(
+          generateAllocsCommand,
+          argument(addressOption, Some(address)),
+          argument(addressOption, Some(address2)),
+          argument(balanceOption, Some(requestedBalance))
+        )
+      )
+      .right
+      .value shouldBe s""""alloc": {$address: { "balance": $requestedBalance }, $address2: { "balance": $requestedBalance }}"""
+  }
+
+  it should "generate allocs using both keys and addresses" in {
+    api
+      .parse(
+        Seq(
+          generateAllocsCommand,
+          argument(addressOption, Some(address)),
+          argument(keyOption, Some(privateKey2)),
+          argument(addressOption, Some(address3)),
+          argument(balanceOption, Some(requestedBalance))
+        )
+      )
+      .right
+      .value shouldBe s""""alloc": {$address: { "balance": $requestedBalance }, $address3: { "balance": $requestedBalance }, $address2: { "balance": $requestedBalance }}"""
+  }
+
+}
+
+object Fixture {
+
+  def argument(name: String, value: Option[Any] = None): String = s"--$name${value.fold("")(v => s"=${v.toString}")}"
+
+  val privateKey = "00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d0"
+  val privateKey2 = "00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d1"
+  val privateKey3 = "00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d2"
+
+  val address = "8b196738d90cf3d9fc299e0ec28e15ebdcbb0bdcb281d9d5084182c9c66d5d12"
+  val address2 = "add8c627e14480b36b30811758240d8acb282aae883043990d8a2d7e2e75cf3b"
+  val address3 = "1e9cd60cf3b2c902e60f809e604542f9a9fb55d3e8004ff122f662f88eb32b4a"
+
+  val requestedBalance = 42
+
+}