@farcaster/frame-sdk 0.0.39 → 0.0.41

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { AddFrame, ComposeCast, Context, FrameNotificationDetails, Ready, SendToken, SetPrimaryButtonOptions, SignIn, SolanaWalletProvider, SwapToken, ViewProfile, ViewToken } from '@farcaster/frame-core';
+import type { AddMiniApp, ComposeCast, Context, FrameNotificationDetails, GetCapabilities, Ready, SendToken, SetPrimaryButtonOptions, SignIn, SolanaWalletProvider, SwapToken, ViewProfile, ViewToken } from '@farcaster/frame-core';
 import type { EventEmitter } from 'eventemitter3';
 import type * as Provider from 'ox/Provider';
 declare global {
@@ -18,7 +18,7 @@ export type EventMap = {
         notificationDetails?: FrameNotificationDetails;
     }) => void;
     frameAddRejected: ({ reason, }: {
-        reason: AddFrame.AddFrameRejectedReason;
+        reason: AddMiniApp.AddMiniAppRejectedReason;
     }) => void;
     frameRemoved: () => void;
     notificationsEnabled: ({ notificationDetails, }: {
@@ -29,6 +29,7 @@ export type EventMap = {
 export type Emitter = Compute<EventEmitter<EventMap>>;
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>;
 export type FrameSDK = {
+    getCapabilities: GetCapabilities;
     isInMiniApp: () => Promise<boolean>;
     context: Promise<Context.FrameContext>;
     actions: {
@@ -36,19 +37,21 @@ export type FrameSDK = {
         openUrl: (url: string) => Promise<void>;
         close: () => Promise<void>;
         setPrimaryButton: SetPrimaryButton;
-        addFrame: AddFrame.AddFrame;
+        addFrame: AddMiniApp.AddMiniApp;
+        addMiniApp: AddMiniApp.AddMiniApp;
         signIn: SignIn.SignIn;
         viewProfile: ViewProfile.ViewProfile;
         composeCast: <close extends boolean | undefined = undefined>(options?: ComposeCast.Options<close>) => Promise<ComposeCast.Result<close>>;
-    };
-    experimental: {
         viewToken: ViewToken.ViewToken;
         sendToken: SendToken.SendToken;
         swapToken: SwapToken.SwapToken;
-        solanaProvider?: SolanaWalletProvider;
+    };
+    experimental: {
+        getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>;
     };
     wallet: {
         ethProvider: Provider.Provider;
+        getEvmProvider: () => Promise<Provider.Provider | undefined>;
     };
 } & Emitter;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
     "comlink": "^4.4.2",
     "eventemitter3": "^5.0.1",
     "ox": "^0.4.4",
-    "@farcaster/frame-core": "0.0.35"
+    "@farcaster/frame-core": "0.0.36"
   },
   "scripts": {
     "clean": "rm -rf dist",

package/src/{provider.ts → evmProvider.ts}

@@ -1,6 +1,7 @@
 import type {
   EthProviderWireEvent,
   FrameClientEvent,
+  MiniAppHostCapability,
 } from '@farcaster/frame-core'
 import type {
   AnnounceProviderParameters,
@@ -44,7 +45,7 @@ function toProviderRpcError({
   }
 }
 
-export const provider: Provider.Provider = Provider.from({
+export const evmProvider: Provider.Provider = Provider.from({
   ...emitter,
   async request(args) {
     // @ts-expect-error
@@ -83,7 +84,21 @@ export const provider: Provider.Provider = Provider.from({
   },
 })
 
-function announceProvider(
+export async function getEvmProvider(): Promise<Provider.Provider | undefined> {
+  try {
+    const capabilities = await frameHost.getCapabilities()
+    if (!capabilities.includes('wallet.getEvmProvider')) {
+      return undefined
+    }
+    return evmProvider
+  } catch {
+    // If this is an old frame host that doesn't support getCapabilities,
+    // getEvmProvider will assume that it's supported
+    return evmProvider
+  }
+}
+
+function announceEvmProvider(
   detail: AnnounceProviderParameters,
 ): AnnounceProviderReturnType {
   const event: CustomEvent<EIP6963ProviderDetail> = new CustomEvent(
@@ -118,9 +133,9 @@ if (typeof document !== 'undefined') {
     if (event instanceof MessageEvent) {
       const frameEvent = event.data as FrameClientEvent
       if (frameEvent.event === 'eip6963:announceProvider') {
-        announceProvider({
+        announceEvmProvider({
           info: frameEvent.info,
-          provider: provider as EIP1193Provider,
+          provider: evmProvider as EIP1193Provider,
         })
       }
     }
@@ -150,9 +165,9 @@ if (typeof window !== 'undefined') {
       if (event.data.type === 'frameEvent') {
         const frameEvent = event.data.event as FrameClientEvent
         if (frameEvent.event === 'eip6963:announceProvider') {
-          announceProvider({
+          announceEvmProvider({
             info: frameEvent.info,
-            provider: provider as EIP1193Provider,
+            provider: evmProvider as EIP1193Provider,
           })
         }
       }

package/src/sdk.ts

@@ -1,13 +1,14 @@
 import {
-  AddFrame,
+  AddMiniApp,
   type FrameClientEvent,
   SignIn,
   type SolanaRequestFn,
   createSolanaWalletProvider,
 } from '@farcaster/frame-core'
 import { EventEmitter } from 'eventemitter3'
+import { evmProvider, getEvmProvider } from './evmProvider'
 import { frameHost } from './frameHost'
-import { provider } from './provider'
+import { getSolanaProvider } from './solanaProvider'
 import type { Emitter, EventMap, FrameSDK } from './types'
 
 export function createEmitter(): Emitter {
@@ -77,8 +78,26 @@ async function isInMiniApp(timeoutMs = 50): Promise<boolean> {
   return isInMiniApp
 }
 
+const addMiniApp = async () => {
+  const response = await frameHost.addFrame()
+  if (response.result) {
+    return response.result
+  }
+
+  if (response.error.type === 'invalid_domain_manifest') {
+    throw new AddMiniApp.InvalidDomainManifest()
+  }
+
+  if (response.error.type === 'rejected_by_user') {
+    throw new AddMiniApp.RejectedByUser()
+  }
+
+  throw new Error('Unreachable')
+}
+
 export const sdk: FrameSDK = {
   ...emitter,
+  getCapabilities: frameHost.getCapabilities,
   isInMiniApp,
   context: frameHost.context,
   actions: {
@@ -102,38 +121,21 @@ export const sdk: FrameSDK = {
       const url = typeof urlArg === 'string' ? urlArg : urlArg.url
       return frameHost.openUrl(url.trim())
     },
-    addFrame: async () => {
-      const response = await frameHost.addFrame()
-      if (response.result) {
-        return response.result
-      }
-
-      if (response.error.type === 'invalid_domain_manifest') {
-        throw new AddFrame.InvalidDomainManifest()
-      }
-
-      if (response.error.type === 'rejected_by_user') {
-        throw new AddFrame.RejectedByUser()
-      }
-
-      throw new Error('Unreachable')
-    },
+    addFrame: addMiniApp,
+    addMiniApp,
     composeCast(options = {}) {
       return frameHost.composeCast(options) as never
     },
-  },
-  experimental: {
     viewToken: frameHost.viewToken.bind(frameHost),
     sendToken: frameHost.sendToken.bind(frameHost),
     swapToken: frameHost.swapToken.bind(frameHost),
-    solanaProvider: frameHost.solanaProviderRequest
-      ? createSolanaWalletProvider(
-          frameHost.solanaProviderRequest as unknown as SolanaRequestFn,
-        )
-      : undefined,
+  },
+  experimental: {
+    getSolanaProvider,
   },
   wallet: {
-    ethProvider: provider,
+    ethProvider: evmProvider,
+    getEvmProvider: getEvmProvider,
   },
 }
 

package/src/solanaProvider.ts

@@ -0,0 +1,33 @@
+import {
+  type MiniAppHostCapability,
+  type SolanaWalletProvider,
+  type SolanaWireRequestFn,
+  createSolanaWalletProvider,
+  unwrapSolanaProviderRequest,
+} from '@farcaster/frame-core'
+
+import { frameHost } from './frameHost'
+
+const { solanaProviderRequest } = frameHost
+
+let solanaProvider: SolanaWalletProvider | undefined
+if (solanaProviderRequest) {
+  solanaProvider = createSolanaWalletProvider(
+    unwrapSolanaProviderRequest(
+      solanaProviderRequest as unknown as SolanaWireRequestFn,
+    ),
+  )
+}
+
+async function getSolanaProvider(): Promise<SolanaWalletProvider | undefined> {
+  let capabilities: MiniAppHostCapability[] | undefined
+  try {
+    capabilities = await frameHost.getCapabilities()
+  } catch {}
+  if (!capabilities?.includes('wallet.getSolanaProvider')) {
+    return undefined
+  }
+  return solanaProvider
+}
+
+export { getSolanaProvider }

package/src/types.ts

@@ -1,8 +1,9 @@
 import type {
-  AddFrame,
+  AddMiniApp,
   ComposeCast,
   Context,
   FrameNotificationDetails,
+  GetCapabilities,
   Ready,
   SendToken,
   SetPrimaryButtonOptions,
@@ -37,7 +38,7 @@ export type EventMap = {
   }) => void
   frameAddRejected: ({
     reason,
-  }: { reason: AddFrame.AddFrameRejectedReason }) => void
+  }: { reason: AddMiniApp.AddMiniAppRejectedReason }) => void
   frameRemoved: () => void
   notificationsEnabled: ({
     notificationDetails,
@@ -52,6 +53,7 @@ export type Emitter = Compute<EventEmitter<EventMap>>
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>
 
 export type FrameSDK = {
+  getCapabilities: GetCapabilities
   isInMiniApp: () => Promise<boolean>
   context: Promise<Context.FrameContext>
   actions: {
@@ -59,20 +61,24 @@ export type FrameSDK = {
     openUrl: (url: string) => Promise<void>
     close: () => Promise<void>
     setPrimaryButton: SetPrimaryButton
-    addFrame: AddFrame.AddFrame
+    // Deprecated in favor of addMiniApp
+    addFrame: AddMiniApp.AddMiniApp
+    addMiniApp: AddMiniApp.AddMiniApp
     signIn: SignIn.SignIn
     viewProfile: ViewProfile.ViewProfile
     composeCast: <close extends boolean | undefined = undefined>(
       options?: ComposeCast.Options<close>,
     ) => Promise<ComposeCast.Result<close>>
-  }
-  experimental: {
     viewToken: ViewToken.ViewToken
     sendToken: SendToken.SendToken
     swapToken: SwapToken.SwapToken
-    solanaProvider?: SolanaWalletProvider
+  }
+  experimental: {
+    getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>
   }
   wallet: {
+    // Deprecated in favor of getEvmProvider
     ethProvider: Provider.Provider
+    getEvmProvider: () => Promise<Provider.Provider | undefined>
   }
 } & Emitter

package/dist/provider.d.ts

@@ -1,2 +0,0 @@
-import * as Provider from 'ox/Provider';
-export declare const provider: Provider.Provider;