neoneo-go/README.md

<p align="center">
<img
    src="https://neo-cdn.azureedge.net/images/neo_logo.svg"
    width="250px">
</p>
<p align="center">
  <b>Go</b> Node and SDK for the <a href="https://neo.org">NEO</a> blockchain.
</p>

<hr />

[![codecov](https://codecov.io/gh/nspcc-dev/neo-go/branch/master/graph/badge.svg)](https://codecov.io/gh/nspcc-dev/neo-go)
[![CircleCI](https://circleci.com/gh/nspcc-dev/neo-go/tree/master.svg?style=svg)](https://circleci.com/gh/nspcc-dev/neo-go/tree/master)
[![Report](https://goreportcard.com/badge/github.com/nspcc-dev/neo-go)](https://goreportcard.com/report/github.com/nspcc-dev/neo-go)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neo-go?sort=semver)
![License](https://img.shields.io/github/license/nspcc-dev/neo-go.svg?style=popout)

# 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 (WIP)
- [RPC node & client](https://github.com/nspcc-dev/neo-go/tree/master/pkg/rpc/README.md)
- [RPC client](https://github.com/nspcc-dev/neo-go/blob/master/pkg/rpc/README.md)
- [CLI tool](https://github.com/nspcc-dev/neo-go/blob/master/cli/README.md)
- [Smart contract compiler](https://github.com/nspcc-dev/neo-go/blob/master/pkg/vm/compiler/README.md)
- [NEO virtual machine](https://github.com/nspcc-dev/neo-go/blob/master/pkg/vm/README.md)

# Getting started

## Installation

Go: 1.11+

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`

# 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
- [@volekerb](https://github.com/volekerb) on Github
- [@anthdm](https://github.com/anthdm) 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)
Also READMES need alittle bit of love. 2018-01-28 18:05:06 +00:00			`<p align="center">`
Replace glide with godep (#27) 2018-02-24 07:23:02 +00:00			`<img`
Update Readme Add current NEO pic Add @volekerb and @roman-khimov in Contacts Add links to docs 2019-08-21 16:30:21 +00:00			`src="https://neo-cdn.azureedge.net/images/neo_logo.svg"`
			`width="250px">`
Also READMES need alittle bit of love. 2018-01-28 18:05:06 +00:00			`</p>`
			`<p align="center">`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			`<b>Go</b> Node and SDK for the <a href="https://neo.org">NEO</a> blockchain.`
Also READMES need alittle bit of love. 2018-01-28 18:05:06 +00:00			`</p>`

Update Readme - update links - update head / badges 2019-08-21 17:31:48 +00:00			`<hr />`

			`[![codecov](https://codecov.io/gh/nspcc-dev/neo-go/branch/master/graph/badge.svg)](https://codecov.io/gh/nspcc-dev/neo-go)`
			`[![CircleCI](https://circleci.com/gh/nspcc-dev/neo-go/tree/master.svg?style=svg)](https://circleci.com/gh/nspcc-dev/neo-go/tree/master)`
			`[![Report](https://goreportcard.com/badge/github.com/nspcc-dev/neo-go)](https://goreportcard.com/report/github.com/nspcc-dev/neo-go)`
			`![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neo-go?sort=semver)`
			`![License](https://img.shields.io/github/license/nspcc-dev/neo-go.svg?style=popout)`
added basic checksum test. + fix travis build 2018-01-29 07:42:49 +00:00
Also READMES need alittle bit of love. 2018-01-28 18:05:06 +00:00			`# Overview`
Updated README and LICENSE according to other COZ repo’s. 2018-01-31 12:50:11 +00:00
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`This project aims to be a full port of the original C# [NEO project](https://github.com/neo-project).`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			`A complete toolkit for the NEO blockchain, including:`

Update Readme Add current NEO pic Add @volekerb and @roman-khimov in Contacts Add links to docs 2019-08-21 16:30:21 +00:00			`- Consensus node (WIP)`
Update Readme - update links - update head / badges 2019-08-21 17:31:48 +00:00			`- [RPC node & client](https://github.com/nspcc-dev/neo-go/tree/master/pkg/rpc/README.md)`
Update Readme Add current NEO pic Add @volekerb and @roman-khimov in Contacts Add links to docs 2019-08-21 16:30:21 +00:00			`- [RPC client](https://github.com/nspcc-dev/neo-go/blob/master/pkg/rpc/README.md)`
Add neo-go cli documentation Comments fix 2019-09-02 13:43:44 +00:00			`- [CLI tool](https://github.com/nspcc-dev/neo-go/blob/master/cli/README.md)`
Update Readme Add current NEO pic Add @volekerb and @roman-khimov in Contacts Add links to docs 2019-08-21 16:30:21 +00:00			`- [Smart contract compiler](https://github.com/nspcc-dev/neo-go/blob/master/pkg/vm/compiler/README.md)`
			`- [NEO virtual machine](https://github.com/nspcc-dev/neo-go/blob/master/pkg/vm/README.md)`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`# Getting started`
updated readme 2018-01-31 11:51:02 +00:00
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`## Installation`
updated readme 2018-01-31 11:51:02 +00:00
Update Readme - add go minimal version - fix dependency manager 2019-08-26 13:58:24 +00:00			`Go: 1.11+`

update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`Install dependencies.`
added more details to the readme. 2018-01-28 18:37:03 +00:00
Update Readme - add go minimal version - fix dependency manager 2019-08-26 13:58:24 +00:00			`neo-go` uses [GoModules](https://github.com/golang/go/wiki/Modules) as dependency manager:
Repo Setup (#6) 2018-02-01 17:40:04 +00:00
Simplify CLI build process (#7) 2018-02-01 18:06:17 +00:00			```
			`make deps`
			```

update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`## How to setup a node`

Docker setup (#70) * Adds docker setup * Add build args * Remove spaec * Bump version * Adds run prefix 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`

Simplify CLI build process (#7) 2018-02-01 18:06:17 +00:00			`Build the neo-go CLI:`

			```
			`make build`
			```
Repo Setup (#6) 2018-02-01 17:40:04 +00:00
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 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.`
added more details to the readme. 2018-01-28 18:37:03 +00:00
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			```
Fix bug where channel for peers events is called after it's closed (#34) * Disconnect once go routines signal so * Send msg if cmd is other than cmdUnknown * Remove typo * Fix lock file * Updates README * Comment typo * Fix issue * Revert old changes * Handle error 2018-03-03 07:16:05 +00:00			`make run`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			```
added more details to the readme. 2018-01-28 18:37:03 +00:00
Fix bug where channel for peers events is called after it's closed (#34) * Disconnect once go routines signal so * Send msg if cmd is other than cmdUnknown * Remove typo * Fix lock file * Updates README * Comment typo * Fix issue * Revert old changes * Handle error 2018-03-03 07:16:05 +00:00			`To run the binary directly:`

Repo Setup (#6) 2018-02-01 17:40:04 +00:00			```
Add neo-go cli documentation Comments fix 2019-09-02 13:43:44 +00:00			`./bin/neo-go node`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			```
Added the start of RPC + removed proxy functions. * Set the listener of the server when opened. * refactor server RPC. * deleted proxy functions + moved TCPPeer to tcp file * implemented the start of JSON-RPC * changed string port args to int * added peerCount. * Start a server with startOpts * Updated README 2018-02-01 08:00:42 +00:00
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			By default the node will run on the `private network`, to change his:
Added the start of RPC + removed proxy functions. * Set the listener of the server when opened. * refactor server RPC. * deleted proxy functions + moved TCPPeer to tcp file * implemented the start of JSON-RPC * changed string port args to int * added peerCount. * Start a server with startOpts * Updated README 2018-02-01 08:00:42 +00:00
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			```
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`./bin/neo-go node --mainnet`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00			```
Added the start of RPC + removed proxy functions. * Set the listener of the server when opened. * refactor server RPC. * deleted proxy functions + moved TCPPeer to tcp file * implemented the start of JSON-RPC * changed string port args to int * added peerCount. * Start a server with startOpts * Updated README 2018-02-01 08:00:42 +00:00
update and tidy README. (#55) * update and tidy README. * bumped version 0.34.1 2018-03-25 14:03:38 +00:00			`Available network flags:`
			- `--mainnet, -m`
			- `--privnet, -p`
			- `--testnet, -t`
updated readme 2018-01-31 11:51:02 +00:00
Added extra comments. 2018-01-29 07:11:08 +00:00			`# Contributing`
updated readme 2018-01-31 11:51:02 +00:00
Replace glide with godep (#27) 2018-02-24 07:23:02 +00:00			`Feel free to contribute to this project after reading the`
Update Readme - update links - update head / badges 2019-08-21 17:31:48 +00:00			`[contributing guidelines](https://github.com/nspcc-dev/neo-go/blob/master/CONTRIBUTING.md).`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00
Replace glide with godep (#27) 2018-02-24 07:23:02 +00:00			`Before starting to work on a certain topic, create an new issue first,`
Fix typos (#133) * Fix typos * revert chains/unit_testnet * revert chains * fix review comments (thx @AlexVanin) 2019-02-13 18:01:10 +00:00			`describing the feature/topic you are going to implement.`
Added extra comments. 2018-01-29 07:11:08 +00:00
Added contact details to README 2018-01-31 10:58:19 +00:00			`# Contact`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00
Update Readme Add current NEO pic Add @volekerb and @roman-khimov in Contacts Add links to docs 2019-08-21 16:30:21 +00:00			`- [@roman-khimov](https://github.com/roman-khimov) on GitHub`
			`- [@volekerb](https://github.com/volekerb) on Github`
Added contact details to README 2018-01-31 10:58:19 +00:00			`- [@anthdm](https://github.com/anthdm) on Github`
Update Readme Add current NEO pic Add @volekerb and @roman-khimov in Contacts Add links to docs 2019-08-21 16:30:21 +00:00			`- Reach out to us on the [NEO Discord](https://discordapp.com/invite/R8v48YA) channel`
Updated README and LICENSE according to other COZ repo’s. 2018-01-31 12:50:11 +00:00
			`# License`
Repo Setup (#6) 2018-02-01 17:40:04 +00:00
Update Readme - update links - update head / badges 2019-08-21 17:31:48 +00:00			`- Open-source [MIT](https://github.com/nspcc-dev/neo-go/blob/master/LICENSE.md)`