@metamask/connect-multichain 0.7.0 → 0.9.0

package/CHANGELOG.md

@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.9.0]
+
+### Added
+
+- Add `versions` constructor option to `createMultichainClient` so chain-specific packages (`connect-evm`, `connect-solana`) can report their version in analytics events. Versions are merged into the singleton on each call, following the same pattern as `api.supportedNetworks`. ([#206](https://github.com/MetaMask/connect-monorepo/pull/206))
+
+### Changed
+
+- **BREAKING** `mmconnect_versions` analytics property is now a `Record<string, string>` keyed by package name instead of a plain version string ([#206](https://github.com/MetaMask/connect-monorepo/pull/206))
+
+### Removed
+
+- Stop passing `sdkVersion` to install and OTP modals ([#212](https://github.com/MetaMask/connect-monorepo/pull/212))
+
+### Fixed
+
+- Fix a bug where wallet_sessionChanged events were failing to propagate to the `ConnectMultichain` instance when the `DefaultTransport` is using the `WindowPostMessageTransport`. This was affecting Firefox, both iOS and Android in-app browsers ([#204](https://github.com/MetaMask/connect-monorepo/pull/204))
+
+## [0.8.0]
+
+### Added
+
+- Enable `ConnectMultichain` to automatically handle `wallet_sessionChanged` events when MetaMask extension is detected (Desktop Chrome/Firefox, or Mobile In-App Browser) and `preferExtension: true` without needing the user to explicitly connect via `ConnectMultichain.connect()` ([#198](https://github.com/MetaMask/connect-monorepo/pull/198/))
+
+### Changed
+
+- Bump `@metamask/mobile-wallet-protocol-core` to `^0.4.0` ([#201](https://github.com/MetaMask/connect-monorepo/pull/201))
+- Bump `@metamask/mobile-wallet-protocol-dapp-client` to `^0.3.0` ([#201](https://github.com/MetaMask/connect-monorepo/pull/201))
+
 ## [0.7.0]
 
 ### Changed
@@ -170,7 +199,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.7.0...HEAD
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.9.0...HEAD
+[0.9.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.8.0...@metamask/connect-multichain@0.9.0
+[0.8.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.7.0...@metamask/connect-multichain@0.8.0
 [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

package/README.md

@@ -134,28 +134,29 @@ 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.
+> **Singleton:** `createMultichainClient` returns a single shared instance per global context. Calling it a second time with different options will merge the new `api.supportedNetworks`, `versions`, `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-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                                                          |
+| 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                                                                                            |
+| `versions`                  | `Partial<ConnectVersions>`                    | No       | Internal: set automatically by `createEVMClient` / `createSolanaClient`. Consumers do not need to provide this. |
+| `debug`                     | `boolean`                                     | No       | Enable debug logging                                                                                            |
 
 #### Returns
 

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

@@ -386,6 +386,14 @@ type ConnectionRequest = {
         };
     };
 };
+/**
+ * Package versions keyed by connect package name.
+ * connect-multichain is always present; chain-specific packages
+ * appear only when their client is instantiated.
+ */
+type ConnectVersions = {
+    'connect-multichain': string;
+} & Partial<Record<'connect-evm' | 'connect-solana', string>>;
 /**
  * Constructor options for creating a Multichain SDK instance.
  *
@@ -431,6 +439,8 @@ type MultichainOptions = {
     };
     /** Enable debug logging */
     debug?: boolean;
+    /** Package versions contributed by chain-specific clients (merged on each createMultichainClient call) */
+    versions?: Partial<ConnectVersions>;
 };
 type MultiChainFNOptions = Omit<MultichainOptions, 'storage' | 'ui'> & {
     ui?: Omit<MultichainOptions['ui'], 'factory'>;
@@ -441,11 +451,12 @@ type MultiChainFNOptions = Omit<MultichainOptions, 'storage' | 'ui'> & {
  * Options that can be merged/overwritten when createMultichainClient is called
  * with an existing singleton.
  */
-type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' | 'storage' | 'api' | 'ui' | 'transport'> & {
+type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' | 'storage' | 'api' | 'ui' | 'transport' | 'versions'> & {
     api?: MultichainOptions['api'];
     ui?: Pick<MultichainOptions['ui'], 'headless' | 'preferExtension' | 'showInstallModal'>;
     transport?: Pick<NonNullable<MultichainOptions['transport']>, 'extensionId'>;
     debug?: boolean;
+    versions?: Partial<ConnectVersions>;
 };
 /**
  * Complete options for Multichain SDK configuration.
@@ -455,6 +466,7 @@ type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' |
  */
 type CreateMultichainFN = (options: MultiChainFNOptions) => Promise<MultichainCore>;
 type ExtendedTransport = Omit<Transport, 'connect'> & {
+    init: () => Promise<void>;
     connect: (props?: {
         scopes: Scope[];
         caipAccountIds: CaipAccountId[];
@@ -518,7 +530,7 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
     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).
+     * Only the mergeable keys are updated (api.supportedNetworks, versions, 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.
@@ -657,15 +669,17 @@ declare function isRejectionError(error: unknown): boolean;
  * @param options - Multichain options containing dapp and analytics config
  * @param storage - Storage client for getting anonymous ID
  * @param invokeOptions - The invoke method options containing method and scope
+ * @param transportType - The transport type to use for the analytics event
  * @returns Wallet action analytics properties
  */
-declare function getWalletActionAnalyticsProperties(options: MultichainOptions, storage: StoreClient, invokeOptions: InvokeMethodOptions): Promise<{
-    mmconnect_version: string;
+declare function getWalletActionAnalyticsProperties(options: MultichainOptions, storage: StoreClient, invokeOptions: InvokeMethodOptions, transportType: TransportType): Promise<{
+    mmconnect_versions: Record<string, string>;
     dapp_id: string;
     method: string;
     integration_type: string;
     caip_chain_id: string;
     anon_id: string;
+    transport_type: TransportType;
 }>;
 
 /**
@@ -677,4 +691,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, 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 };
+export { 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 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 };