@farcaster/frame-sdk 0.0.58 → 0.0.59

package/dist/types.d.ts

@@ -30,6 +30,17 @@ 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;
@@ -50,20 +61,14 @@ export type FrameSDK = {
         viewToken: ViewToken.ViewToken;
         sendToken: SendToken.SendToken;
         swapToken: SwapToken.SwapToken;
+        quickAuth: QuickAuth;
     };
     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;
-        }>;
+        /**
+         * @deprecated - use `sdk.actions.quickAuth`
+         */
+        quickAuth: QuickAuth;
     };
     wallet: {
         ethProvider: Provider.Provider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/sdk.ts

@@ -55,6 +55,40 @@ 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) {
@@ -111,42 +145,11 @@ export const sdk: FrameSDK = {
     viewToken: frameHost.viewToken.bind(frameHost),
     sendToken: frameHost.sendToken.bind(frameHost),
     swapToken: frameHost.swapToken.bind(frameHost),
+    quickAuth,
   },
   experimental: {
     getSolanaProvider,
-    quickAuth: async (options = {}) => {
-      const quickAuth = createLightClient({
-        origin: options.quickAuthServerOrigin,
-      })
-
-      const { nonce } = await quickAuth.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 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')
-    },
+    quickAuth,
   },
   wallet: {
     ethProvider: ethereumProvider,

package/src/types.ts

@@ -58,6 +58,17 @@ 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
@@ -82,20 +93,15 @@ export type FrameSDK = {
     viewToken: ViewToken.ViewToken
     sendToken: SendToken.SendToken
     swapToken: SwapToken.SwapToken
+    quickAuth: QuickAuth
   }
   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
-    }>
+
+    /**
+     * @deprecated - use `sdk.actions.quickAuth`
+     */
+    quickAuth: QuickAuth
   }
   wallet: {
     // Deprecated in favor of getEthereumProvider