@farcaster/frame-core 0.0.27 → 0.0.29

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Merkle Manufactory Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/actions/Ready.d.ts

@@ -0,0 +1,13 @@
+export type ReadyOptions = {
+    /**
+     * Disable native gestures. Use this option if your frame uses gestures
+     * that conflict with native gestures.
+     *
+     * @defaultValue false
+     */
+    disableNativeGestures: boolean;
+};
+export declare const DEFAULT_READY_OPTIONS: {
+    disableNativeGestures: false;
+};
+export type Ready = (options?: Partial<ReadyOptions>) => void;

package/dist/actions/Ready.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_READY_OPTIONS = void 0;
+exports.DEFAULT_READY_OPTIONS = {
+    disableNativeGestures: false,
+};

package/dist/actions/index.d.ts

@@ -1,5 +1,6 @@
 export * as AddFrame from './AddFrame';
-export * as ViewProfile from './ViewProfile';
-export * as ViewToken from './ViewToken';
+export * as Ready from './Ready';
 export * as SignIn from './SignIn';
 export * as Swap from './Swap';
+export * as ViewProfile from './ViewProfile';
+export * as ViewToken from './ViewToken';

package/dist/actions/index.js

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

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './actions';
+export * from './wallet';
 export * as Context from './context';
 export * from './types';
 export * from './schemas';

package/dist/index.js

@@ -38,6 +38,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
 __exportStar(require("./actions"), exports);
+__exportStar(require("./wallet"), exports);
 exports.Context = __importStar(require("./context"));
 __exportStar(require("./types"), exports);
 __exportStar(require("./schemas"), exports);

package/dist/types.d.ts

@@ -1,50 +1,26 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
-import type { AddFrame, SignIn, Swap, ViewProfile, ViewToken } from './actions';
+import type { AddFrame, Ready, SignIn, Swap, 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 EthProviderRequest = Provider.RequestFn<RpcSchema.Default>;
-export type ReadyOptions = {
-    /**
-     * Disable native gestures. Use this option if your frame uses gestures
-     * that conflict with native gestures.
-     *
-     * @defaultValue false
-     */
-    disableNativeGestures: boolean;
-};
-export declare const DEFAULT_READY_OPTIONS: ReadyOptions;
-export type SignInOptions = {
-    /**
-     * A random string used to prevent replay attacks.
-     */
-    nonce: string;
-    /**
-     * Start time at which the signature becomes valid.
-     * ISO 8601 datetime.
-     */
-    notBefore?: string;
-    /**
-     * Expiration time at which the signature is no longer valid.
-     * ISO 8601 datetime.
-     */
-    expirationTime?: string;
-};
 export type WireFrameHost = {
     context: FrameContext;
     close: () => void;
-    ready: (options?: Partial<ReadyOptions>) => void;
+    ready: Ready.Ready;
     openUrl: (url: string) => void;
     signIn: SignIn.WireSignIn;
     setPrimaryButton: SetPrimaryButton;
-    ethProviderRequest: EthProviderRequest;
-    ethProviderRequestV2: RpcTransport;
+    ethProviderRequest: Ethereum.EthProvideRequest;
+    ethProviderRequestV2: Ethereum.RpcTransport;
     eip6963RequestProvider: () => void;
     addFrame: AddFrame.WireAddFrame;
     viewProfile: ViewProfile.ViewProfile;
@@ -54,12 +30,12 @@ export type WireFrameHost = {
 export type FrameHost = {
     context: FrameContext;
     close: () => void;
-    ready: (options?: Partial<ReadyOptions>) => void;
+    ready: Ready.Ready;
     openUrl: (url: string) => void;
     signIn: SignIn.SignIn;
     setPrimaryButton: SetPrimaryButton;
-    ethProviderRequest: EthProviderRequest;
-    ethProviderRequestV2: RpcTransport;
+    ethProviderRequest: Ethereum.EthProvideRequest;
+    ethProviderRequestV2: Ethereum.RpcTransport;
     /**
      * Receive forwarded eip6963:requestProvider events from the frame document.
      * Hosts must emit an EventEip6963AnnounceProvider in response.
@@ -70,34 +46,6 @@ export type FrameHost = {
     viewToken: ViewToken.ViewToken;
     swap: Swap.Swap;
 };
-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;
 export type EventFrameAddRejected = {
     event: 'frame_add_rejected';
     reason: AddFrame.AddFrameRejectedReason;
@@ -105,17 +53,4 @@ export type EventFrameAddRejected = {
 export type EventPrimaryButtonClicked = {
     event: 'primary_button_clicked';
 };
-/**
- * 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;
-};
-export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | EventEip6963AnnounceProvider;
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;

package/dist/types.js

@@ -1,6 +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;
-exports.DEFAULT_READY_OPTIONS = {
-    disableNativeGestures: false,
-};
+// 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,43 @@
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
+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

@@ -1,36 +1,40 @@
-import * as Errors from '../errors';
-import type { OneOf } from '../internal/types';
-import type { FrameNotificationDetails } from '../schemas';
+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>;
+  notificationDetails?: FrameNotificationDetails
+}
+export type AddFrame = () => Promise<AddFrameResult>
 type InvalidDomainManifestJsonError = {
-    type: 'invalid_domain_manifest';
-};
+  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>;
+  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();
+  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();
+  readonly name = 'AddFrame.RejectedByUser'
+  constructor()
 }
-export {};

package/esm/actions/AddFrame.js

@@ -1,19 +1,19 @@
-import * as Errors from '../errors';
+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';
-    constructor() {
-        super('Invalid domain manifest');
-    }
+  name = 'AddFrame.InvalidDomainManifest'
+  constructor() {
+    super('Invalid domain manifest')
+  }
 }
 /**
  * Thrown when add frame action was rejected by the user.
  */
 export class RejectedByUser extends Errors.BaseError {
-    name = 'AddFrame.RejectedByUser';
-    constructor() {
-        super('Add frame rejected by user');
-    }
+  name = 'AddFrame.RejectedByUser'
+  constructor() {
+    super('Add frame rejected by user')
+  }
 }

package/esm/actions/Ready.d.ts

@@ -0,0 +1,13 @@
+export type ReadyOptions = {
+  /**
+   * Disable native gestures. Use this option if your frame uses gestures
+   * that conflict with native gestures.
+   *
+   * @defaultValue false
+   */
+  disableNativeGestures: boolean
+}
+export declare const DEFAULT_READY_OPTIONS: {
+  disableNativeGestures: false
+}
+export type Ready = (options?: Partial<ReadyOptions>) => void

package/esm/actions/Ready.js

@@ -0,0 +1,3 @@
+export const DEFAULT_READY_OPTIONS = {
+  disableNativeGestures: false,
+}

package/esm/actions/SignIn.d.ts

@@ -1,41 +1,43 @@
-import * as Errors from '../errors';
-import type { OneOf } from '../internal/types';
+import * as Errors from '../errors'
+import type { OneOf } from '../internal/types'
 export type SignInOptions = {
-    /**
-     * A random string used to prevent replay attacks.
-     */
-    nonce: string;
-    /**
-     * Start time at which the signature becomes valid.
-     * ISO 8601 datetime.
-     */
-    notBefore?: string;
-    /**
-     * Expiration time at which the signature is no longer valid.
-     * ISO 8601 datetime.
-     */
-    expirationTime?: string;
-};
+  /**
+   * A random string used to prevent replay attacks.
+   */
+  nonce: string
+  /**
+   * Start time at which the signature becomes valid.
+   * ISO 8601 datetime.
+   */
+  notBefore?: string
+  /**
+   * Expiration time at which the signature is no longer valid.
+   * ISO 8601 datetime.
+   */
+  expirationTime?: string
+}
 export type SignInResult = {
-    signature: string;
-    message: string;
-};
-export type SignIn = (options: SignInOptions) => Promise<SignInResult>;
+  signature: string
+  message: string
+}
+export type SignIn = (options: SignInOptions) => Promise<SignInResult>
 type RejectedByUserJsonError = {
-    type: 'rejected_by_user';
-};
-export type SignInJsonError = RejectedByUserJsonError;
-export type SignInJsonResult = OneOf<{
-    result: SignInResult;
-} | {
-    error: SignInJsonError;
-}>;
-export type WireSignIn = (options: SignInOptions) => Promise<SignInJsonResult>;
+  type: 'rejected_by_user'
+}
+export type SignInJsonError = RejectedByUserJsonError
+export type SignInJsonResult = OneOf<
+  | {
+      result: SignInResult
+    }
+  | {
+      error: SignInJsonError
+    }
+>
+export type WireSignIn = (options: SignInOptions) => Promise<SignInJsonResult>
 /**
  * Thrown when a sign in action was rejected.
  */
 export declare class RejectedByUser extends Errors.BaseError {
-    readonly name = "SignIn.RejectedByUser";
-    constructor();
+  readonly name = 'SignIn.RejectedByUser'
+  constructor()
 }
-export {};

package/esm/actions/SignIn.js

@@ -1,10 +1,10 @@
-import * as Errors from '../errors';
+import * as Errors from '../errors'
 /**
  * Thrown when a sign in action was rejected.
  */
 export class RejectedByUser extends Errors.BaseError {
-    name = 'SignIn.RejectedByUser';
-    constructor() {
-        super('Sign in rejected by user');
-    }
+  name = 'SignIn.RejectedByUser'
+  constructor() {
+    super('Sign in rejected by user')
+  }
 }

package/esm/actions/Swap.d.ts

@@ -1,46 +1,47 @@
 export type SwapOptions = {
-    /**
-     * CAIP-19 asset ID
-     * For example, Base USDC:
-     * eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
-     */
-    sellToken?: string;
-    /**
-     * CAIP-19 token ID. For example, OP ETH:
-     * eip155:10/native
-     */
-    buyToken?: string;
-    /**
-     * Sell token amount, as numeric string.
-     * For example, 10 USDC: 1000000
-     */
-    sellAmount?: string;
-};
+  /**
+   * CAIP-19 asset ID
+   * For example, Base USDC:
+   * eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
+   */
+  sellToken?: string
+  /**
+   * CAIP-19 token ID. For example, OP ETH:
+   * eip155:10/native
+   */
+  buyToken?: string
+  /**
+   * Sell token amount, as numeric string.
+   * For example, 10 USDC: 1000000
+   */
+  sellAmount?: string
+}
 type SwapDetails = {
-    /**
-     * Array of tx identifiers in order of execution.
-     * Some swaps will have both an approval and swap tx.
-     */
-    transactions: `0x${string}`[];
-};
+  /**
+   * Array of tx identifiers in order of execution.
+   * Some swaps will have both an approval and swap tx.
+   */
+  transactions: `0x${string}`[]
+}
 type SwapErrorDetails = {
-    /**
-     * Error code.
-     */
-    error: string;
-    /**
-     * Error message.
-     */
-    message?: string;
-};
-export type SwapErrorReason = 'rejected_by_user' | 'swap_failed';
-export type SwapResult = {
-    success: true;
-    swap: SwapDetails;
-} | {
-    success: false;
-    reason: SwapErrorReason;
-    error?: SwapErrorDetails;
-};
-export type Swap = (options: SwapOptions) => Promise<SwapResult>;
-export {};
+  /**
+   * Error code.
+   */
+  error: string
+  /**
+   * Error message.
+   */
+  message?: string
+}
+export type SwapErrorReason = 'rejected_by_user' | 'swap_failed'
+export type SwapResult =
+  | {
+      success: true
+      swap: SwapDetails
+    }
+  | {
+      success: false
+      reason: SwapErrorReason
+      error?: SwapErrorDetails
+    }
+export type Swap = (options: SwapOptions) => Promise<SwapResult>

package/esm/actions/Swap.js

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

package/esm/actions/ViewProfile.d.ts

@@ -1,4 +1,4 @@
 export type ViewProfileOptions = {
-    fid: number;
-};
-export type ViewProfile = (options: ViewProfileOptions) => Promise<void>;
+  fid: number
+}
+export type ViewProfile = (options: ViewProfileOptions) => Promise<void>

package/esm/actions/ViewProfile.js

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

package/esm/actions/ViewToken.d.ts

@@ -1,4 +1,4 @@
 export type ViewTokenOptions = {
-    token: string;
-};
-export type ViewToken = (options: ViewTokenOptions) => Promise<void>;
+  token: string
+}
+export type ViewToken = (options: ViewTokenOptions) => Promise<void>

package/esm/actions/ViewToken.js

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