@metamask/utils
Version:
Various JavaScript/TypeScript utilities of wide relevance to the MetaMask codebase
387 lines • 17.4 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.toCaipAssetId = exports.toCaipAssetType = exports.toCaipAccountId = exports.toCaipChainId = exports.parseCaipAssetId = exports.parseCaipAssetType = exports.parseCaipAccountId = exports.parseCaipChainId = exports.isCaipAssetId = exports.isCaipAssetType = exports.isCaipTokenId = exports.isCaipAssetReference = exports.isCaipAssetNamespace = exports.isCaipAccountAddress = exports.isCaipAccountId = exports.isCaipReference = exports.isCaipNamespace = exports.isCaipChainId = exports.KnownCaipNamespace = exports.CaipAssetTypeOrIdStruct = exports.CaipAssetIdStruct = exports.CaipAssetTypeStruct = exports.CaipTokenIdStruct = exports.CaipAssetReferenceStruct = exports.CaipAssetNamespaceStruct = exports.CaipAccountAddressStruct = exports.CaipAccountIdStruct = exports.CaipReferenceStruct = exports.CaipNamespaceStruct = exports.CaipChainIdStruct = exports.CAIP_ASSET_ID_REGEX = exports.CAIP_ASSET_TYPE_REGEX = exports.CAIP_TOKEN_ID_REGEX = exports.CAIP_ASSET_REFERENCE_REGEX = exports.CAIP_ASSET_NAMESPACE_REGEX = exports.CAIP_ACCOUNT_ADDRESS_REGEX = exports.CAIP_ACCOUNT_ID_REGEX = exports.CAIP_REFERENCE_REGEX = exports.CAIP_NAMESPACE_REGEX = exports.CAIP_CHAIN_ID_REGEX = void 0;
const superstruct_1 = require("@metamask/superstruct");
const superstruct_2 = require("./superstruct.cjs");
exports.CAIP_CHAIN_ID_REGEX = /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})$/u;
exports.CAIP_NAMESPACE_REGEX = /^[-a-z0-9]{3,8}$/u;
exports.CAIP_REFERENCE_REGEX = /^[-_a-zA-Z0-9]{1,32}$/u;
exports.CAIP_ACCOUNT_ID_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32})):(?<accountAddress>[-.%a-zA-Z0-9]{1,128})$/u;
exports.CAIP_ACCOUNT_ADDRESS_REGEX = /^[-.%a-zA-Z0-9]{1,128}$/u;
exports.CAIP_ASSET_NAMESPACE_REGEX = /^[-a-z0-9]{3,8}$/u;
exports.CAIP_ASSET_REFERENCE_REGEX = /^[-.%a-zA-Z0-9]{1,128}$/u;
exports.CAIP_TOKEN_ID_REGEX = /^[-.%a-zA-Z0-9]{1,78}$/u;
exports.CAIP_ASSET_TYPE_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})$/u;
exports.CAIP_ASSET_ID_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})\/(?<tokenId>[-.%a-zA-Z0-9]{1,78})$/u;
const CAIP_ASSET_TYPE_OR_ID_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})(\/(?<tokenId>[-.%a-zA-Z0-9]{1,78}))?$/u;
/**
* A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
*/
exports.CaipChainIdStruct = (0, superstruct_2.definePattern)('CaipChainId', exports.CAIP_CHAIN_ID_REGEX);
/**
* A CAIP-2 namespace, i.e., the first part of a CAIP chain ID.
*/
exports.CaipNamespaceStruct = (0, superstruct_2.definePattern)('CaipNamespace', exports.CAIP_NAMESPACE_REGEX);
/**
* A CAIP-2 reference, i.e., the second part of a CAIP chain ID.
*/
exports.CaipReferenceStruct = (0, superstruct_2.definePattern)('CaipReference', exports.CAIP_REFERENCE_REGEX);
/**
* A CAIP-10 account ID, i.e., a human-readable namespace, reference, and account address.
*/
exports.CaipAccountIdStruct = (0, superstruct_2.definePattern)('CaipAccountId', exports.CAIP_ACCOUNT_ID_REGEX);
/**
* A CAIP-10 account address, i.e., the third part of the CAIP account ID.
*/
exports.CaipAccountAddressStruct = (0, superstruct_2.definePattern)('CaipAccountAddress', exports.CAIP_ACCOUNT_ADDRESS_REGEX);
/**
* A CAIP-19 asset namespace, i.e., a namespace domain of an asset.
*/
exports.CaipAssetNamespaceStruct = (0, superstruct_2.definePattern)('CaipAssetNamespace', exports.CAIP_ASSET_NAMESPACE_REGEX);
/**
* A CAIP-19 asset reference, i.e., an identifier for an asset within a given namespace.
*/
exports.CaipAssetReferenceStruct = (0, superstruct_2.definePattern)('CaipAssetReference', exports.CAIP_ASSET_REFERENCE_REGEX);
/**
* A CAIP-19 asset token ID, i.e., a unique identifier for an addressable asset of a given type
*/
exports.CaipTokenIdStruct = (0, superstruct_2.definePattern)('CaipTokenId', exports.CAIP_TOKEN_ID_REGEX);
/**
* A CAIP-19 asset type identifier, i.e., a human-readable type of asset identifier.
*/
exports.CaipAssetTypeStruct = (0, superstruct_2.definePattern)('CaipAssetType', exports.CAIP_ASSET_TYPE_REGEX);
/**
* A CAIP-19 asset ID identifier, i.e., a human-readable type of asset ID.
*/
exports.CaipAssetIdStruct = (0, superstruct_2.definePattern)('CaipAssetId', exports.CAIP_ASSET_ID_REGEX);
/**
* A CAIP-19 asset type or asset ID identifier, i.e., a human-readable type of asset identifier.
*/
exports.CaipAssetTypeOrIdStruct = (0, superstruct_2.definePattern)('CaipAssetTypeOrId', CAIP_ASSET_TYPE_OR_ID_REGEX);
/** Known CAIP namespaces. */
var KnownCaipNamespace;
(function (KnownCaipNamespace) {
/** BIP-122 (Bitcoin) compatible chains. */
KnownCaipNamespace["Bip122"] = "bip122";
/** Solana compatible chains */
KnownCaipNamespace["Solana"] = "solana";
/** EIP-155 compatible chains. */
KnownCaipNamespace["Eip155"] = "eip155";
KnownCaipNamespace["Wallet"] = "wallet";
})(KnownCaipNamespace = exports.KnownCaipNamespace || (exports.KnownCaipNamespace = {}));
/**
* Check if the given value is a {@link CaipChainId}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipChainId}.
*/
function isCaipChainId(value) {
return (0, superstruct_1.is)(value, exports.CaipChainIdStruct);
}
exports.isCaipChainId = isCaipChainId;
/**
* Check if the given value is a {@link CaipNamespace}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipNamespace}.
*/
function isCaipNamespace(value) {
return (0, superstruct_1.is)(value, exports.CaipNamespaceStruct);
}
exports.isCaipNamespace = isCaipNamespace;
/**
* Check if the given value is a {@link CaipReference}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipReference}.
*/
function isCaipReference(value) {
return (0, superstruct_1.is)(value, exports.CaipReferenceStruct);
}
exports.isCaipReference = isCaipReference;
/**
* Check if the given value is a {@link CaipAccountId}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipAccountId}.
*/
function isCaipAccountId(value) {
return (0, superstruct_1.is)(value, exports.CaipAccountIdStruct);
}
exports.isCaipAccountId = isCaipAccountId;
/**
* Check if a value is a {@link CaipAccountAddress}.
*
* @param value - The value to validate.
* @returns True if the value is a valid {@link CaipAccountAddress}.
*/
function isCaipAccountAddress(value) {
return (0, superstruct_1.is)(value, exports.CaipAccountAddressStruct);
}
exports.isCaipAccountAddress = isCaipAccountAddress;
/**
* Check if the given value is a {@link CaipAssetNamespace}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipAssetNamespace}.
*/
function isCaipAssetNamespace(value) {
return (0, superstruct_1.is)(value, exports.CaipAssetNamespaceStruct);
}
exports.isCaipAssetNamespace = isCaipAssetNamespace;
/**
* Check if the given value is a {@link CaipAssetReference}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipAssetReference}.
*/
function isCaipAssetReference(value) {
return (0, superstruct_1.is)(value, exports.CaipAssetReferenceStruct);
}
exports.isCaipAssetReference = isCaipAssetReference;
/**
* Check if the given value is a {@link CaipTokenId}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipTokenId}.
*/
function isCaipTokenId(value) {
return (0, superstruct_1.is)(value, exports.CaipTokenIdStruct);
}
exports.isCaipTokenId = isCaipTokenId;
/**
* Check if the given value is a {@link CaipAssetType}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipAssetType}.
*/
function isCaipAssetType(value) {
return (0, superstruct_1.is)(value, exports.CaipAssetTypeStruct);
}
exports.isCaipAssetType = isCaipAssetType;
/**
* Check if the given value is a {@link CaipAssetId}.
*
* @param value - The value to check.
* @returns Whether the value is a {@link CaipAssetId}.
*/
function isCaipAssetId(value) {
return (0, superstruct_1.is)(value, exports.CaipAssetIdStruct);
}
exports.isCaipAssetId = isCaipAssetId;
/**
* 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.
*/
function parseCaipChainId(caipChainId) {
const match = exports.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,
};
}
exports.parseCaipChainId = parseCaipChainId;
/**
* 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.
*/
function parseCaipAccountId(caipAccountId) {
const match = exports.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,
},
};
}
exports.parseCaipAccountId = parseCaipAccountId;
/**
* Parse a CAIP-19 asset type to an object containing the chain ID, parsed chain ID,
* asset namespace, and asset reference
*
* This validates the CAIP-19 asset type before parsing it.
*
* @param caipAssetType - The CAIP-19 asset type to validate and parse.
* @returns The parsed CAIP-19 asset type.
*/
function parseCaipAssetType(caipAssetType) {
const match = exports.CAIP_ASSET_TYPE_REGEX.exec(caipAssetType);
if (!match?.groups) {
throw new Error('Invalid CAIP asset type.');
}
return {
assetNamespace: match.groups.assetNamespace,
assetReference: match.groups.assetReference,
chainId: match.groups.chainId,
chain: {
namespace: match.groups.namespace,
reference: match.groups.reference,
},
};
}
exports.parseCaipAssetType = parseCaipAssetType;
/**
* Parse a CAIP-19 asset ID to an object containing the chain ID, parsed chain ID,
* asset namespace, asset reference, and token ID.
*
* This validates the CAIP-19 asset ID before parsing it.
*
* @param caipAssetId - The CAIP-19 asset ID to validate and parse.
* @returns The parsed CAIP-19 asset ID.
*/
function parseCaipAssetId(caipAssetId) {
const match = exports.CAIP_ASSET_ID_REGEX.exec(caipAssetId);
if (!match?.groups) {
throw new Error('Invalid CAIP asset ID.');
}
return {
assetNamespace: match.groups.assetNamespace,
assetReference: match.groups.assetReference,
tokenId: match.groups.tokenId,
chainId: match.groups.chainId,
chain: {
namespace: match.groups.namespace,
reference: match.groups.reference,
},
};
}
exports.parseCaipAssetId = parseCaipAssetId;
/**
* Chain ID as defined per the CAIP-2
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md}.
*
* It defines a way to uniquely identify any blockchain in a human-readable
* way.
*
* @param namespace - The standard (ecosystem) of similar blockchains.
* @param reference - Identify of a blockchain within a given namespace.
* @throws {@link Error}
* This exception is thrown if the inputs does not comply with the CAIP-2
* syntax specification
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md#syntax}.
* @returns A CAIP chain ID.
*/
function toCaipChainId(namespace, reference) {
if (!isCaipNamespace(namespace)) {
throw new Error(`Invalid "namespace", must match: ${exports.CAIP_NAMESPACE_REGEX.toString()}`);
}
if (!isCaipReference(reference)) {
throw new Error(`Invalid "reference", must match: ${exports.CAIP_REFERENCE_REGEX.toString()}`);
}
return `${namespace}:${reference}`;
}
exports.toCaipChainId = toCaipChainId;
/**
* Account ID as defined per the CAIP-10
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md}.
*
* It defines a way to uniquely identify any blockchain account in a human-readable
* way.
*
* @param namespace - The standard (ecosystem) of similar blockchains.
* @param reference - Identity of a blockchain within a given namespace.
* @param accountAddress - The address of the blockchain account.
* @throws {@link Error}
* This exception is thrown if the inputs do not comply with the CAIP-10
* syntax specification
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md#syntax}.
* @returns A CAIP account ID.
*/
function toCaipAccountId(namespace, reference, accountAddress) {
if (!isCaipNamespace(namespace)) {
throw new Error(`Invalid "namespace", must match: ${exports.CAIP_NAMESPACE_REGEX.toString()}`);
}
if (!isCaipReference(reference)) {
throw new Error(`Invalid "reference", must match: ${exports.CAIP_REFERENCE_REGEX.toString()}`);
}
if (!isCaipAccountAddress(accountAddress)) {
throw new Error(`Invalid "accountAddress", must match: ${exports.CAIP_ACCOUNT_ADDRESS_REGEX.toString()}`);
}
return `${namespace}:${reference}:${accountAddress}`;
}
exports.toCaipAccountId = toCaipAccountId;
/**
* Asset Type as defined per the CAIP-19
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md}.
*
* It defines a way to uniquely identify any blockchain asset in a human-readable
* way.
*
* @param namespace - The standard (ecosystem) of similar blockchains.
* @param reference - Identity of a blockchain within a given namespace.
* @param assetNamespace - The namespace domain of an asset.
* @param assetReference - The identity of an asset within a given namespace.
* @throws {@link Error}
* This exception is thrown if the inputs do not comply with the CAIP-19
* syntax specification
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md#syntax}.
* @returns A CAIP asset type.
*/
function toCaipAssetType(namespace, reference, assetNamespace, assetReference) {
if (!isCaipNamespace(namespace)) {
throw new Error(`Invalid "namespace", must match: ${exports.CAIP_NAMESPACE_REGEX.toString()}`);
}
if (!isCaipReference(reference)) {
throw new Error(`Invalid "reference", must match: ${exports.CAIP_REFERENCE_REGEX.toString()}`);
}
if (!isCaipAssetNamespace(assetNamespace)) {
throw new Error(`Invalid "assetNamespace", must match: ${exports.CAIP_ASSET_NAMESPACE_REGEX.toString()}`);
}
if (!isCaipAssetReference(assetReference)) {
throw new Error(`Invalid "assetReference", must match: ${exports.CAIP_ASSET_REFERENCE_REGEX.toString()}`);
}
return `${namespace}:${reference}/${assetNamespace}:${assetReference}`;
}
exports.toCaipAssetType = toCaipAssetType;
/**
* Asset ID as defined per the CAIP-19
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md}.
*
* It defines a way to uniquely identify any blockchain asset in a human-readable
* way.
*
* @param namespace - The standard (ecosystem) of similar blockchains.
* @param reference - Identity of a blockchain within a given namespace.
* @param assetNamespace - The namespace domain of an asset.
* @param assetReference - The identity of an asset within a given namespace.
* @param tokenId - The unique identifier for an addressable asset of a given type.
* @throws {@link Error}
* This exception is thrown if the inputs do not comply with the CAIP-19
* syntax specification
* {@link https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md#syntax}.
* @returns A CAIP asset ID.
*/
function toCaipAssetId(namespace, reference, assetNamespace, assetReference, tokenId) {
if (!isCaipNamespace(namespace)) {
throw new Error(`Invalid "namespace", must match: ${exports.CAIP_NAMESPACE_REGEX.toString()}`);
}
if (!isCaipReference(reference)) {
throw new Error(`Invalid "reference", must match: ${exports.CAIP_REFERENCE_REGEX.toString()}`);
}
if (!isCaipAssetNamespace(assetNamespace)) {
throw new Error(`Invalid "assetNamespace", must match: ${exports.CAIP_ASSET_NAMESPACE_REGEX.toString()}`);
}
if (!isCaipAssetReference(assetReference)) {
throw new Error(`Invalid "assetReference", must match: ${exports.CAIP_ASSET_REFERENCE_REGEX.toString()}`);
}
if (!isCaipTokenId(tokenId)) {
throw new Error(`Invalid "tokenId", must match: ${exports.CAIP_TOKEN_ID_REGEX.toString()}`);
}
return `${namespace}:${reference}/${assetNamespace}:${assetReference}/${tokenId}`;
}
exports.toCaipAssetId = toCaipAssetId;
//# sourceMappingURL=caip-types.cjs.map