Elastos.ELA

README

Elastos ELA

Travis CI	Go Report Card

Introduction

ELA is the digital currency solution within the Elastos ecosystem. It is merged mined with Bitcoin which means the existing bitcoin miners are able to merge mine both BTC and ELA at the same time without expending any additional resources or energy while also providing the enormous hashpower that comes with the bitcoin network.

This project is the source code that can build a full node of ELA blockchain(main chain).

Table of Contents

• Elastos ELA
  • Introduction
  • Table of Contents
• Pre-requisites on Mac
  • 1. Check OS version
  • 2. Install Go distribution 1.9
  • 3. Install Glide
• Pre-requisites on Ubuntu
  • 1. Check OS version
  • 2. Install git
  • 3. Install Go distribution 1.9
  • 4. Install Glide
• Configure the node
• Build the node
  • 1. Setup basic workspace
  • 2. Set correct environment variables
  • 3. Check Go version and glide version
  • 4. Clone source code to $GOPATH/src/github/elastos folder
  • 5. Install dependencies using Glide
  • 6. Make
  • 7. Run the node on Mac
• Build and Run using docker
  • 1. Build the docker node
  • 2. Run the node in the docker container
• Interact with the node
  • 1. Access the web UI of the node
  • 2. REST API of the node
  • 3. JSON RPC API of the node
• Contribution
• Acknowledgments
• License

Pre-requisites on Mac

1. Check OS version

Make sure the OSX version is 16.7+

$ uname -srm
Darwin 16.7.0 x86_64

2. Install Go distribution 1.9

Use Homebrew to install Golang 1.9.

$ brew install go@1.9

If you install older version, such as v1.8, you may get missing math/bits package error when build.

3. Install Glide

Glide is a package manager for Golang. We use Glide to install dependent packages.

$ brew install --ignore-dependencies glide

Pre-requisites on Ubuntu

1. Check OS version

Make sure your ubuntu version is 16.04+

$ cat /etc/issue
Ubuntu 16.04.3 LTS \n \l

2. Install git

$ sudo apt-get install -y git

3. Install Go distribution 1.9

$ sudo apt-get install -y software-properties-common
$ sudo add-apt-repository -y ppa:gophers/archive
$ sudo apt update
$ sudo apt-get install -y golang-1.9-go

If you install older version, such as v1.8, you may get missing math/bits package error when build.

4. Install Glide

Glide is a package manager for Golang. We use Glide to install dependent packages.

$ cd ~/dev
$ curl https://glide.sh/get | sh

Configure the node

See the documentation about config.json to understand what each parameter means on the configuration file.

If you would like to connect to testnet, do the following:

$ cp docs/testnet_config.json.sample config.json

If you would like to connect to mainnet, do the following:

$ cp docs/mainnet_config.json.sample config.json

Make sure to modify the parameters to what your own specification.

NOTE: At the moment, main net is only open to BTC.com mining pool.

Build the node

1. Setup basic workspace

In this instruction we use ~/dev/src/github.com/elastos as our working directory. If you clone the source code to a different directory, please make sure you change other environment variables accordingly (not recommended).

$ mkdir -p ~/dev/bin
$ mkdir -p ~/dev/src/github.com/elastos/

2. Set correct environment variables

export GOROOT=/usr/local/opt/go@1.9/libexec
export GOPATH=$HOME/dev
export GOBIN=$GOPATH/bin
export PATH=$GOROOT/bin:$PATH
export PATH=$GOBIN:$PATH

3. Check Go version and glide version

Check the golang and glider version. Make sure they are the following version number or above.

$ go version
go version go1.9.2 darwin/amd64

$ glide --version
glide version 0.13.1

If you cannot see the version number, there must be something wrong when install.

4. Clone source code to $GOPATH/src/github/elastos folder

Make sure you are in the folder of $GOPATH/src/github.com/elastos

$ git clone https://github.com/elastos/Elastos.ELA.git

If clone works successfully, you should see folder structure like $GOPATH/src/github.com/elastos/Elastos.ELA/Makefile

5. Install dependencies using Glide

$ cd $GOPATH/src/github.com/elastos/Elastos.ELA
$ glide update && glide install

6. Make

Build the node.

$ cd $GOPATH/src/github.com/elastos/Elastos.ELA
$ make

If you did not see any error message, congratulations, you have made the ELA full node.

7. Run the node on Mac

Run the node.

$ ./ela

Build and Run using docker

Alternatively, if don't want to build it manually on Mac or Linux, we also provide a Dockerfile to help you (You need to have docker installed).

1. Build the docker node

$ cd docker
$ docker build -t ela_node_run .

2. Run the node in the docker container

$ docker run -p 20334:20334 -p 20335:20335 -p 20336:20336 -p 20338:20338 ela_node_run

Note: Don't hit Ctrl-C to terminate the output; instead close this terminal and open another.

Please note the dockerfile uses the default 'config.json' in the repository. If you're familiar with docker, you can change the docker file to make it use your own ELA Node configuration file.

Interact with the node

1. Access the web UI of the node

If you would like to access the web UI of the node to get different stats about the node, go to the following URL on your browser: http://localhost:21333/info

2. REST API of the node

Once the node is running successfully, you can access ELA Node's REST APIs:

Example 1: Get the number of nodes to which the node is connected

curl http://localhost:21334/api/v1/node/connectioncount
{
    "Desc": "Success",
    "Error": 0,
    "Result": 5
}

Example 2: Get the block height of the node

curl http://localhost:21334/api/v1/block/height
{
    "Desc": "Success",
    "Error": 0,
    "Result": 1000
}

If you would like to learn more about what other REST APIs are available for the node, please check out the Restful API

3. JSON RPC API of the node

Once the node is running successfully, you can access ELA Node's JSON RPC APIs:

Example 1: Get the hash of the most recent block

curl -H 'Content-Type: application/json' -H 'Accept:application/json' --data '{"method":"getbestblockhash"}' http://localhost:21336
{
    "error": null,
    "id": null,
    "jsonrpc": "2.0",
    "result": "c4e72359cbb128bca244a800fb36d71f64b834e20d437c25de6c62edc46196c7"
}

Example 2: Get the hash of the specific blockchain height

curl -H 'Content-Type: application/json' -H 'Accept:application/json' --data '{"method":"getblockhash","params":{"height":1}}' http://localhost:21336
{
    "error": null,
    "id": null,
    "jsonrpc": "2.0",
    "result": "71b422e09dcd2f749d2adc0086735c210084cdb6b59bd4cd42e50455d024a662"
}

If you would like to learn more about what other JSON RPC APIs are available for the node, please check out the JSON RPC API

Contribution

We welcome contributions to the Elastos ELA Project.

Acknowledgments

A sincere thank you to all teams and projects that we rely on directly or indirectly.

License

This project is licensed under the terms of the MIT license.