cd26526868
* Add client-traits crate Move the BlockInfo trait to new crate * New crate `machine` Contains code extracted from ethcore that defines `Machine`, `Externalities` and other execution related code. * Use new machine and client-traits crates in ethcore * Use new crates machine and client-traits instead of ethcore where appropriate * Fix tests * Don't re-export so many types from ethcore::client * Fixing more fallout from removing re-export * fix test * More fallout from not re-exporting types * Add some docs * cleanup * import the macro edition style * Tweak docs * Add missing import * remove unused ethabi_derive imports * Use latest ethabi-contract * Move many traits from ethcore/client/traits to client-traits crate Initial version of extracted Engine trait * Move snapshot related traits to the engine crate (eew) * Move a few snapshot related types to common_types Cleanup Executed as exported from machine crate * fix warning * Gradually introduce new engine crate: snapshot * ethcore typechecks with new engine crate * Sort out types outside ethcore * Add an EpochVerifier to ethash and use that in Engine.epoch_verifier() Cleanup * Document pub members * Sort out tests Sort out default impls for EpochVerifier * Add test-helpers feature and move EngineSigner impl to the right place * Sort out tests * Sort out tests and refactor verification types * Fix missing traits * More missing traits Fix Histogram * Fix tests and cleanup * cleanup * Put back needed logger import * Don't rexport common_types from ethcore/src/client Don't export ethcore::client::* * Remove files no longer used Use types from the engine crate Explicit exports from engine::engine * Get rid of itertools * Move a few more traits from ethcore to client-traits: BlockChainReset, ScheduleInfo, StateClient * Move ProvingBlockChainClient to client-traits * Don't re-export ForkChoice and Transition from ethcore * Address grumbles: sort imports, remove commented out code * Fix merge resolution error * Extract the Clique engine to own crate * Extract NullEngine and the block_reward module from ethcore * Extract InstantSeal engine to own crate * Extract remaining engines * Extract executive_state to own crate so it can be used by engine crates * Remove snapshot stuff from the engine crate * Put snapshot traits back in ethcore * cleanup * Remove stuff from ethcore * Don't use itertools * itertools in aura is legit-ish * More post-merge fixes * Re-export less types in client * cleanup * Extract spec to own crate * Put back the test-helpers from basic-authority * Fix ethcore benchmarks * Reduce the public api of ethcore/verification * WIP * Add Cargo.toml * Fix compilation outside ethcore * Audit uses of import_verified_blocks() and remove unneeded calls Cleanup * cleanup * Remove unused imports from ethcore * Cleanup * remove double semi-colons * Add missing generic param * More missing generics * Update ethcore/block-reward/Cargo.toml Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * Update ethcore/engines/basic-authority/Cargo.toml Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * Update ethcore/engines/ethash/Cargo.toml Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * Update ethcore/engines/clique/src/lib.rs Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * signers is already a ref * Add an EngineType enum to tighten up Engine.name() * Introduce Snapshotting enum to distinguish the type of snapshots a chain uses * Rename supports_warp to snapshot_mode * Missing import * Update ethcore/src/snapshot/consensus/mod.rs Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * missing import * Fix import * double semi * Fix merge problem * cleanup * Parametrise `ClientIoMessage` with `()` for the light client * Add impl Tick for () * Address review feedback * Move ClientIoMessage to common-types * remove superseeded fixme * fix merge conflict errors |
||
---|---|---|
.cargo | ||
.github | ||
accounts | ||
chainspec | ||
cli-signer | ||
docs | ||
ethash | ||
ethcore | ||
evmbin | ||
ipfs | ||
json | ||
miner | ||
parity | ||
parity-clib | ||
rpc | ||
scripts | ||
secret-store | ||
updater | ||
util | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
.gitlab-ci.yml | ||
.gitmodules | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
LICENSE | ||
license_header | ||
README.md | ||
rustfmt.toml | ||
SECURITY.md |
The Fastest and most Advanced Ethereum Client.
» Download the latest release «
Table of Contents
- Description
- Technical Overview
- 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 - Testing
- Documentation
- Toolchain
- Community
- Contributing
- 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
, andcmake
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 themsvc
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:
- Copy
./scripts/parity.service
to yoursystemd
user directory (usually~/.config/systemd/user
). - Copy release to bin folder, write
sudo install ./target/release/parity /usr/bin/parity
- To configure Parity Ethereum, write a
/etc/parity/config.toml
config file, see Configuring Parity Ethereum for details.
4. Testing
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
)
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 <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
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 Blockchain Database, Test Generator, Configuration,
Caching, Importing Blocks, and Block Information
- 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:
Alternatively, join our community on Matrix:
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.