@byoky/relay 0.4.10 → 0.4.11

package/README.md

@@ -0,0 +1,79 @@
+# @byoky/relay
+
+WebSocket relay server for [Byoky](https://byoky.com). Enables real-time pairing between web apps and mobile wallets when the browser extension isn't available.
+
+```
+Web App <--WebSocket--> Relay Server <--WebSocket--> Mobile Wallet
+```
+
+## What It Does
+
+The relay is a stateless message broker. When a user doesn't have the Byoky browser extension, the web app generates a pairing code. The user scans it with the Byoky mobile app, and both sides connect to this relay. All API requests are then proxied through the phone's wallet -- keys never leave the device.
+
+The relay never inspects payloads. It just forwards JSON messages between paired peers.
+
+## Deploy
+
+### Self-hosted
+
+```bash
+npm install @byoky/relay
+PORT=8787 npx byoky-relay
+```
+
+### Docker
+
+```dockerfile
+FROM node:20-alpine
+RUN npm install -g @byoky/relay
+EXPOSE 8787
+CMD ["byoky-relay"]
+```
+
+### Railway / Fly.io / Render
+
+Deploy as a standard Node.js WebSocket server. Set the `PORT` environment variable if needed.
+
+## Configuration
+
+| Env Variable | Default | Description |
+|-------------|---------|-------------|
+| `PORT` | `8787` | Server listen port |
+
+## How It Works
+
+1. Web app creates a room with a random ID and auth token
+2. Mobile app scans the QR code containing room ID + token
+3. Both connect to the relay and authenticate with `relay:auth`
+4. Relay assigns sender (phone) and recipient (browser) roles
+5. All subsequent messages are forwarded between the pair
+6. Idle rooms are cleaned up after 5 minutes
+
+### Security
+
+- Auth tokens are compared using constant-time comparison
+- Rate-limited to 5 auth attempts per 60 seconds per connection
+- No message payloads are stored or inspected
+
+## Using with the SDK
+
+Point the SDK to your relay instance:
+
+```typescript
+import { Byoky } from '@byoky/sdk';
+
+const byoky = new Byoky({
+  relayUrl: 'wss://your-relay.example.com',
+});
+
+const session = await byoky.connect({
+  providers: [{ id: 'anthropic', required: true }],
+  modal: true,
+});
+```
+
+The default relay is `wss://relay.byoky.com`.
+
+## License
+
+[MIT](../../LICENSE)

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@byoky/relay",
-  "version": "0.4.10",
+  "version": "0.4.11",
   "description": "WebSocket relay server for Byoky",
   "type": "module",
   "main": "dist/server.js",
-  "bin": {
-    "byoky-relay": "dist/server.js"
+  "bin": { "byoky-relay": "dist/server.js" },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/server.js",
+    "dev": "tsx src/server.ts"
   },
   "dependencies": {
     "ws": "^8.16.0"
@@ -14,10 +17,5 @@
     "typescript": "^5.4.0",
     "tsx": "^4.7.0",
     "@types/ws": "^8.5.10"
-  },
-  "scripts": {
-    "build": "tsc",
-    "start": "node dist/server.js",
-    "dev": "tsx src/server.ts"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 byoky contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.