Merge pull request #843 from input-output-hk/release/v3.2.0

Release/v3.2.0

Author: jmendiola222

README.md

@@ -44,6 +44,10 @@ Possible networks: `etc`, `eth`, `mordor`, `testnet-internal`
  - generate genesis allocs (using private keys and/or addresses)
 ```
 `./bin/mantis cli generate-alloc --balance=42 --address=8b196738d90cf3d9fc299e0ec28e15ebdcbb0bdcb281d9d5084182c9c66d5d12 --key=00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d1`
+```
+ - generate multiple key-pairs (following example generate 5 key-pairs)
+ ```
+./bin/mantis cli generate-key-pairs 5
 ```
 
 ### Building the client
@@ -126,6 +130,42 @@ projectRoot $ docker build -f ./docker/monitoring-client.Dockerfile -t mantis-mo
 projectRoot $ docker run --network=host mantis-monitoring-client
 ```
 
+### TLS setup
+
+Both the JSON RPC (on the node and faucet) can be additionally protected using TLS.
+On the development environment it's already properly configured with a development certificate.
+
+#### Generating a new certificate
+
+If a new certificate is required, create a new keystore with a certificate by running `./tls/gen-cert.sh`
+
+#### Configuring the node
+
+1. Configure the certificate and password file to be used at `mantis.network.rpc.http.certificate` key on the `application.conf` file:
+
+    keystore-path: path to the keystore storing the certificates (if generated through our script they are by default located in "./tls/mantisCA.p12")
+    keystore-type: type of certificate keystore being used (if generated through our script use "pkcs12")
+    password-file: path to the file with the password used for accessing the certificate keystore (if generated through our script they are by default located in "./tls/password")
+2. Enable TLS in specific config:
+    - For JSON RPC: `mantis.network.rpc.http.mode=https`
+
+#### Configuring the faucet
+
+1. Configure the certificate and password file to be used at `mantis.network.rpc.http.certificate` key on the `faucet.conf` file:
+
+    keystore-path: path to the keystore storing the certificates (if generated through our script they are by default located in "./tls/mantisCA.p12")
+    keystore-type: type of certificate keystore being used (if generated through our script use "pkcs12")
+    password-file: path to the file with the password used for accessing the certificate keystore (if generated through our script they are by default located in "./tls/password")
+2. Enable TLS in specific config:
+    - For JSON RPC: `mantis.network.rpc.http.mode=https`
+3. Configure the certificate used from RpcClient to connect with the node. Necessary if the node uses http secure. 
+   This certificate and password file to be used at `faucet.rpc-client.certificate` key on the `faucet.conf` file:
+
+    keystore-path: path to the keystore storing the certificates
+    keystore-type: type of certificate keystore being used (if generated through our script use "pkcs12")
+    password-file: path to the file with the password used for accessing the certificate keystore
+
+
 ### Feedback
 
 Feedback gratefully received through the Ethereum Classic Forum (http://forum.ethereumclassic.org/)

build.sbt

@@ -1,6 +1,7 @@
 enablePlugins(JDKPackagerPlugin, JavaAppPackaging, SolidityPlugin)
 
 import scala.sys.process.Process
+import NativePackagerHelper._
 
 // Necessary for the nix build, please do not remove.
 val nixBuild = sys.props.isDefinedAt("nix")
@@ -10,7 +11,7 @@ val mantisDev = sys.props.get("mantisDev").contains("true") || sys.env.get("MANT
 
 val commonSettings = Seq(
   name := "mantis",
-  version := "3.1.0",
+  version := "3.2.0",
   scalaVersion := "2.12.12",
   // Scalanet snapshots are published to Sonatype after each build.
   resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots",
@@ -144,6 +145,10 @@ discoveredMainClasses in Compile := Seq()
 ThisBuild / jdkPackagerType := "image"
 
 Universal / mappings += (resourceDirectory in Compile).value / "logback.xml" -> "conf/logback.xml"
+Universal / mappings += (resourceDirectory in Compile).value / "application.conf" -> "conf/base.conf"
+Universal / mappings ++= directory((resourceDirectory in Compile).value / "chains").map { case (f, name) =>
+  f -> s"conf/$name"
+}
 
 val sep = java.io.File.separator
 jdkPackagerJVMArgs := Seq(