@metamask/snaps-controllers 6.0.3 → 7.0.0

package/dist/types/encryptor.js

@@ -0,0 +1,2 @@
+"use strict";require('../chunk-HP6S5IOB.js');
+//# sourceMappingURL=encryptor.js.map

package/dist/types/encryptor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/encryptor.mjs

@@ -0,0 +1,2 @@
+import "../chunk-NZOUFWUN.mjs";
+//# sourceMappingURL=encryptor.mjs.map

package/dist/types/encryptor.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";require('../chunk-HP6S5IOB.js');
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/index.mjs

@@ -0,0 +1,2 @@
+import "../chunk-NZOUFWUN.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

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

@@ -12,6 +12,7 @@ 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 ExportableKeyEncryptor } from '../types';
 import type { SnapLocation } from './location';
 import { detectSnapLocation } from './location';
 import type { GetMetadata, GetResult, ResolveVersion, SnapsRegistryMetadata, Update } from './registry';
@@ -75,6 +76,10 @@ export interface SnapRuntimeData {
      * @see {@link SnapController:constructor}
      */
     interpreter: StateMachine.Service<StatusContext, StatusEvents, StatusStates>;
+    /**
+     * Cached encryption key used for state encryption.
+     */
+    encryptionKey: string | null;
 }
 export declare type SnapError = {
     message: string;
@@ -351,11 +356,21 @@ declare type SnapControllerArgs = {
      * A list of snaps to be preinstalled into the SnapController state on initialization.
      */
     preinstalledSnaps?: PreinstalledSnap[];
+    /**
+     * A utility object containing functions required for state encryption.
+     */
+    encryptor: ExportableKeyEncryptor;
+    /**
+     * A hook to access the mnemonic of the user's primary keyring.
+     *
+     * @returns The mnemonic as bytes.
+     */
+    getMnemonic: () => Promise<Uint8Array>;
 };
 export declare class SnapController extends BaseController<string, SnapControllerState, SnapControllerMessenger> {
     #private;
     private readonly maxRequestTime;
-    constructor({ closeAllConnections, messenger, state, dynamicPermissions, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, maxIdleTime, maxRequestTime, maxInitTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, preinstalledSnaps, }: SnapControllerArgs);
+    constructor({ closeAllConnections, messenger, state, dynamicPermissions, environmentEndowmentPermissions, excludedPermissions, idleTimeCheckInterval, maxIdleTime, maxRequestTime, maxInitTime, fetchFunction, featureFlags, detectSnapLocation: detectSnapLocationFunction, preinstalledSnaps, encryptor, getMnemonic, }: SnapControllerArgs);
     /**
      * Checks all installed snaps against the block list and
      * blocks/unblocks snaps as appropriate. See {@link SnapController.blockSnap}
@@ -454,7 +469,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param newSnapState - The new state of the snap.
      * @param encrypted - A flag to indicate whether to use encrypted storage or not.
      */
-    updateSnapState(snapId: SnapId, newSnapState: string, encrypted: boolean): void;
+    updateSnapState(snapId: SnapId, newSnapState: Record<string, Json>, encrypted: boolean): Promise<void>;
     /**
      * Clears the state of the snap with the given id.
      * This is distinct from the state MetaMask uses to manage snaps.
@@ -471,7 +486,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param encrypted - A flag to indicate whether to use encrypted storage or not.
      * @returns The requested snap state or null if no state exists.
      */
-    getSnapState(snapId: SnapId, encrypted: boolean): Json;
+    getSnapState(snapId: SnapId, encrypted: boolean): Promise<Json>;
     /**
      * Gets a static auxiliary snap file in a chosen file encoding.
      *

package/dist/types/types/encryptor.d.ts

@@ -0,0 +1,98 @@
+import type { Json } from '@metamask/utils';
+export declare type PBKDF2Params = {
+    iterations: number;
+};
+export declare type KeyDerivationOptions = {
+    algorithm: 'PBKDF2';
+    params: PBKDF2Params;
+};
+export declare type EncryptionResult = {
+    data: string;
+    iv: string;
+    salt: string;
+    keyMetadata?: KeyDerivationOptions;
+};
+/**
+ * A generic encryptor interface that supports encrypting and decrypting
+ * serializable data with a password.
+ */
+export declare type GenericEncryptor = {
+    /**
+     * Encrypt the given object with the given password.
+     *
+     * @param password - The password to encrypt with.
+     * @param object - The object to encrypt.
+     * @returns The encrypted string.
+     */
+    encrypt: (password: string, object: Json) => Promise<string>;
+    /**
+     * Decrypt the given encrypted string with the given password.
+     *
+     * @param password - The password to decrypt with.
+     * @param encryptedString - The encrypted string to decrypt.
+     * @returns The decrypted object.
+     */
+    decrypt: (password: string, encryptedString: string) => Promise<unknown>;
+    /**
+     * Check if the provided vault is up to date with the
+     * desired encryption algorithm.
+     *
+     * @param vault - The encrypted string to check.
+     * @param targetDerivationParams - The desired target derivation params.
+     * @returns The updated encrypted string.
+     */
+    isVaultUpdated: (vault: string, targetDerivationParams?: KeyDerivationOptions) => boolean;
+};
+/**
+ * An encryptor interface that supports encrypting and decrypting
+ * serializable data with a password, and exporting and importing keys.
+ */
+export declare type ExportableKeyEncryptor = GenericEncryptor & {
+    /**
+     * Encrypt the given object with the given encryption key.
+     *
+     * @param key - The encryption key to encrypt with.
+     * @param object - The object to encrypt.
+     * @returns The encryption result.
+     */
+    encryptWithKey: (key: unknown, object: Json) => Promise<EncryptionResult>;
+    /**
+     * Decrypt the given encrypted string with the given encryption key.
+     *
+     * @param key - The encryption key to decrypt with.
+     * @param encryptedString - The encrypted string to decrypt.
+     * @returns The decrypted object.
+     */
+    decryptWithKey: (key: unknown, encryptedString: EncryptionResult) => Promise<unknown>;
+    /**
+     * Generate an encryption key from exported key string.
+     *
+     * @param key - The exported key string.
+     * @returns The encryption key.
+     */
+    importKey: <Type>(key: string) => Promise<Type>;
+    /**
+     * Export a generated key as a string.
+     *
+     * @param key - The encryption key.
+     * @returns The exported key string.
+     */
+    exportKey: (key: unknown) => Promise<string>;
+    /**
+     * Generate a salt with a given length.
+     *
+     * @param length - The length of the salt, default is 32 bytes.
+     * @returns The base64 encoded salt bytes.
+     */
+    generateSalt: (length?: number) => string;
+    /**
+     * Generate an encryption key using a password.
+     *
+     * @param password - The password to use to generate key.
+     * @param salt - The salt string to use in key derivation.
+     * @param exportable - Whether or not the key should be exportable.
+     * @param opts - The options to use for key derivation.
+     * @returns The encryption key.
+     */
+    keyFromPassword: <Type>(password: string, salt: string, exportable?: boolean, opts?: KeyDerivationOptions) => Promise<Type>;
+};

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

@@ -0,0 +1 @@
+export * from './encryptor';

package/dist/types/utils.d.ts

@@ -162,78 +162,54 @@ export declare function fetchSnap(snapId: SnapId, location: SnapLocation): Promi
             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;
-                }[];
+        initialPermissions: Partial<{
+            'endowment:cronjob': {
+                jobs: import("@metamask/snaps-sdk").Cronjob[];
                 maxRequestTime?: number | undefined;
-            } | undefined;
-            'endowment:ethereum-provider'?: {} | undefined;
-            'endowment:keyring'?: {
+            };
+            'endowment:ethereum-provider': import("@metamask/snaps-sdk").EmptyObject;
+            'endowment:keyring': {
                 allowedOrigins?: string[] | undefined;
                 maxRequestTime?: number | undefined;
-            } | undefined;
+            };
             'endowment:lifecycle-hooks'?: {
                 maxRequestTime?: number | undefined;
             } | undefined;
-            'endowment:name-lookup'?: {
+            'endowment:name-lookup': {
                 chains?: `${string}:${string}`[] | undefined;
+                matchers?: import("@metamask/snaps-sdk").NameLookupMatchers | undefined;
                 maxRequestTime?: number | undefined;
-                matchers?: {
-                    tlds: string[];
-                } | {
-                    schemes: string[];
-                } | {
-                    tlds: string[];
-                    schemes: string[];
-                } | undefined;
-            } | undefined;
-            'endowment:network-access'?: {} | undefined;
+            };
+            'endowment:network-access': import("@metamask/snaps-sdk").EmptyObject;
             'endowment:page-home'?: {
                 maxRequestTime?: number | undefined;
             } | undefined;
-            'endowment:rpc'?: {
-                snaps?: boolean | undefined;
+            'endowment:rpc': {
                 dapps?: boolean | undefined;
+                snaps?: boolean | undefined;
                 allowedOrigins?: string[] | undefined;
-            } | undefined;
-            'endowment:signature-insight'?: {
                 maxRequestTime?: number | undefined;
+            };
+            'endowment:signature-insight': {
                 allowSignatureOrigin?: boolean | undefined;
-            } | undefined;
-            'endowment:transaction-insight'?: {
                 maxRequestTime?: number | undefined;
+            };
+            'endowment:transaction-insight': {
                 allowTransactionOrigin?: boolean | undefined;
-            } | undefined;
-            'endowment:webassembly'?: {} | undefined;
-        };
+                maxRequestTime?: number | undefined;
+            };
+            'endowment:webassembly': import("@metamask/snaps-sdk").EmptyObject;
+            snap_dialog: import("@metamask/snaps-sdk").EmptyObject;
+            snap_getBip32Entropy: import("@metamask/snaps-sdk").Bip32Entropy[];
+            snap_getBip32PublicKey: import("@metamask/snaps-sdk").Bip32Entropy[];
+            snap_getBip44Entropy: import("@metamask/snaps-sdk").Bip44Entropy[];
+            snap_getEntropy: import("@metamask/snaps-sdk").EmptyObject;
+            snap_getLocale: import("@metamask/snaps-sdk").EmptyObject;
+            snap_manageAccounts: import("@metamask/snaps-sdk").EmptyObject;
+            snap_manageState: import("@metamask/snaps-sdk").EmptyObject;
+            snap_notify: import("@metamask/snaps-sdk").EmptyObject;
+            wallet_snap: Record<string, import("@metamask/snaps-sdk").RequestedSnap>;
+        }>;
         manifestVersion: "0.1";
         repository?: {
             type: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "6.0.3",
+  "version": "7.0.0",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -51,25 +51,25 @@
     "build:ci": "tsup --clean"
   },
   "dependencies": {
-    "@metamask/approval-controller": "^5.1.3",
-    "@metamask/base-controller": "^4.1.0",
-    "@metamask/json-rpc-engine": "^7.3.3",
+    "@metamask/approval-controller": "^6.0.1",
+    "@metamask/base-controller": "^5.0.1",
+    "@metamask/json-rpc-engine": "^8.0.1",
+    "@metamask/json-rpc-middleware-stream": "^7.0.1",
     "@metamask/object-multiplex": "^2.0.0",
-    "@metamask/permission-controller": "^8.0.1",
-    "@metamask/phishing-controller": "^8.0.2",
+    "@metamask/permission-controller": "^9.0.2",
+    "@metamask/phishing-controller": "^9.0.1",
     "@metamask/post-message-stream": "^8.0.0",
     "@metamask/rpc-errors": "^6.2.1",
-    "@metamask/snaps-registry": "^3.0.1",
-    "@metamask/snaps-rpc-methods": "^7.0.1",
-    "@metamask/snaps-sdk": "^3.1.1",
-    "@metamask/snaps-utils": "^7.0.3",
+    "@metamask/snaps-registry": "^3.1.0",
+    "@metamask/snaps-rpc-methods": "^8.0.0",
+    "@metamask/snaps-sdk": "^4.0.0",
+    "@metamask/snaps-utils": "^7.1.0",
     "@metamask/utils": "^8.3.0",
     "@xstate/fsm": "^2.0.0",
     "browserify-zlib": "^0.2.0",
     "concat-stream": "^2.0.0",
     "get-npm-tarball-url": "^2.0.3",
     "immer": "^9.0.6",
-    "json-rpc-middleware-stream": "^5.0.0",
     "nanoid": "^3.1.31",
     "readable-stream": "^3.6.2",
     "readable-web-to-node-stream": "^3.0.2",
@@ -80,6 +80,7 @@
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
     "@lavamoat/allow-scripts": "^3.0.3",
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/browser-passworder": "^5.0.0",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
@@ -134,7 +135,7 @@
     "webdriverio": "^8.19.0"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^5.0.3"
+    "@metamask/snaps-execution-environments": "^6.0.0"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {