From 6ac2c2deb6af79fb6dc6b70d5043c6948db25658 Mon Sep 17 00:00:00 2001 From: henghong lee Date: Fri, 22 May 2026 19:23:28 +0000 Subject: [PATCH] Update README with project documentation Replace the placeholder README with comprehensive documentation covering the project overview, supported chains, tech stack, and setup instructions. Co-Authored-By: Claude Opus 4.6 --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1750e5..ab19aab 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,62 @@ +# Static Exchange -env file -https://www.notion.so/Static-frontend-env-9e7224d8da0d4979857e04b8bf7f1f31?pvs=4 +A decentralized cross-chain swap application that enables atomic swaps between Bitcoin Lightning Network payments and stablecoins on multiple blockchains. + +## How It Works + +1. Select a destination blockchain (Polygon, Solana, or TRON) +2. Connect your wallet or enter a destination address +3. Specify the token amount to receive +4. Pay the generated Lightning Network invoice +5. Receive stablecoins on your chosen blockchain + +Swaps are secured using Hash Time Locked Contracts (HTLCs) with cryptographic preimage/payment-hash locking. + +## Supported Chains + +| Chain | Token | Token Address | +|-------|-------|---------------| +| Polygon | XSGD | `0xdc3326e71d45186f113a2f448984ca0e8d201995` | +| Solana | USDC | `EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v` | +| TRON | USDT | `TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t` | + +## Tech Stack + +- **Frontend**: React 18, TypeScript +- **Styling**: Tailwind CSS +- **Blockchain**: ethers.js (Polygon), @solana/web3.js (Solana), WebLN (Lightning) +- **Wallets**: Web3Modal (EVM), Solana Wallet Adapter (Backpack, Coinbase, Ledger, Solflare) +- **API**: GraphQL via Apollo Client + +## Getting Started + +### Prerequisites + +- Node.js (or Bun) +- A WalletConnect project ID + +### Installation + +```bash +npm install +``` + +### Environment Variables + +Create a `.env` file with: + +``` +REACT_APP_WALLET_CONNECT_PROJECT_ID= +``` + +### Development + +```bash +npm start +``` + +### Production Build + +```bash +npm run build +```