@metamask/multichain-network-controller 0.2.0 → 0.4.0

package/dist/utils.mjs

@@ -1,7 +1,17 @@
 import { BtcScope, SolScope } from "@metamask/keyring-api";
-import { KnownCaipNamespace, toCaipChainId, hexToNumber } from "@metamask/utils";
+import { KnownCaipNamespace, toCaipChainId, parseCaipChainId, hexToNumber, add0x } from "@metamask/utils";
 import { isAddress as isSolanaAddress } from "@solana/addresses";
 import { AVAILABLE_MULTICHAIN_NETWORK_CONFIGURATIONS } from "./constants.mjs";
+/**
+ * Checks if the chain ID is EVM.
+ *
+ * @param chainId - The account type to check.
+ * @returns Whether the network is EVM.
+ */
+export function isEvmCaipChainId(chainId) {
+    const { namespace } = parseCaipChainId(chainId);
+    return namespace === KnownCaipNamespace.Eip155;
+}
 /**
  * Returns the chain id of the non-EVM network based on the account address.
  *
@@ -32,6 +42,19 @@ export function checkIfSupportedCaipChainId(id) {
  * @returns The Caip chain ID.
  */
 export const toEvmCaipChainId = (chainId) => toCaipChainId(KnownCaipNamespace.Eip155, hexToNumber(chainId).toString());
+/**
+ * Convert an eip155 CAIP chain ID to a hex chain ID.
+ *
+ * @param chainId - The CAIP chain ID to convert.
+ * @returns The hex chain ID.
+ */
+export function convertEvmCaipToHexChainId(chainId) {
+    const { namespace, reference } = parseCaipChainId(chainId);
+    if (namespace === KnownCaipNamespace.Eip155) {
+        return add0x(parseInt(reference, 10).toString(16));
+    }
+    throw new Error(`Unsupported CAIP chain ID namespace: ${namespace}. Only eip155 is supported.`);
+}
 /**
  * Updates a network configuration to the format used by the MultichainNetworkController.
  * This method is exclusive for EVM networks with hex identifiers from the NetworkController.
@@ -40,13 +63,14 @@ export const toEvmCaipChainId = (chainId) => toCaipChainId(KnownCaipNamespace.Ei
  * @returns The updated network configuration.
  */
 export const toMultichainNetworkConfiguration = (network) => {
+    const { chainId, name, rpcEndpoints, defaultRpcEndpointIndex, nativeCurrency, blockExplorerUrls, defaultBlockExplorerUrlIndex, } = network;
     return {
-        chainId: toEvmCaipChainId(network.chainId),
+        chainId: toEvmCaipChainId(chainId),
         isEvm: true,
-        name: network.name,
-        nativeCurrency: network.nativeCurrency,
-        blockExplorerUrls: network.blockExplorerUrls,
-        defaultBlockExplorerUrlIndex: network.defaultBlockExplorerUrlIndex || 0,
+        name: name || rpcEndpoints[defaultRpcEndpointIndex].url,
+        nativeCurrency,
+        blockExplorerUrls,
+        defaultBlockExplorerUrlIndex: defaultBlockExplorerUrlIndex || 0,
     };
 };
 /**

package/dist/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,8BAA8B;AAE3D,OAAO,EAGL,kBAAkB,EAClB,aAAa,EACb,WAAW,EACZ,wBAAwB;AACzB,OAAO,EAAE,SAAS,IAAI,eAAe,EAAE,0BAA0B;AAEjE,OAAO,EAAE,2CAA2C,EAAE,wBAAoB;AAM1E;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAAe;IAEf,2GAA2G;IAC3G,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE;QAC5B,OAAO,QAAQ,CAAC,OAAO,CAAC;KACzB;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,EAAe;IAEf,qCAAqC;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAY,EAAe,EAAE,CAC5D,aAAa,CAAC,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,OAA6B,EACG,EAAE;IAClC,OAAO;QACL,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1C,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;QAC5C,4BAA4B,EAAE,OAAO,CAAC,4BAA4B,IAAI,CAAC;KACxE,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG,CACxD,8BAAoE,EACf,EAAE,CACvD,MAAM,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC,MAAM,CACnD,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;IACrB,GAAG,GAAG;IACN,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EACjC,gCAAgC,CAAC,OAAO,CAAC;CAC5C,CAAC,EACF,EAAE,CACH,CAAC","sourcesContent":["import { BtcScope, SolScope } from '@metamask/keyring-api';\nimport type { NetworkConfiguration } from '@metamask/network-controller';\nimport {\n  type Hex,\n  type CaipChainId,\n  KnownCaipNamespace,\n  toCaipChainId,\n  hexToNumber,\n} from '@metamask/utils';\nimport { isAddress as isSolanaAddress } from '@solana/addresses';\n\nimport { AVAILABLE_MULTICHAIN_NETWORK_CONFIGURATIONS } from './constants';\nimport type {\n  SupportedCaipChainId,\n  MultichainNetworkConfiguration,\n} from './types';\n\n/**\n * Returns the chain id of the non-EVM network based on the account address.\n *\n * @param address - The address to check.\n * @returns The caip chain id of the non-EVM network.\n */\nexport function getChainIdForNonEvmAddress(\n  address: string,\n): SupportedCaipChainId {\n  // This condition is not the most robust. Once we support more networks, we will need to update this logic.\n  if (isSolanaAddress(address)) {\n    return SolScope.Mainnet;\n  }\n  return BtcScope.Mainnet;\n}\n\n/**\n * Checks if the Caip chain ID is supported.\n *\n * @param id - The Caip chain IDto check.\n * @returns Whether the chain ID is supported.\n */\nexport function checkIfSupportedCaipChainId(\n  id: CaipChainId,\n): id is SupportedCaipChainId {\n  // Check if the chain id is supported\n  return Object.keys(AVAILABLE_MULTICHAIN_NETWORK_CONFIGURATIONS).includes(id);\n}\n\n/**\n * Converts a hex chain ID to a Caip chain ID.\n *\n * @param chainId - The hex chain ID to convert.\n * @returns The Caip chain ID.\n */\nexport const toEvmCaipChainId = (chainId: Hex): CaipChainId =>\n  toCaipChainId(KnownCaipNamespace.Eip155, hexToNumber(chainId).toString());\n\n/**\n * Updates a network configuration to the format used by the MultichainNetworkController.\n * This method is exclusive for EVM networks with hex identifiers from the NetworkController.\n *\n * @param network - The network configuration to update.\n * @returns The updated network configuration.\n */\nexport const toMultichainNetworkConfiguration = (\n  network: NetworkConfiguration,\n): MultichainNetworkConfiguration => {\n  return {\n    chainId: toEvmCaipChainId(network.chainId),\n    isEvm: true,\n    name: network.name,\n    nativeCurrency: network.nativeCurrency,\n    blockExplorerUrls: network.blockExplorerUrls,\n    defaultBlockExplorerUrlIndex: network.defaultBlockExplorerUrlIndex || 0,\n  };\n};\n\n/**\n * Updates a record of network configurations to the format used by the MultichainNetworkController.\n * This method is exclusive for EVM networks with hex identifiers from the NetworkController.\n *\n * @param networkConfigurationsByChainId - The network configurations to update.\n * @returns The updated network configurations.\n */\nexport const toMultichainNetworkConfigurationsByChainId = (\n  networkConfigurationsByChainId: Record<string, NetworkConfiguration>,\n): Record<CaipChainId, MultichainNetworkConfiguration> =>\n  Object.entries(networkConfigurationsByChainId).reduce(\n    (acc, [, network]) => ({\n      ...acc,\n      [toEvmCaipChainId(network.chainId)]:\n        toMultichainNetworkConfiguration(network),\n    }),\n    {},\n  );\n"]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,8BAA8B;AAE3D,OAAO,EAGL,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,KAAK,EACN,wBAAwB;AACzB,OAAO,EAAE,SAAS,IAAI,eAAe,EAAE,0BAA0B;AAEjE,OAAO,EAAE,2CAA2C,EAAE,wBAAoB;AAM1E;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAoB;IACnD,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChD,OAAO,SAAS,KAAM,kBAAkB,CAAC,MAAiB,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAAe;IAEf,2GAA2G;IAC3G,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE;QAC5B,OAAO,QAAQ,CAAC,OAAO,CAAC;KACzB;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,EAAe;IAEf,qCAAqC;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAY,EAAe,EAAE,CAC5D,aAAa,CAAC,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,OAAoB;IAC7D,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC3D,IAAI,SAAS,KAAM,kBAAkB,CAAC,MAAiB,EAAE;QACvD,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;KACpD;IAED,MAAM,IAAI,KAAK,CACb,wCAAwC,SAAS,6BAA6B,CAC/E,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,OAA6B,EACG,EAAE;IAClC,MAAM,EACJ,OAAO,EACP,IAAI,EACJ,YAAY,EACZ,uBAAuB,EACvB,cAAc,EACd,iBAAiB,EACjB,4BAA4B,GAC7B,GAAG,OAAO,CAAC;IACZ,OAAO;QACL,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;QAClC,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,IAAI,IAAI,YAAY,CAAC,uBAAuB,CAAC,CAAC,GAAG;QACvD,cAAc;QACd,iBAAiB;QACjB,4BAA4B,EAAE,4BAA4B,IAAI,CAAC;KAChE,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG,CACxD,8BAAoE,EACf,EAAE,CACvD,MAAM,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC,MAAM,CACnD,CAAC,GAAG,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;IACrB,GAAG,GAAG;IACN,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EACjC,gCAAgC,CAAC,OAAO,CAAC;CAC5C,CAAC,EACF,EAAE,CACH,CAAC","sourcesContent":["import { BtcScope, SolScope } from '@metamask/keyring-api';\nimport type { NetworkConfiguration } from '@metamask/network-controller';\nimport {\n  type Hex,\n  type CaipChainId,\n  KnownCaipNamespace,\n  toCaipChainId,\n  parseCaipChainId,\n  hexToNumber,\n  add0x,\n} from '@metamask/utils';\nimport { isAddress as isSolanaAddress } from '@solana/addresses';\n\nimport { AVAILABLE_MULTICHAIN_NETWORK_CONFIGURATIONS } from './constants';\nimport type {\n  SupportedCaipChainId,\n  MultichainNetworkConfiguration,\n} from './types';\n\n/**\n * Checks if the chain ID is EVM.\n *\n * @param chainId - The account type to check.\n * @returns Whether the network is EVM.\n */\nexport function isEvmCaipChainId(chainId: CaipChainId): boolean {\n  const { namespace } = parseCaipChainId(chainId);\n  return namespace === (KnownCaipNamespace.Eip155 as string);\n}\n\n/**\n * Returns the chain id of the non-EVM network based on the account address.\n *\n * @param address - The address to check.\n * @returns The caip chain id of the non-EVM network.\n */\nexport function getChainIdForNonEvmAddress(\n  address: string,\n): SupportedCaipChainId {\n  // This condition is not the most robust. Once we support more networks, we will need to update this logic.\n  if (isSolanaAddress(address)) {\n    return SolScope.Mainnet;\n  }\n  return BtcScope.Mainnet;\n}\n\n/**\n * Checks if the Caip chain ID is supported.\n *\n * @param id - The Caip chain IDto check.\n * @returns Whether the chain ID is supported.\n */\nexport function checkIfSupportedCaipChainId(\n  id: CaipChainId,\n): id is SupportedCaipChainId {\n  // Check if the chain id is supported\n  return Object.keys(AVAILABLE_MULTICHAIN_NETWORK_CONFIGURATIONS).includes(id);\n}\n\n/**\n * Converts a hex chain ID to a Caip chain ID.\n *\n * @param chainId - The hex chain ID to convert.\n * @returns The Caip chain ID.\n */\nexport const toEvmCaipChainId = (chainId: Hex): CaipChainId =>\n  toCaipChainId(KnownCaipNamespace.Eip155, hexToNumber(chainId).toString());\n\n/**\n * Convert an eip155 CAIP chain ID to a hex chain ID.\n *\n * @param chainId - The CAIP chain ID to convert.\n * @returns The hex chain ID.\n */\nexport function convertEvmCaipToHexChainId(chainId: CaipChainId): Hex {\n  const { namespace, reference } = parseCaipChainId(chainId);\n  if (namespace === (KnownCaipNamespace.Eip155 as string)) {\n    return add0x(parseInt(reference, 10).toString(16));\n  }\n\n  throw new Error(\n    `Unsupported CAIP chain ID namespace: ${namespace}. Only eip155 is supported.`,\n  );\n}\n\n/**\n * Updates a network configuration to the format used by the MultichainNetworkController.\n * This method is exclusive for EVM networks with hex identifiers from the NetworkController.\n *\n * @param network - The network configuration to update.\n * @returns The updated network configuration.\n */\nexport const toMultichainNetworkConfiguration = (\n  network: NetworkConfiguration,\n): MultichainNetworkConfiguration => {\n  const {\n    chainId,\n    name,\n    rpcEndpoints,\n    defaultRpcEndpointIndex,\n    nativeCurrency,\n    blockExplorerUrls,\n    defaultBlockExplorerUrlIndex,\n  } = network;\n  return {\n    chainId: toEvmCaipChainId(chainId),\n    isEvm: true,\n    name: name || rpcEndpoints[defaultRpcEndpointIndex].url,\n    nativeCurrency,\n    blockExplorerUrls,\n    defaultBlockExplorerUrlIndex: defaultBlockExplorerUrlIndex || 0,\n  };\n};\n\n/**\n * Updates a record of network configurations to the format used by the MultichainNetworkController.\n * This method is exclusive for EVM networks with hex identifiers from the NetworkController.\n *\n * @param networkConfigurationsByChainId - The network configurations to update.\n * @returns The updated network configurations.\n */\nexport const toMultichainNetworkConfigurationsByChainId = (\n  networkConfigurationsByChainId: Record<string, NetworkConfiguration>,\n): Record<CaipChainId, MultichainNetworkConfiguration> =>\n  Object.entries(networkConfigurationsByChainId).reduce(\n    (acc, [, network]) => ({\n      ...acc,\n      [toEvmCaipChainId(network.chainId)]:\n        toMultichainNetworkConfiguration(network),\n    }),\n    {},\n  );\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/multichain-network-controller",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Multichain network controller",
   "keywords": [
     "MetaMask",
@@ -48,14 +48,15 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^8.0.0",
-    "@metamask/keyring-api": "^17.2.0",
+    "@metamask/keyring-api": "^17.4.0",
     "@metamask/utils": "^11.2.0",
     "@solana/addresses": "^2.0.0"
   },
   "devDependencies": {
+    "@metamask/accounts-controller": "^27.0.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/keyring-controller": "^21.0.0",
-    "@metamask/network-controller": "^22.2.1",
+    "@metamask/keyring-controller": "^21.0.2",
+    "@metamask/network-controller": "^23.2.0",
     "@types/jest": "^27.4.1",
     "@types/uuid": "^8.3.0",
     "deepmerge": "^4.2.2",
@@ -68,8 +69,8 @@
     "typescript": "~5.2.2"
   },
   "peerDependencies": {
-    "@metamask/accounts-controller": "^26.0.0",
-    "@metamask/network-controller": "^22.0.0"
+    "@metamask/accounts-controller": "^27.0.0",
+    "@metamask/network-controller": "^23.0.0"
   },
   "engines": {
     "node": "^18.18 || >=20"