@metamask/snaps-controllers 3.6.0 → 4.1.0

package/dist/types/snaps/endowments/signature-insight.d.ts

@@ -0,0 +1,39 @@
+import type { PermissionSpecificationBuilder, EndowmentGetterParams, PermissionValidatorConstraint, PermissionConstraint, CaveatSpecificationConstraint } from '@metamask/permission-controller';
+import { PermissionType } from '@metamask/permission-controller';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import type { Json, NonEmptyArray } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+declare const permissionName = SnapEndowments.SignatureInsight;
+export declare const signatureInsightEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.SignatureInsight;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => undefined;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+    }>;
+}>;
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export declare function getSignatureInsightCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the signature origin caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the signature origin caveat from.
+ * @returns The signature origin, or `null` if the permission does not have a
+ * signature origin caveat.
+ */
+export declare function getSignatureOriginCaveat(permission?: PermissionConstraint): boolean | null;
+export declare const signatureInsightCaveatSpecifications: Record<SnapCaveatType.SignatureOrigin, CaveatSpecificationConstraint>;
+export {};

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,102 @@ 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:ethereum-provider'?: {} | undefined;
+            'endowment:network-access'?: {} | undefined;
+            'endowment:webassembly'?: {} | undefined;
+            'endowment:signature-insight'?: {
+                allowSignatureOrigin?: boolean | undefined;
+            } | undefined;
+            'endowment:transaction-insight'?: {
+                allowTransactionOrigin?: boolean | 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;
+                }[];
+            } | undefined;
+            'endowment:rpc'?: {
+                dapps?: boolean | undefined;
+                snaps?: boolean | undefined;
+                allowedOrigins?: string[] | undefined;
+            } | undefined;
+            'endowment:name-lookup'?: `${string}:${string}`[] | undefined;
+            'endowment:keyring'?: {
+                allowedOrigins?: string[] | undefined;
+            } | undefined;
+            snap_confirm?: {} | 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": "3.6.0",
+  "version": "4.1.0",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -43,18 +43,18 @@
   },
   "dependencies": {
     "@metamask/approval-controller": "^5.1.1",
-    "@metamask/base-controller": "^4.0.0",
+    "@metamask/base-controller": "^4.1.0",
     "@metamask/json-rpc-engine": "^7.3.1",
     "@metamask/object-multiplex": "^2.0.0",
-    "@metamask/permission-controller": "^7.0.0",
+    "@metamask/permission-controller": "^7.1.0",
     "@metamask/phishing-controller": "^8.0.1",
     "@metamask/post-message-stream": "^7.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.1",
-    "@metamask/snaps-utils": "^5.1.1",
-    "@metamask/utils": "^8.2.1",
+    "@metamask/snaps-rpc-methods": "^5.0.0",
+    "@metamask/snaps-sdk": "^1.4.0",
+    "@metamask/snaps-utils": "^5.2.0",
+    "@metamask/utils": "^8.3.0",
     "@xstate/fsm": "^2.0.0",
     "browserify-zlib": "^0.2.0",
     "concat-stream": "^2.0.0",
@@ -69,8 +69,8 @@
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@lavamoat/allow-scripts": "^2.5.1",
-    "@metamask/auto-changelog": "^3.4.3",
+    "@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",
     "@metamask/eslint-config-nodejs": "^12.1.0",
@@ -125,7 +125,7 @@
     "webdriverio": "^8.19.0"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^3.4.3"
+    "@metamask/snaps-execution-environments": "^3.5.0"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {