@farcaster/frame-sdk 0.0.40 → 0.0.43

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { AddMiniApp, ComposeCast, Context, FrameNotificationDetails, GetCapabilities, Ready, SendToken, SetPrimaryButtonOptions, SignIn, SolanaWalletProvider, SwapToken, ViewProfile, ViewToken } from '@farcaster/frame-core';
+import type { AddMiniApp, ComposeCast, Context, FrameNotificationDetails, GetCapabilities, GetChains, 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 {
@@ -30,6 +30,7 @@ export type Emitter = Compute<EventEmitter<EventMap>>;
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>;
 export type FrameSDK = {
     getCapabilities: GetCapabilities;
+    getChains: GetChains;
     isInMiniApp: () => Promise<boolean>;
     context: Promise<Context.FrameContext>;
     actions: {
@@ -51,7 +52,7 @@ export type FrameSDK = {
     };
     wallet: {
         ethProvider: Provider.Provider;
-        getEvmProvider: () => Promise<Provider.Provider | undefined>;
+        getEthereumProvider: () => Promise<Provider.Provider | undefined>;
     };
 } & Emitter;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.40",
+  "version": "0.0.43",
   "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.36"
+    "@farcaster/frame-core": "0.0.38"
   },
   "scripts": {
     "clean": "rm -rf dist",

package/src/{evmProvider.ts → ethereumProvider.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 evmProvider: Provider.Provider = Provider.from({
+export const ethereumProvider: Provider.Provider = Provider.from({
   ...emitter,
   async request(args) {
     // @ts-expect-error
@@ -83,12 +84,25 @@ export const evmProvider: Provider.Provider = Provider.from({
   },
 })
 
-export async function getEvmProvider(): Promise<Provider.Provider | undefined> {
-  const capabilities = await frameHost.getCapabilities()
-  if (!capabilities.includes('wallet.getEvmProvider')) {
-    return undefined
+export async function getEthereumProvider(): Promise<
+  Provider.Provider | undefined
+> {
+  try {
+    const capabilities = await frameHost.getCapabilities()
+    if (
+      !capabilities.includes('wallet.getEthereumProvider') &&
+      !capabilities.includes('wallet.getEvmProvider' as MiniAppHostCapability)
+    ) {
+      // We used getEvmProvider for a short period before getEthereumProvider.
+      // In case we're talking to an old host, we check the old key.
+      return undefined
+    }
+    return ethereumProvider
+  } catch {
+    // If this is an old frame host that doesn't support getCapabilities,
+    // getEthereumProvider will assume that it's supported
+    return ethereumProvider
   }
-  return evmProvider
 }
 
 function announceEvmProvider(
@@ -128,7 +142,7 @@ if (typeof document !== 'undefined') {
       if (frameEvent.event === 'eip6963:announceProvider') {
         announceEvmProvider({
           info: frameEvent.info,
-          provider: evmProvider as EIP1193Provider,
+          provider: ethereumProvider as EIP1193Provider,
         })
       }
     }
@@ -160,7 +174,7 @@ if (typeof window !== 'undefined') {
         if (frameEvent.event === 'eip6963:announceProvider') {
           announceEvmProvider({
             info: frameEvent.info,
-            provider: evmProvider as EIP1193Provider,
+            provider: ethereumProvider as EIP1193Provider,
           })
         }
       }

package/src/sdk.ts

@@ -6,7 +6,7 @@ import {
   createSolanaWalletProvider,
 } from '@farcaster/frame-core'
 import { EventEmitter } from 'eventemitter3'
-import { evmProvider, getEvmProvider } from './evmProvider'
+import { ethereumProvider, getEthereumProvider } from './ethereumProvider'
 import { frameHost } from './frameHost'
 import { getSolanaProvider } from './solanaProvider'
 import type { Emitter, EventMap, FrameSDK } from './types'
@@ -98,6 +98,7 @@ const addMiniApp = async () => {
 export const sdk: FrameSDK = {
   ...emitter,
   getCapabilities: frameHost.getCapabilities,
+  getChains: frameHost.getChains,
   isInMiniApp,
   context: frameHost.context,
   actions: {
@@ -134,8 +135,8 @@ export const sdk: FrameSDK = {
     getSolanaProvider,
   },
   wallet: {
-    ethProvider: evmProvider,
-    getEvmProvider: getEvmProvider,
+    ethProvider: ethereumProvider,
+    getEthereumProvider,
   },
 }
 

package/src/solanaProvider.ts

@@ -1,4 +1,5 @@
 import {
+  type MiniAppHostCapability,
   type SolanaWalletProvider,
   type SolanaWireRequestFn,
   createSolanaWalletProvider,
@@ -19,8 +20,11 @@ if (solanaProviderRequest) {
 }
 
 async function getSolanaProvider(): Promise<SolanaWalletProvider | undefined> {
-  const capabilities = await frameHost.getCapabilities()
-  if (!capabilities.includes('wallet.getSolanaProvider')) {
+  let capabilities: MiniAppHostCapability[] | undefined
+  try {
+    capabilities = await frameHost.getCapabilities()
+  } catch {}
+  if (!capabilities?.includes('wallet.getSolanaProvider')) {
     return undefined
   }
   return solanaProvider

package/src/types.ts

@@ -4,6 +4,7 @@ import type {
   Context,
   FrameNotificationDetails,
   GetCapabilities,
+  GetChains,
   Ready,
   SendToken,
   SetPrimaryButtonOptions,
@@ -54,6 +55,7 @@ type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>
 
 export type FrameSDK = {
   getCapabilities: GetCapabilities
+  getChains: GetChains
   isInMiniApp: () => Promise<boolean>
   context: Promise<Context.FrameContext>
   actions: {
@@ -77,8 +79,8 @@ export type FrameSDK = {
     getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>
   }
   wallet: {
-    // Deprecated in favor of getEvmProvider
+    // Deprecated in favor of getEthereumProvider
     ethProvider: Provider.Provider
-    getEvmProvider: () => Promise<Provider.Provider | undefined>
+    getEthereumProvider: () => Promise<Provider.Provider | undefined>
   }
 } & Emitter

package/dist/evmProvider.d.ts

@@ -1,3 +0,0 @@
-import * as Provider from 'ox/Provider';
-export declare const evmProvider: Provider.Provider;
-export declare function getEvmProvider(): Promise<Provider.Provider | undefined>;