openethereum/README.md

Parity-Ethereum - a fast, light, and robust EVM and WASM blockchain client

» Download the latest release «

Join the chat!

Get in touch with us on Gitter:

Or join our community on Matrix:

Official website: https://parity.io | Be sure to check out our wiki for more information.

---

About Parity-Ethereum

Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3, and can be used for all your Ethereum needs.

By default, Parity-Ethereum will run a JSON-RPC HTTP server on 127.0.0.1:8545 and a Web-Sockets server on 127.0.0.1:8546. This is fully configurable and supports a number of APIs.

If you run into problems while using Parity-Ethereum, feel free to file an issue in this repository or hop on our Gitter or Riot chat room to ask a question. We are glad to help! For security-critical issues, please refer to the security policy outlined in SECURITY.md.

Parity-Ethereum's current beta-release is 2.0. You can download it at the releases page or follow the instructions below to build from source. Please, mind the CHANGELOG.md for a list of all changes between different versions.

---

Build dependencies

Parity-Ethereum requires Rust version 1.27.0 to build

We recommend installing Rust through rustup. If you don't already have rustup, you can install it like this:

• Linux:

  $ curl https://sh.rustup.rs -sSf | sh
  

  Parity-Ethereum also requires gcc, g++, libudev-dev, pkg-config, file, make, and cmake packages to be installed.

• OSX:

  $ curl https://sh.rustup.rs -sSf | sh
  

  clang is required. It comes with Xcode command line tools or can be installed with homebrew.

• Windows Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the msvc toolchain:

  $ rustup default stable-x86_64-pc-windows-msvc
  

Once you have rustup installed, then you need to install:

• Perl
• Yasm

Make sure that these binaries are in your PATH. After that you should be able to build Parity-Ethereum from source.

---

Install from the snap store

In any of the supported Linux distros:

sudo snap install parity

Or, if you want to contribute testing the upcoming release:

sudo snap install parity --beta

And to test the latest code landed into the master branch:

sudo snap install parity --edge

---

Build from source

# download Parity-Ethereum code
$ git clone https://github.com/paritytech/parity-ethereum
$ cd parity-ethereum

# build in release mode
$ cargo build --release --features final

This will produce an executable in the ./target/release subdirectory.

Note: if cargo fails to parse manifest try:

$ ~/.cargo/bin/cargo build --release

Note, when compiling a crate and you receive errors, it's in most cases your outdated version of Rust, or some of your crates have to be recompiled. Cleaning the repository will most likely solve the issue if you are on the latest stable version of Rust, try:

$ cargo clean

This will always compile the latest nightly builds. If you want to build stable or beta, do a

$ git checkout stable

or

$ git checkout beta

first.

---

Simple one-line installer for Mac and Ubuntu

bash <(curl https://get.parity.io -L)

The one-line installer always defaults to the latest beta release. To install a stable release, run:

bash <(curl https://get.parity.io -L) -r stable

Start Parity-Ethereum

Manually

To start Parity-Ethereum manually, just run

$ ./target/release/parity

and Parity-Ethereum will begin syncing the Ethereum blockchain.

Using systemd service file

To start Parity-Ethereum as a regular user using systemd init:

1. Copy ./scripts/parity.service to your systemd user directory (usually ~/.config/systemd/user).
2. To configure Parity-Ethereum, write a /etc/parity/config.toml config file, see Configuring Parity-Ethereum for details.