@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/index.mjs

@@ -1,398 +1,33 @@
-import "./chunk-W7A3BYUP.mjs";
-import {
-  getJsxChildren,
-  getJsxElementFromComponent,
-  getTextChildren,
-  getTotalTextLength,
-  hasChildren,
-  serialiseJsx,
-  validateJsxLinks,
-  validateTextLinks,
-  walkJsx
-} from "./chunk-7HLSXEHK.mjs";
-import {
-  validateFetchedSnap
-} from "./chunk-IPUL74MZ.mjs";
-import {
-  DEFAULT_REQUESTED_SNAP_VERSION,
-  getTargetVersion,
-  resolveVersionRange
-} from "./chunk-N5HVDE3P.mjs";
-import "./chunk-JI5NQ2C3.mjs";
-import {
-  Bip32EntropyStruct,
-  Bip32PathStruct,
-  ChainIdsStruct,
-  CurveStruct,
-  EmptyObjectStruct,
-  FORBIDDEN_COIN_TYPES,
-  HandlerCaveatsStruct,
-  InitialConnectionsStruct,
-  LookupMatchersStruct,
-  MAXIMUM_REQUEST_TIMEOUT,
-  MINIMUM_REQUEST_TIMEOUT,
-  MaxRequestTimeStruct,
-  PermissionsStruct,
-  SemVerRangeStruct,
-  SnapAuxilaryFilesStruct,
-  SnapGetBip32EntropyPermissionsStruct,
-  SnapIdsStruct,
-  SnapManifestStruct,
-  assertIsSnapManifest,
-  bip32entropy,
-  createSnapManifest,
-  isSnapManifest
-} from "./chunk-GXSTPU7D.mjs";
-import {
-  BaseSnapIdStruct,
-  HttpSnapIdStruct,
-  LOCALHOST_HOSTNAMES,
-  LocalSnapIdStruct,
-  NpmSnapIdStruct,
-  PROPOSED_NAME_REGEX,
-  SnapIdStruct,
-  SnapStatus,
-  SnapStatusEvents,
-  assertIsValidSnapId,
-  getSnapChecksum,
-  getSnapPrefix,
-  isCaipChainId,
-  isSnapPermitted,
-  stripSnapPrefix,
-  validateSnapShasum,
-  verifyRequestedSnapPermissions
-} from "./chunk-NSVVZNSD.mjs";
-import {
-  SnapsStructError,
-  arrayToGenerator,
-  createFromStruct,
-  createUnion,
-  getError,
-  getStructErrorMessage,
-  getStructErrorPrefix,
-  getStructFailureMessage,
-  getStructFromPath,
-  getUnionStructNames,
-  mergeStructs,
-  named,
-  validateUnion
-} from "./chunk-3N27GIUS.mjs";
-import {
-  indent
-} from "./chunk-IV3FSWZ7.mjs";
-import {
-  LOCALIZABLE_FIELDS,
-  LocalizationFileStruct,
-  TRANSLATION_REGEX,
-  getLocalizationFile,
-  getLocalizedSnapManifest,
-  getValidatedLocalizationFiles,
-  translate,
-  validateSnapManifestLocalizations
-} from "./chunk-CJK7DDV2.mjs";
-import {
-  normalizeRelative
-} from "./chunk-UW74NLTC.mjs";
-import "./chunk-NNYGTNHP.mjs";
-import "./chunk-PTOH2SVI.mjs";
-import "./chunk-EVHDXNOC.mjs";
-import {
-  NameStruct,
-  NpmSnapFileNames,
-  NpmSnapPackageJsonStruct,
-  SNAP_STREAM_NAMES,
-  SnapIdPrefixes,
-  WALLET_SNAP_PERMISSION_KEY,
-  isValidUrl,
-  uri
-} from "./chunk-N2JAYIUP.mjs";
-import {
-  logError,
-  logInfo,
-  logWarning,
-  snapsLogger
-} from "./chunk-SRMDDOVO.mjs";
-import {
-  ACCOUNT_ADDRESS_REGEX,
-  ACCOUNT_ID_REGEX,
-  AccountAddressStruct,
-  AccountIdArrayStruct,
-  AccountIdStruct,
-  CHAIN_ID_REGEX,
-  ChainIdStringStruct,
-  ChainIdStruct,
-  ChainStruct,
-  LimitedString,
-  NamespaceIdStruct,
-  NamespaceStruct,
-  isAccountId,
-  isAccountIdArray,
-  isChainId,
-  isNamespace,
-  isNamespaceId,
-  parseAccountId,
-  parseChainId
-} from "./chunk-LHQP7CUJ.mjs";
-import {
-  AddressResolutionResponseStruct,
-  AddressResolutionStruct,
-  DomainResolutionResponseStruct,
-  DomainResolutionStruct,
-  OnHomePageResponseStruct,
-  OnHomePageResponseWithContentStruct,
-  OnHomePageResponseWithIdStruct,
-  OnNameLookupResponseStruct,
-  OnSignatureResponseStruct,
-  OnTransactionResponseStruct,
-  OnTransactionResponseWithContentStruct,
-  OnTransactionResponseWithIdStruct,
-  OnTransactionSeverityResponseStruct,
-  SNAP_EXPORTS
-} from "./chunk-4AA3TKRJ.mjs";
-import {
-  createWindow
-} from "./chunk-PJMEJVOB.mjs";
-import {
-  KeyringOriginsStruct,
-  RpcOriginsStruct,
-  assertIsJsonRpcSuccess,
-  assertIsKeyringOrigins,
-  assertIsRpcOrigins,
-  isOriginAllowed
-} from "./chunk-ANYNWSCA.mjs";
-import {
-  SNAPS_DERIVATION_PATHS,
-  getSlip44ProtocolName,
-  getSnapDerivationPathName
-} from "./chunk-IELPPZJP.mjs";
-import {
-  SIP_6_MAGIC_VALUE,
-  STATE_ENCRYPTION_MAGIC_VALUE
-} from "./chunk-AS5P6JRP.mjs";
-import {
-  SNAP_ERROR_WRAPPER_CODE,
-  SNAP_ERROR_WRAPPER_MESSAGE,
-  WrappedSnapError,
-  isSerializedSnapError,
-  isSnapError,
-  isWrappedSnapError,
-  unwrapError
-} from "./chunk-PZF4KWU2.mjs";
-import {
-  HandlerType,
-  SNAP_EXPORT_NAMES
-} from "./chunk-5R7UF7KM.mjs";
-import {
-  DEFAULT_ENDOWMENTS
-} from "./chunk-BGSO2GQC.mjs";
-import "./chunk-HYF7Q6VY.mjs";
-import {
-  getJsonSizeUnsafe,
-  parseJson
-} from "./chunk-UNNEBOL4.mjs";
-import {
-  isEqual
-} from "./chunk-P252LKUT.mjs";
-import {
-  encodeAuxiliaryFile,
-  validateAuxiliaryFiles
-} from "./chunk-VIAHMNTA.mjs";
-import {
-  decodeBase64,
-  encodeBase64
-} from "./chunk-JJTIVHFX.mjs";
-import {
-  SnapCaveatType
-} from "./chunk-7LG4D4XA.mjs";
-import {
-  checksum,
-  checksumFiles
-} from "./chunk-XF2AZMWG.mjs";
-import {
-  getBytes
-} from "./chunk-3S4INAGA.mjs";
-import {
-  VirtualFile
-} from "./chunk-DE22V5AO.mjs";
-import {
-  deepClone
-} from "./chunk-Z2JQNSVL.mjs";
-import {
-  MAX_FILE_SIZE
-} from "./chunk-SPCIIRSB.mjs";
-import {
-  CronExpressionStruct,
-  CronjobRpcRequestStruct,
-  CronjobSpecificationArrayStruct,
-  CronjobSpecificationStruct,
-  isCronjobSpecification,
-  isCronjobSpecificationArray,
-  parseCronExpression
-} from "./chunk-YJHQZFR4.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  ACCOUNT_ADDRESS_REGEX,
-  ACCOUNT_ID_REGEX,
-  AccountAddressStruct,
-  AccountIdArrayStruct,
-  AccountIdStruct,
-  AddressResolutionResponseStruct,
-  AddressResolutionStruct,
-  BaseSnapIdStruct,
-  Bip32EntropyStruct,
-  Bip32PathStruct,
-  CHAIN_ID_REGEX,
-  ChainIdStringStruct,
-  ChainIdStruct,
-  ChainIdsStruct,
-  ChainStruct,
-  CronExpressionStruct,
-  CronjobRpcRequestStruct,
-  CronjobSpecificationArrayStruct,
-  CronjobSpecificationStruct,
-  CurveStruct,
-  DEFAULT_ENDOWMENTS,
-  DEFAULT_REQUESTED_SNAP_VERSION,
-  DomainResolutionResponseStruct,
-  DomainResolutionStruct,
-  EmptyObjectStruct,
-  FORBIDDEN_COIN_TYPES,
-  HandlerCaveatsStruct,
-  HandlerType,
-  HttpSnapIdStruct,
-  InitialConnectionsStruct,
-  KeyringOriginsStruct,
-  LOCALHOST_HOSTNAMES,
-  LOCALIZABLE_FIELDS,
-  LimitedString,
-  LocalSnapIdStruct,
-  LocalizationFileStruct,
-  LookupMatchersStruct,
-  MAXIMUM_REQUEST_TIMEOUT,
-  MAX_FILE_SIZE,
-  MINIMUM_REQUEST_TIMEOUT,
-  MaxRequestTimeStruct,
-  NameStruct,
-  NamespaceIdStruct,
-  NamespaceStruct,
-  NpmSnapFileNames,
-  NpmSnapIdStruct,
-  NpmSnapPackageJsonStruct,
-  OnHomePageResponseStruct,
-  OnHomePageResponseWithContentStruct,
-  OnHomePageResponseWithIdStruct,
-  OnNameLookupResponseStruct,
-  OnSignatureResponseStruct,
-  OnTransactionResponseStruct,
-  OnTransactionResponseWithContentStruct,
-  OnTransactionResponseWithIdStruct,
-  OnTransactionSeverityResponseStruct,
-  PROPOSED_NAME_REGEX,
-  PermissionsStruct,
-  RpcOriginsStruct,
-  SIP_6_MAGIC_VALUE,
-  SNAPS_DERIVATION_PATHS,
-  SNAP_ERROR_WRAPPER_CODE,
-  SNAP_ERROR_WRAPPER_MESSAGE,
-  SNAP_EXPORTS,
-  SNAP_EXPORT_NAMES,
-  SNAP_STREAM_NAMES,
-  STATE_ENCRYPTION_MAGIC_VALUE,
-  SemVerRangeStruct,
-  SnapAuxilaryFilesStruct,
-  SnapCaveatType,
-  SnapGetBip32EntropyPermissionsStruct,
-  SnapIdPrefixes,
-  SnapIdStruct,
-  SnapIdsStruct,
-  SnapManifestStruct,
-  SnapStatus,
-  SnapStatusEvents,
-  SnapsStructError,
-  TRANSLATION_REGEX,
-  VirtualFile,
-  WALLET_SNAP_PERMISSION_KEY,
-  WrappedSnapError,
-  arrayToGenerator,
-  assertIsJsonRpcSuccess,
-  assertIsKeyringOrigins,
-  assertIsRpcOrigins,
-  assertIsSnapManifest,
-  assertIsValidSnapId,
-  bip32entropy,
-  checksum,
-  checksumFiles,
-  createFromStruct,
-  createSnapManifest,
-  createUnion,
-  createWindow,
-  decodeBase64,
-  deepClone,
-  encodeAuxiliaryFile,
-  encodeBase64,
-  getBytes,
-  getError,
-  getJsonSizeUnsafe,
-  getJsxChildren,
-  getJsxElementFromComponent,
-  getLocalizationFile,
-  getLocalizedSnapManifest,
-  getSlip44ProtocolName,
-  getSnapChecksum,
-  getSnapDerivationPathName,
-  getSnapPrefix,
-  getStructErrorMessage,
-  getStructErrorPrefix,
-  getStructFailureMessage,
-  getStructFromPath,
-  getTargetVersion,
-  getTextChildren,
-  getTotalTextLength,
-  getUnionStructNames,
-  getValidatedLocalizationFiles,
-  hasChildren,
-  indent,
-  isAccountId,
-  isAccountIdArray,
-  isCaipChainId,
-  isChainId,
-  isCronjobSpecification,
-  isCronjobSpecificationArray,
-  isEqual,
-  isNamespace,
-  isNamespaceId,
-  isOriginAllowed,
-  isSerializedSnapError,
-  isSnapError,
-  isSnapManifest,
-  isSnapPermitted,
-  isValidUrl,
-  isWrappedSnapError,
-  logError,
-  logInfo,
-  logWarning,
-  mergeStructs,
-  named,
-  normalizeRelative,
-  parseAccountId,
-  parseChainId,
-  parseCronExpression,
-  parseJson,
-  resolveVersionRange,
-  serialiseJsx,
-  snapsLogger,
-  stripSnapPrefix,
-  translate,
-  unwrapError,
-  uri,
-  validateAuxiliaryFiles,
-  validateFetchedSnap,
-  validateJsxLinks,
-  validateSnapManifestLocalizations,
-  validateSnapShasum,
-  validateTextLinks,
-  validateUnion,
-  verifyRequestedSnapPermissions,
-  walkJsx
-};
+export * from "./array.mjs";
+export * from "./auxiliary-files.mjs";
+export * from "./base64.mjs";
+export * from "./bytes.mjs";
+export * from "./caveats.mjs";
+export * from "./checksum.mjs";
+export * from "./constants.mjs";
+export * from "./cronjob.mjs";
+export * from "./deep-clone.mjs";
+export * from "./default-endowments.mjs";
+export * from "./derivation-paths.mjs";
+export * from "./entropy.mjs";
+export * from "./errors.mjs";
+export * from "./handlers.mjs";
+export * from "./handler-types.mjs";
+export * from "./iframe.mjs";
+export * from "./json.mjs";
+export * from "./json-rpc.mjs";
+export * from "./localization.mjs";
+export * from "./logging.mjs";
+export * from "./manifest/index.mjs";
+export * from "./namespace.mjs";
+export * from "./path.mjs";
+export * from "./snaps.mjs";
+export * from "./strings.mjs";
+export * from "./structs.mjs";
+export * from "./types.mjs";
+export * from "./ui.mjs";
+export * from "./validation.mjs";
+export * from "./versions.mjs";
+export * from "./virtual-file/index.mjs";
+export * from "./promise.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4BAAwB;AACxB,sCAAkC;AAClC,6BAAyB;AACzB,4BAAwB;AACxB,8BAA0B;AAC1B,+BAA2B;AAC3B,gCAA4B;AAC5B,8BAA0B;AAC1B,iCAA6B;AAC7B,yCAAqC;AACrC,uCAAmC;AACnC,8BAA0B;AAC1B,6BAAyB;AACzB,+BAA2B;AAC3B,oCAAgC;AAChC,6BAAyB;AACzB,2BAAuB;AACvB,+BAA2B;AAC3B,mCAA+B;AAC/B,8BAA0B;AAC1B,qCAA2B;AAC3B,gCAA4B;AAC5B,2BAAuB;AACvB,4BAAwB;AACxB,8BAA0B;AAC1B,8BAA0B;AAC1B,4BAAwB;AACxB,yBAAqB;AACrB,iCAA6B;AAC7B,+BAA2B;AAC3B,yCAA+B;AAC/B,8BAA0B","sourcesContent":["export * from './array';\nexport * from './auxiliary-files';\nexport * from './base64';\nexport * from './bytes';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './constants';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './derivation-paths';\nexport * from './entropy';\nexport * from './errors';\nexport * from './handlers';\nexport * from './handler-types';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './localization';\nexport * from './logging';\nexport * from './manifest';\nexport * from './namespace';\nexport * from './path';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './ui';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file';\nexport * from './promise';\n"]}

package/dist/json-rpc.cjs

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsJsonRpcSuccess = exports.isOriginAllowed = exports.assertIsKeyringOrigins = exports.KeyringOriginsStruct = exports.assertIsRpcOrigins = exports.RpcOriginsStruct = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const AllowedOriginsStruct = (0, superstruct_1.array)((0, superstruct_1.refine)((0, superstruct_1.string)(), 'Allowed origin', (value) => {
+    const wildcards = value.split('*').length - 1;
+    if (wildcards > 2) {
+        return 'No more than two wildcards ("*") are allowed in an origin specifier.';
+    }
+    return true;
+}));
+exports.RpcOriginsStruct = (0, superstruct_1.refine)((0, superstruct_1.object)({
+    dapps: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+    snaps: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
+    allowedOrigins: (0, superstruct_1.optional)(AllowedOriginsStruct),
+}), 'RPC origins', (value) => {
+    const hasOrigins = Boolean(value.snaps === true ||
+        value.dapps === true ||
+        (value.allowedOrigins && value.allowedOrigins.length > 0));
+    if (hasOrigins) {
+        return true;
+    }
+    return 'Must specify at least one JSON-RPC origin.';
+});
+/**
+ * Asserts that the given value is a valid {@link RpcOrigins} object.
+ *
+ * @param value - The value to assert.
+ * @param ErrorWrapper - An optional error wrapper to use. Defaults to
+ * {@link AssertionError}.
+ * @throws If the value is not a valid {@link RpcOrigins} object.
+ */
+function assertIsRpcOrigins(value, 
+// eslint-disable-next-line @typescript-eslint/naming-convention
+ErrorWrapper) {
+    (0, utils_1.assertStruct)(value, exports.RpcOriginsStruct, 'Invalid JSON-RPC origins', ErrorWrapper);
+}
+exports.assertIsRpcOrigins = assertIsRpcOrigins;
+exports.KeyringOriginsStruct = (0, superstruct_1.object)({
+    allowedOrigins: (0, superstruct_1.optional)(AllowedOriginsStruct),
+});
+/**
+ * Assert that the given value is a valid {@link KeyringOrigins} object.
+ *
+ * @param value - The value to assert.
+ * @param ErrorWrapper - An optional error wrapper to use. Defaults to
+ * {@link AssertionError}.
+ * @throws If the value is not a valid {@link KeyringOrigins} object.
+ */
+function assertIsKeyringOrigins(value, 
+// eslint-disable-next-line @typescript-eslint/naming-convention
+ErrorWrapper) {
+    (0, utils_1.assertStruct)(value, exports.KeyringOriginsStruct, 'Invalid keyring origins', ErrorWrapper);
+}
+exports.assertIsKeyringOrigins = assertIsKeyringOrigins;
+/**
+ * Create regular expression for matching against an origin while allowing wildcards.
+ *
+ * The "*" symbol is treated as a wildcard and will match 0 or more characters.
+ *
+ * @param matcher - The string to create the regular expression with.
+ * @returns The regular expression.
+ */
+function createOriginRegExp(matcher) {
+    // Escape potential Regex characters
+    const escaped = matcher.replace(/[.*+?^${}()|[\]\\]/gu, '\\$&');
+    // Support wildcards
+    const regex = escaped.replace(/\\\*/gu, '.*');
+    return RegExp(`${regex}$`, 'u');
+}
+/**
+ * Check whether an origin is allowed or not using a matcher string.
+ *
+ * The matcher string may be a specific origin to match or include wildcards.
+ * The "*" symbol is treated as a wildcard and will match 0 or more characters.
+ * Note: this means that https://*metamask.io matches both https://metamask.io
+ * and https://snaps.metamask.io.
+ *
+ * @param matcher - The matcher string.
+ * @param origin - The origin.
+ * @returns Whether the origin is allowed.
+ */
+function checkAllowedOrigin(matcher, origin) {
+    // If the matcher is a single wildcard or identical to the origin we can return true immediately.
+    if (matcher === '*' || matcher === origin) {
+        return true;
+    }
+    const regex = createOriginRegExp(matcher);
+    return regex.test(origin);
+}
+/**
+ * Check if the given origin is allowed by the given JSON-RPC origins object.
+ *
+ * @param origins - The JSON-RPC origins object.
+ * @param subjectType - The type of the origin.
+ * @param origin - The origin to check.
+ * @returns Whether the origin is allowed.
+ */
+function isOriginAllowed(origins, subjectType, origin) {
+    // The MetaMask client is always allowed.
+    if (origin === 'metamask') {
+        return true;
+    }
+    // If the origin is in the `allowedOrigins` list, it is allowed.
+    if (origins.allowedOrigins?.some((matcher) => checkAllowedOrigin(matcher, origin))) {
+        return true;
+    }
+    // If the origin is a website and `dapps` is true, it is allowed.
+    if (subjectType === permission_controller_1.SubjectType.Website && origins.dapps) {
+        return true;
+    }
+    // If the origin is a snap and `snaps` is true, it is allowed.
+    return Boolean(subjectType === permission_controller_1.SubjectType.Snap && origins.snaps);
+}
+exports.isOriginAllowed = isOriginAllowed;
+/**
+ * Assert that the given value is a successful JSON-RPC response. If the value
+ * is not a success response, an error is thrown. If the value is an JSON-RPC
+ * error, the error message is included in the thrown error.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a JSON-RPC success response.
+ */
+function assertIsJsonRpcSuccess(value) {
+    if (!(0, utils_1.isJsonRpcSuccess)(value)) {
+        if ((0, utils_1.isJsonRpcFailure)(value)) {
+            throw new Error(`JSON-RPC request failed: ${value.error.message}`);
+        }
+        throw new Error('Invalid JSON-RPC response.');
+    }
+}
+exports.assertIsJsonRpcSuccess = assertIsJsonRpcSuccess;
+//# sourceMappingURL=json-rpc.cjs.map

package/dist/json-rpc.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-rpc.cjs","sourceRoot":"","sources":["../src/json-rpc.ts"],"names":[],"mappings":";;;AAAA,2EAA8D;AAE9D,uDAO+B;AAM/B,2CAIyB;AAEzB,MAAM,oBAAoB,GAAG,IAAA,mBAAK,EAChC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE;IAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAC9C,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QAClB,OAAO,sEAAsE,CAAC;IAChF,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CACH,CAAC;AAEW,QAAA,gBAAgB,GAAG,IAAA,oBAAM,EACpC,IAAA,oBAAM,EAAC;IACL,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IAC1B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IAC1B,cAAc,EAAE,IAAA,sBAAQ,EAAC,oBAAoB,CAAC;CAC/C,CAAC,EACF,aAAa,EACb,CAAC,KAAK,EAAE,EAAE;IACR,MAAM,UAAU,GAAG,OAAO,CACxB,KAAK,CAAC,KAAK,KAAK,IAAI;QAClB,KAAK,CAAC,KAAK,KAAK,IAAI;QACpB,CAAC,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAC5D,CAAC;IAEF,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,4CAA4C,CAAC;AACtD,CAAC,CACF,CAAC;AAIF;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,KAAc;AACd,gEAAgE;AAChE,YAAwC;IAExC,IAAA,oBAAY,EACV,KAAK,EACL,wBAAgB,EAChB,0BAA0B,EAC1B,YAAY,CACb,CAAC;AACJ,CAAC;AAXD,gDAWC;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC,cAAc,EAAE,IAAA,sBAAQ,EAAC,oBAAoB,CAAC;CAC/C,CAAC,CAAC;AAIH;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc;AACd,gEAAgE;AAChE,YAAwC;IAExC,IAAA,oBAAY,EACV,KAAK,EACL,4BAAoB,EACpB,yBAAyB,EACzB,YAAY,CACb,CAAC;AACJ,CAAC;AAXD,wDAWC;AAED;;;;;;;GAOG;AACH,SAAS,kBAAkB,CAAC,OAAe;IACzC,oCAAoC;IACpC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAChE,oBAAoB;IACpB,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,kBAAkB,CAAC,OAAe,EAAE,MAAc;IACzD,iGAAiG;IACjG,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC1C,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAC7B,OAAmB,EACnB,WAAwB,EACxB,MAAc;IAEd,yCAAyC;IACzC,IAAI,MAAM,KAAK,UAAU,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gEAAgE;IAChE,IACE,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CACvC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CACpC,EACD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iEAAiE;IACjE,IAAI,WAAW,KAAK,mCAAW,CAAC,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8DAA8D;IAC9D,OAAO,OAAO,CAAC,WAAW,KAAK,mCAAW,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AA1BD,0CA0BC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc;IAEd,IAAI,CAAC,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,IAAI,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;AACH,CAAC;AAVD,wDAUC","sourcesContent":["import { SubjectType } from '@metamask/permission-controller';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  array,\n  boolean,\n  object,\n  optional,\n  refine,\n  string,\n} from '@metamask/superstruct';\nimport type {\n  AssertionErrorConstructor,\n  Json,\n  JsonRpcSuccess,\n} from '@metamask/utils';\nimport {\n  assertStruct,\n  isJsonRpcFailure,\n  isJsonRpcSuccess,\n} from '@metamask/utils';\n\nconst AllowedOriginsStruct = array(\n  refine(string(), 'Allowed origin', (value) => {\n    const wildcards = value.split('*').length - 1;\n    if (wildcards > 2) {\n      return 'No more than two wildcards (\"*\") are allowed in an origin specifier.';\n    }\n\n    return true;\n  }),\n);\n\nexport const RpcOriginsStruct = refine(\n  object({\n    dapps: optional(boolean()),\n    snaps: optional(boolean()),\n    allowedOrigins: optional(AllowedOriginsStruct),\n  }),\n  'RPC origins',\n  (value) => {\n    const hasOrigins = Boolean(\n      value.snaps === true ||\n        value.dapps === true ||\n        (value.allowedOrigins && value.allowedOrigins.length > 0),\n    );\n\n    if (hasOrigins) {\n      return true;\n    }\n\n    return 'Must specify at least one JSON-RPC origin.';\n  },\n);\n\nexport type RpcOrigins = Infer<typeof RpcOriginsStruct>;\n\n/**\n * Asserts that the given value is a valid {@link RpcOrigins} object.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid {@link RpcOrigins} object.\n */\nexport function assertIsRpcOrigins(\n  value: unknown,\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is RpcOrigins {\n  assertStruct(\n    value,\n    RpcOriginsStruct,\n    'Invalid JSON-RPC origins',\n    ErrorWrapper,\n  );\n}\n\nexport const KeyringOriginsStruct = object({\n  allowedOrigins: optional(AllowedOriginsStruct),\n});\n\nexport type KeyringOrigins = Infer<typeof KeyringOriginsStruct>;\n\n/**\n * Assert that the given value is a valid {@link KeyringOrigins} object.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid {@link KeyringOrigins} object.\n */\nexport function assertIsKeyringOrigins(\n  value: unknown,\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is KeyringOrigins {\n  assertStruct(\n    value,\n    KeyringOriginsStruct,\n    'Invalid keyring origins',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Create regular expression for matching against an origin while allowing wildcards.\n *\n * The \"*\" symbol is treated as a wildcard and will match 0 or more characters.\n *\n * @param matcher - The string to create the regular expression with.\n * @returns The regular expression.\n */\nfunction createOriginRegExp(matcher: string) {\n  // Escape potential Regex characters\n  const escaped = matcher.replace(/[.*+?^${}()|[\\]\\\\]/gu, '\\\\$&');\n  // Support wildcards\n  const regex = escaped.replace(/\\\\\\*/gu, '.*');\n  return RegExp(`${regex}$`, 'u');\n}\n\n/**\n * Check whether an origin is allowed or not using a matcher string.\n *\n * The matcher string may be a specific origin to match or include wildcards.\n * The \"*\" symbol is treated as a wildcard and will match 0 or more characters.\n * Note: this means that https://*metamask.io matches both https://metamask.io\n * and https://snaps.metamask.io.\n *\n * @param matcher - The matcher string.\n * @param origin - The origin.\n * @returns Whether the origin is allowed.\n */\nfunction checkAllowedOrigin(matcher: string, origin: string) {\n  // If the matcher is a single wildcard or identical to the origin we can return true immediately.\n  if (matcher === '*' || matcher === origin) {\n    return true;\n  }\n\n  const regex = createOriginRegExp(matcher);\n  return regex.test(origin);\n}\n\n/**\n * Check if the given origin is allowed by the given JSON-RPC origins object.\n *\n * @param origins - The JSON-RPC origins object.\n * @param subjectType - The type of the origin.\n * @param origin - The origin to check.\n * @returns Whether the origin is allowed.\n */\nexport function isOriginAllowed(\n  origins: RpcOrigins,\n  subjectType: SubjectType,\n  origin: string,\n) {\n  // The MetaMask client is always allowed.\n  if (origin === 'metamask') {\n    return true;\n  }\n\n  // If the origin is in the `allowedOrigins` list, it is allowed.\n  if (\n    origins.allowedOrigins?.some((matcher) =>\n      checkAllowedOrigin(matcher, origin),\n    )\n  ) {\n    return true;\n  }\n\n  // If the origin is a website and `dapps` is true, it is allowed.\n  if (subjectType === SubjectType.Website && origins.dapps) {\n    return true;\n  }\n\n  // If the origin is a snap and `snaps` is true, it is allowed.\n  return Boolean(subjectType === SubjectType.Snap && origins.snaps);\n}\n\n/**\n * Assert that the given value is a successful JSON-RPC response. If the value\n * is not a success response, an error is thrown. If the value is an JSON-RPC\n * error, the error message is included in the thrown error.\n *\n * @param value - The value to check.\n * @throws If the value is not a JSON-RPC success response.\n */\nexport function assertIsJsonRpcSuccess(\n  value: unknown,\n): asserts value is JsonRpcSuccess<Json> {\n  if (!isJsonRpcSuccess(value)) {\n    if (isJsonRpcFailure(value)) {\n      throw new Error(`JSON-RPC request failed: ${value.error.message}`);\n    }\n\n    throw new Error('Invalid JSON-RPC response.');\n  }\n}\n"]}

package/dist/json-rpc.d.cts

@@ -0,0 +1,56 @@
+import { SubjectType } from "@metamask/permission-controller";
+import type { Infer } from "@metamask/superstruct";
+import type { AssertionErrorConstructor, Json, JsonRpcSuccess } from "@metamask/utils";
+export declare const RpcOriginsStruct: import("@metamask/superstruct").Struct<{
+    snaps?: boolean | undefined;
+    dapps?: boolean | undefined;
+    allowedOrigins?: string[] | undefined;
+}, {
+    dapps: import("@metamask/superstruct").Struct<boolean | undefined, null>;
+    snaps: import("@metamask/superstruct").Struct<boolean | undefined, null>;
+    allowedOrigins: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+}>;
+export type RpcOrigins = Infer<typeof RpcOriginsStruct>;
+/**
+ * Asserts that the given value is a valid {@link RpcOrigins} object.
+ *
+ * @param value - The value to assert.
+ * @param ErrorWrapper - An optional error wrapper to use. Defaults to
+ * {@link AssertionError}.
+ * @throws If the value is not a valid {@link RpcOrigins} object.
+ */
+export declare function assertIsRpcOrigins(value: unknown, ErrorWrapper?: AssertionErrorConstructor): asserts value is RpcOrigins;
+export declare const KeyringOriginsStruct: import("@metamask/superstruct").Struct<{
+    allowedOrigins?: string[] | undefined;
+}, {
+    allowedOrigins: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+}>;
+export type KeyringOrigins = Infer<typeof KeyringOriginsStruct>;
+/**
+ * Assert that the given value is a valid {@link KeyringOrigins} object.
+ *
+ * @param value - The value to assert.
+ * @param ErrorWrapper - An optional error wrapper to use. Defaults to
+ * {@link AssertionError}.
+ * @throws If the value is not a valid {@link KeyringOrigins} object.
+ */
+export declare function assertIsKeyringOrigins(value: unknown, ErrorWrapper?: AssertionErrorConstructor): asserts value is KeyringOrigins;
+/**
+ * Check if the given origin is allowed by the given JSON-RPC origins object.
+ *
+ * @param origins - The JSON-RPC origins object.
+ * @param subjectType - The type of the origin.
+ * @param origin - The origin to check.
+ * @returns Whether the origin is allowed.
+ */
+export declare function isOriginAllowed(origins: RpcOrigins, subjectType: SubjectType, origin: string): boolean;
+/**
+ * Assert that the given value is a successful JSON-RPC response. If the value
+ * is not a success response, an error is thrown. If the value is an JSON-RPC
+ * error, the error message is included in the thrown error.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a JSON-RPC success response.
+ */
+export declare function assertIsJsonRpcSuccess(value: unknown): asserts value is JsonRpcSuccess<Json>;
+//# sourceMappingURL=json-rpc.d.cts.map

package/dist/json-rpc.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-rpc.d.cts","sourceRoot":"","sources":["../src/json-rpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,wCAAwC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AASnD,OAAO,KAAK,EACV,yBAAyB,EACzB,IAAI,EACJ,cAAc,EACf,wBAAwB;AAkBzB,eAAO,MAAM,gBAAgB;;;;;;;;EAoB5B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAExD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,OAAO,EAEd,YAAY,CAAC,EAAE,yBAAyB,GACvC,OAAO,CAAC,KAAK,IAAI,UAAU,CAO7B;AAED,eAAO,MAAM,oBAAoB;;;;EAE/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,EAEd,YAAY,CAAC,EAAE,yBAAyB,GACvC,OAAO,CAAC,KAAK,IAAI,cAAc,CAOjC;AAwCD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,UAAU,EACnB,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,MAAM,WAuBf;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,cAAc,CAAC,IAAI,CAAC,CAQvC"}