@metamask/snaps-controllers 0.25.0 → 0.26.0

package/dist/snaps/SnapController.d.ts

@@ -1,12 +1,13 @@
 import { AddApprovalRequest } from '@metamask/approval-controller';
 import { BaseControllerV2 as BaseController, RestrictedControllerMessenger } from '@metamask/base-controller';
 import { GetEndowments, GetPermissions, GrantPermissions, HasPermission, HasPermissions, RevokeAllPermissions, RevokePermissionForAllSubjects, RevokePermissions } from '@metamask/permission-controller';
-import { BlockedSnapInfo, InstallSnapsResult, PersistedSnap, RequestedSnapPermissions, Snap, SnapId, SnapManifest, SnapRpcHook, SnapRpcHookArgs, SnapStatusEvents, StatusContext, StatusEvents, StatusStates, TruncatedSnap, ValidatedSnapId } from '@metamask/snaps-utils';
+import { BlockedSnapInfo, InstallSnapsResult, PersistedSnap, RequestedSnapPermissions, Snap, SnapId, SnapRpcHook, SnapRpcHookArgs, SnapStatusEvents, StatusContext, StatusEvents, StatusStates, TruncatedSnap, ValidatedSnapId } from '@metamask/snaps-utils';
 import { GetSubjectMetadata } from '@metamask/subject-metadata-controller';
 import { Json } from '@metamask/utils';
 import { StateMachine } from '@xstate/fsm';
 import type { Patch } from 'immer';
 import { ExecuteSnapAction, ExecutionServiceEvents, HandleRpcRequestAction, SnapErrorJson, TerminateAllSnapsAction, TerminateSnapAction } from '../services';
+import { detectSnapLocation, SnapLocation } from './location';
 import { Timer } from './Timer';
 export declare const controllerName = "SnapController";
 export declare const SNAP_APPROVAL_INSTALL = "wallet_installSnap";
@@ -67,23 +68,6 @@ export declare type SnapError = {
     code: number;
     data?: Json;
 };
-/**
- * The return type of {@link SnapController.fetchSnap} and its sibling methods.
- */
-declare type FetchSnapResult = {
-    /**
-     * The manifest of the fetched Snap.
-     */
-    manifest: SnapManifest;
-    /**
-     * The source code of the fetched Snap.
-     */
-    sourceCode: string;
-    /**
-     * The raw XML content of the Snap's SVG icon, if any.
-     */
-    svgIcon?: string;
-};
 declare type CloseAllConnectionsFunction = (origin: string) => void;
 declare type StoredSnaps = Record<SnapId, Snap>;
 export declare type SnapControllerState = {
@@ -232,6 +216,13 @@ export declare type SnapUpdated = {
     type: `${typeof controllerName}:snapUpdated`;
     payload: [snap: TruncatedSnap, oldVersion: string];
 };
+/**
+ * Emitted when a snap is rolled back.
+ */
+export declare type SnapRolledback = {
+    type: `${typeof controllerName}:snapRolledback`;
+    payload: [snap: TruncatedSnap, failedVersion: string];
+};
 /**
  * Emitted when a Snap is terminated. This is different from the snap being
  * stopped as it can also be triggered when a snap fails initialization.
@@ -240,7 +231,7 @@ export declare type SnapTerminated = {
     type: `${typeof controllerName}:snapTerminated`;
     payload: [snap: TruncatedSnap];
 };
-export declare type SnapControllerEvents = SnapAdded | SnapBlocked | SnapInstalled | SnapRemoved | SnapStateChange | SnapUnblocked | SnapUpdated | SnapTerminated;
+export declare type SnapControllerEvents = SnapAdded | SnapBlocked | SnapInstalled | SnapRemoved | SnapStateChange | SnapUnblocked | SnapUpdated | SnapRolledback | SnapTerminated;
 export declare type AllowedActions = GetEndowments | GetPermissions | GetSubjectMetadata | HasPermission | HasPermissions | RevokePermissions | RevokeAllPermissions | RevokePermissionForAllSubjects | GrantPermissions | AddApprovalRequest | HandleRpcRequestAction | ExecuteSnapAction | TerminateAllSnapsAction | TerminateSnapAction;
 export declare type AllowedEvents = ExecutionServiceEvents;
 declare type SnapControllerMessenger = RestrictedControllerMessenger<typeof controllerName, SnapControllerActions | AllowedActions, SnapControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
@@ -329,12 +320,18 @@ declare type SnapControllerArgs = {
      * Persisted state that will be used for rehydration.
      */
     state?: PersistedSnapControllerState;
+    /**
+     * A function that takes Snap Id and converts it into a class that fetches files.
+     *
+     * Used for test overrides.
+     */
+    detectSnapLocation?: typeof detectSnapLocation;
 };
 export declare class SnapController extends BaseController<string, SnapControllerState, SnapControllerMessenger> {
     #private;
     private readonly maxRequestTime;
     private readonly snapsRuntimeData;
-    constructor({ closeAllConnections, messenger, state, getAppKey, environmentEndowmentPermissions, npmRegistryUrl, idleTimeCheckInterval, checkBlockList, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, }: SnapControllerArgs);
+    constructor({ closeAllConnections, messenger, state, getAppKey, environmentEndowmentPermissions, npmRegistryUrl, idleTimeCheckInterval, checkBlockList, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, }: SnapControllerArgs);
     /**
      * Checks all installed snaps against the block list and
      * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}
@@ -560,19 +557,10 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param origin - The origin requesting the snap update.
      * @param snapId - The id of the Snap to be updated.
      * @param newVersionRange - A semver version range in which the maximum version will be chosen.
+     * @param location - Optional location that was already used during installation flow.
      * @returns The snap metadata if updated, `null` otherwise.
      */
-    updateSnap(origin: string, snapId: ValidatedSnapId, newVersionRange?: string): Promise<TruncatedSnap | null>;
-    /**
-     * Fetches the manifest and source code of a snap.
-     *
-     * This function is not hash private yet because of tests.
-     *
-     * @param snapId - The id of the Snap.
-     * @param versionRange - The SemVer version of the Snap to fetch.
-     * @returns A tuple of the Snap manifest object and the Snap source code.
-     */
-    fetchSnap(snapId: ValidatedSnapId, versionRange?: string): Promise<FetchSnapResult>;
+    updateSnap(origin: string, snapId: ValidatedSnapId, newVersionRange?: string, location?: SnapLocation): Promise<TruncatedSnap | null>;
     /**
      * Initiates a request for the given snap's initial permissions.
      * Must be called in order. See processRequestedSnap.