@farcaster/frame-sdk 0.0.44 → 0.0.46

package/dist/types.d.ts

@@ -49,6 +49,17 @@ export type FrameSDK = {
     };
     experimental: {
         getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>;
+        quickAuth: (options?: {
+            /**
+             * Use a custom Quick Auth server, otherwise defaults to the public
+             * instance provided by Farcaster.
+             *
+             * @default https://auth.farcaster.xyz
+             */
+            quickAuthServerOrigin?: string;
+        }) => Promise<{
+            token: string;
+        }>;
     };
     wallet: {
         ethProvider: Provider.Provider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.44",
+  "version": "0.0.46",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -16,13 +16,14 @@
     "esbuild": "^0.25.0",
     "mipd": "^0.0.7",
     "typescript": "^5.7.2",
-    "@farcaster/tsconfig": "0.0.2"
+    "@farcaster/tsconfig": "0.0.3"
   },
   "dependencies": {
+    "@farcaster/quick-auth": "^0.0.4",
     "comlink": "^4.4.2",
     "eventemitter3": "^5.0.1",
     "ox": "^0.4.4",
-    "@farcaster/frame-core": "0.0.39"
+    "@farcaster/frame-core": "0.0.40"
   },
   "scripts": {
     "clean": "rm -rf dist",

package/src/sdk.ts

@@ -2,10 +2,10 @@ import {
   AddMiniApp,
   type FrameClientEvent,
   SignIn,
-  type SolanaRequestFn,
-  createSolanaWalletProvider,
 } from '@farcaster/frame-core'
+import { createLightClient } from '@farcaster/quick-auth/light'
 import { EventEmitter } from 'eventemitter3'
+import * as Siwe from 'ox/Siwe'
 import { ethereumProvider, getEthereumProvider } from './ethereumProvider'
 import { frameHost } from './frameHost'
 import { getSolanaProvider } from './solanaProvider'
@@ -133,6 +133,38 @@ export const sdk: FrameSDK = {
   },
   experimental: {
     getSolanaProvider,
+    quickAuth: async (options = {}) => {
+      const quickAuth = createLightClient({
+        origin: options.quickAuthServerOrigin,
+      })
+
+      const { nonce } = await quickAuth.generateNonce()
+      const response = await frameHost.signIn({
+        nonce,
+      })
+
+      if (response.result) {
+        const parsedSiwe = Siwe.parseMessage(response.result.message)
+
+        // The Farcaster Client rendering the Mini App will set the domain
+        // based on the URL it's rendering. It should always be set.
+        if (!parsedSiwe.domain) {
+          throw new Error('Missing domain on SIWE message')
+        }
+
+        return await quickAuth.verifySiwf({
+          domain: parsedSiwe.domain,
+          message: response.result.message,
+          signature: response.result.signature,
+        })
+      }
+
+      if (response.error.type === 'rejected_by_user') {
+        throw new SignIn.RejectedByUser()
+      }
+
+      throw new Error('Unreachable')
+    },
   },
   wallet: {
     ethProvider: ethereumProvider,

package/src/types.ts

@@ -77,6 +77,17 @@ export type FrameSDK = {
   }
   experimental: {
     getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>
+    quickAuth: (options?: {
+      /**
+       * Use a custom Quick Auth server, otherwise defaults to the public
+       * instance provided by Farcaster.
+       *
+       * @default https://auth.farcaster.xyz
+       */
+      quickAuthServerOrigin?: string
+    }) => Promise<{
+      token: string
+    }>
   }
   wallet: {
     // Deprecated in favor of getEthereumProvider