@metamask/connect-evm 0.1.0 → 0.1.2

package/dist/src/connect.d.ts

@@ -0,0 +1,166 @@
+import type { MultichainOptions } from '@metamask/connect-multichain';
+import { EIP1193Provider } from './provider';
+import type { AddEthereumChainParameter, Address, EventHandlers, Hex, MetamaskConnectEVMOptions } from './types';
+/** The options for the connect method */
+type ConnectOptions = {
+    /** The account to connect to */
+    account?: string | undefined;
+    /** Whether to force a request regardless of an existing session */
+    forceRequest?: boolean;
+    /** All available chain IDs in the dapp */
+    chainIds: number[];
+};
+/**
+ * The MetamaskConnectEVM class provides an EIP-1193 compatible interface for connecting
+ * to MetaMask and interacting with Ethereum Virtual Machine (EVM) networks.
+ *
+ * This class serves as a modern replacement for MetaMask SDK V1, offering enhanced
+ * functionality and cross-platform compatibility. It wraps the Multichain SDK to provide
+ * a simplified, EIP-1193 compliant API for dapp developers.
+ *
+ * Key features:
+ * - EIP-1193 provider interface for seamless integration with existing dapp code
+ * - Automatic session recovery when reloading or opening in new tabs
+ * - Chain switching with automatic chain addition if not configured
+ * - Event-driven architecture with support for connect, disconnect, accountsChanged, and chainChanged events
+ * - Cross-platform support for browser extensions and mobile applications
+ * - Built-in handling of common Ethereum methods (eth_accounts, wallet_switchEthereumChain, etc.)
+ *
+ * @example
+ * ```typescript
+ * const sdk = await createMetamaskConnectEVM({
+ *   dapp: { name: 'My DApp', url: 'https://mydapp.com' }
+ * });
+ *
+ * await sdk.connect({ chainId: 1 });
+ * const provider = await sdk.getProvider();
+ * const accounts = await provider.request({ method: 'eth_accounts' });
+ * ```
+ */
+export declare class MetamaskConnectEVM {
+    #private;
+    /**
+     * Creates a new MetamaskConnectEVM instance.
+     *
+     * @param options - The options for the MetamaskConnectEVM instance
+     * @param options.core - The core instance of the Multichain SDK
+     * @param options.eventHandlers - Optional event handlers for EIP-1193 provider events
+     */
+    constructor({ core, eventHandlers }: MetamaskConnectEVMOptions);
+    /**
+     * Connects to the wallet with the specified chain ID and optional account.
+     *
+     * @param options - The connection options
+     * @param options.account - Optional specific account to connect to
+     * @param options.forceRequest - Wwhether to force a request regardless of an existing session
+     * @param options.chainIds - Array of chain IDs to connect to
+     * @returns A promise that resolves with the connected accounts and chain ID
+     */
+    connect({ account, forceRequest, chainIds }?: ConnectOptions): Promise<{
+        accounts: Address[];
+        chainId: number;
+    }>;
+    /**
+     * Connects to the wallet and signs a message using personal_sign.
+     *
+     * @param options - The connection options
+     * @param options.message - The message to sign after connecting
+     * @param options.chainIds - Optional chain IDs to connect to (defaults to ethereum mainnet if not provided)
+     * @returns A promise that resolves with the signature
+     * @throws Error if the selected account is not available after timeout
+     */
+    connectAndSign({ message, chainIds, }: {
+        message: string;
+        chainIds?: number[];
+    }): Promise<string>;
+    /**
+     * Connects to the wallet and invokes a method with specified parameters.
+     *
+     * @param options - The options for connecting and invoking the method
+     * @param options.method - The method name to invoke
+     * @param options.params - The parameters to pass to the method, or a function that receives the account and returns params
+     * @param options.chainIds - Optional chain IDs to connect to (defaults to ethereum mainnet if not provided)
+     * @param options.account - Optional specific account to connect to
+     * @param options.forceRequest - Whether to force a request regardless of an existing session
+     * @returns A promise that resolves with the result of the method invocation
+     * @throws Error if the selected account is not available after timeout (for methods that require an account)
+     */
+    connectWith({ method, params, chainIds, account, forceRequest, }: {
+        method: string;
+        params: unknown[] | ((account: Address) => unknown[]);
+        chainIds?: number[];
+        account?: string | undefined;
+        forceRequest?: boolean;
+    }): Promise<unknown>;
+    /**
+     * Disconnects from the wallet by revoking the session and cleaning up event listeners.
+     *
+     * @returns A promise that resolves when disconnection is complete
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Switches the Ethereum chain. Will track state internally whenever possible.
+     *
+     * @param options - The options for the switch chain request
+     * @param options.chainId - The chain ID to switch to
+     * @param options.chainConfiguration - The chain configuration to use in case the chain is not present by the wallet
+     * @returns The result of the switch chain request
+     */
+    switchChain({ chainId, chainConfiguration, }: {
+        chainId: number | Hex;
+        chainConfiguration?: AddEthereumChainParameter;
+    }): Promise<unknown>;
+    /**
+     * Gets the EIP-1193 provider instance
+     *
+     * @returns The EIP-1193 provider instance
+     */
+    getProvider(): EIP1193Provider;
+    /**
+     * Gets the currently selected chain ID on the wallet
+     *
+     * @returns The currently selected chain ID or undefined if no chain is selected
+     */
+    getChainId(): Hex | undefined;
+    /**
+     * Gets the currently selected account on the wallet
+     *
+     * @returns The currently selected account or undefined if no account is selected
+     */
+    getAccount(): Address | undefined;
+    /**
+     * Gets the currently permitted accounts
+     *
+     * @returns The currently permitted accounts
+     */
+    get accounts(): Address[];
+    /**
+     * Gets the currently selected account on the wallet
+     *
+     * @returns The currently selected account or undefined if no account is selected
+     */
+    get selectedAccount(): Address | undefined;
+    /**
+     * Gets the currently selected chain ID on the wallet
+     *
+     * @returns The currently selected chain ID or undefined if no chain is selected
+     */
+    get selectedChainId(): Hex | undefined;
+}
+/**
+ * Creates a new Metamask Connect/EVM instance
+ *
+ * @param options - The options for the Metamask Connect/EVM layer
+ * @param options.dapp - Dapp identification and branding settings
+ * @param options.api - API configuration including read-only RPC map
+ * @param options.api.supportedNetworks - A map of CAIP chain IDs to RPC URLs for read-only requests
+ * @param options.eventEmitter - The event emitter to use for the Metamask Connect/EVM layer
+ * @param options.eventHandlers - The event handlers to use for the Metamask Connect/EVM layer
+ * @returns The Metamask Connect/EVM layer instance
+ */
+export declare function createMetamaskConnectEVM(options: Pick<MultichainOptions, 'dapp' | 'api'> & {
+    eventHandlers?: Partial<EventHandlers>;
+    debug?: boolean;
+}): Promise<MetamaskConnectEVM>;
+export {};
+//# sourceMappingURL=connect.d.ts.map

package/dist/src/connect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEV,iBAAiB,EAGlB,MAAM,8BAA8B,CAAC;AAetC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,yBAAyB,EACzB,OAAO,EAEP,aAAa,EACb,GAAG,EACH,yBAAyB,EAG1B,MAAM,SAAS,CAAC;AAYjB,yCAAyC;AACzC,KAAK,cAAc,GAAG;IACpB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,mEAAmE;IACnE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,kBAAkB;;IAmB7B;;;;;;OAMG;gBACS,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,yBAAyB;IAsJ9D;;;;;;;;OAQG;IACG,OAAO,CACX,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAE,cAEpC,GACA,OAAO,CAAC;QAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAqEpD;;;;;;;;OAQG;IACG,cAAc,CAAC,EACnB,OAAO,EACP,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnB;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,EAChB,MAAM,EACN,MAAM,EACN,QAAQ,EACR,OAAO,EACP,YAAY,GACb,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,EAAE,CAAC,CAAC;QACtD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,OAAO,CAAC;IAyBpB;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBjC;;;;;;;OAOG;IACG,WAAW,CAAC,EAChB,OAAO,EACP,kBAAkB,GACnB,EAAE;QACD,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;QACtB,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;KAChD,GAAG,OAAO,CAAC,OAAO,CAAC;IAiUpB;;;;OAIG;IACH,WAAW,IAAI,eAAe;IAI9B;;;;OAIG;IACH,UAAU,IAAI,GAAG,GAAG,SAAS;IAI7B;;;;OAIG;IACH,UAAU,IAAI,OAAO,GAAG,SAAS;IAKjC;;;;OAIG;IACH,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,OAAO,GAAG,SAAS,CAEzC;IAED;;;;OAIG;IACH,IAAI,eAAe,IAAI,GAAG,GAAG,SAAS,CAErC;CACF;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC,GAAG;IACjD,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GACA,OAAO,CAAC,kBAAkB,CAAC,CAkC7B"}