@farcaster/frame-core 0.0.0-canary-20250509164556 → 0.0.0-canary-20250510204457

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

@@ -9,13 +9,13 @@ import type {
   ViewToken,
 } from './actions'
 import type { FrameContext } from './context'
-import type { ShareStateProvider } from './funcs'
 import type {
   EventFrameAdded,
   EventFrameRemoved,
   EventNotificationsDisabled,
   EventNotificationsEnabled,
 } from './schemas'
+import type { SolanaRequestFn } from './solana'
 import type { Ethereum } from './wallet'
 
 export type SetPrimaryButtonOptions = {
@@ -43,6 +43,7 @@ export type WireFrameHost = {
   ethProviderRequest: Ethereum.EthProvideRequest
   ethProviderRequestV2: Ethereum.RpcTransport
   eip6963RequestProvider: () => void
+  solanaProviderRequest?: SolanaRequestFn
   addFrame: AddFrame.WireAddFrame
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
@@ -51,7 +52,6 @@ export type WireFrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
-  setShareStateProvider: (fn: ShareStateProvider) => void
 }
 
 export type FrameHost = {
@@ -68,6 +68,7 @@ export type FrameHost = {
    * Hosts must emit an EventEip6963AnnounceProvider in response.
    */
   eip6963RequestProvider: () => void
+  solanaProviderRequest?: SolanaRequestFn
   addFrame: AddFrame.AddFrame
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
@@ -76,7 +77,6 @@ export type FrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
-  setShareStateProvider: (fn: ShareStateProvider) => void
 }
 
 export type EventFrameAddRejected = {

package/dist/funcs.d.ts

@@ -1,20 +0,0 @@
-import type { z } from 'zod';
-import type { sharedStateSchema } from './schemas/funcs';
-/**
- * State used by the host when constructing the mini app URL to be shared.
- *
- * path: The path to be added to the mini app URL when shared. Added either to
- * the `homeUrl` specified in the manifest or the URL of an mini app embed
- * shared on the feed.
- *
- * e.g. `'/specific/miniapp/screen'` (can set `window.location.pathname` directly).
- *
- * params: Query parms to be added to the mini app URL when shared. Compatible with
- * URLSearchParams constructor parameters.
- *
- * Either a key-value pair e.g. `{ foo: 'bar' }`, a string e.g. `'foo=bar'`,
- * or an array of arrays e.g. `[['foo', 'bar'], ['baz', 'qux']]`
- * (can set `window.location.search` directly).
- */
-export type ShareState = z.infer<typeof sharedStateSchema>;
-export type ShareStateProvider = () => ShareState | Promise<ShareState>;

package/dist/funcs.js

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

package/dist/schemas/funcs.d.ts

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-export declare const sharedStateSchema: z.ZodObject<{
-    path: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
-    params: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodString>, z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">]>>;
-}, "strip", z.ZodTypeAny, {
-    params?: string | Record<string, string> | string[][] | undefined;
-    path?: string | undefined;
-}, {
-    params?: string | Record<string, string> | string[][] | undefined;
-    path?: string | undefined;
-}>;

package/dist/schemas/funcs.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sharedStateSchema = void 0;
-const zod_1 = require("zod");
-const isUrlEncoded = (val) => {
-    if (val === '')
-        return true;
-    try {
-        return encodeURIComponent(decodeURIComponent(val)) === val;
-    }
-    catch (e) {
-        return false;
-    }
-};
-exports.sharedStateSchema = zod_1.z.object({
-    path: zod_1.z
-        .string()
-        .refine((pathStr) => {
-        if (pathStr === '')
-            return true;
-        if (!pathStr.startsWith('/'))
-            return false;
-        if (pathStr.includes('?') || pathStr.includes('#'))
-            return false;
-        if (pathStr === '/') {
-            return true;
-        }
-        const segments = pathStr.substring(1).split('/');
-        for (let i = 0; i < segments.length; i++) {
-            const segment = segments[i];
-            if (segment === '') {
-                if (i < segments.length - 1) {
-                    return false;
-                }
-                return true;
-            }
-            if (!isUrlEncoded(segment)) {
-                return false;
-            }
-        }
-        return true;
-    }, {
-        message: 'Path must be a valid URL-encoded path string, starting with / (e.g., /foo/bar), or an empty string. Consecutive slashes (e.g., /foo//bar) are not allowed.',
-    })
-        .optional(),
-    params: zod_1.z
-        .union([
-        zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
-        zod_1.z.string().refine((queryStr) => {
-            const str = queryStr.startsWith('?')
-                ? queryStr.substring(1)
-                : queryStr;
-            if (str === '')
-                return true;
-            if (str.includes('&&')) {
-                if (str !== '&&')
-                    return false;
-            }
-            const pairs = str.split('&');
-            for (const pair of pairs) {
-                const parts = pair.split('=', 2);
-                const key = parts[0];
-                if (!isUrlEncoded(key))
-                    return false;
-                if (parts.length > 1) {
-                    const value = parts[1];
-                    if (!isUrlEncoded(value))
-                        return false;
-                }
-            }
-            return true;
-        }, {
-            message: "Query string must be a valid URL-encoded query string (e.g., 'foo=bar%20baz&key=val' or '?name=value'). Both keys and values must be URL-encoded.",
-        }),
-        zod_1.z.array(zod_1.z.array(zod_1.z.string())),
-    ])
-        .optional(),
-});

package/esm/funcs.d.ts

@@ -1,20 +0,0 @@
-import type { z } from 'zod';
-import type { sharedStateSchema } from './schemas/funcs';
-/**
- * State used by the host when constructing the mini app URL to be shared.
- *
- * path: The path to be added to the mini app URL when shared. Added either to
- * the `homeUrl` specified in the manifest or the URL of an mini app embed
- * shared on the feed.
- *
- * e.g. `'/specific/miniapp/screen'` (can set `window.location.pathname` directly).
- *
- * params: Query parms to be added to the mini app URL when shared. Compatible with
- * URLSearchParams constructor parameters.
- *
- * Either a key-value pair e.g. `{ foo: 'bar' }`, a string e.g. `'foo=bar'`,
- * or an array of arrays e.g. `[['foo', 'bar'], ['baz', 'qux']]`
- * (can set `window.location.search` directly).
- */
-export type ShareState = z.infer<typeof sharedStateSchema>;
-export type ShareStateProvider = () => ShareState | Promise<ShareState>;

package/esm/funcs.js

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

package/esm/schemas/funcs.d.ts

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-export declare const sharedStateSchema: z.ZodObject<{
-    path: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
-    params: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodString>, z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">]>>;
-}, "strip", z.ZodTypeAny, {
-    params?: string | Record<string, string> | string[][] | undefined;
-    path?: string | undefined;
-}, {
-    params?: string | Record<string, string> | string[][] | undefined;
-    path?: string | undefined;
-}>;

package/esm/schemas/funcs.js

@@ -1,75 +0,0 @@
-import { z } from 'zod';
-const isUrlEncoded = (val) => {
-    if (val === '')
-        return true;
-    try {
-        return encodeURIComponent(decodeURIComponent(val)) === val;
-    }
-    catch (e) {
-        return false;
-    }
-};
-export const sharedStateSchema = z.object({
-    path: z
-        .string()
-        .refine((pathStr) => {
-        if (pathStr === '')
-            return true;
-        if (!pathStr.startsWith('/'))
-            return false;
-        if (pathStr.includes('?') || pathStr.includes('#'))
-            return false;
-        if (pathStr === '/') {
-            return true;
-        }
-        const segments = pathStr.substring(1).split('/');
-        for (let i = 0; i < segments.length; i++) {
-            const segment = segments[i];
-            if (segment === '') {
-                if (i < segments.length - 1) {
-                    return false;
-                }
-                return true;
-            }
-            if (!isUrlEncoded(segment)) {
-                return false;
-            }
-        }
-        return true;
-    }, {
-        message: 'Path must be a valid URL-encoded path string, starting with / (e.g., /foo/bar), or an empty string. Consecutive slashes (e.g., /foo//bar) are not allowed.',
-    })
-        .optional(),
-    params: z
-        .union([
-        z.record(z.string(), z.string()),
-        z.string().refine((queryStr) => {
-            const str = queryStr.startsWith('?')
-                ? queryStr.substring(1)
-                : queryStr;
-            if (str === '')
-                return true;
-            if (str.includes('&&')) {
-                if (str !== '&&')
-                    return false;
-            }
-            const pairs = str.split('&');
-            for (const pair of pairs) {
-                const parts = pair.split('=', 2);
-                const key = parts[0];
-                if (!isUrlEncoded(key))
-                    return false;
-                if (parts.length > 1) {
-                    const value = parts[1];
-                    if (!isUrlEncoded(value))
-                        return false;
-                }
-            }
-            return true;
-        }, {
-            message: "Query string must be a valid URL-encoded query string (e.g., 'foo=bar%20baz&key=val' or '?name=value'). Both keys and values must be URL-encoded.",
-        }),
-        z.array(z.array(z.string())),
-    ])
-        .optional(),
-});

package/src/funcs.ts

@@ -1,22 +0,0 @@
-import type { z } from 'zod'
-import type { sharedStateSchema } from './schemas/funcs'
-
-/**
- * State used by the host when constructing the mini app URL to be shared.
- *
- * path: The path to be added to the mini app URL when shared. Added either to
- * the `homeUrl` specified in the manifest or the URL of an mini app embed
- * shared on the feed.
- *
- * e.g. `'/specific/miniapp/screen'` (can set `window.location.pathname` directly).
- *
- * params: Query parms to be added to the mini app URL when shared. Compatible with
- * URLSearchParams constructor parameters.
- *
- * Either a key-value pair e.g. `{ foo: 'bar' }`, a string e.g. `'foo=bar'`,
- * or an array of arrays e.g. `[['foo', 'bar'], ['baz', 'qux']]`
- * (can set `window.location.search` directly).
- */
-export type ShareState = z.infer<typeof sharedStateSchema>
-
-export type ShareStateProvider = () => ShareState | Promise<ShareState>

package/src/schemas/funcs.ts

@@ -1,83 +0,0 @@
-import { z } from 'zod'
-
-const isUrlEncoded = (val: string): boolean => {
-  if (val === '') return true
-  try {
-    return encodeURIComponent(decodeURIComponent(val)) === val
-  } catch (e) {
-    return false
-  }
-}
-
-export const sharedStateSchema = z.object({
-  path: z
-    .string()
-    .refine(
-      (pathStr) => {
-        if (pathStr === '') return true
-        if (!pathStr.startsWith('/')) return false
-        if (pathStr.includes('?') || pathStr.includes('#')) return false
-
-        if (pathStr === '/') {
-          return true
-        }
-
-        const segments = pathStr.substring(1).split('/')
-        for (let i = 0; i < segments.length; i++) {
-          const segment = segments[i]
-          if (segment === '') {
-            if (i < segments.length - 1) {
-              return false
-            }
-            return true
-          }
-          if (!isUrlEncoded(segment)) {
-            return false
-          }
-        }
-        return true
-      },
-      {
-        message:
-          'Path must be a valid URL-encoded path string, starting with / (e.g., /foo/bar), or an empty string. Consecutive slashes (e.g., /foo//bar) are not allowed.',
-      },
-    )
-    .optional(),
-  params: z
-    .union([
-      z.record(z.string(), z.string()),
-      z.string().refine(
-        (queryStr) => {
-          const str = queryStr.startsWith('?')
-            ? queryStr.substring(1)
-            : queryStr
-          if (str === '') return true
-
-          if (str.includes('&&')) {
-            if (str !== '&&') return false
-          }
-
-          const pairs = str.split('&')
-
-          for (const pair of pairs) {
-            const parts = pair.split('=', 2)
-            const key = parts[0]
-
-            if (!isUrlEncoded(key)) return false
-
-            if (parts.length > 1) {
-              const value = parts[1]
-              if (!isUrlEncoded(value)) return false
-            }
-          }
-          return true
-        },
-        {
-          message:
-            "Query string must be a valid URL-encoded query string (e.g., 'foo=bar%20baz&key=val' or '?name=value'). Both keys and values must be URL-encoded.",
-        },
-      ),
-      z.array(z.array(z.string())),
-    ])
-    .optional(),
-})