@metamask/connect-evm 0.1.1 → 0.2.0

package/dist/src/utils/type-guards.js

@@ -0,0 +1,64 @@
+/**
+ * Type guard for connect-like requests:
+ * - wallet_requestPermissions
+ * - eth_requestAccounts
+ *
+ * @param req - The request object to check
+ * @returns True if the request is a connect-like request, false otherwise
+ */
+export function isConnectRequest(req) {
+    return (req.method === 'wallet_requestPermissions' ||
+        req.method === 'eth_requestAccounts');
+}
+/**
+ * Type guard for wallet_switchEthereumChain request.
+ *
+ * @param req - The request object to check
+ * @returns True if the request is a wallet_switchEthereumChain request, false otherwise
+ */
+export function isSwitchChainRequest(req) {
+    return req.method === 'wallet_switchEthereumChain';
+}
+/**
+ * Type guard for wallet_addEthereumChain request.
+ *
+ * @param req - The request object to check
+ * @returns True if the request is a wallet_addEthereumChain request, false otherwise
+ */
+export function isAddChainRequest(req) {
+    return req.method === 'wallet_addEthereumChain';
+}
+/**
+ * Type guard for generic accounts request:
+ * - eth_accounts
+ * - eth_coinbase
+ *
+ * @param req - The request object to check
+ * @returns True if the request is a generic accounts request, false otherwise
+ */
+export function isAccountsRequest(req) {
+    return req.method === 'eth_accounts' || req.method === 'eth_coinbase';
+}
+/**
+ * Validates that all values in a Record are valid URLs.
+ *
+ * @param record - The record to validate (e.g., supportedNetworks)
+ * @param recordName - The name of the record for error messages
+ * @throws Error if any values are invalid URLs
+ */
+export function validSupportedChainsUrls(record, recordName) {
+    const invalidUrls = [];
+    for (const [key, url] of Object.entries(record)) {
+        try {
+            // eslint-disable-next-line no-new
+            new URL(url);
+        }
+        catch (_a) {
+            invalidUrls.push(`${key}: ${url}`);
+        }
+    }
+    if (invalidUrls.length > 0) {
+        throw new Error(`${recordName} contains invalid URLs:\n${invalidUrls.join('\n')}`);
+    }
+}
+//# sourceMappingURL=type-guards.js.map

package/dist/src/utils/type-guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../../src/utils/type-guards.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAoB;IAMnD,OAAO,CACL,GAAG,CAAC,MAAM,KAAK,2BAA2B;QAC1C,GAAG,CAAC,MAAM,KAAK,qBAAqB,CACrC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,GAAoB;IAEpB,OAAO,GAAG,CAAC,MAAM,KAAK,4BAA4B,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAoB;IAEpB,OAAO,GAAG,CAAC,MAAM,KAAK,yBAAyB,CAAC;AAClD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAoB;IAKpB,OAAO,GAAG,CAAC,MAAM,KAAK,cAAc,IAAI,GAAG,CAAC,MAAM,KAAK,cAAc,CAAC;AACxE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAA8B,EAC9B,UAAkB;IAElB,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC;YACH,kCAAkC;YAClC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;QAAC,WAAM,CAAC;YACP,WAAW,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CACb,GAAG,UAAU,4BAA4B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/types/index.d.ts

@@ -16,6 +16,11 @@ type EIP1193ProviderEvents = {
         type: string;
         data: unknown;
     }];
+    /**
+     * Emitted when a QR code URI is available for display.
+     * This allows consumers to show their own custom QR code UI.
+     */
+    display_uri: [string];
     connectAndSign: [
         {
             accounts: readonly Address[];
@@ -39,6 +44,7 @@ type EventHandlers = {
     disconnect: () => void;
     accountsChanged: (accounts: Address[]) => void;
     chainChanged: (chainId: Hex) => void;
+    displayUri: (uri: string) => void;
     connectAndSign: (result: {
         accounts: readonly Address[];
         chainId: number;
@@ -96,6 +102,23 @@ type GenericProviderRequest = {
 };
 type ProviderRequest = ConnectRequest | RevokePermissionsRequest | SwitchEthereumChainRequest | AddEthereumChainRequest | AccountsRequest | GenericProviderRequest;
 type ProviderRequestInterceptor = (req: ProviderRequest) => Promise<unknown>;
+type JsonRpcRequest<T = unknown> = {
+    id?: number | string;
+    jsonrpc?: '2.0';
+    method: string;
+    params?: T;
+};
+type JsonRpcResponse<T = unknown> = {
+    id: number | string;
+    jsonrpc: '2.0';
+    result?: T;
+    error?: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+};
+type JsonRpcCallback<T = unknown> = (error: Error | null, response: JsonRpcResponse<T> | null) => void;
 
 /**
  * EIP-1193 Provider wrapper around the Multichain SDK.
@@ -115,8 +138,37 @@ declare class EIP1193Provider extends EventEmitter<EIP1193ProviderEvents> {
     get accounts(): Address[];
     get selectedChainId(): Hex | undefined;
     set selectedChainId(chainId: Hex | number | undefined);
+    /**
+     * Alias for selectedChainId for legacy compatibility.
+     * Many dApps expect a `chainId` property on the provider.
+     */
+    get chainId(): Hex | undefined;
+    /**
+     * Legacy method for sending JSON-RPC requests.
+     * @deprecated Use `request` instead. This method is provided for backwards compatibility.
+     * @param request - The JSON-RPC request object
+     * @param callback - Optional callback function. If provided, the method returns void.
+     * @returns A promise resolving to the JSON-RPC response, or void if a callback is provided.
+     */
+    sendAsync<TParams = unknown, TResult = unknown>(request: JsonRpcRequest<TParams>, callback?: JsonRpcCallback<TResult>): Promise<JsonRpcResponse<TResult> | void>;
+    /**
+     * Legacy method for sending JSON-RPC requests synchronously (callback-based).
+     * @deprecated Use `request` instead. This method is provided for backwards compatibility.
+     * @param request - The JSON-RPC request object
+     * @param callback - The callback function to receive the response
+     */
+    send<TParams = unknown, TResult = unknown>(request: JsonRpcRequest<TParams>, callback: JsonRpcCallback<TResult>): void;
 }
 
+/** 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.
@@ -135,7 +187,7 @@ declare class EIP1193Provider extends EventEmitter<EIP1193ProviderEvents> {
  *
  * @example
  * ```typescript
- * const sdk = await createMetamaskConnectEVM({
+ * const sdk = await createEVMClient({
  *   dapp: { name: 'My DApp', url: 'https://mydapp.com' }
  * });
  *
@@ -158,43 +210,44 @@ declare class MetamaskConnectEVM {
      * Connects to the wallet with the specified chain ID and optional account.
      *
      * @param options - The connection options
-     * @param options.chainId - The chain ID to connect to (defaults to 1 for mainnet)
      * @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({ chainId, account, forceRequest, }?: {
-        chainId: number;
-        account?: string | undefined;
-        forceRequest?: boolean;
-    }): Promise<{
+    connect({ account, forceRequest, chainIds }?: ConnectOptions): Promise<{
         accounts: Address[];
         chainId: number;
     }>;
     /**
      * Connects to the wallet and signs a message using personal_sign.
      *
-     * @param message - The message to 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: string): Promise<string>;
+    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.chainId - Optional chain ID to connect to (defaults to mainnet)
+     * @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, chainId, account, forceRequest, }: {
+    connectWith({ method, params, chainIds, account, forceRequest, }: {
         method: string;
         params: unknown[] | ((account: Address) => unknown[]);
-        chainId?: number;
+        chainIds?: number[];
         account?: string | undefined;
         forceRequest?: boolean;
     }): Promise<unknown>;
@@ -264,9 +317,9 @@ declare class MetamaskConnectEVM {
  * @param options.eventHandlers - The event handlers to use for the Metamask Connect/EVM layer
  * @returns The Metamask Connect/EVM layer instance
  */
-declare function createMetamaskConnectEVM(options: Pick<MultichainOptions, 'dapp' | 'api'> & {
+declare function createEVMClient(options: Pick<MultichainOptions, 'dapp' | 'api'> & {
     eventHandlers?: Partial<EventHandlers>;
     debug?: boolean;
 }): Promise<MetamaskConnectEVM>;
 
-export { type AddEthereumChainParameter, type Address, type CaipAccountId, type CaipChainId, EIP1193Provider, type EIP1193ProviderEvents, type EventHandlers, type Hex, MetamaskConnectEVM, type MetamaskConnectEVMOptions, type ProviderRequest, type ProviderRequestInterceptor, createMetamaskConnectEVM };
+export { type AddEthereumChainParameter, type Address, type CaipAccountId, type CaipChainId, EIP1193Provider, type EIP1193ProviderEvents, type EventHandlers, type Hex, type JsonRpcCallback, type JsonRpcRequest, type JsonRpcResponse, MetamaskConnectEVM, type MetamaskConnectEVMOptions, type ProviderRequest, type ProviderRequestInterceptor, createEVMClient };

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@metamask/connect-evm",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "EVM Layer for MetaMask Connect",
   "keywords": [
     "MetaMask",
     "Ethereum"
   ],
-  "homepage": "https://github.com/MetaMask/metamask-connect-monorepo/tree/main/packages/connect-evm#readme",
+  "homepage": "https://github.com/MetaMask/connect-monorepo/tree/main/packages/connect-evm#readme",
   "bugs": {
     "url": ""
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/MetaMask/metamask-connect-monorepo.git"
+    "url": "https://github.com/MetaMask/connect-monorepo.git"
   },
   "license": "MIT",
   "sideEffects": false,
@@ -56,7 +56,7 @@
   "dependencies": {
     "@metamask/analytics": "^0.2.0",
     "@metamask/chain-agnostic-permission": "^1.2.2",
-    "@metamask/connect-multichain": "^0.3.2",
+    "@metamask/connect-multichain": "^0.5.0",
     "@metamask/utils": "^11.8.1"
   },
   "devDependencies": {
@@ -68,11 +68,11 @@
     "tsup": "^8.4.0",
     "typedoc": "^0.28.14",
     "typedoc-plugin-missing-exports": "^4.1.2",
-    "typescript": "~5.9.2",
+    "typescript": "^5.9.3",
     "vitest": "^3.1.2"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": ">=20.19.0"
   },
   "publishConfig": {
     "access": "public",