mirror of
https://github.com/nspcc-dev/neo-go.git
synced 2024-12-24 09:25:21 +00:00
63bc244163
* Updated readme in compiler folder + bumped version to match latest tag. |
||
---|---|---|
.. | ||
tests | ||
codegen.go | ||
compiler.go | ||
emit.go | ||
func_scope.go | ||
README.md | ||
struct_scope.go |
NEO-GO Compiler
The neo-go compiler compiles Go programs to bytecode that the NEO virtual machine can understand.
The neo-go compiler is under very active development and will be updated on a weekly basis.
Usage
./bin/neo-go contract compile -i mycontract.go --out /Users/foo/bar/contract.avm
Currently supported
Go internals
- type checker
- multiple assigns
- types int, string and booleans
- struct types + method receives
- functions
- composite literals
[]int, []string
- basic if statements
- binary expressions.
- return statements
- imports
VM API (interop layer)
- storage
Not yet implemented
- for loops
- ranges
- builtins (append, len, ..)
- large part of the interop layer (VM API)
Not supported
Due to the limitations of the NEO virtual machine, features listed below will not be supported.
- channels
- goroutines
- multiple returns
How to report compiler bugs
- Make a proper testcase (example testcases can be found in the tests folder)
- Create an issue on Github
- Make a PR with a reference to the created issue, containing the testcase that proves the bug
- Either you fix the bug yourself or wait for patch that solves the problem
Quick start
Compile a smart contract
./bin/neo-go contract compile -i mycontract.go
By default the filename will be the name of your .go file with the .avm extension, the file will be located in the same directory where you called the command from. If you want another location for your compiled contract:
./bin/neo-go contract compile -i mycontract.go --out /Users/foo/bar/contract.avm
Debugging your smart contract
You can dump the opcodes generated by the compiler with the following command:
./bin/neo-go contract opdump -i mycontract.go
This will result in something like this:
INDEX OPCODE DESC
0 0x52 OpPush2
1 0xc5 OpNewArray
2 0x6b OpToAltStack
3 0x 0 OpPush0
4 0x6c OpFromAltStack
5 0x76 OpDup
6 0x6b OpToAltStack
7 0x 0 OpPush0
8 0x52 OpPush2
9 0x7a OpRoll
10 0xc4 OpSetItem