openethereum/README.md
sandakersmann 09210269c9 Changed http:// to https:// on some links (#2349)
Changed http:// to https:// on some links in README.md
2016-09-27 08:02:26 +02:00

3.7 KiB

Parity

Fast, light, and robust Ethereum implementation

Build Status Coverage Status Join the chat at https://gitter.im/ethcore/parity GPLv3

Internal Documentation

Be sure to check out our wiki for more information.


About Parity

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

By default, Parity will run a JSONRPC server on 127.0.0.1:8545. This is fully configurable and supports a number of RPC APIs.

Parity also runs a server for running decentralized apps, or "Dapps", on http://127.0.0.1:8080. This includes a few useful Dapps, including Ethereum Wallet, Maker OTC, and a node status page. In a near-future release, it will be easy to install Dapps and use them through this web interface.

If you run into an issue while using parity, feel free to file one in this repository or hop on our gitter chat room to ask a question. We are glad to help!

Parity's current release is 1.3. You can download it at https://ethcore.io/parity.html or follow the instructions below to build from source.


Build dependencies

Parity is fully compatible with Stable Rust.

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

  • Linux and OSX:

    $ curl https://sh.rustup.rs -sSf | sh
    
  • 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, install parity or download and build from source


Quick install

cargo install --git https://github.com/ethcore/parity.git parity

Build from source

# download Parity code
$ git clone https://github.com/ethcore/parity
$ cd parity

# build in release mode
$ cargo build --release

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

Start Parity

Manually

To start Parity manually, just run

$ ./target/release/parity

and Parity will begin syncing the Ethereum blockchain.

Using systemd service file

To start Parity as a regular user using systemd init:

  1. Copy parity/scripts/parity.service to your systemd user directory (usually ~/.config/systemd/user).

  2. To pass any argument to Parity, write a ~/.parity/parity.conf file this way: ARGS="ARG1 ARG2 ARG3".

    Example: ARGS="ui --geth --identity MyMachine".