@metamask/connect-multichain 0.15.0 → 1.1.0

package/CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0]
+
+### Fixed
+
+- Normalize `invokeMethod()` wallet errors across transports. Wallet-side JSON-RPC / EIP-1193 `code`, `message`, and `data` fields are now preserved in `RPCInvokeMethodErr` as `rpcCode`, `rpcMessage`, and `rpcData` whether the wallet error arrives as a resolved JSON-RPC error response or as a rejected transport error. Wrapped transport errors now walk a capped `cause` chain so wallet error details are not hidden by transport/API wrapper errors. ([#312](https://github.com/MetaMask/connect-monorepo/pull/312))
+- `DefaultTransport` and `MWPTransport` now preserve the wallet's JSON-RPC error `data` when parsing a failed wallet response. Previously both transports dropped `data` while constructing the rejected error, so revert reasons / custom-error bytes never reached `RequestRouter` (leaving `RPCInvokeMethodErr.rpcData` unset). ([#312](https://github.com/MetaMask/connect-monorepo/pull/312))
+
+## [1.0.0]
+
+### Added
+
+- Add `version` getter to `MultichainCore` and `MetaMaskConnectMultichain` that returns the runtime package version ([#253](https://github.com/MetaMask/connect-monorepo/pull/253))
+- Warn at runtime when an existing singleton has a different version than the newly requested instance, indicating duplicate `@metamask/connect-multichain` resolutions ([#253](https://github.com/MetaMask/connect-monorepo/pull/253))
+
+### Changed
+
+- This release promotes @metamask/connect-multichain to a stable 1.0. From here it follows semver strictly — 1.x minor and patch releases will be backward-compatible, and breaking changes will only land in a future major. This lets the ecosystem packages (connect-evm, connect-solana, any future ecosystem packages) depend on ^1.0.0 and pick up all future 1.x improvements without a coordinated re-release, and gives consumers a dependable compatibility contract. ([#317](https://github.com/MetaMask/connect-monorepo/pull/317))
+- Rename the storage API methods for the persisted transport type from `getTransport`, `setTransport`, and `removeTransport` to `getTransportType`, `setTransportType`, and `removeTransportType`. The existing `multichain-transport` storage key is unchanged, so no persisted data migration is required. ([#307](https://github.com/MetaMask/connect-monorepo/pull/307))
+- `getVersion()` now returns the real package version injected at build time via `__PACKAGE_VERSION__`, instead of a hardcoded `'0.0.0'` ([#253](https://github.com/MetaMask/connect-monorepo/pull/253))
+- Refactor `MWPTransport.connect()` and other internals to replace deeply nested `new Promise()` and event-callback patterns with deferred promises, reducing nesting and breaking `connect()` into smaller helpers. No behavior change. ([#305](https://github.com/MetaMask/connect-monorepo/pull/305))
+
+### Removed
+
+- **BREAKING:** Remove the `transport.onNotification` constructor option from `createMultichainClient()`. The option was a fan-out of every typed event already exposed via `client.on(...)`. Migrate to the typed event API: `client.on('stateChanged' | 'wallet_sessionChanged' | 'metamask_accountsChanged' | 'metamask_chainChanged' | 'display_uri', handler)`. ([#318](https://github.com/MetaMask/connect-monorepo/pull/318))
+- **BREAKING:** Remove the public `transport` accessor from `MultichainCore` and `MetaMaskConnectMultichain`. Consumers that previously reached the underlying transport to invoke EIP-1193 / legacy provider methods (`wallet_addEthereumChain`, `wallet_switchEthereumChain`, `eth_accounts`) should now go through `client.invokeMethod({ scope, request: { method, params } })`. `RequestRouter` recognizes those methods as EIP-1193 passthroughs and forwards the raw payload to the active transport's `sendEip1193Message`, so behavior is preserved. All other RPCs continue to flow through `invokeMethod` unchanged. ([#318](https://github.com/MetaMask/connect-monorepo/pull/318))
+
+### Fixed
+
+- Restrict EIP-6963 extension detection to native MetaMask RDNS values so MMConnect-managed provider announcements do not select the browser-extension transport. ([#304](https://github.com/MetaMask/connect-monorepo/pull/304))
+- Failed `createMultichainClient()` singleton initialization now rethrows after clearing the stored singleton promise, preventing the cleanup path from resolving to `undefined` and preserving retry behavior. ([#306](https://github.com/MetaMask/connect-monorepo/pull/306))
+- `MWPTransport.request()` and `sendEip1193Message()` now reject wallet response errors returned as `result.error`, matching `DefaultTransport` error handling and preserving wallet error codes. ([#311](https://github.com/MetaMask/connect-monorepo/pull/311))
+- `MetaMaskConnectMultichain.#headlessConnect()` now removes the `dappClient` `session_request` listener once the connection settles, preventing each headless `connect()` call from leaking a listener that would re-emit `display_uri` with stale deeplinks for every subsequent session request. ([#314](https://github.com/MetaMask/connect-monorepo/pull/314))
+
 ## [0.15.0]
 
 ### Added
@@ -283,7 +316,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.15.0...HEAD
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@1.1.0...HEAD
+[1.1.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@1.0.0...@metamask/connect-multichain@1.1.0
+[1.0.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.15.0...@metamask/connect-multichain@1.0.0
 [0.15.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.14.0...@metamask/connect-multichain@0.15.0
 [0.14.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.13.0...@metamask/connect-multichain@0.14.0
 [0.13.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.12.1...@metamask/connect-multichain@0.13.0

package/README.md

@@ -155,7 +155,6 @@ Factory function to create a new Multichain SDK instance.
 | `analytics.enabled`         | `boolean`                                     | No       | Enables dapp-side analytics. Defaults to `true`; set to `false` to disable analytics events and wallet correlation metadata. |
 | `analytics.integrationType` | `string`                                      | No       | Integration type for analytics                                                                                               |
 | `transport.extensionId`     | `string`                                      | No       | Custom extension ID                                                                                                          |
-| `transport.onNotification`  | `(notification: unknown) => void`             | No       | Notification handler                                                                                                         |
 | `versions`                  | `Partial<ConnectVersions>`                    | No       | Internal: set automatically by `createEVMClient` / `createSolanaClient`. Consumers do not need to provide this.              |
 | `debug`                     | `boolean`                                     | No       | Enable debug logging                                                                                                         |
 

package/dist/browser/es/connect-multichain.d.mts

@@ -1,7 +1,7 @@
+import { Json, CaipAccountId, CaipChainId } from '@metamask/utils';
 import debug from 'debug';
 import { SessionData, Transport, SessionProperties, TransportRequest, TransportResponse, MultichainApiClient } from '@metamask/multichain-api-client';
 export { SessionData } from '@metamask/multichain-api-client';
-import { CaipAccountId, CaipChainId, Json } from '@metamask/utils';
 import { SessionRequest, Session } from '@metamask/mobile-wallet-protocol-core';
 import { Components } from '@metamask/multichain-ui';
 
@@ -39,8 +39,17 @@ declare class RPCInvokeMethodErr extends BaseErr<'RPC', RPCErrorCodes> {
     readonly reason: string;
     readonly rpcCode?: number | undefined;
     readonly rpcMessage?: string | undefined;
+    readonly rpcData?: Json | undefined;
     static readonly code = 53;
-    constructor(reason: string, rpcCode?: number | undefined, rpcMessage?: string | undefined);
+    /**
+     * @param reason - MetaMask Connect invokeMethod reason.
+     * @param rpcCode - Original wallet JSON-RPC / EIP-1193 error code.
+     * @param rpcMessage - Original provider-facing wallet message, sourced only
+     * from the wallet's coded error. Unset when the wallet provides no message,
+     * so it may differ from `reason`, which can fall back through the cause chain.
+     * @param rpcData - Original JSON-RPC error data, when provided by the wallet.
+     */
+    constructor(reason: string, rpcCode?: number | undefined, rpcMessage?: string | undefined, rpcData?: Json | undefined);
 }
 
 type SDKEvents = {
@@ -458,7 +467,6 @@ type MultichainOptions = {
     transport?: {
         /** Extension ID for browser extension transport */
         extensionId?: string;
-        onNotification?: (notification: unknown) => void;
     };
     /** Enable debug logging */
     debug?: boolean;
@@ -508,6 +516,7 @@ type ExtendedTransport = Omit<Transport, 'connect'> & {
 declare const infuraRpcUrls: RpcUrlsMap;
 declare const RPC_HANDLED_METHODS: Set<string>;
 declare const SDK_HANDLED_METHODS: Set<string>;
+declare const EIP1193_PASSTHROUGH_METHODS: Set<string>;
 
 /**
  * Generates Infura RPC URLs for common networks keyed by CAIP Chain ID.
@@ -539,8 +548,8 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
     abstract storage: StoreClient;
     abstract status: ConnectionStatus;
     abstract provider: MultichainApiClient<RPCAPI>;
-    abstract transport: ExtendedTransport;
     abstract transportType: TransportType;
+    abstract version: string;
     /**
      * Establishes a connection to the multichain provider, or re-use existing session
      *
@@ -581,9 +590,9 @@ declare abstract class StoreClient {
     abstract getAnonId(): Promise<string>;
     abstract getExtensionId(): Promise<string | null>;
     abstract setExtensionId(extensionId: string): Promise<void>;
-    abstract getTransport(): Promise<TransportType | null>;
-    abstract setTransport(transport: TransportType): Promise<void>;
-    abstract removeTransport(): Promise<void>;
+    abstract getTransportType(): Promise<TransportType | null>;
+    abstract setTransportType(transportType: TransportType): Promise<void>;
+    abstract removeTransportType(): Promise<void>;
     abstract setAnonId(anonId: string): Promise<void>;
     abstract removeExtensionId(): Promise<void>;
     abstract removeAnonId(): Promise<void>;
@@ -760,6 +769,7 @@ declare function getWalletActionAnalyticsProperties(options: MultichainOptions,
     error_message_sample?: string;
 }>;
 
+declare const packageVersion: string;
 /**
  * Returns the version of the Multichain SDK.
  *
@@ -769,4 +779,4 @@ declare function getVersion(): string;
 
 declare const createMultichainClient: CreateMultichainFN;
 
-export { type AnalyticsOptions, type ConnectVersions, type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type FailureReason, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, type MergeableMultichainOptions, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, classifyFailureReason, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };
+export { type AnalyticsOptions, type ConnectVersions, type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, EIP1193_PASSTHROUGH_METHODS, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type FailureReason, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, type MergeableMultichainOptions, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, classifyFailureReason, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure, packageVersion };