neoneo-go/README.md
2018-02-01 09:40:04 -08:00

3 KiB

neo-go

Go Node and SDK for the NEO blockchain.

Overview

This project is currently in alpha and under active development.

Project Goals

Full port of the original C# NEO project. A complete toolkit for the NEO blockchain, including:

  • Full consensus node
  • Full RPC node
  • RPC client
  • ClI tool
  • Smart contract compiler

Current State

This project is still under heavy development. Still working on internal API's and project layout. T his should not take longer than 2 weeks.

The project will exist out of the following packages:

Package State Developer
api started @anthdm
core started @anthdm
network started @anthdm
smartcontract started @revett
vm started @revett

Getting Started

Server

Install the neoserver cli:

go install ./cmd/neoserver

Currently, there is a minimal subset of the NEO protocol implemented. To start experimenting make sure you a have a private net running on your machine. If you dont, take a look at docker-privnet-with-gas.

Start the server:

neoserver -seed 127.0.0.1:20333

You can add multiple seeds if you want:

neoserver -seed 127.0.0.1:20333,127.0.01:20334

By default the server will currently run on port 3000, for testing purposes. You can change that by setting the tcp flag:

neoserver -seed 127.0.0.1:20333 -tcp 1337

RPC

If you want your node to also serve JSON-RPC, you can do that by setting the following flag:

neoserver -rpc 4000

In this case server will accept and respond JSON-RPC on port 4000. Keep in mind that currently there is only a small subset of the JSON-RPC implemented. Feel free to make a PR with more functionality.

VM

TODO

Smart Contracts

TODO

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 feauture/topic you are going to implement.

Contact

License

  • Open-source MIT