@farcaster/frame-sdk 0.0.60 → 0.0.63

package/dist/types.d.ts

@@ -2,6 +2,7 @@ import type { AddMiniApp, ComposeCast, Context, FrameNotificationDetails, GetCap
 import type { EventEmitter } from 'eventemitter3';
 import type * as Provider from 'ox/Provider';
 import type { Back } from './back.ts';
+import type { QuickAuth } from './quickAuth.ts';
 declare global {
     interface Window {
         ReactNativeWebView: {
@@ -30,23 +31,13 @@ export type EventMap = {
 };
 export type Emitter = Compute<EventEmitter<EventMap>>;
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>;
-type 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;
-}>;
 export type FrameSDK = {
     getCapabilities: GetCapabilities;
     getChains: GetChains;
     isInMiniApp: () => Promise<boolean>;
     context: Promise<Context.FrameContext>;
     back: Back;
+    quickAuth: QuickAuth;
     actions: {
         ready: (options?: Partial<Ready.ReadyOptions>) => Promise<void>;
         openUrl: (url: string) => Promise<void>;
@@ -61,14 +52,13 @@ export type FrameSDK = {
         viewToken: ViewToken.ViewToken;
         sendToken: SendToken.SendToken;
         swapToken: SwapToken.SwapToken;
-        quickAuth: QuickAuth;
     };
     experimental: {
         getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>;
         /**
-         * @deprecated - use `sdk.actions.quickAuth`
+         * @deprecated - use `sdk.quickAuth.getToken`
          */
-        quickAuth: QuickAuth;
+        quickAuth: QuickAuth['getToken'];
     };
     wallet: {
         ethProvider: Provider.Provider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.60",
+  "version": "0.0.63",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -19,11 +19,11 @@
     "@farcaster/tsconfig": "0.0.5"
   },
   "dependencies": {
-    "@farcaster/quick-auth": "^0.0.5",
+    "@farcaster/quick-auth": "^0.0.6",
     "comlink": "^4.4.2",
     "eventemitter3": "^5.0.1",
     "ox": "^0.4.4",
-    "@farcaster/frame-core": "0.1.8"
+    "@farcaster/frame-core": "0.1.10"
   },
   "scripts": {
     "clean": "rm -rf dist",

package/src/index.ts

@@ -4,4 +4,8 @@ export * from './frameHost.ts'
 export * from './sdk.ts'
 export * from '@farcaster/frame-core'
 
+export * as QuickAuth from './quickAuth.ts'
+
+export { quickAuth } from './quickAuth.ts'
+
 export default sdk

package/src/quickAuth.ts

@@ -0,0 +1,148 @@
+import { SignIn } from '@farcaster/frame-core'
+import type { JWTPayload } from '@farcaster/quick-auth'
+import { decodeJwt } from '@farcaster/quick-auth/decodeJwt'
+import { createLightClient } from '@farcaster/quick-auth/light'
+import * as Siwe from 'ox/Siwe'
+
+import { frameHost } from './frameHost.js'
+
+export declare namespace getToken {
+  type Options = {
+    /**
+     * Use a custom Quick Auth server, otherwise defaults to the public
+     * instance provided by Farcaster.
+     *
+     * @default https://auth.farcaster.xyz
+     */
+    quickAuthServerOrigin?: string
+
+    /**
+     * Acquire a new token even if one is already in memory and not expired.
+     *
+     * @default false
+     */
+    force?: string
+  }
+
+  type ReturnValue = { token: string }
+  type ReturnType = Promise<ReturnValue>
+
+  type ErrorType = SignIn.RejectedByUser | Error
+}
+
+export type QuickAuth = {
+  /**
+   * Returns the session token if one is present and not expired.
+   */
+  readonly token: string | undefined
+
+  /**
+   * Get a Quick Auth JWT.
+   *
+   * If a token is already in memory and not expired it will be returned unless
+   * `force` is used. Otherwise a new token will be acquired.
+   */
+  getToken: (options?: getToken.Options) => getToken.ReturnType
+
+  /**
+   * Make an authenticated fetch request. The `Authorization` header will
+   * contain `Bearer ${token}` where token is a Quick Auth session token.
+   */
+  fetch: typeof fetch
+}
+
+export const quickAuth: QuickAuth = (() => {
+  let current:
+    | {
+        token: string
+        payload: JWTPayload
+      }
+    | undefined
+  let pendingPromise: Promise<getToken.ReturnValue> | undefined = undefined
+
+  async function getTokenInner(options: getToken.Options): getToken.ReturnType {
+    const quickAuthClient = createLightClient({
+      origin: options.quickAuthServerOrigin,
+    })
+
+    const { nonce } = await quickAuthClient.generateNonce()
+    const response = await frameHost.signIn({
+      nonce,
+      acceptAuthAddress: true,
+    })
+
+    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')
+      }
+
+      const verifyResult = await quickAuthClient.verifySiwf({
+        domain: parsedSiwe.domain,
+        message: response.result.message,
+        signature: response.result.signature,
+      })
+
+      current = {
+        token: verifyResult.token,
+        payload: decodeJwt(verifyResult.token),
+      }
+
+      return verifyResult
+    }
+
+    if (response.error.type === 'rejected_by_user') {
+      throw new SignIn.RejectedByUser()
+    }
+
+    throw new Error('Unreachable')
+  }
+
+  return {
+    get token() {
+      if (
+        current &&
+        new Date(current.payload.exp * 1000) > new Date(Date.now() + 15000)
+      ) {
+        return current.token
+      }
+
+      return undefined
+    },
+    async getToken(options = {}) {
+      const force = options.force ?? false
+
+      if (
+        current &&
+        !force &&
+        new Date(current.payload.exp * 1000) > new Date(Date.now() + 15000)
+      ) {
+        return { token: current.token }
+      }
+
+      if (!pendingPromise) {
+        pendingPromise = getTokenInner(options)
+      }
+
+      pendingPromise.finally(() => {
+        pendingPromise = undefined
+      })
+
+      return pendingPromise
+    },
+    async fetch(url, options) {
+      const { token } = await this.getToken()
+
+      const headers = new Headers(options?.headers)
+      headers.set('Authorization', `Bearer ${token}`)
+
+      return fetch(url, {
+        ...options,
+        headers,
+      })
+    },
+  }
+})()

package/src/sdk.ts

@@ -3,11 +3,10 @@ import {
   type FrameClientEvent,
   SignIn,
 } from '@farcaster/frame-core'
-import { createLightClient } from '@farcaster/quick-auth/light'
-import * as Siwe from 'ox/Siwe'
 import { createBack } from './back.ts'
 import { ethereumProvider, getEthereumProvider } from './ethereumProvider.ts'
 import { frameHost } from './frameHost.ts'
+import { quickAuth } from './quickAuth.ts'
 import { emitter } from './sdkEmitter.ts'
 import { getSolanaProvider } from './solanaProvider.ts'
 import type { FrameSDK } from './types.ts'
@@ -55,40 +54,6 @@ async function isInMiniApp(timeoutMs = 50): Promise<boolean> {
   return isInMiniApp
 }
 
-const quickAuth: FrameSDK['actions']['quickAuth'] = async (options = {}) => {
-  const quickAuthClient = createLightClient({
-    origin: options.quickAuthServerOrigin,
-  })
-
-  const { nonce } = await quickAuthClient.generateNonce()
-  const response = await frameHost.signIn({
-    nonce,
-    acceptAuthAddress: true,
-  })
-
-  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 quickAuthClient.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')
-}
-
 const addMiniApp = async () => {
   const response = await frameHost.addFrame()
   if (response.result) {
@@ -113,6 +78,7 @@ export const sdk: FrameSDK = {
   isInMiniApp,
   context: frameHost.context,
   back: createBack({ frameHost, emitter }),
+  quickAuth,
   actions: {
     setPrimaryButton: frameHost.setPrimaryButton.bind(frameHost),
     ready: async (options = {}) => {
@@ -145,11 +111,12 @@ export const sdk: FrameSDK = {
     viewToken: frameHost.viewToken.bind(frameHost),
     sendToken: frameHost.sendToken.bind(frameHost),
     swapToken: frameHost.swapToken.bind(frameHost),
-    quickAuth,
   },
   experimental: {
     getSolanaProvider,
-    quickAuth,
+    quickAuth(options) {
+      return quickAuth.getToken(options)
+    },
   },
   wallet: {
     ethProvider: ethereumProvider,

package/src/types.ts

@@ -21,6 +21,7 @@ import type {
 import type { EventEmitter } from 'eventemitter3'
 import type * as Provider from 'ox/Provider'
 import type { Back } from './back.ts'
+import type { QuickAuth } from './quickAuth.ts'
 
 declare global {
   interface Window {
@@ -58,17 +59,6 @@ export type EventMap = {
 export type Emitter = Compute<EventEmitter<EventMap>>
 
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>
-type 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
-}>
 
 export type FrameSDK = {
   getCapabilities: GetCapabilities
@@ -76,6 +66,7 @@ export type FrameSDK = {
   isInMiniApp: () => Promise<boolean>
   context: Promise<Context.FrameContext>
   back: Back
+  quickAuth: QuickAuth
   actions: {
     ready: (options?: Partial<Ready.ReadyOptions>) => Promise<void>
     openUrl: (url: string) => Promise<void>
@@ -93,15 +84,14 @@ export type FrameSDK = {
     viewToken: ViewToken.ViewToken
     sendToken: SendToken.SendToken
     swapToken: SwapToken.SwapToken
-    quickAuth: QuickAuth
   }
   experimental: {
     getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>
 
     /**
-     * @deprecated - use `sdk.actions.quickAuth`
+     * @deprecated - use `sdk.quickAuth.getToken`
      */
-    quickAuth: QuickAuth
+    quickAuth: QuickAuth['getToken']
   }
   wallet: {
     // Deprecated in favor of getEthereumProvider