nearc 0.3.2

Python to WebAssembly compiler for NEAR smart contracts

NEARC - NEAR Python Contract Compiler

NEARC is a specialized compiler that transforms Python smart contracts into WebAssembly bytecode for deployment on the NEAR blockchain. It allows developers to write smart contracts in Python rather than Rust or AssemblyScript, leveraging MicroPython as the underlying runtime.

Features

• Write NEAR smart contracts in Python
• Use Python decorators (@export, @view, @call, etc.) to mark contract methods
• Automatic dependency detection and packaging
• Optimized WebAssembly output
• Automatic NEP-330 contract metadata compliance

Prerequisites

• Python 3.11 or newer
• Emscripten (emcc must be in PATH)
• uv for Python package management

Getting Started

NEARC is designed to be used without installation via uvx:

# Use directly with uvx (recommended)
uvx nearc contract.py

Alternatively, you can install it globally:

# Add to global Python with uv
uv pip install nearc

# Or install from PyPI
pip install nearc

Usage

# Basic usage
nearc contract.py

# Specify output file
nearc contract.py -o my-contract.wasm

# Use custom virtual environment
nearc contract.py --venv my-venv

# Force rebuild
nearc contract.py --rebuild

Command Line Options

Option	Description
--output, -o	Output WASM filename (default: derived from contract name)
--venv	Path to virtual environment (default: .venv)
--rebuild	Force rebuild of all components

Writing NEAR Contracts in Python

Here's a simple example of a NEAR smart contract written in Python:

# counter.py
import near

@near.export
def get_count():
    return near.storage_read('count', 0)

@near.export
def increment():
    count = near.storage_read('count', 0)
    count += 1
    near.storage_write('count', count)
    return count

The compiler automatically detects functions with @near.export and similar decorators, making them available as contract methods in the compiled WebAssembly.

Contract Metadata (NEP-330)

NEARC automatically adds NEP-330 compliant metadata to your contracts. You can customize the metadata in two ways:

Using Standard Project Metadata (PEP 621)

You can use standard Python project metadata fields in your pyproject.toml file, which NEARC will automatically use to populate NEP-330 metadata:

[project]
name = "my-near-contract"
version = "0.2.0"
description = "My NEAR smart contract"

[project.urls]
repository = "https://github.com/myorg/mycontract"

Using NEAR-Specific Configuration

For more advanced metadata and NEAR-specific fields, you can use the [tool.near.contract] section:

[tool.near.contract]
version = "0.2.0"
link = "https://github.com/myorg/mycontract"
standards = [
  { standard = "nep141", version = "1.0.0" },
  { standard = "nep148", version = "1.0.0" }
]
build_info = {
  build_environment = "docker.io/sourcescan/near-python@sha256:bf488476d9c4e49e36862bbdef2c595f88d34a295fd551cc65dc291553849471",
  source_code_snapshot = "git+https://github.com/myorg/mycontract.git#main",
  contract_path = ".",
  build_command = ["nearc", "contract.py", "--no-debug"]
}

This will generate a contract_source_metadata function in your contract that returns:

{
  "version": "0.2.0",
  "link": "https://github.com/myorg/mycontract",
  "standards": [
    { "standard": "nep141", "version": "1.0.0" },
    { "standard": "nep148", "version": "1.0.0" },
    { "standard": "nep330", "version": "1.0.0" }
  ],
  "build_info": {
    "build_environment": "docker.io/sourcescan/near-python@sha256:bf488476d9c4e49e36862bbdef2c595f88d34a295fd551cc65dc291553849471",
    "source_code_snapshot": "git+https://github.com/myorg/mycontract.git#main",
    "contract_path": ".",
    "build_command": ["nearc", "contract.py", "--no-debug"]
  }
}

If you already have a contract_source_metadata function in your contract, it will be preserved.

Metadata Field Priority

When both standard project metadata and NEAR-specific configuration are present, NEARC uses the following priority order:

1. Standard PEP 621 fields ([project] section)
2. NEAR-specific fields ([tool.near.contract] section)

The NEP-330 standard is always included in the standards list, ensuring compliance.

How It Works

NEARC compiles Python smart contracts to WebAssembly through these steps:

1. Code Analysis - Identifies exported functions and dependencies in the Python code
2. Metadata Injection - Adds NEP-330 metadata if not already present
3. Manifest Generation - Creates a MicroPython manifest file that includes all necessary modules
4. Export Wrapping - Generates C wrappers for exported functions
5. WebAssembly Compilation - Uses MicroPython and Emscripten to compile to WebAssembly
6. Optimization - Produces a compact WASM file ready for blockchain deployment

The compiler handles dependency resolution automatically, making it easy to use Python libraries in your contracts (as long as they're compatible with MicroPython).

Development

If you want to contribute to NEARC or modify the source code:

# Clone the repository
git clone https://github.com/r-near/nearc
cd nearc

# Initialize submodules
git submodule update --init src/nearc/micropython
git -C src/nearc/micropython submodule update --init lib/micropython-lib

# Create virtual environment for development
uv init
uv pip install -e '.[dev]'

Technical Details

MicroPython Integration

NEARC uses a customized version of MicroPython as its runtime environment:

• Focused on minimal memory footprint and efficient execution
• Includes NEAR-specific host function bindings
• Provides a Python standard library subset optimized for smart contracts

Support for External Dependencies

The compiler can include Python packages from your virtual environment:

• Automatically detects imports in your code
• Includes them in the compiled WebAssembly
• Warns about incompatible or missing dependencies

Limitations

• Only supports MicroPython-compatible Python code
• Not all Python standard library modules are available
• No support for async/await syntax
• Limited compatibility with existing Python packages
• Contract size limitations (though generally sufficient for most use cases)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.