- 🌟 Overview
- 🏗️ Architecture
- 📁 Project Structure
- 🚀 Quick Start
- ✨ Key Features
- 🔧 Development
- 🧪 Testing
- 📊 Tech Stack
- 🤝 Contributing
- 📄 License
- 🙏 Acknowledgments
DeStock is a professional-grade decentralized trading platform that enables trading of tokenized company shares using DSTK tokens. It combines automated market making (AMM), traditional order books, and liquidity provider rewards in a single platform.
graph LR
A[Frontend Next.js] --> B[Load Balancer Nginx]
B --> C[Microservices]
C --> D[Trade Engine PostgreSQL]
C --> E[Market Maker Bot]
C --> F[Redis Cache]
F --> G[Smart Contracts]
G --> H[DeStock.sol Main Trading]
G --> I[DeStockToken.sol Platform Token]
📐 Architecture Diagram (Text)
Frontend (Next.js) ──► Load Balancer (Nginx) ──► Microservices
├── Trade Engine (PostgreSQL)
├── Market Maker Bot
└── Redis Cache
│
Smart Contracts ◄─────────────────────────────────────┘
├── DeStock.sol (Main Trading) │
└── DeStockToken.sol (Platform Token) ◄───────────────┘
DeStock/
├── 📱 apps/web/ # Next.js Trading Interface
├── 🔗 contracts/ # Smart Contracts & Tests
│ ├── src/ # Solidity contracts
│ ├── test/ # Contract tests
│ └── script/ # Deployment scripts
├── 🐳 services/ # Microservices
│ ├── trade-engine/ # Order matching engine
│ └── market-maker/ # Automated trading bot
├── 🏗️ infrastructure/ # Docker & Config
│ ├── docker-compose.yml # Service orchestration
│ └── nginx.conf # Load balancer
├── 📜 scripts/ # Automation scripts
├── 📚 docs/ # Documentation
└── 🎨 assets/ # Static assets
| Requirement | Version | Installation |
|---|---|---|
| 🐳 Docker Desktop | Latest | Download |
| 🟢 Node.js | 18+ | Download |
| ⚡ Foundry | Latest | curl -L https://foundry.paradigm.xyz | bash |
# Clone and start the platform
git clone https://github.com/shri29s/DeStock.git
cd DeStock
chmod +x scripts/start-destock.sh
./scripts/start-destock.sh| Service | URL | Description |
|---|---|---|
| 🎯 Trading Platform | http://localhost:3000 | Main trading interface |
| 🔧 API Gateway | http://localhost:80 | Load balancer |
| ⛓️ Blockchain RPC | http://localhost:8545 | Local blockchain |
|
🤖 AMM Trading
📊 Order Book
|
🪙 LP Tokens
🏢 Company Tokenization
|
💰 Trading Fees: 0.25% fee structure for platform sustainability
| Feature | Description |
|---|---|
| 📋 Real-time Order Book | Live bid/ask spreads |
| 📊 Professional Charts | Candlestick charts with timeframes |
| 💼 Portfolio Dashboard | Holdings and P&L tracking |
| 🗺️ Market Heatmap | Visual market overview |
| ⚡ Instant Trading | Market and limit orders |
- 🔄 Trade Engine: Real-time order matching with PostgreSQL
- 🤖 Market Maker: Automated liquidity provision
- 📡 WebSocket Streaming: Live price feeds and order updates
- ⚖️ Load Balancer: High-availability architecture
# 🏗️ Contract Development
npm run contracts:build # Compile contracts
npm run contracts:test # Run tests
npm run contracts:deploy # Deploy to local chain# 🎨 Frontend Development
npm run web:dev # Start development server
npm run web:build # Build for production# 🚀 Platform Operations
npm run platform:start # Start entire platform
npm run platform:stop # Stop all services# 🔍 Contract Testing
cd contracts && forge test -vv# 🏥 Health Monitoring
curl http://localhost:3002/api/health # Trade Engine
curl http://localhost:3001/api/health # Market Maker
We welcome contributions! Please follow these steps:
- 🍴 Fork the repository
- 🌿 Create your feature branch:
git checkout -b feature/amazing-feature - 💾 Commit your changes:
git commit -m 'Add amazing feature' - 🚀 Push to the branch:
git push origin feature/amazing-feature - 📬 Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
Special thanks to these amazing projects that made DeStock possible:
- Foundry - Smart contract development toolkit
- Next.js - The React framework for production
- OpenZeppelin - Secure smart contract development
