@metamask/snaps-controllers 4.0.0 → 5.0.0

package/dist/types/snaps/SnapController.d.ts

@@ -2,15 +2,15 @@ import type { AddApprovalRequest, UpdateRequestState } from '@metamask/approval-
 import type { RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseController } from '@metamask/base-controller';
 import type { GetEndowments, GetPermissions, GetSubjectMetadata, AddSubjectMetadata, GetSubjects, GrantPermissions, HasPermission, HasPermissions, RevokeAllPermissions, RevokePermissionForAllSubjects, RevokePermissions, UpdateCaveat } from '@metamask/permission-controller';
-import type { MaybeUpdateState, TestOrigin } from '@metamask/phishing-controller';
 import type { BlockReason } from '@metamask/snaps-registry';
 import type { RequestSnapsParams, RequestSnapsResult, SnapId } from '@metamask/snaps-sdk';
 import { AuxiliaryFileEncoding } from '@metamask/snaps-sdk';
-import type { PersistedSnap, Snap, SnapRpcHook, SnapRpcHookArgs, StatusContext, StatusEvents, StatusStates, TruncatedSnap } from '@metamask/snaps-utils';
+import type { PersistedSnap, Snap, SnapManifest, SnapRpcHookArgs, StatusContext, StatusEvents, StatusStates, TruncatedSnap } from '@metamask/snaps-utils';
 import { SnapStatusEvents } from '@metamask/snaps-utils';
 import type { Json, NonEmptyArray } from '@metamask/utils';
 import type { StateMachine } from '@xstate/fsm';
 import type { Patch } from 'immer';
+import type { CreateInterface, GetInterface } from '../interface';
 import type { ExecuteSnapAction, ExecutionServiceEvents, HandleRpcRequestAction, SnapErrorJson, TerminateAllSnapsAction, TerminateSnapAction } from '../services';
 import type { SnapLocation } from './location';
 import { detectSnapLocation } from './location';
@@ -24,6 +24,19 @@ export declare type PendingRequest = {
     requestId: unknown;
     timer: Timer;
 };
+export interface PreinstalledSnapFile {
+    path: string;
+    value: string | Uint8Array;
+}
+export interface PreinstalledSnap {
+    snapId: SnapId;
+    manifest: SnapManifest;
+    files: PreinstalledSnapFile[];
+    removable?: boolean;
+}
+declare type SnapRpcHandler = (options: SnapRpcHookArgs & {
+    timeout: number;
+}) => Promise<unknown>;
 /**
  * A wrapper type for any data stored during runtime of Snaps.
  * It is not persisted in state as it contains non-serializable data and is only relevant for the
@@ -54,7 +67,7 @@ export interface SnapRuntimeData {
     /**
      * RPC handler designated for the Snap
      */
-    rpcHandler: null | SnapRpcHook;
+    rpcHandler: null | SnapRpcHandler;
     /**
      * The finite state machine interpreter for possible states that the Snap can be in such as
      * stopped, running, blocked
@@ -188,6 +201,20 @@ export declare type SnapBlocked = {
     type: `${typeof controllerName}:snapBlocked`;
     payload: [snapId: string, blockedSnapInfo?: BlockReason];
 };
+/**
+ * Emitted when a snap installation or update is started.
+ */
+export declare type SnapInstallStarted = {
+    type: `${typeof controllerName}:snapInstallStarted`;
+    payload: [snapId: SnapId, origin: string, isUpdate: boolean];
+};
+/**
+ * Emitted when a snap installation or update failed.
+ */
+export declare type SnapInstallFailed = {
+    type: `${typeof controllerName}:snapInstallFailed`;
+    payload: [snapId: SnapId, origin: string, isUpdate: boolean, error: string];
+};
 /**
  * Emitted when a snap has been started after being added and authorized during
  * installation.
@@ -247,8 +274,8 @@ export declare type SnapDisabled = {
     type: `${typeof controllerName}:snapDisabled`;
     payload: [snap: TruncatedSnap];
 };
-export declare type SnapControllerEvents = SnapBlocked | SnapInstalled | SnapUninstalled | SnapStateChange | SnapUnblocked | SnapUpdated | SnapRolledback | SnapTerminated | SnapEnabled | SnapDisabled;
-export declare type AllowedActions = GetEndowments | GetPermissions | GetSubjects | GetSubjectMetadata | AddSubjectMetadata | HasPermission | HasPermissions | RevokePermissions | RevokeAllPermissions | RevokePermissionForAllSubjects | GrantPermissions | AddApprovalRequest | HandleRpcRequestAction | ExecuteSnapAction | TerminateAllSnapsAction | TerminateSnapAction | UpdateCaveat | UpdateRequestState | GetResult | GetMetadata | Update | ResolveVersion | TestOrigin | MaybeUpdateState;
+export declare type SnapControllerEvents = SnapBlocked | SnapInstalled | SnapUninstalled | SnapInstallStarted | SnapInstallFailed | SnapStateChange | SnapUnblocked | SnapUpdated | SnapRolledback | SnapTerminated | SnapEnabled | SnapDisabled;
+export declare type AllowedActions = GetEndowments | GetPermissions | GetSubjects | GetSubjectMetadata | AddSubjectMetadata | HasPermission | HasPermissions | RevokePermissions | RevokeAllPermissions | RevokePermissionForAllSubjects | GrantPermissions | AddApprovalRequest | HandleRpcRequestAction | ExecuteSnapAction | TerminateAllSnapsAction | TerminateSnapAction | UpdateCaveat | UpdateRequestState | GetResult | GetMetadata | Update | ResolveVersion | CreateInterface | GetInterface;
 export declare type AllowedEvents = ExecutionServiceEvents | SnapInstalled | SnapUpdated;
 declare type SnapControllerMessenger = RestrictedControllerMessenger<typeof controllerName, SnapControllerActions | AllowedActions, SnapControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 declare type FeatureFlags = {
@@ -315,11 +342,15 @@ declare type SnapControllerArgs = {
      * Used for test overrides.
      */
     detectSnapLocation?: typeof detectSnapLocation;
+    /**
+     * A list of snaps to be preinstalled into the SnapController state on initialization.
+     */
+    preinstalledSnaps?: PreinstalledSnap[];
 };
 export declare class SnapController extends BaseController<string, SnapControllerState, SnapControllerMessenger> {
     #private;
     private readonly maxRequestTime;
-    constructor({ closeAllConnections, messenger, state, dynamicPermissions, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, }: SnapControllerArgs);
+    constructor({ closeAllConnections, messenger, state, dynamicPermissions, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, preinstalledSnaps, }: SnapControllerArgs);
     /**
      * Checks all installed snaps against the block list and
      * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}

package/dist/types/snaps/constants.d.ts

@@ -0,0 +1 @@
+export declare const ALLOWED_PERMISSIONS: readonly string[];

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

@@ -1,6 +1,4 @@
 export * from './location';
 export * from './SnapController';
-export * from './endowments';
 export * from './selectors';
 export * from './registry';
-export * from './permissions';

package/dist/types/utils.d.ts

@@ -1,3 +1,4 @@
+import type { SnapId } from '@metamask/snaps-sdk';
 import type { SnapLocation } from './snaps';
 import { Timer } from './snaps/Timer';
 /**
@@ -134,4 +135,122 @@ export declare type Mutable<Type extends Record<string, unknown>, TargetKey exte
  * @returns The array of files as {@link VirtualFile}s.
  */
 export declare function getSnapFiles(location: SnapLocation, files?: string[] | undefined): Promise<import("@metamask/snaps-utils").VirtualFile<unknown>[]>;
+/**
+ * Fetch the Snap manifest, source code, and any other files from the given
+ * location.
+ *
+ * @param snapId - The ID of the Snap to fetch.
+ * @param location - The location of the Snap.
+ * @returns The Snap files and location.
+ * @throws If the Snap files are invalid, or if the Snap could not be fetched.
+ */
+export declare function fetchSnap(snapId: SnapId, location: SnapLocation): Promise<{
+    manifest: import("@metamask/snaps-utils").VirtualFile<{
+        description: string;
+        version: import("@metamask/utils").SemVerVersion;
+        source: {
+            location: {
+                npm: {
+                    registry: "https://registry.npmjs.org" | "https://registry.npmjs.org/";
+                    filePath: string;
+                    packageName: string;
+                    iconPath?: string | undefined;
+                };
+            };
+            shasum: string;
+            files?: string[] | undefined;
+            locales?: string[] | undefined;
+        };
+        proposedName: string;
+        initialPermissions: {
+            snap_dialog?: {} | undefined;
+            snap_getBip32Entropy?: {
+                path: string[];
+                curve: "ed25519" | "secp256k1";
+            }[] | undefined;
+            snap_getBip32PublicKey?: {
+                path: string[];
+                curve: "ed25519" | "secp256k1";
+            }[] | undefined;
+            snap_getBip44Entropy?: {
+                coinType: number;
+            }[] | undefined;
+            snap_getEntropy?: {} | undefined;
+            snap_getLocale?: {} | undefined;
+            snap_manageAccounts?: {} | undefined;
+            snap_manageState?: {} | undefined;
+            snap_notify?: {} | undefined;
+            wallet_snap?: Record<string, {
+                version?: string | undefined;
+            }> | undefined;
+            'endowment:cronjob'?: {
+                jobs: {
+                    request: {
+                        method: string;
+                        id?: string | number | null | undefined;
+                        jsonrpc?: "2.0" | undefined;
+                        params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
+                    };
+                    expression: string;
+                }[];
+                maxRequestTime?: number | undefined;
+            } | undefined;
+            'endowment:ethereum-provider'?: {} | undefined;
+            'endowment:keyring'?: {
+                allowedOrigins?: string[] | undefined;
+                maxRequestTime?: number | undefined;
+            } | undefined;
+            'endowment:lifecycle-hooks'?: {
+                maxRequestTime?: number | undefined;
+            } | undefined;
+            'endowment:name-lookup'?: {
+                chains?: `${string}:${string}`[] | undefined;
+                maxRequestTime?: number | undefined;
+                matchers?: {
+                    tlds: string[];
+                } | {
+                    schemes: string[];
+                } | {
+                    tlds: string[];
+                    schemes: string[];
+                } | undefined;
+            } | undefined;
+            'endowment:network-access'?: {} | undefined;
+            'endowment:page-home'?: {
+                maxRequestTime?: number | undefined;
+            } | undefined;
+            'endowment:rpc'?: {
+                dapps?: boolean | undefined;
+                snaps?: boolean | undefined;
+                allowedOrigins?: string[] | undefined;
+            } | undefined;
+            'endowment:signature-insight'?: {
+                maxRequestTime?: number | undefined;
+                allowSignatureOrigin?: boolean | undefined;
+            } | undefined;
+            'endowment:transaction-insight'?: {
+                maxRequestTime?: number | undefined;
+                allowTransactionOrigin?: boolean | undefined;
+            } | undefined;
+            'endowment:webassembly'?: {} | undefined;
+        };
+        manifestVersion: "0.1";
+        repository?: {
+            type: string;
+            url: string;
+        } | undefined;
+        initialConnections?: Record<string & URL, {}> | undefined;
+        $schema?: string | undefined;
+    }>;
+    sourceCode: import("@metamask/snaps-utils").VirtualFile<unknown>;
+    svgIcon: import("@metamask/snaps-utils").VirtualFile<unknown> | undefined;
+    auxiliaryFiles: import("@metamask/snaps-utils").VirtualFile<unknown>[];
+    localizationFiles: import("@metamask/snaps-utils").VirtualFile<{
+        locale: string;
+        messages: Record<string, {
+            message: string;
+            description?: string | undefined;
+        }>;
+    }>[];
+}>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -42,19 +42,19 @@
     "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@metamask/approval-controller": "^5.1.1",
-    "@metamask/base-controller": "^4.0.0",
-    "@metamask/json-rpc-engine": "^7.3.1",
+    "@metamask/approval-controller": "^5.1.2",
+    "@metamask/base-controller": "^4.1.0",
+    "@metamask/json-rpc-engine": "^7.3.2",
     "@metamask/object-multiplex": "^2.0.0",
-    "@metamask/permission-controller": "^7.1.0",
-    "@metamask/phishing-controller": "^8.0.1",
-    "@metamask/post-message-stream": "^7.0.0",
+    "@metamask/permission-controller": "^8.0.0",
+    "@metamask/phishing-controller": "^8.0.2",
+    "@metamask/post-message-stream": "^8.0.0",
     "@metamask/rpc-errors": "^6.1.0",
     "@metamask/snaps-registry": "^3.0.0",
-    "@metamask/snaps-rpc-methods": "^4.1.0",
-    "@metamask/snaps-sdk": "^1.3.2",
-    "@metamask/snaps-utils": "^5.1.2",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/snaps-rpc-methods": "^6.0.0",
+    "@metamask/snaps-sdk": "^2.0.0",
+    "@metamask/snaps-utils": "^6.0.0",
+    "@metamask/utils": "^8.3.0",
     "@xstate/fsm": "^2.0.0",
     "browserify-zlib": "^0.2.0",
     "concat-stream": "^2.0.0",
@@ -64,12 +64,12 @@
     "nanoid": "^3.1.31",
     "readable-stream": "^3.6.2",
     "readable-web-to-node-stream": "^3.0.2",
-    "tar-stream": "^3.1.6"
+    "tar-stream": "^3.1.7"
   },
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@lavamoat/allow-scripts": "^2.5.1",
+    "@lavamoat/allow-scripts": "^3.0.0",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
@@ -125,7 +125,7 @@
     "webdriverio": "^8.19.0"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^3.4.3"
+    "@metamask/snaps-execution-environments": "^4.0.0"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {

package/dist/cjs/snaps/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/snaps/endowments/cronjob.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/snaps/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/snaps/endowments/enum.js

@@ -1,25 +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["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/snaps/endowments/enum.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/enum.ts"],"sourcesContent":["export enum SnapEndowments {\n  NetworkAccess = 'endowment:network-access',\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","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks","Keyring","HomePage"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,wBAAqB;IAFXF,eAGVG,aAAU;IAHAH,eAIVI,sBAAmB;IAJTJ,eAKVK,SAAM;IALIL,eAMVM,uBAAoB;IANVN,eAOVO,gBAAa;IAPHP,eAQVQ,oBAAiB;IARPR,eASVS,aAAU;IATAT,eAUVU,cAAW;GAVDV,mBAAAA"}

package/dist/cjs/snaps/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/snaps/endowments/ethereum-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/ethereum-provider.ts"],"sourcesContent":["import type {\n  EndowmentGetterParams,\n  PermissionSpecificationBuilder,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.EthereumProvider;\n\ntype EthereumProviderEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => ['ethereum'];\n  allowedCaveats: null;\n}>;\n\n/**\n * `endowment:ethereum-provider` returns the name of the ethereum global browser API.\n * This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the network endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  EthereumProviderEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n      return ['ethereum'];\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const ethereumProviderEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["ethereumProviderEndowmentBuilder","permissionName","SnapEndowments","EthereumProvider","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BA4CaA;;;eAAAA;;;sCAvC+B;sBAEb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,gBAAgB;AAStD;;;;;;;;;CASC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAW;QACrB;QACAC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMf,mCAAmCgB,OAAOC,MAAM,CAAC;IAC5DR,YAAYR;IACZG;AACF"}

package/dist/cjs/snaps/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/snaps/endowments/home-page.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/snaps/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/snaps/endowments/index.js

@@ -1,99 +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;
-    },
-    getTransactionOriginCaveat: function() {
-        return _transactioninsight.getTransactionOriginCaveat;
-    },
-    getChainIdsCaveat: function() {
-        return _namelookup.getChainIdsCaveat;
-    },
-    getKeyringCaveatOrigins: function() {
-        return _keyring.getKeyringCaveatOrigins;
-    }
-});
-const _snapsutils = require("@metamask/snaps-utils");
-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 _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
-};
-const endowmentCaveatSpecifications = {
-    ..._cronjob.cronjobCaveatSpecifications,
-    ..._transactioninsight.transactionInsightCaveatSpecifications,
-    ..._rpc.rpcCaveatSpecifications,
-    ..._namelookup.nameLookupCaveatSpecifications,
-    ..._keyring.keyringCaveatSpecifications
-};
-const endowmentCaveatMappers = {
-    [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.getCronjobCaveatMapper,
-    [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.getTransactionInsightCaveatMapper,
-    [_rpc.rpcEndowmentBuilder.targetName]: _rpc.getRpcCaveatMapper,
-    [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.getNameLookupCaveatMapper,
-    [_keyring.keyringEndowmentBuilder.targetName]: _keyring.getKeyringCaveatMapper
-};
-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
-};
-
-//# sourceMappingURL=index.js.map