Comprehensive documentation for TrustUp smart contracts on Stellar/Soroban.
System architecture, contract design, and technical specifications.
- Overview - System architecture and tech stack
- Contracts - Detailed contract architecture
- Storage Patterns - Data storage strategies
Code standards, conventions, and best practices.
- Error Handling - Error codes and patterns
- File Organization - Repository structure
- Code Style - Rust code conventions
- Naming Conventions - Naming standards (coming soon)
Development guides, workflows, and tools.
- Setup - Initial setup instructions (coming soon)
- Workflow - Development process (coming soon)
- Testing - Testing strategies (coming soon)
- Tools - Development tools (coming soon)
External resources, tools, and references.
- OpenZeppelin - OpenZeppelin tools and libraries
- Stellar & Soroban - Platform documentation
- AI Assistants & MCP - AI development tools
- Read: PROJECT_CONTEXT.md - Understand TrustUp's vision
- Setup: Install Rust and dependencies
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh rustup target add wasm32-unknown-unknown
- Clone: Get the repository
git clone https://github.com/yourusername/TrustUp-Contracts.git cd TrustUp-Contracts - Verify: Run tests
cargo test - Contribute: See CONTRIBUTING.md
Architecture Overview: architecture/overview.md
Current Contracts:
- ✅ Reputation Contract - User credit scores
- ⏳ CreditLine Contract - Loan management (in progress)
- ⏳ Merchant Registry - Merchant whitelist (planned)
- ⏳ Liquidity Pool - LP management (planned)
Development Roadmap: ROADMAP.md
Security Focus Areas:
- Access control patterns: architecture/overview.md
- Error handling: standards/error-handling.md
- Storage patterns: architecture/storage-patterns.md
- Safe arithmetic: standards/code-style.md
Test Coverage: Run cargo test to see comprehensive test suite
- PROJECT_CONTEXT.md - What is TrustUp?
- CONTRIBUTING.md - How to contribute
- ROADMAP.md - Development timeline
- Architecture Overview - System design
- Error Codes - Complete error reference
- Storage Patterns - Data management
- Code Style - Coding standards
- OpenZeppelin Tools - Security libraries
- Stellar Platform - Blockchain platform
- AI Assistants - Development assistants
# Build all contracts (native)
cargo build --release
# Build WASM for deployment
cargo build -p reputation-contract --target wasm32-unknown-unknown --release# All tests
cargo test
# Specific contract
cargo test -p reputation-contract
# Specific test
cargo test test_increase_score# Format code
cargo fmt
# Lint code
cargo clippy
# Check compilation
cargo checkTrustUp-Contracts/
├── contracts/ # Smart contracts
│ ├── reputation-contract/ # ✅ Reputation scoring
│ ├── creditline-contract/ # ⏳ Loan management
│ ├── merchant-registry-contract/ # ⏳ Merchant whitelist
│ └── liquidity-pool-contract/ # ⏳ LP management
│
├── docs/ # Documentation (you are here)
│ ├── architecture/ # System architecture
│ ├── standards/ # Code standards
│ ├── development/ # Dev workflows
│ └── resources/ # External resources
│
├── Cargo.toml # Workspace configuration
├── CONTRIBUTING.md # Contribution guide
├── PROJECT_CONTEXT.md # Project vision
└── README.md # Project readme
| Contract | Status | Description | Documentation |
|---|---|---|---|
| Reputation | ✅ Complete | User credit scores (0-100) | Details |
| CreditLine | ⏳ In Progress | Loan creation and repayment | Details |
| Merchant Registry | ⏳ Planned | Merchant whitelist | Details |
| Liquidity Pool | ⏳ Planned | LP deposits and rewards | Details |
- Stellar Discord - #soroban channel
- Stellar GitHub
- OpenZeppelin Forum
We welcome contributions! Please see:
- CONTRIBUTING.md - Contribution guidelines
- ROADMAP.md - Pick an issue to work on
- Code Style - Follow our standards
This project is open source. See LICENSE file for details.
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Discord: Stellar Discord - mention @TrustUp
Last Updated: February 2026 Documentation Version: 1.0 Contract Version: See individual contracts