Soroban Contract Templates

A curated collection of production-ready Soroban smart contract templates. These templates help developers quickly bootstrap common use cases on Soroban (Stellar's smart contract platform) for DeFi, payments, governance, and more.

🚀 Quick Start

# Clone the repository
git clone https://github.com/your-username/soroban-contract-templates.git
cd soroban-contract-templates

# Build a contract (example: token)
cd contracts/token
soroban contract build

# Deploy to testnet
./scripts/deploy.sh testnet

# Run tests
cargo test

📦 Contract Templates

Template	Description	Use Cases	Status
Token	Custom fungible token with mint/burn/admin controls	DeFi tokens, governance tokens, utility tokens	✅ Complete
Escrow	Two-party escrow with timeout and refund mechanism	P2P trading, service payments, milestone payments	✅ Complete

Token Contract Features

• Standard Interface: Full Soroban token compatibility
• Administrative Controls: Mint, burn, and admin management
• Metadata Support: Name, symbol, and decimals
• Allowance System: Approve and transfer_from functionality
• Event Emission: All operations emit events for tracking
• Error Handling: Custom error types for better debugging

Escrow Contract Features

• Two-Party Security: Secure buyer-seller transactions
• Deadline Protection: Automatic refunds after deadline
• Arbiter Support: Third-party dispute resolution
• State Management: Clear transaction lifecycle
• Token Agnostic: Works with any Soroban token
• Event Emission: All operations emit events for tracking

Each template includes:

• ✅ Complete contract implementation
• ✅ Comprehensive unit tests (8+ test cases each)
• ✅ Deployment scripts with examples
• ✅ Usage examples and documentation

🛠 Prerequisites

• Rust (latest stable)
• Soroban CLI
• Docker (for local Stellar node)

📖 Usage

Building Contracts

cd contracts/[template-name]
soroban contract build

Running Tests

cd contracts/[template-name]
cargo test

Deploying to Testnet

cd contracts/[template-name]
./scripts/deploy.sh testnet

Local Development

Start a local Stellar node with Soroban RPC:

docker compose up stellar-node

🤝 Contributing

We welcome contributions! Please:

• Add new contract templates following the existing structure
• Include comprehensive tests for all functionality
• Provide clear documentation and usage examples
• Follow Rust and Soroban best practices

📚 Resources

• Soroban Documentation
• Stellar Developer Discord
• Soroban Examples
• Freighter Wallet
• Stellar Laboratory

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

---

Ready to build on Soroban? Start with any template and customize it for your use case! 🚀