@farcaster/snap 2.7.0 → 2.8.0

package/dist/react/index.d.ts

@@ -13,6 +13,27 @@ export type SnapPage = {
     effects?: string[];
     ui: Spec;
 };
+export type SnapSendTransactionParams = {
+    chainId: string;
+    to: string;
+    data?: string;
+    value?: string;
+    gas?: string;
+    gasPrice?: string;
+    maxFeePerGas?: string;
+    maxPriorityFeePerGas?: string;
+};
+export type SnapSendCallsParams = {
+    version?: "1.0";
+    chainId: string;
+    atomicRequired?: boolean;
+    id?: string;
+    calls: Array<{
+        to?: string;
+        data?: string;
+        value?: string;
+    }>;
+};
 export type SnapActionHandlers = {
     submit: (target: string, inputs: Record<string, JsonValue>) => void;
     open_url: (target: string) => void;
@@ -24,6 +45,9 @@ export type SnapActionHandlers = {
     view_profile: (params: {
         fid: number;
     }) => void;
+    view_channel: (params: {
+        channelKey: string;
+    }) => void;
     compose_cast: (params: {
         text?: string;
         channelKey?: string;
@@ -42,6 +66,8 @@ export type SnapActionHandlers = {
         sellToken?: string;
         buyToken?: string;
     }) => void;
+    send_transaction?: (params: SnapSendTransactionParams) => void;
+    send_calls?: (params: SnapSendCallsParams) => void;
 };
 export type { SnapRenderState };
 export declare function SnapCard({ snap, handlers, loading, appearance, maxWidth, showOverflowWarning, onValidationError, validationErrorFallback, actionError, plain, loadingOverlay, initialRenderState, onRenderStateChange, }: {

package/dist/react/snap-view-core.js

@@ -8,6 +8,14 @@ import { resolveSnapPaletteHex } from "./lib/resolve-palette-hex.js";
 import { snapPreviewPrimaryCssProperties } from "./lib/preview-primary-css.js";
 import { applyStatePaths, buildInitialRenderState, cloneSnapRenderState, getUnpresentedSnapEffects, markSnapEffectsPresented, } from "../render-state.js";
 import { useCallback, useEffect, useMemo, useRef, useState, } from "react";
+function asRecord(value) {
+    return value && typeof value === "object"
+        ? value
+        : {};
+}
+function optionalString(value) {
+    return value ? String(value) : undefined;
+}
 function withDefaultElementProps(spec) {
     if (!spec || typeof spec !== "object" || !("elements" in spec))
         return spec;
@@ -302,6 +310,9 @@ export function SnapViewCore({ snap, handlers, loading = false, appearance = "da
             case "view_profile":
                 handlers.view_profile({ fid: Number(p.fid ?? 0) });
                 break;
+            case "view_channel":
+                handlers.view_channel({ channelKey: String(p.channelKey ?? "") });
+                break;
             case "compose_cast":
                 handlers.compose_cast({
                     text: p.text ? String(p.text) : undefined,
@@ -330,6 +341,38 @@ export function SnapViewCore({ snap, handlers, loading = false, appearance = "da
                     buyToken: p.buyToken ? String(p.buyToken) : undefined,
                 });
                 break;
+            case "send_transaction":
+                handlers.send_transaction?.({
+                    chainId: String(p.chainId ?? ""),
+                    to: String(p.to ?? ""),
+                    data: optionalString(p.data),
+                    value: optionalString(p.value),
+                    gas: optionalString(p.gas),
+                    gasPrice: optionalString(p.gasPrice),
+                    maxFeePerGas: optionalString(p.maxFeePerGas),
+                    maxPriorityFeePerGas: optionalString(p.maxPriorityFeePerGas),
+                });
+                break;
+            case "send_calls":
+                handlers.send_calls?.({
+                    version: p.version === "1.0" ? "1.0" : undefined,
+                    chainId: String(p.chainId ?? ""),
+                    atomicRequired: typeof p.atomicRequired === "boolean"
+                        ? p.atomicRequired
+                        : undefined,
+                    id: optionalString(p.id),
+                    calls: Array.isArray(p.calls)
+                        ? p.calls.map((call) => {
+                            const c = asRecord(call);
+                            return {
+                                to: optionalString(c.to),
+                                data: optionalString(c.data),
+                                value: optionalString(c.value),
+                            };
+                        })
+                        : [],
+                });
+                break;
             default:
                 break;
         }

package/dist/react-native/snap-view-core.js

@@ -9,6 +9,14 @@ import { useCallback, useEffect, useMemo, useRef, useState, } from "react";
 import { ActivityIndicator, StyleSheet, View } from "react-native";
 import { DEFAULT_THEME_ACCENT, PALETTE_LIGHT_HEX, PALETTE_DARK_HEX, } from "@farcaster/snap";
 import { applyStatePaths, buildInitialRenderState, cloneSnapRenderState, getUnpresentedSnapEffects, markSnapEffectsPresented, } from "../render-state.js";
+function asRecord(value) {
+    return value && typeof value === "object"
+        ? value
+        : {};
+}
+function optionalString(value) {
+    return value ? String(value) : undefined;
+}
 function withDefaultElementProps(spec) {
     if (!spec || typeof spec !== "object" || !("elements" in spec))
         return spec;
@@ -129,6 +137,9 @@ export function SnapViewCoreInner({ snap, handlers, loading = false, loadingOver
             case "view_profile":
                 h.view_profile({ fid: Number(p.fid ?? 0) });
                 break;
+            case "view_channel":
+                h.view_channel({ channelKey: String(p.channelKey ?? "") });
+                break;
             case "compose_cast":
                 h.compose_cast({
                     text: p.text ? String(p.text) : undefined,
@@ -155,6 +166,38 @@ export function SnapViewCoreInner({ snap, handlers, loading = false, loadingOver
                     buyToken: p.buyToken ? String(p.buyToken) : undefined,
                 });
                 break;
+            case "send_transaction":
+                h.send_transaction?.({
+                    chainId: String(p.chainId ?? ""),
+                    to: String(p.to ?? ""),
+                    data: optionalString(p.data),
+                    value: optionalString(p.value),
+                    gas: optionalString(p.gas),
+                    gasPrice: optionalString(p.gasPrice),
+                    maxFeePerGas: optionalString(p.maxFeePerGas),
+                    maxPriorityFeePerGas: optionalString(p.maxPriorityFeePerGas),
+                });
+                break;
+            case "send_calls":
+                h.send_calls?.({
+                    version: p.version === "1.0" ? "1.0" : undefined,
+                    chainId: String(p.chainId ?? ""),
+                    atomicRequired: typeof p.atomicRequired === "boolean"
+                        ? p.atomicRequired
+                        : undefined,
+                    id: optionalString(p.id),
+                    calls: Array.isArray(p.calls)
+                        ? p.calls.map((call) => {
+                            const c = asRecord(call);
+                            return {
+                                to: optionalString(c.to),
+                                data: optionalString(c.data),
+                                value: optionalString(c.value),
+                            };
+                        })
+                        : [],
+                });
+                break;
             default:
                 break;
         }

package/dist/react-native/types.d.ts

@@ -12,6 +12,27 @@ export type SnapPage = {
     effects?: string[];
     ui: Spec;
 };
+export type SnapSendTransactionParams = {
+    chainId: string;
+    to: string;
+    data?: string;
+    value?: string;
+    gas?: string;
+    gasPrice?: string;
+    maxFeePerGas?: string;
+    maxPriorityFeePerGas?: string;
+};
+export type SnapSendCallsParams = {
+    version?: "1.0";
+    chainId: string;
+    atomicRequired?: boolean;
+    id?: string;
+    calls: Array<{
+        to?: string;
+        data?: string;
+        value?: string;
+    }>;
+};
 export type SnapActionHandlers = {
     submit: (target: string, inputs: Record<string, JsonValue>) => void;
     open_url: (target: string) => void;
@@ -23,6 +44,9 @@ export type SnapActionHandlers = {
     view_profile: (params: {
         fid: number;
     }) => void;
+    view_channel: (params: {
+        channelKey: string;
+    }) => void;
     compose_cast: (params: {
         text?: string;
         channelKey?: string;
@@ -41,4 +65,6 @@ export type SnapActionHandlers = {
         sellToken?: string;
         buyToken?: string;
     }) => void;
+    send_transaction?: (params: SnapSendTransactionParams) => void;
+    send_calls?: (params: SnapSendCallsParams) => void;
 };

package/dist/ui/catalog.d.ts

@@ -542,6 +542,12 @@ export declare const snapJsonRenderCatalog: import("@json-render/core").Catalog<
                 fid: z.ZodNumber;
             }, z.core.$strip>;
         };
+        view_channel: {
+            description: string;
+            params: z.ZodObject<{
+                channelKey: z.ZodString;
+            }, z.core.$strip>;
+        };
         compose_cast: {
             description: string;
             params: z.ZodObject<{
@@ -572,6 +578,33 @@ export declare const snapJsonRenderCatalog: import("@json-render/core").Catalog<
                 buyToken: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>;
         };
+        send_transaction: {
+            description: string;
+            params: z.ZodObject<{
+                chainId: z.ZodString;
+                to: z.ZodString;
+                data: z.ZodOptional<z.ZodString>;
+                value: z.ZodOptional<z.ZodString>;
+                gas: z.ZodOptional<z.ZodString>;
+                gasPrice: z.ZodOptional<z.ZodString>;
+                maxFeePerGas: z.ZodOptional<z.ZodString>;
+                maxPriorityFeePerGas: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+        };
+        send_calls: {
+            description: string;
+            params: z.ZodObject<{
+                version: z.ZodOptional<z.ZodLiteral<"1.0">>;
+                chainId: z.ZodString;
+                atomicRequired: z.ZodOptional<z.ZodBoolean>;
+                id: z.ZodOptional<z.ZodString>;
+                calls: z.ZodArray<z.ZodObject<{
+                    to: z.ZodOptional<z.ZodString>;
+                    data: z.ZodOptional<z.ZodString>;
+                    value: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        };
         paginator_next: {
             description: string;
             params: z.ZodObject<{

package/dist/ui/catalog.js

@@ -123,6 +123,10 @@ export const snapJsonRenderCatalog = defineCatalog(snapJsonRenderSchema, {
             description: "Navigate to a user profile by FID.",
             params: z.object({ fid: z.number() }),
         },
+        view_channel: {
+            description: "Navigate to a Farcaster channel by channel key.",
+            params: z.object({ channelKey: z.string() }),
+        },
         compose_cast: {
             description: "Open the cast composer with optional pre-filled content.",
             params: z.object({
@@ -151,6 +155,33 @@ export const snapJsonRenderCatalog = defineCatalog(snapJsonRenderSchema, {
                 buyToken: z.string().optional(),
             }),
         },
+        send_transaction: {
+            description: "Request an EVM transaction through the host wallet using eth_sendTransaction.",
+            params: z.object({
+                chainId: z.string(),
+                to: z.string(),
+                data: z.string().optional(),
+                value: z.string().optional(),
+                gas: z.string().optional(),
+                gasPrice: z.string().optional(),
+                maxFeePerGas: z.string().optional(),
+                maxPriorityFeePerGas: z.string().optional(),
+            }),
+        },
+        send_calls: {
+            description: "Request one or more EVM calls through the host wallet using wallet_sendCalls.",
+            params: z.object({
+                version: z.literal("1.0").optional(),
+                chainId: z.string(),
+                atomicRequired: z.boolean().optional(),
+                id: z.string().optional(),
+                calls: z.array(z.object({
+                    to: z.string().optional(),
+                    data: z.string().optional(),
+                    value: z.string().optional(),
+                })),
+            }),
+        },
         paginator_next: {
             description: "Move the snap's paginator to the next page locally. Does not POST and is ignored when no paginator is rendered.",
             params: z.object({ page: z.number().int().min(0).optional() }),

package/llms.txt

@@ -172,7 +172,7 @@ Field values are sent in POST `inputs[name]` when a `submit` action fires.
 - `label` (string, optional, max 60)
 - POST value: string (single) or string[] (multiple)
 
-## Actions (10 types)
+## Actions (11 types)
 
 Bound to buttons via `on.press`:
 
@@ -184,6 +184,7 @@ Bound to buttons via `on.press`:
 | `open_mini_app` | `target` (URL) | Open as Farcaster mini app |
 | `view_cast` | `hash` (string) | Navigate to a cast |
 | `view_profile` | `fid` (number) | Navigate to a profile |
+| `view_channel` | `channelKey` (string) | Navigate to a channel |
 | `compose_cast` | `text?`, `channelKey?`, `embeds?` | Open cast composer. Put URLs in `embeds`, not `text` |
 | `view_token` | `token` (CAIP-19) | View token in wallet |
 | `send_token` | `token`, `amount?`, `recipientFid?`, `recipientAddress?` | Send token flow |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/snap",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Farcaster Snaps 🫰",
   "repository": {
     "type": "git",

package/src/react/index.tsx

@@ -25,6 +25,29 @@ export type SnapPage = {
   ui: Spec;
 };
 
+export type SnapSendTransactionParams = {
+  chainId: string;
+  to: string;
+  data?: string;
+  value?: string;
+  gas?: string;
+  gasPrice?: string;
+  maxFeePerGas?: string;
+  maxPriorityFeePerGas?: string;
+};
+
+export type SnapSendCallsParams = {
+  version?: "1.0";
+  chainId: string;
+  atomicRequired?: boolean;
+  id?: string;
+  calls: Array<{
+    to?: string;
+    data?: string;
+    value?: string;
+  }>;
+};
+
 export type SnapActionHandlers = {
   submit: (target: string, inputs: Record<string, JsonValue>) => void;
   open_url: (target: string) => void;
@@ -32,6 +55,7 @@ export type SnapActionHandlers = {
   open_mini_app: (target: string) => void;
   view_cast: (params: { hash: string }) => void;
   view_profile: (params: { fid: number }) => void;
+  view_channel: (params: { channelKey: string }) => void;
   compose_cast: (params: {
     text?: string;
     channelKey?: string;
@@ -45,6 +69,8 @@ export type SnapActionHandlers = {
     recipientAddress?: string;
   }) => void;
   swap_token: (params: { sellToken?: string; buyToken?: string }) => void;
+  send_transaction?: (params: SnapSendTransactionParams) => void;
+  send_calls?: (params: SnapSendCallsParams) => void;
 };
 
 export type { SnapRenderState };

package/src/react/snap-view-core.tsx

@@ -26,6 +26,16 @@ import {
 } from "react";
 import type { JsonValue, SnapActionHandlers, SnapPage } from "./index";
 
+function asRecord(value: unknown): Record<string, unknown> {
+  return value && typeof value === "object"
+    ? (value as Record<string, unknown>)
+    : {};
+}
+
+function optionalString(value: unknown): string | undefined {
+  return value ? String(value) : undefined;
+}
+
 function withDefaultElementProps(spec: Spec): Spec {
   if (!spec || typeof spec !== "object" || !("elements" in spec)) return spec;
   const elements = spec.elements as unknown as Record<
@@ -465,6 +475,9 @@ export function SnapViewCore({
         case "view_profile":
           handlers.view_profile({ fid: Number(p.fid ?? 0) });
           break;
+        case "view_channel":
+          handlers.view_channel({ channelKey: String(p.channelKey ?? "") });
+          break;
         case "compose_cast":
           handlers.compose_cast({
             text: p.text ? String(p.text) : undefined,
@@ -493,6 +506,39 @@ export function SnapViewCore({
             buyToken: p.buyToken ? String(p.buyToken) : undefined,
           });
           break;
+        case "send_transaction":
+          handlers.send_transaction?.({
+            chainId: String(p.chainId ?? ""),
+            to: String(p.to ?? ""),
+            data: optionalString(p.data),
+            value: optionalString(p.value),
+            gas: optionalString(p.gas),
+            gasPrice: optionalString(p.gasPrice),
+            maxFeePerGas: optionalString(p.maxFeePerGas),
+            maxPriorityFeePerGas: optionalString(p.maxPriorityFeePerGas),
+          });
+          break;
+        case "send_calls":
+          handlers.send_calls?.({
+            version: p.version === "1.0" ? "1.0" : undefined,
+            chainId: String(p.chainId ?? ""),
+            atomicRequired:
+              typeof p.atomicRequired === "boolean"
+                ? p.atomicRequired
+                : undefined,
+            id: optionalString(p.id),
+            calls: Array.isArray(p.calls)
+              ? p.calls.map((call) => {
+                  const c = asRecord(call);
+                  return {
+                    to: optionalString(c.to),
+                    data: optionalString(c.data),
+                    value: optionalString(c.value),
+                  };
+                })
+              : [],
+          });
+          break;
         default:
           break;
       }

package/src/react-native/snap-view-core.tsx

@@ -30,6 +30,16 @@ import {
 } from "../render-state";
 import type { SnapPage, SnapActionHandlers, JsonValue } from "./types";
 
+function asRecord(value: unknown): Record<string, unknown> {
+  return value && typeof value === "object"
+    ? (value as Record<string, unknown>)
+    : {};
+}
+
+function optionalString(value: unknown): string | undefined {
+  return value ? String(value) : undefined;
+}
+
 function withDefaultElementProps(spec: Spec): Spec {
   if (!spec || typeof spec !== "object" || !("elements" in spec)) return spec;
   const elements = spec.elements as unknown as Record<
@@ -202,6 +212,9 @@ export function SnapViewCoreInner({
       case "view_profile":
         h.view_profile({ fid: Number(p.fid ?? 0) });
         break;
+      case "view_channel":
+        h.view_channel({ channelKey: String(p.channelKey ?? "") });
+        break;
       case "compose_cast":
         h.compose_cast({
           text: p.text ? String(p.text) : undefined,
@@ -228,6 +241,39 @@ export function SnapViewCoreInner({
           buyToken: p.buyToken ? String(p.buyToken) : undefined,
         });
         break;
+      case "send_transaction":
+        h.send_transaction?.({
+          chainId: String(p.chainId ?? ""),
+          to: String(p.to ?? ""),
+          data: optionalString(p.data),
+          value: optionalString(p.value),
+          gas: optionalString(p.gas),
+          gasPrice: optionalString(p.gasPrice),
+          maxFeePerGas: optionalString(p.maxFeePerGas),
+          maxPriorityFeePerGas: optionalString(p.maxPriorityFeePerGas),
+        });
+        break;
+      case "send_calls":
+        h.send_calls?.({
+          version: p.version === "1.0" ? "1.0" : undefined,
+          chainId: String(p.chainId ?? ""),
+          atomicRequired:
+            typeof p.atomicRequired === "boolean"
+              ? p.atomicRequired
+              : undefined,
+          id: optionalString(p.id),
+          calls: Array.isArray(p.calls)
+            ? p.calls.map((call) => {
+                const c = asRecord(call);
+                return {
+                  to: optionalString(c.to),
+                  data: optionalString(c.data),
+                  value: optionalString(c.value),
+                };
+              })
+            : [],
+        });
+        break;
       default:
         break;
     }

package/src/react-native/types.ts

@@ -18,6 +18,29 @@ export type SnapPage = {
   ui: Spec;
 };
 
+export type SnapSendTransactionParams = {
+  chainId: string;
+  to: string;
+  data?: string;
+  value?: string;
+  gas?: string;
+  gasPrice?: string;
+  maxFeePerGas?: string;
+  maxPriorityFeePerGas?: string;
+};
+
+export type SnapSendCallsParams = {
+  version?: "1.0";
+  chainId: string;
+  atomicRequired?: boolean;
+  id?: string;
+  calls: Array<{
+    to?: string;
+    data?: string;
+    value?: string;
+  }>;
+};
+
 export type SnapActionHandlers = {
   submit: (target: string, inputs: Record<string, JsonValue>) => void;
   open_url: (target: string) => void;
@@ -25,6 +48,7 @@ export type SnapActionHandlers = {
   open_mini_app: (target: string) => void;
   view_cast: (params: { hash: string }) => void;
   view_profile: (params: { fid: number }) => void;
+  view_channel: (params: { channelKey: string }) => void;
   compose_cast: (params: {
     text?: string;
     channelKey?: string;
@@ -38,4 +62,6 @@ export type SnapActionHandlers = {
     recipientAddress?: string;
   }) => void;
   swap_token: (params: { sellToken?: string; buyToken?: string }) => void;
+  send_transaction?: (params: SnapSendTransactionParams) => void;
+  send_calls?: (params: SnapSendCallsParams) => void;
 };

package/src/ui/catalog.ts

@@ -144,6 +144,10 @@ export const snapJsonRenderCatalog = defineCatalog(snapJsonRenderSchema, {
       description: "Navigate to a user profile by FID.",
       params: z.object({ fid: z.number() }),
     },
+    view_channel: {
+      description: "Navigate to a Farcaster channel by channel key.",
+      params: z.object({ channelKey: z.string() }),
+    },
     compose_cast: {
       description: "Open the cast composer with optional pre-filled content.",
       params: z.object({
@@ -172,6 +176,37 @@ export const snapJsonRenderCatalog = defineCatalog(snapJsonRenderSchema, {
         buyToken: z.string().optional(),
       }),
     },
+    send_transaction: {
+      description:
+        "Request an EVM transaction through the host wallet using eth_sendTransaction.",
+      params: z.object({
+        chainId: z.string(),
+        to: z.string(),
+        data: z.string().optional(),
+        value: z.string().optional(),
+        gas: z.string().optional(),
+        gasPrice: z.string().optional(),
+        maxFeePerGas: z.string().optional(),
+        maxPriorityFeePerGas: z.string().optional(),
+      }),
+    },
+    send_calls: {
+      description:
+        "Request one or more EVM calls through the host wallet using wallet_sendCalls.",
+      params: z.object({
+        version: z.literal("1.0").optional(),
+        chainId: z.string(),
+        atomicRequired: z.boolean().optional(),
+        id: z.string().optional(),
+        calls: z.array(
+          z.object({
+            to: z.string().optional(),
+            data: z.string().optional(),
+            value: z.string().optional(),
+          }),
+        ),
+      }),
+    },
     paginator_next: {
       description:
         "Move the snap's paginator to the next page locally. Does not POST and is ignored when no paginator is rendered.",