openethereum/README.md at b375c9adbf54f8e9a0f30cad01ab9f10b9dfc7f9

* ci: reduce gitlab pipelines significantly

* ci: build pipeline for PR

* ci: remove dead weight

* ci: remove github release script

* ci: remove forever broken aura tests

* ci: add random stuff to the end of the pipes

* ci: add wind and mac to the end of the pipe

* ci: remove snap artifacts

* ci: (re)move dockerfiles

* ci: clarify job names

* ci: add cargo audit job

* ci: make audit script executable

* ci: ignore snap and docker files for rust check

* ci: simplify audit script

* ci: rename misc to optional

* ci: add publish script to releaseable branches

* ci: more verbose cp command for windows build

* ci: fix weird binary checksum logic in push script

* ci: fix regex in push script for windows

* ci: simplify gitlab caching

* docs: align README with ci changes

* ci: specify default cargo target dir

* ci: print verbose environment

* ci: proper naming of scripts

* ci: restore docker files

* ci: use docker hub file

* ci: use cargo home instead of cargo target dir

* ci: touch random rust file to trigger real builds

* ci: set cargo target dir for audit script

* ci: remove temp file

* ci: don't export the cargo target dir in the audit script

* ci: fix windows unbound variable

* docs: fix gitlab badge path

* rename deprecated gitlab ci variables

https://docs.gitlab.com/ee/ci/variables/#9-0-renaming

* ci: fix git compare for nightly builds

* test: skip c++ example for all platforms but linux

* ci: add random rust file to trigger tests

* ci: remove random rust file

* disable cpp lib test for mac, win and beta (#9686)

2018-10-02 00:03:58 +01:00

6.6 KiB

Raw Blame History

The fastest and most advanced Ethereum client.

» Download the latest release «

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

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.

Build Dependencies

Parity Ethereum requires Rust version 1.29.x 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++, libudev-dev, 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:

Perl
Yasm

Make sure that these binaries are in your PATH. After that, you should be able to build Parity Ethereum from source.

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

$ git checkout beta

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

Start 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 your systemd user directory (usually ~/.config/systemd/user).
To configure Parity Ethereum, write a /etc/parity/config.toml config file, see Configuring Parity Ethereum for details.