README
¶
Go Node and SDK for the NEO blockchain.
Overview
This project aims to be a full port of the original C# Neo project. A complete toolkit for the NEO blockchain, including:
This branch (master) is under active development now (read: won't work out of the box) and aims to be compatible with Neo 3. For the current stable version compatible with Neo 2 please refer to the master-2.x branch and releases before 0.80.0 (0.7X.Y track). Releases starting from 0.90.0 contain Neo 3 code (0.90.0 being compatible with Neo 3 preview2).
Getting started
Installation
Go: 1.13+
Install dependencies.
neo-go uses GoModules 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:
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
Running
Quick start a NEO node on the private network. This requires the 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
Importing mainnet/testnet dump files
If you want to jump-start your mainnet or testnet node with chain archives provided by NGD follow these instructions (when they'd be available for 3.0 networks):
$ 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 that shows some simple contracts that can be compiled/deployed/run using neo-go compiler, SDK 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.
Developer notes
Nodes have such features as Prometheus and 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.
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 on GitHub
- @fyrchik on Github
- Reach out to us on the NEO Discord channel
License
- Open-source MIT
Directories
¶
| Path | Synopsis |
|---|---|
|
options
Package options contains a set of common CLI options and helper functions to use them.
|
Package options contains a set of common CLI options and helper functions to use them. |
|
examples
|
|
|
nft-nd
Module
|
|
|
nft-nd-nns
Module
|
|
|
oracle
Module
|
|
|
internal
|
|
|
pkg
|
|
|
core
Package core implements Neo ledger functionality.
|
Package core implements Neo ledger functionality. |
|
core/mpt
Package mpt implements MPT (Merkle-Patricia Tree).
|
Package mpt implements MPT (Merkle-Patricia Tree). |
|
encoding/base58
Package base58 wraps generic base58 encoder with NEO-specific checksumming.
|
Package base58 wraps generic base58 encoder with NEO-specific checksumming. |
|
interop
Package interop contains smart contract API functions and type synonyms.
|
Package interop contains smart contract API functions and type synonyms. |
|
interop/binary
Package binary provides binary serialization routines.
|
Package binary provides binary serialization routines. |
|
interop/blockchain
Package blockchain provides functions to access various blockchain data.
|
Package blockchain provides functions to access various blockchain data. |
|
interop/contract
Package contract provides functions to work with contracts.
|
Package contract provides functions to work with contracts. |
|
interop/convert
Package convert provides functions for type conversion.
|
Package convert provides functions for type conversion. |
|
interop/crypto
Package crypto provides an interface to cryptographic syscalls.
|
Package crypto provides an interface to cryptographic syscalls. |
|
interop/enumerator
Package enumerator provides functions to work with enumerators.
|
Package enumerator provides functions to work with enumerators. |
|
interop/iterator
Package iterator provides functions to work with Neo iterators.
|
Package iterator provides functions to work with Neo iterators. |
|
interop/json
Package json provides various JSON serialization/deserialization routines.
|
Package json provides various JSON serialization/deserialization routines. |
|
interop/runtime
Package runtime provides various service functions related to execution environment.
|
Package runtime provides various service functions related to execution environment. |
|
interop/storage
Package storage provides functions to access and modify contract's storage.
|
Package storage provides functions to access and modify contract's storage. |
|
interop/util
Package util contains some special useful functions that are provided by compiler and VM.
|
Package util contains some special useful functions that are provided by compiler and VM. |
|
rpc/client
Package client implements NEO-specific JSON-RPC 2.0 client.
|
Package client implements NEO-specific JSON-RPC 2.0 client. |
|
smartcontract/manifest/standard
Package standard contains interfaces for well-defined standards and function for checking if arbitrary manifest complies with them.
|
Package standard contains interfaces for well-defined standards and function for checking if arbitrary manifest complies with them. |