swiftbridge-docs

SwiftBridge

Seamless crypto offramp/onramp, swaps, and P2P transfers on Base network

---

🌉 What is SwiftBridge?

SwiftBridge is a comprehensive crypto bridge solution that enables:

• Offramp/Onramp: Buy and sell crypto with Nigerian Naira
• Token Swaps: Exchange tokens via Uniswap V3
• P2P Transfers: Send crypto using Telegram usernames
• Easy Access: Via Telegram bot and web mini app

---

🏗️ Project Structure

SwiftBridge/
│
├── swiftbridge-contracts/    # Smart contracts on Base
│   ├── UserRegistry          # Username → wallet mapping
│   ├── EscrowManager         # Buy/sell escrow system
│   ├── P2PTransfer          # Send to @username
│   └── SwapRouter           # Token swaps
│
├── swiftbridge-bot/          # Telegram bot
│   ├── Commands              # /buy, /sell, /send, /swap
│   ├── Blockchain service    # Contract interactions
│   └── Rate service         # Exchange rates
│
└── swiftbridge-miniapp/      # Web mini app
    ├── Wallet connection     # Reown AppKit
    ├── Dashboard            # Balance view
    ├── Swap interface       # Token swaps
    └── Send interface       # P2P transfers

---

🚀 Quick Start

For Users

Via Telegram Bot:

1. Open @swiftbridgebot
2. Send /start
3. Register with /register
4. Start using SwiftBridge!

Via Mini App:

1. Visit app.swiftbridge.com
2. Connect your wallet
3. Swap, send, and manage crypto

For Developers

# Clone all repositories
git clone https://github.com/SwiftBridge/swiftbridge-contracts
git clone https://github.com/SwiftBridge/swiftbridge-bot
git clone https://github.com/SwiftBridge/swiftbridge-miniapp

# Or use the org
git clone https://github.com/SwiftBridge/* --recursive

See individual README files in each repo for setup instructions.

---

📦 Deployed Addresses (Base Sepolia)

Contract	Address
UserRegistry	0xFaaE...3667
EscrowManager	0xBd52...2568
P2PTransfer	0x2B11...3774
SwapRouter	0xb71A...0DCdf

---

✨ Features

🔗 Smart Contracts

• Username registration for easy P2P transfers
• Secure escrow system for fiat on/offramp
• P2P transfers using Telegram usernames
• Token swaps via Uniswap V3
• Fee collection mechanism

🤖 Telegram Bot

• /buy <amount> <token> - Buy crypto with Naira
• /sell <amount> <token> - Sell crypto for Naira
• /send <amount> <token> to @username - P2P transfers
• /swap <amount> <from> to <to> - Token swaps
• /balance - Check balances
• /rates - Live exchange rates

🎨 Mini App

• Connect any Web3 wallet (MetaMask, WalletConnect, etc.)
• Beautiful dashboard with portfolio overview
• Easy-to-use swap interface
• Send crypto to Telegram usernames
• Real-time balance updates

---

🛠️ Tech Stack

• Smart Contracts: Solidity, Hardhat, OpenZeppelin
• Bot: Node.js, Grammy, Ethers.js
• Mini App: Next.js, Reown AppKit, Wagmi, Tailwind
• Blockchain: Base (Sepolia testnet)

---

📊 Supported Tokens

• USDC - USD Coin
• WETH - Wrapped Ether
• More tokens coming soon

---

🎯 Roadmap

✅ Phase 1 - Testnet Launch (COMPLETED)

• Smart contract development
• Telegram bot
• Web mini app
• Base Sepolia deployment

🚧 Phase 2 - Mainnet Preparation

• Professional security audit
• Real payment processor integration
• Enhanced UI/UX
• Comprehensive testing

🔮 Phase 3 - Mainnet & Growth

• Deploy to Base mainnet
• Marketing campaign
• Partnerships
• User acquisition

💫 Phase 4 - Expansion

• Multi-chain support
• More tokens
• Advanced features
• Mobile apps

---

🔐 Security

Current (Testnet)

• OpenZeppelin battle-tested contracts
• ReentrancyGuard on state-changing functions
• Access control and pausability
• ⚠️ Not audited - testnet only

Future (Mainnet)

• Professional security audit
• Bug bounty program
• Comprehensive testing
• Insurance coverage

---

📖 Documentation

• Project Summary
• Deployment Checklist
• Contracts Documentation
• Bot Documentation
• Mini App Documentation

---

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Development Setup

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

---

📄 License

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

---

🙏 Acknowledgments

• Base - The blockchain platform
• OpenZeppelin - Smart contract libraries
• Uniswap - DEX protocol
• Grammy - Telegram bot framework
• Next.js - React framework
• Reown - Wallet connection (WalletConnect)

---

💬 Community & Support

• Telegram Bot: @swiftbridgebot
• Support: @SwiftBridgeSupport
• Twitter: @SwiftBridge
• GitHub: SwiftBridge
• Discord: Join our server

---

⚠️ Disclaimer

TESTNET VERSION: This is a testnet deployment on Base Sepolia for testing purposes only. Do not use with real funds. The smart contracts have not been professionally audited. Use at your own risk.

For production deployment on mainnet, comprehensive security audits and testing are required.

---

📈 Stats

• Contracts Deployed: 4
• Lines of Code: ~2,500
• Bot Commands: 10+
• Supported Tokens: 2 (growing)
• Network: Base Sepolia (testnet)

---

🌟 Star History

If you find this project useful, please consider giving it a star ⭐

---

Built with ❤️ for the Base ecosystem

Website • Docs • Blog