@farcaster/frame-core 0.0.34 → 0.0.36

package/esm/types.d.ts

@@ -1,6 +1,7 @@
-import type { AddFrame, ComposeCast, Ready, SendToken, SignIn, SwapToken, ViewProfile, ViewToken } from './actions';
+import type { AddMiniApp, ComposeCast, Ready, SendToken, SignIn, SwapToken, ViewProfile, ViewToken } from './actions';
 import type { FrameContext } from './context';
 import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana';
 import type { Ethereum } from './wallet';
 export type SetPrimaryButtonOptions = {
     text: string;
@@ -12,6 +13,8 @@ export * from './wallet/ethereum';
 export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready';
 export type SignInOptions = SignIn.SignInOptions;
 export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
+export type MiniAppHostCapability = 'wallet.getEvmProvider' | 'wallet.getSolanaProvider' | 'actions.ready' | 'actions.openUrl' | 'actions.close' | 'actions.setPrimaryButton' | 'actions.addMiniApp' | 'actions.signIn' | 'actions.viewProfile' | 'actions.composeCast' | 'actions.viewToken' | 'actions.sendToken' | 'actions.swapToken';
+export type GetCapabilities = () => Promise<MiniAppHostCapability[]>;
 export type WireFrameHost = {
     context: FrameContext;
     close: () => void;
@@ -22,12 +25,14 @@ export type WireFrameHost = {
     ethProviderRequest: Ethereum.EthProvideRequest;
     ethProviderRequestV2: Ethereum.RpcTransport;
     eip6963RequestProvider: () => void;
-    addFrame: AddFrame.WireAddFrame;
+    solanaProviderRequest?: SolanaWireRequestFn;
+    addFrame: AddMiniApp.WireAddMiniApp;
     viewProfile: ViewProfile.ViewProfile;
     viewToken: ViewToken.ViewToken;
     sendToken: SendToken.SendToken;
     swapToken: SwapToken.SwapToken;
     composeCast: <close extends boolean | undefined = undefined>(options: ComposeCast.Options<close>) => Promise<ComposeCast.Result<close>>;
+    getCapabilities: GetCapabilities;
 };
 export type FrameHost = {
     context: FrameContext;
@@ -43,16 +48,18 @@ export type FrameHost = {
      * Hosts must emit an EventEip6963AnnounceProvider in response.
      */
     eip6963RequestProvider: () => void;
-    addFrame: AddFrame.AddFrame;
+    solanaProviderRequest?: SolanaRequestFn;
+    addFrame: AddMiniApp.AddMiniApp;
     viewProfile: ViewProfile.ViewProfile;
     viewToken: ViewToken.ViewToken;
     sendToken: SendToken.SendToken;
     swapToken: SwapToken.SwapToken;
     composeCast: <close extends boolean | undefined = undefined>(options: ComposeCast.Options<close>) => Promise<ComposeCast.Result<close>>;
+    getCapabilities: GetCapabilities;
 };
 export type EventFrameAddRejected = {
     event: 'frame_add_rejected';
-    reason: AddFrame.AddFrameRejectedReason;
+    reason: AddMiniApp.AddMiniAppRejectedReason;
 };
 export type EventPrimaryButtonClicked = {
     event: 'primary_button_clicked';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -21,6 +21,7 @@
     "@farcaster/tsconfig": "0.0.2"
   },
   "dependencies": {
+    "@solana/web3.js": "^1.98.2",
     "ox": "^0.4.4",
     "zod": "^3.24.1"
   },

package/src/actions/{AddFrame.ts → AddMiniApp.ts}

@@ -2,11 +2,11 @@ import * as Errors from '../errors'
 import type { OneOf } from '../internal/types'
 import type { FrameNotificationDetails } from '../schemas'
 
-export type AddFrameResult = {
+export type AddMiniAppResult = {
   notificationDetails?: FrameNotificationDetails
 }
 
-export type AddFrame = () => Promise<AddFrameResult>
+export type AddMiniApp = () => Promise<AddMiniAppResult>
 
 type InvalidDomainManifestJsonError = {
   type: 'invalid_domain_manifest'
@@ -16,23 +16,23 @@ type RejectedByUserJsonError = {
   type: 'rejected_by_user'
 }
 
-export type AddFrameJsonError =
+export type AddMiniAppJsonError =
   | InvalidDomainManifestJsonError
   | RejectedByUserJsonError
 
-export type AddFrameRejectedReason = AddFrameJsonError['type']
+export type AddMiniAppRejectedReason = AddMiniAppJsonError['type']
 
-export type AddFrameJsonResult = OneOf<
-  { result: AddFrameResult } | { error: AddFrameJsonError }
+export type AddMiniAppJsonResult = OneOf<
+  { result: AddMiniAppResult } | { error: AddMiniAppJsonError }
 >
 
-export type WireAddFrame = () => Promise<AddFrameJsonResult>
+export type WireAddMiniApp = () => Promise<AddMiniAppJsonResult>
 
 /**
  * Thrown when the frame does not have a valid domain manifest.
  */
 export class InvalidDomainManifest extends Errors.BaseError {
-  override readonly name = 'AddFrame.InvalidDomainManifest'
+  override readonly name = 'AddMiniApp.InvalidDomainManifest'
 
   constructor() {
     super('Invalid domain manifest')
@@ -43,7 +43,7 @@ export class InvalidDomainManifest extends Errors.BaseError {
  * Thrown when add frame action was rejected by the user.
  */
 export class RejectedByUser extends Errors.BaseError {
-  override readonly name = 'AddFrame.RejectedByUser'
+  override readonly name = 'AddMiniApp.RejectedByUser'
 
   constructor() {
     super('Add frame rejected by user')

package/src/actions/ComposeCast.ts

@@ -2,7 +2,7 @@ export type Options<close extends boolean | undefined = undefined> = {
   /**
    * Suggested text for the body of the cast.
    *
-   * Mentions can be included using the human-writeable form (e.g. @farcaster).
+   * Mentions can be included using the human-writable form (e.g. @farcaster).
    **/
   text?: string
 

package/src/actions/SignIn.ts

@@ -18,11 +18,27 @@ export type SignInOptions = {
    * ISO 8601 datetime.
    */
   expirationTime?: string
+
+  /**
+   * Whether an [Auth
+   * Address](https://github.com/farcasterxyz/protocol/discussions/225) signed
+   * message is acceptable. Defaults to `false` to maintain backwards
+   * compatibility, though applications should set this to `true` for the best
+   * user experience assuming their verification method supports it.
+   *
+   * @default false
+   */
+  acceptAuthAddress?: boolean
 }
 
 export type SignInResult = {
   signature: string
   message: string
+
+  /**
+   * Indicates if the signature was produced by a custody or auth address.
+   */
+  authMethod: 'custody' | 'authAddress'
 }
 
 export type SignIn = (options: SignInOptions) => Promise<SignInResult>

package/src/actions/SwapToken.ts

@@ -14,7 +14,7 @@ export type SwapTokenOptions = {
 
   /**
    * Sell token amount, as numeric string.
-   * For example, 10 USDC: 1000000
+   * For example, 1 USDC: 1000000
    */
   sellAmount?: string
 }

package/src/actions/index.ts

@@ -1,4 +1,4 @@
-export * as AddFrame from './AddFrame'
+export * as AddMiniApp from './AddMiniApp'
 export * as ComposeCast from './ComposeCast'
 export * as Ready from './Ready'
 export * as SignIn from './SignIn'

package/src/index.ts

@@ -5,3 +5,5 @@ export * as Context from './context'
 export * as Manifest from './manifest'
 export * from './types'
 export * from './schemas'
+export * from './solana'
+export * from './solanaWire'

package/src/solana.ts

@@ -0,0 +1,108 @@
+import {
+  Connection as SolanaConnection,
+  type SendOptions as SolanaSendOptions,
+  type Transaction as SolanaTransaction,
+  type VersionedTransaction as SolanaVersionedTransaction,
+} from '@solana/web3.js'
+
+export { SolanaConnection }
+export type { SolanaSendOptions }
+
+export type SolanaCombinedTransaction =
+  | SolanaTransaction
+  | SolanaVersionedTransaction
+
+export type SolanaConnectRequestArguments = {
+  method: 'connect'
+}
+export type SolanaSignMessageRequestArguments = {
+  method: 'signMessage'
+  params: {
+    message: string
+  }
+}
+export type SolanaSignAndSendTransactionRequestArguments = {
+  method: 'signAndSendTransaction'
+  params: {
+    transaction: SolanaCombinedTransaction
+    options?: SolanaSendOptions
+  }
+}
+export type SolanaSignTransactionRequestArguments<
+  T extends SolanaCombinedTransaction = SolanaTransaction,
+> = {
+  method: 'signTransaction'
+  params: {
+    transaction: T
+  }
+}
+
+export type SolanaRequestFn = ((
+  request: SolanaConnectRequestArguments,
+) => Promise<{ publicKey: string }>) &
+  ((request: SolanaSignMessageRequestArguments) => Promise<{
+    signature: string
+  }>) &
+  ((request: SolanaSignAndSendTransactionRequestArguments) => Promise<{
+    signature: string
+  }>) &
+  (<T extends SolanaCombinedTransaction>(
+    request: SolanaSignTransactionRequestArguments<T>,
+  ) => Promise<{ signedTransaction: T }>)
+
+export interface SolanaWalletProvider {
+  request: SolanaRequestFn
+
+  signMessage(message: string): Promise<{ signature: string }>
+  signTransaction<T extends SolanaCombinedTransaction>(
+    transaction: T,
+  ): Promise<{ signedTransaction: T }>
+  signAndSendTransaction(input: {
+    transaction: SolanaCombinedTransaction
+  }): Promise<{ signature: string }>
+}
+
+export const createSolanaWalletProvider = (
+  request: SolanaRequestFn,
+): SolanaWalletProvider => ({
+  request,
+  signMessage: (msg: string) =>
+    request({ method: 'signMessage', params: { message: msg } }),
+  signTransaction: <T extends SolanaCombinedTransaction>(transaction: T) =>
+    request({ method: 'signTransaction', params: { transaction } }),
+  signAndSendTransaction: (input: {
+    transaction: SolanaCombinedTransaction
+  }) =>
+    request({
+      method: 'signAndSendTransaction',
+      params: input,
+    }),
+})
+
+export type SolanaWireSignAndSendTransactionRequestArguments = {
+  method: 'signAndSendTransaction'
+  params: {
+    transaction: string
+    options?: SolanaSendOptions
+  }
+}
+
+export type SolanaWireSignTransactionRequestArguments = {
+  method: 'signTransaction'
+  params: {
+    transaction: string
+  }
+}
+
+export type SolanaWireRequestFn = ((
+  request: SolanaConnectRequestArguments,
+) => Promise<{ publicKey: string }>) &
+  ((request: SolanaSignMessageRequestArguments) => Promise<{
+    signature: string
+  }>) &
+  ((request: SolanaWireSignAndSendTransactionRequestArguments) => Promise<{
+    signature: string
+  }>) &
+  ((
+    request: SolanaWireSignTransactionRequestArguments,
+  ) => Promise<{ signedTransaction: string }>)

package/src/solanaWire.ts

@@ -0,0 +1,118 @@
+import {
+  Transaction as SolanaTransaction,
+  VersionedTransaction as SolanaVersionedTransaction,
+} from '@solana/web3.js'
+
+import type {
+  SolanaCombinedTransaction,
+  SolanaConnectRequestArguments,
+  SolanaRequestFn,
+  SolanaSignAndSendTransactionRequestArguments,
+  SolanaSignMessageRequestArguments,
+  SolanaSignTransactionRequestArguments,
+  SolanaWireRequestFn,
+  SolanaWireSignAndSendTransactionRequestArguments,
+  SolanaWireSignTransactionRequestArguments,
+} from './solana'
+
+function serializeTransaction(transaction: SolanaCombinedTransaction): string {
+  return Buffer.from(
+    transaction.serialize({
+      verifySignatures: false,
+    }),
+  ).toString('base64')
+}
+
+function unserializeTransaction(
+  transaction: string,
+): SolanaCombinedTransaction {
+  const bytes = Uint8Array.from(Buffer.from(transaction, 'base64'))
+  return (bytes[0] & 0x80) !== 0
+    ? SolanaVersionedTransaction.deserialize(bytes)
+    : SolanaTransaction.from(bytes)
+}
+
+export function wrapSolanaProviderRequest(
+  requestFn: SolanaRequestFn,
+): SolanaWireRequestFn {
+  const wrappedFn = async (
+    request:
+      | SolanaConnectRequestArguments
+      | SolanaSignMessageRequestArguments
+      | SolanaWireSignAndSendTransactionRequestArguments
+      | SolanaWireSignTransactionRequestArguments,
+  ) => {
+    if (request.method === 'connect') {
+      return await requestFn(request)
+    }
+    if (request.method === 'signMessage') {
+      return await requestFn(request)
+    }
+    if (request.method === 'signAndSendTransaction') {
+      const { transaction, options } = request.params
+      const params = {
+        transaction: unserializeTransaction(transaction),
+        options,
+      }
+      return await requestFn({
+        method: 'signAndSendTransaction',
+        params,
+      })
+    }
+    if (request.method === 'signTransaction') {
+      const { transaction } = request.params
+      const params = {
+        transaction: unserializeTransaction(transaction),
+      }
+      const { signedTransaction } = await requestFn({
+        method: 'signTransaction',
+        params,
+      })
+      return {
+        signedTransaction: serializeTransaction(signedTransaction),
+      }
+    }
+  }
+  return wrappedFn as SolanaWireRequestFn
+}
+
+export function unwrapSolanaProviderRequest(
+  wrappedRequestFn: SolanaWireRequestFn,
+): SolanaRequestFn {
+  const unwrappedFn = async <T extends SolanaCombinedTransaction>(
+    request:
+      | SolanaConnectRequestArguments
+      | SolanaSignMessageRequestArguments
+      | SolanaSignAndSendTransactionRequestArguments
+      | SolanaSignTransactionRequestArguments<T>,
+  ) => {
+    if (request.method === 'connect') {
+      return await wrappedRequestFn(request)
+    }
+    if (request.method === 'signMessage') {
+      return await wrappedRequestFn(request)
+    }
+    if (request.method === 'signAndSendTransaction') {
+      const { transaction, options } = request.params
+      const params = {
+        transaction: serializeTransaction(transaction),
+      }
+      return await wrappedRequestFn({
+        method: 'signAndSendTransaction',
+        params,
+      })
+    }
+    if (request.method === 'signTransaction') {
+      const { transaction } = request.params
+      const params = {
+        transaction: serializeTransaction(transaction),
+      }
+      const { signedTransaction } = await wrappedRequestFn({
+        method: 'signTransaction',
+        params,
+      })
+      return { signedTransaction: unserializeTransaction(signedTransaction) }
+    }
+  }
+  return unwrappedFn as SolanaRequestFn
+}

package/src/types.ts

@@ -1,5 +1,5 @@
 import type {
-  AddFrame,
+  AddMiniApp,
   ComposeCast,
   Ready,
   SendToken,
@@ -15,6 +15,7 @@ import type {
   EventNotificationsDisabled,
   EventNotificationsEnabled,
 } from './schemas'
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana'
 import type { Ethereum } from './wallet'
 
 export type SetPrimaryButtonOptions = {
@@ -32,6 +33,23 @@ export type SignInOptions = SignIn.SignInOptions
 
 export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
 
+export type MiniAppHostCapability =
+  | 'wallet.getEvmProvider'
+  | 'wallet.getSolanaProvider'
+  | 'actions.ready'
+  | 'actions.openUrl'
+  | 'actions.close'
+  | 'actions.setPrimaryButton'
+  | 'actions.addMiniApp'
+  | 'actions.signIn'
+  | 'actions.viewProfile'
+  | 'actions.composeCast'
+  | 'actions.viewToken'
+  | 'actions.sendToken'
+  | 'actions.swapToken'
+
+export type GetCapabilities = () => Promise<MiniAppHostCapability[]>
+
 export type WireFrameHost = {
   context: FrameContext
   close: () => void
@@ -42,7 +60,8 @@ export type WireFrameHost = {
   ethProviderRequest: Ethereum.EthProvideRequest
   ethProviderRequestV2: Ethereum.RpcTransport
   eip6963RequestProvider: () => void
-  addFrame: AddFrame.WireAddFrame
+  solanaProviderRequest?: SolanaWireRequestFn
+  addFrame: AddMiniApp.WireAddMiniApp
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
   sendToken: SendToken.SendToken
@@ -50,6 +69,7 @@ export type WireFrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
+  getCapabilities: GetCapabilities
 }
 
 export type FrameHost = {
@@ -66,7 +86,8 @@ export type FrameHost = {
    * Hosts must emit an EventEip6963AnnounceProvider in response.
    */
   eip6963RequestProvider: () => void
-  addFrame: AddFrame.AddFrame
+  solanaProviderRequest?: SolanaRequestFn
+  addFrame: AddMiniApp.AddMiniApp
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
   sendToken: SendToken.SendToken
@@ -74,11 +95,12 @@ export type FrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
+  getCapabilities: GetCapabilities
 }
 
 export type EventFrameAddRejected = {
   event: 'frame_add_rejected'
-  reason: AddFrame.AddFrameRejectedReason
+  reason: AddMiniApp.AddMiniAppRejectedReason
 }
 
 export type EventPrimaryButtonClicked = {