neo-go/README.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

2018-01-28 18:05:06 +00:00
<p align="center">
<img
src="http://res.cloudinary.com/vidsy/image/upload/v1503160820/CoZ_Icon_DARKBLUE_200x178px_oq0gxm.png"
width="125px"
>
2018-01-28 18:05:06 +00:00
</p>
<h1 align="center">NEO-GO</h1>
<p align="center">
2018-01-30 10:56:36 +00:00
Node and SDK for the <b>NEO</b> blockchain written in the <b>Go</b> language.
2018-01-28 18:05:06 +00:00
</p>
<p align="center">
<a href="https://travis-ci.org/anthdm/neo-go">
<img src="https://travis-ci.org/anthdm/neo-go.svg?branch=master">
</a>
</p>
2018-01-28 18:05:06 +00:00
# Overview
> This project is currently in alpha and under active development.
2018-01-28 18:05:06 +00:00
### Long term project goals
2018-01-28 18:37:03 +00:00
Full port of the original C# [NEO project](https://github.com/neo-project). A complete toolkit for the NEO blockchain.
2018-01-28 18:05:06 +00:00
2018-01-30 10:56:36 +00:00
- Full server (consensus and RPC) nodes.
2018-01-28 18:05:06 +00:00
- RPC client
- build, compile and deploy smart contracts with the Go vm
2018-01-29 18:18:04 +00:00
### Current state
2018-01-28 18:37:03 +00:00
This project is still under heavy development. Still working on internal API's and project layout. This should not take longer than 2 weeks.
2018-01-31 11:51:02 +00:00
The project will exist out of the following topics/packages:
1. network (started)
2. core (started)
3. vm (open)
4. smartcontract (open)
5. api (RPC server) (open)
2018-01-28 18:37:03 +00:00
# Getting started
2018-01-31 11:51:02 +00:00
### Server
2018-01-28 18:37:03 +00:00
2018-01-31 11:51:02 +00:00
Install the neoserver cli `go install ./cmd/neoserver`
2018-01-28 18:37:03 +00:00
2018-01-31 11:51:02 +00:00
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](https://hub.docker.com/r/metachris/neo-privnet-with-gas/).
Start the server:
2018-01-28 18:37:03 +00:00
`neoserver -seed 127.0.0.1:20333`
2018-01-31 11:51:02 +00:00
You can add multiple seeds if you want:
`neoserver -seed 127.0.0.1:20333,127.0.01:20334`
### RPC
To be implemented..
### vm
To be implemented..
### smart contracts
To be implemented..
2018-01-28 18:37:03 +00:00
2018-01-29 07:11:08 +00:00
# Contributing
2018-01-31 11:51:02 +00:00
Feel free to contribute to this project after reading the [contributing guidelines](https://github.com/anthdm/neo-go/blob/master/CONTRIBUTING.md).
Before starting to work on a certain topic, create an new issue first, describing the feauture/topic you are going to implement.
2018-01-29 07:11:08 +00:00
2018-01-31 10:58:19 +00:00
# Contact
- [@anthdm](https://github.com/anthdm) on Github
- [@anthdm](https://twitter.com/anthdm) on Twitter
- Send me an email anthony@cityofzion.io
# License
- Open-source [MIT](https://github.com/anthdm/neo-go/blob/master/LICENCE.md)