README.md
3.3 Simple One-Line Installer for Mac and Linux
3.4 Starting Parity Ethereum 4. Testing 5. Documentation 6. Toolchain 7. Community 8. Contributing 9. License
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):
<a id="package-list"></a> Package List
<details><p>parity-ethereum
ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
chainspec
cli-signer parity-rpc-client
ethash
ethcore
ethcore-blockchain
ethcore-call-contract
ethcore-db
evm
ethcore-light
node-filter
ethcore-private-tx
ethcore-service
ethcore-sync
common-types
vm
wasm
pwasm-run-test
evmbin
parity-ipfs-api
ethjson
parity-machine
ethcore-miner parity-local-store price-info ethcore-stratum using_queue
ethcore-logger
parity-clib
parity-rpc
ethcore-secretstore
parity-updater parity-hash-fetch
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.