OpenEthereum

Fast and feature-rich multi-network Ethereum client.

» Download the latest release «

[![GPL licensed][license-badge]][license-url]
[![Build Status][ci-badge]][ci-url]
[![Discord chat][chat-badge]][chat-url]

[license-badge]: https://img.shields.io/badge/license-GPL_v3-green.svg
[license-url]: LICENSE
[ci-badge]: https://github.com/openethereum/openethereum/workflows/Build%20and%20Test%20Suite/badge.svg
[ci-url]: https://github.com/openethereum/openethereum/actions
[chat-badge]: https://img.shields.io/discord/669192218728202270.svg?logo=discord
[chat-url]: https://discord.io/openethereum

Table of Contents

1. [Description](#chapter-001)
2. [Technical Overview](#chapter-002)
3. [Building](#chapter-003)
3.1 [Building Dependencies](#chapter-0031)
3.2 [Building from Source Code](#chapter-0032)
3.3 [Starting OpenEthereum](#chapter-0034)
4. [Testing](#chapter-004)
5. [Documentation](#chapter-005)
6. [Toolchain](#chapter-006)
7. [Contributing](#chapter-008)
8. [License](#chapter-009)

1. Description

Built for mission-critical use: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. OpenEthereum 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

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

By default, OpenEthereum 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 OpenEthereum, check out the old wiki for documentation, feel free to file an issue in this repository, or hop on our Discord chat room to ask a question. We are glad to help!

You can download OpenEthereum's latest release at the releases page or follow the instructions below to build from source. Read the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.

3. Building

3.1 Build Dependencies

OpenEthereum 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:

bash
  $ curl https://sh.rustup.rs -sSf | sh

OpenEthereum also requires clang (>= 9.0), clang++, pkg-config, file, make, and cmake packages to be installed.

• OSX:

bash
  $ curl https://sh.rustup.rs -sSf | sh

clang is required. It comes with Xcode command line tools or can be installed with homebrew.

• Windows:

bash
  $ rustup default stable-x86_64-pc-windows-msvc

Once you have rustup installed, then you need to install:

• Perl
• Yasm

3.2 Build from Source Code

bash
# download OpenEthereum code
$ git clone https://github.com/openethereum/openethereum
$ cd openethereum

# 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:

bash
$ ~/.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:

bash
$ cargo clean

This always compiles the latest nightly builds. If you want to build stable, do a

bash
$ git checkout stable

3.3 Starting OpenEthereum

Manually

To start OpenEthereum manually, just run

bash
$ ./target/release/openethereum

so OpenEthereum begins syncing the Ethereum blockchain.

Using systemd service file

To start OpenEthereum as a regular user using systemd init:

1. Copy ./scripts/openethereum.service to your
systemd user directory (usually ~/.config/systemd/user).
2. Copy release to bin folder, write sudo install ./target/release/openethereum /usr/bin/openethereum
3. To configure OpenEthereum, see our wiki 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](#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)

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

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 openethereum --open):

bash
  openethereum

bash
  ethcore-accounts, ethkey-cli, ethstore, ethstore-cli

bash
  chainspec

bash
  cli-signer parity-rpc-client

bash
  ethash

bash
  ethcore

bash
    ethcore-blockchain

bash
    ethcore-call-contract

bash
    ethcore-db

bash
    evm

bash
    ethcore-light

bash
    node-filter

bash
    ethcore-service

bash
    ethcore-sync

bash
    common-types

bash
    vm

bash
    wasm

bash
    pwasm-run-test

bash
    evmbin

bash
    ethjson

bash
    parity-machine

bash
  ethcore-miner parity-local-store price-info ethcore-stratum using_queue

bash
  ethcore-logger

bash
  parity-rpc

bash
  parity-updater parity-hash-fetch

• OpenEthereum Core Libraries (util`)

bash
  accounts-bloom blooms-db dir eip-712 fake-fetch fastmap fetch ethcore-io
  journaldb keccak-hasher len-caching-lock memory-cache memzero
  migration-rocksdb ethcore-network ethcore-network-devp2p panic_hook
  patricia-trie-ethereum registrar rlp_compress stats
  time-utils triehash-ethereum unexpected parity-version

6. Toolchain

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

• [evmbin](./bin/evmbin) - OpenEthereum EVM Implementation.
• [ethstore](./crates/accounts/ethstore) - OpenEthereum Key Management.
• [ethkey](./crates/accounts/ethkey) - OpenEthereum Keys Generator.

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

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](./.github/CONTRIBUTING.md).

Contributor Code of Conduct

[CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md)

8. License

[LICENSE](./LICENSE)

Collapse