README.md

Write smart contracts for Neo3 in Python
Made by COZ.IO

neo3-boa · neo-mamba · cpm

Note: The latest release (v0.14.0) has breaking changes with contracts written using previous versions. Please refer to our migration guide to update your smart contracts.

Table of Contents

• Overview
• Quickstart
  • Installation
    • Pip (Recommended)
    • Build from Source (Optional)
• Docs
• Reference Examples
• Neo Python Suite Projects
• Contributing
• License

Overview

Neo3-Boa is a tool for creating Neo Smart Contracts using Python. It compiles .py files to .nef and .manifest.json formats for usage in the Neo Virtual Machine which is used to execute contracts on the Neo Blockchain.

Neo3-Boa is part of the Neo Python Framework, aimed to allow the full development of dApps using Python alone.

Quickstart

Installation requires Python 3.10 or later.

Installation

Make a Python 3 virtual environment and activate it:

On Linux / Mac OS:

$ python3 -m venv venv
$ source venv/bin/activate

On Windows:

$ python3 -m venv venv
$ venv\Scripts\activate.bat

Pip (Recommended)

Install Neo3-Boa using Pip:

$ pip install neo3-boa

Build from Source (Optional)

If Neo3-Boa is not available via pip, you can run it from source.

Clone Neo3-Boa:

$ git clone https://github.com/CityOfZion/neo3-boa.git

Install project dependencies:

$ pip install wheel
$ pip install -e .

Docs

Check out our getting started documentation to learn how to use the compiler. Also check our examples below for reference.

Reference Examples

For an extensive collection of examples:

• Smart contract examples
• Features tests

Neo Python Suite Projects

• Neo3-Boa: Python smart contracts' compiler.
• neo3-mamba: Python SDK for interacting with Neo.

Contributing

Checkout our contributing file to see how you can contribute with our project.

License

• Open-source Apache 2.0.