@metamask/connect-multichain 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.10.0]
+
+### Changed
+
+- **BREAKING** `getInfuraRpcUrls` now accepts a single options object `{ infuraApiKey, caipChainIds? }` instead of a positional `infuraApiKey` string. The optional `caipChainIds` parameter filters the output to only the specified CAIP-2 chain IDs ([#211](https://github.com/MetaMask/connect-monorepo/pull/211))
+- use merged integration types in analytics ([#223](https://github.com/MetaMask/connect-monorepo/pull/223))
+
+### Fixed
+
+- fix: Fix react-native-playground consumption of **PACKAGE_VERSION** build-time constant in connect packages ([#221](https://github.com/MetaMask/connect-monorepo/pull/221))
+
 ## [0.9.0]
 
 ### Added
@@ -199,7 +210,8 @@ 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.9.0...HEAD
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.10.0...HEAD
+[0.10.0]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-multichain@0.9.0...@metamask/connect-multichain@0.10.0
 [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

package/README.md

@@ -32,7 +32,7 @@ const client = await createMultichainClient({
   api: {
     supportedNetworks: {
       // use the `getInfuraRpcUrls` helper to generate a map of Infura RPC endpoints
-      ...getInfuraRpcUrls(INFURA_API_KEY),
+      ...getInfuraRpcUrls({ infuraApiKey: INFURA_API_KEY }),
       // or specify your own CAIP Chain ID to rpc endpoint mapping
       'eip155:1': 'https://mainnet.example.io/rpc',
       'eip155:137': 'https://polygon-mainnet.example.io/rpc',
@@ -338,15 +338,16 @@ Emits an event to all registered handlers.
 
 ### Utilities
 
-#### `getInfuraRpcUrls(infuraApiKey)`
+#### `getInfuraRpcUrls(options)`
 
 Generates Infura RPC URLs for common networks keyed by CAIP Chain ID.
 
 **Parameters**
 
-| Name           | Type     | Required | Description         |
-| -------------- | -------- | -------- | ------------------- |
-| `infuraApiKey` | `string` | Yes      | Your Infura API key |
+| Name           | Type            | Required | Description                           |
+| -------------- | --------------- | -------- | ------------------------------------- |
+| `infuraApiKey` | `string`        | Yes      | Your Infura API key                   |
+| `caipChainIds` | `CaipChainId[]` | No       | CAIP-2 chain IDs to filter the output |
 
 **Returns**
 
@@ -355,13 +356,24 @@ A map of [CAIP-2 chain IDs](https://chainagnostic.org/CAIPs/caip-2) to Infura RP
 ```typescript
 import { getInfuraRpcUrls } from '@metamask/connect-multichain';
 
-const rpcUrls = getInfuraRpcUrls('YOUR_INFURA_KEY');
+// Get all supported Infura RPC URLs
+const rpcUrls = getInfuraRpcUrls({ infuraApiKey: 'YOUR_INFURA_KEY' });
 // {
 //   'eip155:1': 'https://mainnet.infura.io/v3/YOUR_KEY',
 //   'eip155:137': 'https://polygon-mainnet.infura.io/v3/YOUR_KEY',
 //   'eip155:11155111': 'https://sepolia.infura.io/v3/YOUR_KEY',
 //   ...
 // }
+
+// Filter to specific chains
+const filtered = getInfuraRpcUrls({
+  infuraApiKey: 'YOUR_INFURA_KEY',
+  caipChainIds: ['eip155:1', 'eip155:137'],
+});
+// {
+//   'eip155:1': 'https://mainnet.infura.io/v3/YOUR_KEY',
+//   'eip155:137': 'https://polygon-mainnet.infura.io/v3/YOUR_KEY',
+// }
 ```
 
 ---

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

@@ -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';
 
@@ -485,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 {
@@ -676,7 +687,6 @@ declare function getWalletActionAnalyticsProperties(options: MultichainOptions,
     mmconnect_versions: Record<string, string>;
     dapp_id: string;
     method: string;
-    integration_type: string;
     caip_chain_id: string;
     anon_id: string;
     transport_type: TransportType;

package/dist/browser/es/connect-multichain.mjs

@@ -356,10 +356,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;
   }, {});
 }
@@ -627,31 +633,27 @@ function isRejectionError(error) {
 }
 function getBaseAnalyticsProperties(options, storage) {
   return __async(this, null, function* () {
-    var _a3, _b, _c;
+    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_versions: (_c = options.versions) != null ? _c : {},
+      mmconnect_versions: (_a3 = options.versions) != null ? _a3 : {},
       dapp_id: dappId,
       platform,
-      integration_type: integrationType,
       anon_id: anonId
     };
   });
 }
 function getWalletActionAnalyticsProperties(options, storage, invokeOptions, transportType) {
   return __async(this, null, function* () {
-    var _a3, _b, _c;
+    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_versions: (_c = options.versions) != null ? _c : {},
+      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,
       transport_type: transportType
@@ -2670,21 +2672,23 @@ var SINGLETON_KEY = "__METAMASK_CONNECT_MULTICHAIN_SINGLETON__";
 var _a2, _provider, _providerTransportWrapper, _transport2, _dappClient, _beforeUnloadListener, _listener, _sdkInfo, _MetaMaskConnectMultichain_instances, setupAnalytics_fn, onTransportNotification_fn, getStoredTransport_fn, setupTransport_fn, init_fn2, createDappClient_fn, setupMWP_fn, onBeforeUnload_fn, createBeforeUnloadListener_fn, renderInstallModalAsync_fn, showInstallModal_fn, headlessConnect_fn, setupDefaultTransport_fn, deeplinkConnect_fn, handleConnection_fn, getCaipSession_fn, openConnectDeeplinkIfNeeded_fn;
 var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends MultichainCore {
   constructor(options) {
-    var _a3, _b, _c, _d, _e, _f, _g;
+    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({
-        "connect-multichain": "0.9.0"
-      }, (_g = options.versions) != null ? _g : {})
+        // 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);
@@ -2746,7 +2750,7 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
   // subsequent calls to `createMultichainClient` to have a different `dapp` value.
   static create(options) {
     return __async(this, null, function* () {
-      var _a3;
+      var _a3, _b;
       const globalObject = getGlobalObject();
       const existing = globalObject[SINGLETON_KEY];
       if (existing) {
@@ -2756,6 +2760,11 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
           "mmconnect_versions",
           (_a3 = instance.options.versions) != null ? _a3 : {}
         );
+        if ((_b = options.analytics) == null ? void 0 : _b.integrationType) {
+          analytics2.setGlobalProperty("integration_types", [
+            options.analytics.integrationType
+          ]);
+        }
         if (options.debug) {
           enableDebug("metamask-sdk:*");
         }
@@ -2976,7 +2985,9 @@ setupAnalytics_fn = function() {
     analytics2.setGlobalProperty("dapp_id", dappId);
     analytics2.setGlobalProperty("anon_id", anonId);
     analytics2.setGlobalProperty("platform", platform);
-    analytics2.setGlobalProperty("integration_type", integrationType);
+    if (integrationType) {
+      analytics2.setGlobalProperty("integration_types", [integrationType]);
+    }
     analytics2.enable();
   });
 };