Neo Rust SDK
Documentation API Reference Examples Playground GitHub

Neo Rust SDK Documentation

Welcome to the Neo Rust SDK documentation. This comprehensive guide will help you build blockchain applications on the Neo N3 ecosystem using Rust.

Getting Started

The Neo Rust SDK provides a complete toolkit for interacting with the Neo blockchain, allowing you to build decentralized applications, manage digital assets, and deploy smart contracts.

Requirements

Before you begin, make sure you have the following installed:

  • Rust (1.58.0 or later)
  • Cargo (included with Rust)
  • Git

Installation

Add the Neo Rust SDK to your Cargo.toml file:

Cargo.toml
[dependencies]
neo3 = "0.1.9"

For development with the latest features, you can also use the Git repository directly:

Cargo.toml
[dependencies]
neo3 = { git = "https://github.com/R3E-Network/NeoRust.git" }

Basic Usage

Here's a simple example to create a new wallet:

main.rs
use neo::prelude::*;

fn main() -> Result<()> {
    // Create a new wallet
    let wallet = Wallet::new();
    
    // Print the wallet address
    println!("New wallet address: {}", wallet.address());
    
    Ok(())
}

Core Features

The Neo Rust SDK includes the following key features:

  • Wallet Management: Create, load, and manage Neo wallets
  • Transaction Building: Build and sign transactions
  • Smart Contract Interaction: Deploy and invoke smart contracts
  • NEP-17 Token Support: Interact with NEP-17 tokens
  • NNS Integration: Work with the Neo Name Service
  • Neo X Support: EVM compatibility and bridge functionality
  • SGX Support: Secure operations within Intel SGX enclaves

Documentation Structure

Our documentation is organized into the following sections:

  • Introduction: Get started with the Neo Rust SDK
  • Wallet Management: Create and manage Neo wallets
  • Transactions: Build, sign, and send blockchain transactions
  • Smart Contracts: Work with smart contracts on the Neo blockchain
  • Neo X: Use Neo's EVM compatibility features
  • Advanced Topics: Explore cryptography, RPC clients, and more

Support

If you encounter any issues or have questions, you can:

  • Open an issue on GitHub
  • Join the Neo community on Discord
  • Check the API Reference for detailed information about all SDK components

Contributing

We welcome contributions to the Neo Rust SDK! Please refer to our Contributing Guide for details on how to get involved.

Next: Installation