@farcaster/frame-wagmi-connector 0.0.52 → 1.0.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@farcaster/frame-wagmi-connector",
-  "version": "0.0.52",
+  "version": "1.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/farcasterxyz/frames.git",
+    "url": "https://github.com/farcasterxyz/miniapps.git",
     "directory": "packages/frame-wagmi-connector"
   },
   "type": "module",
@@ -17,17 +17,20 @@
     "@wagmi/core": "^2.16.3",
     "typescript": "^5.8.3",
     "viem": "^2.21.57",
-    "@farcaster/tsconfig": "0.0.5",
-    "@farcaster/frame-sdk": "0.0.63"
+    "@farcaster/miniapp-wagmi-connector": "1.0.0",
+    "@farcaster/tsconfig": "0.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "@farcaster/frame-sdk": "^0.0.63",
+    "@farcaster/frame-sdk": "^0.1.0",
     "@wagmi/core": "^2.14.1",
     "viem": "^2.21.55"
   },
+  "engines": {
+    "node": ">=22.11.0"
+  },
   "scripts": {
     "clean": "rm -rf dist",
     "prebuild": "npm run clean",

package/src/index.ts

@@ -1,5 +1,32 @@
-import { farcasterFrame } from './connector.js'
+// Deprecation warning
+if (typeof console !== 'undefined' && console.warn) {
+  console.warn(
+    '[DEPRECATION WARNING] @farcaster/frame-wagmi-connector is deprecated. Please migrate to @farcaster/miniapp-wagmi-connector. ' +
+      'See https://github.com/farcasterxyz/frames/blob/main/MIGRATION.md for migration guide.',
+  )
+}
 
-export * from './connector.js'
+// Re-export everything from miniapp-wagmi-connector
+export * from '@farcaster/miniapp-wagmi-connector'
+
+// Import and re-export for backward compatibility
+import { farcasterFrame as _farcasterFrame } from '@farcaster/miniapp-wagmi-connector'
+
+// Add deprecation warning when farcasterFrame is used
+let farcasterFrameWarningShown = false
+export const farcasterFrame = () => {
+  if (
+    !farcasterFrameWarningShown &&
+    typeof console !== 'undefined' &&
+    console.warn
+  ) {
+    console.warn(
+      '[DEPRECATION WARNING] farcasterFrame() is deprecated. Please use farcasterMiniApp() instead. ' +
+        'Import from @farcaster/miniapp-wagmi-connector.',
+    )
+    farcasterFrameWarningShown = true
+  }
+  return _farcasterFrame()
+}
 
 export default farcasterFrame

package/dist/connector.d.ts

@@ -1,444 +0,0 @@
-export declare function farcasterFrame(): import("@wagmi/core").CreateConnectorFn<{
-    request: import("ox/Provider").RequestFn<{
-        Request: {
-            method: "eth_accounts";
-            params?: undefined;
-        };
-        ReturnType: readonly import("ox/Address").Address[];
-    } | {
-        Request: {
-            method: "eth_blobBaseFee";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_blockNumber";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_call";
-            params: [transaction: import("ox/TransactionRequest").Rpc] | [transaction: import("ox/TransactionRequest").Rpc, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier] | [transaction: import("ox/TransactionRequest").Rpc, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier, stateOverride: unknown];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_chainId";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_coinbase";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Address").Address;
-    } | {
-        Request: {
-            method: "eth_estimateGas";
-            params: [transaction: import("ox/TransactionRequest").Rpc] | [transaction: import("ox/TransactionRequest").Rpc, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier] | [transaction: import("ox/TransactionRequest").Rpc, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier, stateOverride: unknown];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_feeHistory";
-            params: [blockCount: import("ox/Hex").Hex, newestBlock: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag, rewardPercentiles: number[] | undefined];
-        };
-        ReturnType: import("ox/Fee").FeeHistoryRpc;
-    } | {
-        Request: {
-            method: "eth_gasPrice";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getBalance";
-            params: [address: import("ox/Address").Address, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getBlockByHash";
-            params: [hash: import("ox/Hex").Hex, includeTransactionObjects: boolean];
-        };
-        ReturnType: import("ox/Block").Rpc | null;
-    } | {
-        Request: {
-            method: "eth_getBlockByNumber";
-            params: [block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag, includeTransactionObjects: boolean];
-        };
-        ReturnType: import("ox/Block").Rpc | null;
-    } | {
-        Request: {
-            method: "eth_getBlockTransactionCountByHash";
-            params: [hash: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getBlockTransactionCountByNumber";
-            params: [block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getCode";
-            params: [address: import("ox/Address").Address, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getFilterChanges";
-            params: [filterId: import("ox/Hex").Hex];
-        };
-        ReturnType: readonly import("ox/Log").Rpc[] | readonly import("ox/Hex").Hex[];
-    } | {
-        Request: {
-            method: "eth_getFilterLogs";
-            params: [filterId: import("ox/Hex").Hex];
-        };
-        ReturnType: readonly import("ox/Log").Rpc[];
-    } | {
-        Request: {
-            method: "eth_getLogs";
-            params: [filter: import("ox/Filter").Rpc];
-        };
-        ReturnType: readonly import("ox/Log").Rpc[];
-    } | {
-        Request: {
-            method: "eth_getProof";
-            params: [address: import("ox/Address").Address, storageKeys: import("ox/Hex").Hex[], block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier];
-        };
-        ReturnType: import("ox/AccountProof").Rpc;
-    } | {
-        Request: {
-            method: "eth_getStorageAt";
-            params: [address: import("ox/Address").Address, index: import("ox/Hex").Hex, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getTransactionByBlockHashAndIndex";
-            params: [hash: import("ox/Hex").Hex, index: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Transaction").Rpc | null;
-    } | {
-        Request: {
-            method: "eth_getTransactionByBlockNumberAndIndex";
-            params: [block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag, index: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Transaction").Rpc | null;
-    } | {
-        Request: {
-            method: "eth_getTransactionByHash";
-            params: [hash: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Transaction").Rpc | null;
-    } | {
-        Request: {
-            method: "eth_getTransactionCount";
-            params: [address: import("ox/Address").Address, block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag | import("ox/Block").Hash | import("ox/Block").Identifier];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getTransactionReceipt";
-            params: [hash: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/TransactionReceipt").Rpc | null;
-    } | {
-        Request: {
-            method: "eth_getUncleCountByBlockHash";
-            params: [hash: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_getUncleCountByBlockNumber";
-            params: [block: import("ox/Block").Number<import("ox/Hex").Hex> | import("ox/Block").Tag];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_maxPriorityFeePerGas";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_newBlockFilter";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_newFilter";
-            params: [filter: import("ox/Filter").Rpc];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_newPendingTransactionFilter";
-            params?: undefined;
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_protocolVersion";
-            params?: undefined;
-        };
-        ReturnType: string;
-    } | {
-        Request: {
-            method: "eth_requestAccounts";
-            params?: undefined;
-        };
-        ReturnType: readonly import("ox/Address").Address[];
-    } | {
-        Request: {
-            method: "eth_sendRawTransaction";
-            params: [serializedTransaction: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_sendTransaction";
-            params: [transaction: import("ox/TransactionRequest").Rpc];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_signTransaction";
-            params: [request: import("ox/TransactionRequest").Rpc];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_signTypedData_v4";
-            params: [address: import("ox/Address").Address, message: string];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_uninstallFilter";
-            params: [filterId: import("ox/Hex").Hex];
-        };
-        ReturnType: boolean;
-    } | {
-        Request: {
-            method: "eth_requestAccounts";
-            params?: undefined;
-        };
-        ReturnType: readonly import("ox/Address").Address[];
-    } | {
-        Request: {
-            method: "eth_sendRawTransaction";
-            params: [serializedTransaction: import("ox/Hex").Hex];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_sendTransaction";
-            params: [transaction: import("ox/TransactionRequest").Rpc];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_signTransaction";
-            params: [request: import("ox/TransactionRequest").Rpc];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "eth_signTypedData_v4";
-            params: [address: import("ox/Address").Address, message: string];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "personal_sign";
-            params: [data: import("ox/Hex").Hex, address: import("ox/Address").Address];
-        };
-        ReturnType: import("ox/Hex").Hex;
-    } | {
-        Request: {
-            method: "wallet_addEthereumChain";
-            params: [chain: {
-                chainId: string;
-                chainName: string;
-                nativeCurrency?: {
-                    name: string;
-                    symbol: string;
-                    decimals: number;
-                } | undefined | undefined;
-                rpcUrls: readonly string[];
-                blockExplorerUrls?: readonly string[] | undefined;
-                iconUrls?: readonly string[] | undefined;
-            }];
-        };
-        ReturnType: null;
-    } | {
-        Request: {
-            method: "wallet_getCallsStatus";
-            params?: [string];
-        };
-        ReturnType: {
-            status: "PENDING" | "CONFIRMED";
-            receipts?: readonly {
-                logs: {
-                    address: import("ox/Hex").Hex;
-                    data: import("ox/Hex").Hex;
-                    topics: readonly import("ox/Hex").Hex[];
-                }[];
-                status: import("ox/Hex").Hex;
-                blockHash: import("ox/Hex").Hex;
-                blockNumber: import("ox/Hex").Hex;
-                gasUsed: import("ox/Hex").Hex;
-                transactionHash: import("ox/Hex").Hex;
-            }[] | undefined;
-        };
-    } | {
-        Request: {
-            method: "wallet_getCapabilities";
-            params?: [import("ox/Address").Address];
-        };
-        ReturnType: {
-            [x: `0x${string}`]: {
-                [capability: string]: any;
-            };
-        };
-    } | {
-        Request: {
-            method: "wallet_getPermissions";
-            params?: undefined;
-        };
-        ReturnType: readonly {
-            caveats: readonly {
-                type: string;
-                value: any;
-            }[];
-            date: number;
-            id: string;
-            invoker: `http://${string}` | `https://${string}`;
-            parentCapability: "eth_accounts" | string;
-        }[];
-    } | {
-        Request: {
-            method: "wallet_grantPermissions";
-            params?: [{
-                signer?: {
-                    type: string;
-                    data?: unknown | undefined;
-                } | undefined;
-                permissions: readonly {
-                    data: unknown;
-                    policies: readonly {
-                        data: unknown;
-                        type: string;
-                    }[];
-                    required?: boolean | undefined;
-                    type: string;
-                }[];
-                expiry: number;
-            }];
-        };
-        ReturnType: {
-            expiry: number;
-            factory?: `0x${string}` | undefined | undefined;
-            factoryData?: string | undefined | undefined;
-            grantedPermissions: readonly {
-                data: unknown;
-                policies: readonly {
-                    data: unknown;
-                    type: string;
-                }[];
-                required?: boolean | undefined;
-                type: string;
-            }[];
-            permissionsContext: string;
-            signerData?: {
-                userOpBuilder?: `0x${string}` | undefined;
-                submitToAddress?: `0x${string}` | undefined;
-            } | undefined | undefined;
-        };
-    } | {
-        Request: {
-            method: "wallet_requestPermissions";
-            params: [permissions: {
-                eth_accounts: Record<string, any>;
-            }];
-        };
-        ReturnType: readonly {
-            caveats: readonly {
-                type: string;
-                value: any;
-            }[];
-            date: number;
-            id: string;
-            invoker: `http://${string}` | `https://${string}`;
-            parentCapability: "eth_accounts" | string;
-        }[];
-    } | {
-        Request: {
-            method: "wallet_revokePermissions";
-            params: [permissions: {
-                eth_accounts: Record<string, any>;
-            }];
-        };
-        ReturnType: null;
-    } | {
-        Request: {
-            method: "wallet_sendCalls";
-            params: [{
-                calls: readonly {
-                    to?: import("ox/Address").Address | undefined;
-                    data?: import("ox/Hex").Hex | undefined;
-                    value?: import("ox/Hex").Hex | undefined;
-                }[];
-                capabilities?: {
-                    [capability: string]: any;
-                } | undefined;
-                chainId?: import("ox/Hex").Hex | undefined;
-                from: import("ox/Address").Address;
-                version: string;
-            }];
-        };
-        ReturnType: string;
-    } | {
-        Request: {
-            method: "wallet_showCallsStatus";
-            params: [string];
-        };
-        ReturnType: undefined;
-    } | {
-        Request: {
-            method: "wallet_switchEthereumChain";
-            params: [chain: {
-                chainId: string;
-            }];
-        };
-        ReturnType: null;
-    } | {
-        Request: {
-            method: "wallet_watchAsset";
-            params: [{
-                type: "ERC20";
-                options: {
-                    address: string;
-                    symbol: string;
-                    decimals: number;
-                    image?: string | undefined;
-                };
-            }];
-        };
-        ReturnType: boolean;
-    }>;
-    on: import("ox/Provider").EventListenerFn;
-    removeListener: import("ox/Provider").EventListenerFn;
-}, Record<string, unknown>, Record<string, unknown>>;
-export declare namespace farcasterFrame {
-    var type: "farcasterFrame";
-}

package/dist/connector.js

@@ -1,129 +0,0 @@
-import FrameSDK from '@farcaster/frame-sdk';
-import { ChainNotConfiguredError, createConnector, } from '@wagmi/core';
-import { SwitchChainError, fromHex, getAddress, numberToHex } from 'viem';
-farcasterFrame.type = 'farcasterFrame';
-let accountsChanged;
-let chainChanged;
-let disconnect;
-export function farcasterFrame() {
-    return createConnector((config) => ({
-        id: 'farcaster',
-        name: 'Farcaster',
-        rdns: 'xyz.farcaster.MiniAppWallet',
-        icon: 'https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/055c25d6-7fe7-4a49-abf9-49772021cf00/original',
-        type: farcasterFrame.type,
-        async connect({ chainId } = {}) {
-            const provider = await this.getProvider();
-            const accounts = await provider.request({
-                method: 'eth_requestAccounts',
-            });
-            let targetChainId = chainId;
-            if (!targetChainId) {
-                const state = (await config.storage?.getItem('state')) ?? {};
-                const isChainSupported = config.chains.some((x) => x.id === state.chainId);
-                if (isChainSupported)
-                    targetChainId = state.chainId;
-                else
-                    targetChainId = config.chains[0]?.id;
-            }
-            if (!targetChainId)
-                throw new Error('No chains found on connector.');
-            if (!accountsChanged) {
-                accountsChanged = this.onAccountsChanged.bind(this);
-                // @ts-expect-error - provider type is stricter
-                provider.on('accountsChanged', accountsChanged);
-            }
-            if (!chainChanged) {
-                chainChanged = this.onChainChanged.bind(this);
-                provider.on('chainChanged', chainChanged);
-            }
-            if (!disconnect) {
-                disconnect = this.onDisconnect.bind(this);
-                provider.on('disconnect', disconnect);
-            }
-            let currentChainId = await this.getChainId();
-            if (targetChainId && currentChainId !== targetChainId) {
-                const chain = await this.switchChain({ chainId: targetChainId });
-                currentChainId = chain.id;
-            }
-            return {
-                accounts: accounts.map((x) => getAddress(x)),
-                chainId: currentChainId,
-            };
-        },
-        async disconnect() {
-            const provider = await this.getProvider();
-            if (accountsChanged) {
-                // @ts-expect-error - provider type is stricter
-                provider.removeListener('accountsChanged', accountsChanged);
-                accountsChanged = undefined;
-            }
-            if (chainChanged) {
-                provider.removeListener('chainChanged', chainChanged);
-                chainChanged = undefined;
-            }
-            if (disconnect) {
-                provider.removeListener('disconnect', disconnect);
-                disconnect = undefined;
-            }
-        },
-        async getAccounts() {
-            const provider = await this.getProvider();
-            const accounts = await provider.request({
-                method: 'eth_accounts',
-            });
-            return accounts.map((x) => getAddress(x));
-        },
-        async getChainId() {
-            const provider = await this.getProvider();
-            const hexChainId = await provider.request({ method: 'eth_chainId' });
-            return fromHex(hexChainId, 'number');
-        },
-        async isAuthorized() {
-            try {
-                const accounts = await this.getAccounts();
-                return !!accounts.length;
-            }
-            catch {
-                return false;
-            }
-        },
-        async switchChain({ chainId }) {
-            const provider = await this.getProvider();
-            const chain = config.chains.find((x) => x.id === chainId);
-            if (!chain) {
-                throw new SwitchChainError(new ChainNotConfiguredError());
-            }
-            await provider.request({
-                method: 'wallet_switchEthereumChain',
-                params: [{ chainId: numberToHex(chainId) }],
-            });
-            // providers should start emitting these events - remove when hosts have upgraded
-            //
-            // explicitly emit this event as a workaround for ethereum provider not
-            // emitting events, can remove once events are flowing
-            config.emitter.emit('change', { chainId });
-            return chain;
-        },
-        onAccountsChanged(accounts) {
-            if (accounts.length === 0) {
-                this.onDisconnect();
-            }
-            else {
-                config.emitter.emit('change', {
-                    accounts: accounts.map((x) => getAddress(x)),
-                });
-            }
-        },
-        onChainChanged(chain) {
-            const chainId = Number(chain);
-            config.emitter.emit('change', { chainId });
-        },
-        async onDisconnect() {
-            config.emitter.emit('disconnect');
-        },
-        async getProvider() {
-            return FrameSDK.wallet.ethProvider;
-        },
-    }));
-}