@farcaster/frame-core 0.0.26 → 0.0.28

package/esm/types.d.ts

@@ -1,63 +1,41 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
-import type { AddFrame, SignIn, ViewProfile } from './actions';
+import type { AddFrame, Ready, SignIn, Swap, ViewProfile, ViewToken } from './actions';
 import type { FrameContext } from './context';
 import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
+import type { Ethereum } from './wallet';
 export type SetPrimaryButtonOptions = {
     text: string;
     loading?: boolean;
     disabled?: boolean;
     hidden?: boolean;
 };
+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 EthProviderRequest = Provider.RequestFn<RpcSchema.Default>;
-export type ReadyOptions = {
-    /**
-     * Disable native gestures. Use this option if your frame uses gestures
-     * that conflict with native gestures.
-     *
-     * @defaultValue false
-     */
-    disableNativeGestures: boolean;
-};
-export declare const DEFAULT_READY_OPTIONS: ReadyOptions;
-export type SignInOptions = {
-    /**
-     * A random string used to prevent replay attacks.
-     */
-    nonce: string;
-    /**
-     * Start time at which the signature becomes valid.
-     * ISO 8601 datetime.
-     */
-    notBefore?: string;
-    /**
-     * Expiration time at which the signature is no longer valid.
-     * ISO 8601 datetime.
-     */
-    expirationTime?: string;
-};
 export type WireFrameHost = {
     context: FrameContext;
     close: () => void;
-    ready: (options?: Partial<ReadyOptions>) => void;
+    ready: Ready.Ready;
     openUrl: (url: string) => void;
     signIn: SignIn.WireSignIn;
     setPrimaryButton: SetPrimaryButton;
-    ethProviderRequest: EthProviderRequest;
-    ethProviderRequestV2: RpcTransport;
+    ethProviderRequest: Ethereum.EthProvideRequest;
+    ethProviderRequestV2: Ethereum.RpcTransport;
     eip6963RequestProvider: () => void;
     addFrame: AddFrame.WireAddFrame;
     viewProfile: ViewProfile.ViewProfile;
+    viewToken: ViewToken.ViewToken;
+    swap: Swap.Swap;
 };
 export type FrameHost = {
     context: FrameContext;
     close: () => void;
-    ready: (options?: Partial<ReadyOptions>) => void;
+    ready: Ready.Ready;
     openUrl: (url: string) => void;
     signIn: SignIn.SignIn;
     setPrimaryButton: SetPrimaryButton;
-    ethProviderRequest: EthProviderRequest;
-    ethProviderRequestV2: RpcTransport;
+    ethProviderRequest: Ethereum.EthProvideRequest;
+    ethProviderRequestV2: Ethereum.RpcTransport;
     /**
      * Receive forwarded eip6963:requestProvider events from the frame document.
      * Hosts must emit an EventEip6963AnnounceProvider in response.
@@ -65,35 +43,9 @@ export type FrameHost = {
     eip6963RequestProvider: () => void;
     addFrame: AddFrame.AddFrame;
     viewProfile: ViewProfile.ViewProfile;
+    viewToken: ViewToken.ViewToken;
+    swap: Swap.Swap;
 };
-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;
 export type EventFrameAddRejected = {
     event: 'frame_add_rejected';
     reason: AddFrame.AddFrameRejectedReason;
@@ -101,17 +53,4 @@ export type EventFrameAddRejected = {
 export type EventPrimaryButtonClicked = {
     event: 'primary_button_clicked';
 };
-/**
- * Metadata of the EIP-1193 Provider.
- */
-export interface EIP6963ProviderInfo {
-    icon: `data:image/${string}`;
-    name: string;
-    rdns: string;
-    uuid: string;
-}
-export type EventEip6963AnnounceProvider = {
-    event: 'eip6963:announceProvider';
-    info: EIP6963ProviderInfo;
-};
-export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | EventEip6963AnnounceProvider;
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;

package/esm/types.js

@@ -1,3 +1,3 @@
-export const DEFAULT_READY_OPTIONS = {
-    disableNativeGestures: false,
-};
+// start backwards compat, remove in 1.0
+export * from './wallet/ethereum';
+export { DEFAULT_READY_OPTIONS } from './actions/Ready';

package/esm/wallet/ethereum.d.ts

@@ -0,0 +1,43 @@
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
+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}`;
+    name: string;
+    rdns: string;
+    uuid: string;
+}
+export type EventEip6963AnnounceProvider = {
+    event: 'eip6963:announceProvider';
+    info: EIP6963ProviderInfo;
+};

package/esm/wallet/ethereum.js

@@ -0,0 +1 @@
+export {};

package/esm/wallet/index.d.ts

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

package/esm/wallet/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "main": "dist/index.js",
   "module": "esm/index.js",
   "files": [
@@ -11,7 +11,7 @@
   "devDependencies": {
     "@vitest/coverage-v8": "^2.1.8",
     "typescript": "^5.7.2",
-    "vitest": "^2.1.8",
+    "vitest": "^2.1.9",
     "@farcaster/tsconfig": "0.0.2"
   },
   "dependencies": {

package/src/actions/Ready.ts

@@ -0,0 +1,15 @@
+export type ReadyOptions = {
+  /**
+   * Disable native gestures. Use this option if your frame uses gestures
+   * that conflict with native gestures.
+   *
+   * @defaultValue false
+   */
+  disableNativeGestures: boolean
+}
+
+export const DEFAULT_READY_OPTIONS = {
+  disableNativeGestures: false,
+} satisfies ReadyOptions
+
+export type Ready = (options?: Partial<ReadyOptions>) => void

package/src/actions/Swap.ts

@@ -0,0 +1,54 @@
+export type SwapOptions = {
+  /**
+   * CAIP-19 asset ID
+   * For example, Base USDC:
+   * eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
+   */
+  sellToken?: string
+
+  /**
+   * CAIP-19 token ID. For example, OP ETH:
+   * eip155:10/native
+   */
+  buyToken?: string
+
+  /**
+   * Sell token amount, as numeric string.
+   * For example, 10 USDC: 1000000
+   */
+  sellAmount?: string
+}
+
+type SwapDetails = {
+  /**
+   * Array of tx identifiers in order of execution.
+   * Some swaps will have both an approval and swap tx.
+   */
+  transactions: `0x${string}`[]
+}
+
+type SwapErrorDetails = {
+  /**
+   * Error code.
+   */
+  error: string
+  /**
+   * Error message.
+   */
+  message?: string
+}
+
+export type SwapErrorReason = 'rejected_by_user' | 'swap_failed'
+
+export type SwapResult =
+  | {
+      success: true
+      swap: SwapDetails
+    }
+  | {
+      success: false
+      reason: SwapErrorReason
+      error?: SwapErrorDetails
+    }
+
+export type Swap = (options: SwapOptions) => Promise<SwapResult>

package/src/actions/ViewToken.ts

@@ -0,0 +1,5 @@
+export type ViewTokenOptions = {
+  token: string
+}
+
+export type ViewToken = (options: ViewTokenOptions) => Promise<void>

package/src/actions/index.ts

@@ -1,3 +1,6 @@
 export * as AddFrame from './AddFrame'
-export * as ViewProfile from './ViewProfile'
+export * as Ready from './Ready'
 export * as SignIn from './SignIn'
+export * as Swap from './Swap'
+export * as ViewProfile from './ViewProfile'
+export * as ViewToken from './ViewToken'

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './actions'
+export * from './wallet'
 export * as Context from './context'
 export * from './types'
 export * from './schemas'

package/src/types.ts

@@ -1,5 +1,11 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
-import type { AddFrame, SignIn, ViewProfile } from './actions'
+import type {
+  AddFrame,
+  Ready,
+  SignIn,
+  Swap,
+  ViewProfile,
+  ViewToken,
+} from './actions'
 import type { FrameContext } from './context'
 import type {
   EventFrameAdded,
@@ -7,6 +13,7 @@ import type {
   EventNotificationsDisabled,
   EventNotificationsEnabled,
 } from './schemas'
+import type { Ethereum } from './wallet'
 
 export type SetPrimaryButtonOptions = {
   text: string
@@ -15,66 +22,39 @@ export type SetPrimaryButtonOptions = {
   hidden?: boolean
 }
 
-export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
-
-export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>
-
-export type ReadyOptions = {
-  /**
-   * Disable native gestures. Use this option if your frame uses gestures
-   * that conflict with native gestures.
-   *
-   * @defaultValue false
-   */
-  disableNativeGestures: boolean
-}
-
-export const DEFAULT_READY_OPTIONS: ReadyOptions = {
-  disableNativeGestures: false,
-}
-
-export type SignInOptions = {
-  /**
-   * A random string used to prevent replay attacks.
-   */
-  nonce: string
-
-  /**
-   * Start time at which the signature becomes valid.
-   * ISO 8601 datetime.
-   */
-  notBefore?: string
+// start backwards compat, remove in 1.0
+export * from './wallet/ethereum'
+export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready'
+export type SignInOptions = SignIn.SignInOptions
+// end backwards compat
 
-  /**
-   * Expiration time at which the signature is no longer valid.
-   * ISO 8601 datetime.
-   */
-  expirationTime?: string
-}
+export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
 
 export type WireFrameHost = {
   context: FrameContext
   close: () => void
-  ready: (options?: Partial<ReadyOptions>) => void
+  ready: Ready.Ready
   openUrl: (url: string) => void
   signIn: SignIn.WireSignIn
   setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: EthProviderRequest
-  ethProviderRequestV2: RpcTransport
+  ethProviderRequest: Ethereum.EthProvideRequest
+  ethProviderRequestV2: Ethereum.RpcTransport
   eip6963RequestProvider: () => void
   addFrame: AddFrame.WireAddFrame
   viewProfile: ViewProfile.ViewProfile
+  viewToken: ViewToken.ViewToken
+  swap: Swap.Swap
 }
 
 export type FrameHost = {
   context: FrameContext
   close: () => void
-  ready: (options?: Partial<ReadyOptions>) => void
+  ready: Ready.Ready
   openUrl: (url: string) => void
   signIn: SignIn.SignIn
   setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: EthProviderRequest
-  ethProviderRequestV2: RpcTransport
+  ethProviderRequest: Ethereum.EthProvideRequest
+  ethProviderRequestV2: Ethereum.RpcTransport
   /**
    * Receive forwarded eip6963:requestProvider events from the frame document.
    * Hosts must emit an EventEip6963AnnounceProvider in response.
@@ -82,49 +62,10 @@ export type FrameHost = {
   eip6963RequestProvider: () => void
   addFrame: AddFrame.AddFrame
   viewProfile: ViewProfile.ViewProfile
+  viewToken: ViewToken.ViewToken
+  swap: Swap.Swap
 }
 
-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
-
 export type EventFrameAddRejected = {
   event: 'frame_add_rejected'
   reason: AddFrame.AddFrameRejectedReason
@@ -134,21 +75,6 @@ export type EventPrimaryButtonClicked = {
   event: 'primary_button_clicked'
 }
 
-/**
- * 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
-}
-
 export type FrameClientEvent =
   | EventFrameAdded
   | EventFrameAddRejected
@@ -156,4 +82,4 @@ export type FrameClientEvent =
   | EventNotificationsEnabled
   | EventNotificationsDisabled
   | EventPrimaryButtonClicked
-  | EventEip6963AnnounceProvider
+  | Ethereum.EventEip6963AnnounceProvider

package/src/wallet/ethereum.ts

@@ -0,0 +1,61 @@
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
+
+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

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