The Fastest and most Advanced Ethereum Client

Overview

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. Testing
  5. Documentation
  6. Toolchain
  7. Community
  8. Contributing
  9. 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.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.

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

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 
         
    
         

Replace 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)

5. 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 --document-private-items --open
    
  • Specific package

    cargo doc --package 
         
           -- --document-private-items --open
    
         

Use--document-private-items to also view private documentation and --no-deps to exclude building documentation for dependencies.

Replacing with one of the following from the details section below (i.e. cargo doc --package parity-ethereum --open):

Package List

  • 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

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

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

The following tool is available in a separate repository:

  • ethabi - Parity Ethereum Encoding of Function Calls. Docs here
  • whisper - Parity Ethereum Whisper-v2 PoC Implementation.

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

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

9. License

LICENSE

You might also like...
Benchmarks of most widely used web frameworks built in rust.
Benchmarks of most widely used web frameworks built in rust.

Rust framework benchmarks Benchmarking utility to test the performance of all the rust web frameworks. Built with rust 🚀 . Demo (Last updated: Thu Ju

Terabethia - A Bridge and Messaging Protocol between Ethereum and the Internet Computer.
Terabethia - A Bridge and Messaging Protocol between Ethereum and the Internet Computer.

Terabethia - A Bridge Between Ethereum & the Internet Computer Terabethia is a bridge between Ethereum & the Internet Computer that contracts in both

Complete Ethereum and Celo wallet implementation and utilities in Rust

ethers.rs Complete Ethereum and Celo wallet implementation and utilities in Rust Documentation Extensive documentation and examples are available here

An Ethereum compatible Substrate blockchain for bounties and governance for the Devcash community.

Substrate Node Template A fresh FRAME-based Substrate node, ready for hacking 🚀 Getting Started Follow the steps below to get started with the Node T

zkSync: trustless scaling and privacy engine for Ethereum

zkSync: scaling and privacy engine for Ethereum zkSync is a scaling and privacy engine for Ethereum. Its current functionality scope includes low gas

Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.

foundry Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust. Foundry consists of: Forge: Ethe

A library to help you sew up your Ethereum project with Rust and just like develop in a common backend

SewUp Secondstate EWasm Utility Program, a library helps you sew up your Ethereum project with Rust and just like development in a common backend. The

MangoBOX is a fork and upgrade of fund-raising protocol Juicebox on Ethereum.

Mangoboxink MangoBOX is a fork and upgrade of fund-raising protocol Juicebox on Ethereum. It rewrites the logic and functions of Juicebox in the smart

Parser and test runner for testing compatable common Ethereum full node tests against Polygon Zero's EVM.

EVM Test Parses and runs compatible common Ethereum tests from ethereum/tests against Polygon Zero's EVM. Note: This repo is currently very early in d

Owner
Jay Lee
Blockchain Developer | Solidity, React, Ethereum, Node.js, Solana, Rust, Anchor
Jay Lee
Heimdall is an advanced Ethereum smart contract toolkit for forensic and heuristic analysis.

Heimdall is an advanced EVM toolkit which aims to make dealing with smart contracts on EVM based chains easier. Installation & Usage Heimdall's update

Jonathan Becker 426 Nov 24, 2022
Substreams development kit for Ethereum chains, contains Firehose Block model and helpers as well as utilities for Ethereum ABI encoding/decoding.

Substreams Ethereum Substreams development kit for Ethereum chains, contains Rust Firehose Block model and helpers as well as utilities for Ethereum A

StreamingFast 15 Oct 25, 2022
The fast, light, and robust client for the Ethereum mainnet.

OpenEthereum Fast and feature-rich multi-network Ethereum client. » Download the latest release « Table of Contents Description Technical Overview Bui

OpenEthereum 1.6k Nov 29, 2022
Rust client to Opensea's APIs and Ethereum smart contracts

opensea.rs Rust bindings & CLI to the Opensea API and Contracts CLI Usage Run cargo r -- --help to get the top level help menu: opensea-cli 0.1.0 Choo

Georgios Konstantopoulos 222 Nov 27, 2022
The fast, light, and robust client for Ethereum-like networks.

The Fastest and most Advanced Ethereum Client. » Download the latest release « Table of Contents Description Technical Overview Building 3.1 Building

OpenEthereum 6.7k Nov 23, 2022
Rust client to Seaport's APIs and Ethereum smart contracts(WIP)

Seaport-rs WIP - WORK IN PROGRESS. REFER TO https://github.com/Alcibiades-Capital/quay FOR PRODUCTION READY CODE I'm new to Rust and seek to be legend

Perelyn 19 Oct 26, 2022
Rust Ethereum 2.0 Client

Lighthouse: Ethereum 2.0 An open-source Ethereum 2.0 client, written in Rust and maintained by Sigma Prime. Documentation Overview Lighthouse is: Read

Sigma Prime 2.1k Nov 26, 2022
Next-generation implementation of Ethereum protocol ("client") written in Rust, based on Erigon architecture.

?? Martinez ?? Next-generation implementation of Ethereum protocol ("client") written in Rust, based on Erigon architecture. Why run Martinez? Look at

Arthur·Thomas 23 Jul 3, 2022
Ethereum JSON-RPC multi-transport client. Rust implementation of web3 library

Ethereum JSON-RPC multi-transport client. Rust implementation of web3 library. ENS address: rust-web3.eth

Tomasz Drwięga 1.1k Nov 20, 2022
Aptos-core strives towards being the safest and most scalable layer one blockchain solution.

Aptos-core strives towards being the safest and most scalable layer one blockchain solution. Today, this powers the Aptos Devnet, tomorrow Mainnet in order to create universal and fair access to decentralized assets for billions of people.

Aptos Labs 4.6k Dec 1, 2022