mirror of
https://github.com/Such-Software/smirk-website.git
synced 2026-06-13 01:21:32 -04:00
main
The runtime that installs window.smirk in v0.3.0+ iframe context is now available as a published npm package, so smirk.cash can import it directly instead of carrying a synced local copy. Same behaviour, less maintenance burden. - npm install @such-software/smirk-dapp-api@^0.3.0 - SmirkBridgeBootstrap imports installSmirkPageApi from the package - Local mirror deleted (src/lib/smirk-iframe-bridge.ts)
Smirk Website
User dashboard for Smirk wallet users. Requires the Smirk browser extension to access.
Overview
This website serves as a hub for Smirk wallet users to:
- View their account UUID and balances
- See tipping history (sent and received)
- Register & verify social platform usernames (Telegram, Discord)
- Manage social tips - view sent/received, clawback unclaimed
- Public stats - platform growth metrics at /stats
Important: This site is ONLY accessible to users with the Smirk extension installed. Authentication happens via cryptographic signatures from the user's wallet keys.
Architecture
Deployment Options
The website is designed to be deployable either:
- Alongside the backend - Served from the same server as smirk-backend (current plan)
- Separately - As a standalone deployment (e.g., Vercel, separate server)
Keep this flexibility in mind when developing - avoid tight coupling to backend internals.
Extension Communication
The Smirk extension injects a window.smirk API object into web pages. The website uses this to:
- Detect extension - Check if
window.smirkexists - Connect - Request user's public keys (with user approval)
- Sign - Request signatures for authentication challenges (BTC/LTC: ECDSA, XMR/WOW/Grin: Ed25519)
┌─────────────┐ window.smirk ┌─────────────────┐
│ Website │ ◄──────────────────► │ Smirk Extension │
└──────┬──────┘ └────────┬────────┘
│ │
│ POST /auth/verify │ User approves
│ { publicKeys, signatures } │ in popup
▼ ▼
┌─────────────┐ ┌─────────────────┐
│ Backend │ │ Extension UI │
└─────────────┘ └─────────────────┘
Authentication Flow
- User clicks "Connect with Smirk"
- Website calls
window.smirk.connect() - Extension shows approval popup
- User approves → Extension returns public keys for all 5 assets
- Website calls
POST /api/v1/auth/website/challengewith origin - Backend returns challenge message (with nonce + timestamp + origin)
- Website calls
window.smirk.signMessage(challenge) - Extension shows asset picker - user chooses favorite coin
- User signs → Extension returns signature from chosen asset
- Website sends
{ challenge_id, signature }toPOST /api/v1/auth/website/verify - Backend verifies signature, looks up user by pubkey_hash, issues JWT session
- Website stores JWT, user is now authenticated
Tech Stack
- Framework: Next.js 14+ (App Router)
- Styling: Tailwind CSS
- State: React Context / Zustand (TBD)
- Auth: JWT sessions verified against backend
Development
# Install dependencies
npm install
# Run development server
npm run dev
# Build for production
npm run build
# Start production server
npm start
Environment Variables
# Backend API URL
NEXT_PUBLIC_API_URL=http://localhost:3000
# For production
NEXT_PUBLIC_API_URL=https://api.smirk.cash
Project Structure
src/
├── app/ # Next.js App Router pages
│ ├── page.tsx # Landing / Connect page
│ ├── dashboard/ # Protected dashboard routes
│ │ ├── page.tsx # Main dashboard (balances, UUID)
│ │ ├── history/ # Tip history
│ │ └── settings/ # Account settings
│ └── layout.tsx # Root layout
├── components/ # React components
│ ├── ConnectButton.tsx # "Connect with Smirk" button
│ ├── Dashboard/ # Dashboard components
│ └── ui/ # Shared UI components
├── lib/
│ ├── smirk.ts # window.smirk API wrapper
│ ├── auth.ts # Authentication utilities
│ └── api.ts # Backend API client
└── types/
└── smirk.d.ts # TypeScript types for window.smirk
Security Considerations
- Challenge messages include timestamps to prevent replay attacks
- Signatures are verified server-side against registered public keys
- JWT tokens have reasonable expiration
- HTTPS required in production
- CSP headers to prevent XSS
Related Projects
- smirk-extension - Browser extension (injects
window.smirk) - smirk-backend - Rust backend API
Languages
TypeScript
97.7%
CSS
1.8%
JavaScript
0.5%