README.md

Real Estate DeFi Platform Documentation

Welcome to the comprehensive documentation for the Real Estate Tokenization and DeFi Lending Platform on Stellar.

🏗️ Platform Overview

This platform combines two powerful concepts:

1. Real Estate Tokenization - Fractional ownership of properties through blockchain tokens
2. DeFi Lending - Privacy-configurable lending pools using tokenized real estate as collateral

📚 Documentation Sections

🚀 Quick Start

• Getting Started

🏗️ Architecture

• System Architecture

🚢 Deployment

Start here for any production or testnet launch.

• Environment Variables - complete .env reference, secret warnings, network passphrases
• Deploy Contracts - build, deploy, oracle setup, pool creation, role grants
• Post-Deploy Checklist - Day 0 action list: liveness, oracle, roles, pool, API verification

🌐 API Workflows

Step-by-step flows for platform integrators and operators.

• API Overview - framework, authentication, rate limiting
• Launch Workflows - end-to-end HTTP sequences with full payloads: KYC onboarding, property tokenization, share purchase
• Minting Workflow - deep dive: tokenization path from HTTP request to on-chain mint_shares
• KYC Workflow - off-chain compliance state machine, admin verification procedure, known gaps

🔥 Operations Runbooks

Use these documents during incidents. Read them before an incident occurs.

• Emergency Pause Runbook - immediate pause, 24-hour timelock recovery, exact CLI commands
• Oracle Failure Runbook - price feed outage, stale data response, backup oracle switch
• Role Management Runbook - grant/revoke EmergencyGuard, admin transfer procedure
• Dividend Distribution - placeholder pending Issue #722

🔧 Legacy Contract Docs

These documents predate the current codebase and contain outdated file paths. Kept for historical context only.

• Contract Deployment (outdated) - superseded by deployment/deploy-contracts.md

🛠️ Technology Stack

• Blockchain: Stellar Network
• Smart Contracts: Soroban (Rust)
• Frontend: Next.js 14, TypeScript, Tailwind CSS
• Backend: Elysia (Bun), TypeScript
• Package Manager: Bun
• CI/CD: GitHub Actions

🔗 Quick Links

• GitHub Repository: Platform Code
• API Documentation: Live API Docs
• Stellar Documentation: Stellar Developers
• Soroban Documentation: Soroban Docs

📞 Support

For technical support or questions:

• Create an issue in the GitHub repository
• Join our community Discord
• Check the FAQ section

🔄 Version History

• v1.0.0: Initial release with core functionality
  • Real estate tokenization
  • DeFi lending pools
  • KYC integration
  • Basic frontend and API

---

This documentation is continuously updated. Last updated: March 2026