neo

Table of Contents

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

Overview

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.)

Documentation

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

Guide	Description
Documentation hub	Index of all local docs
Getting started	What this repo is, what to clone, common mix-ups
Architecture	How neo + neo-node + neo-vm fit together
Neo core	This library (neo-project/neo)
Neo node	Neo-CLI and plugins (neo-project/neo-node)
NeoVM	Virtual machine (neo-project/neo-vm)
How to: build and test	dotnet test / publish all three repos
How to: run a node	Start Neo-CLI, RPC ports, plugins
How to: smart contracts	NEF, deploy, invoke
How to: contribute	Branches, which repo to PR
Glossary	GAS, dBFT, NEF, hardfork, …
Persistence architecture	Stores and DataCache
Serialization format

Project structure

An overview of the project folders can be seen below.

Folder	Content
/src/neo/Cryptography/	General cryptography implementation, including ECC.
/src/neo/IO/	Data structures used for caching and collection interaction.
/src/neo/Ledger/	Classes responsible for the state control, including the MemoryPool and Blockchain.
/src/neo/Network/	Peer-to-peer protocol implementation.
/src/neo/Persistence/	Classes used to allow other classes to access application state.
/src/neo/Plugins/	Interfaces used to extend Neo, including the storage interface.
/src/neo/SmartContract/	Native contracts, ApplicationEngine, InteropService and other smart-contract related classes.
/src/neo/Wallets/	Wallet and account implementation.
/src/Neo.Extensions/	Extensions to expand the existing functionality.
/src/Neo.Json/	Neo's JSON specification.
/tests/	All unit tests.

Related projects

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

This is the beginning of the README. Read the rest at the original. Read the full README ↗