2018-01-28 18:05:06 +00:00
< p align = "center" >
2019-10-22 16:48:22 +00:00
< img src = "./.github/neo_color_dark_gopher.png" width = "300px" alt = "logo" >
2018-01-28 18:05:06 +00:00
< / p >
< p align = "center" >
2018-02-01 17:40:04 +00:00
< b > Go< / b > Node and SDK for the < a href = "https://neo.org" > NEO< / a > blockchain.
2018-01-28 18:05:06 +00:00
< / p >
2019-08-21 17:31:48 +00:00
< hr / >
2020-04-09 16:45:46 +00:00
[](https://codecov.io/gh/nspcc-dev/neo-go/branch/master-2.x)
[](https://circleci.com/gh/nspcc-dev/neo-go/tree/master-2.x)
2019-08-21 17:31:48 +00:00
2018-01-29 07:42:49 +00:00
2018-01-28 18:05:06 +00:00
# Overview
2018-01-31 12:50:11 +00:00
2020-04-09 16:45:46 +00:00
This project aims to be a full port of the original C# [Neo project ](https://github.com/neo-project ).
2018-02-01 17:40:04 +00:00
A complete toolkit for the NEO blockchain, including:
2019-11-27 13:11:43 +00:00
- [Consensus node ](docs/consensus.md )
2020-04-09 16:45:46 +00:00
- [RPC node & client ](docs/rpc.md )
- [CLI tool ](docs/cli.md )
- [Smart contract compiler ](docs/compiler.md )
- [NEO virtual machine ](docs/vm.md )
This branch (**master-2.x**) is a stable version of the project compatible
2020-06-25 14:05:10 +00:00
with Neo 2 (including [cross-chain neox support ](docs/neox.md )), it only
receives bug fixes and minor updates. For Neo 3
2020-04-09 16:45:46 +00:00
development version please refer to the [**master**
branch](https://github.com/nspcc-dev/neo-go/tree/master) and releases
after 0.90.0. Releases before 0.80.0 (**0.7X.Y** track) are made from this
branch and only contain Neo 2 code.
2018-02-01 17:40:04 +00:00
2018-03-25 14:03:38 +00:00
# Getting started
2018-01-31 11:51:02 +00:00
2018-03-25 14:03:38 +00:00
## Installation
2018-01-31 11:51:02 +00:00
2020-08-06 13:28:41 +00:00
Go: 1.13+
2019-08-26 13:58:24 +00:00
2018-03-25 14:03:38 +00:00
Install dependencies.
2018-01-28 18:37:03 +00:00
2019-08-26 13:58:24 +00:00
`neo-go` uses [GoModules ](https://github.com/golang/go/wiki/Modules ) as dependency manager:
2018-02-01 17:40:04 +00:00
2018-02-01 18:06:17 +00:00
```
make deps
```
2018-03-25 14:03:38 +00:00
## How to setup a node
2018-04-16 08:41:23 +00:00
### 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:
```bash
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
2018-02-01 18:06:17 +00:00
Build the **neo-go** CLI:
```
make build
```
2018-02-01 17:40:04 +00:00
2020-04-27 13:24:21 +00:00
### Running
2018-03-25 14:03:38 +00:00
Quick start a NEO node on the private network. This requires the [neo-privatenet ](https://hub.docker.com/r/cityofzion/neo-privatenet/ ) Docker image running on your machine.
2018-01-28 18:37:03 +00:00
2018-02-01 17:40:04 +00:00
```
2018-03-03 07:16:05 +00:00
make run
2018-02-01 17:40:04 +00:00
```
2018-01-28 18:37:03 +00:00
2018-03-03 07:16:05 +00:00
To run the binary directly:
2018-02-01 17:40:04 +00:00
```
2019-09-02 13:43:44 +00:00
./bin/neo-go node
2018-02-01 17:40:04 +00:00
```
2018-02-01 08:00:42 +00:00
2018-03-25 14:03:38 +00:00
By default the node will run on the `private network` , to change his:
2018-02-01 08:00:42 +00:00
2018-02-01 17:40:04 +00:00
```
2018-03-25 14:03:38 +00:00
./bin/neo-go node --mainnet
2018-02-01 17:40:04 +00:00
```
2018-02-01 08:00:42 +00:00
2018-03-25 14:03:38 +00:00
Available network flags:
- `--mainnet, -m`
- `--privnet, -p`
- `--testnet, -t`
2018-01-31 11:51:02 +00:00
2020-04-27 13:24:21 +00:00
#### Importing mainnet/testnet dump files
If you want to jump-start your mainnet or testnet node with [chain archives
provided by NGD](https://sync.ngd.network/) follow these instructions:
```
$ 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](https://github.com/nspcc-dev/neo-go-sc-wrkshp) that shows some
simple contracts that can be compiled/deployed/run using neo-go compiler, SDK
2020-05-18 21:17:05 +00:00
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 ](docs/compiler.md ).
2020-04-27 13:24:21 +00:00
# Developer notes
2019-12-04 06:56:10 +00:00
Nodes have such features as [Prometheus ](https://prometheus.io/docs/guides/go-application ) and
[Pprof ](https://golang.org/pkg/net/http/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.
2020-04-27 13:24:21 +00:00
## Contributing
2018-01-31 11:51:02 +00:00
2018-02-24 07:23:02 +00:00
Feel free to contribute to this project after reading the
2020-04-09 16:45:46 +00:00
[contributing guidelines ](CONTRIBUTING.md ).
2018-02-01 17:40:04 +00:00
2018-02-24 07:23:02 +00:00
Before starting to work on a certain topic, create an new issue first,
2019-02-13 18:01:10 +00:00
describing the feature/topic you are going to implement.
2018-01-29 07:11:08 +00:00
2018-01-31 10:58:19 +00:00
# Contact
2018-02-01 17:40:04 +00:00
2019-08-21 16:30:21 +00:00
- [@roman-khimov ](https://github.com/roman-khimov ) on GitHub
2020-02-11 16:06:19 +00:00
- [@fyrchik ](https://github.com/fyrchik ) on Github
2019-08-21 16:30:21 +00:00
- Reach out to us on the [NEO Discord ](https://discordapp.com/invite/R8v48YA ) channel
2018-01-31 12:50:11 +00:00
# License
2018-02-01 17:40:04 +00:00
2020-04-09 16:45:46 +00:00
- Open-source [MIT ](LICENSE.md )
