@farcaster/frame-core 0.1.10 → 0.3.0

package/src/schemas/manifest.ts

@@ -1,122 +0,0 @@
-import { z } from 'zod'
-import { miniAppHostCapabilityList } from '../types.ts'
-import {
-  buttonTitleSchema,
-  createSimpleStringSchema,
-  encodedJsonFarcasterSignatureSchema,
-  frameNameSchema,
-  hexColorSchema,
-  secureUrlSchema,
-} from './shared.ts'
-
-const primaryCategorySchema = z.enum([
-  'games',
-  'social',
-  'finance',
-  'utility',
-  'productivity',
-  'health-fitness',
-  'news-media',
-  'music',
-  'shopping',
-  'education',
-  'developer-tools',
-  'entertainment',
-  'art-creativity',
-])
-
-const chainList = [
-  'eip155:1', // Ethereum mainnet
-  'eip155:8453', // Base mainnet
-  'eip155:42161', // Arbitrum One
-  'eip155:421614', // Arbitrum Sepolia
-  'eip155:84532', // Base Sepolia
-  'eip155:666666666', // Degen
-  'eip155:100', // Gnosis
-  'eip155:10', // Optimism
-  'eip155:11155420', // Optimism Sepolia
-  'eip155:137', // Polygon
-  'eip155:11155111', // Ethereum Sepolia
-  'eip155:7777777', // Zora
-  'eip155:130', // Unichain
-  'eip155:10143', // Monad testnet
-  'eip155:42220', // Celo
-  'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', // Solana
-] as const
-
-function removeArrayDuplicates<T>(arr: T[]) {
-  const set = new Set(arr)
-  return Array.from(set)
-}
-
-export const domainFrameConfigSchema = z
-  .object({
-    // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
-    // backwards compatibility. next should always resolve to the most recent
-    // schema version.
-    version: z.union([
-      z.literal('0.0.0'),
-      z.literal('0.0.1'),
-      z.literal('1'),
-      z.literal('next'),
-    ]),
-    name: frameNameSchema,
-    iconUrl: secureUrlSchema,
-    homeUrl: secureUrlSchema,
-    /** deprecated, set ogImageUrl instead */
-    imageUrl: secureUrlSchema.optional(),
-    /** deprecated, will rely on fc:frame meta tag */
-    buttonTitle: buttonTitleSchema.optional(),
-    splashImageUrl: secureUrlSchema.optional(),
-    splashBackgroundColor: hexColorSchema.optional(),
-    webhookUrl: secureUrlSchema.optional(),
-    /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
-    subtitle: createSimpleStringSchema({ max: 30 }).optional(),
-    description: createSimpleStringSchema({ max: 170 }).optional(),
-    screenshotUrls: z.array(secureUrlSchema).max(3).optional(),
-    primaryCategory: primaryCategorySchema.optional(),
-    tags: z
-      .array(createSimpleStringSchema({ max: 20, noSpaces: true }))
-      .max(5)
-      .optional(),
-    heroImageUrl: secureUrlSchema.optional(),
-    tagline: createSimpleStringSchema({ max: 30 }).optional(),
-    ogTitle: createSimpleStringSchema({ max: 30 }).optional(),
-    ogDescription: createSimpleStringSchema({ max: 100 }).optional(),
-    ogImageUrl: secureUrlSchema.optional(),
-    /** see: https://github.com/farcasterxyz/miniapps/discussions/204 */
-    noindex: z.boolean().optional(),
-    /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
-    requiredChains: z
-      .array(z.enum(chainList))
-      .transform(removeArrayDuplicates)
-      .optional(),
-    requiredCapabilities: z
-      .array(z.enum(miniAppHostCapabilityList))
-      .transform(removeArrayDuplicates)
-      .optional(),
-    /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
-    /** Documentation will be added once this feature is finalized. */
-    castShareUrl: secureUrlSchema.optional(),
-  })
-  .refine(
-    (data) => {
-      if (data.castShareUrl === undefined) return true
-      try {
-        const homeUrlDomain = new URL(data.homeUrl).hostname
-        const castShareUrlDomain = new URL(data.castShareUrl).hostname
-        return homeUrlDomain === castShareUrlDomain
-      } catch {
-        return false
-      }
-    },
-    {
-      message: 'castShareUrl must have the same domain as homeUrl',
-      path: ['castShareUrl'],
-    },
-  )
-
-export const domainManifestSchema = z.object({
-  accountAssociation: encodedJsonFarcasterSignatureSchema,
-  frame: domainFrameConfigSchema.optional(),
-})

package/src/schemas/notifications.ts

@@ -1,33 +0,0 @@
-import { z } from 'zod'
-import { secureUrlSchema } from './shared.ts'
-
-export const notificationDetailsSchema = z.object({
-  url: z.string(),
-  token: z.string(),
-})
-
-export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>
-
-export const sendNotificationRequestSchema = z.object({
-  notificationId: z.string().max(128),
-  title: z.string().max(32),
-  body: z.string().max(128),
-  targetUrl: secureUrlSchema,
-  tokens: z.string().array().max(100),
-})
-
-export type SendNotificationRequest = z.infer<
-  typeof sendNotificationRequestSchema
->
-
-export const sendNotificationResponseSchema = z.object({
-  result: z.object({
-    successfulTokens: z.array(z.string()),
-    invalidTokens: z.array(z.string()),
-    rateLimitedTokens: z.array(z.string()),
-  }),
-})
-
-export type SendNotificationResponse = z.infer<
-  typeof sendNotificationResponseSchema
->

package/src/schemas/shared.ts

@@ -1,81 +0,0 @@
-import { z } from 'zod'
-
-const SPECIAL_CHARS_PATTERN = /[@#$%^&*+=\/\\|~«»]/
-const REPEATED_PUNCTUATION_PATTERN = /(!{2,}|\?{2,}|-{2,})/
-
-// Unicode ranges for emoji detection:
-// \u{1F300}-\u{1F9FF} - Miscellaneous Symbols, Pictographs, Emoticons, Transport, Map, and Supplemental
-// \u{2702}-\u{27B0} - Dingbats
-// \u{2600}-\u{26FF} - Miscellaneous Symbols
-// \u{2B00}-\u{2BFF} - Miscellaneous Symbols and Arrows
-const EMOJI_PATTERN =
-  /[\u{1F300}-\u{1F9FF}]|[\u{2702}-\u{27B0}]|[\u{2600}-\u{26FF}]|[\u{2B00}-\u{2BFF}]/u
-
-export const createSimpleStringSchema = ({
-  max,
-  noSpaces,
-}: { max?: number; noSpaces?: boolean } = {}) => {
-  const stringValidations = noSpaces
-    ? z
-        .string()
-        .max(max ?? Number.POSITIVE_INFINITY)
-        .regex(/^\S*$/, 'Spaces are not allowed')
-    : z.string().max(max ?? Number.POSITIVE_INFINITY)
-
-  return stringValidations
-    .refine((value) => !EMOJI_PATTERN.test(value), {
-      message: 'Emojis and symbols are not allowed',
-    })
-    .refine((value) => !SPECIAL_CHARS_PATTERN.test(value), {
-      message:
-        'Special characters (@, #, $, %, ^, &, *, +, =, /, \\, |, ~, «, ») are not allowed',
-    })
-    .refine((value) => !REPEATED_PUNCTUATION_PATTERN.test(value), {
-      message: 'Repeated punctuations (!!, ??, --) are not allowed',
-    })
-}
-
-export const secureUrlSchema = z
-  .string()
-  .url()
-  .startsWith('https://', { message: 'Must be an https url' })
-  .max(1024)
-
-export const frameNameSchema = z.string().max(32)
-export const buttonTitleSchema = z.string().max(32)
-
-const CAIP_19_REGEX =
-  /^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\/(?:[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(?:\/[-.%a-zA-Z0-9]{1,78})?|native)$/
-
-export const caip19TokenSchema = z
-  .string()
-  .regex(CAIP_19_REGEX, { message: 'Invalid CAIP-19 asset ID' })
-
-export const hexColorSchema = z
-  .string()
-  .regex(/^#([0-9A-F]{3}|[0-9A-F]{6})$/i, {
-    message:
-      'Invalid hex color code. It should be in the format #RRGGBB or #RGB.',
-  })
-
-export const aspectRatioSchema = z.union([z.literal('1:1'), z.literal('3:2')])
-
-export const encodedJsonFarcasterSignatureSchema = z.object({
-  header: z.string(),
-  payload: z.string(),
-  signature: z.string(),
-})
-
-export type EncodedJsonFarcasterSignatureSchema = z.infer<
-  typeof encodedJsonFarcasterSignatureSchema
->
-
-export const jsonFarcasterSignatureHeaderSchema = z.object({
-  fid: z.number(),
-  type: z.literal('app_key'),
-  key: z.string().startsWith('0x'),
-})
-
-export type JsonFarcasterSignatureHeaderSchema = z.infer<
-  typeof jsonFarcasterSignatureHeaderSchema
->

package/src/solana.ts

@@ -1,108 +0,0 @@
-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

@@ -1,120 +0,0 @@
-import {
-  Transaction as SolanaTransaction,
-  VersionedMessage as SolanaVersionedMessage,
-  VersionedTransaction as SolanaVersionedTransaction,
-} from '@solana/web3.js'
-
-import type {
-  SolanaCombinedTransaction,
-  SolanaConnectRequestArguments,
-  SolanaRequestFn,
-  SolanaSignAndSendTransactionRequestArguments,
-  SolanaSignMessageRequestArguments,
-  SolanaSignTransactionRequestArguments,
-  SolanaWireRequestFn,
-  SolanaWireSignAndSendTransactionRequestArguments,
-  SolanaWireSignTransactionRequestArguments,
-} from './solana.ts'
-
-function serializeTransaction(transaction: SolanaCombinedTransaction): string {
-  return Buffer.from(
-    transaction.serialize({
-      verifySignatures: false,
-    }),
-  ).toString('base64')
-}
-
-function unserializeTransaction(
-  transaction: string,
-): SolanaCombinedTransaction {
-  const bytes = Buffer.from(transaction, 'base64')
-  const version = SolanaVersionedMessage.deserializeMessageVersion(bytes)
-  return version === 'legacy'
-    ? 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,155 +0,0 @@
-import type {
-  ImpactOccurred,
-  NotificationOccurred,
-  SelectionChanged,
-} from './actions/Haptics.ts'
-import type {
-  AddMiniApp,
-  ComposeCast,
-  Ready,
-  SendToken,
-  SignIn,
-  SwapToken,
-  ViewCast,
-  ViewProfile,
-  ViewToken,
-} from './actions/index.ts'
-import type { UpdateBackState } from './back.ts'
-import type { FrameContext } from './context.ts'
-import type {
-  EventFrameAdded,
-  EventFrameRemoved,
-  EventNotificationsDisabled,
-  EventNotificationsEnabled,
-} from './schemas/index.ts'
-import type { SolanaRequestFn, SolanaWireRequestFn } from './solana.ts'
-import type { Ethereum } from './wallet/index.ts'
-
-export type SetPrimaryButtonOptions = {
-  text: string
-  loading?: boolean
-  disabled?: boolean
-  hidden?: boolean
-}
-
-// start backwards compat, remove in 1.0
-export * from './wallet/ethereum.ts'
-export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready.ts'
-export type SignInOptions = SignIn.SignInOptions
-// end backwards compat
-
-export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
-
-// Export haptics types
-export type { ImpactOccurred, NotificationOccurred, SelectionChanged }
-
-export const miniAppHostCapabilityList = [
-  'wallet.getEthereumProvider',
-  'wallet.getSolanaProvider',
-  'actions.ready',
-  'actions.openUrl',
-  'actions.close',
-  'actions.setPrimaryButton',
-  'actions.addMiniApp',
-  'actions.signIn',
-  'actions.viewCast',
-  'actions.viewProfile',
-  'actions.composeCast',
-  'actions.viewToken',
-  'actions.sendToken',
-  'actions.swapToken',
-  'haptics.impactOccurred',
-  'haptics.notificationOccurred',
-  'haptics.selectionChanged',
-  'back',
-] as const
-
-export type MiniAppHostCapability = (typeof miniAppHostCapabilityList)[number]
-
-export type GetCapabilities = () => Promise<MiniAppHostCapability[]>
-
-// Returns a list of CAIP-2 identifiers
-export type GetChains = () => Promise<string[]>
-
-export type WireFrameHost = {
-  context: FrameContext
-  close: () => void
-  ready: Ready.Ready
-  openUrl: (url: string) => void
-  signIn: SignIn.WireSignIn
-  setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: Ethereum.EthProvideRequest
-  ethProviderRequestV2: Ethereum.RpcTransport
-  eip6963RequestProvider: () => void
-  solanaProviderRequest?: SolanaWireRequestFn
-  addFrame: AddMiniApp.WireAddMiniApp
-  viewCast: ViewCast.ViewCast
-  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>>
-  impactOccurred: ImpactOccurred
-  notificationOccurred: NotificationOccurred
-  selectionChanged: SelectionChanged
-  getCapabilities: GetCapabilities
-  getChains: GetChains
-  updateBackState: UpdateBackState
-}
-
-export type FrameHost = {
-  context: FrameContext
-  close: () => void
-  ready: Ready.Ready
-  openUrl: (url: string) => void
-  signIn: SignIn.SignIn
-  setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: Ethereum.EthProvideRequest
-  ethProviderRequestV2: Ethereum.RpcTransport
-  /**
-   * Receive forwarded eip6963:requestProvider events from the frame document.
-   * Hosts must emit an EventEip6963AnnounceProvider in response.
-   */
-  eip6963RequestProvider: () => void
-  solanaProviderRequest?: SolanaRequestFn
-  addFrame: AddMiniApp.AddMiniApp
-  viewCast: ViewCast.ViewCast
-  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>>
-  impactOccurred: ImpactOccurred
-  notificationOccurred: NotificationOccurred
-  selectionChanged: SelectionChanged
-  getCapabilities: GetCapabilities
-  getChains: GetChains
-  updateBackState: UpdateBackState
-}
-
-export type EventFrameAddRejected = {
-  event: 'frame_add_rejected'
-  reason: AddMiniApp.AddMiniAppRejectedReason
-}
-
-export type EventPrimaryButtonClicked = {
-  event: 'primary_button_clicked'
-}
-
-export type EventBackNavigationTriggered = {
-  event: 'back_navigation_triggered'
-}
-
-export type FrameClientEvent =
-  | EventFrameAdded
-  | EventFrameAddRejected
-  | EventFrameRemoved
-  | EventNotificationsEnabled
-  | EventNotificationsDisabled
-  | EventPrimaryButtonClicked
-  | EventBackNavigationTriggered
-  | Ethereum.EventEip6963AnnounceProvider

package/src/wallet/ethereum.ts

@@ -1,65 +0,0 @@
-import type * as Address from 'ox/Address'
-import type * as Provider from 'ox/Provider'
-import type * as RpcRequest from 'ox/RpcRequest'
-import type * as RpcResponse from 'ox/RpcResponse'
-import type * as RpcSchema from 'ox/RpcSchema'
-
-export type EthProvideRequest<
-  schema extends RpcSchema.Generic = RpcSchema.Default,
-> = Provider.RequestFn<schema>
-
-export type FrameEthProviderEventData = {
-  type: 'frame_eth_provider_event'
-} & EthProviderWireEvent
-
-export type RpcTransport = (
-  request: RpcRequest.RpcRequest,
-) => Promise<RpcResponse.RpcResponse>
-
-export type ProviderRpcError = {
-  code: number
-  details?: string
-  message?: string
-}
-
-export type EthProviderWireEvent =
-  | {
-      event: 'accountsChanged'
-      params: [readonly Address.Address[]]
-    }
-  | {
-      event: 'chainChanged'
-      params: [string]
-    }
-  | {
-      event: 'connect'
-      params: [Provider.ConnectInfo]
-    }
-  | {
-      event: 'disconnect'
-      params: [ProviderRpcError]
-    }
-  | {
-      event: 'message'
-      params: [Provider.Message]
-    }
-
-export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(
-  event: event,
-  params: Extract<EthProviderWireEvent, { event: event }>['params'],
-) => void
-
-/**
- * Metadata of the EIP-1193 Provider.
- */
-export interface EIP6963ProviderInfo {
-  icon: `data:image/${string}` // RFC-2397
-  name: string
-  rdns: string
-  uuid: string
-}
-
-export type EventEip6963AnnounceProvider = {
-  event: 'eip6963:announceProvider'
-  info: EIP6963ProviderInfo
-}

package/src/wallet/index.ts

@@ -1 +0,0 @@
-export * as Ethereum from './ethereum.ts'