Merge branch 'phase/beta1' into fix/InvalidJumpForDestinationsOverLimit

Author: mcsherrylabs

README.md

@@ -1,46 +1,125 @@
-# etc-client
+# mantis - Scala client for Ethereum Classic
 
+*Mantis* is the name given to the new Ethereum Classic client produced by the [Grothendieck Team](https://iohk.io/projects/ethereum-classic/).
+ 
+### Status - Beta 1 
+
+Continuous Integration Build Status [![CircleCI](https://circleci.com/gh/input-output-hk/etc-client/tree/master.svg?style=svg)](https://circleci.com/gh/input-output-hk/etc-client/tree/master)
+
+Unit Test Code Coverage Status [![Coverage Status](https://coveralls.io/repos/github/input-output-hk/etc-client/badge.svg?branch=master)](https://coveralls.io/github/input-output-hk/etc-client?branch=master)
+
+This version of the code supports 
 
-[![CircleCI](https://circleci.com/gh/input-output-hk/etc-client/tree/master.svg?style=svg)](https://circleci.com/gh/input-output-hk/etc-client/tree/master)
+  - fast sync (download a recent state trie snapshot and all blocks, this is the default behaviour)
+  - regular sync (download and execute every transaction in every block in the chain, this can be very slow)
+  - bootstrap sync (download a database for *mantis* preloaded with a recent version of the block chain, recommended for testing) 
+  - JSON RPC API (useful for console and Mist integration)
+  - Morden testnet and private network
+  - `ethminer` miner integration (allows *mantis* to mine blocks with [ethminer](https://github.com/Genoil/cpp-ethereum))
+  
+This version has been tested on Windows 10, Linux and MacOS     
+
+For more details on configuration and functionality check out our [wiki](https://github.com/input-output-hk/etc-client/wiki)
 
-[![Coverage Status](https://coveralls.io/repos/github/input-output-hk/etc-client/badge.svg?branch=master)](https://coveralls.io/github/input-output-hk/etc-client?branch=master)
+### Download the client and bootstrap files
 
+The latest release can be downloaded from [here](https://github.com/input-output-hk/etc-client/releases)
 
-## A Scala based client for Ethereum Classic 
+The bootstrap database files can be downloaded from [here](https://github.com/input-output-hk/etc-client/wiki/Bootstrap-Database-Download-Links)
+    
+### Building the client 
 
-### Milestone 3 & 4 - JSON RPC and Miner Integration
+#### Prerequisites to build
 
-**This version of the code supports almost all the functionality for a first release.**
+- JDK 1.8 (download from [java.com](http://www.java.com))
+- sbt ([download sbt](http://www.scala-sbt.org/download.html))  
 
-For the curious ...
+#### Build the client
 
-In order to build the client checkout the code base and then type
+As an alternative to downloading the client build the client from source. 
+Checkout this repository from github and then type
 
  `sbt dist`
 
  in the root of the project.
 
-This creates a distribution zip. Unzip that file to create a folder structure starting with
+This creates a distribution zip.
+ 
+### Install and run the client
+
+#### Prerequisites to run the client
+ 
+ - JVM 1.8 (download from [java.com](http://www.java.com))
+ 
+Note that on windows a 64 bit version of the JVM is required. This can be checked by using `java -version`. Check for `64-Bit`
+ 
+```
+ java version "1.8.0_131"
+ Java(TM) SE Runtime Environment (build 1.8.0_131-b11)
+ Java HotSpot(TM) 64-Bit Server VM (build 25.131-b11, mixed mode)
+```
+ 
+ - the download of the Ethereum Classic chain will take up around 15G of disk space
+ 
+Note that a slow disk will slow the chain dowload, an SSD with 25G free space is recommended  
+
+#### Install the client 
+
+Unzip that file to create a folder structure starting with
 
  ```
- etc-client-0.1
+ mantis-0.3-cli-beta
  ```
 
- From there run 
+### Run the client on Linux and MacOS
+
+In a terminal from the root of the installation run  
 
  ```
- ./bin/etc-client
+ ./bin/mantis
  ```
+The client runs in the foreground, it is recommended to use a session manager like `tmux` to prevent the client exiting when the terminal is shut down.
 
-The client attempts to contact the remote peers configured in the configuration file and begin a 
-`fast-sync` download. The [configuration file](https://github.com/input-output-hk/etc-client/blob/master/src/main/resources/application.conf)
-settings can all be overriden in 
-
-`./config/production.conf`
+Within a minute the chain begins downloading to a folder in the `$HOME` folder called `.mantis`
+  
+### Run the client on Windows 
 
-The client has been run on Windows 8 and seems to work however it has not been extensively tested.
- 
-The [next milestone](https://iohk.io/projects/ethereum-classic/#roadmap) is our early Beta release!!
+Open a command terminal and from the root of the installation run
 
+```
+bin\mantis.bat
+```
+Within a minute the chain begins downloading to a folder in the `%HOME%` folder called `.mantis`
+
+#### Configuration
+
+Using the 'out of the box' settings the client attempts to contact the remote peers configured in the configuration file and begin a 
+`fast-sync` download. Time taken to complete `fast-sync` varies significantly depending on the quality of the network connection and the quality of the hardware. 
 
+A faster option for creating a node that is synced with the network is to use the bootstrap download.   
+
+All options can be configured in the  files located in the `conf` folder. 
+
+For example to change the default datadir to `/mydata` edit the `storage.conf` file and find the lines   
+
+```
+# Base directory where all the data used by the node is stored, including blockchain data and private keys
+# datadir = ${user.home}"/.mantis"
+```
+Uncomment and edit `datadir` to read 
+```
+# Base directory where all the data used by the node is stored, including blockchain data and private keys
+datadir = "/mydata"
+```
+
+For more details on configuration and functionality check out our [wiki](https://github.com/input-output-hk/etc-client/wiki) 
+
+### Uninstall 
+
+To remove the mantis client simple delete the folder the distribution (zip) file was unzipped to and delete the `datadir`. The default datadir folder is `$HOME/.mantis`  
+
+### Feedback
+
+Feedback gratefully received through the Ethereum Classic Slack (@carlo) although please check out the list of known issues first in the 'RELEASE' file located in the root of the installation.
+
 

src/universal/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Input Output
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

src/universal/RELEASE

@@ -0,0 +1,50 @@
+Introduction
+
+This is the early beta 1 release of the mantis scala client for the Ethereum Classic network.
+
+This release is fundamentally a command line release allowing fast syncing of the Ethereum Classic network and processing of new transactions.
+
+For a more detailed description of the functionality and configuration options see https://github.com/input-output-hk/etc-client/wiki
+
+Known Issues
+
+EC-269 JSON RPC network_version returns a value of 1 for morden network, correct version is 2
+
+EC-270 personal_importRawKey allows the same key to be imported several times
+
+EC-282 download gets stuck in a loop when downloading block headers from a single peer which doesn't have those block headers
+
+Workaround - restart the client to allow another peer to be chosen
+
+EC-174 Releases not signed. Potential security issue whereby neither our releases nor the components used to build our releases are signed as verified.
+
+EC-283 Keyfiles exported from MyEtherwallet do not work
+
+Workaround - edit the exported file and change all json keys to lower case (e.g. "Crypto" -> "crypto")
+
+EC-278 Killing the client during fast download *might* result in missing block header
+
+EC-268 Pending transactions may not get forwarded to new peers. A connection made to a peer when a transaction is already pending will not receive the pending transaction.
+
+Workaround - resend the transaction when the client has peers
+
+EC-265 Spurious "Could not open table" database error during regular sync.
+Occasionally during regular sync the client will crash with an error saying it cannot locate a LeveLDB database file.
+
+Workaround - clear out datadir and restart sync
+
+EC-254 Full discovery 'kademlia' protocol not implemented. There are no known implications.
+
+EC-244 etcstats.net data for mantis always seems one block behind
+
+EC-167 Trying to run "regular sync" after an incomplete "fast sync" results in "Node not found" exception
+
+Workaround - clear out datadir and restart sync
+
+Feedback
+
+Feedback gratefully received through the Ethereum Classic Slack (@carlo)
+
+
+
+