Feat/connect rtc

.decisions/3-Peer-to-Peer-Signaling.md

@@ -0,0 +1,60 @@
+# Overview
+
+Communicating across platforms in a decentralized manner
+
+## Decisions
+
+- Limit dependency on WebSockets to signaling
+- Allow bidirectional communication between peers
+- Enforce locality of device?
+
+## Implementation
+
+A WebSocket Service should establish the SDP handshake and emit ICE candidates for WebRTC clients.
+
+This implementation should replace Wallet Connect with the following sequence
+```mermaid
+sequenceDiagram
+    participant Website
+    participant Server
+    participant Wallet
+    Note over Website, Wallet: Link devices
+    Website->>Server: GET Challenge Message
+    Server->>Website: Send Challenge Message
+
+    Website-->>Website: Display QR Connect Nonce
+    Website->>Server: Subscribe to 'wss:link'
+    Wallet->>Website: Scan QR Code
+    Wallet->>Server: POST Nonce + Signature + Answer
+    Server-->>Server: Validate Signature
+    Server-->>Website: HTTPOnly Session
+    Server->>Wallet: Ok Response + HTTPOnly Session
+    Server->>Website: Emit to `wss:link` client
+    Note over Website, Wallet: Passkeys/FIDO2
+    Website-->>Website: Continue FIDO2 Flow
+    Wallet-->>Wallet: Continue FIDO2 Flow
+    Note over Website, Wallet: Signaling Peer Offer/Answer
+    Website-->>Server: Subscribe to 'wss:answer-${address}'
+    Wallet-->>Server: Subscribe to 'wss:offer-${address}'
+
+    Website-->>Website: Create Peer Offer & DataChannel
+    Website-->>Server: POST Offer
+    Server-->>Wallet: Emit Offer
+
+    Wallet-->>Wallet: Create Peer Answer with Offer & DataChannel
+
+    Wallet-->>Server: POST Answer
+    Server-->>Website: Emit Answer
+    Website-->>Website: Set Remote SDP
+    Website-->>Website: Discover ICE Candidates
+    Website->>Server: Emit candidates to `wss:offer-${address}`
+    Server->>Wallet: Emit candidates to `wss:offer-${address}`
+    Wallet-->>Wallet: Set Candidates
+    Wallet-->>Wallet: Discover ICE Candidates
+    Wallet->>Server: Emit candidates to `wss:answer-${address}`
+    Server->>Website: Emit to `wss:answer`
+    Website->>Website: Set Candidates
+
+```
+
+*Note: This process may be deprecated in the future in favor of `libp2p` which allows for an agnostic discovery layer and also supports the WebRTC transport

.github/workflows/CI.yml

@@ -0,0 +1,23 @@
+name: CI
+on: [pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18.x, 20.x ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install Dependencies
+        run: npm install
+      - name: Run Build
+        run: npm run build
+      - name: Lint Codebase
+        run: npm run lint
+      - name: Unit Tests with Coverage
+        run: npm run test:cov

.gitignore

@@ -1,3 +1,5 @@
+swagger-codegen-cli.jar
+
 .data
 .idea
 

client-gen.sh

@@ -0,0 +1,12 @@
+
+
+CODEGEN=swagger-codegen-cli.jar
+if [ -f $CODEGEN ]; then
+    echo "Codegen already exists"
+else
+    echo "Downloading codegen"
+    wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.52/swagger-codegen-cli-3.0.52.jar -O swagger-codegen-cli.jar
+fi
+
+java -jar swagger-codegen-cli.jar generate -i http://localhost:3000/api-json -l typescript-fetch -o clients/liquid-auth-client-js/src/client
+java -jar swagger-codegen-cli.jar generate -i http://localhost:3000/api-json -l kotlin-client -o clients/liquid-auth-client-kotlin

clients/README.md

@@ -0,0 +1,59 @@
+# Overview
+
+Client JSON-RPC interfaces are generated from OpenAPI 3.0 specifications.
+All clients should mirror the same interfaces and include the same parameters (as much as possible).
+
+```typescript
+interface SignalClient {
+  readonly url: string; // Origin of the service
+  type: "offer" | "answer" // Type of client
+  peerClient: RTCPeerConnection | PeerClient // Native WebRTC Wrapper/Interface
+  socket: Socket // The socket to the service
+
+  readonly authenticated: boolean; // State of authentication
+  readonly requestId?: string; // The current request being signaled
+
+  /**
+   * Generate a Request ID
+   */
+  generateRequestId(): any;
+
+  /**
+   * Top level Friendly interface for signaling
+   * @param args
+   */
+  peer(requestId: any, type: 'offer' | 'answer', config?: RTCConfiguration): Promise<void>;
+
+  /**
+   * Link a Request ID to this client
+   * @param args
+   */
+  link(...args: any[]): Promise<LinkMessage>;
+
+  /**
+   * Wait for a desciption signal
+   * @param args
+   */
+  signal(...args: any[]): Promise<string>;
+
+  /**
+   * Terminate the signaling session
+   */
+  close(): void
+
+
+  /**
+   * Listen to Interface events
+   * @param args
+   */
+  on(...args: any[]): void;
+
+  /**
+   * Emit an event to the interface
+   * @param channel
+   * @param callback
+   */
+  emit(channel: string, callback: (...args: any[])=>void)
+
+}
+```

clients/liquid-auth-client-js/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint/eslint-plugin",
+        "eslint-plugin-tsdoc"
+    ],
+    "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "warn"
+    }
+}

clients/liquid-auth-client-js/.gitignore

@@ -1,4 +1,5 @@
 lib
+docs
 
 # Logs
 logs

clients/liquid-auth-client-js/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

clients/liquid-auth-client-js/package.json

@@ -21,29 +21,43 @@
       "default": "./lib/connect.js",
       "types": "./lib/connect.d.ts"
     },
-    "./encoding": {
-      "default": "./lib/encoding.js",
-      "types": "./lib/encoding.d.ts"
+    "./signal": {
+      "default": "./lib/signal.js",
+      "types": "./lib/signal.d.ts"
+    },
+    "./errors": {
+      "default": "./lib/errors.js",
+      "types": "./lib/errors.d.ts"
     }
   },
   "scripts": {
     "dev": "tsc --watch",
     "build": "tsc",
-    "preinstall": "npm run build",
-    "test": "tsc && c8 node --test ./tests/*.test.js"
+    "build:docs": "typedoc --plugin typedoc-plugin-markdown --out docs src",
+    "lint": "eslint --fix src",
+    "test": "tsc && node --test ./tests/*.spec.js",
+    "test:cov": "tsc && c8 node --test ./tests/*.spec.js"
   },
   "author": "",
   "license": "MIT",
   "devDependencies": {
     "@types/qrcode": "^1.5.5",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^7.6.0",
+    "algosdk": "^2.7.0",
     "c8": "^9.1.0",
-    "typescript": "^5.3.3"
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.0-next.55",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
-    "qr-code-styling": "^1.6.0-rc.1"
-  },
-  "peerDependencies": {
-    "algosdk": "^2.7.0",
+    "@liquid/core": "^1.0.0",
+    "eventemitter3": "^5.0.1",
+    "qr-code-styling": "^1.6.0-rc.1",
     "tweetnacl": "^1.0.3"
   }
 }