@metamask/snaps-rpc-methods 4.1.0 → 6.0.0

package/dist/types/permitted/createInterface.d.ts

@@ -0,0 +1,150 @@
+import type { PermittedHandlerExport } from '@metamask/permission-controller';
+import type { Component, CreateInterfaceParams, CreateInterfaceResult } from '@metamask/snaps-sdk';
+import { type InferMatching } from '@metamask/snaps-utils';
+export declare type CreateInterfaceMethodHooks = {
+    /**
+     * @param ui - The UI components.
+     * @returns The unique identifier of the interface.
+     */
+    createInterface: (ui: Component) => Promise<string>;
+};
+export declare const createInterfaceHandler: PermittedHandlerExport<CreateInterfaceMethodHooks, CreateInterfaceParameters, CreateInterfaceResult>;
+declare const CreateInterfaceParametersStruct: import("superstruct").Struct<{
+    ui: import("@metamask/snaps-sdk").Panel | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    };
+}, {
+    ui: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    }, null>;
+}>;
+export declare type CreateInterfaceParameters = InferMatching<typeof CreateInterfaceParametersStruct, CreateInterfaceParams>;
+export {};

package/dist/types/permitted/getClientStatus.d.ts

@@ -0,0 +1,13 @@
+import type { PermittedHandlerExport } from '@metamask/permission-controller';
+import type { GetClientStatusResult } from '@metamask/snaps-sdk';
+import type { JsonRpcParams } from '@metamask/utils';
+/**
+ * `snap_getClientStatus` returns useful information about the client running the snap.
+ */
+export declare const getClientStatusHandler: PermittedHandlerExport<GetClientStatusHooks, JsonRpcParams, GetClientStatusResult>;
+export declare type GetClientStatusHooks = {
+    /**
+     * @returns Whether the client is locked or not.
+     */
+    getIsLocked: () => boolean;
+};

package/dist/types/permitted/getInterfaceState.d.ts

@@ -0,0 +1,18 @@
+import type { PermittedHandlerExport } from '@metamask/permission-controller';
+import type { GetInterfaceStateParams, GetInterfaceStateResult, InterfaceState } from '@metamask/snaps-sdk';
+import { type InferMatching } from '@metamask/snaps-utils';
+export declare type GetInterfaceStateMethodHooks = {
+    /**
+     * @param id - The interface ID.
+     * @returns The interface state.
+     */
+    getInterfaceState: (id: string) => InterfaceState;
+};
+export declare const getInterfaceStateHandler: PermittedHandlerExport<GetInterfaceStateMethodHooks, GetInterfaceStateParameters, GetInterfaceStateResult>;
+declare const GetInterfaceStateParametersStruct: import("superstruct").Struct<{
+    id: string;
+}, {
+    id: import("superstruct").Struct<string, null>;
+}>;
+export declare type GetInterfaceStateParameters = InferMatching<typeof GetInterfaceStateParametersStruct, GetInterfaceStateParams>;
+export {};

package/dist/types/permitted/handlers.d.ts

@@ -4,6 +4,10 @@ export declare const methodHandlers: {
     wallet_requestSnaps: import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult>;
     wallet_invokeSnap: import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
     wallet_invokeKeyring: import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>;
+    snap_getClientStatus: import("@metamask/permission-controller").PermittedHandlerExport<import("./getClientStatus").GetClientStatusHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetClientStatusResult>;
     snap_getFile: import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string>;
+    snap_createInterface: import("@metamask/permission-controller").PermittedHandlerExport<import("./createInterface").CreateInterfaceMethodHooks, import("@metamask/snaps-sdk").CreateInterfaceParams, string>;
+    snap_updateInterface: import("@metamask/permission-controller").PermittedHandlerExport<import("./updateInterface").UpdateInterfaceMethodHooks, import("@metamask/snaps-sdk").UpdateInterfaceParams, null>;
+    snap_getInterfaceState: import("@metamask/permission-controller").PermittedHandlerExport<import("./getInterfaceState").GetInterfaceStateMethodHooks, import("@metamask/snaps-sdk").GetInterfaceStateParams, Record<string, string | Record<string, string | null> | null>>;
 };
-export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];
+export declare const handlers: (import("@metamask/permission-controller").PermittedHandlerExport<import("./createInterface").CreateInterfaceMethodHooks, import("@metamask/snaps-sdk").CreateInterfaceParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getAllSnaps").GetAllSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getClientStatus").GetClientStatusHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetClientStatusResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getInterfaceState").GetInterfaceStateMethodHooks, import("@metamask/snaps-sdk").GetInterfaceStateParams, Record<string, string | Record<string, string | null> | null>> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getSnaps").GetSnapsHooks, import("@metamask/utils").JsonRpcParams, import("@metamask/snaps-sdk").GetSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./requestSnaps").RequestSnapsHooks, import("@metamask/snaps-sdk").RequestSnapsParams, import("@metamask/snaps-sdk").RequestSnapsResult> | import("@metamask/permission-controller").PermittedHandlerExport<import("./updateInterface").UpdateInterfaceMethodHooks, import("@metamask/snaps-sdk").UpdateInterfaceParams, null> | import("@metamask/permission-controller").PermittedHandlerExport<import("./getFile").GetFileHooks, import("@metamask/snaps-sdk").GetFileParams, string> | import("@metamask/permission-controller").PermittedHandlerExport<void, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json> | import("@metamask/permission-controller").PermittedHandlerExport<import("./invokeKeyring").InvokeKeyringHooks, import("@metamask/snaps-sdk").InvokeSnapParams, import("@metamask/utils").Json>)[];

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

@@ -1,6 +1,10 @@
+import type { CreateInterfaceMethodHooks } from './createInterface';
 import type { GetAllSnapsHooks } from './getAllSnaps';
+import type { GetClientStatusHooks } from './getClientStatus';
+import type { GetInterfaceStateMethodHooks } from './getInterfaceState';
 import type { GetSnapsHooks } from './getSnaps';
 import type { RequestSnapsHooks } from './requestSnaps';
-export declare type PermittedRpcMethodHooks = GetAllSnapsHooks & GetSnapsHooks & RequestSnapsHooks;
+import type { UpdateInterfaceMethodHooks } from './updateInterface';
+export declare type PermittedRpcMethodHooks = GetAllSnapsHooks & GetClientStatusHooks & GetSnapsHooks & RequestSnapsHooks & CreateInterfaceMethodHooks & UpdateInterfaceMethodHooks & GetInterfaceStateMethodHooks;
 export * from './handlers';
 export * from './middleware';

package/dist/types/permitted/invokeKeyring.d.ts

@@ -6,10 +6,10 @@ import type { Snap, SnapRpcHookArgs } from '@metamask/snaps-utils';
  */
 export declare const invokeKeyringHandler: PermittedHandlerExport<InvokeKeyringHooks, InvokeSnapParams, InvokeKeyringResult>;
 export declare type InvokeKeyringHooks = {
-    hasPermission: (origin: string, permissionName: string) => boolean;
-    handleSnapRpcRequest: ({ snapId, origin, handler, request, }: SnapRpcHookArgs & {
+    hasPermission: (permissionName: string) => boolean;
+    handleSnapRpcRequest: ({ snapId, handler, request, }: Omit<SnapRpcHookArgs, 'origin'> & {
         snapId: string;
     }) => Promise<unknown>;
     getSnap: (snapId: string) => Snap | undefined;
-    getAllowedKeyringMethods: (origin: string) => string[];
+    getAllowedKeyringMethods: () => string[];
 };

package/dist/types/permitted/updateInterface.d.ts

@@ -0,0 +1,152 @@
+import type { PermittedHandlerExport } from '@metamask/permission-controller';
+import type { Component, UpdateInterfaceParams, UpdateInterfaceResult } from '@metamask/snaps-sdk';
+import { type InferMatching } from '@metamask/snaps-utils';
+export declare type UpdateInterfaceMethodHooks = {
+    /**
+     * @param id - The interface ID.
+     * @param ui - The UI components.
+     */
+    updateInterface: (id: string, ui: Component) => Promise<void>;
+};
+export declare const updateInterfaceHandler: PermittedHandlerExport<UpdateInterfaceMethodHooks, UpdateInterfaceParameters, UpdateInterfaceResult>;
+declare const UpdateInterfaceParametersStruct: import("superstruct").Struct<{
+    id: string;
+    ui: import("@metamask/snaps-sdk").Panel | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    };
+}, {
+    id: import("superstruct").Struct<string, null>;
+    ui: import("superstruct").Struct<import("@metamask/snaps-sdk").Panel | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Copyable;
+        sensitive?: boolean | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Divider;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Heading;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Image;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Spinner;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Text;
+        markdown?: boolean | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Address;
+    } | {
+        value: {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Image;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Text;
+            markdown?: boolean | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Address;
+        };
+        type: import("@metamask/snaps-sdk").NodeType.Row;
+        label: string;
+        variant?: "default" | "warning" | "critical" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Input;
+        name: string;
+        value?: string | undefined;
+        label?: string | undefined;
+        inputType?: "number" | "text" | "password" | undefined;
+        placeholder?: string | undefined;
+    } | {
+        value: string;
+        type: import("@metamask/snaps-sdk").NodeType.Button;
+        name?: string | undefined;
+        variant?: "primary" | "secondary" | undefined;
+        buttonType?: "button" | "submit" | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").NodeType.Form;
+        name: string;
+        children: ({
+            type: import("@metamask/snaps-sdk").NodeType.Input;
+            name: string;
+            value?: string | undefined;
+            label?: string | undefined;
+            inputType?: "number" | "text" | "password" | undefined;
+            placeholder?: string | undefined;
+        } | {
+            value: string;
+            type: import("@metamask/snaps-sdk").NodeType.Button;
+            name?: string | undefined;
+            variant?: "primary" | "secondary" | undefined;
+            buttonType?: "button" | "submit" | undefined;
+        })[];
+    }, null>;
+}>;
+export declare type UpdateInterfaceParameters = InferMatching<typeof UpdateInterfaceParametersStruct, UpdateInterfaceParams>;
+export {};