Stellar Web3 Toolkit

A comprehensive deployment pipeline and development toolkit for Soroban smart contracts on the Stellar blockchain. Built with Rust to provide seamless WASM compilation, testing, and deployment capabilities.

Features

• CLI Tool: Complete command-line interface for contract management
• WASM Compilation: Automated Rust-to-WASM compilation pipeline
• Local Testing: Soroban sandbox environment for contract testing
• Stellar Integration: Seamless deployment to Stellar Testnet/Mainnet
• Transaction Signing: Secure transaction signing and verification
• State Verification: Post-deployment contract state validation
• Error Handling: Comprehensive error management and recovery
• Environment Config: Support for dev/test/production environments

Quick Start

Installation

cargo install --path .

Basic Usage

# Compile a contract
stellar-toolkit compile ./contracts/my_contract

# Run tests
stellar-toolkit test ./contracts/my_contract

# Deploy to testnet
stellar-toolkit deploy ./contracts/my_contract --network testnet

# Verify deployment
stellar-toolkit verify <contract_id>

Project Structure

stellar-web3-toolkit/
├── src/
│   ├── main.rs              # CLI entry point
│   ├── cli.rs               # Command definitions
│   ├── compiler.rs          # WASM compilation logic
│   ├── deployer.rs          # Deployment management
│   ├── tester.rs            # Testing framework
│   ├── config.rs            # Configuration management
│   ├── error.rs             # Error handling
│   └── utils.rs             # Utility functions
├── contracts/               # Example contracts
├── tests/                   # Test suites
└── examples/               # Usage examples

Configuration

Create a .env file in your project root:

STELLAR_NETWORK=testnet
STELLAR_SECRET_KEY=your_secret_key
HORIZON_URL=https://horizon-testnet.stellar.org
SOROBAN_RPC_URL=https://soroban-testnet.stellar.org

Development

Building

cargo build --release

Testing

cargo test

Running Examples

cargo run --example basic_deployment

Roadmap

See GitHub Issues for detailed development roadmap including:

• Soroban smart contract deployment pipeline
• HTLC atomic swap implementation
• W3C DID method for Stellar
• Payment channel network
• AMM liquidity pool implementation

Documentation & Resources

• Security Policy - Vulnerability reporting and security SLA
• Contributor Onboarding Guide - Setup guide, workflow, and testing
• Protocol Terms Glossary - Reference for Stellar & Soroban terminology
• Architecture Decision Records (ADRs) - Architectural design rationale
• Soroban Documentation
• Stellar Developers
• Rust Documentation

Contributing

Please review our Contributor Onboarding Guide and Security Policy before contributing.

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests (cargo test --workspace)
5. Submit a pull request

License

MIT License - see LICENSE file for details.

Support

For questions and support, please open an issue on GitHub or report security vulnerabilities according to our Security Policy.