@metamask/connect-multichain 0.8.0 → 0.10.0

package/dist/browser/umd/connect-multichain.d.ts

@@ -1,7 +1,7 @@
 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, Json } from '@metamask/utils';
+import { CaipAccountId, CaipChainId, Json } from '@metamask/utils';
 import { SessionRequest, Session } from '@metamask/mobile-wallet-protocol-core';
 import { Components } from '@metamask/multichain-ui';
 
@@ -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.
@@ -474,7 +485,18 @@ declare const infuraRpcUrls: RpcUrlsMap;
 declare const RPC_HANDLED_METHODS: Set<string>;
 declare const SDK_HANDLED_METHODS: Set<string>;
 
-declare function getInfuraRpcUrls(infuraAPIKey: string): RpcUrlsMap;
+/**
+ * Generates Infura RPC URLs for common networks keyed by CAIP Chain ID.
+ *
+ * @param options - The options for generating Infura RPC URLs
+ * @param options.infuraApiKey - The Infura API key
+ * @param options.caipChainIds - Optional CAIP-2 chain IDs to filter the output
+ * @returns A map of CAIP-2 chain IDs to Infura RPC URLs
+ */
+declare function getInfuraRpcUrls({ infuraApiKey, caipChainIds, }: {
+    infuraApiKey: string;
+    caipChainIds?: CaipChainId[];
+}): RpcUrlsMap;
 
 type ConnectionStatus = 'pending' | 'loaded' | 'disconnected' | 'connected' | 'connecting';
 declare enum TransportType {
@@ -519,7 +541,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.
@@ -658,15 +680,16 @@ 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;
 }>;
 
 /**
@@ -678,4 +701,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 };

package/dist/browser/umd/connect-multichain.js

@@ -377,10 +377,16 @@ var init_constants = __esm({
 });
 
 // src/domain/multichain/api/infura.ts
-function getInfuraRpcUrls(infuraAPIKey) {
-  return Object.keys(infuraRpcUrls).reduce((acc, key) => {
-    const typedKey = key;
-    acc[typedKey] = `${infuraRpcUrls[typedKey]}${infuraAPIKey}`;
+function getInfuraRpcUrls({
+  infuraApiKey,
+  caipChainIds
+}) {
+  const keys = caipChainIds && caipChainIds.length > 0 ? caipChainIds : Object.keys(infuraRpcUrls);
+  return keys.reduce((acc, key) => {
+    const baseUrl = infuraRpcUrls[key];
+    if (baseUrl) {
+      acc[key] = `${baseUrl}${infuraApiKey}`;
+    }
     return acc;
   }, {});
 }
@@ -422,7 +428,7 @@ var init_multichain = __esm({
       }
       /**
        * 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.
@@ -430,22 +436,23 @@ var init_multichain = __esm({
        * @param partial - Options to merge/overwrite onto the current instance
        */
       mergeOptions(partial) {
-        var _a3, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
+        var _a3, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o;
         const opts = this.options;
         this.options = __spreadProps(__spreadValues({}, opts), {
           api: __spreadProps(__spreadValues({}, opts.api), {
             supportedNetworks: __spreadValues(__spreadValues({}, opts.api.supportedNetworks), (_b = (_a3 = partial.api) == null ? void 0 : _a3.supportedNetworks) != null ? _b : {})
           }),
+          versions: __spreadValues(__spreadValues({}, opts.versions), (_c = partial.versions) != null ? _c : {}),
           ui: __spreadProps(__spreadValues({}, opts.ui), {
-            headless: (_d = (_c = partial.ui) == null ? void 0 : _c.headless) != null ? _d : opts.ui.headless,
-            preferExtension: (_f = (_e = partial.ui) == null ? void 0 : _e.preferExtension) != null ? _f : opts.ui.preferExtension,
-            showInstallModal: (_h = (_g = partial.ui) == null ? void 0 : _g.showInstallModal) != null ? _h : opts.ui.showInstallModal
+            headless: (_e = (_d = partial.ui) == null ? void 0 : _d.headless) != null ? _e : opts.ui.headless,
+            preferExtension: (_g = (_f = partial.ui) == null ? void 0 : _f.preferExtension) != null ? _g : opts.ui.preferExtension,
+            showInstallModal: (_i = (_h = partial.ui) == null ? void 0 : _h.showInstallModal) != null ? _i : opts.ui.showInstallModal
           }),
-          mobile: __spreadValues(__spreadValues({}, opts.mobile), (_i = partial.mobile) != null ? _i : {}),
-          transport: __spreadProps(__spreadValues({}, (_j = opts.transport) != null ? _j : {}), {
-            extensionId: (_m = (_k = partial.transport) == null ? void 0 : _k.extensionId) != null ? _m : (_l = opts.transport) == null ? void 0 : _l.extensionId
+          mobile: __spreadValues(__spreadValues({}, opts.mobile), (_j = partial.mobile) != null ? _j : {}),
+          transport: __spreadProps(__spreadValues({}, (_k = opts.transport) != null ? _k : {}), {
+            extensionId: (_n = (_l = partial.transport) == null ? void 0 : _l.extensionId) != null ? _n : (_m = opts.transport) == null ? void 0 : _m.extensionId
           }),
-          debug: (_n = partial.debug) != null ? _n : opts.debug
+          debug: (_o = partial.debug) != null ? _o : opts.debug
         });
       }
     };
@@ -647,35 +654,30 @@ function isRejectionError(error) {
 }
 function getBaseAnalyticsProperties(options, storage) {
   return __async(this, null, function* () {
-    var _a3, _b;
-    const version = getVersion();
+    var _a3;
     const dappId = getDappId(options.dapp);
     const platform = getPlatformType();
     const anonId = yield storage.getAnonId();
-    const integrationType = (_b = (_a3 = options.analytics) == null ? void 0 : _a3.integrationType) != null ? _b : "unknown" /* UNKNOWN */;
     return {
-      mmconnect_version: version,
+      mmconnect_versions: (_a3 = options.versions) != null ? _a3 : {},
       dapp_id: dappId,
       platform,
-      integration_type: integrationType,
       anon_id: anonId
     };
   });
 }
-function getWalletActionAnalyticsProperties(options, storage, invokeOptions) {
+function getWalletActionAnalyticsProperties(options, storage, invokeOptions, transportType) {
   return __async(this, null, function* () {
-    var _a3, _b;
-    const version = getVersion();
+    var _a3;
     const dappId = getDappId(options.dapp);
     const anonId = yield storage.getAnonId();
-    const integrationType = (_b = (_a3 = options.analytics) == null ? void 0 : _a3.integrationType) != null ? _b : "unknown";
     return {
-      mmconnect_version: version,
+      mmconnect_versions: (_a3 = options.versions) != null ? _a3 : {},
       dapp_id: dappId,
       method: invokeOptions.request.method,
-      integration_type: integrationType,
       caip_chain_id: invokeOptions.scope,
-      anon_id: anonId
+      anon_id: anonId,
+      transport_type: transportType
     };
   });
 }
@@ -1111,7 +1113,6 @@ var init_install = __esm({
           "mm-install-modal"
         );
         modal.showInstallModal = options.showInstallModal;
-        modal.sdkVersion = options.sdkVersion;
         modal.addEventListener("close", (ev) => {
           const { detail } = ev;
           options.onClose(detail == null ? void 0 : detail.shouldTerminate);
@@ -1464,10 +1465,11 @@ init_utils2();
 init_analytics();
 var _RequestRouter_instances, withAnalyticsTracking_fn, trackWalletActionRequested_fn, trackWalletActionSucceeded_fn, trackWalletActionFailed_fn, trackWalletActionRejected_fn;
 var RequestRouter = class {
-  constructor(transport, rpcClient, config) {
+  constructor(transport, rpcClient, config, transportType) {
     this.transport = transport;
     this.rpcClient = rpcClient;
     this.config = config;
+    this.transportType = transportType;
     __privateAdd(this, _RequestRouter_instances);
   }
   /**
@@ -1537,16 +1539,14 @@ var RequestRouter = class {
    */
   handleWithRpcNode(options) {
     return __async(this, null, function* () {
-      return __privateMethod(this, _RequestRouter_instances, withAnalyticsTracking_fn).call(this, options, () => __async(this, null, function* () {
-        try {
-          return yield this.rpcClient.request(options);
-        } catch (error) {
-          if (error instanceof MissingRpcEndpointErr) {
-            return this.handleWithWallet(options);
-          }
-          throw error;
+      try {
+        return yield this.rpcClient.request(options);
+      } catch (error) {
+        if (error instanceof MissingRpcEndpointErr) {
+          return this.handleWithWallet(options);
         }
-      }));
+        throw error;
+      }
     });
   }
   /**
@@ -1590,7 +1590,8 @@ trackWalletActionRequested_fn = function(options) {
     const props = yield getWalletActionAnalyticsProperties(
       this.config,
       this.config.storage,
-      options
+      options,
+      this.transportType
     );
     import_analytics2.analytics.track("mmconnect_wallet_action_requested", props);
   });
@@ -1600,7 +1601,8 @@ trackWalletActionSucceeded_fn = function(options) {
     const props = yield getWalletActionAnalyticsProperties(
       this.config,
       this.config.storage,
-      options
+      options,
+      this.transportType
     );
     import_analytics2.analytics.track("mmconnect_wallet_action_succeeded", props);
   });
@@ -1610,7 +1612,8 @@ trackWalletActionFailed_fn = function(options) {
     const props = yield getWalletActionAnalyticsProperties(
       this.config,
       this.config.storage,
-      options
+      options,
+      this.transportType
     );
     import_analytics2.analytics.track("mmconnect_wallet_action_failed", props);
   });
@@ -1620,7 +1623,8 @@ trackWalletActionRejected_fn = function(options) {
     const props = yield getWalletActionAnalyticsProperties(
       this.config,
       this.config.storage,
-      options
+      options,
+      this.transportType
     );
     import_analytics2.analytics.track("mmconnect_wallet_action_rejected", props);
   });
@@ -1863,7 +1867,9 @@ setupMessageListener_fn = function() {
 init_fn = function() {
   return __async(this, null, function* () {
     __privateMethod(this, _DefaultTransport_instances, setupMessageListener_fn).call(this);
-    yield __privateGet(this, _transport).connect();
+    if (!__privateGet(this, _transport).isConnected()) {
+      yield __privateGet(this, _transport).connect();
+    }
   });
 };
 
@@ -2708,16 +2714,21 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
   constructor(options) {
     var _a3, _b, _c, _d, _e, _f;
     const withDappMetadata = setupDappMetadata(options);
-    const integrationType = (_b = (_a3 = options.analytics) == null ? void 0 : _a3.integrationType) != null ? _b : "direct";
+    const integrationType = ((_a3 = options.analytics) == null ? void 0 : _a3.integrationType) || "direct";
     const allOptions = __spreadProps(__spreadValues({}, withDappMetadata), {
       ui: __spreadProps(__spreadValues({}, withDappMetadata.ui), {
-        preferExtension: (_c = withDappMetadata.ui.preferExtension) != null ? _c : true,
-        showInstallModal: (_d = withDappMetadata.ui.showInstallModal) != null ? _d : false,
-        headless: (_e = withDappMetadata.ui.headless) != null ? _e : false
+        preferExtension: (_b = withDappMetadata.ui.preferExtension) != null ? _b : true,
+        showInstallModal: (_c = withDappMetadata.ui.showInstallModal) != null ? _c : false,
+        headless: (_d = withDappMetadata.ui.headless) != null ? _d : false
       }),
-      analytics: __spreadProps(__spreadValues({}, (_f = options.analytics) != null ? _f : {}), {
+      analytics: __spreadProps(__spreadValues({}, (_e = options.analytics) != null ? _e : {}), {
         integrationType
-      })
+      }),
+      versions: __spreadValues({
+        // typeof guard needed: Metro (React Native) bundles TS source directly,
+        // bypassing the tsup build that substitutes __PACKAGE_VERSION__.
+        "connect-multichain": false ? "unknown" : "0.10.0"
+      }, (_f = options.versions) != null ? _f : {})
     });
     super(allOptions);
     __privateAdd(this, _MetaMaskConnectMultichain_instances);
@@ -2774,23 +2785,33 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
   // Creates a singleton instance of MetaMaskConnectMultichain.
   // If the singleton already exists, it merges the incoming options with the
   // existing singleton options for the following keys: `api.supportedNetworks`,
-  // `ui.*`, `mobile.*`, `transport.extensionId`, `debug`. Take note 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.
+  // `versions`, `ui.*`, `mobile.*`, `transport.extensionId`, `debug`. Take note
+  // 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.
   static create(options) {
     return __async(this, null, function* () {
+      var _a3, _b;
       const globalObject = getGlobalObject();
       const existing = globalObject[SINGLETON_KEY];
       if (existing) {
         const instance = yield existing;
         instance.mergeOptions(options);
+        import_analytics4.analytics.setGlobalProperty(
+          "mmconnect_versions",
+          (_a3 = instance.options.versions) != null ? _a3 : {}
+        );
+        if ((_b = options.analytics) == null ? void 0 : _b.integrationType) {
+          import_analytics4.analytics.setGlobalProperty("integration_types", [
+            options.analytics.integrationType
+          ]);
+        }
         if (options.debug) {
           enableDebug("metamask-sdk:*");
         }
         return instance;
       }
       const instancePromise = (() => __async(null, null, function* () {
-        var _a3;
+        var _a4;
         const instance = new _MetaMaskConnectMultichain(options);
         const isEnabled2 = yield isEnabled(
           "metamask-sdk:core",
@@ -2799,7 +2820,7 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
         if (isEnabled2) {
           enableDebug("metamask-sdk:core");
         }
-        yield __privateMethod(_a3 = instance, _MetaMaskConnectMultichain_instances, init_fn2).call(_a3);
+        yield __privateMethod(_a4 = instance, _MetaMaskConnectMultichain_instances, init_fn2).call(_a4);
         return instance;
       }))();
       globalObject[SINGLETON_KEY] = instancePromise;
@@ -2927,7 +2948,12 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
     return __async(this, null, function* () {
       const { transport, options } = this;
       const rpcClient = new RpcClient(options, __privateGet(this, _sdkInfo));
-      const requestRouter = new RequestRouter(transport, rpcClient, options);
+      const requestRouter = new RequestRouter(
+        transport,
+        rpcClient,
+        options,
+        this.transportType
+      );
       return requestRouter.invokeMethod(request);
     });
   }
@@ -2980,24 +3006,28 @@ _sdkInfo = new WeakMap();
 _MetaMaskConnectMultichain_instances = new WeakSet();
 setupAnalytics_fn = function() {
   return __async(this, null, function* () {
-    var _a3;
+    var _a3, _b;
     const platform = getPlatformType();
     const isBrowser = platform === "in-app-browser" /* MetaMaskMobileWebview */ || platform === "web-desktop" /* DesktopWeb */ || platform === "web-mobile" /* MobileWeb */;
     const isReactNative2 = platform === "react-native" /* ReactNative */;
     if (!isBrowser && !isReactNative2) {
       return;
     }
-    const version = getVersion();
     const dappId = getDappId(this.options.dapp);
     const anonId = yield this.storage.getAnonId();
     const { integrationType } = (_a3 = this.options.analytics) != null ? _a3 : {
       integrationType: ""
     };
-    import_analytics4.analytics.setGlobalProperty("mmconnect_version", version);
+    import_analytics4.analytics.setGlobalProperty(
+      "mmconnect_versions",
+      (_b = this.options.versions) != null ? _b : {}
+    );
     import_analytics4.analytics.setGlobalProperty("dapp_id", dappId);
     import_analytics4.analytics.setGlobalProperty("anon_id", anonId);
     import_analytics4.analytics.setGlobalProperty("platform", platform);
-    import_analytics4.analytics.setGlobalProperty("integration_type", integrationType);
+    if (integrationType) {
+      import_analytics4.analytics.setGlobalProperty("integration_types", [integrationType]);
+    }
     import_analytics4.analytics.enable();
   });
 };
@@ -3084,15 +3114,6 @@ init_fn2 = function() {
     try {
       yield __privateMethod(this, _MetaMaskConnectMultichain_instances, setupAnalytics_fn).call(this);
       yield __privateMethod(this, _MetaMaskConnectMultichain_instances, setupTransport_fn).call(this);
-      try {
-        const baseProps = yield getBaseAnalyticsProperties(
-          this.options,
-          this.storage
-        );
-        import_analytics4.analytics.track("mmconnect_initialized", baseProps);
-      } catch (error) {
-        logger2("Error tracking initialized event", error);
-      }
     } catch (error) {
       yield this.storage.removeTransport();
       this.status = "pending";
@@ -3746,7 +3767,6 @@ var BaseModalFactory = class {
         parentElement,
         showInstallModal,
         link: qrCodeLink,
-        sdkVersion: getVersion(),
         generateQRCode: (request) => __async(this, null, function* () {
           var _a4;
           const newLink = this.createConnectionDeeplink(request);
@@ -3772,7 +3792,6 @@ var BaseModalFactory = class {
       const otpCode = yield createOTPCode();
       const modal = new this.options.OTPCodeModal({
         parentElement: container,
-        sdkVersion: getVersion(),
         otpCode,
         onClose: this.onCloseModal.bind(this),
         createOTPCode,