Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Commit

Permalink
Random small cleanups (#9423)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
5chdn committed Aug 30, 2018
1 parent 8a5c9a8 commit c658b46
Show file tree
Hide file tree
Showing 27 changed files with 165 additions and 108 deletions.
8 changes: 4 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ 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?

Also, try to include **steps to reproduce** the issue and expand on the **actual versus expected behavior**.

## 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.
14 changes: 6 additions & 8 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
_Before filing a new issue, please **provide the following information**._

> I'm running:
>
> - **Which Parity version?**: 0.0.0
> - **Which operating system?**: Windows / MacOS / Linux
> - **How installed?**: via installer / homebrew / binaries / from source
> - **Are you fully synchronized?**: no / yes
> - **Which network are you connected to?**: ethereum / ropsten / kovan / ...
> - **Did you try to restart the node?**: no / yes
- **Parity Ethereum version**: 0.0.0
- **Operating system**: Windows / MacOS / Linux
- **Installation**: homebrew / one-line installer / built from source
- **Fully synchronized**: no / yes
- **Network**: ethereum / ropsten / kovan / ...
- **Restarted**: no / yes

_Your issue description goes here below. Try to include **actual** vs. **expected behavior** and **steps to reproduce** the issue._

10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion chainspec/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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" }
Expand Down
2 changes: 0 additions & 2 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -20,7 +19,6 @@ PARITY_RUNNER_IMAGE_TAG=centos-parity-experimental \
./docker/centos/build.sh
```


Default values:
```
# The image name
Expand Down
2 changes: 0 additions & 2 deletions ethash/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
44 changes: 19 additions & 25 deletions ethkey/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
# ethkey
## ethkey-cli

[![Build Status][travis-image]][travis-url]

[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)
Parity Ethereum keys generator.

### Usage

```
Ethereum keys generator.
Copyright 2016, 2017 Parity Technologies (UK) Ltd
Parity Ethereum keys generator.
Copyright 2015-2018 Parity Technologies (UK) Ltd.
Usage:
ethkey info <secret-or-phrase> [options]
Expand All @@ -27,17 +20,17 @@ Usage:
Options:
-h, --help Display this message and exit.
-s, --secret Display only the secret.
-p, --public Display only the public.
-s, --secret Display only the secret key.
-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.
generate random Generates new random ethereum key.
generate prefix Random generation, but address must start with a prefix.
sign Sign message using secret.
verify Verify signer of the signature.
info Display public key and address of the secret.
generate random Generates new random Ethereum key.
generate prefix Random generation, but address must start with a prefix ("vanity address").
sign Sign message using a secret key.
verify Verify signer of the signature by public key or address.
recover Try to find brain phrase matching given address from partial phrase.
```

Expand Down Expand Up @@ -218,10 +211,11 @@ public: 4e19a5fdae82596e1485c69b687c9cc52b5078e5b0668ef3ce8543cd90e712cb00df822
address: 00cf3711cbd3a1512570639280758118ba0b2bcb
```

## Parity Ethereum toolchain
_This project is a part of the Parity Ethereum toolchain._

# Parity toolchain
*this project is a part of the parity toolchain*

- [**ethkey**](https://github.com/paritytech/ethkey) - Ethereum keys generator and signer.
- [**ethstore**](https://github.com/paritytech/ethstore) - Ethereum key management.
- [**ethabi**](https://github.com/paritytech/ethabi) - Ethereum function calls encoding.
- [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.
20 changes: 10 additions & 10 deletions ethkey/cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copyright 2016, 2017 Parity Technologies (UK) Ltd
Parity Ethereum keys generator.
Copyright 2015-2018 Parity Technologies (UK) Ltd.
Usage:
ethkey info <secret-or-phrase> [options]
Expand All @@ -49,17 +49,17 @@ Usage:
Options:
-h, --help Display this message and exit.
-s, --secret Display only the secret.
-p, --public Display only the public.
-s, --secret Display only the secret key.
-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.
generate random Generates new random ethereum key.
generate prefix Random generation, but address must start with a prefix.
sign Sign message using secret.
verify Verify signer of the signature.
info Display public key and address of the secret.
generate random Generates new random Ethereum key.
generate prefix Random generation, but address must start with a prefix ("vanity address").
sign Sign message using a secret key.
verify Verify signer of the signature by public key or address.
recover Try to find brain phrase matching given address from partial phrase.
"#;

Expand Down
37 changes: 15 additions & 22 deletions ethstore/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
# ethstore
## ethstore-cli

[![Build Status][travis-image]][travis-url]

[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)
Parity Ethereum key management.

### Usage

```
Ethereum key management.
Copyright 2016, 2017 Parity Technologies (UK) Ltd
Parity Ethereum key management tool.
Copyright 2015-2018 Parity Technologies (UK) Ltd.
Usage:
ethstore insert <secret> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
Expand All @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -337,11 +330,11 @@ ethstore move-from-vault 00e63fdb87ceb815ec96ae185b8f7381a0b4a5ea vault1 vault1_
OK
```

--

# Parity toolchain
*this project is a part of the parity toolchain*
## Parity Ethereum toolchain
_This project is a part of the Parity Ethereum toolchain._

- [**ethkey**](https://github.com/paritytech/ethkey) - Ethereum keys generator and signer.
- [**ethstore**](https://github.com/paritytech/ethstore) - Ethereum key management.
- [**ethabi**](https://github.com/paritytech/ethabi) - Ethereum function calls encoding.
- [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.
6 changes: 3 additions & 3 deletions ethstore/cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ use ethstore::{EthStore, SimpleSecretStore, SecretStore, import_accounts, Presal
mod crack;

pub const USAGE: &'static str = r#"
Ethereum key management.
Copyright 2016, 2017 Parity Technologies (UK) Ltd
Parity Ethereum key management tool.
Copyright 2015-2018 Parity Technologies (UK) Ltd.
Usage:
ethstore insert <secret> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
Expand Down Expand Up @@ -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:
Expand Down
50 changes: 50 additions & 0 deletions evmbin/README.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 4 additions & 4 deletions evmbin/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
timing statistcis in tsv format.
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).
Expand All @@ -86,7 +86,7 @@ State test options:
General options:
--json Display verbose results in JSON.
--std-json Display results in standardized JSON format.
--std-json Display results in standardized JSON format.
--chain CHAIN Chain spec file path.
-h, --help Display this message and exit.
"#;
Expand Down
8 changes: 4 additions & 4 deletions license_header
Original file line number Diff line number Diff line change
@@ -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/>.

Loading

0 comments on commit c658b46

Please sign in to comment.