@farcaster/frame-core 0.0.35 → 0.0.36

package/dist/actions/{AddFrame.d.ts → AddMiniApp.d.ts}

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

package/dist/actions/{AddFrame.js → AddMiniApp.js}

@@ -39,7 +39,7 @@ const Errors = __importStar(require("../errors"));
  * Thrown when the frame does not have a valid domain manifest.
  */
 class InvalidDomainManifest extends Errors.BaseError {
-    name = 'AddFrame.InvalidDomainManifest';
+    name = 'AddMiniApp.InvalidDomainManifest';
     constructor() {
         super('Invalid domain manifest');
     }
@@ -49,7 +49,7 @@ exports.InvalidDomainManifest = InvalidDomainManifest;
  * Thrown when add frame action was rejected by the user.
  */
 class RejectedByUser extends Errors.BaseError {
-    name = 'AddFrame.RejectedByUser';
+    name = 'AddMiniApp.RejectedByUser';
     constructor() {
         super('Add frame rejected by user');
     }

package/dist/actions/index.d.ts

@@ -1,4 +1,4 @@
-export * as AddFrame from './AddFrame';
+export * as AddMiniApp from './AddMiniApp';
 export * as ComposeCast from './ComposeCast';
 export * as Ready from './Ready';
 export * as SignIn from './SignIn';

package/dist/actions/index.js

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

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export * as Manifest from './manifest';
 export * from './types';
 export * from './schemas';
 export * from './solana';
+export * from './solanaWire';

package/dist/index.js

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

package/dist/solana.d.ts

@@ -1,5 +1,6 @@
-import type { Connection as SolanaConnection, SendOptions as SolanaSendOptions, Transaction as SolanaTransaction, VersionedTransaction as SolanaVersionedTransaction } from '@solana/web3.js';
-export type { SolanaConnection };
+import { Connection as SolanaConnection, type SendOptions as SolanaSendOptions, type Transaction as SolanaTransaction, type VersionedTransaction as SolanaVersionedTransaction } from '@solana/web3.js';
+export { SolanaConnection };
+export type { SolanaSendOptions };
 export type SolanaCombinedTransaction = SolanaTransaction | SolanaVersionedTransaction;
 export type SolanaConnectRequestArguments = {
     method: 'connect';
@@ -14,7 +15,6 @@ export type SolanaSignAndSendTransactionRequestArguments = {
     method: 'signAndSendTransaction';
     params: {
         transaction: SolanaCombinedTransaction;
-        connection: SolanaConnection;
         options?: SolanaSendOptions;
     };
 };
@@ -43,9 +43,30 @@ export interface SolanaWalletProvider {
     }>;
     signAndSendTransaction(input: {
         transaction: SolanaCombinedTransaction;
-        connection: SolanaConnection;
     }): Promise<{
         signature: string;
     }>;
 }
 export declare const createSolanaWalletProvider: (request: SolanaRequestFn) => SolanaWalletProvider;
+export type SolanaWireSignAndSendTransactionRequestArguments = {
+    method: 'signAndSendTransaction';
+    params: {
+        transaction: string;
+        options?: SolanaSendOptions;
+    };
+};
+export type SolanaWireSignTransactionRequestArguments = {
+    method: 'signTransaction';
+    params: {
+        transaction: string;
+    };
+};
+export type SolanaWireRequestFn = ((request: SolanaConnectRequestArguments) => Promise<{
+    publicKey: string;
+}>) & ((request: SolanaSignMessageRequestArguments) => Promise<{
+    signature: string;
+}>) & ((request: SolanaWireSignAndSendTransactionRequestArguments) => Promise<{
+    signature: string;
+}>) & ((request: SolanaWireSignTransactionRequestArguments) => Promise<{
+    signedTransaction: string;
+}>);

package/dist/solana.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSolanaWalletProvider = void 0;
+exports.createSolanaWalletProvider = exports.SolanaConnection = void 0;
+const web3_js_1 = require("@solana/web3.js");
+Object.defineProperty(exports, "SolanaConnection", { enumerable: true, get: function () { return web3_js_1.Connection; } });
 const createSolanaWalletProvider = (request) => ({
     request,
     signMessage: (msg) => request({ method: 'signMessage', params: { message: msg } }),

package/dist/solanaWire.d.ts

@@ -0,0 +1,3 @@
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana';
+export declare function wrapSolanaProviderRequest(requestFn: SolanaRequestFn): SolanaWireRequestFn;
+export declare function unwrapSolanaProviderRequest(wrappedRequestFn: SolanaWireRequestFn): SolanaRequestFn;

package/dist/solanaWire.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapSolanaProviderRequest = wrapSolanaProviderRequest;
+exports.unwrapSolanaProviderRequest = unwrapSolanaProviderRequest;
+const web3_js_1 = require("@solana/web3.js");
+function serializeTransaction(transaction) {
+    return Buffer.from(transaction.serialize({
+        verifySignatures: false,
+    })).toString('base64');
+}
+function unserializeTransaction(transaction) {
+    const bytes = Uint8Array.from(Buffer.from(transaction, 'base64'));
+    return (bytes[0] & 0x80) !== 0
+        ? web3_js_1.VersionedTransaction.deserialize(bytes)
+        : web3_js_1.Transaction.from(bytes);
+}
+function wrapSolanaProviderRequest(requestFn) {
+    const wrappedFn = async (request) => {
+        if (request.method === 'connect') {
+            return await requestFn(request);
+        }
+        if (request.method === 'signMessage') {
+            return await requestFn(request);
+        }
+        if (request.method === 'signAndSendTransaction') {
+            const { transaction, options } = request.params;
+            const params = {
+                transaction: unserializeTransaction(transaction),
+                options,
+            };
+            return await requestFn({
+                method: 'signAndSendTransaction',
+                params,
+            });
+        }
+        if (request.method === 'signTransaction') {
+            const { transaction } = request.params;
+            const params = {
+                transaction: unserializeTransaction(transaction),
+            };
+            const { signedTransaction } = await requestFn({
+                method: 'signTransaction',
+                params,
+            });
+            return {
+                signedTransaction: serializeTransaction(signedTransaction),
+            };
+        }
+    };
+    return wrappedFn;
+}
+function unwrapSolanaProviderRequest(wrappedRequestFn) {
+    const unwrappedFn = async (request) => {
+        if (request.method === 'connect') {
+            return await wrappedRequestFn(request);
+        }
+        if (request.method === 'signMessage') {
+            return await wrappedRequestFn(request);
+        }
+        if (request.method === 'signAndSendTransaction') {
+            const { transaction, options } = request.params;
+            const params = {
+                transaction: serializeTransaction(transaction),
+            };
+            return await wrappedRequestFn({
+                method: 'signAndSendTransaction',
+                params,
+            });
+        }
+        if (request.method === 'signTransaction') {
+            const { transaction } = request.params;
+            const params = {
+                transaction: serializeTransaction(transaction),
+            };
+            const { signedTransaction } = await wrappedRequestFn({
+                method: 'signTransaction',
+                params,
+            });
+            return { signedTransaction: unserializeTransaction(signedTransaction) };
+        }
+    };
+    return unwrappedFn;
+}

package/dist/types.d.ts

@@ -1,7 +1,7 @@
-import type { AddFrame, ComposeCast, Ready, SendToken, SignIn, SwapToken, ViewProfile, ViewToken } from './actions';
+import type { AddMiniApp, 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 { SolanaRequestFn, SolanaWireRequestFn } from './solana';
 import type { Ethereum } from './wallet';
 export type SetPrimaryButtonOptions = {
     text: string;
@@ -13,6 +13,8 @@ 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 MiniAppHostCapability = 'wallet.getEvmProvider' | 'wallet.getSolanaProvider' | 'actions.ready' | 'actions.openUrl' | 'actions.close' | 'actions.setPrimaryButton' | 'actions.addMiniApp' | 'actions.signIn' | 'actions.viewProfile' | 'actions.composeCast' | 'actions.viewToken' | 'actions.sendToken' | 'actions.swapToken';
+export type GetCapabilities = () => Promise<MiniAppHostCapability[]>;
 export type WireFrameHost = {
     context: FrameContext;
     close: () => void;
@@ -23,13 +25,14 @@ export type WireFrameHost = {
     ethProviderRequest: Ethereum.EthProvideRequest;
     ethProviderRequestV2: Ethereum.RpcTransport;
     eip6963RequestProvider: () => void;
-    solanaProviderRequest?: SolanaRequestFn;
-    addFrame: AddFrame.WireAddFrame;
+    solanaProviderRequest?: SolanaWireRequestFn;
+    addFrame: AddMiniApp.WireAddMiniApp;
     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>>;
+    getCapabilities: GetCapabilities;
 };
 export type FrameHost = {
     context: FrameContext;
@@ -46,16 +49,17 @@ export type FrameHost = {
      */
     eip6963RequestProvider: () => void;
     solanaProviderRequest?: SolanaRequestFn;
-    addFrame: AddFrame.AddFrame;
+    addFrame: AddMiniApp.AddMiniApp;
     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>>;
+    getCapabilities: GetCapabilities;
 };
 export type EventFrameAddRejected = {
     event: 'frame_add_rejected';
-    reason: AddFrame.AddFrameRejectedReason;
+    reason: AddMiniApp.AddMiniAppRejectedReason;
 };
 export type EventPrimaryButtonClicked = {
     event: 'primary_button_clicked';

package/esm/actions/{AddFrame.d.ts → AddMiniApp.d.ts}

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

package/esm/actions/{AddFrame.js → AddMiniApp.js}

@@ -3,7 +3,7 @@ import * as Errors from '../errors';
  * Thrown when the frame does not have a valid domain manifest.
  */
 export class InvalidDomainManifest extends Errors.BaseError {
-    name = 'AddFrame.InvalidDomainManifest';
+    name = 'AddMiniApp.InvalidDomainManifest';
     constructor() {
         super('Invalid domain manifest');
     }
@@ -12,7 +12,7 @@ export class InvalidDomainManifest extends Errors.BaseError {
  * Thrown when add frame action was rejected by the user.
  */
 export class RejectedByUser extends Errors.BaseError {
-    name = 'AddFrame.RejectedByUser';
+    name = 'AddMiniApp.RejectedByUser';
     constructor() {
         super('Add frame rejected by user');
     }

package/esm/actions/index.d.ts

@@ -1,4 +1,4 @@
-export * as AddFrame from './AddFrame';
+export * as AddMiniApp from './AddMiniApp';
 export * as ComposeCast from './ComposeCast';
 export * as Ready from './Ready';
 export * as SignIn from './SignIn';

package/esm/actions/index.js

@@ -1,4 +1,4 @@
-export * as AddFrame from './AddFrame';
+export * as AddMiniApp from './AddMiniApp';
 export * as ComposeCast from './ComposeCast';
 export * as Ready from './Ready';
 export * as SignIn from './SignIn';

package/esm/index.d.ts

@@ -6,3 +6,4 @@ export * as Manifest from './manifest';
 export * from './types';
 export * from './schemas';
 export * from './solana';
+export * from './solanaWire';

package/esm/index.js

@@ -6,3 +6,4 @@ export * as Manifest from './manifest';
 export * from './types';
 export * from './schemas';
 export * from './solana';
+export * from './solanaWire';

package/esm/solana.d.ts

@@ -1,5 +1,6 @@
-import type { Connection as SolanaConnection, SendOptions as SolanaSendOptions, Transaction as SolanaTransaction, VersionedTransaction as SolanaVersionedTransaction } from '@solana/web3.js';
-export type { SolanaConnection };
+import { Connection as SolanaConnection, type SendOptions as SolanaSendOptions, type Transaction as SolanaTransaction, type VersionedTransaction as SolanaVersionedTransaction } from '@solana/web3.js';
+export { SolanaConnection };
+export type { SolanaSendOptions };
 export type SolanaCombinedTransaction = SolanaTransaction | SolanaVersionedTransaction;
 export type SolanaConnectRequestArguments = {
     method: 'connect';
@@ -14,7 +15,6 @@ export type SolanaSignAndSendTransactionRequestArguments = {
     method: 'signAndSendTransaction';
     params: {
         transaction: SolanaCombinedTransaction;
-        connection: SolanaConnection;
         options?: SolanaSendOptions;
     };
 };
@@ -43,9 +43,30 @@ export interface SolanaWalletProvider {
     }>;
     signAndSendTransaction(input: {
         transaction: SolanaCombinedTransaction;
-        connection: SolanaConnection;
     }): Promise<{
         signature: string;
     }>;
 }
 export declare const createSolanaWalletProvider: (request: SolanaRequestFn) => SolanaWalletProvider;
+export type SolanaWireSignAndSendTransactionRequestArguments = {
+    method: 'signAndSendTransaction';
+    params: {
+        transaction: string;
+        options?: SolanaSendOptions;
+    };
+};
+export type SolanaWireSignTransactionRequestArguments = {
+    method: 'signTransaction';
+    params: {
+        transaction: string;
+    };
+};
+export type SolanaWireRequestFn = ((request: SolanaConnectRequestArguments) => Promise<{
+    publicKey: string;
+}>) & ((request: SolanaSignMessageRequestArguments) => Promise<{
+    signature: string;
+}>) & ((request: SolanaWireSignAndSendTransactionRequestArguments) => Promise<{
+    signature: string;
+}>) & ((request: SolanaWireSignTransactionRequestArguments) => Promise<{
+    signedTransaction: string;
+}>);

package/esm/solana.js

@@ -1,3 +1,5 @@
+import { Connection as SolanaConnection, } from '@solana/web3.js';
+export { SolanaConnection };
 export const createSolanaWalletProvider = (request) => ({
     request,
     signMessage: (msg) => request({ method: 'signMessage', params: { message: msg } }),

package/esm/solanaWire.d.ts

@@ -0,0 +1,3 @@
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana';
+export declare function wrapSolanaProviderRequest(requestFn: SolanaRequestFn): SolanaWireRequestFn;
+export declare function unwrapSolanaProviderRequest(wrappedRequestFn: SolanaWireRequestFn): SolanaRequestFn;

package/esm/solanaWire.js

@@ -0,0 +1,79 @@
+import { Transaction as SolanaTransaction, VersionedTransaction as SolanaVersionedTransaction, } from '@solana/web3.js';
+function serializeTransaction(transaction) {
+    return Buffer.from(transaction.serialize({
+        verifySignatures: false,
+    })).toString('base64');
+}
+function unserializeTransaction(transaction) {
+    const bytes = Uint8Array.from(Buffer.from(transaction, 'base64'));
+    return (bytes[0] & 0x80) !== 0
+        ? SolanaVersionedTransaction.deserialize(bytes)
+        : SolanaTransaction.from(bytes);
+}
+export function wrapSolanaProviderRequest(requestFn) {
+    const wrappedFn = async (request) => {
+        if (request.method === 'connect') {
+            return await requestFn(request);
+        }
+        if (request.method === 'signMessage') {
+            return await requestFn(request);
+        }
+        if (request.method === 'signAndSendTransaction') {
+            const { transaction, options } = request.params;
+            const params = {
+                transaction: unserializeTransaction(transaction),
+                options,
+            };
+            return await requestFn({
+                method: 'signAndSendTransaction',
+                params,
+            });
+        }
+        if (request.method === 'signTransaction') {
+            const { transaction } = request.params;
+            const params = {
+                transaction: unserializeTransaction(transaction),
+            };
+            const { signedTransaction } = await requestFn({
+                method: 'signTransaction',
+                params,
+            });
+            return {
+                signedTransaction: serializeTransaction(signedTransaction),
+            };
+        }
+    };
+    return wrappedFn;
+}
+export function unwrapSolanaProviderRequest(wrappedRequestFn) {
+    const unwrappedFn = async (request) => {
+        if (request.method === 'connect') {
+            return await wrappedRequestFn(request);
+        }
+        if (request.method === 'signMessage') {
+            return await wrappedRequestFn(request);
+        }
+        if (request.method === 'signAndSendTransaction') {
+            const { transaction, options } = request.params;
+            const params = {
+                transaction: serializeTransaction(transaction),
+            };
+            return await wrappedRequestFn({
+                method: 'signAndSendTransaction',
+                params,
+            });
+        }
+        if (request.method === 'signTransaction') {
+            const { transaction } = request.params;
+            const params = {
+                transaction: serializeTransaction(transaction),
+            };
+            const { signedTransaction } = await wrappedRequestFn({
+                method: 'signTransaction',
+                params,
+            });
+            return { signedTransaction: unserializeTransaction(signedTransaction) };
+        }
+    };
+    return unwrappedFn;
+}