Skip to content
README.md 2.95 KiB
Newer Older
asynchronous rob's avatar
asynchronous rob committed
# [Parity](https://ethcore.io/parity.html)
### Fast, light, and robust Ethereum implementation
[![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Join the chat at https://gitter.im/trogdoro/xiki][gitter-image]][gitter-url] [![GPLv3][license-image]][license-url]
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]: http://www.gnu.org/licenses/gpl-3.0.en.html
asynchronous rob's avatar
asynchronous rob committed
[Internal Documentation](http://ethcore.github.io/parity/ethcore/index.html)
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!

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

----

## Building from source

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
Gav Wood's avatar
Gav Wood committed
```
- Windows

Make sure you have Visual Studio 2015 with C++ support installed, download and run [rustup](https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe) and use the following command to setup msvc toolchain:

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

Gav Wood's avatar
Gav Wood committed
Then, download and build Parity:
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
asynchronous rob's avatar
asynchronous rob committed

This will produce an executable in the `target/release` subdirectory.
Either run `cd target/release`, or copy `target/release/parity` to another location.

To get started, just run
```bash
$ parity
```

and parity will begin syncing the Ethereum blockchain.