Skip to content

Latest commit

 

History

History
348 lines (272 loc) · 11.4 KB

README.md

File metadata and controls

348 lines (272 loc) · 11.4 KB
Raw

Open Ethereum

The Fastest and most Advanced Ethereum Client.

» Download the latest release «

Table of Contents

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

1. Description

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

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

By default, Open 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 Open Ethereum, 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! For security-critical issues, please refer to the security policy outlined in SECURITY.md.

You can download Open Ethereum's latest release 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

Open 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

    Open Ethereum 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 Open Ethereum from source.

3.2 Build from Source Code 

# download Open Ethereum code
$ git clone https://github.com/OpenEthereum/open-ethereum
$ cd open-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, do a

$ git checkout stable

3.3 Starting Open Ethereum

Manually

To start Open Ethereum manually, just run

$ ./target/release/parity

so Open Ethereum begins syncing the Ethereum blockchain.

Using systemd service file

To start Open Ethereum as a regular user using systemd init:

  1. Copy ./scripts/parity.service to your systemd user directory (usually ~/.config/systemd/user).
  2. Copy release to bin folder, write sudo install ./target/release/parity /usr/bin/parity
  3. To configure Open Ethereum, write a /etc/parity/config.toml config file, 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 Open Ethereum packages

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

Package List

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

Contributing to documentation for Open Ethereum packages

Document source code for Open 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 Open Ethereum client, there are additional tools in this repository available:

  • evmbin - Open Ethereum EVM Implementation.
  • ethstore - Open Ethereum Key Management.
  • ethkey - Open Ethereum Keys Generator.

The following tool is available in a separate repository:

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

7. Community

Join the chat!

Questions? Get in touch with us on Discord: Discord: Open Ethereum

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.

Contributor Code of Conduct

CODE_OF_CONDUCT

9. License

LICENSE