Go to file
Wei Tang 0ecbb3ec02
Fork choice and metadata framework for Engine (#8401)
* Add light client TODO item

* Move existing total-difficulty-based fork choice check to Engine

* Abstract total difficulty and block provider as Machine::BlockMetadata and Machine::BlockProvider

* Decouple "generate_metadata" logic to Engine

* Use fixed BlockMetadata and BlockProvider type for null and instantseal

In this way they can use total difficulty fork choice check

* Extend blockdetails with metadatas and finalized info

* Extra data update: mark_finalized and update_metadatas

* Check finalized block in Blockchain

* Fix a test constructor in verification mod

* Add total difficulty trait

* Fix type import

* Db migration to V13 with metadata column

* Address grumbles

* metadatas -> metadata

* Use generic type for update_metadata to avoid passing HashMap all around

* Remove metadata in blockdetails

* [WIP] Implement a generic metadata architecture

* [WIP] Metadata insertion logic in BlockChain

* typo: Value -> Self::Value

* [WIP] Temporarily remove Engine::is_new_best interface

So that we don't have too many type errors.

* [WIP] Fix more type errors

* [WIP] ExtendedHeader::PartialEq

* [WIP] Change metadata type Option<Vec<u8>> to Vec<u8>

* [WIP] Remove Metadata Error

* [WIP] Clean up error conversion

* [WIP] finalized -> is_finalized

* [WIP] Mark all fields in ExtrasInsert as pub

* [WIP] Remove unused import

* [WIP] Keep only local metadata info

* Mark metadata as optional

* [WIP] Revert metadata db change in BlockChain

* [WIP] Put finalization in unclosed state

* Use metadata interface in BlockDetail

* [WIP] Fix current build failures

* [WIP] Remove unused blockmetadata struct

* Remove DB migration info

* [WIP] Typo

* Use ExtendedHeader to implement fork choice check

* Implement is_new_best using Ancestry iterator

* Use expect instead of panic

* [WIP] Add ancestry Engine support via on_new_block

* Fix tests

* Emission of ancestry actions

* use_short_version should take account of metadata

* Engine::is_new_best -> Engine::fork_choice

* Use proper expect format as defined in #1026

* panic -> expect

* ancestry_header -> ancestry_with_metadata

* Boxed iterator -> &mut iterator

* Fix tests

* is_new_best -> primitive_fork_choice

* Document how fork_choice works

* Engine::fork_choice -> Engine::primitive_fork_choice

* comment: clarify types of finalization where Engine::primitive_fork_choice works

* Expose FinalizationInfo to Engine

* Fix tests due to merging

* Remove TotalDifficulty trait

* Do not pass FinalizationInfo to Engine

If there's finalized blocks in from route, choose the old branch without calling `Engine::fork_choice`.

* Fix compile

* Fix unused import

* Remove is_to_route_finalized

When no block reorg passes a finalized block, this variable is always false.

* Address format grumbles

* Fix docs: mark_finalized returns None if block hash is not found

`blockchain` mod does not yet have an Error type, so we still temporarily use None here.

* Fix inaccurate tree_route None expect description
2018-05-16 14:58:01 +08:00
.cargo Statically link the C runtime on Windows (#7246) 2018-01-11 15:41:22 +01:00
.github Update issue template and readme (#7450) 2018-01-08 09:24:49 +01:00
chainspec Chainspec validation (#6197) 2017-08-02 12:50:36 +02:00
dapps Remove inject.js server-side injection for dapps (#8539) 2018-05-11 12:09:42 +02:00
devtools Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
docker Added Dockerfile for alpine linux by @andresilva, closes #3565 (#8587) 2018-05-09 23:28:16 +02:00
docs Update CHANGELOG for 1.9, 1.10, and 1.11 (#8556) 2018-05-09 14:11:36 +02:00
ethash Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
ethcore Fork choice and metadata framework for Engine (#8401) 2018-05-16 14:58:01 +08:00
ethkey Consolidate crypto functionality in `ethcore-crypto`. (#8432) 2018-05-05 11:02:33 +02:00
ethstore Use full qualified syntax for itertools::Itertools::flatten (#8606) 2018-05-14 09:22:59 +02:00
evmbin Bump ethabi & ethereum-types. (#8258) 2018-04-02 12:12:52 +01:00
hash-fetch Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
hw Hardware Wallet trait (#8071) 2018-05-01 15:01:49 +02:00
ipfs Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
json EIP 145: Bitwise shifting instructions in EVM (#8451) 2018-05-05 10:23:50 +02:00
local-store Replace legacy Rlp with UntrustedRlp and use in ethcore rlp views (#8316) 2018-04-16 15:52:12 +02:00
logger Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
mac Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
machine Fork choice and metadata framework for Engine (#8401) 2018-05-16 14:58:01 +08:00
miner Attempt to fix intermittent test failures (#8584) 2018-05-10 12:33:56 +02:00
nsis Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
parity ´main.rs´ typo (#8629) 2018-05-15 07:46:37 +02:00
parity-clib Parity as a library (#8412) 2018-05-09 08:47:21 +02:00
parity-clib-example Parity as a library (#8412) 2018-05-09 08:47:21 +02:00
price-info Bump master to 1.12 (#8477) 2018-04-25 16:25:43 +02:00
registrar [contract-client] refactor (#7978) 2018-03-12 20:46:27 +00:00
rpc block_header can fail so return Result (#8581) 2018-05-11 11:34:07 +02:00
rpc_cli Remove unused dependency `bigint` (#8505) 2018-04-27 17:46:17 +02:00
rpc_client Bump ethabi & ethereum-types. (#8258) 2018-04-02 12:12:52 +01:00
scripts Gitlab test script fixes (#8573) 2018-05-14 11:28:41 +02:00
secret_store Keep all enacted blocks notify in order (#8524) 2018-05-07 12:58:25 +02:00
snap Forward-port snap fixes (#7831) 2018-02-13 16:31:05 +01:00
transaction-pool Make trace-time publishable. (#8568) 2018-05-09 08:54:37 +02:00
updater Keep all enacted blocks notify in order (#8524) 2018-05-07 12:58:25 +02:00
util Remove NetworkContext::io_channel() (#8625) 2018-05-15 17:03:09 +02:00
whisper Remove manually added text to the errors (#8595) 2018-05-14 10:11:10 +02:00
windows/ptray Updated icons (#7469) 2018-01-05 13:44:05 +01:00
.dockerignore improved dockerfile builds (#5659) 2017-05-23 12:25:41 +02:00
.editorconfig Fix checksums and auto-update push (#7846) 2018-02-13 19:31:06 +01:00
.gitignore Store morden db and keys in "path/to/parity/data/Morden" (ropsten uses "test", like before) (#8621) 2018-05-15 12:57:32 +02:00
.gitlab-ci.yml Check that the Android build doesn't dep on c++_shared (#8538) 2018-05-16 00:11:14 +03:00
.gitmodules WASM contracts MVP (#5679) 2017-07-10 17:42:10 +02:00
CHANGELOG.md changelog nit (#8585) 2018-05-09 23:21:16 +02:00
Cargo.lock Make mio optional in ethcore-io (#8537) 2018-05-10 12:34:36 +02:00
Cargo.toml Parity as a library (#8412) 2018-05-09 08:47:21 +02:00
LICENSE Change to library. 2015-11-24 21:05:08 +01:00
README.md Fix Parity UI link (#8600) 2018-05-11 09:04:04 +02:00
SECURITY.md Update SECURITY.md 2018-01-25 18:53:32 +01:00
license_header Fix whitespace (#4299) 2017-01-25 18:51:41 +01:00
rust-toolchain rust-toolchain file on master (#6266) 2017-08-14 13:47:53 +02:00
rustfmt.toml Use memmap for dag cache (#6193) 2017-09-25 19:45:33 +02:00
test.sh Make mio optional in ethcore-io (#8537) 2018-05-10 12:34:36 +02:00

README.md

Parity - fast, light, and robust Ethereum client

» Download the latest release «

build status codecov Snap Status GPLv3

Join the chat!

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

Or join our community on Matrix: Riot: +Parity

Official website: https://parity.io | Be sure to check out our wiki for more information.


About Parity

Parity's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity using the sophisticated and cutting-edge Rust programming language. Parity is licensed under the GPLv3, and can be used for all your Ethereum needs.

From Parity Ethereum client version 1.10.0, the User Interface (UI) is accessible in a separate application called Parity UI. To keep using the UI in the browser (deprecated), follow these steps.

By default, Parity will also run a JSONRPC server on 127.0.0.1:8545 and a websockets server on 127.0.0.1:8546. This is fully configurable and supports a number of APIs.

If you run into an issue while using Parity, feel free to file one 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's current beta-release is 1.11. You can download it at https://github.com/paritytech/parity/releases or follow the instructions below to build from source.


Build dependencies

Parity requires Rust version 1.26.0 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 also requires gcc, g++, libssl-dev/openssl, libudev-dev and pkg-config 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 from source.


Install from the snap store

In any of the supported Linux distros:

sudo snap install parity

Or, if you want to contribute testing the upcoming release:

sudo snap install parity --beta

And to test the latest code landed into the master branch:

sudo snap install parity --edge

Build from source

# download Parity code
$ git clone https://github.com/paritytech/parity
$ cd parity

# build in release mode
$ cargo build --release

This will produce 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 will always compile the latest nightly builds. If you want to build stable or beta, do a

$ git checkout stable

or

$ git checkout beta

first.


Simple one-line installer for Mac and Ubuntu

bash <(curl https://get.parity.io -Lk)

The one-line installer always defaults to the latest beta release. To install a stable release, run:

bash <(curl https://get.parity.io -Lk) -r stable

Start Parity

Manually

To start Parity manually, just run

$ ./target/release/parity

and Parity will begin syncing the Ethereum blockchain.

Using systemd service file

To start Parity as a regular user using systemd init:

  1. Copy ./scripts/parity.service to your systemd user directory (usually ~/.config/systemd/user).
  2. To configure Parity, write a /etc/parity/config.toml config file, see Configuring Parity for details.