/go-nebulas

Official Go implementation of the Nebulas protocol.

Primary LanguageGoGNU Lesser General Public License v3.0LGPL-3.0

go-nebulas

Official Go implementation of the Nebulas protocol. The current version is 2.0, also called Nebulas Nova.

Build Status

For the roadmap of Nebulas, please visit the roadmap page.

For more information of Nebulas protocol, design documents, please refer to our wiki.

TestNet is released, please check here for more details.

Mainnet is released, please check here for more details.

Building from source

Prerequisites

Components Version Description
Golang >= 1.12 The Go Programming Language

Build

Checkout repo.

git clone github.com/nebulasio/go-nebulas

The project is under active development. New users may want to checkout and use the stable mainnet release in master.

cd github.com/nebulasio/go-nebulas
git checkout master

Or use the stable testnet release in testnet.

git checkout testnet

Install native libs.

Nebulas execution need NVM and NBRE two dependent libraries. We provide stable versions of both libraries. Execute the execution script to install

cd github.com/nebulasio/go-nebulas

OS X:
./setup.sh

Linux:
source setup.sh
Note:

The dependency libraries are not installed in the system directory, and there are different path-loading methods used in Darwin and Linux systems.

  • OS X:

    • In the user's root directory to create lib folder, system to load the library path can read this path, ensure that the root directory of the current folder does not exist. All of these operations in setup.sh already processing.(DYLD_LIBRARY_PATH is not possible unless System Integrity Protection (SIP) is disabled)
    ./setup.sh

  • Linux - Ubuntu

    • setup.sh export LD_LIBRARY_PATH for native libs.

Build the neb binary.

  • run command
make build

Building from Docker

You can specify the config file by modifying the docker-compose environment configuration.

  • default docker compose config(version3):
version: '3'

services:
  
  node:
    image: nebulasio/go-nebulas
    build:
      context: ./docker
    ports:
      - '8680:8680'
      - '8684:8684'
      - '8685:8685'
      - '8888:8888'
      - '8086:8086'
    volumes:
      - .:/go/src/github.com/nebulasio/go-nebulas
    environment:
      - REGION=China
      - config=mainnet/conf/config.conf
    command: bash docker/scripts/neb.bash


sudo docker-compose build
sudo docker-compose up -d

Run

Run node

Starting a Nebulas node is simple. After the build step above, run a command:

./neb [-c /path/to/config.conf]

Quick start please use script and added check(Recommend):

./start.sh mainnet|testnet|[-c /path/to/config.conf]

tips: more details about configuration, please refer to template.conf

You will see log message output like:

INFO[2018-03-30T01:39:16+08:00] Setuped Neblet.                               file=neblet.go func="neblet.(*Neblet).Setup" line=161
INFO[2018-03-30T01:39:16+08:00] Starting Neblet...                            file=neblet.go func="neblet.(*Neblet).Start" line=183
INFO[2018-03-30T01:39:16+08:00] Starting NebService...                        file=net_service.go func="net.(*NebService).Start" line=58
INFO[2018-03-30T01:39:16+08:00] Starting NebService Dispatcher...             file=dispatcher.go func="net.(*Dispatcher).Start" line=85
INFO[2018-03-30T01:39:16+08:00] Starting NebService Node...                   file=node.go func="net.(*Node).Start" line=96
INFO[2018-03-30T01:39:16+08:00] Starting NebService StreamManager...          file=stream_manager.go func="net.(*StreamManager).Start" line=74
INFO[2018-03-30T01:39:16+08:00] Started NewService Dispatcher.                file=dispatcher.go func="net.(*Dispatcher).loop" line=93
INFO[2018-03-30T01:39:16+08:00] Starting NebService RouteTable Sync...        file=route_table.go func="net.(*RouteTable).Start" line=91
INFO[2018-03-30T01:39:16+08:00] Started NebService StreamManager.             file=stream_manager.go func="net.(*StreamManager).loop" line=146
INFO[2018-03-30T01:39:16+08:00] Started NebService Node.                      file=net_service.go func="net.(*NebService).Start" id=QmP7HDFcYmJL12Ez4ZNVCKjKedfE7f48f1LAkUc3Whz4jP line=65 listening address="[/ip4/127.0.0.1/tcp/8680 /ip4/127.94.0.1/tcp/8680 /ip4/127.94.0.2/tcp/8680 /ip4/192.168.1.13/tcp/8680]"
INFO[2018-03-30T01:39:16+08:00] Started NebService.                           file=net_service.go func="net.(*NebService).Start" line=74
INFO[2018-03-30T01:39:16+08:00] Starting RPC GRPCServer...                    file=server.go func="rpc.(*Server).Start" line=87
INFO[2018-03-30T01:39:16+08:00] Started RPC GRPCServer.                       address="0.0.0.0:8684" file=server.go func="rpc.(*Server).Start" line=95
INFO[2018-03-30T01:39:16+08:00] Started NebService RouteTable Sync.           file=route_table.go func="net.(*RouteTable).syncLoop" line=123
INFO[2018-03-30T01:39:16+08:00] Starting RPC Gateway GRPCServer...            file=neblet.go func="neblet.(*Neblet).Start" http-cors="[]" http-server="[0.0.0.0:8685]" line=212 rpc-server="0.0.0.0:8684"
INFO[2018-03-30T01:39:16+08:00] Starting BlockChain...                        file=blockchain.go func="core.(*BlockChain).Start" line=194
INFO[2018-03-30T01:39:16+08:00] Starting BlockPool...                         file=neblet.go func="neblet.(*Neblet).Start" line=219 size=128
INFO[2018-03-30T01:39:16+08:00] Starting TransactionPool...                   file=neblet.go func="neblet.(*Neblet).Start" line=220 size=327680
INFO[2018-03-30T01:39:16+08:00] Started BlockChain.                           file=blockchain.go func="core.(*BlockChain).loop" line=208
INFO[2018-03-30T01:39:16+08:00] Starting EventEmitter...                      file=neblet.go func="neblet.(*Neblet).Start" line=221 size=40960
INFO[2018-03-30T01:39:16+08:00] Started BlockPool.                            file=block_pool.go func="core.(*BlockPool).loop" line=232
INFO[2018-03-30T01:39:16+08:00] Started TransactionPool.                      file=asm_amd64.s func=runtime.goexit line=2362 size=327680
INFO[2018-03-30T01:39:16+08:00] Started EventEmitter.                         file=event.go func="core.(*EventEmitter).loop" line=156
INFO[2018-03-30T01:39:16+08:00] Starting Dpos Mining...                       file=dpos.go func="dpos.(*Dpos).Start" line=136
INFO[2018-03-30T01:39:16+08:00] Started Sync Service.                         file=sync_service.go func="sync.(*Service).startLoop" line=150
INFO[2018-03-30T01:39:16+08:00] Started Dpos Mining.                          file=dpos.go func="dpos.(*Dpos).blockLoop" line=619
INFO[2018-03-30T01:39:16+08:00] Enabled Dpos Mining...                        file=dpos.go func="dpos.(*Dpos).EnableMining" line=155
INFO[2018-03-30T01:39:16+08:00] This is a seed node.                          file=neblet.go func="neblet.(*Neblet).Start" line=247
INFO[2018-03-30T01:39:16+08:00] Resumed Dpos Mining.                          file=dpos.go func="dpos.(*Dpos).ResumeMining" line=296
INFO[2018-03-30T01:39:16+08:00] Started Neblet.                               file=neblet.go func="neblet.(*Neblet).Start" line=259

From the log, we can see the binary execution starts neblet, starts network service, starts RPC API server, and starts consensus state machine.

TestNet

We are glad to release Nebulas Testnet here. You can use and join our TestNet right now.

MaintNet

We are glad to release Nebulas Mainnet here. You can use and join our MainNet right now.

Explorer

Nebulas provides a block explorer to view block/transaction information. Please check Explorer.

Wallet

Nebulas provides a web wallet to send transaction and deploy/call contract. Please check Web-Wallet

Wiki

Please check our Wiki to learn more about Nebulas.

Contribution

We are very glad that you are considering to help Nebulas Team or go-nebulas project, including but not limited to source code, documents or others.

If you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our slack channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please refer to our contribution guideline for more information.

Thanks.

License

The go-nebulas project is licensed under the GNU Lesser General Public License Version 3.0 (“LGPL v3”).

For the more information about licensing, please refer to Licensing page.