neo-project / Neo Node

Currently, neo-cli and neo-gui are integrated into one repository. You can enter the corresponding folder and follow the instructions to run each node.

Prerequisites

You will need Window, Linux or macOS. Ubuntu LTS 14, 16 and 18 are supported.

Install .NET Core.

On Linux, install the LevelDB and SQLite3 dev packages. E.g. on Ubuntu or Fedora:

sudo apt-get install libleveldb-dev sqlite3 libsqlite3-dev libunwind8-dev # Ubuntu
sudo dnf install leveldb-devel sqlite sqlite-devel libunwind-devel # Fedora

On macOS, install the LevelDB package. E.g. install via Homebrew:

brew install --ignore-dependencies --build-from-source leveldb

On Windows, use the Neo version of LevelDB.

Download pre-compiled binaries

See also official docs. Download and unzip the latest release.

On Linux, you can type the command:

./neo-cli

On Windows, you can just double click the exe to run the node.

Compile from source

Clone the neo-node repository.

For neo-cli, you can type the following commands:

cd neo-node/neo-cli
dotnet restore
dotnet publish -c Release

Next, you should enter the working directory (i.e. /bin/Debug, /bin/Release) and paste the libleveldb.dll here. In addition, you need to create Plugins folder and put the LevelDBStore or RocksDBStore or other supported storage engine, as well as the configuration file, in the Plugins folder.

Assuming you are in the working directory:

dotnet neo-cli.dll 

For neo-gui, you just need to enter the neo-node/neo-gui folder and follow the above steps to run the node.

Build into Docker

Clone the neo-node repository.

cd neo-node
docker build -t neo-cli .
docker run -p 10332:10332 -p 10333:10333 --name=neo-cli-mainnet neo-cli

After start the container successfully, use the following scripts to open neo-cli interactive window:

docker exec -it neo-cli-mainnet /bin/bash
screen -r node

Logging

To enable logs in neo-cli, you need to add the ApplicationLogs plugin. Please check here for more information.

Bootstrapping the network.

In order to synchronize the network faster, please check here.

Usage

For more information about these two nodes, you can refer to documentation to try out more features.