examples directory contains smart contract examples written in Go.
These examples are aimed to demonstrate the basic usage of Go programming
language to write Neo smart contracts as far as to provide a brief introduction
to the Neo-specific interop package application.
Each example represents a separate folder with the smart contract content inside.
The content is presented by the smart contract code written in Go and the smart
contract configuration file with .yml extension.
Some contracts have a contract owner, which is needed for witness checking and
represented by the owner string constant inside the smart contract code. The
owner account address is taken from the my_wallet.json. The
wallet is located under the examples directory, has a single account inside
with the my_account label which can be decrypted with the qwerty password.
You can use my_wallet.json to deploy example contracts.
See the table below for the detailed examples description.
| Example | Description |
|---|---|
| engine | This contract demonstrates how to use runtime interop package which implements an API for System.Runtime.* Neo system calls. Please, refer to the runtime package documentation for details. |
| events | The contract shows how execution notifications with the different arguments types can be sent with the help of runtime.Notify function of the runtime interop package. Please, refer to the runtime.Notify function documentation for details. |
| iterator | This example describes a way to work with Neo iterators. Please, refer to the iterator package documentation for details. |
| nft-d | NEP-11 divisible NFT. See NEP-11 token standard specification for details. |
| nft-nd | NEP-11 non-divisible NFT. See NEP-11 token standard specification for details. |
| nft-nd-nns | Neo Name Service contract which is NEP-11 non-divisible NFT. The contract implements methods for Neo domain name system managing such as domains registration/transferring, records addition and names resolving. The package also contains tests implemented with neotest. |
| oracle | Oracle demo contract exposing two methods that you can use to process URLs. It uses oracle native contract, see interop package documentation also. |
| runtime | This contract demonstrates how to use special _initialize and _deploy methods. See the compiler documentation for methods details. It also shows the pattern for checking owner witness inside the contract with the help of runtime.CheckWitness interop function. |
| storage | The contract implements API for basic operations with a contract storage. It shows how to use storage interop package. See the storage package documentation. |
| timer | The idea of the contract is to count tick method invocations and destroy itself after the third invocation. It shows how to use contract.Call interop function to call, update (migrate) and destroy the contract. Please, refer to the contract.Call function documentation |
| token | This contract implements NEP-17 token standard (like NEO and GAS tokens) with all required methods and operations. See the NEP-17 token standard specification for details. |
| zkp/cubic_circuit | This example demonstrates how to create your own circuit and generate Groth-16 proof based on BLS12-381 elliptic curve points with the help of consensys/gnark. It also shows how to generate, deploy and invoke Verifier smart contract to verify proofs for the given circuit on the Neo chain with the help of zkpbindings NeoGo package. The package also contains circuit tests implemented with gnark/test to check the circuit validity and end-to-end proof generation/verification test implemented with neotest to demonstrate how to build, deploy and verify proofs via Verifier smart contract for the given circuit. |
Please, refer to the neo-go smart contract compiler documentation to compile example smart contracts.
You can set up neo-go private network to deploy the example contracts. Please, refer to the consensus documentation to start your own privnet with neo-go nodes.
To deploy smart contracts, refer to the Deploying section of the compiler documentation.
Feel free to explore neo-go smart contract development workshop to get the basic concepts of how to develop, compile, debug and deploy Neo smart contracts written in go.