https://github.com/elastos/elastos.ela.sidechain.token
https://github.com/elastos/elastos.ela.sidechain.token
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/elastos/elastos.ela.sidechain.token
- Owner: elastos
- License: mit
- Created: 2018-09-12T12:59:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-25T03:43:08.000Z (almost 5 years ago)
- Last Synced: 2024-06-21T13:14:57.134Z (12 months ago)
- Language: Go
- Size: 157 KB
- Stars: 1
- Watchers: 24
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Elastos ELA SideChain Token
===========
[](https://travis-ci.com/elastos/Elastos.ELA.SideChain.Token) [](https://goreportcard.com/report/github.com/elastos/Elastos.ELA.SideChain.Token)
## Introduction
Elacoin is the digital currency solution within Elastos eco system.
This project is the source code that can build a full node of TOKEN.
## Table of Contents
- [Elastos ELA SideChain Token](#elastos-ela-sidechain-token)
- [Introduction](#introduction)
- [Table of Contents](#table-of-contents)
- [Pre-requisites on Mac](#pre-requisites-on-mac)
- [1. Check OS version](#1-check-os-version)
- [2. Install Go distribution 1.9](#2-install-go-distribution-19)
- [3. Install Glide](#3-install-glide)
- [Pre-requisites on Ubuntu](#pre-requisites-on-ubuntu)
- [1. Check OS version](#1-check-os-version-1)
- [2. Install git](#2-install-git)
- [3. Install Go distribution 1.9](#3-install-go-distribution-19)
- [4. Install Glide](#4-install-glide)
- [Configure the node](#configure-the-node)
- [Build the node](#build-the-node)
- [1. Setup basic workspace](#1-setup-basic-workspace)
- [2. Set correct environment variables](#2-set-correct-environment-variables)
- [3. Check Go version and glide version](#3-check-go-version-and-glide-version)
- [4. Clone source code to $GOPATH/src/github/elastos folder](#4-clone-source-code-to-gopathsrcgithubelastos-folder)
- [5. Install dependencies using Glide](#5-install-dependencies-using-glide)
- [6. Make](#6-make)
- [7. Run the node on Mac](#7-run-the-node-on-mac)
- [Interact with the node](#interact-with-the-node)
- [1. JSON RPC API of the node](#1-json-rpc-api-of-the-node)
- [Contribution](#contribution)
- [Acknowledgments](#acknowledgments)
- [License](#license)
## Pre-requisites on Mac
#### 1. Check OS version
Make sure the OSX version is 16.7+
```shell
$ uname -srm
Darwin 16.7.0 x86_64
```
#### 2. Install Go distribution 1.9
Use Homebrew to install Golang 1.9.
```shell
$ brew install [email protected]
```
> 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.
```shell
$ brew install --ignore-dependencies glide
```
## Pre-requisites on Ubuntu
#### 1. Check OS version
Make sure your ubuntu version is 16.04+
```shell
$ cat /etc/issue
Ubuntu 16.04.3 LTS \n \l
```
#### 2. Install git
```shell
$ sudo apt-get install -y git
```
#### 3. Install Go distribution 1.9
```shell
$ 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.
```shell
$ cd ~/dev
$ curl https://glide.sh/get | sh
```
## Configure the node
See the [documentation](./docs/config.json.md) about config.json to understand what each parameter means on the configuration file.
If you would like to connect to testnet, do the following:
```shell
$ cp docs/testnet_config.json.sample config.json
```
If you would like to connect to mainnet, do the following:
```shell
$ cp docs/mainnet_config.json.sample config.json
```
Make sure to modify the parameters to what your own specification.
## 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).
```shell
$ mkdir -p ~/dev/bin
$ mkdir -p ~/dev/src/github.com/elastos/
```
#### 2. Set correct environment variables
```shell
export GOROOT=/usr/local/opt/[email protected]/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.
```shell
$ 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
```shell
$ git clone https://github.com/elastos/Elastos.ELA.SideChain.Token.git
```
If clone works successfully, you should see folder structure like $GOPATH/src/github.com/elastos/Elastos.ELA.SideChain.Token/Makefile
#### 5. Install dependencies using Glide
```shell
$ cd $GOPATH/src/github.com/elastos/Elastos.ELA.SideChain.Token
$ glide update && glide install
```
#### 6. Make
Build the node.
```shell
$ cd $GOPATH/src/github.com/elastos/Elastos.ELA.SideChain.Token
$ make
```
If you did not see any error message, congratulations, you have made the DID full node.
#### 7. Run the node on Mac
Run the node.
```shell
$ ./token
```
## Interact with the node
#### 1. 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
```bash
curl -H 'Content-Type: application/json' -H 'Accept:application/json' --data '{"method":"getbestblockhash"}' http://localhost:20606
{
"error": null,
"id": null,
"jsonrpc": "2.0",
"result": "c4e72359cbb128bca244a800fb36d71f64b834e20d437c25de6c62edc46196c7"
}
```
Example 2: Get the hash of the specific blockchain height
```bash
curl -H 'Content-Type: application/json' -H 'Accept:application/json' --data '{"method":"getblockhash","params":{"height":1}}' http://localhost:20606
{
"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](docs/jsonrpc_apis.md)
## Contribution
We welcome contributions to the Elastos ELA SideChain Token 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](https://github.com/elastos/Elastos.ELA.SideChain.Token/blob/master/LICENSE).