TrueCloudLab/neo-go
6
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-10-16 15:43:25 +00:00
Code Issues Projects Releases Packages Wiki Activity
Go Node and SDK for the NEO blockchain
4694 commits 35 branches 136 tags 40 MiB
Go 99.8%
Makefile 0.1%
Find a file
Roman Khimov 4d2ecab16f consensus: fix nonce handling 
It was broken somewhere between 2f490a3403 and
85ce207f40 leading to panic on watch only node:

2021-07-21T16:21:39.201+0200    INFO    received Commit {"validator": 3}
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x28 pc=0xbcc59e]

goroutine 486 [running]:
github.com/nspcc-dev/neo-go/pkg/consensus.(*service).newBlockFromContext(0xc0001629a0, 0xc000308000, 0xc0010fa000, 0x2cb417800)
        github.com/nspcc-dev/neo-go/pkg/consensus/consensus.go:664 +0xbe
github.com/nspcc-dev/dbft.(*Context).MakeHeader(...)
        github.com/nspcc-dev/dbft@v0.0.0-20210302103605-cc75991b7cfb/context.go:270
github.com/nspcc-dev/dbft.(*DBFT).onCommit(0xc000308000, 0x138c998, 0xc000115110)
        github.com/nspcc-dev/dbft@v0.0.0-20210302103605-cc75991b7cfb/dbft.go:487 +0x575
github.com/nspcc-dev/dbft.(*DBFT).OnReceive(0xc000308000, 0x138c998, 0xc000115110)
        github.com/nspcc-dev/dbft@v0.0.0-20210302103605-cc75991b7cfb/dbft.go:251 +0xef5
github.com/nspcc-dev/neo-go/pkg/consensus.(*service).eventLoop(0xc0001629a0)
        github.com/nspcc-dev/neo-go/pkg/consensus/consensus.go:312 +0x7d6
created by github.com/nspcc-dev/neo-go/pkg/consensus.(*service).Start
        github.com/nspcc-dev/neo-go/pkg/consensus/consensus.go:262 +0xdc

In fact, nonce is correctly provided by dbft library (since Legacy), we just
need to use it here.
2021-07-21 19:06:19 +03:00
.circleci circleci: fix image build with latest alpine 2021-07-07 20:21:52 +03:00
.docker core: rename Neo.Crypto.CheckMultisig interop 2021-05-11 18:38:14 +03:00
.github circleci/workflows: drop vet run 2021-05-13 00:08:42 +03:00
cli cli/wallet: request candidate registration price 2021-07-21 12:26:35 +03:00
config config: update mainnet magic 2021-07-21 14:42:26 +03:00
docs docs: add query tx info 2021-07-20 18:03:51 +03:00
examples examples: add missing permission methods in manifests 2021-06-24 16:00:45 +03:00
internal stackitem: introduce Convertible interface 2021-07-19 15:42:42 +03:00
pkg consensus: fix nonce handling 2021-07-21 19:06:19 +03:00
scripts config: add InitialGASSupply, fix #2073 2021-07-20 16:59:54 +03:00
.dockerignore Fix build node and docker-image 2019-08-26 19:32:09 +03:00
.gitignore .gitignore: add compiler outputs in example dir 2021-04-06 22:50:42 +03:00
.gitmodules vm: update json tests to neo3 branch 2020-04-17 11:46:31 +03:00
.golangci.yml *: enable godot linter and fix all its warnings 2021-05-12 23:17:03 +03:00
.travis.yml drop support for Go 1.12 2020-08-06 16:29:55 +03:00
CHANGELOG.md CHANGELOG: release 0.96.0 2021-07-21 16:57:08 +03:00
CONTRIBUTING.md CONTRIBUTING.md: add section for benchmarks 2021-07-12 14:34:38 +03:00
Dockerfile Dockerfile: use make to build neo-go 2021-05-13 17:16:27 +03:00
go.mod consensus: fix nonce handling 2021-07-21 19:06:19 +03:00
go.sum consensus: fix nonce handling 2021-07-21 19:06:19 +03:00
LICENSE.md LICENSE.md: rename from LICENCE.md 2019-08-20 18:47:08 +03:00
Makefile Makefile: drop vendoring 2021-05-13 17:22:10 +03:00
neo-go.service.template service file templating 2019-11-13 15:05:13 +03:00
README.md docs: add more info about running a CN node on public networks 2021-07-15 12:21:07 +03:00
ROADMAP.md CHANGELOG: release 0.96.0 2021-07-21 16:57:08 +03:00

README.md

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 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 contain Neo 3 code (0.90.0 being compatible with Neo 3 preview2).

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.14+ and make:

make build

The resulting binary is bin/neo-go.

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