Skip to content

Latest commit

 

History

History
322 lines (251 loc) · 10.4 KB

README.md

File metadata and controls

322 lines (251 loc) · 10.4 KB
Raw

OpenEthereum

Fast and feature-rich multi-network Ethereum client.

» Download the latest release «

GPL licensed Build Status Discord chat

Table of Contents

  1. Description
  2. Technical Overview
  3. Building
    3.1 Building Dependencies
    3.2 Building from Source Code
    3.3 Starting OpenEthereum
  4. Testing
  5. Documentation
  6. Toolchain
  7. Contributing
  8. License

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

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

    $ 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 OpenEthereum from source.

3.2 Build from Source Code 

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

$ ~/.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, do a

$ git checkout stable

3.3 Starting OpenEthereum

Manually

To start OpenEthereum manually, just run

$ ./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 old 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 <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

Be sure to check out our old wiki for more information.

Viewing documentation for OpenEthereum packages

You can generate documentation for OpenEthereum 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 openethereum --open):

Package List

  • OpenEthereum Client Application 
    openethereum
  • OpenEthereum Account Management, Key Management Tool, and Keys Generator 
    ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
  • OpenEthereum Chain Specification 
    chainspec
  • OpenEthereum CLI Signer Tool & RPC Client 
    cli-signer parity-rpc-client
  • OpenEthereum Ethash & ProgPoW Implementations 
    ethash
  • EthCore Library 
    ethcore
    • OpenEthereum Blockchain Database, Test Generator, Configuration, Caching, Importing Blocks, and Block Information 
      ethcore-blockchain
    • OpenEthereum Contract Calls and Blockchain Service & Registry Information 
      ethcore-call-contract
    • OpenEthereum Database Access & Utilities, Database Cache Manager 
      ethcore-db
    • OpenEthereum Virtual Machine (EVM) Rust Implementation 
      evm
    • OpenEthereum Light Client Implementation 
      ethcore-light
    • Smart Contract based Node Filter, Manage Permissions of Network Connections 
      node-filter
    • Private Transactions 
      ethcore-private-tx
    • OpenEthereum Client & Network Service Creation & Registration with the I/O Subsystem 
      ethcore-service
    • OpenEthereum Blockchain Synchronization 
      ethcore-sync
    • OpenEthereum Common Types 
      common-types
    • OpenEthereum Virtual Machines (VM) Support Library 
      vm
    • OpenEthereum WASM Interpreter 
      wasm
    • OpenEthereum WASM Test Runner 
      pwasm-run-test
    • OpenEthereum EVM Implementation 
      evmbin
    • OpenEthereum JSON Deserialization 
      ethjson
    • OpenEthereum State Machine Generalization for Consensus Engines 
      parity-machine
  • OpenEthereum Miner Interface 
    ethcore-miner parity-local-store price-info ethcore-stratum using_queue
  • OpenEthereum Logger Implementation 
    ethcore-logger
  • OpenEthereum JSON-RPC Servers 
    parity-rpc
  • OpenEthereum Updater Service 
    parity-updater parity-hash-fetch
  • OpenEthereum Core Libraries (util) 
    ethcore-bloom-journal 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 - OpenEthereum EVM Implementation.
  • ethstore - OpenEthereum Key Management.
  • ethkey - OpenEthereum Keys Generator.

The following tools are available in a separate repository:

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

Contributor Code of Conduct

CODE_OF_CONDUCT

8. License

LICENSE