mirror of
https://github.com/nspcc-dev/neo-go.git
synced 2024-12-11 15:30:07 +00:00
117 lines
3.5 KiB
Markdown
117 lines
3.5 KiB
Markdown
<p align="center">
|
|
<img src="./.github/neo_color_dark_gopher.png" width="300px" alt="logo">
|
|
</p>
|
|
<p align="center">
|
|
<b>Go</b> Node and SDK for the <a href="https://neo.org">NEO</a> blockchain.
|
|
</p>
|
|
|
|
<hr />
|
|
|
|
[](https://codecov.io/gh/nspcc-dev/neo-go)
|
|
[](https://circleci.com/gh/nspcc-dev/neo-go/tree/master)
|
|
[](https://goreportcard.com/report/github.com/nspcc-dev/neo-go)
|
|
[](https://godoc.org/github.com/nspcc-dev/neo-go)
|
|
|
|
|
|
|
|
# Overview
|
|
|
|
This project aims to be a full port of the original C# [NEO project](https://github.com/neo-project).
|
|
A complete toolkit for the NEO blockchain, including:
|
|
|
|
- [Consensus node](docs/consensus.md)
|
|
- [RPC node & client](https://github.com/nspcc-dev/neo-go/tree/master/docs/rpc.md)
|
|
- [CLI tool](https://github.com/nspcc-dev/neo-go/blob/master/docs/cli.md)
|
|
- [Smart contract compiler](https://github.com/nspcc-dev/neo-go/blob/master/docs/compiler.md)
|
|
- [NEO virtual machine](https://github.com/nspcc-dev/neo-go/blob/master/docs/vm.md)
|
|
|
|
# Getting started
|
|
|
|
## Installation
|
|
|
|
Go: 1.12+
|
|
|
|
Install dependencies.
|
|
|
|
`neo-go` uses [GoModules](https://github.com/golang/go/wiki/Modules) 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:
|
|
|
|
```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
|
|
|
|
Build the **neo-go** CLI:
|
|
|
|
```
|
|
make build
|
|
```
|
|
|
|
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.
|
|
|
|
```
|
|
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`
|
|
|
|
#Developer notes
|
|
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.
|
|
|
|
# Contributing
|
|
|
|
Feel free to contribute to this project after reading the
|
|
[contributing guidelines](https://github.com/nspcc-dev/neo-go/blob/master/CONTRIBUTING.md).
|
|
|
|
Before starting to work on a certain topic, create an new issue first,
|
|
describing the feature/topic you are going to implement.
|
|
|
|
# Contact
|
|
|
|
- [@roman-khimov](https://github.com/roman-khimov) on GitHub
|
|
- [@fyrchik](https://github.com/fyrchik) on Github
|
|
- Reach out to us on the [NEO Discord](https://discordapp.com/invite/R8v48YA) channel
|
|
|
|
# License
|
|
|
|
- Open-source [MIT](https://github.com/nspcc-dev/neo-go/blob/master/LICENSE.md)
|