Go Node and SDK for the NEO blockchain
Find a file
Roman Khimov 4e028cca89
Merge pull request #2435 from nspcc-dev/rpc/getversion-fix
rpc: adjust `getversion` RPC response
2022-04-14 14:53:19 +03:00
.circleci circleci: update cache key to avoid fetching outdated cache 2022-03-30 12:18:01 +03:00
.docker .github: add action to build WSC image 2021-11-29 11:11:09 +03:00
.github github: add job to check WSC privnet image build 2022-03-28 15:15:14 +03:00
cli cli/server: don't spit out error if notary request already exists 2022-04-05 17:37:17 +03:00
config config: use http for oracle nodes 2021-11-26 17:17:10 +03:00
docs Merge pull request #2410 from nspcc-dev/workflows/check_build_privnet 2022-03-28 15:33:17 +03:00
examples examples: update neo-go dependency 2022-04-05 10:50:50 +03:00
internal Merge pull request #2414 from nspcc-dev/eliminate-getstorageitems 2022-04-01 09:16:42 +03:00
pkg rpc: adjust getversion RPC response 2022-04-14 13:51:30 +03:00
scripts *: remove io/ioutil uses 2022-03-17 19:39:18 +03:00
.dockerignore Fix build node and docker-image 2019-08-26 19:32:09 +03:00
.gitignore vm: add some Fuzz tests 2022-03-18 16:13:39 +03:00
.gitmodules vm: update json tests to neo3 branch 2020-04-17 11:46:31 +03:00
.golangci.yml .golangci.yml: replace golint with revive 2021-09-14 14:39:23 +03:00
.travis.yml *: drop Go 1.14 2021-08-25 14:59:00 +03:00
CHANGELOG.md CHANGELOG: mention Windows! 2022-03-21 16:20:19 +03:00
codecov.yml codecov: adjust codecov config and remove CircleCI coverage job 2022-02-03 16:21:15 +03:00
CONTRIBUTING.md CONTRIBUTING: trivial fix 2021-07-23 18:15:43 +03:00
Dockerfile workflows: upgrade supported go version 2022-03-18 11:09:30 +03:00
Dockerfile.wsc workflows: upgrade supported go version 2022-03-18 11:09:30 +03:00
go.mod gomod: update interop dependency 2022-04-05 10:49:10 +03:00
go.sum gomod: update interop dependency 2022-04-05 10:49:10 +03:00
LICENSE.md LICENSE.md: add NSPCC copyright 2022-04-04 12:34:18 +03:00
Makefile Makefile: allow to build privnet image for WSC 2022-03-28 15:15:08 +03:00
neo-go.service.template service file templating 2019-11-13 15:05:13 +03:00
README.md gomod: upgrade minimum required go version up to 1.16 2022-03-18 11:09:23 +03:00
ROADMAP.md CHANGELOG: release 0.98.0 2021-12-03 11:11:06 +03:00

logo

Go Node and SDK for the Neo blockchain.


codecov CircleCI GithubWorkflows Tests GithubWorkflows CodeQL 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 Neo N3-compatible. For the current Legacy-compatible version please refer to the master-2.x branch and releases before 0.80.0 (0.7X.Y track).

Getting started

Installation

NeoGo is distributed as a single binary that includes all the functionality provided (but smart contract compiler requires Go compiler to operate). You can grab it from releases page, use a Docker image (see Docker Hub for various releases of NeoGo, :latest points to the latest release) or build yourself.

Building

To build NeoGo you need Go 1.16+ and make:

make build

The resulting binary is bin/neo-go.

Building on Windows

To build NeoGo on Windows platform we recommend you to install make from MinGW package. Then you can build NeoGo with:

make build

The resulting binary is bin/neo-go.exe.

We also recommend you to switch the Windows Firewall off for further NeoGo node run.

Running a node

A node needs to connect to some network, either local one (usually referred to as privnet) or public (like mainnet or testnet). Network configuration is stored in a file and NeoGo allows you to store multiple files in one directory (./config by default) and easily switch between them using network flags.

To start Neo node on private network use:

./bin/neo-go node

Or specify a different network with appropriate flag like this:

./bin/neo-go node --mainnet

Available network flags:

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

To run a consensus/committee node refer to consensus documentation.

Docker

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

docker run -d --name neo-go -p 20332:20332 -p 20331:20331 nspccdev/neo-go

Which will start a node on privnet and expose node's ports 20332 (P2P protocol) and 20331 (JSON-RPC server).

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.

Running a private network

Refer to consensus node documentation.

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.

Refer to examples for more NEO smart contract examples written in Go.

Wallets

NeoGo differs substantially from C# implementation in its approach to wallets. NeoGo wallet is just a NEP-6 file that is used by CLI commands to sign various things. There is no database behind it, the blockchain is the database and CLI commands use RPC to query data from it. At the same time it's not required to open the wallet on RPC node to perform various actions (unless your node is providing some service for the network like consensus or oracle nodes).

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