Skip to content
The fast, light, and robust EVM and WASM client.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.cargo Enable aesni (#10756) Jun 18, 2019
.github docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
accounts ethkey no longer uses byteorder (#10786) Jun 26, 2019
chainspec docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
cli-signer docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
docs docs: add changelogs for 2.3.{6,7,8} and 2.4.{1,2,3} (#10494) Mar 22, 2019
ethash docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
ethcore Log validator set changes in EpochManager (#10734) Jun 25, 2019
evmbin docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
ipfs docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
json docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
miner docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
parity-clib CI improvements (#10579) Apr 12, 2019
parity docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
rpc docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
scripts Enable aesni (#10756) Jun 18, 2019
secret-store docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
updater updater: fix static id hashes initialization (#10755) Jun 17, 2019
util Updated blooms-db to rust 2018 and removed redundant deps (#10785) Jun 26, 2019
whisper docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
.dockerignore improved dockerfile builds (#5659) May 23, 2017
.editorconfig Fix checksums and auto-update push (#7846) Feb 13, 2018
.gitignore Move the C/C++ example to another directory (#9032) Jul 4, 2018
.gitlab-ci.yml Update publishing (#10644) May 31, 2019
.gitmodules WASM contracts MVP (#5679) Jul 10, 2017
CHANGELOG.md docs: add changelogs for 2.3.{6,7,8} and 2.4.{1,2,3} (#10494) Mar 22, 2019
Cargo.lock Updated blooms-db to rust 2018 and removed redundant deps (#10785) Jun 26, 2019
Cargo.toml Remove calls to heapsize (#10432) Jun 19, 2019
LICENSE Change to library. Nov 24, 2015
README.md docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac… Jun 25, 2019
SECURITY.md Update SECURITY.md Jan 25, 2018
license_header misc: bump license header to 2019 (#10135) Jan 7, 2019
rustfmt.toml Use memmap for dag cache (#6193) Sep 25, 2017

README.md

Parity Ethereum

The Fastest and most Advanced Ethereum Client.

» Download the latest release «

Table of Contents

  1. Description
  2. Technical Overview
  3. Building
    3.1 Building Dependencies
    3.2 Building from Source Code
    3.3 Simple One-Line Installer for Mac and Linux
    3.4 Starting Parity Ethereum
  4. Documentation
  5. Toolchain
  6. Community
  7. Contributing
  8. License

1. Description

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.

  • Clean, modular codebase for easy customisation
  • Advanced CLI-based client
  • Minimal memory and storage footprint
  • Synchronise in hours, not days with Warp Sync
  • Modular for light integration into your service or product

2. Technical Overview

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.1. 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.

3. Building

3.1 Build Dependencies

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.

3.2 Build from Source Code

# 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

3.3 Simple One-Line Installer for Mac and Linux

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

3.4 Starting Parity Ethereum

Manually

To start Parity Ethereum manually, just run

$ ./target/release/parity

so Parity Ethereum begins syncing the Ethereum blockchain.

Using systemd service file

To start Parity Ethereum as a regular user using systemd init:

  1. Copy ./scripts/parity.service to your systemd user directory (usually ~/.config/systemd/user).
  2. Copy release to bin folder, write sudo install ./target/release/parity /usr/bin/parity
  3. To configure Parity Ethereum, write a /etc/parity/config.toml config file, see Configuring Parity Ethereum for details.

4. Documentation

Official website: https://parity.io

Be sure to check out our wiki for more information.

Viewing documentation for Parity Ethereum packages

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 --open
    
  • Specific package

    cargo doc --package <spec> --open
    

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
    parity-ethereum
  • Parity Ethereum Account Management, Key Management Tool, and Keys Generator
    ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
  • Parity Chain Specification
    chainspec
  • Parity CLI Signer Tool & RPC Client
    cli-signer parity-rpc-client
  • Parity Ethereum Ethash & ProgPoW Implementations
    ethash
  • Parity (EthCore) Library
    ethcore
    • Parity Ethereum Blockchain Database, Test Generator, Configuration, Caching, Importing Blocks, and Block Information
      ethcore-blockchain
    • Parity Ethereum (EthCore) Contract Calls and Blockchain Service & Registry Information
      ethcore-call-contract
    • Parity Ethereum (EthCore) Database Access & Utilities, Database Cache Manager
      ethcore-db
    • Parity Ethereum Virtual Machine (EVM) Rust Implementation
      evm
    • Parity Ethereum (EthCore) Light Client Implementation
      ethcore-light
    • Parity Smart Contract based Node Filter, Manage Permissions of Network Connections
      node-filter
    • Parity Private Transactions
      ethcore-private-tx
    • Parity Ethereum (EthCore) Client & Network Service Creation & Registration with the I/O Subsystem
      ethcore-service
    • Parity Ethereum (EthCore) Blockchain Synchronization
      ethcore-sync
    • Parity Ethereum Common Types
      common-types
    • Parity Ethereum Virtual Machines (VM) Support Library
      vm
    • Parity Ethereum WASM Interpreter
      wasm
    • Parity Ethereum WASM Test Runner
      pwasm-run-test
    • Parity EVM Implementation
      evmbin
    • Parity Ethereum IPFS-compatible API
      parity-ipfs-api
    • Parity Ethereum JSON Deserialization
      ethjson
    • Parity Ethereum State Machine Generalization for Consensus Engines
      parity-machine
  • Parity Ethereum (EthCore) Miner Interface
    ethcore-miner parity-local-store price-info ethcore-stratum using_queue
  • Parity Ethereum (EthCore) Logger Implementation
    ethcore-logger
  • C bindings library for the Parity Ethereum client
    parity-clib
  • Parity Ethereum JSON-RPC Servers
    parity-rpc
  • Parity Ethereum (EthCore) Secret Store
    ethcore-secretstore
  • Parity Updater Service
    parity-updater parity-hash-fetch
  • Parity Core Libraries (Parity Util)
    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
  • Parity Whisper Protocol Implementation
    parity-whisper whisper-cli

Contributing to documentation for Parity Ethereum packages

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
/// ```
///

5. Toolchain

In addition to the Parity Ethereum client, there are additional tools in this repository available:

  • evmbin - Parity Ethereum EVM Implementation.
  • ethstore - Parity Ethereum Key Management.
  • ethkey - Parity Ethereum Keys Generator.
  • whisper - Parity Ethereum Whisper-v2 PoC Implementation.

The following tool is available in a separate repository:

6. Community

Join the chat!

Questions? Get in touch with us on Gitter: Gitter: Parity Gitter: Parity.js Gitter: Parity/Miners Gitter: Parity-PoA

Alternatively, join our community on Matrix: Riot: +Parity

7. Contributing

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.

Contributor Code of Conduct

CODE_OF_CONDUCT

8. License

LICENSE

You can’t perform that action at this time.