@metamask/utils 7.0.0 → 7.1.0

package/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.1.0]
+### Added
+- CAIP-2 and CAIP-10 Types ([#116](https://github.com/MetaMask/utils/pull/116))
+
 ## [7.0.0]
 ### Added
 - Add `getKnownPropertyNames` function ([#111](https://github.com/MetaMask/utils/pull/111))
@@ -174,7 +178,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/utils/compare/v7.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/utils/compare/v7.1.0...HEAD
+[7.1.0]: https://github.com/MetaMask/utils/compare/v7.0.0...v7.1.0
 [7.0.0]: https://github.com/MetaMask/utils/compare/v6.2.0...v7.0.0
 [6.2.0]: https://github.com/MetaMask/utils/compare/v6.1.0...v6.2.0
 [6.1.0]: https://github.com/MetaMask/utils/compare/v6.0.1...v6.1.0

package/dist/cjs/caip-types.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    CAIP_CHAIN_ID_REGEX: function() {
+        return CAIP_CHAIN_ID_REGEX;
+    },
+    CAIP_NAMESPACE_REGEX: function() {
+        return CAIP_NAMESPACE_REGEX;
+    },
+    CAIP_REFERENCE_REGEX: function() {
+        return CAIP_REFERENCE_REGEX;
+    },
+    CAIP_ACCOUNT_ID_REGEX: function() {
+        return CAIP_ACCOUNT_ID_REGEX;
+    },
+    CAIP_ACCOUNT_ADDRESS_REGEX: function() {
+        return CAIP_ACCOUNT_ADDRESS_REGEX;
+    },
+    CaipChainIdStruct: function() {
+        return CaipChainIdStruct;
+    },
+    CaipNamespaceStruct: function() {
+        return CaipNamespaceStruct;
+    },
+    CaipReferenceStruct: function() {
+        return CaipReferenceStruct;
+    },
+    CaipAccountIdStruct: function() {
+        return CaipAccountIdStruct;
+    },
+    CaipAccountAddressStruct: function() {
+        return CaipAccountAddressStruct;
+    },
+    isCaipChainId: function() {
+        return isCaipChainId;
+    },
+    isCaipNamespace: function() {
+        return isCaipNamespace;
+    },
+    isCaipReference: function() {
+        return isCaipReference;
+    },
+    isCaipAccountId: function() {
+        return isCaipAccountId;
+    },
+    isCaipAccountAddress: function() {
+        return isCaipAccountAddress;
+    },
+    parseCaipChainId: function() {
+        return parseCaipChainId;
+    },
+    parseCaipAccountId: function() {
+        return parseCaipAccountId;
+    }
+});
+const _superstruct = require("superstruct");
+const CAIP_CHAIN_ID_REGEX = RegExp("^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})$", "u");
+const CAIP_NAMESPACE_REGEX = /^[-a-z0-9]{3,8}$/u;
+const CAIP_REFERENCE_REGEX = /^[-_a-zA-Z0-9]{1,32}$/u;
+const CAIP_ACCOUNT_ID_REGEX = RegExp("^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})):(?<accountAddress>[-.%a-zA-Z0-9]{1,128})$", "u");
+const CAIP_ACCOUNT_ADDRESS_REGEX = /^[-.%a-zA-Z0-9]{1,128}$/u;
+const CaipChainIdStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), CAIP_CHAIN_ID_REGEX);
+const CaipNamespaceStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), CAIP_NAMESPACE_REGEX);
+const CaipReferenceStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), CAIP_REFERENCE_REGEX);
+const CaipAccountIdStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), CAIP_ACCOUNT_ID_REGEX);
+const CaipAccountAddressStruct = (0, _superstruct.pattern)((0, _superstruct.string)(), CAIP_ACCOUNT_ADDRESS_REGEX);
+function isCaipChainId(value) {
+    return (0, _superstruct.is)(value, CaipChainIdStruct);
+}
+function isCaipNamespace(value) {
+    return (0, _superstruct.is)(value, CaipNamespaceStruct);
+}
+function isCaipReference(value) {
+    return (0, _superstruct.is)(value, CaipReferenceStruct);
+}
+function isCaipAccountId(value) {
+    return (0, _superstruct.is)(value, CaipAccountIdStruct);
+}
+function isCaipAccountAddress(value) {
+    return (0, _superstruct.is)(value, CaipAccountAddressStruct);
+}
+function parseCaipChainId(caipChainId) {
+    const match = CAIP_CHAIN_ID_REGEX.exec(caipChainId);
+    if (!match?.groups) {
+        throw new Error('Invalid CAIP chain ID.');
+    }
+    return {
+        namespace: match.groups.namespace,
+        reference: match.groups.reference
+    };
+}
+function parseCaipAccountId(caipAccountId) {
+    const match = CAIP_ACCOUNT_ID_REGEX.exec(caipAccountId);
+    if (!match?.groups) {
+        throw new Error('Invalid CAIP account ID.');
+    }
+    return {
+        address: match.groups.accountAddress,
+        chainId: match.groups.chainId,
+        chain: {
+            namespace: match.groups.namespace,
+            reference: match.groups.reference
+        }
+    };
+}
+
+//# sourceMappingURL=caip-types.js.map

package/dist/cjs/caip-types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/caip-types.ts"],"sourcesContent":["import type { Infer } from 'superstruct';\nimport { is, pattern, string } from 'superstruct';\n\nexport const CAIP_CHAIN_ID_REGEX =\n  /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})$/u;\n\nexport const CAIP_NAMESPACE_REGEX = /^[-a-z0-9]{3,8}$/u;\n\nexport const CAIP_REFERENCE_REGEX = /^[-_a-zA-Z0-9]{1,32}$/u;\n\nexport const CAIP_ACCOUNT_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})):(?<accountAddress>[-.%a-zA-Z0-9]{1,128})$/u;\n\nexport const CAIP_ACCOUNT_ADDRESS_REGEX = /^[-.%a-zA-Z0-9]{1,128}$/u;\n\n/**\n * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.\n */\nexport const CaipChainIdStruct = pattern(string(), CAIP_CHAIN_ID_REGEX);\nexport type CaipChainId = `${string}:${string}`;\n\n/**\n * A CAIP-2 namespace, i.e., the first part of a CAIP chain ID.\n */\nexport const CaipNamespaceStruct = pattern(string(), CAIP_NAMESPACE_REGEX);\nexport type CaipNamespace = Infer<typeof CaipNamespaceStruct>;\n\n/**\n * A CAIP-2 reference, i.e., the second part of a CAIP chain ID.\n */\nexport const CaipReferenceStruct = pattern(string(), CAIP_REFERENCE_REGEX);\nexport type CaipReference = Infer<typeof CaipReferenceStruct>;\n\n/**\n * A CAIP-10 account ID, i.e., a human-readable namespace, reference, and account address.\n */\nexport const CaipAccountIdStruct = pattern(string(), CAIP_ACCOUNT_ID_REGEX);\nexport type CaipAccountId = `${string}:${string}:${string}`;\n\n/**\n * A CAIP-10 account address, i.e., the third part of the CAIP account ID.\n */\nexport const CaipAccountAddressStruct = pattern(\n  string(),\n  CAIP_ACCOUNT_ADDRESS_REGEX,\n);\nexport type CaipAccountAddress = Infer<typeof CaipAccountAddressStruct>;\n\n/**\n * Check if the given value is a {@link CaipChainId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipChainId}.\n */\nexport function isCaipChainId(value: unknown): value is CaipChainId {\n  return is(value, CaipChainIdStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipNamespace}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipNamespace}.\n */\nexport function isCaipNamespace(value: unknown): value is CaipNamespace {\n  return is(value, CaipNamespaceStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipReference}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipReference}.\n */\nexport function isCaipReference(value: unknown): value is CaipReference {\n  return is(value, CaipReferenceStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipAccountId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipAccountId}.\n */\nexport function isCaipAccountId(value: unknown): value is CaipAccountId {\n  return is(value, CaipAccountIdStruct);\n}\n\n/**\n * Check if a value is a {@link CaipAccountAddress}.\n *\n * @param value - The value to validate.\n * @returns True if the value is a valid {@link CaipAccountAddress}.\n */\nexport function isCaipAccountAddress(\n  value: unknown,\n): value is CaipAccountAddress {\n  return is(value, CaipAccountAddressStruct);\n}\n\n/**\n * Parse a CAIP-2 chain ID to an object containing the namespace and reference.\n * This validates the CAIP-2 chain ID before parsing it.\n *\n * @param caipChainId - The CAIP-2 chain ID to validate and parse.\n * @returns The parsed CAIP-2 chain ID.\n */\nexport function parseCaipChainId(caipChainId: CaipChainId): {\n  namespace: CaipNamespace;\n  reference: CaipReference;\n} {\n  const match = CAIP_CHAIN_ID_REGEX.exec(caipChainId);\n  if (!match?.groups) {\n    throw new Error('Invalid CAIP chain ID.');\n  }\n\n  return {\n    namespace: match.groups.namespace as CaipNamespace,\n    reference: match.groups.reference as CaipReference,\n  };\n}\n\n/**\n * Parse an CAIP-10 account ID to an object containing the chain ID, parsed chain ID, and account address.\n * This validates the CAIP-10 account ID before parsing it.\n *\n * @param caipAccountId - The CAIP-10 account ID to validate and parse.\n * @returns The parsed CAIP-10 account ID.\n */\nexport function parseCaipAccountId(caipAccountId: CaipAccountId): {\n  address: CaipAccountAddress;\n  chainId: CaipChainId;\n  chain: { namespace: CaipNamespace; reference: CaipReference };\n} {\n  const match = CAIP_ACCOUNT_ID_REGEX.exec(caipAccountId);\n  if (!match?.groups) {\n    throw new Error('Invalid CAIP account ID.');\n  }\n\n  return {\n    address: match.groups.accountAddress as CaipAccountAddress,\n    chainId: match.groups.chainId as CaipChainId,\n    chain: {\n      namespace: match.groups.namespace as CaipNamespace,\n      reference: match.groups.reference as CaipReference,\n    },\n  };\n}\n"],"names":["CAIP_CHAIN_ID_REGEX","CAIP_NAMESPACE_REGEX","CAIP_REFERENCE_REGEX","CAIP_ACCOUNT_ID_REGEX","CAIP_ACCOUNT_ADDRESS_REGEX","CaipChainIdStruct","CaipNamespaceStruct","CaipReferenceStruct","CaipAccountIdStruct","CaipAccountAddressStruct","isCaipChainId","isCaipNamespace","isCaipReference","isCaipAccountId","isCaipAccountAddress","parseCaipChainId","parseCaipAccountId","pattern","string","value","is","caipChainId","match","exec","groups","Error","namespace","reference","caipAccountId","address","accountAddress","chainId","chain"],"mappings":";;;;;;;;;;;IAGaA,mBAAmB;eAAnBA;;IAGAC,oBAAoB;eAApBA;;IAEAC,oBAAoB;eAApBA;;IAEAC,qBAAqB;eAArBA;;IAGAC,0BAA0B;eAA1BA;;IAKAC,iBAAiB;eAAjBA;;IAMAC,mBAAmB;eAAnBA;;IAMAC,mBAAmB;eAAnBA;;IAMAC,mBAAmB;eAAnBA;;IAMAC,wBAAwB;eAAxBA;;IAYGC,aAAa;eAAbA;;IAUAC,eAAe;eAAfA;;IAUAC,eAAe;eAAfA;;IAUAC,eAAe;eAAfA;;IAUAC,oBAAoB;eAApBA;;IAaAC,gBAAgB;eAAhBA;;IAsBAC,kBAAkB;eAAlBA;;;6BAhIoB;AAE7B,MAAMhB,sBACX;AAEK,MAAMC,uBAAuB;AAE7B,MAAMC,uBAAuB;AAE7B,MAAMC,wBACX;AAEK,MAAMC,6BAA6B;AAKnC,MAAMC,oBAAoBY,IAAAA,oBAAO,EAACC,IAAAA,mBAAM,KAAIlB;AAM5C,MAAMM,sBAAsBW,IAAAA,oBAAO,EAACC,IAAAA,mBAAM,KAAIjB;AAM9C,MAAMM,sBAAsBU,IAAAA,oBAAO,EAACC,IAAAA,mBAAM,KAAIhB;AAM9C,MAAMM,sBAAsBS,IAAAA,oBAAO,EAACC,IAAAA,mBAAM,KAAIf;AAM9C,MAAMM,2BAA2BQ,IAAAA,oBAAO,EAC7CC,IAAAA,mBAAM,KACNd;AAUK,SAASM,cAAcS,KAAc;IAC1C,OAAOC,IAAAA,eAAE,EAACD,OAAOd;AACnB;AAQO,SAASM,gBAAgBQ,KAAc;IAC5C,OAAOC,IAAAA,eAAE,EAACD,OAAOb;AACnB;AAQO,SAASM,gBAAgBO,KAAc;IAC5C,OAAOC,IAAAA,eAAE,EAACD,OAAOZ;AACnB;AAQO,SAASM,gBAAgBM,KAAc;IAC5C,OAAOC,IAAAA,eAAE,EAACD,OAAOX;AACnB;AAQO,SAASM,qBACdK,KAAc;IAEd,OAAOC,IAAAA,eAAE,EAACD,OAAOV;AACnB;AASO,SAASM,iBAAiBM,WAAwB;IAIvD,MAAMC,QAAQtB,oBAAoBuB,IAAI,CAACF;IACvC,IAAI,CAACC,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLC,WAAWJ,MAAME,MAAM,CAACE,SAAS;QACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;IACnC;AACF;AASO,SAASX,mBAAmBY,aAA4B;IAK7D,MAAMN,QAAQnB,sBAAsBoB,IAAI,CAACK;IACzC,IAAI,CAACN,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLI,SAASP,MAAME,MAAM,CAACM,cAAc;QACpCC,SAAST,MAAME,MAAM,CAACO,OAAO;QAC7BC,OAAO;YACLN,WAAWJ,MAAME,MAAM,CAACE,SAAS;YACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;QACnC;IACF;AACF"}

package/dist/cjs/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 _export_star(require("./assert"), exports);
 _export_star(require("./base64"), exports);
 _export_star(require("./bytes"), exports);
+_export_star(require("./caip-types"), exports);
 _export_star(require("./checksum"), exports);
 _export_star(require("./coercers"), exports);
 _export_star(require("./collections"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './assert';\nexport * from './base64';\nexport * from './bytes';\nexport * from './checksum';\nexport * from './coercers';\nexport * from './collections';\nexport * from './encryption-types';\nexport * from './hex';\nexport * from './json';\nexport * from './keyring';\nexport * from './logging';\nexport * from './misc';\nexport * from './number';\nexport * from './opaque';\nexport * from './time';\nexport * from './transaction-types';\nexport * from './versions';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './assert';\nexport * from './base64';\nexport * from './bytes';\nexport * from './caip-types';\nexport * from './checksum';\nexport * from './coercers';\nexport * from './collections';\nexport * from './encryption-types';\nexport * from './hex';\nexport * from './json';\nexport * from './keyring';\nexport * from './logging';\nexport * from './misc';\nexport * from './number';\nexport * from './opaque';\nexport * from './time';\nexport * from './transaction-types';\nexport * from './versions';\n"],"names":[],"mappings":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/esm/caip-types.js

@@ -0,0 +1,99 @@
+import { is, pattern, string } from 'superstruct';
+export const CAIP_CHAIN_ID_REGEX = RegExp("^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})$", "u");
+export const CAIP_NAMESPACE_REGEX = /^[-a-z0-9]{3,8}$/u;
+export const CAIP_REFERENCE_REGEX = /^[-_a-zA-Z0-9]{1,32}$/u;
+export const CAIP_ACCOUNT_ID_REGEX = RegExp("^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})):(?<accountAddress>[-.%a-zA-Z0-9]{1,128})$", "u");
+export const CAIP_ACCOUNT_ADDRESS_REGEX = /^[-.%a-zA-Z0-9]{1,128}$/u;
+/**
+ * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
+ */ export const CaipChainIdStruct = pattern(string(), CAIP_CHAIN_ID_REGEX);
+/**
+ * A CAIP-2 namespace, i.e., the first part of a CAIP chain ID.
+ */ export const CaipNamespaceStruct = pattern(string(), CAIP_NAMESPACE_REGEX);
+/**
+ * A CAIP-2 reference, i.e., the second part of a CAIP chain ID.
+ */ export const CaipReferenceStruct = pattern(string(), CAIP_REFERENCE_REGEX);
+/**
+ * A CAIP-10 account ID, i.e., a human-readable namespace, reference, and account address.
+ */ export const CaipAccountIdStruct = pattern(string(), CAIP_ACCOUNT_ID_REGEX);
+/**
+ * A CAIP-10 account address, i.e., the third part of the CAIP account ID.
+ */ export const CaipAccountAddressStruct = pattern(string(), CAIP_ACCOUNT_ADDRESS_REGEX);
+/**
+ * Check if the given value is a {@link CaipChainId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipChainId}.
+ */ export function isCaipChainId(value) {
+    return is(value, CaipChainIdStruct);
+}
+/**
+ * Check if the given value is a {@link CaipNamespace}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipNamespace}.
+ */ export function isCaipNamespace(value) {
+    return is(value, CaipNamespaceStruct);
+}
+/**
+ * Check if the given value is a {@link CaipReference}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipReference}.
+ */ export function isCaipReference(value) {
+    return is(value, CaipReferenceStruct);
+}
+/**
+ * Check if the given value is a {@link CaipAccountId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipAccountId}.
+ */ export function isCaipAccountId(value) {
+    return is(value, CaipAccountIdStruct);
+}
+/**
+ * Check if a value is a {@link CaipAccountAddress}.
+ *
+ * @param value - The value to validate.
+ * @returns True if the value is a valid {@link CaipAccountAddress}.
+ */ export function isCaipAccountAddress(value) {
+    return is(value, CaipAccountAddressStruct);
+}
+/**
+ * Parse a CAIP-2 chain ID to an object containing the namespace and reference.
+ * This validates the CAIP-2 chain ID before parsing it.
+ *
+ * @param caipChainId - The CAIP-2 chain ID to validate and parse.
+ * @returns The parsed CAIP-2 chain ID.
+ */ export function parseCaipChainId(caipChainId) {
+    const match = CAIP_CHAIN_ID_REGEX.exec(caipChainId);
+    if (!match?.groups) {
+        throw new Error('Invalid CAIP chain ID.');
+    }
+    return {
+        namespace: match.groups.namespace,
+        reference: match.groups.reference
+    };
+}
+/**
+ * Parse an CAIP-10 account ID to an object containing the chain ID, parsed chain ID, and account address.
+ * This validates the CAIP-10 account ID before parsing it.
+ *
+ * @param caipAccountId - The CAIP-10 account ID to validate and parse.
+ * @returns The parsed CAIP-10 account ID.
+ */ export function parseCaipAccountId(caipAccountId) {
+    const match = CAIP_ACCOUNT_ID_REGEX.exec(caipAccountId);
+    if (!match?.groups) {
+        throw new Error('Invalid CAIP account ID.');
+    }
+    return {
+        address: match.groups.accountAddress,
+        chainId: match.groups.chainId,
+        chain: {
+            namespace: match.groups.namespace,
+            reference: match.groups.reference
+        }
+    };
+}
+
+//# sourceMappingURL=caip-types.js.map

package/dist/esm/caip-types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/caip-types.ts"],"sourcesContent":["import type { Infer } from 'superstruct';\nimport { is, pattern, string } from 'superstruct';\n\nexport const CAIP_CHAIN_ID_REGEX =\n  /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})$/u;\n\nexport const CAIP_NAMESPACE_REGEX = /^[-a-z0-9]{3,8}$/u;\n\nexport const CAIP_REFERENCE_REGEX = /^[-_a-zA-Z0-9]{1,32}$/u;\n\nexport const CAIP_ACCOUNT_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})):(?<accountAddress>[-.%a-zA-Z0-9]{1,128})$/u;\n\nexport const CAIP_ACCOUNT_ADDRESS_REGEX = /^[-.%a-zA-Z0-9]{1,128}$/u;\n\n/**\n * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.\n */\nexport const CaipChainIdStruct = pattern(string(), CAIP_CHAIN_ID_REGEX);\nexport type CaipChainId = `${string}:${string}`;\n\n/**\n * A CAIP-2 namespace, i.e., the first part of a CAIP chain ID.\n */\nexport const CaipNamespaceStruct = pattern(string(), CAIP_NAMESPACE_REGEX);\nexport type CaipNamespace = Infer<typeof CaipNamespaceStruct>;\n\n/**\n * A CAIP-2 reference, i.e., the second part of a CAIP chain ID.\n */\nexport const CaipReferenceStruct = pattern(string(), CAIP_REFERENCE_REGEX);\nexport type CaipReference = Infer<typeof CaipReferenceStruct>;\n\n/**\n * A CAIP-10 account ID, i.e., a human-readable namespace, reference, and account address.\n */\nexport const CaipAccountIdStruct = pattern(string(), CAIP_ACCOUNT_ID_REGEX);\nexport type CaipAccountId = `${string}:${string}:${string}`;\n\n/**\n * A CAIP-10 account address, i.e., the third part of the CAIP account ID.\n */\nexport const CaipAccountAddressStruct = pattern(\n  string(),\n  CAIP_ACCOUNT_ADDRESS_REGEX,\n);\nexport type CaipAccountAddress = Infer<typeof CaipAccountAddressStruct>;\n\n/**\n * Check if the given value is a {@link CaipChainId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipChainId}.\n */\nexport function isCaipChainId(value: unknown): value is CaipChainId {\n  return is(value, CaipChainIdStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipNamespace}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipNamespace}.\n */\nexport function isCaipNamespace(value: unknown): value is CaipNamespace {\n  return is(value, CaipNamespaceStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipReference}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipReference}.\n */\nexport function isCaipReference(value: unknown): value is CaipReference {\n  return is(value, CaipReferenceStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipAccountId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipAccountId}.\n */\nexport function isCaipAccountId(value: unknown): value is CaipAccountId {\n  return is(value, CaipAccountIdStruct);\n}\n\n/**\n * Check if a value is a {@link CaipAccountAddress}.\n *\n * @param value - The value to validate.\n * @returns True if the value is a valid {@link CaipAccountAddress}.\n */\nexport function isCaipAccountAddress(\n  value: unknown,\n): value is CaipAccountAddress {\n  return is(value, CaipAccountAddressStruct);\n}\n\n/**\n * Parse a CAIP-2 chain ID to an object containing the namespace and reference.\n * This validates the CAIP-2 chain ID before parsing it.\n *\n * @param caipChainId - The CAIP-2 chain ID to validate and parse.\n * @returns The parsed CAIP-2 chain ID.\n */\nexport function parseCaipChainId(caipChainId: CaipChainId): {\n  namespace: CaipNamespace;\n  reference: CaipReference;\n} {\n  const match = CAIP_CHAIN_ID_REGEX.exec(caipChainId);\n  if (!match?.groups) {\n    throw new Error('Invalid CAIP chain ID.');\n  }\n\n  return {\n    namespace: match.groups.namespace as CaipNamespace,\n    reference: match.groups.reference as CaipReference,\n  };\n}\n\n/**\n * Parse an CAIP-10 account ID to an object containing the chain ID, parsed chain ID, and account address.\n * This validates the CAIP-10 account ID before parsing it.\n *\n * @param caipAccountId - The CAIP-10 account ID to validate and parse.\n * @returns The parsed CAIP-10 account ID.\n */\nexport function parseCaipAccountId(caipAccountId: CaipAccountId): {\n  address: CaipAccountAddress;\n  chainId: CaipChainId;\n  chain: { namespace: CaipNamespace; reference: CaipReference };\n} {\n  const match = CAIP_ACCOUNT_ID_REGEX.exec(caipAccountId);\n  if (!match?.groups) {\n    throw new Error('Invalid CAIP account ID.');\n  }\n\n  return {\n    address: match.groups.accountAddress as CaipAccountAddress,\n    chainId: match.groups.chainId as CaipChainId,\n    chain: {\n      namespace: match.groups.namespace as CaipNamespace,\n      reference: match.groups.reference as CaipReference,\n    },\n  };\n}\n"],"names":["is","pattern","string","CAIP_CHAIN_ID_REGEX","CAIP_NAMESPACE_REGEX","CAIP_REFERENCE_REGEX","CAIP_ACCOUNT_ID_REGEX","CAIP_ACCOUNT_ADDRESS_REGEX","CaipChainIdStruct","CaipNamespaceStruct","CaipReferenceStruct","CaipAccountIdStruct","CaipAccountAddressStruct","isCaipChainId","value","isCaipNamespace","isCaipReference","isCaipAccountId","isCaipAccountAddress","parseCaipChainId","caipChainId","match","exec","groups","Error","namespace","reference","parseCaipAccountId","caipAccountId","address","accountAddress","chainId","chain"],"mappings":"AACA,SAASA,EAAE,EAAEC,OAAO,EAAEC,MAAM,QAAQ,cAAc;AAElD,OAAO,MAAMC,sBACX,gFAAoE;AAEtE,OAAO,MAAMC,uBAAuB,oBAAoB;AAExD,OAAO,MAAMC,uBAAuB,yBAAyB;AAE7D,OAAO,MAAMC,wBACX,qIAAyH;AAE3H,OAAO,MAAMC,6BAA6B,2BAA2B;AAErE;;CAEC,GACD,OAAO,MAAMC,oBAAoBP,QAAQC,UAAUC,qBAAqB;AAGxE;;CAEC,GACD,OAAO,MAAMM,sBAAsBR,QAAQC,UAAUE,sBAAsB;AAG3E;;CAEC,GACD,OAAO,MAAMM,sBAAsBT,QAAQC,UAAUG,sBAAsB;AAG3E;;CAEC,GACD,OAAO,MAAMM,sBAAsBV,QAAQC,UAAUI,uBAAuB;AAG5E;;CAEC,GACD,OAAO,MAAMM,2BAA2BX,QACtCC,UACAK,4BACA;AAGF;;;;;CAKC,GACD,OAAO,SAASM,cAAcC,KAAc;IAC1C,OAAOd,GAAGc,OAAON;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASO,gBAAgBD,KAAc;IAC5C,OAAOd,GAAGc,OAAOL;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASO,gBAAgBF,KAAc;IAC5C,OAAOd,GAAGc,OAAOJ;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASO,gBAAgBH,KAAc;IAC5C,OAAOd,GAAGc,OAAOH;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASO,qBACdJ,KAAc;IAEd,OAAOd,GAAGc,OAAOF;AACnB;AAEA;;;;;;CAMC,GACD,OAAO,SAASO,iBAAiBC,WAAwB;IAIvD,MAAMC,QAAQlB,oBAAoBmB,IAAI,CAACF;IACvC,IAAI,CAACC,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLC,WAAWJ,MAAME,MAAM,CAACE,SAAS;QACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;IACnC;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,mBAAmBC,aAA4B;IAK7D,MAAMP,QAAQf,sBAAsBgB,IAAI,CAACM;IACzC,IAAI,CAACP,OAAOE,QAAQ;QAClB,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;QACLK,SAASR,MAAME,MAAM,CAACO,cAAc;QACpCC,SAASV,MAAME,MAAM,CAACQ,OAAO;QAC7BC,OAAO;YACLP,WAAWJ,MAAME,MAAM,CAACE,SAAS;YACjCC,WAAWL,MAAME,MAAM,CAACG,SAAS;QACnC;IACF;AACF"}

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 export * from './assert';
 export * from './base64';
 export * from './bytes';
+export * from './caip-types';
 export * from './checksum';
 export * from './coercers';
 export * from './collections';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './assert';\nexport * from './base64';\nexport * from './bytes';\nexport * from './checksum';\nexport * from './coercers';\nexport * from './collections';\nexport * from './encryption-types';\nexport * from './hex';\nexport * from './json';\nexport * from './keyring';\nexport * from './logging';\nexport * from './misc';\nexport * from './number';\nexport * from './opaque';\nexport * from './time';\nexport * from './transaction-types';\nexport * from './versions';\n"],"names":[],"mappings":"AAAA,cAAc,WAAW;AACzB,cAAc,WAAW;AACzB,cAAc,UAAU;AACxB,cAAc,aAAa;AAC3B,cAAc,aAAa;AAC3B,cAAc,gBAAgB;AAC9B,cAAc,qBAAqB;AACnC,cAAc,QAAQ;AACtB,cAAc,SAAS;AACvB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,WAAW;AACzB,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,sBAAsB;AACpC,cAAc,aAAa"}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './assert';\nexport * from './base64';\nexport * from './bytes';\nexport * from './caip-types';\nexport * from './checksum';\nexport * from './coercers';\nexport * from './collections';\nexport * from './encryption-types';\nexport * from './hex';\nexport * from './json';\nexport * from './keyring';\nexport * from './logging';\nexport * from './misc';\nexport * from './number';\nexport * from './opaque';\nexport * from './time';\nexport * from './transaction-types';\nexport * from './versions';\n"],"names":[],"mappings":"AAAA,cAAc,WAAW;AACzB,cAAc,WAAW;AACzB,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,aAAa;AAC3B,cAAc,gBAAgB;AAC9B,cAAc,qBAAqB;AACnC,cAAc,QAAQ;AACtB,cAAc,SAAS;AACvB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,WAAW;AACzB,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,sBAAsB;AACpC,cAAc,aAAa"}

package/dist/types/caip-types.d.ts

@@ -0,0 +1,93 @@
+import type { Infer } from 'superstruct';
+export declare const CAIP_CHAIN_ID_REGEX: RegExp;
+export declare const CAIP_NAMESPACE_REGEX: RegExp;
+export declare const CAIP_REFERENCE_REGEX: RegExp;
+export declare const CAIP_ACCOUNT_ID_REGEX: RegExp;
+export declare const CAIP_ACCOUNT_ADDRESS_REGEX: RegExp;
+/**
+ * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
+ */
+export declare const CaipChainIdStruct: import("superstruct").Struct<string, null>;
+export declare type CaipChainId = `${string}:${string}`;
+/**
+ * A CAIP-2 namespace, i.e., the first part of a CAIP chain ID.
+ */
+export declare const CaipNamespaceStruct: import("superstruct").Struct<string, null>;
+export declare type CaipNamespace = Infer<typeof CaipNamespaceStruct>;
+/**
+ * A CAIP-2 reference, i.e., the second part of a CAIP chain ID.
+ */
+export declare const CaipReferenceStruct: import("superstruct").Struct<string, null>;
+export declare type CaipReference = Infer<typeof CaipReferenceStruct>;
+/**
+ * A CAIP-10 account ID, i.e., a human-readable namespace, reference, and account address.
+ */
+export declare const CaipAccountIdStruct: import("superstruct").Struct<string, null>;
+export declare type CaipAccountId = `${string}:${string}:${string}`;
+/**
+ * A CAIP-10 account address, i.e., the third part of the CAIP account ID.
+ */
+export declare const CaipAccountAddressStruct: import("superstruct").Struct<string, null>;
+export declare type CaipAccountAddress = Infer<typeof CaipAccountAddressStruct>;
+/**
+ * Check if the given value is a {@link CaipChainId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipChainId}.
+ */
+export declare function isCaipChainId(value: unknown): value is CaipChainId;
+/**
+ * Check if the given value is a {@link CaipNamespace}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipNamespace}.
+ */
+export declare function isCaipNamespace(value: unknown): value is CaipNamespace;
+/**
+ * Check if the given value is a {@link CaipReference}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipReference}.
+ */
+export declare function isCaipReference(value: unknown): value is CaipReference;
+/**
+ * Check if the given value is a {@link CaipAccountId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipAccountId}.
+ */
+export declare function isCaipAccountId(value: unknown): value is CaipAccountId;
+/**
+ * Check if a value is a {@link CaipAccountAddress}.
+ *
+ * @param value - The value to validate.
+ * @returns True if the value is a valid {@link CaipAccountAddress}.
+ */
+export declare function isCaipAccountAddress(value: unknown): value is CaipAccountAddress;
+/**
+ * Parse a CAIP-2 chain ID to an object containing the namespace and reference.
+ * This validates the CAIP-2 chain ID before parsing it.
+ *
+ * @param caipChainId - The CAIP-2 chain ID to validate and parse.
+ * @returns The parsed CAIP-2 chain ID.
+ */
+export declare function parseCaipChainId(caipChainId: CaipChainId): {
+    namespace: CaipNamespace;
+    reference: CaipReference;
+};
+/**
+ * Parse an CAIP-10 account ID to an object containing the chain ID, parsed chain ID, and account address.
+ * This validates the CAIP-10 account ID before parsing it.
+ *
+ * @param caipAccountId - The CAIP-10 account ID to validate and parse.
+ * @returns The parsed CAIP-10 account ID.
+ */
+export declare function parseCaipAccountId(caipAccountId: CaipAccountId): {
+    address: CaipAccountAddress;
+    chainId: CaipChainId;
+    chain: {
+        namespace: CaipNamespace;
+        reference: CaipReference;
+    };
+};
+//# sourceMappingURL=caip-types.d.ts.map

package/dist/types/caip-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-types.d.ts","sourceRoot":"","sources":["../../src/caip-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGzC,eAAO,MAAM,mBAAmB,QACqC,CAAC;AAEtE,eAAO,MAAM,oBAAoB,QAAsB,CAAC;AAExD,eAAO,MAAM,oBAAoB,QAA2B,CAAC;AAE7D,eAAO,MAAM,qBAAqB,QACwF,CAAC;AAE3H,eAAO,MAAM,0BAA0B,QAA6B,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,iBAAiB,4CAAyC,CAAC;AACxE,oBAAY,WAAW,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,mBAAmB,4CAA0C,CAAC;AAC3E,oBAAY,aAAa,GAAG,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,mBAAmB,4CAA0C,CAAC;AAC3E,oBAAY,aAAa,GAAG,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,mBAAmB,4CAA2C,CAAC;AAC5E,oBAAY,aAAa,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,wBAAwB,4CAGpC,CAAC;AACF,oBAAY,kBAAkB,GAAG,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEtE;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,kBAAkB,CAE7B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG;IAC1D,SAAS,EAAE,aAAa,CAAC;IACzB,SAAS,EAAE,aAAa,CAAC;CAC1B,CAUA;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,aAAa,GAAG;IAChE,OAAO,EAAE,kBAAkB,CAAC;IAC5B,OAAO,EAAE,WAAW,CAAC;IACrB,KAAK,EAAE;QAAE,SAAS,EAAE,aAAa,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE,CAAC;CAC/D,CAcA"}

package/dist/types/caip-types.test-d.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=caip-types.test-d.d.ts.map

package/dist/types/caip-types.test-d.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip-types.test-d.d.ts","sourceRoot":"","sources":["../../src/caip-types.test-d.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from './assert';
 export * from './base64';
 export * from './bytes';
+export * from './caip-types';
 export * from './checksum';
 export * from './coercers';
 export * from './collections';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/utils",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Various JavaScript/TypeScript utilities of wide relevance to the MetaMask codebase",
   "homepage": "https://github.com/MetaMask/utils#readme",
   "bugs": {