» Download the latest release «
Built for mission-critical use: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Parity Ethereum provides the core infrastructure essential for speedy and reliable services.
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 runs a JSON-RPC HTTP server on port :8545
and a Web-Sockets server on port :8546
. This is fully configurable and supports a number of APIs.
If you run into problems while using Parity Ethereum, check out the wiki for documentation, 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.6. 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.
Parity Ethereum requires latest stable Rust version 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++
, 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:
Make sure that these binaries are in your PATH
. After that, you should be able to build Parity Ethereum 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 produces 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 always compiles the latest nightly builds. If you want to build stable or beta, do a
$ git checkout stable
or
$ git checkout beta
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
To start Parity Ethereum manually, just run
$ ./target/release/parity
so Parity Ethereum begins syncing the Ethereum blockchain.
systemd
service fileTo start Parity Ethereum as a regular user using systemd
init:
./scripts/parity.service
to your
systemd
user directory (usually ~/.config/systemd/user
).sudo install ./target/release/parity /usr/bin/parity
/etc/parity/config.toml
config file, see Configuring Parity Ethereum for details.Download the required test files: git submodule update --init --recursive
. You can run tests with the following commands:
All packages
cargo test --all
Specific package
cargo test --package <spec>
Replace <spec>
with one of the packages from the package list (e.g. cargo test --package evmbin
).
You can show your logs in the test output by passing --nocapture
(i.e. cargo test --package evmbin -- --nocapture
)
Official website: https://parity.io
Be sure to check out our wiki for more information.
You can generate documentation for Parity Ethereum Rust packages that automatically opens in your web browser using rustdoc with Cargo (of the The Rustdoc Book), by running the the following commands:
All packages
cargo doc --document-private-items --open
Specific package
cargo doc --package <spec> -- --document-private-items --open
Use--document-private-items
to also view private documentation and --no-deps
to exclude building documentation for dependencies.
Replacing <spec>
with one of the following from the details section below (i.e. cargo doc --package parity-ethereum --open
):
* Parity Ethereum (EthCore) Client Application ```bash parity-ethereum ``` * Parity Ethereum Account Management, Key Management Tool, and Keys Generator ```bash ethcore-accounts, ethkey-cli, ethstore, ethstore-cli ``` * Parity Chain Specification ```bash chainspec ``` * Parity CLI Signer Tool & RPC Client ```bash cli-signer parity-rpc-client ``` * Parity Ethereum Ethash & ProgPoW Implementations ```bash ethash ``` * Parity (EthCore) Library ```bash ethcore ``` * Parity Ethereum Blockchain Database, Test Generator, Configuration, Caching, Importing Blocks, and Block Information ```bash ethcore-blockchain ``` * Parity Ethereum (EthCore) Contract Calls and Blockchain Service & Registry Information ```bash ethcore-call-contract ``` * Parity Ethereum (EthCore) Database Access & Utilities, Database Cache Manager ```bash ethcore-db ``` * Parity Ethereum Virtual Machine (EVM) Rust Implementation ```bash evm ``` * Parity Ethereum (EthCore) Light Client Implementation ```bash ethcore-light ``` * Parity Smart Contract based Node Filter, Manage Permissions of Network Connections ```bash node-filter ``` * Parity Private Transactions ```bash ethcore-private-tx ``` * Parity Ethereum (EthCore) Client & Network Service Creation & Registration with the I/O Subsystem ```bash ethcore-service ``` * Parity Ethereum (EthCore) Blockchain Synchronization ```bash ethcore-sync ``` * Parity Ethereum Common Types ```bash common-types ``` * Parity Ethereum Virtual Machines (VM) Support Library ```bash vm ``` * Parity Ethereum WASM Interpreter ```bash wasm ``` * Parity Ethereum WASM Test Runner ```bash pwasm-run-test ``` * Parity EVM Implementation ```bash evmbin ``` * Parity Ethereum IPFS-compatible API ```bash parity-ipfs-api ``` * Parity Ethereum JSON Deserialization ```bash ethjson ``` * Parity Ethereum State Machine Generalization for Consensus Engines ```bash parity-machine ``` * Parity Ethereum (EthCore) Miner Interface ```bash ethcore-miner parity-local-store price-info ethcore-stratum using_queue ``` * Parity Ethereum (EthCore) Logger Implementation ```bash ethcore-logger ``` * C bindings library for the Parity Ethereum client ```bash parity-clib ``` * Parity Ethereum JSON-RPC Servers ```bash parity-rpc ``` * Parity Ethereum (EthCore) Secret Store ```bash ethcore-secretstore ``` * Parity Updater Service ```bash parity-updater parity-hash-fetch ``` * Parity Core Libraries (Parity Util) ```bash ethcore-bloom-journal blooms-db dir eip-712 fake-fetch fastmap fetch ethcore-io journaldb keccak-hasher len-caching-lock macros memory-cache memzero migration-rocksdb ethcore-network ethcore-network-devp2p panic_hook patricia-trie-ethereum registrar rlp_compress rlp_derive parity-runtime stats time-utils triehash-ethereum unexpected parity-version ```
Document source code for Parity Ethereum packages by annotating the source code with documentation comments.
Example (generic documentation comment):
/// Summary
///
/// Description
///
/// # Panics
///
/// # Errors
///
/// # Safety
///
/// # Examples
///
/// Summary of Example 1
///
/// ```rust
/// // insert example 1 code here for use with documentation as tests
/// ```
///
In addition to the Parity Ethereum client, there are additional tools in this repository available:
The following tool is available in a separate repository:
Questions? Get in touch with us on Gitter:
Alternatively, join our community on Matrix:
An introduction has been provided in the "So You Want to be a Core Developer" presentation slides by Hernando Castano. Additional guidelines are provided in CONTRIBUTING.