@farcaster/frame-core 0.0.33 → 0.0.35

package/dist/actions/ComposeCast.d.ts

@@ -2,7 +2,7 @@ export type Options<close extends boolean | undefined = undefined> = {
     /**
      * Suggested text for the body of the cast.
      *
-     * Mentions can be included using the human-writeable form (e.g. @farcaster).
+     * Mentions can be included using the human-writable form (e.g. @farcaster).
      **/
     text?: string;
     /** Suggested embeds. Max two. */

package/dist/actions/SendToken.d.ts

@@ -0,0 +1,48 @@
+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>;
+export {};

package/dist/actions/SignIn.d.ts

@@ -15,10 +15,24 @@ 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>;
 type RejectedByUserJsonError = {

package/dist/actions/{Swap.d.ts → SwapToken.d.ts}

@@ -1,4 +1,4 @@
-export type SwapOptions = {
+export type SwapTokenOptions = {
     /**
      * CAIP-19 asset ID
      * For example, Base USDC:
@@ -12,18 +12,18 @@ export type SwapOptions = {
     buyToken?: string;
     /**
      * 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.
      */
     transactions: `0x${string}`[];
 };
-type SwapErrorDetails = {
+type SwapTokenErrorDetails = {
     /**
      * Error code.
      */
@@ -34,13 +34,13 @@ type SwapErrorDetails = {
     message?: string;
 };
 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>;
 export {};

package/dist/actions/SwapToken.js

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

package/dist/actions/index.d.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/dist/actions/index.js

@@ -33,11 +33,12 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewToken = exports.ViewProfile = exports.Swap = exports.SignIn = exports.Ready = exports.ComposeCast = exports.AddFrame = void 0;
+exports.ViewToken = exports.ViewProfile = exports.SwapToken = exports.SendToken = exports.SignIn = exports.Ready = exports.ComposeCast = exports.AddFrame = void 0;
 exports.AddFrame = __importStar(require("./AddFrame"));
 exports.ComposeCast = __importStar(require("./ComposeCast"));
 exports.Ready = __importStar(require("./Ready"));
 exports.SignIn = __importStar(require("./SignIn"));
-exports.Swap = __importStar(require("./Swap"));
+exports.SendToken = __importStar(require("./SendToken"));
+exports.SwapToken = __importStar(require("./SwapToken"));
 exports.ViewProfile = __importStar(require("./ViewProfile"));
 exports.ViewToken = __importStar(require("./ViewToken"));

package/dist/index.d.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/dist/index.js

@@ -44,3 +44,4 @@ exports.Context = __importStar(require("./context"));
 exports.Manifest = __importStar(require("./manifest"));
 __exportStar(require("./types"), exports);
 __exportStar(require("./schemas"), exports);
+__exportStar(require("./solana"), exports);

package/dist/solana.d.ts

@@ -0,0 +1,51 @@
+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 declare const createSolanaWalletProvider: (request: SolanaRequestFn) => SolanaWalletProvider;

package/dist/solana.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSolanaWalletProvider = void 0;
+const createSolanaWalletProvider = (request) => ({
+    request,
+    signMessage: (msg) => request({ method: 'signMessage', params: { message: msg } }),
+    signTransaction: (transaction) => request({ method: 'signTransaction', params: { transaction } }),
+    signAndSendTransaction: (input) => request({
+        method: 'signAndSendTransaction',
+        params: input,
+    }),
+});
+exports.createSolanaWalletProvider = createSolanaWalletProvider;

package/dist/types.d.ts

@@ -1,6 +1,7 @@
-import type { AddFrame, ComposeCast, Ready, SignIn, Swap, ViewProfile, ViewToken } from './actions';
+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 { SolanaRequestFn } from './solana';
 import type { Ethereum } from './wallet';
 export type SetPrimaryButtonOptions = {
     text: string;
@@ -22,10 +23,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>>;
 };
 export type FrameHost = {
@@ -42,10 +45,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>>;
 };
 export type EventFrameAddRejected = {

package/esm/actions/ComposeCast.d.ts

@@ -2,7 +2,7 @@ export type Options<close extends boolean | undefined = undefined> = {
     /**
      * Suggested text for the body of the cast.
      *
-     * Mentions can be included using the human-writeable form (e.g. @farcaster).
+     * Mentions can be included using the human-writable form (e.g. @farcaster).
      **/
     text?: string;
     /** Suggested embeds. Max two. */

package/esm/actions/SendToken.d.ts

@@ -0,0 +1,48 @@
+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>;
+export {};

package/esm/actions/SignIn.d.ts

@@ -15,10 +15,24 @@ 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>;
 type RejectedByUserJsonError = {

package/esm/actions/{Swap.d.ts → SwapToken.d.ts}

@@ -1,4 +1,4 @@
-export type SwapOptions = {
+export type SwapTokenOptions = {
     /**
      * CAIP-19 asset ID
      * For example, Base USDC:
@@ -12,18 +12,18 @@ export type SwapOptions = {
     buyToken?: string;
     /**
      * 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.
      */
     transactions: `0x${string}`[];
 };
-type SwapErrorDetails = {
+type SwapTokenErrorDetails = {
     /**
      * Error code.
      */
@@ -34,13 +34,13 @@ type SwapErrorDetails = {
     message?: string;
 };
 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>;
 export {};

package/esm/actions/SwapToken.js

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

package/esm/actions/index.d.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/esm/actions/index.js

@@ -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/esm/index.d.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/esm/index.js

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

package/esm/solana.d.ts

@@ -0,0 +1,51 @@
+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 declare const createSolanaWalletProvider: (request: SolanaRequestFn) => SolanaWalletProvider;

package/esm/solana.js

@@ -0,0 +1,9 @@
+export const createSolanaWalletProvider = (request) => ({
+    request,
+    signMessage: (msg) => request({ method: 'signMessage', params: { message: msg } }),
+    signTransaction: (transaction) => request({ method: 'signTransaction', params: { transaction } }),
+    signAndSendTransaction: (input) => request({
+        method: 'signAndSendTransaction',
+        params: input,
+    }),
+});