@metamask/snaps-utils 8.10.0 → 9.0.0

package/dist/namespace.mjs

@@ -1,126 +0,0 @@
-import { array, define, is, object, optional, pattern, size, string } from "@metamask/superstruct";
-export const CHAIN_ID_REGEX = /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u;
-export const ACCOUNT_ID_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;
-export const ACCOUNT_ADDRESS_REGEX = /^(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;
-/**
- * Parse a chain ID string to an object containing the namespace and reference.
- * This validates the chain ID before parsing it.
- *
- * @param chainId - The chain ID to validate and parse.
- * @returns The parsed chain ID.
- */
-export function parseChainId(chainId) {
-    const match = CHAIN_ID_REGEX.exec(chainId);
-    if (!match?.groups) {
-        throw new Error('Invalid chain ID.');
-    }
-    return {
-        namespace: match.groups.namespace,
-        reference: match.groups.reference,
-    };
-}
-/**
- * Parse an account ID to an object containing the chain, chain ID and address.
- * This validates the account ID before parsing it.
- *
- * @param accountId - The account ID to validate and parse.
- * @returns The parsed account ID.
- */
-export function parseAccountId(accountId) {
-    const match = ACCOUNT_ID_REGEX.exec(accountId);
-    if (!match?.groups) {
-        throw new Error('Invalid account ID.');
-    }
-    return {
-        address: match.groups.accountAddress,
-        chainId: match.groups.chainId,
-        chain: {
-            namespace: match.groups.namespace,
-            reference: match.groups.reference,
-        },
-    };
-}
-/**
- * A helper struct for a string with a minimum length of 1 and a maximum length
- * of 40.
- */
-export const LimitedString = size(string(), 1, 40);
-export const ChainIdStringStruct = define('Chain ID', string().validator);
-/**
- * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
- */
-export const ChainIdStruct = pattern(ChainIdStringStruct, CHAIN_ID_REGEX);
-export const AccountIdStruct = pattern(string(), ACCOUNT_ID_REGEX);
-export const AccountIdArrayStruct = array(AccountIdStruct);
-export const AccountAddressStruct = pattern(string(), ACCOUNT_ADDRESS_REGEX);
-/**
- * A chain descriptor.
- */
-export const ChainStruct = object({
-    id: ChainIdStruct,
-    name: LimitedString,
-});
-export const NamespaceStruct = object({
-    /**
-     * A list of supported chains in the namespace.
-     */
-    chains: array(ChainStruct),
-    /**
-     * A list of supported RPC methods on the namespace, that a DApp can call.
-     */
-    methods: optional(array(LimitedString)),
-    /**
-     * A list of supported RPC events on the namespace, that a DApp can listen to.
-     */
-    events: optional(array(LimitedString)),
-});
-/**
- * A CAIP-2 namespace, i.e., the first part of a chain ID.
- */
-export const NamespaceIdStruct = pattern(string(), /^[-a-z0-9]{3,8}$/u);
-/**
- * Check if the given value is a CAIP-2 namespace ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-2 namespace ID.
- */
-export function isNamespaceId(value) {
-    return is(value, NamespaceIdStruct);
-}
-/**
- * Check if the given value is a CAIP-2 chain ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-2 chain ID.
- */
-export function isChainId(value) {
-    return is(value, ChainIdStruct);
-}
-/**
- * Check if the given value is a CAIP-10 account ID.
- *
- * @param value - The value to check.
- * @returns Whether the value is a CAIP-10 account ID.
- */
-export function isAccountId(value) {
-    return is(value, AccountIdStruct);
-}
-/**
- * Check if the given value is an array of CAIP-10 account IDs.
- *
- * @param value - The value to check.
- * @returns Whether the value is an array of CAIP-10 account IDs.
- */
-export function isAccountIdArray(value) {
-    return is(value, AccountIdArrayStruct);
-}
-/**
- * Check if a value is a {@link Namespace}.
- *
- * @param value - The value to validate.
- * @returns True if the value is a valid {@link Namespace}.
- */
-export function isNamespace(value) {
-    return is(value, NamespaceStruct);
-}
-//# sourceMappingURL=namespace.mjs.map

package/dist/namespace.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"namespace.mjs","sourceRoot":"","sources":["../src/namespace.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,MAAM,EACN,EAAE,EACF,MAAM,EACN,QAAQ,EACR,OAAO,EACP,IAAI,EACJ,MAAM,EACP,8BAA8B;AAI/B,MAAM,CAAC,MAAM,cAAc,GACzB,kEAAkE,CAAC;AAErE,MAAM,CAAC,MAAM,gBAAgB,GAC3B,mHAAmH,CAAC;AAEtH,MAAM,CAAC,MAAM,qBAAqB,GAAG,yCAAyC,CAAC;AAE/E;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,OAAgB;IAI3C,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;QACjC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;KAClC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,SAAoB;IAKjD,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc;QACpC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAkB;QACxC,KAAK,EAAE;YACL,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;YACjC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;SAClC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAEnD,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CACvC,UAAU,EACV,MAAM,EAAE,CAAC,SAAS,CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAClC,mBAAmB,EACnB,cAAc,CACf,CAAC;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC;AAEnE,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAAC;AAG7E;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;IAChC,EAAE,EAAE,aAAa;IACjB,IAAI,EAAE,aAAa;CACpB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;CACvC,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC,CAAC;AAGxE;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,EAAE,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACpC,CAAC","sourcesContent":["import type { AccountId, ChainId } from '@metamask/snaps-sdk';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  array,\n  define,\n  is,\n  object,\n  optional,\n  pattern,\n  size,\n  string,\n} from '@metamask/superstruct';\n\nimport type { InferMatching } from './structs';\n\nexport const CHAIN_ID_REGEX =\n  /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u;\n\nexport const ACCOUNT_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\nexport const ACCOUNT_ADDRESS_REGEX = /^(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\n/**\n * Parse a chain ID string to an object containing the namespace and reference.\n * This validates the chain ID before parsing it.\n *\n * @param chainId - The chain ID to validate and parse.\n * @returns The parsed chain ID.\n */\nexport function parseChainId(chainId: ChainId): {\n  namespace: NamespaceId;\n  reference: string;\n} {\n  const match = CHAIN_ID_REGEX.exec(chainId);\n  if (!match?.groups) {\n    throw new Error('Invalid chain ID.');\n  }\n\n  return {\n    namespace: match.groups.namespace,\n    reference: match.groups.reference,\n  };\n}\n\n/**\n * Parse an account ID to an object containing the chain, chain ID and address.\n * This validates the account ID before parsing it.\n *\n * @param accountId - The account ID to validate and parse.\n * @returns The parsed account ID.\n */\nexport function parseAccountId(accountId: AccountId): {\n  chain: { namespace: NamespaceId; reference: string };\n  chainId: ChainId;\n  address: string;\n} {\n  const match = ACCOUNT_ID_REGEX.exec(accountId);\n  if (!match?.groups) {\n    throw new Error('Invalid account ID.');\n  }\n\n  return {\n    address: match.groups.accountAddress,\n    chainId: match.groups.chainId as ChainId,\n    chain: {\n      namespace: match.groups.namespace,\n      reference: match.groups.reference,\n    },\n  };\n}\n\n/**\n * A helper struct for a string with a minimum length of 1 and a maximum length\n * of 40.\n */\nexport const LimitedString = size(string(), 1, 40);\n\nexport const ChainIdStringStruct = define<ChainId>(\n  'Chain ID',\n  string().validator,\n);\n\n/**\n * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.\n */\nexport const ChainIdStruct = pattern<ChainId, null>(\n  ChainIdStringStruct,\n  CHAIN_ID_REGEX,\n);\n\nexport type Caip2ChainId = InferMatching<typeof ChainIdStruct, ChainId>;\n\nexport const AccountIdStruct = pattern(string(), ACCOUNT_ID_REGEX);\n\nexport const AccountIdArrayStruct = array(AccountIdStruct);\nexport const AccountAddressStruct = pattern(string(), ACCOUNT_ADDRESS_REGEX);\nexport type AccountAddress = Infer<typeof AccountAddressStruct>;\n\n/**\n * A chain descriptor.\n */\nexport const ChainStruct = object({\n  id: ChainIdStruct,\n  name: LimitedString,\n});\nexport type Chain = Infer<typeof ChainStruct>;\n\nexport const NamespaceStruct = object({\n  /**\n   * A list of supported chains in the namespace.\n   */\n  chains: array(ChainStruct),\n\n  /**\n   * A list of supported RPC methods on the namespace, that a DApp can call.\n   */\n  methods: optional(array(LimitedString)),\n\n  /**\n   * A list of supported RPC events on the namespace, that a DApp can listen to.\n   */\n  events: optional(array(LimitedString)),\n});\nexport type Namespace = Infer<typeof NamespaceStruct>;\n\n/**\n * A CAIP-2 namespace, i.e., the first part of a chain ID.\n */\nexport const NamespaceIdStruct = pattern(string(), /^[-a-z0-9]{3,8}$/u);\nexport type NamespaceId = Infer<typeof NamespaceIdStruct>;\n\n/**\n * Check if the given value is a CAIP-2 namespace ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 namespace ID.\n */\nexport function isNamespaceId(value: unknown): value is NamespaceId {\n  return is(value, NamespaceIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-2 chain ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 chain ID.\n */\nexport function isChainId(value: unknown): value is ChainId {\n  return is(value, ChainIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-10 account ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-10 account ID.\n */\nexport function isAccountId(value: unknown): value is AccountId {\n  return is(value, AccountIdStruct);\n}\n\n/**\n * Check if the given value is an array of CAIP-10 account IDs.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of CAIP-10 account IDs.\n */\nexport function isAccountIdArray(value: unknown): value is AccountId[] {\n  return is(value, AccountIdArrayStruct);\n}\n\n/**\n * Check if a value is a {@link Namespace}.\n *\n * @param value - The value to validate.\n * @returns True if the value is a valid {@link Namespace}.\n */\nexport function isNamespace(value: unknown): value is Namespace {\n  return is(value, NamespaceStruct);\n}\n"]}