search

DMDcoin / diamond-node

bit.diamonds node software for network version 4
GNU General Public License v3.0
0 stars 3 forks source link

readme

Diamond Node

Node client for the protocol version 4 of the bit.diamonds network.

GPL licensed

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

diamond-node is the node software for the upcomming V4 of the diamond network. The Node Software is on a alpha level and still under active development.

2. Technical Overview

diamond-node builds on OpenEthereum, and shares a lot of base features, covered in the OpenEthereum Documentation.

By default, diamond-node 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 diamond-node, feel free to file an issue in this repository, or hop on our Slack, Telegram or Discord chat room to ask a question. We are glad to help!

We do not provide binaries and suggest to build from source.

3. Building

3.1 Build Dependencies

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

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 diamond-node from source.

3.2 Build from Source Code 

# download OpenEthereum code
$ git clone https://github.com/DMDcoin/diamond-node
$ cd diamond-node

# 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 diamond-node

Manually

To start diamond-node manually, just run

$ ./target/release/openethereum

so diamond-node begins syncing the Ethereum blockchain.

Using systemd service file

To start diamond-node 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 diamond-node, 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:

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

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

The following tools are available in a separate repository:

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