From 2a062cf5e1aa2863d51390d7bcd8c073de5bcd4b Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 16 Nov 2026 23:00:34 -0500 Subject: [PATCH] account: README with flow, endpoints and deploy notes Co-Authored-By: Claude Opus 5.5 --- server/account/README.md | 59 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 server/account/README.md diff --git a/server/account/README.md b/server/account/README.md new file mode 100644 index 0000000..3f2c722 --- /dev/null +++ b/server/account/README.md @@ -0,0 +1,59 @@ +# eom.dev accounts (Dex SSO) and wallet linking + +Off-chain only. Nothing here changes blocks, transfers, trades or validation. + +## Flow +1. **Browser** (`src/auth/session.ts`): + - `GET /api/account/config` + - build the PKCE S256 authorize URL (with `state` and `nonce`) + - navigate to `https://dex.eom.dev/auth` +2. Dex redirects to `/auth/callback`. On native, it uses `dev.eom.wikideck:/oauth/callback`. +3. **Browser** sends `POST /api/account/token {code, codeVerifier, redirectUri, nonce}`. The **node** then: + - exchanges the code as the public client `wikideck` (no secret) + - verifies the ID token against the JWKS + - returns `{idToken, expiresAt, account}` + + The exchange runs on the node because Dex sends no CORS headers. +4. The browser keeps the ID token in **sessionStorage** and sends it as `Authorization: Bearer`. +5. **Linking a wallet:** + - `POST challenge {address}` → `{nonce, message, expiresAt}` + - the wallet signs `message` locally with `src/wallet.ts` `sign` + - `POST link {nonce, address, publicKey, signature}` + + Nonces are single use, expire after 5 minutes, and are bound to (sub, address). One wallet belongs to one account. + +## Endpoints (`/api/account/...`) +| Method | Path | Auth | Purpose | +|---|---|---|---| +| GET | `config` | none | issuer, clientId, scopes, authorization endpoint, allowed redirect URIs | +| POST | `token` | none | code exchange → ID token + account | +| GET | `me` | Bearer | account + linked wallets | +| POST | `challenge` | Bearer | one-time link challenge | +| POST | `link` | Bearer | prove wallet ownership, store mapping | +| DELETE | `link/:address` | Bearer | unlink | +| GET | `names?addresses=a,b` | none | leaderboard display names (`name` → `preferred_username`; never email) | + +Signed link message (off-chain, domain-tagged): +`["wikideck:account-link:v1", NETWORK, issuer, sub, address, nonce, expiresAt]` + +## Node configuration +- **`PUBLIC_ORIGIN`** must be the node's UI origin, for example `http://192.168.1.32:3101`. Otherwise the existing POST origin check returns 403. +- **Outbound HTTPS** to `https://dex.eom.dev` is required. +- **Optional overrides:** + - `WIKIDECK_OIDC_ISSUER` (default `https://dex.eom.dev/`) + - `WIKIDECK_OIDC_CLIENT_ID` (default `wikideck`) + - `WIKIDECK_OIDC_REDIRECT_URIS` (comma-separated; must match the Dex registration) +- **Storage:** `$WIKIDECK_DATA_DIR/accounts.sqlite`. + +## Capacitor +- Register the URL scheme `dev.eom.wikideck`. +- Install `@capacitor/browser` and `@capacitor/app`. +- Add the listener: + ```ts + App.addListener('appUrlOpen', ({ url }) => { if (isCallback(url)) void completeLogin(url); }); + ``` + +## Known limits +- **Logout is local.** Dex publishes no `end_session_endpoint`, so its SSO cookie remains. +- **ID tokens aren't refreshed.** The default Dex lifetime is 24 h; after that, log in again. +- **Challenges live in memory.** A node restart drops pending challenges, so the client just asks again.