Skip to content
README.md 3.68 KiB
Newer Older
asynchronous rob's avatar
asynchronous rob committed
# [Parity](https://ethcore.io/parity.html)
### Fast, light, and robust Ethereum implementation
asynchronous rob's avatar
asynchronous rob committed
[![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Join the chat at https://gitter.im/ethcore/parity][gitter-image]][gitter-url] [![GPLv3][license-image]][license-url]

[Internal Documentation][doc-url]

Be sure to check out [our wiki][wiki-url] for more information.
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
[travis-image]: https://travis-ci.org/ethcore/parity.svg?branch=master
[travis-url]: https://travis-ci.org/ethcore/parity
Marek Kotewicz's avatar
Marek Kotewicz committed
[coveralls-image]: https://coveralls.io/repos/github/ethcore/parity/badge.svg?branch=master
Marek Kotewicz's avatar
Marek Kotewicz committed
[coveralls-url]: https://coveralls.io/github/ethcore/parity?branch=master
Gav Wood's avatar
Gav Wood committed
[gitter-image]: https://badges.gitter.im/Join%20Chat.svg
[gitter-url]: https://gitter.im/ethcore/parity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[license-image]: https://img.shields.io/badge/license-GPL%20v3-green.svg
[license-url]: https://www.gnu.org/licenses/gpl-3.0.en.html
[doc-url]: https://ethcore.github.io/parity/ethcore/index.html
asynchronous rob's avatar
asynchronous rob committed
[wiki-url]: https://github.com/ethcore/parity/wiki
Marek Kotewicz's avatar
Marek Kotewicz committed

asynchronous rob's avatar
asynchronous rob committed
----
asynchronous rob's avatar
asynchronous rob committed
## 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][gitter-url] to ask a question. We are glad to help!
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
Parity's current release is 1.3. You can download it at https://ethcore.io/parity.html or follow the instructions
asynchronous rob's avatar
asynchronous rob committed
below to build from source.

----

Marek Kotewicz's avatar
Marek Kotewicz committed
## Build dependencies
asynchronous rob's avatar
asynchronous rob committed

Parity is fully compatible with Stable Rust.

Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have rustup, you can install it like this:
- Linux and OSX:
	```bash
	$ curl https://sh.rustup.rs -sSf | sh
	```
asynchronous rob's avatar
asynchronous rob committed
    Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
	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
    ```
Marek Kotewicz's avatar
Marek Kotewicz committed
Once you have rustup, install parity or download and build from source

----

## Quick install

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

----

## Build from source
Gav Wood's avatar
Gav Wood committed
# download Parity code
asynchronous rob's avatar
asynchronous rob committed
$ git clone https://github.com/ethcore/parity
$ cd parity
Gav Wood's avatar
Gav Wood committed
# build in release mode
asynchronous rob's avatar
asynchronous rob committed
$ cargo build --release
This will produce an executable in the `./target/release` subdirectory.
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
## Start Parity
### Manually
Gabx's avatar
Gabx committed
To start Parity manually, just run
asynchronous rob's avatar
asynchronous rob committed
```bash
$ ./target/release/parity
Gabx's avatar
Gabx committed
and Parity will begin syncing the Ethereum blockchain.
Gabx's avatar
Gabx committed

Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
### Using systemd service file
Gabx's avatar
Gabx committed
To start Parity as a regular user using systemd init:
Gabx's avatar
Gabx committed

Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
1. Copy ```parity/scripts/parity.service``` to your
Gabx's avatar
Gabx committed
systemd user directory (usually ```~/.config/systemd/user```).
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
2. To pass any argument to Parity, write a ```~/.parity/parity.conf``` file this way:
Gabx's avatar
Gabx committed
```ARGS="ARG1 ARG2 ARG3"```.

Gabx's avatar
Gabx committed
	Example: ```ARGS="ui --geth --identity MyMachine"```.