Random small cleanups (#9423)

* clean up toml files

* update the parity ethereum toolchain docs

* update contribution guide and issue templates

* update desktop and service files

* build clib examples with 8 threads

* update header templates

* replace parity technologies with parity ethereum logo

.github/CONTRIBUTING.md

@@ -12,9 +12,9 @@ Do **not** open an issue on Github if you think your discovered bug could be a *
 
 Otherwise, just create a [new issue](https://github.com/paritytech/parity-ethereum/issues/new) in our repository and state:
 
-- What's your Parity version?
+- What's your Parity Ethereum version?
 - What's your operating system and version?
-- How did you install parity?
+- How did you install Parity Ethereum?
 - Is your node fully synchronized?
 - Did you try turning it off and on again?
 
@@ -22,12 +22,12 @@ Also, try to include **steps to reproduce** the issue and expand on the **actual
 
 ## Contribute!
 
-If you would like to contribute to Parity, please **fork it**, fix bugs or implement features, and [propose a pull request](https://github.com/paritytech/parity-ethereum/compare).
+If you would like to contribute to Parity Ethereum, please **fork it**, fix bugs or implement features, and [propose a pull request](https://github.com/paritytech/parity-ethereum/compare).
 
 Please, refer to the [Coding Guide](https://wiki.parity.io/Coding-guide) in our wiki for more details about hacking on Parity.
 
 ## License.
 
-By contributing to Parity, you agree that your contributions will be licensed under the [GPLv3 License](../LICENSE).
+By contributing to Parity Ethereum, you agree that your contributions will be licensed under the [GPLv3 License](../LICENSE).
 
 Each contributor has to sign our Contributor License Agreement. The purpose of the CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen license. You can read and sign our full Contributor License Agreement at [cla.parity.io](https://cla.parity.io) before submitting a pull request.

.github/ISSUE_TEMPLATE.md

@@ -1,13 +1,11 @@
 _Before filing a new issue, please **provide the following information**._
 
-> I'm running:
+- **Parity Ethereum version**: 0.0.0
->
+- **Operating system**: Windows / MacOS / Linux
-> - **Which Parity version?**: 0.0.0
+- **Installation**: homebrew / one-line installer / built from source
-> - **Which operating system?**: Windows / MacOS / Linux
+- **Fully synchronized**: no / yes
-> - **How installed?**: via installer / homebrew / binaries / from source
+- **Network**: ethereum / ropsten / kovan / ...
-> - **Are you fully synchronized?**: no / yes
+- **Restarted**: no / yes
-> - **Which network are you connected to?**: ethereum / ropsten / kovan / ...
-> - **Did you try to restart the node?**: no / yes
 
 _Your issue description goes here below. Try to include **actual** vs. **expected behavior** and **steps to reproduce** the issue._
 

README.md

@@ -149,6 +149,16 @@ To start Parity Ethereum as a regular user using `systemd` init:
 `systemd` user directory (usually `~/.config/systemd/user`).
 2. To configure Parity Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
 
+## Parity Ethereum toolchain
+
+In addition to the Parity Ethereum client, there are additional tools in this repository available:
+
+- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
+- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/ethstore/) - Parity Ethereum key management.
+- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/ethkey/) - Parity Ethereum keys generator.
+- [whisper](https://github.com/paritytech/parity-ethereum/blob/master/whisper/) - Implementation of Whisper-v2 PoC.
+
 ## Join the chat!
 
 Questions? Get in touch with us on Gitter:

chainspec/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "chainspec"
 version = "0.1.0"
-authors = ["debris <marek.kotewicz@gmail.com>"]
+authors = ["Marek Kotewicz <marek@parity.io>"]
 
 [dependencies]
 ethjson = { path = "../json" }

docker/README.md

@@ -5,7 +5,6 @@
 ## Usage - CentOS
 
 Builds a lightweight non-root Parity docker image:
-
 ```
 git clone https://github.com/paritytech/parity-ethereum.git
 cd parity-ethereum
@@ -20,7 +19,6 @@ PARITY_RUNNER_IMAGE_TAG=centos-parity-experimental \
 ./docker/centos/build.sh
 ```
 
-
 Default values:
 ```
 # The image name

ethash/Cargo.toml

@@ -3,8 +3,6 @@ name = "ethash"
 version = "1.12.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 
-[lib]
-
 [dependencies]
 crunchy = "0.1.0"
 either = "1.0.0"

ethkey/README.md

@@ -1,19 +1,12 @@
-# ethkey
+## ethkey-cli
 
-[![Build Status][travis-image]][travis-url]
+Parity Ethereum keys generator.
-
-[travis-image]: https://travis-ci.org/paritytech/ethkey.svg?branch=master
-[travis-url]: https://travis-ci.org/paritytech/ethkey
-
-Ethereum keys generator.
-
-[Documentation](http://paritytech.github.io/ethkey/ethkey/index.html)
 
 ### Usage
 
 ```
-Ethereum keys generator.
+Parity Ethereum keys generator.
-  Copyright 2016, 2017 Parity Technologies (UK) Ltd
+  Copyright 2015-2018 Parity Technologies (UK) Ltd.
 
 Usage:
     ethkey info <secret-or-phrase> [options]
@@ -27,17 +20,17 @@ Usage:
 
 Options:
     -h, --help         Display this message and exit.
-    -s, --secret       Display only the secret.
+    -s, --secret       Display only the secret key.
-    -p, --public       Display only the public.
+    -p, --public       Display only the public key.
     -a, --address      Display only the address.
-    -b, --brain        Use parity brain wallet algorithm.
+    -b, --brain        Use parity brain wallet algorithm. Not recommended.
 
 Commands:
-    info               Display public and address of the secret.
+    info               Display public key and address of the secret.
-    generate random    Generates new random ethereum key.
+    generate random    Generates new random Ethereum key.
-    generate prefix    Random generation, but address must start with a prefix.
+    generate prefix    Random generation, but address must start with a prefix ("vanity address").
-    sign               Sign message using secret.
+    sign               Sign message using a secret key.
-    verify             Verify signer of the signature.
+    verify             Verify signer of the signature by public key or address.
     recover            Try to find brain phrase matching given address from partial phrase.
 ```
 
@@ -218,10 +211,11 @@ public:  4e19a5fdae82596e1485c69b687c9cc52b5078e5b0668ef3ce8543cd90e712cb00df822
 address: 00cf3711cbd3a1512570639280758118ba0b2bcb
 ```
 
+## Parity Ethereum toolchain
+_This project is a part of the Parity Ethereum toolchain._
 
-# Parity toolchain
+- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
-*this project is a part of the parity toolchain*
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
-
+- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/ethstore/) - Parity Ethereum key management.
-- [**ethkey**](https://github.com/paritytech/ethkey) - Ethereum keys generator and signer.
+- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/ethkey/) - Parity Ethereum keys generator.
-- [**ethstore**](https://github.com/paritytech/ethstore) - Ethereum key management.
+- [whisper](https://github.com/paritytech/parity-ethereum/blob/master/whisper/) - Implementation of Whisper-v2 PoC.
-- [**ethabi**](https://github.com/paritytech/ethabi) - Ethereum function calls encoding.

ethkey/cli/src/main.rs

@@ -34,8 +34,8 @@ use ethkey::{KeyPair, Random, Brain, BrainPrefix, Prefix, Error as EthkeyError,
 use rustc_hex::{FromHex, FromHexError};
 
 const USAGE: &'static str = r#"
-Ethereum keys generator.
+Parity Ethereum keys generator.
-  Copyright 2016, 2017 Parity Technologies (UK) Ltd
+  Copyright 2015-2018 Parity Technologies (UK) Ltd.
 
 Usage:
     ethkey info <secret-or-phrase> [options]
@@ -49,17 +49,17 @@ Usage:
 
 Options:
     -h, --help         Display this message and exit.
-    -s, --secret       Display only the secret.
+    -s, --secret       Display only the secret key.
-    -p, --public       Display only the public.
+    -p, --public       Display only the public key.
     -a, --address      Display only the address.
-    -b, --brain        Use parity brain wallet algorithm.
+    -b, --brain        Use parity brain wallet algorithm. Not recommended.
 
 Commands:
-    info               Display public and address of the secret.
+    info               Display public key and address of the secret.
-    generate random    Generates new random ethereum key.
+    generate random    Generates new random Ethereum key.
-    generate prefix    Random generation, but address must start with a prefix.
+    generate prefix    Random generation, but address must start with a prefix ("vanity address").
-    sign               Sign message using secret.
+    sign               Sign message using a secret key.
-    verify             Verify signer of the signature.
+    verify             Verify signer of the signature by public key or address.
     recover            Try to find brain phrase matching given address from partial phrase.
 "#;
 

ethstore/README.md

@@ -1,19 +1,12 @@
-# ethstore
+## ethstore-cli
 
-[![Build Status][travis-image]][travis-url]
+Parity Ethereum key management.
-
-[travis-image]: https://travis-ci.org/paritytech/ethstore.svg?branch=master
-[travis-url]: https://travis-ci.org/paritytech/ethstore
-
-Ethereum key management.
-
-[Documentation](http://paritytech.github.io/ethstore/ethstore/index.html)
 
 ### Usage
 
 ```
-Ethereum key management.
+Parity Ethereum key management tool.
-  Copyright 2016, 2017 Parity Technologies (UK) Ltd
+  Copyright 2015-2018 Parity Technologies (UK) Ltd.
 
 Usage:
     ethstore insert <secret> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
@@ -35,19 +28,19 @@ Usage:
 Options:
     -h, --help               Display this message and exit.
     --dir DIR                Specify the secret store directory. It may be either
-                             parity, parity-test, geth, geth-test
+                             parity, parity-(chain), geth, geth-test
                              or a path [default: parity].
     --vault VAULT            Specify vault to use in this operation.
     --vault-pwd VAULTPWD     Specify vault password to use in this operation. Please note
                              that this option is required when vault option is set.
                              Otherwise it is ignored.
     --src DIR                Specify import source. It may be either
-                             parity, parity-test, get, geth-test
+                             parity, parity-(chain), geth, geth-test
                              or a path [default: geth].
 
 Commands:
     insert             Save account with password.
-    change-pwd         Change account password.
+    change-pwd         Change password.
     list               List accounts.
     import             Import accounts from src.
     import-wallet      Import presale wallet.
@@ -59,7 +52,7 @@ Commands:
     create-vault       Create new vault.
     change-vault-pwd   Change vault password.
     move-to-vault      Move account to vault from another vault/root directory.
-    move-from-vault    Move account to root directory from given vault or root.
+    move-from-vault    Move account to root directory from given vault.
 ```
 
 ### Examples
@@ -337,11 +330,11 @@ ethstore move-from-vault 00e63fdb87ceb815ec96ae185b8f7381a0b4a5ea vault1 vault1_
 OK
 ```
 
---
+## Parity Ethereum toolchain
+_This project is a part of the Parity Ethereum toolchain._
 
-# Parity toolchain
+- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
-*this project is a part of the parity toolchain*
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
-
+- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/ethstore/) - Parity Ethereum key management.
-- [**ethkey**](https://github.com/paritytech/ethkey) - Ethereum keys generator and signer.
+- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/ethkey/) - Parity Ethereum keys generator.
-- [**ethstore**](https://github.com/paritytech/ethstore) - Ethereum key management.
+- [whisper](https://github.com/paritytech/parity-ethereum/blob/master/whisper/) - Implementation of Whisper-v2 PoC.
-- [**ethabi**](https://github.com/paritytech/ethabi) - Ethereum function calls encoding.

ethstore/cli/src/main.rs

@@ -38,8 +38,8 @@ use ethstore::{EthStore, SimpleSecretStore, SecretStore, import_accounts, Presal
 mod crack;
 
 pub const USAGE: &'static str = r#"
-Ethereum key management.
+Parity Ethereum key management tool.
-  Copyright 2016, 2017 Parity Technologies (UK) Ltd
+  Copyright 2015-2018 Parity Technologies (UK) Ltd.
 
 Usage:
     ethstore insert <secret> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
@@ -68,7 +68,7 @@ Options:
                              that this option is required when vault option is set.
                              Otherwise it is ignored.
     --src DIR                Specify import source. It may be either
-                             parity, parity-(chain), get, geth-test
+                             parity, parity-(chain), geth, geth-test
                              or a path [default: geth].
 
 Commands:

evmbin/README.md

@@ -0,0 +1,50 @@
+## evmbin
+
+EVM implementation for Parity.
+
+### Usage
+
+```
+EVM implementation for Parity.
+  Copyright 2015-2018 Parity Technologies (UK) Ltd.
+
+Usage:
+    parity-evm state-test <file> [--json --std-json --only NAME --chain CHAIN]
+    parity-evm stats [options]
+    parity-evm stats-jsontests-vm <file>
+    parity-evm [options]
+    parity-evm [-h | --help]
+
+Commands:
+    state-test         Run a state test from a json file.
+    stats              Execute EVM runtime code and return the statistics.
+    stats-jsontests-vm Execute standard json-tests format VMTests and return
+                       timing statistics in tsv format.
+
+Transaction options:
+    --code CODE        Contract code as hex (without 0x).
+    --to ADDRESS       Recipient address (without 0x).
+    --from ADDRESS     Sender address (without 0x).
+    --input DATA       Input data as hex (without 0x).
+    --gas GAS          Supplied gas as hex (without 0x).
+    --gas-price WEI    Supplied gas price as hex (without 0x).
+
+State test options:
+    --only NAME        Runs only a single test matching the name.
+    --chain CHAIN      Run only tests from specific chain.
+
+General options:
+    --json             Display verbose results in JSON.
+    --std-json         Display results in standardized JSON format.
+    --chain CHAIN      Chain spec file path.
+    -h, --help         Display this message and exit.
+```
+
+## Parity Ethereum toolchain
+_This project is a part of the Parity Ethereum toolchain._
+
+- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
+- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/ethstore/) - Parity Ethereum key management.
+- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/ethkey/) - Parity Ethereum keys generator.
+- [whisper](https://github.com/paritytech/parity-ethereum/blob/master/whisper/) - Implementation of Whisper-v2 PoC.

evmbin/src/main.rs

@@ -57,7 +57,7 @@ use info::Informant;
 
 const USAGE: &'static str = r#"
 EVM implementation for Parity.
-  Copyright 2016, 2017 Parity Technologies (UK) Ltd
+  Copyright 2015-2018 Parity Technologies (UK) Ltd.
 
 Usage:
     parity-evm state-test <file> [--json --std-json --only NAME --chain CHAIN]
@@ -69,8 +69,8 @@ Usage:
 Commands:
     state-test         Run a state test from a json file.
     stats              Execute EVM runtime code and return the statistics.
-    stats-jsontests-vm Execute standard jsontests format VMTests and return
+    stats-jsontests-vm Execute standard json-tests format VMTests and return
-                       timing statistcis in tsv format.
+                       timing statistics in tsv format.
 
 Transaction options:
     --code CODE        Contract code as hex (without 0x).

license_header

@@ -1,16 +1,16 @@
 // Copyright 2015-2018 Parity Technologies (UK) Ltd.
-// This file is part of Parity.
+// This file is part of Parity Ethereum.
 
-// Parity is free software: you can redistribute it and/or modify
+// Parity Ethereum is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
 // (at your option) any later version.
 
-// Parity is distributed in the hope that it will be useful,
+// Parity Ethereum is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 // GNU General Public License for more details.
 
 // You should have received a copy of the GNU General Public License
-// along with Parity.  If not, see <http://www.gnu.org/licenses/>.
+// along with Parity Ethereum.  If not, see <http://www.gnu.org/licenses/>.
 

parity/cli/usage_header.txt

@@ -1,3 +1,3 @@
-Parity. Ethereum Client.
+Parity Ethereum Client.
 	By Wood/Paronyan/Kotewicz/Drwięga/Volf et al.
-	Copyright 2015, 2016, 2017, 2018 Parity Technologies (UK) Ltd
+	Copyright 2015-2018 Parity Technologies (UK) Ltd.

parity/cli/version.txt

@@ -1,6 +1,6 @@
-Parity
+Parity Ethereum
   version {}
-Copyright 2015, 2016, 2017, 2018 Parity Technologies (UK) Ltd
+Copyright 2015-2018 Parity Technologies (UK) Ltd.
 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
 This is free software: you are free to change and redistribute it.
 There is NO WARRANTY, to the extent permitted by law.

scripts/parity.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=Parity Daemon
+Description=Parity Ethereum Daemon
 After=network.target
 
 [Service]

snap/gui/parity.desktop

@@ -1,8 +1,8 @@
 [Desktop Entry]
 Type=Application
 Encoding=UTF-8
-Name=parity
+Name=Parity Ethereum
-Comment=Fast, light, robust Ethereum implementation
+Comment=The fastest and most advanced Ethereum client.
 Exec=parity
 Icon=/usr/share/pixmaps/icon.png
 Terminal=true

test.sh

@@ -41,14 +41,13 @@ echo "________Validate chainspecs________"
 time ./scripts/validate_chainspecs.sh
 fi
 
-
 # Running the C++ example
 echo "________Running the C++ example________"
 cd parity-clib-examples/cpp && \
   mkdir -p build && \
   cd build && \
   cmake .. && \
-  make && \
+  make -j 8 && \
   ./parity-example && \
   cd .. && \
   rm -rf build && \

util/macros/Cargo.toml

@@ -2,5 +2,3 @@
 name = "macros"
 version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
-
-[dependencies]

util/mem/Cargo.toml

@@ -2,5 +2,3 @@
 name = "mem"
 version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
-
-[dependencies]

util/stop-guard/Cargo.toml

@@ -2,5 +2,3 @@
 name = "stop-guard"
 version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
-
-[dependencies]

util/unexpected/Cargo.toml

@@ -2,5 +2,3 @@
 name = "unexpected"
 version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
-
-[dependencies]

util/using_queue/Cargo.toml

@@ -2,5 +2,3 @@
 name = "using_queue"
 version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
-
-[dependencies]

util/version/Cargo.toml

@@ -2,7 +2,7 @@
 # Make sure to update the service if it's moved or the structure is changed.
 [package]
 name = "parity-version"
-# NOTE: this value is used for Parity version string (via env CARGO_PKG_VERSION)
+# NOTE: this value is used for Parity Ethereum version string (via env CARGO_PKG_VERSION)
 version = "2.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 build = "build.rs"

whisper/README.md

@@ -1,3 +1,30 @@
-# Whisper
+## Whisper
 
 Implementation of Whisper based on the Whisper-v2 PoC.
+
+### Usage
+
+```
+Parity Whisper-v2 CLI.
+	Copyright 2015-2018 Parity Technologies (UK) Ltd.
+
+Usage:
+	whisper [options]
+	whisper [-h | --help]
+
+Options:
+	--whisper-pool-size SIZE       Specify Whisper pool size [default: 10].
+	-p, --port PORT                Specify which RPC port to use [default: 8545].
+	-a, --address ADDRESS          Specify which address to use [default: 127.0.0.1].
+	-l, --log LEVEL                Specify the logging level. Must conform to the same format as RUST_LOG [default: Error].
+	-h, --help                     Display this message and exit.
+```
+
+## Parity Ethereum toolchain
+_This project is a part of the Parity Ethereum toolchain._
+
+- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
+- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/ethstore/) - Parity Ethereum key management.
+- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/ethkey/) - Parity Ethereum keys generator.
+- [whisper](https://github.com/paritytech/parity-ethereum/blob/master/whisper/) - Implementation of Whisper-v2 PoC.

whisper/cli/src/main.rs

@@ -48,8 +48,8 @@ use jsonrpc_http_server::{AccessControlAllowOrigin, DomainsValidation};
 
 const POOL_UNIT: usize = 1024 * 1024;
 const USAGE: &'static str = r#"
-Whisper CLI.
+Parity Whisper-v2 CLI.
-	Copyright 2018 Parity Technologies (UK) Ltd
+	Copyright 2015-2018 Parity Technologies (UK) Ltd.
 
 Usage:
 	whisper [options]