Suite of development tools for NEO smart contracts. Includes a cli disassembler and a GUI debugger. An helper library that helps loading .AVM files and create and load .neomap files is also included, and can be used to create other dev tools.
- A modified NEO compiler to compile C# into an .avm file and at same time emit a .neomap file.
- A debugger IDE will load the .avm and disassemble it into readable opcodes.
- The debugger IDE can also run or step through either the assembly code or the original source (if the .neomap file is present in same directory as the .avm)
- The debugger will also emulate the smart contracts API that interacts with the Blockchain (like Storage, Transactions, Blocks)
- Supports any NEO .AVM, regardless of the language / compiler used
- Source viewer with syntax highlight powered by ScintillaNET
- Run, step and set breakpoints in order to debug smart contracts
- Toggle between source code and assembly code
- Debugging ASM and C# only for now (see section below how to add new languages)
- Windows only for now, using .NET Framework / Winforms / ScintillaNET
- Smart contract source is limited to a single file for now
- Not possible yet to inspect variable values
- Most NEO syscalls/APIs not supported yet (work in progress)
Open the .avm file in the NEO-dbg GUI application. This will show either assembly code for the .avm or C# if a debug map file was found. Currently the only way to generate a .neomap file is to compile the smart contracts with the modified NeoN compiler include in this repository.
Key | Action | Comments |
---|---|---|
F5 | Executes the smart contract | |
F10 | Steps through the smart contract | |
F12 | Toggle between assembly and source code | Only works when a .neomap file is available |
A single smart contract can have different results and behaviours depending on the inputs passed to it.
So when debugging a contract it is necessary to be able to specify the inputs. Currently this is done via a contract.json that resides in the same folder as the debugger executable.
This file can be edited to suit your needs, and the different inputs there will appear every time you use the debugger to execute the contract.
NEO smart contracts can be coded in many different languages, and in theory, this compiler already supports any language as long as a .neomap file exists in the same directory as the .avm file. However since only NeoN was modified to emit those map files during compilation, to add other languages it would be necessary to modify other compilers to emit a .neomap. The .neomap file format is simple, for each line you need to list a starting offset, ending offset, the source line and the corresponding source file, all values separated by a comma.
- Customize smart contract arguments
- Stack viewer
- Storage emulation
- Transactions emulation
- Persistency of smart contract storage to disk
- Debugger map generation for Java / Python / others
Created by Sérgio Flores (http://lunarlabs.pt/).
Credits also go to the NEO team(http://neo.org), as a large part of this work was based on their NEO compiler and NEO VM.
This project is released under the MIT license, see LICENSE.md
for more details.