A modern distributed network for the Smart Economy.
Documentation » · developers.neo.org

Neo · Neo Modules · Neo DevPack

1. Overview
2. Documentation
   1. Documentation hub
   2. Getting started
   3. Architecture
   4. Neo core (neo-project/neo)
   5. Neo node (neo-project/neo-node)
   6. NeoVM (neo-project/neo-vm)
   7. How to: build and test
   8. How to: run a node
   9. How to: smart contracts
   10. How to: contribute
   11. Glossary
   12. Persistence architecture
   13. Serialization format
   14. Official docs notes
3. Project structure
4. Related projects
5. Opening a new issue
6. Contributing
7. Bounty program
8. License

This repository is a csharp implementation of the neo blockchain protocol library. It is jointly maintained by the neo core developers and neo global development community.

It is not the program that starts a node. Neo-CLI lives in neo-project/neo-node. The virtual machine lives in neo-project/neo-vm.

If you are new, start here: docs/getting-started.md.

Official N3 developer hub: developers.neo.org. (The older docs.neo.org tutorials still exist; prefer developers.neo.org for current N3 APIs.)

Beginner-friendly guides in this repository (covers neo, neo-node, and neo-vm):

An overview of the project folders can be seen below.

Code references are provided for all platform building blocks. That includes the base library, the VM, a command line application and the compiler.

• neo: The core libraries for NEO. Guide: docs/neo-core.md.
• neo-node: Neo-CLI and plugins (DBFT, RpcServer, Oracle, ApplicationLogs, storage engines, etc.). Guide: docs/neo-node.md. How to run: docs/how-to/run-a-node.md.
• neo-vm: The Neo Virtual Machine. Guide: docs/neo-vm.md.
• neo-express: A private net optimized for development scenarios.
• neo-devpack-dotnet: These are the official tools used to convert a C# smart-contract into a neo executable file.
• neo-proposals: NEO Enhancement Proposals (NEPs) describe standards for the NEO platform, including core protocol specifications, client APIs, and contract standards.
• neo-non-native-contracts: Includes non-native contracts that live on the blockchain, included but not limited to NeoNameService.

Please feel free to create new issues to suggest features or ask questions.

• Feature request
• Bug report
• Questions

If you found a security issue, please refer to our security policy.

We welcome contributions to the Neo project! To ensure a smooth collaboration process, please follow these guidelines:

• master - The NEO-4 development branch.
• master-n3 - The NEO-3 development branch.

Important: All pull requests must be based on the master or/and master-n3 branch.

1. Fork the repository and create your feature branch from master or/and master-n3:

   git checkout master-n3 # or git checkout master
   git pull origin master-n3 # or git pull origin master
   git checkout -b feature/your-feature-name # or bugfix/your-bugfix-name

2. Make your changes following the project's coding standards and conventions.

3. Test your changes thoroughly to ensure they don't break existing functionality.

4. Commit your changes with clear, descriptive commit messages:

   git commit -m "feature: add new feature description" # or bugfix: fix bug description

5. Push to your fork and create a pull request against the master or/and master-n3 branch:

   git push origin feature/your-feature-name # or bugfix/your-bugfix-name

6. Create a Pull Request targeting the master or/and master-n3 branch with:

   • Clear title and description
   • Reference to any related issues
   • Summary of changes made

feature, bugfix, etc. → master or/and master-n3 → release-vX.Y
hotfix → release-vX.Y

• Feature branches are merged into master or/and master-n3.
• Create a release branch from master or/and master-n3 periodically.
• Only hotfix branches are merged into release branches.

For more detailed contribution guidelines, please check our documentation or reach out to the maintainers.

You can be rewarded by finding security issues. Please refer to our bounty program page for more information.

The NEO project is licensed under the MIT license.