README
¶
Go Node and SDK for the Neo blockchain.
Overview
NeoGo is a complete platform for distributed application development built on top of and compatible with the Neo project. This includes, but not limited to (see documentation for more details):
- Consensus node
- RPC node & client
- CLI tool
- Smart contract compiler
- Neo virtual machine
- Smart contract examples
- Oracle service
- State validation service
The protocol implemented here is Neo N3-compatible, however you can also find an implementation of the Neo Legacy protocol in the master-2.x branch and releases before 0.80.0 (0.7X.Y track).
Getting started
Installation
NeoGo is distributed as a single binary that includes all the functionality
provided (but smart contract compiler requires Go compiler to operate). You
can grab it from releases
page, use a Docker image (see
Docker Hub for various releases of
NeoGo, :latest points to the latest release) or build yourself.
Building
Building NeoGo requires Go 1.19+ and make:
make
The resulting binary is bin/neo-go. Notice that using some random revision
from the master branch is not recommended (it can have any number of
incompatibilities and bugs depending on the development stage), please use
tagged released versions.
Building on Windows
To build NeoGo on Windows platform we recommend you to install make from MinGW
package. Then, you can build NeoGo with:
make
The resulting binary is bin/neo-go.exe.
Running a node
A node needs to connect to some network, either local one (usually referred to
as privnet) or public (like mainnet or testnet). Network configuration
is stored in a file and NeoGo allows you to store multiple files in one
directory (./config by default) and easily switch between them using network
flags.
To start Neo node on a private network, use:
./bin/neo-go node
Or specify a different network with an appropriate flag like this:
./bin/neo-go node --mainnet
Available network flags:
--mainnet, -m--privnet, -p--testnet, -t
To run a consensus/committee node, refer to consensus documentation.
If you're running a node on Windows, please turn off or configure Windows Firewall appropriately (allowing inbound connections to the P2P port).
Docker
By default, the CMD is set to run a node on privnet. So, to do this, simply run:
docker run -d --name neo-go -p 20332:20332 -p 20331:20331 nspccdev/neo-go
Which will start a node on privnet and expose node's ports 20332 (P2P
protocol) and 20331 (JSON-RPC server).
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:
$ 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.
Running a private network
Refer to consensus node documentation.
Smart contract development
Please refer to NeoGo smart contract development workshop that shows some simple contracts that can be compiled/deployed/run using NeoGo compiler, SDK and a private network. For details on how Go code is translated to Neo VM bytecode and what you can and can not do in a smart contract, please refer to the compiler documentation.
Refer to examples for more Neo smart contract examples written in Go.
Wallets
NeoGo wallet is just a NEP-6 file that is used by CLI commands to sign various things. CLI commands are not a direct part of the node, but rather a part of the NeoGo binary, their implementations use RPC to query data from the blockchain and perform any required actions. It's not required to open a wallet on an RPC node (unless your node provides some service for the network like consensus or oracle nodes do).
Monitoring
NeoGo provides Prometheus and Pprof services that can be enabled in the node in order to provide additional monitoring and debugging data.
Configuring any of the two services is easy, add the following section (Pprof
instead of Prometheus if you need that) to the respective config/protocol.*.yml:
Prometheus:
Enabled: true
Addresses:
- ":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 a new issue first describing the feature/topic you are going to implement.
Contact
- @AnnaShaleva on GitHub
- @roman-khimov 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. |
|
txctx
Package txctx contains helper functions that deal with transactions in CLI context.
|
Package txctx contains helper functions that deal with transactions in CLI context. |
|
examples
|
|
|
engine
Module
|
|
|
events
Module
|
|
|
iterator
Module
|
|
|
nft-nd
Module
|
|
|
nft-nd-nns
Module
|
|
|
oracle
Module
|
|
|
runtime
Module
|
|
|
storage
Module
|
|
|
timer
Module
|
|
|
token
Module
|
|
|
token-sale
Module
|
|
|
internal
|
|
|
testcli
Package testcli contains auxiliary code to test CLI commands.
|
Package testcli contains auxiliary code to test CLI commands. |
|
pkg
|
|
|
compiler
Package compiler implements Go to NEF smart contract compiler.
|
Package compiler implements Go to NEF smart contract compiler. |
|
config
Package config contains NeoGo node configuration definition.
|
Package config contains NeoGo node configuration definition. |
|
config/limits
Package limits contains a number of system-wide hardcoded constants.
|
Package limits contains a number of system-wide hardcoded constants. |
|
config/netmode
Package netmode contains well-known network magic numbers.
|
Package netmode contains well-known network magic numbers. |
|
consensus
Package consensus contains Neo consensus node implementation.
|
Package consensus contains Neo consensus node implementation. |
|
core
Package core implements Neo ledger functionality.
|
Package core implements Neo ledger functionality. |
|
core/block
Package block contains Neo block definition.
|
Package block contains Neo block definition. |
|
core/interop
Package interop contains implementations of Neo interop functions.
|
Package interop contains implementations of Neo interop functions. |
|
core/mpt
Package mpt implements MPT (Merkle-Patricia Trie).
|
Package mpt implements MPT (Merkle-Patricia Trie). |
|
core/native
Package native contains Neo native contracts.
|
Package native contains Neo native contracts. |
|
core/statesync
Package statesync implements module for the P2P state synchronisation process.
|
Package statesync implements module for the P2P state synchronisation process. |
|
core/storage/dbconfig
Package dbconfig is a micropackage that contains storage DB configuration options.
|
Package dbconfig is a micropackage that contains storage DB configuration options. |
|
core/storage/dboper
Package dboper contains a type used to represent single DB operation.
|
Package dboper contains a type used to represent single DB operation. |
|
core/transaction
Package transaction contains Neo transaction definition.
|
Package transaction contains Neo transaction definition. |
|
crypto
Package crypto contains implementation of crypto functions used by Neo.
|
Package crypto contains implementation of crypto functions used by Neo. |
|
crypto/hash
Package hash contains wrappers for Neo hashing algorithms.
|
Package hash contains wrappers for Neo hashing algorithms. |
|
crypto/keys
Package keys wraps public/private keys and implements NEP-2 and WIF.
|
Package keys wraps public/private keys and implements NEP-2 and WIF. |
|
encoding/address
Package address implements conversion of a script hash to/from a Neo address.
|
Package address implements conversion of a script hash to/from a Neo address. |
|
encoding/base58
Package base58 wraps generic base58 encoder with NEO-specific checksumming.
|
Package base58 wraps generic base58 encoder with NEO-specific checksumming. |
|
encoding/bigint
Package bigint implements Neo-specific big.Int (de)serialization to/from []byte.
|
Package bigint implements Neo-specific big.Int (de)serialization to/from []byte. |
|
encoding/fixedn
Package fixedn implements fixed point integers with arbitrary precision.
|
Package fixedn implements fixed point integers with arbitrary precision. |
|
neorpc
Package neorpc contains a set of types used for JSON-RPC communication with Neo servers.
|
Package neorpc contains a set of types used for JSON-RPC communication with Neo servers. |
|
neotest
Package neotest contains a framework for automated contract testing.
|
Package neotest contains a framework for automated contract testing. |
|
neotest/chain
Package chain contains functions creating new test blockchain instances.
|
Package chain contains functions creating new test blockchain instances. |
|
rpcclient
Package rpcclient implements NEO-specific JSON-RPC 2.0 client.
|
Package rpcclient implements NEO-specific JSON-RPC 2.0 client. |
|
rpcclient/actor
Package actor provides a way to change chain state via RPC client.
|
Package actor provides a way to change chain state via RPC client. |
|
rpcclient/gas
Package gas provides a convenience wrapper for GAS contract to use it via RPC.
|
Package gas provides a convenience wrapper for GAS contract to use it via RPC. |
|
rpcclient/invoker
Package invoker provides a convenient wrapper to perform test calls via RPC client.
|
Package invoker provides a convenient wrapper to perform test calls via RPC client. |
|
rpcclient/management
Package management provides an RPC wrapper for the native ContractManagement contract.
|
Package management provides an RPC wrapper for the native ContractManagement contract. |
|
rpcclient/neo
Package neo provides an RPC-based wrapper for the NEOToken contract.
|
Package neo provides an RPC-based wrapper for the NEOToken contract. |
|
rpcclient/nep11
Package nep11 contains RPC wrappers for NEP-11 contracts.
|
Package nep11 contains RPC wrappers for NEP-11 contracts. |
|
rpcclient/nep17
Package nep17 contains RPC wrappers to work with NEP-17 contracts.
|
Package nep17 contains RPC wrappers to work with NEP-17 contracts. |
|
rpcclient/neptoken
Package neptoken contains RPC wrapper for common NEP-11 and NEP-17 methods.
|
Package neptoken contains RPC wrapper for common NEP-11 and NEP-17 methods. |
|
rpcclient/nns
Package nns provide some RPC wrappers for the non-native NNS contract.
|
Package nns provide some RPC wrappers for the non-native NNS contract. |
|
rpcclient/notary
Package notary provides an RPC-based wrapper for the Notary subsystem.
|
Package notary provides an RPC-based wrapper for the Notary subsystem. |
|
rpcclient/oracle
Package oracle allows to work with the native OracleContract contract via RPC.
|
Package oracle allows to work with the native OracleContract contract via RPC. |
|
rpcclient/policy
Package policy allows to work with the native PolicyContract contract via RPC.
|
Package policy allows to work with the native PolicyContract contract via RPC. |
|
rpcclient/rolemgmt
Package rolemgmt allows to work with the native RoleManagement contract via RPC.
|
Package rolemgmt allows to work with the native RoleManagement contract via RPC. |
|
rpcclient/unwrap
Package unwrap provides a set of proxy methods to process invocation results.
|
Package unwrap provides a set of proxy methods to process invocation results. |
|
smartcontract
Package smartcontract contains functions to deal with widely used scripts and NEP-14 Parameters.
|
Package smartcontract contains functions to deal with widely used scripts and NEP-14 Parameters. |
|
smartcontract/manifest/standard
Package standard contains interfaces for well-defined standards and a function for checking if an arbitrary manifest complies with them.
|
Package standard contains interfaces for well-defined standards and a function for checking if an arbitrary manifest complies with them. |
|
smartcontract/zkpbinding
Package zkpbinding contains a set of helper functions aimed to generate and interact with Verifier smart contract written in Go and using Groth-16 proving system over BLS12-381 elliptic curve to verify proofs.
|
Package zkpbinding contains a set of helper functions aimed to generate and interact with Verifier smart contract written in Go and using Groth-16 proving system over BLS12-381 elliptic curve to verify proofs. |
|
util/bitfield
Package bitfield provides a simple and efficient arbitrary size bit field implementation.
|
Package bitfield provides a simple and efficient arbitrary size bit field implementation. |
|
util/slice
Package slice contains byte slice helpers.
|
Package slice contains byte slice helpers. |
|
vm/vmstate
Package vmstate contains a set of VM state flags along with appropriate type.
|
Package vmstate contains a set of VM state flags along with appropriate type. |
|
interop
Module
|
|
|
scripts
|
|