Go Node and SDK for the NEO blockchain
Find a file
Roman Khimov 1f9ab7dfa2
Merge pull request #1121 from nspcc-dev/fix/consensus
consensus: add network magic to hash data
2020-06-26 18:46:23 +03:00
.circleci .circleci: count coverage only for cli/ and pkg/ 2020-04-14 16:10:24 +03:00
.docker *: change address to the new format 2020-06-17 15:58:21 +03:00
.github add new neo logo with gopher 2019-10-22 19:48:22 +03:00
cli cli: update wallet path argument name in cli context 2020-06-25 18:46:24 +03:00
config *: use MaxTransactionsPerBlock from Policy native contract 2020-06-24 07:58:05 +03:00
docs cli: change name for wallet path flag 2020-06-25 17:21:18 +03:00
examples core: fix Storage.Get to return Null when there is no value 2020-06-24 10:43:58 +03:00
integration block/transaction: add network magic into the hash 2020-06-18 12:39:50 +03:00
pkg consensus: add network magic to hash data 2020-06-26 18:41:04 +03:00
scripts scripts: replace compare-dumps with go version 2020-06-24 16:11:34 +03:00
.dockerignore Fix build node and docker-image 2019-08-26 19:32:09 +03:00
.gitignore gitignore: don't ignore blockchain(s) directories 2020-05-26 19:55:35 +03:00
.gitmodules vm: update json tests to neo3 branch 2020-04-17 11:46:31 +03:00
.travis.yml .circleci: count coverage only for cli/ and pkg/ 2020-04-14 16:10:24 +03:00
CHANGELOG.md CHANGELOG: release 0.74.0 2020-03-17 16:40:28 +03:00
CONTRIBUTING.md *: move all packages from CityOfZion to nspcc-dev 2020-03-03 17:21:42 +03:00
Dockerfile docker: drop default privnet-blocks bootstraps 2020-06-05 19:21:40 +03:00
go.mod *: use MaxTransactionsPerBlock from Policy native contract 2020-06-24 07:58:05 +03:00
go.sum *: use MaxTransactionsPerBlock from Policy native contract 2020-06-24 07:58:05 +03:00
LICENSE.md LICENSE.md: rename from LICENCE.md 2019-08-20 18:47:08 +03:00
Makefile .circleci: count coverage only for cli/ and pkg/ 2020-04-14 16:10:24 +03:00
neo-go.service.template service file templating 2019-11-13 15:05:13 +03:00
README.md README: update with block import examples 2020-05-27 12:01:50 +03:00
ROADMAP.md ROADMAP: update for Neo 3 development 2020-04-20 11:09:36 +03:00

logo

Go Node and SDK for the NEO blockchain.


codecov CircleCI Report GoDoc GitHub release (latest SemVer) License

Overview

This project aims to be a full port of the original C# Neo project. A complete toolkit for the NEO blockchain, including:

This branch (master) is under active development now (read: won't work out of the box) and aims to be compatible with Neo 3. For the current stable version compatible with Neo 2 please refer to the master-2.x branch and releases before 0.80.0 (0.7X.Y track). Releases starting from 0.90.0 will contain Neo 3 code.

Getting started

Installation

Go: 1.12+

Install dependencies.

neo-go uses GoModules as dependency manager:

make deps

How to setup a node

Docker

Each tagged build is built to docker hub and the :latest tag pointing at the latest tagged build.

By default the CMD is set to run a node on testnet, so to do this simply run:

 docker run -d --name neo-go -p 20332:20332 -p 20333:20333 cityofzion/neo-go

Which will start a node on testnet and expose the nodes port 20333 and 20332 for the JSON-RPC server.

Building

Build the neo-go CLI:

make build

Running

Quick start a NEO node on the private network. This requires the neo-privatenet Docker image running on your machine.

make run

To run the binary directly:

./bin/neo-go node

By default the node will run on the private network, to change his:

./bin/neo-go node --mainnet

Available network flags:

  • --mainnet, -m
  • --privnet, -p
  • --testnet, -t

Importing mainnet/testnet dump files

If you want to jump-start your mainnet or testnet node with chain archives provided by NGD follow these instructions (when they'd be available for 3.0 networks):

$ wget .../chain.acc.zip # chain dump file
$ unzip chain.acc.zip
$ ./bin/neo-go db restore -m -i chain.acc # for testnet use '-t' flag instead of '-m'

The process differs from the C# node in that block importing is a separate mode, after it ends the node can be started normally.

Smart contract development

Please refer to neo-go smart contract development workshop that shows some simple contracts that can be compiled/deployed/run using neo-go compiler, SDK and private network. For details on how Go code is translated to Neo VM bytecode and what you can and can not do in smart contract please refer to the compiler documentation.

Developer notes

Nodes have such features as Prometheus and Pprof in order to have additional information about them for debugging.

How to configure Prometheus or Pprof: In config/protocol.*.yml there is

  Prometheus:
    Enabled: true
    Port: 2112

where you can switch on/off and define port. Prometheus is enabled and Pprof is disabled by default.

Contributing

Feel free to contribute to this project after reading the contributing guidelines.

Before starting to work on a certain topic, create an new issue first, describing the feature/topic you are going to implement.

Contact

License

  • Open-source MIT