Welcome to NeoRust
๐ NeoRust v1.0.1
Production-Ready Neo N3 Development Suite with 135 Passing Doc Tests
The most comprehensive toolkit for Neo N3 blockchain development. Build with confidence using our powerful CLI, robust Rust SDK, and curated guides.
๐ What Makes NeoRust Specialโ
NeoRust isn't just another blockchain SDK - it's a complete development ecosystem that provides everything you need to build production-ready Neo N3 applications.
โจ Three Powerful Resourcesโ
๐ Guides & Examples
Step-by-step guides and real-world examples for wallets, contracts, and integration workflows.
๐ป Command Line
Powerful CLI with beautiful output, progress indicators, and comprehensive tools. Ideal for developers, automation, and CI/CD pipelines.
๐ Rust SDK
Production-ready library with comprehensive Neo N3 support. Zero panics, full test coverage, and enterprise-grade reliability.
๐ Production Readyโ
โ Proven Reliabilityโ
135/150
Doc Tests Passing
95%
Panic Reduction
100%
Breaking Changes Documented
100%
Production Ready
๐ง Enterprise Featuresโ
- Multi-Network Support: MainNet, TestNet, private networks
- Hardware Wallet Integration: Ledger device support
- Batch Operations: Efficient bulk transaction processing
- Monitoring & Analytics: Built-in performance monitoring
๐ Quick Startโ
Choose your preferred interface and get started in minutes:
๐ป Command Line (Recommended for Developers)โ
cd NeoRust/neo-cli
cargo build --release
./target/release/neo-cli wallet create --name "MyWallet"
๐ Rust SDK (Recommended for Integration)โ
[dependencies]
neo3 = "1.0.1"
use neo3::prelude::*;
async fn example() -> Result<(), Box<dyn std::error::Error>> {
let provider = HttpProvider::new("https://testnet1.neo.coz.io:443")?;
let client = RpcClient::new(provider);
let block_count = client.get_block_count().await?;
println!("Block height: {}", block_count);
Ok(())
}
๐ฏ Use Casesโ
๐ข Enterprise Applicationsโ
- DeFi Platforms: Build decentralized finance applications
- Asset Management: Tokenize and manage digital assets
- Supply Chain: Track products on the blockchain
- Identity Solutions: Decentralized identity management
๐จโ๐ป Developer Toolsโ
- dApp Development: Build decentralized applications
- Smart Contract Testing: Comprehensive testing frameworks
- Blockchain Analytics: Monitor and analyze blockchain data
- Integration Services: Connect existing systems to Neo
๐ฎ Gaming & NFTsโ
- Game Asset Management: In-game item tokenization
- NFT Marketplaces: Create and trade digital collectibles
- Metaverse Integration: Virtual world asset management
- Creator Tools: Content creator monetization platforms
๐ Documentation Structureโ
This documentation is organized into several sections:
๐ Getting Startedโ
- Installation Guide - Set up your development environment
- Quick Start - Get up and running in 5 minutes
- Testing Guide - Validate and test your integration
๐ป Command Line Interfaceโ
- CLI Intro - Introduction to the command line tools
- Commands Reference - Complete command documentation
- Configuration - Customizing the CLI
๐ Rust SDKโ
- SDK Intro - Introduction to the Rust library
- Installation - Set up the SDK in your project
- Quick Start - Build your first SDK workflow
- Examples - Real-world usage examples
- API Reference - Complete API documentation
๐ Community & Supportโ
๐ Getting Helpโ
- GitHub Issues: Report bugs and request features
- Discussions: Community discussions and Q&A
- Documentation: Comprehensive guides and API docs
๐ค Contributingโ
- Contributing Guide: How to contribute to NeoRust
- System Architecture: Core architecture and components
- API Guidelines: API design standards and guidance
๐ Linksโ
- Website: https://neorust.netlify.app
- Crate: https://crates.io/crates/neo3
- API Docs: https://docs.rs/neo3
- GitHub: https://github.com/R3E-Network/NeoRust
Ready to Build on Neo N3? ๐
Choose your preferred interface and start building amazing blockchain applications today!