Skip to content

Latest commit

 

History

History
166 lines (116 loc) · 4.09 KB

README.md

File metadata and controls

166 lines (116 loc) · 4.09 KB
Raw

Block Collider Node

Release Candidate 2 - "Deep Space"

Mining node with built-in block rover, DHT, and peer discovery.

Block Collider Advanced Community

For technical & mining questions visit: https://www.t.me/blockcollideradvanced

Status

Build Status Build status

System Requirements

OS

  • Ubuntu 16.04 (GNU)
  • Mac OSX 10.11+ (Debian)

Getting started

  • $ - lines starting with this symbol ($) should be executed in bash/terminal/command-line/cmd.exe WITHOUT symbol ($) itself
  • # - lines starting with this symbol (#) are comments and SHOULD not be executed

Environment variables

Following environment variables can be used for advanced tweaking

Name Description
BC_CONFIG Path to custom config file; string
BC_DEBUG Collect data in _debug folder; true/false
BC_DATA_DIR Data directory; path
BC_GRPC_HOST gRPC bind host; IP
BC_GRPC_PORT gRPC port; 0..65535
BC_LOG Override log level; debug/info/warn/error
BC_MINER_KEY Miner key; string
BC_MONITOR Print Stats periodically; true/false
BC_UI_PORT Web UI port; 0..65535
BC_P2P_PASSIVE Be passive, ignore discovered peers

Run official docker image from public repo

Backround/Daemon

$ docker run --rm --name bcnode -d -p 3000:3000 -p 16061:16061 -p 16060:16060 blockcollider/bcnode:latest start --ws --rovers --ui --node --miner-key ABCDEF

Foreground

$ docker run --rm --name bcnode -p 3000:3000 -p 16061:16061 -p 16060:16060 blockcollider/bcnode:latest start --ws --rovers --ui --node --miner-key ABCDEF

Build docker image locally

# Clone sources
$ git clone https://github.com/blockcollider/bcnode.git

# Change folder
$ cd bcnode

# Switch to release branch
$ git checkout release

# Build image locally
$ docker build -t blockcollider/bcnode .

Build from source

Prerequisites

# Clone sources
$ git clone https://github.com/blockcollider/bcnode

# Change folder
$ cd bcnode

# Install dependencies
$ yarn

# Build bcnode
$ yarn run dist

Run From Command Line

Show the help

$ ./bin/cli start -h

  Usage: start [opts]

  Start Block Collider

  Options:

    --miner-key [key]  Miner key
    -n, --node         Start P2P node
    --rovers [items]   start rover (default: btc, eth, lsk, neo, wav)
    -R, --no-rovers    do not start any rover
    --rpc              enable RPC
    --ui               enable Web UI
    --ws               enable WebSocket
    -h, --help         output usage information

Startup node with rover GUI & BTC & LSK rovers

$ ./bin/cli start --ui --ws --rovers btc,lsk

Run node with all rovers, GUI, and socket stream

$ ./bin/cli start --ui --ws

Development

npm run watch

Documenation

Generate documentation

$ yarn run doc

Open generated documentation

$ open ./docs/index.html

Rovers (Alphabetical)

  • Bitcoin Blockchain
  • Ethereum Blockchain
  • Lisk Blockchain
  • Neo Blockchain
  • Waves Blockchain

Block Collider Developer Community

Helpful community tools will be added: https://github.com/blockcollider/awesome-blockcollider

Help & Support