@farcaster/frame-core 0.0.33 → 0.0.35

package/src/actions/SendToken.ts

@@ -0,0 +1,57 @@
+export type SendTokenOptions = {
+  /**
+   * CAIP-19 asset ID
+   * For example, Base USDC:
+   * eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
+   */
+  token?: string
+
+  /**
+   * Token amount, as numeric string.
+   * For example, 10 USDC: 1000000
+   */
+  amount?: string
+
+  /**
+   * Recipient address.
+   */
+  recipientAddress?: string
+
+  /**
+   * Recipient fid.
+   */
+  recipientFid?: number
+}
+
+type SendTokenDetails = {
+  /**
+   * Tx identifier.
+   */
+  transaction: `0x${string}`
+}
+
+type SendTokenErrorDetails = {
+  /**
+   * Error code.
+   */
+  error: string
+  /**
+   * Error message.
+   */
+  message?: string
+}
+
+export type SendTokenErrorReason = 'rejected_by_user' | 'send_failed'
+
+export type SendTokenResult =
+  | {
+      success: true
+      send: SendTokenDetails
+    }
+  | {
+      success: false
+      reason: SendTokenErrorReason
+      error?: SendTokenErrorDetails
+    }
+
+export type SendToken = (options: SendTokenOptions) => Promise<SendTokenResult>

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/{Swap.ts → SwapToken.ts}

@@ -1,4 +1,4 @@
-export type SwapOptions = {
+export type SwapTokenOptions = {
   /**
    * CAIP-19 asset ID
    * For example, Base USDC:
@@ -14,12 +14,12 @@ export type SwapOptions = {
 
   /**
    * Sell token amount, as numeric string.
-   * For example, 10 USDC: 1000000
+   * For example, 1 USDC: 1000000
    */
   sellAmount?: string
 }
 
-type SwapDetails = {
+type SwapTokenDetails = {
   /**
    * Array of tx identifiers in order of execution.
    * Some swaps will have both an approval and swap tx.
@@ -27,7 +27,7 @@ type SwapDetails = {
   transactions: `0x${string}`[]
 }
 
-type SwapErrorDetails = {
+type SwapTokenErrorDetails = {
   /**
    * Error code.
    */
@@ -40,15 +40,15 @@ type SwapErrorDetails = {
 
 export type SwapErrorReason = 'rejected_by_user' | 'swap_failed'
 
-export type SwapResult =
+export type SwapTokenResult =
   | {
       success: true
-      swap: SwapDetails
+      swap: SwapTokenDetails
     }
   | {
       success: false
       reason: SwapErrorReason
-      error?: SwapErrorDetails
+      error?: SwapTokenErrorDetails
     }
 
-export type Swap = (options: SwapOptions) => Promise<SwapResult>
+export type SwapToken = (options: SwapTokenOptions) => Promise<SwapTokenResult>

package/src/actions/index.ts

@@ -2,6 +2,7 @@ export * as AddFrame from './AddFrame'
 export * as ComposeCast from './ComposeCast'
 export * as Ready from './Ready'
 export * as SignIn from './SignIn'
-export * as Swap from './Swap'
+export * as SendToken from './SendToken'
+export * as SwapToken from './SwapToken'
 export * as ViewProfile from './ViewProfile'
 export * as ViewToken from './ViewToken'

package/src/index.ts

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

package/src/solana.ts

@@ -0,0 +1,82 @@
+import type {
+  Connection as SolanaConnection,
+  SendOptions as SolanaSendOptions,
+  Transaction as SolanaTransaction,
+  VersionedTransaction as SolanaVersionedTransaction,
+} from '@solana/web3.js'
+
+export type { SolanaConnection }
+
+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
+    connection: SolanaConnection
+    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
+    connection: SolanaConnection
+  }): 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
+    connection: SolanaConnection
+  }) =>
+    request({
+      method: 'signAndSendTransaction',
+      params: input,
+    }),
+})

package/src/types.ts

@@ -2,8 +2,9 @@ import type {
   AddFrame,
   ComposeCast,
   Ready,
+  SendToken,
   SignIn,
-  Swap,
+  SwapToken,
   ViewProfile,
   ViewToken,
 } from './actions'
@@ -14,6 +15,7 @@ import type {
   EventNotificationsDisabled,
   EventNotificationsEnabled,
 } from './schemas'
+import type { SolanaRequestFn } from './solana'
 import type { Ethereum } from './wallet'
 
 export type SetPrimaryButtonOptions = {
@@ -41,10 +43,12 @@ export type WireFrameHost = {
   ethProviderRequest: Ethereum.EthProvideRequest
   ethProviderRequestV2: Ethereum.RpcTransport
   eip6963RequestProvider: () => void
+  solanaProviderRequest?: SolanaRequestFn
   addFrame: AddFrame.WireAddFrame
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
-  swap: Swap.Swap
+  sendToken: SendToken.SendToken
+  swapToken: SwapToken.SwapToken
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
@@ -64,10 +68,12 @@ export type FrameHost = {
    * Hosts must emit an EventEip6963AnnounceProvider in response.
    */
   eip6963RequestProvider: () => void
+  solanaProviderRequest?: SolanaRequestFn
   addFrame: AddFrame.AddFrame
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
-  swap: Swap.Swap
+  sendToken: SendToken.SendToken
+  swapToken: SwapToken.SwapToken
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>