@farcaster/frame-core 0.0.35 → 0.0.38

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/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

@@ -6,3 +6,4 @@ export * as Manifest from './manifest'
 export * from './types'
 export * from './schemas'
 export * from './solana'
+export * from './solanaWire'

package/src/solana.ts

@@ -1,11 +1,12 @@
-import type {
+import {
   Connection as SolanaConnection,
-  SendOptions as SolanaSendOptions,
-  Transaction as SolanaTransaction,
-  VersionedTransaction as SolanaVersionedTransaction,
+  type SendOptions as SolanaSendOptions,
+  type Transaction as SolanaTransaction,
+  type VersionedTransaction as SolanaVersionedTransaction,
 } from '@solana/web3.js'
 
-export type { SolanaConnection }
+export { SolanaConnection }
+export type { SolanaSendOptions }
 
 export type SolanaCombinedTransaction =
   | SolanaTransaction
@@ -24,7 +25,6 @@ export type SolanaSignAndSendTransactionRequestArguments = {
   method: 'signAndSendTransaction'
   params: {
     transaction: SolanaCombinedTransaction
-    connection: SolanaConnection
     options?: SolanaSendOptions
   }
 }
@@ -59,7 +59,6 @@ export interface SolanaWalletProvider {
   ): Promise<{ signedTransaction: T }>
   signAndSendTransaction(input: {
     transaction: SolanaCombinedTransaction
-    connection: SolanaConnection
   }): Promise<{ signature: string }>
 }
 
@@ -73,10 +72,37 @@ export const createSolanaWalletProvider = (
     request({ method: 'signTransaction', params: { transaction } }),
   signAndSendTransaction: (input: {
     transaction: SolanaCombinedTransaction
-    connection: SolanaConnection
   }) =>
     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,7 +15,7 @@ import type {
   EventNotificationsDisabled,
   EventNotificationsEnabled,
 } from './schemas'
-import type { SolanaRequestFn } from './solana'
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana'
 import type { Ethereum } from './wallet'
 
 export type SetPrimaryButtonOptions = {
@@ -33,6 +33,26 @@ export type SignInOptions = SignIn.SignInOptions
 
 export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
 
+export type MiniAppHostCapability =
+  | 'wallet.getEthereumProvider'
+  | '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[]>
+
+// Returns a list of CAIP-2 identifiers
+export type GetChains = () => Promise<string[]>
+
 export type WireFrameHost = {
   context: FrameContext
   close: () => void
@@ -43,8 +63,8 @@ export type WireFrameHost = {
   ethProviderRequest: Ethereum.EthProvideRequest
   ethProviderRequestV2: Ethereum.RpcTransport
   eip6963RequestProvider: () => void
-  solanaProviderRequest?: SolanaRequestFn
-  addFrame: AddFrame.WireAddFrame
+  solanaProviderRequest?: SolanaWireRequestFn
+  addFrame: AddMiniApp.WireAddMiniApp
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
   sendToken: SendToken.SendToken
@@ -52,6 +72,8 @@ export type WireFrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
+  getCapabilities: GetCapabilities
+  getChains: GetChains
 }
 
 export type FrameHost = {
@@ -69,7 +91,7 @@ export type FrameHost = {
    */
   eip6963RequestProvider: () => void
   solanaProviderRequest?: SolanaRequestFn
-  addFrame: AddFrame.AddFrame
+  addFrame: AddMiniApp.AddMiniApp
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
   sendToken: SendToken.SendToken
@@ -77,11 +99,13 @@ export type FrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
+  getCapabilities: GetCapabilities
+  getChains: GetChains
 }
 
 export type EventFrameAddRejected = {
   event: 'frame_add_rejected'
-  reason: AddFrame.AddFrameRejectedReason
+  reason: AddMiniApp.AddMiniAppRejectedReason
 }
 
 export type EventPrimaryButtonClicked = {