@metamask/snaps-rpc-methods 6.0.0 → 7.0.0

package/dist/cjs/endowments/caveats/requestTime.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/endowments/caveats/requestTime.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { MaxRequestTimeStruct, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { AssertionErrorConstructor, Json } from '@metamask/utils';\nimport { assertStruct, hasProperty, isObject } from '@metamask/utils';\n\nimport type { CaveatMapperFunction, CaveatMapperReturnValue } from './generic';\n\n/**\n * Asserts that the given value is a valid `maxRequestTime` value.\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 `maxRequestTime` value.\n */\nfunction assertIsMaxRequestTime(\n  value: unknown, // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is number {\n  assertStruct(\n    value,\n    MaxRequestTimeStruct,\n    'Invalid maxRequestTime',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateMaxRequestTimeCaveat(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value')) {\n    throw rpcErrors.invalidParams({\n      message: 'Invalid maxRequestTime caveat.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsMaxRequestTime(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getMaxRequestTimeCaveatMapper(\n  value: Json,\n): CaveatMapperReturnValue {\n  if (\n    !value ||\n    !isObject(value) ||\n    (isObject(value) && !hasProperty(value, 'maxRequestTime'))\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.MaxRequestTime,\n        value: value.maxRequestTime,\n      },\n    ],\n  };\n}\n\n/**\n * Creates a wrapping caveat mapper that creates the `maxRequestTime` caveat\n * and merges it with any other caveats created by the mapper function.\n *\n * @param mapper - Another caveat mapper function.\n * @returns The caveat specification.\n */\nexport function createMaxRequestTimeMapper(\n  mapper: CaveatMapperFunction,\n): CaveatMapperFunction {\n  return function (value: Json) {\n    // We assume this to be used only with caveats of this type\n    const { maxRequestTime, ...rest } = value as Record<string, Json>;\n\n    const mapperResult = mapper(rest);\n\n    if (!maxRequestTime) {\n      return mapperResult;\n    }\n\n    return {\n      ...mapperResult,\n      caveats: [\n        ...(mapperResult.caveats ?? []),\n        {\n          type: SnapCaveatType.MaxRequestTime,\n          value: maxRequestTime,\n        },\n      ],\n    };\n  };\n}\n\n/**\n * Getter function to get the {@link MaxRequestTime} caveat value from a permission if specified.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value if present, otherwise null.\n */\nexport function getMaxRequestTimeCaveat(\n  permission?: PermissionConstraint,\n): number | null {\n  const foundCaveat = permission?.caveats?.find(\n    (caveat) => caveat.type === SnapCaveatType.MaxRequestTime,\n  );\n  return (foundCaveat?.value as number) ?? null;\n}\n\nexport const maxRequestTimeCaveatSpecifications: Record<\n  SnapCaveatType.MaxRequestTime,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.MaxRequestTime]: Object.freeze({\n    type: SnapCaveatType.MaxRequestTime,\n    validator: (caveat: Caveat<string, any>) =>\n      validateMaxRequestTimeCaveat(caveat),\n  }),\n};\n"],"names":["getMaxRequestTimeCaveatMapper","createMaxRequestTimeMapper","getMaxRequestTimeCaveat","maxRequestTimeCaveatSpecifications","assertIsMaxRequestTime","value","ErrorWrapper","assertStruct","MaxRequestTimeStruct","validateMaxRequestTimeCaveat","caveat","hasProperty","rpcErrors","invalidParams","message","isObject","caveats","type","SnapCaveatType","MaxRequestTime","maxRequestTime","mapper","rest","mapperResult","permission","foundCaveat","find","Object","freeze","validator"],"mappings":";;;;;;;;;;;IA0DgBA,6BAA6B;eAA7BA;;IA2BAC,0BAA0B;eAA1BA;;IAgCAC,uBAAuB;eAAvBA;;IASHC,kCAAkC;eAAlCA;;;2BAzHa;4BAC2B;uBAED;AAIpD;;;;;;;CAOC,GACD,SAASC,uBACPC,KAAc,EACdC,YAAwC;IAExCC,IAAAA,mBAAY,EACVF,OACAG,gCAAoB,EACpB,0BACAF;AAEJ;AAEA;;;;;;CAMC,GACD,SAASG,6BAA6BC,MAA2B;IAC/D,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,UAAU;QACjC,MAAME,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAET,KAAK,EAAE,GAAGK;IAClBN,uBAAuBC,OAAOO,oBAAS,CAACC,aAAa;AACvD;AAUO,SAASb,8BACdK,KAAW;IAEX,IACE,CAACA,SACD,CAACU,IAAAA,eAAQ,EAACV,UACTU,IAAAA,eAAQ,EAACV,UAAU,CAACM,IAAAA,kBAAW,EAACN,OAAO,mBACxC;QACA,OAAO;YAAEW,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEC,MAAMC,0BAAc,CAACC,cAAc;gBACnCd,OAAOA,MAAMe,cAAc;YAC7B;SACD;IACH;AACF;AASO,SAASnB,2BACdoB,MAA4B;IAE5B,OAAO,SAAUhB,KAAW;QAC1B,2DAA2D;QAC3D,MAAM,EAAEe,cAAc,EAAE,GAAGE,MAAM,GAAGjB;QAEpC,MAAMkB,eAAeF,OAAOC;QAE5B,IAAI,CAACF,gBAAgB;YACnB,OAAOG;QACT;QAEA,OAAO;YACL,GAAGA,YAAY;YACfP,SAAS;mBACHO,aAAaP,OAAO,IAAI,EAAE;gBAC9B;oBACEC,MAAMC,0BAAc,CAACC,cAAc;oBACnCd,OAAOe;gBACT;aACD;QACH;IACF;AACF;AAQO,SAASlB,wBACdsB,UAAiC;IAEjC,MAAMC,cAAcD,YAAYR,SAASU,KACvC,CAAChB,SAAWA,OAAOO,IAAI,KAAKC,0BAAc,CAACC,cAAc;IAE3D,OAAO,CAACM,aAAapB,KAAe,KAAK;AAC3C;AAEO,MAAMF,qCAGT;IACF,CAACe,0BAAc,CAACC,cAAc,CAAC,EAAEQ,OAAOC,MAAM,CAAC;QAC7CX,MAAMC,0BAAc,CAACC,cAAc;QACnCU,WAAW,CAACnB,SACVD,6BAA6BC;IACjC;AACF"}

package/dist/cjs/endowments/cronjob.js

@@ -1,100 +0,0 @@
-"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, {
-    cronjobEndowmentBuilder: function() {
-        return cronjobEndowmentBuilder;
-    },
-    getCronjobCaveatMapper: function() {
-        return getCronjobCaveatMapper;
-    },
-    getCronjobCaveatJobs: function() {
-        return getCronjobCaveatJobs;
-    },
-    validateCronjobCaveat: function() {
-        return validateCronjobCaveat;
-    },
-    cronjobCaveatSpecifications: function() {
-        return cronjobCaveatSpecifications;
-    }
-});
-const _permissioncontroller = require("@metamask/permission-controller");
-const _rpcerrors = require("@metamask/rpc-errors");
-const _snapsutils = require("@metamask/snaps-utils");
-const _utils = require("@metamask/utils");
-const _enum = require("./enum");
-const permissionName = _enum.SnapEndowments.Cronjob;
-/**
- * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.
- *
- * @param _builderOptions - Optional specification builder options.
- * @returns The specification for the cronjob endowment.
- */ const specificationBuilder = (_builderOptions)=>{
-    return {
-        permissionType: _permissioncontroller.PermissionType.Endowment,
-        targetName: permissionName,
-        allowedCaveats: [
-            _snapsutils.SnapCaveatType.SnapCronjob
-        ],
-        endowmentGetter: (_getterOptions)=>undefined,
-        subjectTypes: [
-            _permissioncontroller.SubjectType.Snap
-        ]
-    };
-};
-const cronjobEndowmentBuilder = Object.freeze({
-    targetName: permissionName,
-    specificationBuilder
-});
-function getCronjobCaveatMapper(value) {
-    return {
-        caveats: [
-            {
-                type: _snapsutils.SnapCaveatType.SnapCronjob,
-                value
-            }
-        ]
-    };
-}
-function getCronjobCaveatJobs(permission) {
-    if (!permission?.caveats) {
-        return null;
-    }
-    (0, _utils.assert)(permission.caveats.length === 1);
-    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.SnapCronjob);
-    const caveat = permission.caveats[0];
-    return (caveat.value?.jobs) ?? null;
-}
-function validateCronjobCaveat(caveat) {
-    if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
-        throw _rpcerrors.rpcErrors.invalidParams({
-            message: 'Expected a plain object.'
-        });
-    }
-    const { value } = caveat;
-    if (!(0, _utils.hasProperty)(value, 'jobs') || !(0, _utils.isPlainObject)(value)) {
-        throw _rpcerrors.rpcErrors.invalidParams({
-            message: 'Expected a plain object.'
-        });
-    }
-    if (!(0, _snapsutils.isCronjobSpecificationArray)(value.jobs)) {
-        throw _rpcerrors.rpcErrors.invalidParams({
-            message: 'Expected a valid cronjob specification array.'
-        });
-    }
-}
-const cronjobCaveatSpecifications = {
-    [_snapsutils.SnapCaveatType.SnapCronjob]: Object.freeze({
-        type: _snapsutils.SnapCaveatType.SnapCronjob,
-        validator: (caveat)=>validateCronjobCaveat(caveat)
-    })
-};
-
-//# sourceMappingURL=cronjob.js.map

package/dist/cjs/endowments/cronjob.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/endowments/cronjob.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionConstraint,\n  Caveat,\n  CaveatSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { CronjobSpecification } from '@metamask/snaps-utils';\nimport {\n  SnapCaveatType,\n  isCronjobSpecificationArray,\n} from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Cronjob;\n\ntype CronjobEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the cronjob endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  CronjobEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.SnapCronjob],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const cronjobEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getCronjobCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.SnapCronjob,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the cronjobs from a permission.\n *\n * This does basic validation of the caveat, but does not validate the type or\n * value of the namespaces object itself, as this is handled by the\n * `PermissionsController` when the permission is requested.\n *\n * @param permission - The permission to get the keyring namespaces from.\n * @returns The cronjobs, or `null` if the permission does not have a\n * cronjob caveat.\n */\nexport function getCronjobCaveatJobs(\n  permission?: PermissionConstraint,\n): CronjobSpecification[] | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.SnapCronjob);\n\n  const caveat = permission.caveats[0] as Caveat<string, { jobs: Json[] }>;\n\n  return (caveat.value?.jobs as CronjobSpecification[]) ?? null;\n}\n\n/**\n * Validate the cronjob specification values associated with a caveat.\n * This validates that the value is a non-empty array with valid\n * cronjob expression and request object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the value is invalid.\n */\nexport function validateCronjobCaveat(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  if (!isCronjobSpecificationArray(value.jobs)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a valid cronjob specification array.',\n    });\n  }\n}\n\n/**\n * Caveat specification for the Cronjob.\n */\nexport const cronjobCaveatSpecifications: Record<\n  SnapCaveatType.SnapCronjob,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SnapCronjob]: Object.freeze({\n    type: SnapCaveatType.SnapCronjob,\n    validator: (caveat) => validateCronjobCaveat(caveat),\n  }),\n};\n"],"names":["cronjobEndowmentBuilder","getCronjobCaveatMapper","getCronjobCaveatJobs","validateCronjobCaveat","cronjobCaveatSpecifications","permissionName","SnapEndowments","Cronjob","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","SnapCronjob","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze","value","caveats","type","permission","assert","length","caveat","jobs","hasProperty","isPlainObject","rpcErrors","invalidParams","message","isCronjobSpecificationArray","validator"],"mappings":";;;;;;;;;;;IAiDaA,uBAAuB;eAAvBA;;IAaGC,sBAAsB;eAAtBA;;IAwBAC,oBAAoB;eAApBA;;IAuBAC,qBAAqB;eAArBA;;IAyBHC,2BAA2B;eAA3BA;;;sCA9H+B;2BAClB;4BAKnB;uBAE4C;sBAEpB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,OAAO;AAS7C;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,WAAW;SAAC;QAC5CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMtB,0BAA0BuB,OAAOC,MAAM,CAAC;IACnDX,YAAYR;IACZG;AACF;AAUO,SAASP,uBACdwB,KAAW;IAEX,OAAO;QACLC,SAAS;YACP;gBACEC,MAAMZ,0BAAc,CAACC,WAAW;gBAChCS;YACF;SACD;IACH;AACF;AAaO,SAASvB,qBACd0B,UAAiC;IAEjC,IAAI,CAACA,YAAYF,SAAS;QACxB,OAAO;IACT;IAEAG,IAAAA,aAAM,EAACD,WAAWF,OAAO,CAACI,MAAM,KAAK;IACrCD,IAAAA,aAAM,EAACD,WAAWF,OAAO,CAAC,EAAE,CAACC,IAAI,KAAKZ,0BAAc,CAACC,WAAW;IAEhE,MAAMe,SAASH,WAAWF,OAAO,CAAC,EAAE;IAEpC,OAAO,CAACK,OAAON,KAAK,EAAEO,IAA8B,KAAK;AAC3D;AAUO,SAAS7B,sBAAsB4B,MAA2B;IAC/D,IAAI,CAACE,IAAAA,kBAAW,EAACF,QAAQ,YAAY,CAACG,IAAAA,oBAAa,EAACH,OAAON,KAAK,GAAG;QACjE,MAAMU,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEZ,KAAK,EAAE,GAAGM;IAElB,IAAI,CAACE,IAAAA,kBAAW,EAACR,OAAO,WAAW,CAACS,IAAAA,oBAAa,EAACT,QAAQ;QACxD,MAAMU,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,IAAI,CAACC,IAAAA,uCAA2B,EAACb,MAAMO,IAAI,GAAG;QAC5C,MAAMG,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;AACF;AAKO,MAAMjC,8BAGT;IACF,CAACW,0BAAc,CAACC,WAAW,CAAC,EAAEO,OAAOC,MAAM,CAAC;QAC1CG,MAAMZ,0BAAc,CAACC,WAAW;QAChCuB,WAAW,CAACR,SAAW5B,sBAAsB4B;IAC/C;AACF"}

package/dist/cjs/endowments/enum.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "SnapEndowments", {
-    enumerable: true,
-    get: function() {
-        return SnapEndowments;
-    }
-});
-var SnapEndowments;
-(function(SnapEndowments) {
-    SnapEndowments["NetworkAccess"] = 'endowment:network-access';
-    SnapEndowments["SignatureInsight"] = 'endowment:signature-insight';
-    SnapEndowments["TransactionInsight"] = 'endowment:transaction-insight';
-    SnapEndowments["Cronjob"] = 'endowment:cronjob';
-    SnapEndowments["EthereumProvider"] = 'endowment:ethereum-provider';
-    SnapEndowments["Rpc"] = 'endowment:rpc';
-    SnapEndowments["WebAssemblyAccess"] = 'endowment:webassembly';
-    SnapEndowments["NameLookup"] = 'endowment:name-lookup';
-    SnapEndowments["LifecycleHooks"] = 'endowment:lifecycle-hooks';
-    SnapEndowments["Keyring"] = 'endowment:keyring';
-    SnapEndowments["HomePage"] = 'endowment:page-home';
-})(SnapEndowments || (SnapEndowments = {}));
-
-//# sourceMappingURL=enum.js.map

package/dist/cjs/endowments/enum.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/endowments/enum.ts"],"sourcesContent":["export enum SnapEndowments {\n  NetworkAccess = 'endowment:network-access',\n  SignatureInsight = 'endowment:signature-insight',\n  TransactionInsight = 'endowment:transaction-insight',\n  Cronjob = 'endowment:cronjob',\n  EthereumProvider = 'endowment:ethereum-provider',\n  Rpc = 'endowment:rpc',\n  WebAssemblyAccess = 'endowment:webassembly',\n  NameLookup = 'endowment:name-lookup',\n  LifecycleHooks = 'endowment:lifecycle-hooks',\n  Keyring = 'endowment:keyring',\n  HomePage = 'endowment:page-home',\n}\n"],"names":["SnapEndowments","NetworkAccess","SignatureInsight","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks","Keyring","HomePage"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,sBAAmB;IAFTF,eAGVG,wBAAqB;IAHXH,eAIVI,aAAU;IAJAJ,eAKVK,sBAAmB;IALTL,eAMVM,SAAM;IANIN,eAOVO,uBAAoB;IAPVP,eAQVQ,gBAAa;IARHR,eASVS,oBAAiB;IATPT,eAUVU,aAAU;IAVAV,eAWVW,cAAW;GAXDX,mBAAAA"}

package/dist/cjs/endowments/ethereum-provider.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "ethereumProviderEndowmentBuilder", {
-    enumerable: true,
-    get: function() {
-        return ethereumProviderEndowmentBuilder;
-    }
-});
-const _permissioncontroller = require("@metamask/permission-controller");
-const _enum = require("./enum");
-const permissionName = _enum.SnapEndowments.EthereumProvider;
-/**
- * `endowment:ethereum-provider` returns the name of the ethereum global browser API.
- * This is intended to populate the endowments of the
- * SES Compartment in which a Snap executes.
- *
- * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.
- *
- * @param _builderOptions - Optional specification builder options.
- * @returns The specification for the network endowment.
- */ const specificationBuilder = (_builderOptions)=>{
-    return {
-        permissionType: _permissioncontroller.PermissionType.Endowment,
-        targetName: permissionName,
-        allowedCaveats: null,
-        endowmentGetter: (_getterOptions)=>{
-            return [
-                'ethereum'
-            ];
-        },
-        subjectTypes: [
-            _permissioncontroller.SubjectType.Snap
-        ]
-    };
-};
-const ethereumProviderEndowmentBuilder = Object.freeze({
-    targetName: permissionName,
-    specificationBuilder
-});
-
-//# sourceMappingURL=ethereum-provider.js.map

package/dist/cjs/endowments/home-page.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "homePageEndowmentBuilder", {
-    enumerable: true,
-    get: function() {
-        return homePageEndowmentBuilder;
-    }
-});
-const _permissioncontroller = require("@metamask/permission-controller");
-const _enum = require("./enum");
-const permissionName = _enum.SnapEndowments.HomePage;
-/**
- * `endowment:page-home` returns nothing; it is intended to be used as a
- * flag by the snap controller to detect whether the snap has the capability to
- * use the snap home page feature.
- *
- * @param _builderOptions - Optional specification builder options.
- * @returns The specification for the `snap-pages` endowment.
- */ const specificationBuilder = (_builderOptions)=>{
-    return {
-        permissionType: _permissioncontroller.PermissionType.Endowment,
-        targetName: permissionName,
-        allowedCaveats: null,
-        endowmentGetter: (_getterOptions)=>undefined,
-        subjectTypes: [
-            _permissioncontroller.SubjectType.Snap
-        ]
-    };
-};
-const homePageEndowmentBuilder = Object.freeze({
-    targetName: permissionName,
-    specificationBuilder
-});
-
-//# sourceMappingURL=home-page.js.map

package/dist/cjs/endowments/home-page.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/endowments/home-page.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport type { NonEmptyArray } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.HomePage;\n\ntype HomePageEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:page-home` returns nothing; it is intended to be used as a\n * flag by the snap controller to detect whether the snap has the capability to\n * use the snap home page feature.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the `snap-pages` endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  HomePageEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const homePageEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["homePageEndowmentBuilder","permissionName","SnapEndowments","HomePage","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BAyCaA;;;eAAAA;;;sCApC+B;sBAGb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,QAAQ;AAS9C;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMhB,2BAA2BiB,OAAOC,MAAM,CAAC;IACpDT,YAAYR;IACZG;AACF"}

package/dist/cjs/endowments/index.js

@@ -1,121 +0,0 @@
-"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, {
-    endowmentPermissionBuilders: function() {
-        return endowmentPermissionBuilders;
-    },
-    endowmentCaveatSpecifications: function() {
-        return endowmentCaveatSpecifications;
-    },
-    endowmentCaveatMappers: function() {
-        return endowmentCaveatMappers;
-    },
-    handlerEndowments: function() {
-        return handlerEndowments;
-    },
-    getRpcCaveatOrigins: function() {
-        return _rpc.getRpcCaveatOrigins;
-    },
-    getSignatureOriginCaveat: function() {
-        return _signatureinsight.getSignatureOriginCaveat;
-    },
-    getTransactionOriginCaveat: function() {
-        return _transactioninsight.getTransactionOriginCaveat;
-    },
-    getChainIdsCaveat: function() {
-        return _namelookup.getChainIdsCaveat;
-    },
-    getLookupMatchersCaveat: function() {
-        return _namelookup.getLookupMatchersCaveat;
-    },
-    getKeyringCaveatOrigins: function() {
-        return _keyring.getKeyringCaveatOrigins;
-    },
-    getMaxRequestTimeCaveat: function() {
-        return _caveats.getMaxRequestTimeCaveat;
-    },
-    getCronjobCaveatJobs: function() {
-        return _cronjob.getCronjobCaveatJobs;
-    }
-});
-const _snapsutils = require("@metamask/snaps-utils");
-const _caveats = require("./caveats");
-const _cronjob = require("./cronjob");
-const _ethereumprovider = require("./ethereum-provider");
-const _homepage = require("./home-page");
-const _keyring = require("./keyring");
-const _lifecyclehooks = require("./lifecycle-hooks");
-const _namelookup = require("./name-lookup");
-const _networkaccess = require("./network-access");
-const _rpc = require("./rpc");
-const _signatureinsight = require("./signature-insight");
-const _transactioninsight = require("./transaction-insight");
-const _webassembly = require("./web-assembly");
-_export_star(require("./enum"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}
-const endowmentPermissionBuilders = {
-    [_networkaccess.networkAccessEndowmentBuilder.targetName]: _networkaccess.networkAccessEndowmentBuilder,
-    [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.transactionInsightEndowmentBuilder,
-    [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.cronjobEndowmentBuilder,
-    [_ethereumprovider.ethereumProviderEndowmentBuilder.targetName]: _ethereumprovider.ethereumProviderEndowmentBuilder,
-    [_rpc.rpcEndowmentBuilder.targetName]: _rpc.rpcEndowmentBuilder,
-    [_webassembly.webAssemblyEndowmentBuilder.targetName]: _webassembly.webAssemblyEndowmentBuilder,
-    [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.nameLookupEndowmentBuilder,
-    [_lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName]: _lifecyclehooks.lifecycleHooksEndowmentBuilder,
-    [_keyring.keyringEndowmentBuilder.targetName]: _keyring.keyringEndowmentBuilder,
-    [_homepage.homePageEndowmentBuilder.targetName]: _homepage.homePageEndowmentBuilder,
-    [_signatureinsight.signatureInsightEndowmentBuilder.targetName]: _signatureinsight.signatureInsightEndowmentBuilder
-};
-const endowmentCaveatSpecifications = {
-    ..._cronjob.cronjobCaveatSpecifications,
-    ..._transactioninsight.transactionInsightCaveatSpecifications,
-    ..._rpc.rpcCaveatSpecifications,
-    ..._namelookup.nameLookupCaveatSpecifications,
-    ..._keyring.keyringCaveatSpecifications,
-    ..._signatureinsight.signatureInsightCaveatSpecifications,
-    ..._caveats.maxRequestTimeCaveatSpecifications
-};
-const endowmentCaveatMappers = {
-    [_cronjob.cronjobEndowmentBuilder.targetName]: (0, _caveats.createMaxRequestTimeMapper)(_cronjob.getCronjobCaveatMapper),
-    [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: (0, _caveats.createMaxRequestTimeMapper)(_transactioninsight.getTransactionInsightCaveatMapper),
-    [_rpc.rpcEndowmentBuilder.targetName]: (0, _caveats.createMaxRequestTimeMapper)(_rpc.getRpcCaveatMapper),
-    [_namelookup.nameLookupEndowmentBuilder.targetName]: (0, _caveats.createMaxRequestTimeMapper)(_namelookup.getNameLookupCaveatMapper),
-    [_keyring.keyringEndowmentBuilder.targetName]: (0, _caveats.createMaxRequestTimeMapper)(_keyring.getKeyringCaveatMapper),
-    [_signatureinsight.signatureInsightEndowmentBuilder.targetName]: (0, _caveats.createMaxRequestTimeMapper)(_signatureinsight.getSignatureInsightCaveatMapper),
-    [_lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName]: _caveats.getMaxRequestTimeCaveatMapper,
-    [_homepage.homePageEndowmentBuilder.targetName]: _caveats.getMaxRequestTimeCaveatMapper
-};
-const handlerEndowments = {
-    [_snapsutils.HandlerType.OnRpcRequest]: _rpc.rpcEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnTransaction]: _transactioninsight.transactionInsightEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnCronjob]: _cronjob.cronjobEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnNameLookup]: _namelookup.nameLookupEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnInstall]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnUpdate]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnKeyringRequest]: _keyring.keyringEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnHomePage]: _homepage.homePageEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnSignature]: _signatureinsight.signatureInsightEndowmentBuilder.targetName,
-    [_snapsutils.HandlerType.OnUserInput]: null
-};
-
-//# sourceMappingURL=index.js.map

package/dist/cjs/endowments/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/endowments/index.ts"],"sourcesContent":["import type { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  createMaxRequestTimeMapper,\n  getMaxRequestTimeCaveatMapper,\n  maxRequestTimeCaveatSpecifications,\n} from './caveats';\nimport {\n  cronjobCaveatSpecifications,\n  cronjobEndowmentBuilder,\n  getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport { homePageEndowmentBuilder } from './home-page';\nimport {\n  getKeyringCaveatMapper,\n  keyringCaveatSpecifications,\n  keyringEndowmentBuilder,\n} from './keyring';\nimport { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';\nimport {\n  getNameLookupCaveatMapper,\n  nameLookupCaveatSpecifications,\n  nameLookupEndowmentBuilder,\n} from './name-lookup';\nimport { networkAccessEndowmentBuilder } from './network-access';\nimport {\n  getRpcCaveatMapper,\n  rpcCaveatSpecifications,\n  rpcEndowmentBuilder,\n} from './rpc';\nimport {\n  getSignatureInsightCaveatMapper,\n  signatureInsightCaveatSpecifications,\n  signatureInsightEndowmentBuilder,\n} from './signature-insight';\nimport {\n  getTransactionInsightCaveatMapper,\n  transactionInsightCaveatSpecifications,\n  transactionInsightEndowmentBuilder,\n} from './transaction-insight';\nimport { webAssemblyEndowmentBuilder } from './web-assembly';\n\nexport const endowmentPermissionBuilders = {\n  [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,\n  [transactionInsightEndowmentBuilder.targetName]:\n    transactionInsightEndowmentBuilder,\n  [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n  [ethereumProviderEndowmentBuilder.targetName]:\n    ethereumProviderEndowmentBuilder,\n  [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n  [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n  [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,\n  [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,\n  [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,\n  [homePageEndowmentBuilder.targetName]: homePageEndowmentBuilder,\n  [signatureInsightEndowmentBuilder.targetName]:\n    signatureInsightEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n  ...cronjobCaveatSpecifications,\n  ...transactionInsightCaveatSpecifications,\n  ...rpcCaveatSpecifications,\n  ...nameLookupCaveatSpecifications,\n  ...keyringCaveatSpecifications,\n  ...signatureInsightCaveatSpecifications,\n  ...maxRequestTimeCaveatSpecifications,\n};\n\nexport const endowmentCaveatMappers: Record<\n  string,\n  (value: Json) => Pick<PermissionConstraint, 'caveats'>\n> = {\n  [cronjobEndowmentBuilder.targetName]: createMaxRequestTimeMapper(\n    getCronjobCaveatMapper,\n  ),\n  [transactionInsightEndowmentBuilder.targetName]: createMaxRequestTimeMapper(\n    getTransactionInsightCaveatMapper,\n  ),\n  [rpcEndowmentBuilder.targetName]:\n    createMaxRequestTimeMapper(getRpcCaveatMapper),\n  [nameLookupEndowmentBuilder.targetName]: createMaxRequestTimeMapper(\n    getNameLookupCaveatMapper,\n  ),\n  [keyringEndowmentBuilder.targetName]: createMaxRequestTimeMapper(\n    getKeyringCaveatMapper,\n  ),\n  [signatureInsightEndowmentBuilder.targetName]: createMaxRequestTimeMapper(\n    getSignatureInsightCaveatMapper,\n  ),\n  [lifecycleHooksEndowmentBuilder.targetName]: getMaxRequestTimeCaveatMapper,\n  [homePageEndowmentBuilder.targetName]: getMaxRequestTimeCaveatMapper,\n};\n\n// We allow null because a permitted handler does not have an endowment\nexport const handlerEndowments: Record<HandlerType, string | null> = {\n  [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n  [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n  [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n  [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,\n  [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,\n  [HandlerType.OnHomePage]: homePageEndowmentBuilder.targetName,\n  [HandlerType.OnSignature]: signatureInsightEndowmentBuilder.targetName,\n  [HandlerType.OnUserInput]: null,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getSignatureOriginCaveat } from './signature-insight';\nexport { getTransactionOriginCaveat } from './transaction-insight';\nexport { getChainIdsCaveat, getLookupMatchersCaveat } from './name-lookup';\nexport { getKeyringCaveatOrigins } from './keyring';\nexport { getMaxRequestTimeCaveat } from './caveats';\nexport { getCronjobCaveatJobs } from './cronjob';\n"],"names":["endowmentPermissionBuilders","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","getRpcCaveatOrigins","getSignatureOriginCaveat","getTransactionOriginCaveat","getChainIdsCaveat","getLookupMatchersCaveat","getKeyringCaveatOrigins","getMaxRequestTimeCaveat","getCronjobCaveatJobs","networkAccessEndowmentBuilder","targetName","transactionInsightEndowmentBuilder","cronjobEndowmentBuilder","ethereumProviderEndowmentBuilder","rpcEndowmentBuilder","webAssemblyEndowmentBuilder","nameLookupEndowmentBuilder","lifecycleHooksEndowmentBuilder","keyringEndowmentBuilder","homePageEndowmentBuilder","signatureInsightEndowmentBuilder","cronjobCaveatSpecifications","transactionInsightCaveatSpecifications","rpcCaveatSpecifications","nameLookupCaveatSpecifications","keyringCaveatSpecifications","signatureInsightCaveatSpecifications","maxRequestTimeCaveatSpecifications","createMaxRequestTimeMapper","getCronjobCaveatMapper","getTransactionInsightCaveatMapper","getRpcCaveatMapper","getNameLookupCaveatMapper","getKeyringCaveatMapper","getSignatureInsightCaveatMapper","getMaxRequestTimeCaveatMapper","HandlerType","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature","OnUserInput"],"mappings":";;;;;;;;;;;IA6CaA,2BAA2B;eAA3BA;;IAiBAC,6BAA6B;eAA7BA;;IAUAC,sBAAsB;eAAtBA;;IA0BAC,iBAAiB;eAAjBA;;IAcJC,mBAAmB;eAAnBA,wBAAmB;;IACnBC,wBAAwB;eAAxBA,0CAAwB;;IACxBC,0BAA0B;eAA1BA,8CAA0B;;IAC1BC,iBAAiB;eAAjBA,6BAAiB;;IAAEC,uBAAuB;eAAvBA,mCAAuB;;IAC1CC,uBAAuB;eAAvBA,gCAAuB;;IACvBC,uBAAuB;eAAvBA,gCAAuB;;IACvBC,oBAAoB;eAApBA,6BAAoB;;;4BArHD;yBAOrB;yBAKA;kCAC0C;0BACR;yBAKlC;gCACwC;4BAKxC;+BACuC;qBAKvC;kCAKA;oCAKA;6BACqC;qBAoE9B;;;;;;;;;;;;;;AAlEP,MAAMX,8BAA8B;IACzC,CAACY,4CAA6B,CAACC,UAAU,CAAC,EAAED,4CAA6B;IACzE,CAACE,sDAAkC,CAACD,UAAU,CAAC,EAC7CC,sDAAkC;IACpC,CAACC,gCAAuB,CAACF,UAAU,CAAC,EAAEE,gCAAuB;IAC7D,CAACC,kDAAgC,CAACH,UAAU,CAAC,EAC3CG,kDAAgC;IAClC,CAACC,wBAAmB,CAACJ,UAAU,CAAC,EAAEI,wBAAmB;IACrD,CAACC,wCAA2B,CAACL,UAAU,CAAC,EAAEK,wCAA2B;IACrE,CAACC,sCAA0B,CAACN,UAAU,CAAC,EAAEM,sCAA0B;IACnE,CAACC,8CAA8B,CAACP,UAAU,CAAC,EAAEO,8CAA8B;IAC3E,CAACC,gCAAuB,CAACR,UAAU,CAAC,EAAEQ,gCAAuB;IAC7D,CAACC,kCAAwB,CAACT,UAAU,CAAC,EAAES,kCAAwB;IAC/D,CAACC,kDAAgC,CAACV,UAAU,CAAC,EAC3CU,kDAAgC;AACpC;AAEO,MAAMtB,gCAAgC;IAC3C,GAAGuB,oCAA2B;IAC9B,GAAGC,0DAAsC;IACzC,GAAGC,4BAAuB;IAC1B,GAAGC,0CAA8B;IACjC,GAAGC,oCAA2B;IAC9B,GAAGC,sDAAoC;IACvC,GAAGC,2CAAkC;AACvC;AAEO,MAAM5B,yBAGT;IACF,CAACa,gCAAuB,CAACF,UAAU,CAAC,EAAEkB,IAAAA,mCAA0B,EAC9DC,+BAAsB;IAExB,CAAClB,sDAAkC,CAACD,UAAU,CAAC,EAAEkB,IAAAA,mCAA0B,EACzEE,qDAAiC;IAEnC,CAAChB,wBAAmB,CAACJ,UAAU,CAAC,EAC9BkB,IAAAA,mCAA0B,EAACG,uBAAkB;IAC/C,CAACf,sCAA0B,CAACN,UAAU,CAAC,EAAEkB,IAAAA,mCAA0B,EACjEI,qCAAyB;IAE3B,CAACd,gCAAuB,CAACR,UAAU,CAAC,EAAEkB,IAAAA,mCAA0B,EAC9DK,+BAAsB;IAExB,CAACb,kDAAgC,CAACV,UAAU,CAAC,EAAEkB,IAAAA,mCAA0B,EACvEM,iDAA+B;IAEjC,CAACjB,8CAA8B,CAACP,UAAU,CAAC,EAAEyB,sCAA6B;IAC1E,CAAChB,kCAAwB,CAACT,UAAU,CAAC,EAAEyB,sCAA6B;AACtE;AAGO,MAAMnC,oBAAwD;IACnE,CAACoC,uBAAW,CAACC,YAAY,CAAC,EAAEvB,wBAAmB,CAACJ,UAAU;IAC1D,CAAC0B,uBAAW,CAACE,aAAa,CAAC,EAAE3B,sDAAkC,CAACD,UAAU;IAC1E,CAAC0B,uBAAW,CAACG,SAAS,CAAC,EAAE3B,gCAAuB,CAACF,UAAU;IAC3D,CAAC0B,uBAAW,CAACI,YAAY,CAAC,EAAExB,sCAA0B,CAACN,UAAU;IACjE,CAAC0B,uBAAW,CAACK,SAAS,CAAC,EAAExB,8CAA8B,CAACP,UAAU;IAClE,CAAC0B,uBAAW,CAACM,QAAQ,CAAC,EAAEzB,8CAA8B,CAACP,UAAU;IACjE,CAAC0B,uBAAW,CAACO,gBAAgB,CAAC,EAAEzB,gCAAuB,CAACR,UAAU;IAClE,CAAC0B,uBAAW,CAACQ,UAAU,CAAC,EAAEzB,kCAAwB,CAACT,UAAU;IAC7D,CAAC0B,uBAAW,CAACS,WAAW,CAAC,EAAEzB,kDAAgC,CAACV,UAAU;IACtE,CAAC0B,uBAAW,CAACU,WAAW,CAAC,EAAE;AAC7B"}

package/dist/cjs/endowments/keyring.js

@@ -1,104 +0,0 @@
-"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, {
-    keyringEndowmentBuilder: function() {
-        return keyringEndowmentBuilder;
-    },
-    getKeyringCaveatMapper: function() {
-        return getKeyringCaveatMapper;
-    },
-    getKeyringCaveatOrigins: function() {
-        return getKeyringCaveatOrigins;
-    },
-    keyringCaveatSpecifications: function() {
-        return keyringCaveatSpecifications;
-    }
-});
-const _permissioncontroller = require("@metamask/permission-controller");
-const _rpcerrors = require("@metamask/rpc-errors");
-const _snapsutils = require("@metamask/snaps-utils");
-const _utils = require("@metamask/utils");
-const _caveats = require("./caveats");
-const _enum = require("./enum");
-const permissionName = _enum.SnapEndowments.Keyring;
-/**
- * `endowment:keyring` returns nothing; it is intended to be used as a flag
- * by the client to detect whether the snap has keyring capabilities.
- *
- * @param _builderOptions - Optional specification builder options.
- * @returns The specification for the keyring endowment.
- */ const specificationBuilder = (_builderOptions)=>{
-    return {
-        permissionType: _permissioncontroller.PermissionType.Endowment,
-        targetName: permissionName,
-        allowedCaveats: [
-            _snapsutils.SnapCaveatType.KeyringOrigin,
-            _snapsutils.SnapCaveatType.MaxRequestTime
-        ],
-        endowmentGetter: (_getterOptions)=>undefined,
-        validator: (0, _caveats.createGenericPermissionValidator)([
-            {
-                type: _snapsutils.SnapCaveatType.KeyringOrigin
-            },
-            {
-                type: _snapsutils.SnapCaveatType.MaxRequestTime,
-                optional: true
-            }
-        ]),
-        subjectTypes: [
-            _permissioncontroller.SubjectType.Snap
-        ]
-    };
-};
-const keyringEndowmentBuilder = Object.freeze({
-    targetName: permissionName,
-    specificationBuilder
-});
-/**
- * Validate the value of a caveat. This does not validate the type of the
- * caveat itself, only the value of the caveat.
- *
- * @param caveat - The caveat to validate.
- * @throws If the caveat value is invalid.
- */ function validateCaveatOrigins(caveat) {
-    if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
-        throw _rpcerrors.rpcErrors.invalidParams({
-            message: 'Invalid keyring origins: Expected a plain object.'
-        });
-    }
-    const { value } = caveat;
-    (0, _snapsutils.assertIsKeyringOrigins)(value, _rpcerrors.rpcErrors.invalidParams);
-}
-function getKeyringCaveatMapper(value) {
-    return {
-        caveats: [
-            {
-                type: _snapsutils.SnapCaveatType.KeyringOrigin,
-                value
-            }
-        ]
-    };
-}
-function getKeyringCaveatOrigins(permission) {
-    (0, _utils.assert)(permission?.caveats);
-    (0, _utils.assert)(permission.caveats.length === 1);
-    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.KeyringOrigin);
-    const caveat = permission.caveats[0];
-    return caveat.value;
-}
-const keyringCaveatSpecifications = {
-    [_snapsutils.SnapCaveatType.KeyringOrigin]: Object.freeze({
-        type: _snapsutils.SnapCaveatType.KeyringOrigin,
-        validator: (caveat)=>validateCaveatOrigins(caveat)
-    })
-};
-
-//# sourceMappingURL=keyring.js.map

package/dist/cjs/endowments/keyring.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/endowments/keyring.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { KeyringOrigins } from '@metamask/snaps-utils';\nimport { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { createGenericPermissionValidator } from './caveats';\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Keyring;\n\ntype KeyringEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n  subjectTypes: readonly SubjectType[];\n}>;\n\n/**\n * `endowment:keyring` returns nothing; it is intended to be used as a flag\n * by the client to detect whether the snap has keyring capabilities.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the keyring endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  KeyringEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [\n      SnapCaveatType.KeyringOrigin,\n      SnapCaveatType.MaxRequestTime,\n    ],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: createGenericPermissionValidator([\n      { type: SnapCaveatType.KeyringOrigin },\n      { type: SnapCaveatType.MaxRequestTime, optional: true },\n    ]),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const keyringEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Invalid keyring origins: Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsKeyringOrigins(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getKeyringCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.KeyringOrigin,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the {@link KeyringOrigins} caveat value from a\n * permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link KeyringOrigins}\n * caveat.\n */\nexport function getKeyringCaveatOrigins(\n  permission?: PermissionConstraint,\n): KeyringOrigins | null {\n  assert(permission?.caveats);\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, KeyringOrigins>;\n  return caveat.value;\n}\n\nexport const keyringCaveatSpecifications: Record<\n  SnapCaveatType.KeyringOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.KeyringOrigin]: Object.freeze({\n    type: SnapCaveatType.KeyringOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n  }),\n};\n"],"names":["keyringEndowmentBuilder","getKeyringCaveatMapper","getKeyringCaveatOrigins","keyringCaveatSpecifications","permissionName","SnapEndowments","Keyring","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","KeyringOrigin","MaxRequestTime","endowmentGetter","_getterOptions","undefined","validator","createGenericPermissionValidator","type","optional","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","rpcErrors","invalidParams","message","assertIsKeyringOrigins","caveats","permission","assert","length"],"mappings":";;;;;;;;;;;IA0DaA,uBAAuB;eAAvBA;;IA+BGC,sBAAsB;eAAtBA;;IAsBAC,uBAAuB;eAAvBA;;IAWHC,2BAA2B;eAA3BA;;;sCAjH+B;2BAClB;4BAE6B;uBAEJ;yBAEF;sBAClB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,OAAO;AAW7C;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YACdC,0BAAc,CAACC,aAAa;YAC5BD,0BAAc,CAACE,cAAc;SAC9B;QACDC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAWC,IAAAA,yCAAgC,EAAC;YAC1C;gBAAEC,MAAMR,0BAAc,CAACC,aAAa;YAAC;YACrC;gBAAEO,MAAMR,0BAAc,CAACE,cAAc;gBAAEO,UAAU;YAAK;SACvD;QACDC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM1B,0BAA0B2B,OAAOC,MAAM,CAAC;IACnDhB,YAAYR;IACZG;AACF;AAEA;;;;;;CAMC,GACD,SAASsB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMC,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEH,KAAK,EAAE,GAAGH;IAClBO,IAAAA,kCAAsB,EAACJ,OAAOC,oBAAS,CAACC,aAAa;AACvD;AAUO,SAASlC,uBACdgC,KAAW;IAEX,OAAO;QACLK,SAAS;YACP;gBACEhB,MAAMR,0BAAc,CAACC,aAAa;gBAClCkB;YACF;SACD;IACH;AACF;AAWO,SAAS/B,wBACdqC,UAAiC;IAEjCC,IAAAA,aAAM,EAACD,YAAYD;IACnBE,IAAAA,aAAM,EAACD,WAAWD,OAAO,CAACG,MAAM,KAAK;IACrCD,IAAAA,aAAM,EAACD,WAAWD,OAAO,CAAC,EAAE,CAAChB,IAAI,KAAKR,0BAAc,CAACC,aAAa;IAElE,MAAMe,SAASS,WAAWD,OAAO,CAAC,EAAE;IACpC,OAAOR,OAAOG,KAAK;AACrB;AAEO,MAAM9B,8BAGT;IACF,CAACW,0BAAc,CAACC,aAAa,CAAC,EAAEY,OAAOC,MAAM,CAAC;QAC5CN,MAAMR,0BAAc,CAACC,aAAa;QAClCK,WAAW,CAACU,SAAgCD,sBAAsBC;IACpE;AACF"}

package/dist/cjs/endowments/lifecycle-hooks.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "lifecycleHooksEndowmentBuilder", {
-    enumerable: true,
-    get: function() {
-        return lifecycleHooksEndowmentBuilder;
-    }
-});
-const _permissioncontroller = require("@metamask/permission-controller");
-const _enum = require("./enum");
-const permissionName = _enum.SnapEndowments.LifecycleHooks;
-/**
- * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a
- * flag by the snap controller to detect whether the snap has the capability to
- * use lifecycle hooks.
- *
- * @param _builderOptions - Optional specification builder options.
- * @returns The specification for the `lifecycle-hooks` endowment.
- */ const specificationBuilder = (_builderOptions)=>{
-    return {
-        permissionType: _permissioncontroller.PermissionType.Endowment,
-        targetName: permissionName,
-        allowedCaveats: null,
-        endowmentGetter: (_getterOptions)=>undefined,
-        subjectTypes: [
-            _permissioncontroller.SubjectType.Snap
-        ]
-    };
-};
-const lifecycleHooksEndowmentBuilder = Object.freeze({
-    targetName: permissionName,
-    specificationBuilder
-});
-
-//# sourceMappingURL=lifecycle-hooks.js.map

package/dist/cjs/endowments/lifecycle-hooks.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/endowments/lifecycle-hooks.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport type { NonEmptyArray } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.LifecycleHooks;\n\ntype LifecycleHooksEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a\n * flag by the snap controller to detect whether the snap has the capability to\n * use lifecycle hooks.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the `lifecycle-hooks` endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  LifecycleHooksEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const lifecycleHooksEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["lifecycleHooksEndowmentBuilder","permissionName","SnapEndowments","LifecycleHooks","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BAyCaA;;;eAAAA;;;sCApC+B;sBAGb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,cAAc;AASpD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMhB,iCAAiCiB,OAAOC,MAAM,CAAC;IAC1DT,YAAYR;IACZG;AACF"}