@farcaster/frame-core 0.0.0-canary-20250430150627

package/dist/schemas/manifest.d.ts

@@ -0,0 +1,208 @@
+import { z } from 'zod';
+export declare const domainFrameConfigSchema: z.ZodObject<{
+    version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
+    name: z.ZodString;
+    iconUrl: z.ZodString;
+    homeUrl: z.ZodString;
+    /** deprecated, set ogImageUrl instead */
+    imageUrl: z.ZodOptional<z.ZodString>;
+    /** deprecated, will rely on fc:frame meta tag */
+    buttonTitle: z.ZodOptional<z.ZodString>;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodString>;
+    webhookUrl: z.ZodOptional<z.ZodString>;
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+    subtitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    description: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    screenshotUrls: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    primaryCategory: z.ZodOptional<z.ZodEnum<["games", "social", "finance", "utility", "productivity", "health-fitness", "news-media", "music", "shopping", "education", "developer-tools", "entertainment", "art-creativity"]>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, "many">>;
+    heroImageUrl: z.ZodOptional<z.ZodString>;
+    tagline: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    ogTitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    ogDescription: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    ogImageUrl: z.ZodOptional<z.ZodString>;
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/204 */
+    noindex: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    version: "next" | "1" | "0.0.0" | "0.0.1";
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    imageUrl?: string | undefined;
+    buttonTitle?: string | undefined;
+    webhookUrl?: string | undefined;
+    subtitle?: string | undefined;
+    description?: string | undefined;
+    screenshotUrls?: string[] | undefined;
+    primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+    tags?: string[] | undefined;
+    heroImageUrl?: string | undefined;
+    tagline?: string | undefined;
+    ogTitle?: string | undefined;
+    ogDescription?: string | undefined;
+    ogImageUrl?: string | undefined;
+    noindex?: boolean | undefined;
+}, {
+    name: string;
+    version: "next" | "1" | "0.0.0" | "0.0.1";
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    imageUrl?: string | undefined;
+    buttonTitle?: string | undefined;
+    webhookUrl?: string | undefined;
+    subtitle?: string | undefined;
+    description?: string | undefined;
+    screenshotUrls?: string[] | undefined;
+    primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+    tags?: string[] | undefined;
+    heroImageUrl?: string | undefined;
+    tagline?: string | undefined;
+    ogTitle?: string | undefined;
+    ogDescription?: string | undefined;
+    ogImageUrl?: string | undefined;
+    noindex?: boolean | undefined;
+}>;
+export declare const domainManifestSchema: z.ZodObject<{
+    accountAssociation: z.ZodObject<{
+        header: z.ZodString;
+        payload: z.ZodString;
+        signature: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        header: string;
+        payload: string;
+        signature: string;
+    }, {
+        header: string;
+        payload: string;
+        signature: string;
+    }>;
+    frame: z.ZodOptional<z.ZodObject<{
+        version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
+        name: z.ZodString;
+        iconUrl: z.ZodString;
+        homeUrl: z.ZodString;
+        /** deprecated, set ogImageUrl instead */
+        imageUrl: z.ZodOptional<z.ZodString>;
+        /** deprecated, will rely on fc:frame meta tag */
+        buttonTitle: z.ZodOptional<z.ZodString>;
+        splashImageUrl: z.ZodOptional<z.ZodString>;
+        splashBackgroundColor: z.ZodOptional<z.ZodString>;
+        webhookUrl: z.ZodOptional<z.ZodString>;
+        /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+        subtitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        description: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        screenshotUrls: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        primaryCategory: z.ZodOptional<z.ZodEnum<["games", "social", "finance", "utility", "productivity", "health-fitness", "news-media", "music", "shopping", "education", "developer-tools", "entertainment", "art-creativity"]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, "many">>;
+        heroImageUrl: z.ZodOptional<z.ZodString>;
+        tagline: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        ogTitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        ogDescription: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        ogImageUrl: z.ZodOptional<z.ZodString>;
+        /** see: https://github.com/farcasterxyz/miniapps/discussions/204 */
+        noindex: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        version: "next" | "1" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+    }, {
+        name: string;
+        version: "next" | "1" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    accountAssociation: {
+        header: string;
+        payload: string;
+        signature: string;
+    };
+    frame?: {
+        name: string;
+        version: "next" | "1" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+    } | undefined;
+}, {
+    accountAssociation: {
+        header: string;
+        payload: string;
+        signature: string;
+    };
+    frame?: {
+        name: string;
+        version: "next" | "1" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+    } | undefined;
+}>;

package/dist/schemas/manifest.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.domainManifestSchema = exports.domainFrameConfigSchema = void 0;
+const zod_1 = require("zod");
+const shared_1 = require("./shared");
+const primaryCategorySchema = zod_1.z.enum([
+    'games',
+    'social',
+    'finance',
+    'utility',
+    'productivity',
+    'health-fitness',
+    'news-media',
+    'music',
+    'shopping',
+    'education',
+    'developer-tools',
+    'entertainment',
+    'art-creativity',
+]);
+exports.domainFrameConfigSchema = zod_1.z.object({
+    // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
+    // backwards compatibilty. next should always resolve to the most recent
+    // schema version.
+    version: zod_1.z.union([
+        zod_1.z.literal('0.0.0'),
+        zod_1.z.literal('0.0.1'),
+        zod_1.z.literal('1'),
+        zod_1.z.literal('next'),
+    ]),
+    name: shared_1.frameNameSchema,
+    iconUrl: shared_1.secureUrlSchema,
+    homeUrl: shared_1.secureUrlSchema,
+    /** deprecated, set ogImageUrl instead */
+    imageUrl: shared_1.secureUrlSchema.optional(),
+    /** deprecated, will rely on fc:frame meta tag */
+    buttonTitle: shared_1.buttonTitleSchema.optional(),
+    splashImageUrl: shared_1.secureUrlSchema.optional(),
+    splashBackgroundColor: shared_1.hexColorSchema.optional(),
+    webhookUrl: shared_1.secureUrlSchema.optional(),
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+    subtitle: (0, shared_1.createSimpleStringSchema)({ max: 30 }).optional(),
+    description: (0, shared_1.createSimpleStringSchema)({ max: 170 }).optional(),
+    screenshotUrls: zod_1.z.array(shared_1.secureUrlSchema).max(3).optional(),
+    primaryCategory: primaryCategorySchema.optional(),
+    tags: zod_1.z
+        .array((0, shared_1.createSimpleStringSchema)({ max: 20, noSpaces: true }))
+        .max(5)
+        .optional(),
+    heroImageUrl: shared_1.secureUrlSchema.optional(),
+    tagline: (0, shared_1.createSimpleStringSchema)({ max: 30 }).optional(),
+    ogTitle: (0, shared_1.createSimpleStringSchema)({ max: 30 }).optional(),
+    ogDescription: (0, shared_1.createSimpleStringSchema)({ max: 100 }).optional(),
+    ogImageUrl: shared_1.secureUrlSchema.optional(),
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/204 */
+    noindex: zod_1.z.boolean().optional(),
+});
+exports.domainManifestSchema = zod_1.z.object({
+    accountAssociation: shared_1.encodedJsonFarcasterSignatureSchema,
+    frame: exports.domainFrameConfigSchema.optional(),
+});

package/dist/schemas/notifications.d.ts

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+export declare const notificationDetailsSchema: z.ZodObject<{
+    url: z.ZodString;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    token: string;
+}, {
+    url: string;
+    token: string;
+}>;
+export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>;
+export declare const sendNotificationRequestSchema: z.ZodObject<{
+    notificationId: z.ZodString;
+    title: z.ZodString;
+    body: z.ZodString;
+    targetUrl: z.ZodString;
+    tokens: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    notificationId: string;
+    body: string;
+    targetUrl: string;
+    tokens: string[];
+}, {
+    title: string;
+    notificationId: string;
+    body: string;
+    targetUrl: string;
+    tokens: string[];
+}>;
+export type SendNotificationRequest = z.infer<typeof sendNotificationRequestSchema>;
+export declare const sendNotificationResponseSchema: z.ZodObject<{
+    result: z.ZodObject<{
+        successfulTokens: z.ZodArray<z.ZodString, "many">;
+        invalidTokens: z.ZodArray<z.ZodString, "many">;
+        rateLimitedTokens: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    }, {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    result: {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    };
+}, {
+    result: {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    };
+}>;
+export type SendNotificationResponse = z.infer<typeof sendNotificationResponseSchema>;

package/dist/schemas/notifications.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendNotificationResponseSchema = exports.sendNotificationRequestSchema = exports.notificationDetailsSchema = void 0;
+const zod_1 = require("zod");
+const shared_1 = require("./shared");
+exports.notificationDetailsSchema = zod_1.z.object({
+    url: zod_1.z.string(),
+    token: zod_1.z.string(),
+});
+exports.sendNotificationRequestSchema = zod_1.z.object({
+    notificationId: zod_1.z.string().max(128),
+    title: zod_1.z.string().max(32),
+    body: zod_1.z.string().max(128),
+    targetUrl: shared_1.secureUrlSchema,
+    tokens: zod_1.z.string().array().max(100),
+});
+exports.sendNotificationResponseSchema = zod_1.z.object({
+    result: zod_1.z.object({
+        successfulTokens: zod_1.z.array(zod_1.z.string()),
+        invalidTokens: zod_1.z.array(zod_1.z.string()),
+        rateLimitedTokens: zod_1.z.array(zod_1.z.string()),
+    }),
+});

package/dist/schemas/shared.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+export declare const createSimpleStringSchema: ({ max, noSpaces, }?: {
+    max?: number;
+    noSpaces?: boolean;
+}) => z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
+export declare const secureUrlSchema: z.ZodString;
+export declare const frameNameSchema: z.ZodString;
+export declare const buttonTitleSchema: z.ZodString;
+export declare const caip19TokenSchema: z.ZodString;
+export declare const hexColorSchema: z.ZodString;
+export declare const aspectRatioSchema: z.ZodUnion<[z.ZodLiteral<"1:1">, z.ZodLiteral<"3:2">]>;
+export declare const encodedJsonFarcasterSignatureSchema: z.ZodObject<{
+    header: z.ZodString;
+    payload: z.ZodString;
+    signature: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    header: string;
+    payload: string;
+    signature: string;
+}, {
+    header: string;
+    payload: string;
+    signature: string;
+}>;
+export type EncodedJsonFarcasterSignatureSchema = z.infer<typeof encodedJsonFarcasterSignatureSchema>;
+export declare const jsonFarcasterSignatureHeaderSchema: z.ZodObject<{
+    fid: z.ZodNumber;
+    type: z.ZodLiteral<"app_key">;
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "app_key";
+    fid: number;
+    key: string;
+}, {
+    type: "app_key";
+    fid: number;
+    key: string;
+}>;
+export type JsonFarcasterSignatureHeaderSchema = z.infer<typeof jsonFarcasterSignatureHeaderSchema>;

package/dist/schemas/shared.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonFarcasterSignatureHeaderSchema = exports.encodedJsonFarcasterSignatureSchema = exports.aspectRatioSchema = exports.hexColorSchema = exports.caip19TokenSchema = exports.buttonTitleSchema = exports.frameNameSchema = exports.secureUrlSchema = exports.createSimpleStringSchema = void 0;
+const zod_1 = require("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;
+const createSimpleStringSchema = ({ max, noSpaces, } = {}) => {
+    const stringValidations = noSpaces
+        ? zod_1.z
+            .string()
+            .max(max ?? Number.POSITIVE_INFINITY)
+            .regex(/^\S*$/, 'Spaces are not allowed')
+        : zod_1.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',
+    });
+};
+exports.createSimpleStringSchema = createSimpleStringSchema;
+exports.secureUrlSchema = zod_1.z
+    .string()
+    .url()
+    .startsWith('https://', { message: 'Must be an https url' })
+    .max(1024);
+exports.frameNameSchema = zod_1.z.string().max(32);
+exports.buttonTitleSchema = zod_1.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)$/;
+exports.caip19TokenSchema = zod_1.z
+    .string()
+    .regex(CAIP_19_REGEX, { message: 'Invalid CAIP-19 asset ID' });
+exports.hexColorSchema = zod_1.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.',
+});
+exports.aspectRatioSchema = zod_1.z.union([zod_1.z.literal('1:1'), zod_1.z.literal('3:2')]);
+exports.encodedJsonFarcasterSignatureSchema = zod_1.z.object({
+    header: zod_1.z.string(),
+    payload: zod_1.z.string(),
+    signature: zod_1.z.string(),
+});
+exports.jsonFarcasterSignatureHeaderSchema = zod_1.z.object({
+    fid: zod_1.z.number(),
+    type: zod_1.z.literal('app_key'),
+    key: zod_1.z.string().startsWith('0x'),
+});

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+import type { AddFrame, ComposeCast, Ready, SendToken, SignIn, SwapToken, 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 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;
+    addFrame: AddFrame.WireAddFrame;
+    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>>;
+};
+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;
+    addFrame: AddFrame.AddFrame;
+    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>>;
+};
+export type EventFrameAddRejected = {
+    event: 'frame_add_rejected';
+    reason: AddFrame.AddFrameRejectedReason;
+};
+export type EventPrimaryButtonClicked = {
+    event: 'primary_button_clicked';
+};
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;

package/dist/types.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_READY_OPTIONS = void 0;
+// start backwards compat, remove in 1.0
+__exportStar(require("./wallet/ethereum"), exports);
+var Ready_1 = require("./actions/Ready");
+Object.defineProperty(exports, "DEFAULT_READY_OPTIONS", { enumerable: true, get: function () { return Ready_1.DEFAULT_READY_OPTIONS; } });

package/dist/wallet/ethereum.d.ts

@@ -0,0 +1,47 @@
+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}`;
+    name: string;
+    rdns: string;
+    uuid: string;
+}
+export type EventEip6963AnnounceProvider = {
+    event: 'eip6963:announceProvider';
+    info: EIP6963ProviderInfo;
+};

package/dist/wallet/ethereum.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/wallet/index.d.ts

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

package/dist/wallet/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ethereum = void 0;
+exports.Ethereum = __importStar(require("./ethereum"));

package/esm/actions/AddFrame.d.ts

@@ -0,0 +1,36 @@
+import * as Errors from '../errors';
+import type { OneOf } from '../internal/types';
+import type { FrameNotificationDetails } from '../schemas';
+export type AddFrameResult = {
+    notificationDetails?: FrameNotificationDetails;
+};
+export type AddFrame = () => Promise<AddFrameResult>;
+type InvalidDomainManifestJsonError = {
+    type: 'invalid_domain_manifest';
+};
+type RejectedByUserJsonError = {
+    type: 'rejected_by_user';
+};
+export type AddFrameJsonError = InvalidDomainManifestJsonError | RejectedByUserJsonError;
+export type AddFrameRejectedReason = AddFrameJsonError['type'];
+export type AddFrameJsonResult = OneOf<{
+    result: AddFrameResult;
+} | {
+    error: AddFrameJsonError;
+}>;
+export type WireAddFrame = () => Promise<AddFrameJsonResult>;
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+export declare class InvalidDomainManifest extends Errors.BaseError {
+    readonly name = "AddFrame.InvalidDomainManifest";
+    constructor();
+}
+/**
+ * Thrown when add frame action was rejected by the user.
+ */
+export declare class RejectedByUser extends Errors.BaseError {
+    readonly name = "AddFrame.RejectedByUser";
+    constructor();
+}
+export {};