@metamask/connect-multichain 0.5.3 → 0.7.0

package/CHANGELOG.md

@@ -7,6 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0]
+
+### Changed
+
+- Correct README documentation across `connect-solana`, `connect-evm`, and `connect-multichain` to match actual API behaviour. ([#194](https://github.com/MetaMask/connect-monorepo/pull/194))
+- Redact logs ([#191](https://github.com/MetaMask/connect-monorepo/pull/191]))
+- Pin eciesjs to exact version 0.4.17 ([#188](https://github.com/MetaMask/connect-monorepo/pull/188))
+
+### Fixed
+
+- Fix uncaught exception in `parseWalletError` when the wallet returns error codes outside the EIP-1193 provider range (1000–4999), such as standard JSON-RPC codes like `-32603` (Internal error). This prevented Solana request rejections from being handled gracefully. ([#189](https://github.com/MetaMask/connect-monorepo/pull/189))
+
+## [0.6.0]
+
+### Added
+
+- When `ConnectMultichain.connect()` is called while a connection is already pending, the user is re-prompted with the pending connection deeplink. ([#176](https://github.com/MetaMask/connect-monorepo/pull/176))
+
+### Changed
+
+- Normalize non-http(s) dapp URLs to valid https URLs on React Native to prevent RPC middleware crashes ([#190](https://github.com/MetaMask/connect-monorepo/pull/190))
+- **BREAKING** `createMultichainClient()` now returns a singleton. Any incoming constructor params on subsequent calls to `createMultichainClient()` will be applied to the existing singleton instance except for the `dapp`, `storage`, and `ui.factory` param options. ([#157](https://github.com/MetaMask/connect-monorepo/pull/157))
+- **BREAKING** `ConnectMultichain.openDeeplinkIfNeeded()` is renamed to `openSimpleDeeplinkIfNeeded()` ([#176](https://github.com/MetaMask/connect-monorepo/pull/176))
+- `ConnectMultichain.connect()` now throws an `'Existing connection is pending. Please check your MetaMask Mobile app to continue.'` error if there is already an pending connection attempt. Previously it would abort that ongoing connection in favor of a new one. ([#157](https://github.com/MetaMask/connect-monorepo/pull/157))
+- `ConnectMultichain.connect()` adds newly requested scopes and accounts onto any existing permissions rather than fully replacing them. ([#157](https://github.com/MetaMask/connect-monorepo/pull/157))
+- `ConnectMultichain.disconnect()` accepts an optional array of scopes. When provided, only those scopes will be revoked from the existing permissions. If no scopes remain after a partial revoke, then the underly connection is fully discarded. If no scopes are specified ()`[]`), then all scopes will be removed. By default all scopes will be removed. ([#157](https://github.com/MetaMask/connect-monorepo/pull/157))
+
+### Fixed
+
+- `ConnectMultichain` now waits 10 seconds (rather than 2 minutes) when attempting to resume a pending connection on initial instantiation via `createMultichainClient()` ([#175](https://github.com/MetaMask/connect-monorepo/pull/175))
+- Fix `beforeunload` event listener not being properly removed on disconnect due to `.bind()` creating different function references, causing a listener leak on each connect/disconnect cycle ([#170](https://github.com/MetaMask/connect-monorepo/pull/170))
+- Rename `StoreAdapterWeb.DB_NAME` from `mmsdk` to `mmconnect` to prevent IndexedDB collisions when the legacy MetaMask SDK and MM Connect run in the same browser context ([#177](https://github.com/MetaMask/connect-monorepo/pull/177))
+- Clean up stale MWP session from KVStore on connection rejection so subsequent QR code connection attempts are not blocked ([#180](https://github.com/MetaMask/connect-monorepo/pull/180))
+- Fix bug with JSON-RPC requests where previously used `id` value could be re-used causing the wallet to ignore the request when a dapp was refreshed/reloaded. ([#183](https://github.com/MetaMask/connect-monorepo/pull/183))
+
 ## [0.5.3]
 
 ### Added
@@ -15,6 +50,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Fix QR rejection handling: properly propagate user rejection errors from MetaMask Mobile to the dApp ([#156](https://github.com/MetaMask/connect-monorepo/pull/156))
+- Close QR modal automatically when user rejects connection ([#156](https://github.com/MetaMask/connect-monorepo/pull/156))
+- Use `@metamask/rpc-errors` for EIP-1193 compliant error handling ([#156](https://github.com/MetaMask/connect-monorepo/pull/156))
 - Fix `sessionProperties` not being passed to `wallet_createSession` when recreating a session after scope/account changes ([#123](https://github.com/MetaMask/connect-monorepo/pull/123))
 
 ## [0.5.2]
@@ -132,7 +170,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.5.3...HEAD
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.7.0...HEAD
+[0.7.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.6.0...@metamask/connect-multichain@0.7.0
+[0.6.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.5.3...@metamask/connect-multichain@0.6.0
 [0.5.3]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.5.2...@metamask/connect-multichain@0.5.3
 [0.5.2]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.5.1...@metamask/connect-multichain@0.5.2
 [0.5.1]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.5.0...@metamask/connect-multichain@0.5.1

package/README.md

@@ -134,26 +134,28 @@ This package is written in TypeScript and includes full type definitions. No add
 
 Factory function to create a new Multichain SDK instance.
 
+> **Singleton:** `createMultichainClient` returns a single shared instance per global context. Calling it a second time with different options will merge the new `api.supportedNetworks`, `ui.*`, `mobile.*`, `transport.extensionId`, and `debug` values into the existing instance rather than creating a new one. The `dapp` value is never overwritten on subsequent calls.
+
 #### Parameters
 
-| Option                      | Type                                          | Required | Description                                    |
-| --------------------------- | --------------------------------------------- | -------- | ---------------------------------------------- |
-| `dapp.name`                 | `string`                                      | Yes      | Name of your dApp                              |
-| `api.supportedNetworks`     | `RpcUrlsMap`                                  | Yes      | Map of CAIP chain IDs to RPC URLs              |
-| `dapp.url`                  | `string`                                      | No       | URL of your dApp                               |
-| `dapp.iconUrl`              | `string`                                      | No       | Icon URL for your dApp                         |
-| `dapp.base64Icon`           | `string`                                      | No       | Base64-encoded icon (alternative to iconUrl)   |
-| `storage`                   | `StoreClient`                                 | No       | Custom storage adapter                         |
-| `ui.factory`                | `BaseModalFactory`                            | No       | Custom modal factory                           |
-| `ui.headless`               | `boolean`                                     | No       | Run without UI (for custom QR implementations) |
-| `ui.preferExtension`        | `boolean`                                     | No       | Prefer browser extension (default: true)       |
-| `ui.showInstallModal`       | `boolean`                                     | No       | Show installation modal                        |
-| `mobile.preferredOpenLink`  | `(deeplink: string, target?: string) => void` | No       | Custom deeplink handler                        |
-| `mobile.useDeeplink`        | `boolean`                                     | No       | Use `metamask://` instead of universal links   |
-| `analytics.integrationType` | `string`                                      | No       | Integration type for analytics                 |
-| `transport.extensionId`     | `string`                                      | No       | Custom extension ID                            |
-| `transport.onNotification`  | `(notification: unknown) => void`             | No       | Notification handler                           |
-| `debug`                     | `boolean`                                     | No       | Enable debug logging                           |
+| Option                      | Type                                          | Required | Description                                                                   |
+| --------------------------- | --------------------------------------------- | -------- | ----------------------------------------------------------------------------- |
+| `dapp.name`                 | `string`                                      | Yes      | Name of your dApp                                                             |
+| `api.supportedNetworks`     | `RpcUrlsMap`                                  | Yes      | Map of [CAIP-2 chain IDs](https://chainagnostic.org/CAIPs/caip-2) to RPC URLs |
+| `dapp.url`                  | `string`                                      | No       | URL of your dApp                                                              |
+| `dapp.iconUrl`              | `string`                                      | No       | Icon URL for your dApp                                                        |
+| `dapp.base64Icon`           | `string`                                      | No       | Base64-encoded icon (alternative to iconUrl)                                  |
+| `storage`                   | `StoreClient`                                 | No       | Custom storage adapter                                                        |
+| `ui.factory`                | `BaseModalFactory`                            | No       | Custom modal factory                                                          |
+| `ui.headless`               | `boolean`                                     | No       | Run without UI (for custom QR implementations)                                |
+| `ui.preferExtension`        | `boolean`                                     | No       | Prefer browser extension (default: true)                                      |
+| `ui.showInstallModal`       | `boolean`                                     | No       | Show installation modal                                                       |
+| `mobile.preferredOpenLink`  | `(deeplink: string, target?: string) => void` | No       | Custom deeplink handler                                                       |
+| `mobile.useDeeplink`        | `boolean`                                     | No       | Use `metamask://` instead of universal links                                  |
+| `analytics.integrationType` | `string`                                      | No       | Integration type for analytics                                                |
+| `transport.extensionId`     | `string`                                      | No       | Custom extension ID                                                           |
+| `transport.onNotification`  | `(notification: unknown) => void`             | No       | Notification handler                                                          |
+| `debug`                     | `boolean`                                     | No       | Enable debug logging                                                          |
 
 #### Returns
 
@@ -203,20 +205,26 @@ await client.connect(
 );
 ```
 
-##### `disconnect()`
+##### `disconnect(scopes?)`
 
-Disconnects from the wallet and cleans up resources.
+Disconnects from the wallet. If `scopes` are provided, only the specified scopes are revoked; if there are remaining scopes, the connection stays alive. If omitted or empty, all scopes are revoked and the connection is fully torn down.
 
 **Parameters**
 
-None.
+| Name     | Type      | Required | Description                                                          |
+| -------- | --------- | -------- | -------------------------------------------------------------------- |
+| `scopes` | `Scope[]` | No       | Array of CAIP-2 chain identifiers to revoke (defaults to all scopes) |
 
 **Returns**
 
 `Promise<void>`
 
 ```typescript
+// Fully disconnect
 await client.disconnect();
+
+// Disconnect only specific scopes
+await client.disconnect(['eip155:1']);
 ```
 
 ##### `invokeMethod(options)`
@@ -341,7 +349,7 @@ Generates Infura RPC URLs for common networks keyed by CAIP Chain ID.
 
 **Returns**
 
-A map of hex chain IDs to Infura RPC URLs. See https://docs.metamask.io/services
+A map of [CAIP-2 chain IDs](https://chainagnostic.org/CAIPs/caip-2) to Infura RPC URLs. See https://docs.metamask.io/services
 
 ```typescript
 import { getInfuraRpcUrls } from '@metamask/connect-multichain';

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

@@ -369,6 +369,8 @@ declare function hasExtension(): Promise<boolean>;
 type DappSettings = {
     name: string;
     url?: string;
+    /** The original non-http(s) URL before normalization on React Native platforms */
+    nativeScheme?: string;
 } & ({
     iconUrl?: string;
 } | {
@@ -435,6 +437,16 @@ type MultiChainFNOptions = Omit<MultichainOptions, 'storage' | 'ui'> & {
 } & {
     storage?: StoreClient;
 };
+/**
+ * Options that can be merged/overwritten when createMultichainClient is called
+ * with an existing singleton.
+ */
+type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' | 'storage' | 'api' | 'ui' | 'transport'> & {
+    api?: MultichainOptions['api'];
+    ui?: Pick<MultichainOptions['ui'], 'headless' | 'preferExtension' | 'showInstallModal'>;
+    transport?: Pick<NonNullable<MultichainOptions['transport']>, 'extensionId'>;
+    debug?: boolean;
+};
 /**
  * Complete options for Multichain SDK configuration.
  *
@@ -453,6 +465,8 @@ type ExtendedTransport = Omit<Transport, 'connect'> & {
         timeout?: number;
     }) => Promise<TResponse>;
     getActiveSession: () => Promise<Session | undefined>;
+    getStoredPendingSessionRequest: () => Promise<SessionRequest | null>;
+    disconnect: (scopes: Scope[]) => Promise<void>;
 };
 
 declare const infuraRpcUrls: RpcUrlsMap;
@@ -474,7 +488,7 @@ declare enum TransportType {
  * must provide, including session management, connection handling, and method invocation.
  */
 declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
-    protected readonly options: MultichainOptions;
+    protected options: MultichainOptions;
     abstract storage: StoreClient;
     abstract status: ConnectionStatus;
     abstract provider: MultichainApiClient<RPCAPI>;
@@ -491,7 +505,7 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
      *
      * @returns Promise that resolves when disconnection is complete
      */
-    abstract disconnect(): Promise<void>;
+    abstract disconnect(scopes?: Scope[]): Promise<void>;
     /**
      * Invokes an RPC method with the specified options.
      *
@@ -499,8 +513,19 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
      * @returns Promise that resolves to the method result
      */
     abstract invokeMethod(options: InvokeMethodOptions): Promise<Json>;
-    abstract openDeeplinkIfNeeded(): void;
+    abstract openSimpleDeeplinkIfNeeded(): void;
+    abstract emitSessionChanged(): Promise<void>;
     constructor(options: MultichainOptions);
+    /**
+     * Merges the given options into the current instance options.
+     * Only the mergeable keys are updated (api.supportedNetworks, ui.*, mobile.*, transport.extensionId, debug).
+     * The main thing to note is that the value for `dapp` is not merged as it does not make sense for
+     * subsequent calls to `createMultichainClient` to have a different `dapp` value.
+     * Used when createMultichainClient is called with an existing singleton.
+     *
+     * @param partial - Options to merge/overwrite onto the current instance
+     */
+    mergeOptions(partial: MergeableMultichainOptions): void;
 }
 declare function getTransportType(type: string): TransportType;
 
@@ -652,4 +677,4 @@ declare function getVersion(): string;
 
 declare const createMultichainClient: CreateMultichainFN;
 
-export { type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, 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, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };
+export { type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, 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, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };