@metamask/snaps-controllers 0.30.0 → 0.32.0

package/dist/snaps/SnapController.d.ts

@@ -1,4 +1,4 @@
-import { AddApprovalRequest } from '@metamask/approval-controller';
+import { AddApprovalRequest, UpdateRequestState } from '@metamask/approval-controller';
 import { BaseControllerV2 as BaseController, RestrictedControllerMessenger } from '@metamask/base-controller';
 import { GetEndowments, GetPermissions, GetSubjects, GrantPermissions, HasPermission, HasPermissions, RevokeAllPermissions, RevokePermissionForAllSubjects, RevokePermissions, UpdateCaveat } from '@metamask/permission-controller';
 import { BlockReason } from '@metamask/snaps-registry';
@@ -9,11 +9,12 @@ 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 { SnapsRegistry, SnapsRegistryMetadata } from './registry';
+import { GetMetadata, GetResult, SnapsRegistryMetadata } from './registry';
 import { Timer } from './Timer';
 export declare const controllerName = "SnapController";
 export declare const SNAP_APPROVAL_INSTALL = "wallet_installSnap";
 export declare const SNAP_APPROVAL_UPDATE = "wallet_updateSnap";
+export declare const SNAP_APPROVAL_RESULT = "wallet_installSnapResult";
 export declare type PendingRequest = {
     requestId: unknown;
     timer: Timer;
@@ -238,7 +239,7 @@ export declare type SnapTerminated = {
     payload: [snap: TruncatedSnap];
 };
 export declare type SnapControllerEvents = SnapAdded | SnapBlocked | SnapInstalled | SnapRemoved | SnapStateChange | SnapUnblocked | SnapUpdated | SnapRolledback | SnapTerminated;
-export declare type AllowedActions = GetEndowments | GetPermissions | GetSubjects | GetSubjectMetadata | HasPermission | HasPermissions | RevokePermissions | RevokeAllPermissions | RevokePermissionForAllSubjects | GrantPermissions | AddApprovalRequest | HandleRpcRequestAction | ExecuteSnapAction | TerminateAllSnapsAction | TerminateSnapAction | UpdateCaveat;
+export declare type AllowedActions = GetEndowments | GetPermissions | GetSubjects | GetSubjectMetadata | HasPermission | HasPermissions | RevokePermissions | RevokeAllPermissions | RevokePermissionForAllSubjects | GrantPermissions | AddApprovalRequest | HandleRpcRequestAction | ExecuteSnapAction | TerminateAllSnapsAction | TerminateSnapAction | UpdateCaveat | UpdateRequestState | GetResult | GetMetadata;
 export declare type AllowedEvents = ExecutionServiceEvents;
 declare type SnapControllerMessenger = RestrictedControllerMessenger<typeof controllerName, SnapControllerActions | AllowedActions, SnapControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
 declare type FeatureFlags = {
@@ -282,10 +283,6 @@ declare type SnapControllerArgs = {
      * How frequently to check whether a snap is idle.
      */
     idleTimeCheckInterval?: number;
-    /**
-     * A registry implementation used for checking for verified and blocked snaps.
-     */
-    registry: SnapsRegistry;
     /**
      * The maximum amount of time that a snap may be idle.
      */
@@ -318,7 +315,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
     #private;
     private readonly maxRequestTime;
     private readonly snapsRuntimeData;
-    constructor({ closeAllConnections, messenger, state, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, registry, maxIdleTime, maxRequestTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, }: SnapControllerArgs);
+    constructor({ closeAllConnections, messenger, state, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, 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}
@@ -517,6 +514,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      *
      * @param origin - The origin requesting the snap.
      * @param snapId - The id of the snap.
+     * @param location - The location implementation of the snap.
      * @param versionRange - The semver range of the snap to install.
      * @returns The resulting snap object, or an error if something went wrong.
      */
@@ -535,11 +533,11 @@ 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 location - Optional location that was already used during installation flow.
+     * @param location - The location implementation of the snap.
      * @param newVersionRange - A semver version range in which the maximum version will be chosen.
      * @returns The snap metadata if updated, `null` otherwise.
      */
-    updateSnap(origin: string, snapId: ValidatedSnapId, location: SnapLocation, newVersionRange?: string): Promise<TruncatedSnap | null>;
+    updateSnap(origin: string, snapId: ValidatedSnapId, location: SnapLocation, newVersionRange?: string): Promise<TruncatedSnap>;
     /**
      * Get metadata for the given snap ID.
      *
@@ -554,8 +552,8 @@ export declare class SnapController extends BaseController<string, SnapControlle
      *
      * This function is not hash private yet because of tests.
      *
-     * @param origin - The origin of the install request.
      * @param snapId - The id of the Snap.
+     * @param pendingApproval - Pending approval to update.
      * @returns The snap's approvedPermissions.
      */
     private authorize;