@metamask/snaps-rpc-methods 15.1.0 → 16.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +34 -4
- package/dist/endowments/keyring.cjs +2 -5
- package/dist/endowments/keyring.cjs.map +1 -1
- package/dist/endowments/keyring.d.cts +0 -2
- package/dist/endowments/keyring.d.cts.map +1 -1
- package/dist/endowments/keyring.d.mts +0 -2
- package/dist/endowments/keyring.d.mts.map +1 -1
- package/dist/endowments/keyring.mjs +3 -6
- package/dist/endowments/keyring.mjs.map +1 -1
- package/dist/index.cjs +1 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -2
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +1 -2
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +1 -2
- package/dist/index.mjs.map +1 -1
- package/dist/permissions.cjs +18 -8
- package/dist/permissions.cjs.map +1 -1
- package/dist/permissions.d.cts +3 -2
- package/dist/permissions.d.cts.map +1 -1
- package/dist/permissions.d.mts +3 -2
- package/dist/permissions.d.mts.map +1 -1
- package/dist/permissions.mjs +17 -7
- package/dist/permissions.mjs.map +1 -1
- package/dist/permitted/cancelBackgroundEvent.cjs +10 -14
- package/dist/permitted/cancelBackgroundEvent.cjs.map +1 -1
- package/dist/permitted/cancelBackgroundEvent.d.cts +9 -12
- package/dist/permitted/cancelBackgroundEvent.d.cts.map +1 -1
- package/dist/permitted/cancelBackgroundEvent.d.mts +9 -12
- package/dist/permitted/cancelBackgroundEvent.d.mts.map +1 -1
- package/dist/permitted/cancelBackgroundEvent.mjs +10 -14
- package/dist/permitted/cancelBackgroundEvent.mjs.map +1 -1
- package/dist/permitted/clearState.cjs +10 -16
- package/dist/permitted/clearState.cjs.map +1 -1
- package/dist/permitted/clearState.d.cts +9 -23
- package/dist/permitted/clearState.d.cts.map +1 -1
- package/dist/permitted/clearState.d.mts +9 -23
- package/dist/permitted/clearState.d.mts.map +1 -1
- package/dist/permitted/clearState.mjs +10 -16
- package/dist/permitted/clearState.mjs.map +1 -1
- package/dist/permitted/closeWebSocket.cjs +7 -14
- package/dist/permitted/closeWebSocket.cjs.map +1 -1
- package/dist/permitted/closeWebSocket.d.cts +9 -12
- package/dist/permitted/closeWebSocket.d.cts.map +1 -1
- package/dist/permitted/closeWebSocket.d.mts +9 -12
- package/dist/permitted/closeWebSocket.d.mts.map +1 -1
- package/dist/permitted/closeWebSocket.mjs +7 -14
- package/dist/permitted/closeWebSocket.mjs.map +1 -1
- package/dist/permitted/createInterface.cjs +11 -15
- package/dist/permitted/createInterface.cjs.map +1 -1
- package/dist/permitted/createInterface.d.cts +23 -37
- package/dist/permitted/createInterface.d.cts.map +1 -1
- package/dist/permitted/createInterface.d.mts +23 -37
- package/dist/permitted/createInterface.d.mts.map +1 -1
- package/dist/permitted/createInterface.mjs +11 -15
- package/dist/permitted/createInterface.mjs.map +1 -1
- package/dist/permitted/endTrace.cjs +4 -6
- package/dist/permitted/endTrace.cjs.map +1 -1
- package/dist/permitted/endTrace.d.cts +8 -11
- package/dist/permitted/endTrace.d.cts.map +1 -1
- package/dist/permitted/endTrace.d.mts +8 -11
- package/dist/permitted/endTrace.d.mts.map +1 -1
- package/dist/permitted/endTrace.mjs +4 -6
- package/dist/permitted/endTrace.mjs.map +1 -1
- package/dist/permitted/getAllSnaps.cjs +5 -11
- package/dist/permitted/getAllSnaps.cjs.map +1 -1
- package/dist/permitted/getAllSnaps.d.cts +10 -14
- package/dist/permitted/getAllSnaps.d.cts.map +1 -1
- package/dist/permitted/getAllSnaps.d.mts +10 -14
- package/dist/permitted/getAllSnaps.d.mts.map +1 -1
- package/dist/permitted/getAllSnaps.mjs +5 -11
- package/dist/permitted/getAllSnaps.mjs.map +1 -1
- package/dist/permitted/getBackgroundEvents.cjs +8 -15
- package/dist/permitted/getBackgroundEvents.cjs.map +1 -1
- package/dist/permitted/getBackgroundEvents.d.cts +10 -13
- package/dist/permitted/getBackgroundEvents.d.cts.map +1 -1
- package/dist/permitted/getBackgroundEvents.d.mts +10 -13
- package/dist/permitted/getBackgroundEvents.d.mts.map +1 -1
- package/dist/permitted/getBackgroundEvents.mjs +8 -15
- package/dist/permitted/getBackgroundEvents.mjs.map +1 -1
- package/dist/permitted/getClientStatus.cjs +5 -6
- package/dist/permitted/getClientStatus.cjs.map +1 -1
- package/dist/permitted/getClientStatus.d.cts +17 -18
- package/dist/permitted/getClientStatus.d.cts.map +1 -1
- package/dist/permitted/getClientStatus.d.mts +17 -18
- package/dist/permitted/getClientStatus.d.mts.map +1 -1
- package/dist/permitted/getClientStatus.mjs +5 -6
- package/dist/permitted/getClientStatus.mjs.map +1 -1
- package/dist/permitted/getFile.cjs +7 -11
- package/dist/permitted/getFile.cjs.map +1 -1
- package/dist/permitted/getFile.d.cts +8 -10
- package/dist/permitted/getFile.d.cts.map +1 -1
- package/dist/permitted/getFile.d.mts +8 -10
- package/dist/permitted/getFile.d.mts.map +1 -1
- package/dist/permitted/getFile.mjs +7 -11
- package/dist/permitted/getFile.mjs.map +1 -1
- package/dist/permitted/getInterfaceContext.cjs +12 -15
- package/dist/permitted/getInterfaceContext.cjs.map +1 -1
- package/dist/permitted/getInterfaceContext.d.cts +9 -21
- package/dist/permitted/getInterfaceContext.d.cts.map +1 -1
- package/dist/permitted/getInterfaceContext.d.mts +9 -21
- package/dist/permitted/getInterfaceContext.d.mts.map +1 -1
- package/dist/permitted/getInterfaceContext.mjs +12 -15
- package/dist/permitted/getInterfaceContext.mjs.map +1 -1
- package/dist/permitted/getInterfaceState.cjs +11 -15
- package/dist/permitted/getInterfaceState.cjs.map +1 -1
- package/dist/permitted/getInterfaceState.d.cts +9 -21
- package/dist/permitted/getInterfaceState.d.cts.map +1 -1
- package/dist/permitted/getInterfaceState.d.mts +9 -21
- package/dist/permitted/getInterfaceState.d.mts.map +1 -1
- package/dist/permitted/getInterfaceState.mjs +11 -15
- package/dist/permitted/getInterfaceState.mjs.map +1 -1
- package/dist/permitted/getSnaps.cjs +6 -12
- package/dist/permitted/getSnaps.cjs.map +1 -1
- package/dist/permitted/getSnaps.d.cts +11 -14
- package/dist/permitted/getSnaps.d.cts.map +1 -1
- package/dist/permitted/getSnaps.d.mts +11 -14
- package/dist/permitted/getSnaps.d.mts.map +1 -1
- package/dist/permitted/getSnaps.mjs +6 -12
- package/dist/permitted/getSnaps.mjs.map +1 -1
- package/dist/permitted/getState.cjs +9 -11
- package/dist/permitted/getState.cjs.map +1 -1
- package/dist/permitted/getState.d.cts +17 -28
- package/dist/permitted/getState.d.cts.map +1 -1
- package/dist/permitted/getState.d.mts +17 -28
- package/dist/permitted/getState.d.mts.map +1 -1
- package/dist/permitted/getState.mjs +9 -11
- package/dist/permitted/getState.mjs.map +1 -1
- package/dist/permitted/getWebSockets.cjs +11 -14
- package/dist/permitted/getWebSockets.cjs.map +1 -1
- package/dist/permitted/getWebSockets.d.cts +10 -13
- package/dist/permitted/getWebSockets.d.cts.map +1 -1
- package/dist/permitted/getWebSockets.d.mts +10 -13
- package/dist/permitted/getWebSockets.d.mts.map +1 -1
- package/dist/permitted/getWebSockets.mjs +11 -14
- package/dist/permitted/getWebSockets.mjs.map +1 -1
- package/dist/permitted/index.cjs +0 -1
- package/dist/permitted/index.cjs.map +1 -1
- package/dist/permitted/index.d.cts +29 -25
- package/dist/permitted/index.d.cts.map +1 -1
- package/dist/permitted/index.d.mts +29 -25
- package/dist/permitted/index.d.mts.map +1 -1
- package/dist/permitted/index.mjs +0 -1
- package/dist/permitted/index.mjs.map +1 -1
- package/dist/permitted/invokeKeyring.cjs +12 -13
- package/dist/permitted/invokeKeyring.cjs.map +1 -1
- package/dist/permitted/invokeKeyring.d.cts +17 -16
- package/dist/permitted/invokeKeyring.d.cts.map +1 -1
- package/dist/permitted/invokeKeyring.d.mts +17 -16
- package/dist/permitted/invokeKeyring.d.mts.map +1 -1
- package/dist/permitted/invokeKeyring.mjs +12 -13
- package/dist/permitted/invokeKeyring.mjs.map +1 -1
- package/dist/permitted/invokeSnapSugar.cjs +6 -10
- package/dist/permitted/invokeSnapSugar.cjs.map +1 -1
- package/dist/permitted/invokeSnapSugar.d.cts +9 -12
- package/dist/permitted/invokeSnapSugar.d.cts.map +1 -1
- package/dist/permitted/invokeSnapSugar.d.mts +9 -12
- package/dist/permitted/invokeSnapSugar.d.mts.map +1 -1
- package/dist/permitted/invokeSnapSugar.mjs +6 -10
- package/dist/permitted/invokeSnapSugar.mjs.map +1 -1
- package/dist/permitted/listEntropySources.cjs +28 -12
- package/dist/permitted/listEntropySources.cjs.map +1 -1
- package/dist/permitted/listEntropySources.d.cts +12 -23
- package/dist/permitted/listEntropySources.d.cts.map +1 -1
- package/dist/permitted/listEntropySources.d.mts +12 -23
- package/dist/permitted/listEntropySources.d.mts.map +1 -1
- package/dist/permitted/listEntropySources.mjs +28 -12
- package/dist/permitted/listEntropySources.mjs.map +1 -1
- package/dist/permitted/middleware.cjs +70 -20
- package/dist/permitted/middleware.cjs.map +1 -1
- package/dist/permitted/middleware.d.cts +5 -2
- package/dist/permitted/middleware.d.cts.map +1 -1
- package/dist/permitted/middleware.d.mts +5 -2
- package/dist/permitted/middleware.d.mts.map +1 -1
- package/dist/permitted/middleware.mjs +70 -20
- package/dist/permitted/middleware.mjs.map +1 -1
- package/dist/permitted/openWebSocket.cjs +7 -14
- package/dist/permitted/openWebSocket.cjs.map +1 -1
- package/dist/permitted/openWebSocket.d.cts +9 -12
- package/dist/permitted/openWebSocket.d.cts.map +1 -1
- package/dist/permitted/openWebSocket.d.mts +9 -12
- package/dist/permitted/openWebSocket.d.mts.map +1 -1
- package/dist/permitted/openWebSocket.mjs +7 -14
- package/dist/permitted/openWebSocket.mjs.map +1 -1
- package/dist/permitted/requestSnaps.cjs +14 -19
- package/dist/permitted/requestSnaps.cjs.map +1 -1
- package/dist/permitted/requestSnaps.d.cts +9 -36
- package/dist/permitted/requestSnaps.d.cts.map +1 -1
- package/dist/permitted/requestSnaps.d.mts +9 -36
- package/dist/permitted/requestSnaps.d.mts.map +1 -1
- package/dist/permitted/requestSnaps.mjs +15 -20
- package/dist/permitted/requestSnaps.mjs.map +1 -1
- package/dist/permitted/resolveInterface.cjs +11 -15
- package/dist/permitted/resolveInterface.cjs.map +1 -1
- package/dist/permitted/resolveInterface.d.cts +12 -24
- package/dist/permitted/resolveInterface.d.cts.map +1 -1
- package/dist/permitted/resolveInterface.d.mts +12 -24
- package/dist/permitted/resolveInterface.d.mts.map +1 -1
- package/dist/permitted/resolveInterface.mjs +11 -15
- package/dist/permitted/resolveInterface.mjs.map +1 -1
- package/dist/permitted/scheduleBackgroundEvent.cjs +11 -14
- package/dist/permitted/scheduleBackgroundEvent.cjs.map +1 -1
- package/dist/permitted/scheduleBackgroundEvent.d.cts +10 -17
- package/dist/permitted/scheduleBackgroundEvent.d.cts.map +1 -1
- package/dist/permitted/scheduleBackgroundEvent.d.mts +10 -17
- package/dist/permitted/scheduleBackgroundEvent.d.mts.map +1 -1
- package/dist/permitted/scheduleBackgroundEvent.mjs +11 -14
- package/dist/permitted/scheduleBackgroundEvent.mjs.map +1 -1
- package/dist/permitted/sendWebSocketMessage.cjs +10 -14
- package/dist/permitted/sendWebSocketMessage.cjs.map +1 -1
- package/dist/permitted/sendWebSocketMessage.d.cts +9 -12
- package/dist/permitted/sendWebSocketMessage.d.cts.map +1 -1
- package/dist/permitted/sendWebSocketMessage.d.mts +9 -12
- package/dist/permitted/sendWebSocketMessage.d.mts.map +1 -1
- package/dist/permitted/sendWebSocketMessage.mjs +10 -14
- package/dist/permitted/sendWebSocketMessage.mjs.map +1 -1
- package/dist/permitted/setState.cjs +18 -21
- package/dist/permitted/setState.cjs.map +1 -1
- package/dist/permitted/setState.d.cts +18 -45
- package/dist/permitted/setState.d.cts.map +1 -1
- package/dist/permitted/setState.d.mts +18 -45
- package/dist/permitted/setState.d.mts.map +1 -1
- package/dist/permitted/setState.mjs +18 -21
- package/dist/permitted/setState.mjs.map +1 -1
- package/dist/permitted/startTrace.cjs +4 -6
- package/dist/permitted/startTrace.cjs.map +1 -1
- package/dist/permitted/startTrace.d.cts +8 -11
- package/dist/permitted/startTrace.d.cts.map +1 -1
- package/dist/permitted/startTrace.d.mts +8 -11
- package/dist/permitted/startTrace.d.mts.map +1 -1
- package/dist/permitted/startTrace.mjs +4 -6
- package/dist/permitted/startTrace.mjs.map +1 -1
- package/dist/permitted/trackError.cjs +4 -6
- package/dist/permitted/trackError.cjs.map +1 -1
- package/dist/permitted/trackError.d.cts +8 -11
- package/dist/permitted/trackError.d.cts.map +1 -1
- package/dist/permitted/trackError.d.mts +8 -11
- package/dist/permitted/trackError.d.mts.map +1 -1
- package/dist/permitted/trackError.mjs +4 -6
- package/dist/permitted/trackError.mjs.map +1 -1
- package/dist/permitted/trackEvent.cjs +4 -6
- package/dist/permitted/trackEvent.cjs.map +1 -1
- package/dist/permitted/trackEvent.d.cts +8 -11
- package/dist/permitted/trackEvent.d.cts.map +1 -1
- package/dist/permitted/trackEvent.d.mts +8 -11
- package/dist/permitted/trackEvent.d.mts.map +1 -1
- package/dist/permitted/trackEvent.mjs +4 -6
- package/dist/permitted/trackEvent.mjs.map +1 -1
- package/dist/permitted/updateInterface.cjs +11 -15
- package/dist/permitted/updateInterface.cjs.map +1 -1
- package/dist/permitted/updateInterface.d.cts +9 -22
- package/dist/permitted/updateInterface.d.cts.map +1 -1
- package/dist/permitted/updateInterface.d.mts +9 -22
- package/dist/permitted/updateInterface.d.mts.map +1 -1
- package/dist/permitted/updateInterface.mjs +11 -15
- package/dist/permitted/updateInterface.mjs.map +1 -1
- package/dist/restricted/dialog.cjs +23 -30
- package/dist/restricted/dialog.cjs.map +1 -1
- package/dist/restricted/dialog.d.cts +10 -58
- package/dist/restricted/dialog.d.cts.map +1 -1
- package/dist/restricted/dialog.d.mts +10 -58
- package/dist/restricted/dialog.d.mts.map +1 -1
- package/dist/restricted/dialog.mjs +23 -30
- package/dist/restricted/dialog.mjs.map +1 -1
- package/dist/restricted/getBip32Entropy.cjs +15 -12
- package/dist/restricted/getBip32Entropy.cjs.map +1 -1
- package/dist/restricted/getBip32Entropy.d.cts +11 -24
- package/dist/restricted/getBip32Entropy.d.cts.map +1 -1
- package/dist/restricted/getBip32Entropy.d.mts +11 -24
- package/dist/restricted/getBip32Entropy.d.mts.map +1 -1
- package/dist/restricted/getBip32Entropy.mjs +16 -13
- package/dist/restricted/getBip32Entropy.mjs.map +1 -1
- package/dist/restricted/getBip32PublicKey.cjs +15 -12
- package/dist/restricted/getBip32PublicKey.cjs.map +1 -1
- package/dist/restricted/getBip32PublicKey.d.cts +11 -24
- package/dist/restricted/getBip32PublicKey.d.cts.map +1 -1
- package/dist/restricted/getBip32PublicKey.d.mts +11 -24
- package/dist/restricted/getBip32PublicKey.d.mts.map +1 -1
- package/dist/restricted/getBip32PublicKey.mjs +16 -13
- package/dist/restricted/getBip32PublicKey.mjs.map +1 -1
- package/dist/restricted/getBip44Entropy.cjs +14 -10
- package/dist/restricted/getBip44Entropy.cjs.map +1 -1
- package/dist/restricted/getBip44Entropy.d.cts +11 -15
- package/dist/restricted/getBip44Entropy.d.cts.map +1 -1
- package/dist/restricted/getBip44Entropy.d.mts +11 -15
- package/dist/restricted/getBip44Entropy.d.mts.map +1 -1
- package/dist/restricted/getBip44Entropy.mjs +15 -11
- package/dist/restricted/getBip44Entropy.mjs.map +1 -1
- package/dist/restricted/getEntropy.cjs +10 -10
- package/dist/restricted/getEntropy.cjs.map +1 -1
- package/dist/restricted/getEntropy.d.cts +11 -15
- package/dist/restricted/getEntropy.d.cts.map +1 -1
- package/dist/restricted/getEntropy.d.mts +11 -15
- package/dist/restricted/getEntropy.d.mts.map +1 -1
- package/dist/restricted/getEntropy.mjs +11 -11
- package/dist/restricted/getEntropy.mjs.map +1 -1
- package/dist/restricted/index.cjs.map +1 -1
- package/dist/restricted/index.d.cts +20 -160
- package/dist/restricted/index.d.cts.map +1 -1
- package/dist/restricted/index.d.mts +20 -160
- package/dist/restricted/index.d.mts.map +1 -1
- package/dist/restricted/index.mjs.map +1 -1
- package/dist/restricted/invokeSnap.cjs +11 -12
- package/dist/restricted/invokeSnap.cjs.map +1 -1
- package/dist/restricted/invokeSnap.d.cts +9 -13
- package/dist/restricted/invokeSnap.d.cts.map +1 -1
- package/dist/restricted/invokeSnap.d.mts +9 -13
- package/dist/restricted/invokeSnap.d.mts.map +1 -1
- package/dist/restricted/invokeSnap.mjs +11 -12
- package/dist/restricted/invokeSnap.mjs.map +1 -1
- package/dist/restricted/manageState.cjs +21 -20
- package/dist/restricted/manageState.cjs.map +1 -1
- package/dist/restricted/manageState.d.cts +12 -34
- package/dist/restricted/manageState.d.cts.map +1 -1
- package/dist/restricted/manageState.d.mts +12 -34
- package/dist/restricted/manageState.d.mts.map +1 -1
- package/dist/restricted/manageState.mjs +21 -20
- package/dist/restricted/manageState.mjs.map +1 -1
- package/dist/restricted/notify.cjs +31 -24
- package/dist/restricted/notify.cjs.map +1 -1
- package/dist/restricted/notify.d.cts +16 -25
- package/dist/restricted/notify.d.cts.map +1 -1
- package/dist/restricted/notify.d.mts +16 -25
- package/dist/restricted/notify.d.mts.map +1 -1
- package/dist/restricted/notify.mjs +32 -25
- package/dist/restricted/notify.mjs.map +1 -1
- package/dist/types.cjs +3 -0
- package/dist/types.cjs.map +1 -0
- package/dist/types.d.cts +155 -0
- package/dist/types.d.cts.map +1 -0
- package/dist/types.d.mts +155 -0
- package/dist/types.d.mts.map +1 -0
- package/dist/types.mjs +2 -0
- package/dist/types.mjs.map +1 -0
- package/dist/utils.cjs +78 -24
- package/dist/utils.cjs.map +1 -1
- package/dist/utils.d.cts +21 -13
- package/dist/utils.d.cts.map +1 -1
- package/dist/utils.d.mts +21 -13
- package/dist/utils.d.mts.map +1 -1
- package/dist/utils.mjs +75 -22
- package/dist/utils.mjs.map +1 -1
- package/package.json +6 -6
- package/dist/permitted/handlers.cjs +0 -63
- package/dist/permitted/handlers.cjs.map +0 -1
- package/dist/permitted/handlers.d.cts +0 -299
- package/dist/permitted/handlers.d.cts.map +0 -1
- package/dist/permitted/handlers.d.mts +0 -299
- package/dist/permitted/handlers.d.mts.map +0 -1
- package/dist/permitted/handlers.mjs +0 -60
- package/dist/permitted/handlers.mjs.map +0 -1
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
|
|
2
|
-
import type {
|
|
2
|
+
import type { Messenger } from "@metamask/messenger";
|
|
3
|
+
import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
|
|
4
|
+
import type { CloseWebSocketParams, CloseWebSocketResult } from "@metamask/snaps-sdk";
|
|
3
5
|
import type { InferMatching } from "@metamask/snaps-utils";
|
|
4
6
|
import type { PendingJsonRpcResponse } from "@metamask/utils";
|
|
5
|
-
import type {
|
|
6
|
-
export type
|
|
7
|
-
hasPermission: (permissionName: string) => boolean;
|
|
8
|
-
closeWebSocket: (id: string) => void;
|
|
9
|
-
};
|
|
7
|
+
import type { JsonRpcRequestWithOrigin, WebSocketServiceCloseAction } from "../types.cjs";
|
|
8
|
+
export type CloseWebSocketMethodActions = PermissionControllerHasPermissionAction | WebSocketServiceCloseAction;
|
|
10
9
|
declare const CloseWebSocketParametersStruct: import("@metamask/superstruct").Struct<{
|
|
11
10
|
id: string;
|
|
12
11
|
}, {
|
|
@@ -33,9 +32,8 @@ export type CloseWebSocketParameters = InferMatching<typeof CloseWebSocketParame
|
|
|
33
32
|
* ```
|
|
34
33
|
*/
|
|
35
34
|
export declare const closeWebSocketHandler: {
|
|
36
|
-
methodNames: ["snap_closeWebSocket"];
|
|
37
35
|
implementation: typeof closeWebSocketImplementation;
|
|
38
|
-
|
|
36
|
+
actionNames: ("WebSocketService:close" | "PermissionController:hasPermission")[];
|
|
39
37
|
};
|
|
40
38
|
/**
|
|
41
39
|
* The `snap_closeWebSocket` method implementation.
|
|
@@ -44,11 +42,10 @@ export declare const closeWebSocketHandler: {
|
|
|
44
42
|
* @param res - The JSON-RPC response object.
|
|
45
43
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this function.
|
|
46
44
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
47
|
-
* @param
|
|
48
|
-
* @param
|
|
49
|
-
* @param hooks.closeWebSocket - The function to close a WebSocket.
|
|
45
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
46
|
+
* @param messenger - The messenger used to call controller actions.
|
|
50
47
|
* @returns Nothing.
|
|
51
48
|
*/
|
|
52
|
-
declare function closeWebSocketImplementation(req:
|
|
49
|
+
declare function closeWebSocketImplementation(req: JsonRpcRequestWithOrigin<CloseWebSocketParameters>, res: PendingJsonRpcResponse<CloseWebSocketResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, CloseWebSocketMethodActions>): void;
|
|
53
50
|
export {};
|
|
54
51
|
//# sourceMappingURL=closeWebSocket.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"closeWebSocket.d.cts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"closeWebSocket.d.cts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,qBAAiB;AAElB,MAAM,MAAM,2BAA2B,GACnC,uCAAuC,GACvC,2BAA2B,CAAC;AAEhC,QAAA,MAAM,8BAA8B;;;;EAElC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,OAAO,8BAA8B,EACrC,oBAAoB,CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB;;;CASjC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,iBAAS,4BAA4B,CACnC,GAAG,EAAE,wBAAwB,CAAC,wBAAwB,CAAC,EACvD,GAAG,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,EACjD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,2BAA2B,CAAC,GACxD,IAAI,CAsBN"}
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
|
|
2
|
-
import type {
|
|
2
|
+
import type { Messenger } from "@metamask/messenger";
|
|
3
|
+
import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
|
|
4
|
+
import type { CloseWebSocketParams, CloseWebSocketResult } from "@metamask/snaps-sdk";
|
|
3
5
|
import type { InferMatching } from "@metamask/snaps-utils";
|
|
4
6
|
import type { PendingJsonRpcResponse } from "@metamask/utils";
|
|
5
|
-
import type {
|
|
6
|
-
export type
|
|
7
|
-
hasPermission: (permissionName: string) => boolean;
|
|
8
|
-
closeWebSocket: (id: string) => void;
|
|
9
|
-
};
|
|
7
|
+
import type { JsonRpcRequestWithOrigin, WebSocketServiceCloseAction } from "../types.mjs";
|
|
8
|
+
export type CloseWebSocketMethodActions = PermissionControllerHasPermissionAction | WebSocketServiceCloseAction;
|
|
10
9
|
declare const CloseWebSocketParametersStruct: import("@metamask/superstruct").Struct<{
|
|
11
10
|
id: string;
|
|
12
11
|
}, {
|
|
@@ -33,9 +32,8 @@ export type CloseWebSocketParameters = InferMatching<typeof CloseWebSocketParame
|
|
|
33
32
|
* ```
|
|
34
33
|
*/
|
|
35
34
|
export declare const closeWebSocketHandler: {
|
|
36
|
-
methodNames: ["snap_closeWebSocket"];
|
|
37
35
|
implementation: typeof closeWebSocketImplementation;
|
|
38
|
-
|
|
36
|
+
actionNames: ("WebSocketService:close" | "PermissionController:hasPermission")[];
|
|
39
37
|
};
|
|
40
38
|
/**
|
|
41
39
|
* The `snap_closeWebSocket` method implementation.
|
|
@@ -44,11 +42,10 @@ export declare const closeWebSocketHandler: {
|
|
|
44
42
|
* @param res - The JSON-RPC response object.
|
|
45
43
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this function.
|
|
46
44
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
47
|
-
* @param
|
|
48
|
-
* @param
|
|
49
|
-
* @param hooks.closeWebSocket - The function to close a WebSocket.
|
|
45
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
46
|
+
* @param messenger - The messenger used to call controller actions.
|
|
50
47
|
* @returns Nothing.
|
|
51
48
|
*/
|
|
52
|
-
declare function closeWebSocketImplementation(req:
|
|
49
|
+
declare function closeWebSocketImplementation(req: JsonRpcRequestWithOrigin<CloseWebSocketParameters>, res: PendingJsonRpcResponse<CloseWebSocketResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, CloseWebSocketMethodActions>): void;
|
|
53
50
|
export {};
|
|
54
51
|
//# sourceMappingURL=closeWebSocket.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"closeWebSocket.d.mts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"closeWebSocket.d.mts","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAG9D,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC5B,qBAAiB;AAElB,MAAM,MAAM,2BAA2B,GACnC,uCAAuC,GACvC,2BAA2B,CAAC;AAEhC,QAAA,MAAM,8BAA8B;;;;EAElC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAClD,OAAO,8BAA8B,EACrC,oBAAoB,CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB;;;CASjC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,iBAAS,4BAA4B,CACnC,GAAG,EAAE,wBAAwB,CAAC,wBAAwB,CAAC,EACvD,GAAG,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,EACjD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,2BAA2B,CAAC,GACxD,IAAI,CAsBN"}
|
|
@@ -1,11 +1,6 @@
|
|
|
1
1
|
import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
|
|
2
2
|
import { create, object, string, StructError } from "@metamask/superstruct";
|
|
3
3
|
import { SnapEndowments } from "../endowments/index.mjs";
|
|
4
|
-
const methodName = 'snap_closeWebSocket';
|
|
5
|
-
const hookNames = {
|
|
6
|
-
hasPermission: true,
|
|
7
|
-
closeWebSocket: true,
|
|
8
|
-
};
|
|
9
4
|
const CloseWebSocketParametersStruct = object({
|
|
10
5
|
id: string(),
|
|
11
6
|
});
|
|
@@ -29,9 +24,8 @@ const CloseWebSocketParametersStruct = object({
|
|
|
29
24
|
* ```
|
|
30
25
|
*/
|
|
31
26
|
export const closeWebSocketHandler = {
|
|
32
|
-
methodNames: [methodName],
|
|
33
27
|
implementation: closeWebSocketImplementation,
|
|
34
|
-
|
|
28
|
+
actionNames: ['PermissionController:hasPermission', 'WebSocketService:close'],
|
|
35
29
|
};
|
|
36
30
|
/**
|
|
37
31
|
* The `snap_closeWebSocket` method implementation.
|
|
@@ -40,19 +34,18 @@ export const closeWebSocketHandler = {
|
|
|
40
34
|
* @param res - The JSON-RPC response object.
|
|
41
35
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this function.
|
|
42
36
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
43
|
-
* @param
|
|
44
|
-
* @param
|
|
45
|
-
* @param hooks.closeWebSocket - The function to close a WebSocket.
|
|
37
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
38
|
+
* @param messenger - The messenger used to call controller actions.
|
|
46
39
|
* @returns Nothing.
|
|
47
40
|
*/
|
|
48
|
-
function closeWebSocketImplementation(req, res, _next, end,
|
|
49
|
-
|
|
41
|
+
function closeWebSocketImplementation(req, res, _next, end, _hooks, messenger) {
|
|
42
|
+
const { params, origin } = req;
|
|
43
|
+
if (!messenger.call('PermissionController:hasPermission', origin, SnapEndowments.NetworkAccess)) {
|
|
50
44
|
return end(providerErrors.unauthorized());
|
|
51
45
|
}
|
|
52
|
-
const { params } = req;
|
|
53
46
|
try {
|
|
54
47
|
const { id } = getValidatedParams(params);
|
|
55
|
-
|
|
48
|
+
messenger.call('WebSocketService:close', origin, id);
|
|
56
49
|
res.result = null;
|
|
57
50
|
}
|
|
58
51
|
catch (error) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"closeWebSocket.mjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"closeWebSocket.mjs","sourceRoot":"","sources":["../../src/permitted/closeWebSocket.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AAMjE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA8B;AAG5E,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAU/C,MAAM,8BAA8B,GAAG,MAAM,CAAC;IAC5C,EAAE,EAAE,MAAM,EAAE;CACb,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,cAAc,EAAE,4BAA4B;IAC5C,WAAW,EAAE,CAAC,oCAAoC,EAAE,wBAAwB,CAAC;CAO9E,CAAC;AAEF;;;;;;;;;;GAUG;AACH,SAAS,4BAA4B,CACnC,GAAuD,EACvD,GAAiD,EACjD,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAAyD;IAEzD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,IACE,CAAC,SAAS,CAAC,IAAI,CACb,oCAAoC,EACpC,MAAM,EACN,cAAc,CAAC,aAAa,CAC7B,EACD,CAAC;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,EAAE,EAAE,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC1C,SAAS,CAAC,IAAI,CAAC,wBAAwB,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACrD,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;IACxD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type {\n JsonRpcEngineEndCallback,\n MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerHasPermissionAction } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n CloseWebSocketParams,\n CloseWebSocketResult,\n} from '@metamask/snaps-sdk';\nimport type { InferMatching } from '@metamask/snaps-utils';\nimport { create, object, string, StructError } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport { SnapEndowments } from '../endowments';\nimport type {\n JsonRpcRequestWithOrigin,\n WebSocketServiceCloseAction,\n} from '../types';\n\nexport type CloseWebSocketMethodActions =\n | PermissionControllerHasPermissionAction\n | WebSocketServiceCloseAction;\n\nconst CloseWebSocketParametersStruct = object({\n id: string(),\n});\n\nexport type CloseWebSocketParameters = InferMatching<\n typeof CloseWebSocketParametersStruct,\n CloseWebSocketParams\n>;\n\n/**\n * Closes a WebSocket connection that was previously opened with\n * [`snap_openWebSocket`](https://docs.metamask.io/snaps/reference/snaps-api/snap_openwebsocket).\n *\n * @example\n * ```json name=\"Manifest\"\n * {\n * \"initialPermissions\": {\n * \"endowment:network-access\": {}\n * }\n * }\n * ```\n * ```ts name=\"Usage\"\n * await snap.request({\n * method: 'snap_closeWebSocket',\n * params: { id: 'websocket-1' },\n * });\n * ```\n */\nexport const closeWebSocketHandler = {\n implementation: closeWebSocketImplementation,\n actionNames: ['PermissionController:hasPermission', 'WebSocketService:close'],\n} satisfies MethodHandler<\n never,\n CloseWebSocketMethodActions,\n CloseWebSocketParams,\n CloseWebSocketResult,\n { origin: string }\n>;\n\n/**\n * The `snap_closeWebSocket` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param _hooks - The RPC method hooks. Not used by this function.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nfunction closeWebSocketImplementation(\n req: JsonRpcRequestWithOrigin<CloseWebSocketParameters>,\n res: PendingJsonRpcResponse<CloseWebSocketResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n _hooks: never,\n messenger: Messenger<string, CloseWebSocketMethodActions>,\n): void {\n const { params, origin } = req;\n\n if (\n !messenger.call(\n 'PermissionController:hasPermission',\n origin,\n SnapEndowments.NetworkAccess,\n )\n ) {\n return end(providerErrors.unauthorized());\n }\n\n try {\n const { id } = getValidatedParams(params);\n messenger.call('WebSocketService:close', origin, id);\n res.result = null;\n } catch (error) {\n return end(error);\n }\n\n return end();\n}\n\n/**\n * Validates the parameters for the snap_closeWebSocket method.\n *\n * @param params - Parameters to validate.\n * @returns Validated parameters.\n * @throws Throws RPC error if validation fails.\n */\nfunction getValidatedParams(params: unknown): CloseWebSocketParameters {\n try {\n return create(params, CloseWebSocketParametersStruct);\n } catch (error) {\n if (error instanceof StructError) {\n throw rpcErrors.invalidParams({\n message: `Invalid params: ${error.message}.`,\n });\n }\n /* istanbul ignore next */\n throw rpcErrors.internal();\n }\n}\n"]}
|
|
@@ -5,11 +5,6 @@ const rpc_errors_1 = require("@metamask/rpc-errors");
|
|
|
5
5
|
const snaps_sdk_1 = require("@metamask/snaps-sdk");
|
|
6
6
|
const superstruct_1 = require("@metamask/superstruct");
|
|
7
7
|
const utils_1 = require("../utils.cjs");
|
|
8
|
-
const methodName = 'snap_createInterface';
|
|
9
|
-
const hookNames = {
|
|
10
|
-
hasPermission: true,
|
|
11
|
-
createInterface: true,
|
|
12
|
-
};
|
|
13
8
|
/**
|
|
14
9
|
* Create the interactive interface for use in the
|
|
15
10
|
* [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
|
|
@@ -32,9 +27,11 @@ const hookNames = {
|
|
|
32
27
|
* ```
|
|
33
28
|
*/
|
|
34
29
|
exports.createInterfaceHandler = {
|
|
35
|
-
methodNames: [methodName],
|
|
36
30
|
implementation: getCreateInterfaceImplementation,
|
|
37
|
-
|
|
31
|
+
actionNames: [
|
|
32
|
+
'PermissionController:hasPermission',
|
|
33
|
+
'SnapInterfaceController:createInterface',
|
|
34
|
+
],
|
|
38
35
|
};
|
|
39
36
|
const CreateInterfaceParametersStruct = (0, superstruct_1.object)({
|
|
40
37
|
ui: snaps_sdk_1.ComponentOrElementStruct,
|
|
@@ -48,23 +45,22 @@ const CreateInterfaceParametersStruct = (0, superstruct_1.object)({
|
|
|
48
45
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
|
|
49
46
|
* function.
|
|
50
47
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
51
|
-
* @param
|
|
52
|
-
* @param
|
|
53
|
-
* permission.
|
|
54
|
-
* @param hooks.createInterface - The function to create the interface.
|
|
48
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
49
|
+
* @param messenger - The messenger used to call controller actions.
|
|
55
50
|
* @returns Nothing.
|
|
56
51
|
*/
|
|
57
|
-
function getCreateInterfaceImplementation(req, res, _next, end,
|
|
58
|
-
|
|
52
|
+
function getCreateInterfaceImplementation(req, res, _next, end, _hooks, messenger) {
|
|
53
|
+
const { params, origin } = req;
|
|
54
|
+
const isPermitted = utils_1.UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
|
|
55
|
+
if (!isPermitted) {
|
|
59
56
|
return end(rpc_errors_1.providerErrors.unauthorized({
|
|
60
57
|
message: `This method can only be used if the Snap has one of the following permissions: ${utils_1.UI_PERMISSIONS.join(', ')}.`,
|
|
61
58
|
}));
|
|
62
59
|
}
|
|
63
|
-
const { params } = req;
|
|
64
60
|
try {
|
|
65
61
|
const validatedParams = getValidatedParams(params);
|
|
66
62
|
const { ui, context } = validatedParams;
|
|
67
|
-
res.result = createInterface
|
|
63
|
+
res.result = messenger.call('SnapInterfaceController:createInterface', origin, ui, context);
|
|
68
64
|
}
|
|
69
65
|
catch (error) {
|
|
70
66
|
return end(error);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createInterface.cjs","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"createInterface.cjs","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":";;;AAMA,qDAAiE;AAKjE,mDAG6B;AAE7B,uDAA8E;AAO9E,wCAA0C;AAM1C;;;;;;;;;;;;;;;;;;;;GAoBG;AACU,QAAA,sBAAsB,GAAG;IACpC,cAAc,EAAE,gCAAgC;IAChD,WAAW,EAAE;QACX,oCAAoC;QACpC,yCAAyC;KAC1C;CAOF,CAAC;AAEF,MAAM,+BAA+B,GAAG,IAAA,oBAAM,EAAC;IAC7C,EAAE,EAAE,oCAAwB;IAC5B,OAAO,EAAE,IAAA,sBAAQ,EAAC,kCAAsB,CAAC;CAC1C,CAAC,CAAC;AAOH;;;;;;;;;;;GAWG;AACH,SAAS,gCAAgC,CACvC,GAAwD,EACxD,GAAkD,EAClD,KAAc,EACd,GAA6B,EAC7B,MAAa,EACb,SAA0D;IAE1D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAE/B,MAAM,WAAW,GAAG,sBAAc,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CACrD,SAAS,CAAC,IAAI,CAAC,oCAAoC,EAAE,MAAM,EAAE,UAAU,CAAC,CACzE,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,GAAG,CACR,2BAAc,CAAC,YAAY,CAAC;YAC1B,OAAO,EAAE,kFAAkF,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;SACxH,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAExC,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,IAAI,CACzB,yCAAyC,EACzC,MAAM,EACN,EAAE,EACF,OAAO,CACR,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type {\n JsonRpcEngineEndCallback,\n MethodHandler,\n} from '@metamask/json-rpc-engine';\nimport type { Messenger } from '@metamask/messenger';\nimport type { PermissionControllerHasPermissionAction } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport type {\n CreateInterfaceParams,\n CreateInterfaceResult,\n} from '@metamask/snaps-sdk';\nimport {\n ComponentOrElementStruct,\n InterfaceContextStruct,\n} from '@metamask/snaps-sdk';\nimport { type InferMatching } from '@metamask/snaps-utils';\nimport { StructError, create, object, optional } from '@metamask/superstruct';\nimport type { PendingJsonRpcResponse } from '@metamask/utils';\n\nimport type {\n JsonRpcRequestWithOrigin,\n SnapInterfaceControllerCreateInterfaceAction,\n} from '../types';\nimport { UI_PERMISSIONS } from '../utils';\n\nexport type CreateInterfaceMethodActions =\n | PermissionControllerHasPermissionAction\n | SnapInterfaceControllerCreateInterfaceAction;\n\n/**\n * Create the interactive interface for use in the\n * [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).\n *\n * @example\n * ```tsx\n * import { Box, Heading, Text } from '@metamask/snaps-sdk/jsx';\n *\n * const interfaceId = snap.request({\n * method: 'snap_createInterface',\n * params: {\n * ui: (\n * <Box>\n * <Heading>Example Interface</Heading>\n * <Text>This is an example interface created by \"snap_createInterface\".</Text>\n * </Box>\n * ),\n * },\n * });\n * ```\n */\nexport const createInterfaceHandler = {\n implementation: getCreateInterfaceImplementation,\n actionNames: [\n 'PermissionController:hasPermission',\n 'SnapInterfaceController:createInterface',\n ],\n} satisfies MethodHandler<\n never,\n CreateInterfaceMethodActions,\n CreateInterfaceParameters,\n CreateInterfaceResult,\n { origin: string }\n>;\n\nconst CreateInterfaceParametersStruct = object({\n ui: ComponentOrElementStruct,\n context: optional(InterfaceContextStruct),\n});\n\nexport type CreateInterfaceParameters = InferMatching<\n typeof CreateInterfaceParametersStruct,\n CreateInterfaceParams\n>;\n\n/**\n * The `snap_createInterface` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param _hooks - The RPC method hooks. Not used by this function.\n * @param messenger - The messenger used to call controller actions.\n * @returns Nothing.\n */\nfunction getCreateInterfaceImplementation(\n req: JsonRpcRequestWithOrigin<CreateInterfaceParameters>,\n res: PendingJsonRpcResponse<CreateInterfaceResult>,\n _next: unknown,\n end: JsonRpcEngineEndCallback,\n _hooks: never,\n messenger: Messenger<string, CreateInterfaceMethodActions>,\n): void {\n const { params, origin } = req;\n\n const isPermitted = UI_PERMISSIONS.some((permission) =>\n messenger.call('PermissionController:hasPermission', origin, permission),\n );\n\n if (!isPermitted) {\n return end(\n providerErrors.unauthorized({\n message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,\n }),\n );\n }\n\n try {\n const validatedParams = getValidatedParams(params);\n\n const { ui, context } = validatedParams;\n\n res.result = messenger.call(\n 'SnapInterfaceController:createInterface',\n origin,\n ui,\n context,\n );\n } catch (error) {\n return end(error);\n }\n\n return end();\n}\n\n/**\n * Validate the createInterface method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated createInterface method parameter object.\n */\nfunction getValidatedParams(params: unknown): CreateInterfaceParameters {\n try {\n return create(params, CreateInterfaceParametersStruct);\n } catch (error) {\n if (error instanceof StructError) {\n throw rpcErrors.invalidParams({\n message: `Invalid params: ${error.message}.`,\n });\n }\n /* istanbul ignore next */\n throw rpcErrors.internal();\n }\n}\n"]}
|
|
@@ -1,22 +1,11 @@
|
|
|
1
1
|
import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
|
|
2
|
-
import type {
|
|
2
|
+
import type { Messenger } from "@metamask/messenger";
|
|
3
|
+
import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
|
|
4
|
+
import type { CreateInterfaceParams, CreateInterfaceResult } from "@metamask/snaps-sdk";
|
|
3
5
|
import { type InferMatching } from "@metamask/snaps-utils";
|
|
4
6
|
import type { PendingJsonRpcResponse } from "@metamask/utils";
|
|
5
|
-
import type {
|
|
6
|
-
export type
|
|
7
|
-
/**
|
|
8
|
-
* @param permissionName - The name of the permission to check.
|
|
9
|
-
* @returns Whether the Snap has the permission.
|
|
10
|
-
*/
|
|
11
|
-
hasPermission: (permissionName: string) => boolean;
|
|
12
|
-
/**
|
|
13
|
-
* @param ui - The UI components.
|
|
14
|
-
* @param context - An optional interface context object.
|
|
15
|
-
* @param contentType - The optional content type.
|
|
16
|
-
* @returns The unique identifier of the interface.
|
|
17
|
-
*/
|
|
18
|
-
createInterface: (ui: ComponentOrElement, context?: InterfaceContext, contentType?: ContentType) => string;
|
|
19
|
-
};
|
|
7
|
+
import type { JsonRpcRequestWithOrigin, SnapInterfaceControllerCreateInterfaceAction } from "../types.cjs";
|
|
8
|
+
export type CreateInterfaceMethodActions = PermissionControllerHasPermissionAction | SnapInterfaceControllerCreateInterfaceAction;
|
|
20
9
|
/**
|
|
21
10
|
* Create the interactive interface for use in the
|
|
22
11
|
* [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
|
|
@@ -39,9 +28,8 @@ export type CreateInterfaceMethodHooks = {
|
|
|
39
28
|
* ```
|
|
40
29
|
*/
|
|
41
30
|
export declare const createInterfaceHandler: {
|
|
42
|
-
methodNames: ["snap_createInterface"];
|
|
43
31
|
implementation: typeof getCreateInterfaceImplementation;
|
|
44
|
-
|
|
32
|
+
actionNames: ("SnapInterfaceController:createInterface" | "PermissionController:hasPermission")[];
|
|
45
33
|
};
|
|
46
34
|
declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{
|
|
47
35
|
ui: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AccountSelectorProps, "AccountSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressInputProps, "AddressInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AssetSelectorProps, "AssetSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DateTimePickerProps, "DateTimePicker"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FieldProps, "Field"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AvatarProps, "Avatar"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CollapsibleSectionProps, "CollapsibleSection"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BannerProps, "Banner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SkeletonProps, "Skeleton"> | {
|
|
@@ -90,6 +78,13 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
90
78
|
error?: string | undefined;
|
|
91
79
|
} | {
|
|
92
80
|
value: string;
|
|
81
|
+
/**
|
|
82
|
+
* Validate the createInterface method `params` and returns them cast to the correct
|
|
83
|
+
* type. Throws if validation fails.
|
|
84
|
+
*
|
|
85
|
+
* @param params - The unvalidated params object from the method request.
|
|
86
|
+
* @returns The validated createInterface method parameter object.
|
|
87
|
+
*/
|
|
93
88
|
type: import("@metamask/snaps-sdk").NodeType.Button;
|
|
94
89
|
variant?: "primary" | "secondary" | undefined;
|
|
95
90
|
name?: string | undefined;
|
|
@@ -98,13 +93,6 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
98
93
|
type: import("@metamask/snaps-sdk").NodeType.Form;
|
|
99
94
|
name: string;
|
|
100
95
|
children: ({
|
|
101
|
-
/**
|
|
102
|
-
* Validate the createInterface method `params` and returns them cast to the correct
|
|
103
|
-
* type. Throws if validation fails.
|
|
104
|
-
*
|
|
105
|
-
* @param params - The unvalidated params object from the method request.
|
|
106
|
-
* @returns The validated createInterface method parameter object.
|
|
107
|
-
*/
|
|
108
96
|
type: import("@metamask/snaps-sdk").NodeType.Input;
|
|
109
97
|
name: string;
|
|
110
98
|
value?: string | undefined;
|
|
@@ -186,6 +174,13 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
186
174
|
error?: string | undefined;
|
|
187
175
|
} | {
|
|
188
176
|
value: string;
|
|
177
|
+
/**
|
|
178
|
+
* Validate the createInterface method `params` and returns them cast to the correct
|
|
179
|
+
* type. Throws if validation fails.
|
|
180
|
+
*
|
|
181
|
+
* @param params - The unvalidated params object from the method request.
|
|
182
|
+
* @returns The validated createInterface method parameter object.
|
|
183
|
+
*/
|
|
189
184
|
type: import("@metamask/snaps-sdk").NodeType.Button;
|
|
190
185
|
variant?: "primary" | "secondary" | undefined;
|
|
191
186
|
name?: string | undefined;
|
|
@@ -194,13 +189,6 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
194
189
|
type: import("@metamask/snaps-sdk").NodeType.Form;
|
|
195
190
|
name: string;
|
|
196
191
|
children: ({
|
|
197
|
-
/**
|
|
198
|
-
* Validate the createInterface method `params` and returns them cast to the correct
|
|
199
|
-
* type. Throws if validation fails.
|
|
200
|
-
*
|
|
201
|
-
* @param params - The unvalidated params object from the method request.
|
|
202
|
-
* @returns The validated createInterface method parameter object.
|
|
203
|
-
*/
|
|
204
192
|
type: import("@metamask/snaps-sdk").NodeType.Input;
|
|
205
193
|
name: string;
|
|
206
194
|
value?: string | undefined;
|
|
@@ -245,12 +233,10 @@ export type CreateInterfaceParameters = InferMatching<typeof CreateInterfacePara
|
|
|
245
233
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
|
|
246
234
|
* function.
|
|
247
235
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
248
|
-
* @param
|
|
249
|
-
* @param
|
|
250
|
-
* permission.
|
|
251
|
-
* @param hooks.createInterface - The function to create the interface.
|
|
236
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
237
|
+
* @param messenger - The messenger used to call controller actions.
|
|
252
238
|
* @returns Nothing.
|
|
253
239
|
*/
|
|
254
|
-
declare function getCreateInterfaceImplementation(req:
|
|
240
|
+
declare function getCreateInterfaceImplementation(req: JsonRpcRequestWithOrigin<CreateInterfaceParameters>, res: PendingJsonRpcResponse<CreateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, CreateInterfaceMethodActions>): void;
|
|
255
241
|
export {};
|
|
256
242
|
//# sourceMappingURL=createInterface.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"createInterface.d.cts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EACV,wBAAwB,EACxB,4CAA4C,EAC7C,qBAAiB;AAGlB,MAAM,MAAM,4BAA4B,GACpC,uCAAuC,GACvC,4CAA4C,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB;;;CAYlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA8DrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAjED,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,wBAAwB,CAAC,yBAAyB,CAAC,EACxD,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,GACzD,IAAI,CA+BN"}
|
|
@@ -1,22 +1,11 @@
|
|
|
1
1
|
import type { JsonRpcEngineEndCallback } from "@metamask/json-rpc-engine";
|
|
2
|
-
import type {
|
|
2
|
+
import type { Messenger } from "@metamask/messenger";
|
|
3
|
+
import type { PermissionControllerHasPermissionAction } from "@metamask/permission-controller";
|
|
4
|
+
import type { CreateInterfaceParams, CreateInterfaceResult } from "@metamask/snaps-sdk";
|
|
3
5
|
import { type InferMatching } from "@metamask/snaps-utils";
|
|
4
6
|
import type { PendingJsonRpcResponse } from "@metamask/utils";
|
|
5
|
-
import type {
|
|
6
|
-
export type
|
|
7
|
-
/**
|
|
8
|
-
* @param permissionName - The name of the permission to check.
|
|
9
|
-
* @returns Whether the Snap has the permission.
|
|
10
|
-
*/
|
|
11
|
-
hasPermission: (permissionName: string) => boolean;
|
|
12
|
-
/**
|
|
13
|
-
* @param ui - The UI components.
|
|
14
|
-
* @param context - An optional interface context object.
|
|
15
|
-
* @param contentType - The optional content type.
|
|
16
|
-
* @returns The unique identifier of the interface.
|
|
17
|
-
*/
|
|
18
|
-
createInterface: (ui: ComponentOrElement, context?: InterfaceContext, contentType?: ContentType) => string;
|
|
19
|
-
};
|
|
7
|
+
import type { JsonRpcRequestWithOrigin, SnapInterfaceControllerCreateInterfaceAction } from "../types.mjs";
|
|
8
|
+
export type CreateInterfaceMethodActions = PermissionControllerHasPermissionAction | SnapInterfaceControllerCreateInterfaceAction;
|
|
20
9
|
/**
|
|
21
10
|
* Create the interactive interface for use in the
|
|
22
11
|
* [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
|
|
@@ -39,9 +28,8 @@ export type CreateInterfaceMethodHooks = {
|
|
|
39
28
|
* ```
|
|
40
29
|
*/
|
|
41
30
|
export declare const createInterfaceHandler: {
|
|
42
|
-
methodNames: ["snap_createInterface"];
|
|
43
31
|
implementation: typeof getCreateInterfaceImplementation;
|
|
44
|
-
|
|
32
|
+
actionNames: ("SnapInterfaceController:createInterface" | "PermissionController:hasPermission")[];
|
|
45
33
|
};
|
|
46
34
|
declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").Struct<{
|
|
47
35
|
ui: import("@metamask/snaps-sdk").Panel | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AccountSelectorProps, "AccountSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressInputProps, "AddressInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AssetSelectorProps, "AssetSelector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ButtonProps, "Button"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CheckboxProps, "Checkbox"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DateTimePickerProps, "DateTimePicker"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FormProps, "Form"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FieldProps, "Field"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").FileInputProps, "FileInput"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").InputProps, "Input"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").DropdownProps, "Dropdown"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SelectorProps, "Selector"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoldProps, "Bold"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ItalicProps, "Italic"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AvatarProps, "Avatar"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").AddressProps, "Address"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BoxProps, "Box"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CardProps, "Card"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").ContainerProps, "Container"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CopyableProps, "Copyable"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Divider"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").IconProps, "Icon"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").LinkProps, "Link"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").RowProps, "Row"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SectionProps, "Section"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").CollapsibleSectionProps, "CollapsibleSection"> | import("@metamask/snaps-sdk/jsx").SnapElement<Record<string, never>, "Spinner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TextProps, "Text"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").TooltipProps, "Tooltip"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").BannerProps, "Banner"> | import("@metamask/snaps-sdk/jsx").SnapElement<import("@metamask/snaps-sdk/jsx").SkeletonProps, "Skeleton"> | {
|
|
@@ -90,6 +78,13 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
90
78
|
error?: string | undefined;
|
|
91
79
|
} | {
|
|
92
80
|
value: string;
|
|
81
|
+
/**
|
|
82
|
+
* Validate the createInterface method `params` and returns them cast to the correct
|
|
83
|
+
* type. Throws if validation fails.
|
|
84
|
+
*
|
|
85
|
+
* @param params - The unvalidated params object from the method request.
|
|
86
|
+
* @returns The validated createInterface method parameter object.
|
|
87
|
+
*/
|
|
93
88
|
type: import("@metamask/snaps-sdk").NodeType.Button;
|
|
94
89
|
variant?: "primary" | "secondary" | undefined;
|
|
95
90
|
name?: string | undefined;
|
|
@@ -98,13 +93,6 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
98
93
|
type: import("@metamask/snaps-sdk").NodeType.Form;
|
|
99
94
|
name: string;
|
|
100
95
|
children: ({
|
|
101
|
-
/**
|
|
102
|
-
* Validate the createInterface method `params` and returns them cast to the correct
|
|
103
|
-
* type. Throws if validation fails.
|
|
104
|
-
*
|
|
105
|
-
* @param params - The unvalidated params object from the method request.
|
|
106
|
-
* @returns The validated createInterface method parameter object.
|
|
107
|
-
*/
|
|
108
96
|
type: import("@metamask/snaps-sdk").NodeType.Input;
|
|
109
97
|
name: string;
|
|
110
98
|
value?: string | undefined;
|
|
@@ -186,6 +174,13 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
186
174
|
error?: string | undefined;
|
|
187
175
|
} | {
|
|
188
176
|
value: string;
|
|
177
|
+
/**
|
|
178
|
+
* Validate the createInterface method `params` and returns them cast to the correct
|
|
179
|
+
* type. Throws if validation fails.
|
|
180
|
+
*
|
|
181
|
+
* @param params - The unvalidated params object from the method request.
|
|
182
|
+
* @returns The validated createInterface method parameter object.
|
|
183
|
+
*/
|
|
189
184
|
type: import("@metamask/snaps-sdk").NodeType.Button;
|
|
190
185
|
variant?: "primary" | "secondary" | undefined;
|
|
191
186
|
name?: string | undefined;
|
|
@@ -194,13 +189,6 @@ declare const CreateInterfaceParametersStruct: import("@metamask/superstruct").S
|
|
|
194
189
|
type: import("@metamask/snaps-sdk").NodeType.Form;
|
|
195
190
|
name: string;
|
|
196
191
|
children: ({
|
|
197
|
-
/**
|
|
198
|
-
* Validate the createInterface method `params` and returns them cast to the correct
|
|
199
|
-
* type. Throws if validation fails.
|
|
200
|
-
*
|
|
201
|
-
* @param params - The unvalidated params object from the method request.
|
|
202
|
-
* @returns The validated createInterface method parameter object.
|
|
203
|
-
*/
|
|
204
192
|
type: import("@metamask/snaps-sdk").NodeType.Input;
|
|
205
193
|
name: string;
|
|
206
194
|
value?: string | undefined;
|
|
@@ -245,12 +233,10 @@ export type CreateInterfaceParameters = InferMatching<typeof CreateInterfacePara
|
|
|
245
233
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
|
|
246
234
|
* function.
|
|
247
235
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
248
|
-
* @param
|
|
249
|
-
* @param
|
|
250
|
-
* permission.
|
|
251
|
-
* @param hooks.createInterface - The function to create the interface.
|
|
236
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
237
|
+
* @param messenger - The messenger used to call controller actions.
|
|
252
238
|
* @returns Nothing.
|
|
253
239
|
*/
|
|
254
|
-
declare function getCreateInterfaceImplementation(req:
|
|
240
|
+
declare function getCreateInterfaceImplementation(req: JsonRpcRequestWithOrigin<CreateInterfaceParameters>, res: PendingJsonRpcResponse<CreateInterfaceResult>, _next: unknown, end: JsonRpcEngineEndCallback, _hooks: never, messenger: Messenger<string, CreateInterfaceMethodActions>): void;
|
|
255
241
|
export {};
|
|
256
242
|
//# sourceMappingURL=createInterface.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createInterface.d.mts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"createInterface.d.mts","sourceRoot":"","sources":["../../src/permitted/createInterface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EAEzB,kCAAkC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,uCAAuC,EAAE,wCAAwC;AAE/F,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACtB,4BAA4B;AAK7B,OAAO,EAAE,KAAK,aAAa,EAAE,8BAA8B;AAE3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,wBAAwB;AAE9D,OAAO,KAAK,EACV,wBAAwB,EACxB,4CAA4C,EAC7C,qBAAiB;AAGlB,MAAM,MAAM,4BAA4B,GACpC,uCAAuC,GACvC,4CAA4C,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB;;;CAYlC,CAAC;AAEF,QAAA,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA8DrC;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QANH;;;;;;WAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAjED,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,aAAa,CACnD,OAAO,+BAA+B,EACtC,qBAAqB,CACtB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,iBAAS,gCAAgC,CACvC,GAAG,EAAE,wBAAwB,CAAC,yBAAyB,CAAC,EACxD,GAAG,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,EAClD,KAAK,EAAE,OAAO,EACd,GAAG,EAAE,wBAAwB,EAC7B,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,GACzD,IAAI,CA+BN"}
|
|
@@ -2,11 +2,6 @@ import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
|
|
|
2
2
|
import { ComponentOrElementStruct, InterfaceContextStruct } from "@metamask/snaps-sdk";
|
|
3
3
|
import { StructError, create, object, optional } from "@metamask/superstruct";
|
|
4
4
|
import { UI_PERMISSIONS } from "../utils.mjs";
|
|
5
|
-
const methodName = 'snap_createInterface';
|
|
6
|
-
const hookNames = {
|
|
7
|
-
hasPermission: true,
|
|
8
|
-
createInterface: true,
|
|
9
|
-
};
|
|
10
5
|
/**
|
|
11
6
|
* Create the interactive interface for use in the
|
|
12
7
|
* [interactive UI](https://docs.metamask.io/snaps/features/custom-ui/interactive-ui/).
|
|
@@ -29,9 +24,11 @@ const hookNames = {
|
|
|
29
24
|
* ```
|
|
30
25
|
*/
|
|
31
26
|
export const createInterfaceHandler = {
|
|
32
|
-
methodNames: [methodName],
|
|
33
27
|
implementation: getCreateInterfaceImplementation,
|
|
34
|
-
|
|
28
|
+
actionNames: [
|
|
29
|
+
'PermissionController:hasPermission',
|
|
30
|
+
'SnapInterfaceController:createInterface',
|
|
31
|
+
],
|
|
35
32
|
};
|
|
36
33
|
const CreateInterfaceParametersStruct = object({
|
|
37
34
|
ui: ComponentOrElementStruct,
|
|
@@ -45,23 +42,22 @@ const CreateInterfaceParametersStruct = object({
|
|
|
45
42
|
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
|
|
46
43
|
* function.
|
|
47
44
|
* @param end - The `json-rpc-engine` "end" callback.
|
|
48
|
-
* @param
|
|
49
|
-
* @param
|
|
50
|
-
* permission.
|
|
51
|
-
* @param hooks.createInterface - The function to create the interface.
|
|
45
|
+
* @param _hooks - The RPC method hooks. Not used by this function.
|
|
46
|
+
* @param messenger - The messenger used to call controller actions.
|
|
52
47
|
* @returns Nothing.
|
|
53
48
|
*/
|
|
54
|
-
function getCreateInterfaceImplementation(req, res, _next, end,
|
|
55
|
-
|
|
49
|
+
function getCreateInterfaceImplementation(req, res, _next, end, _hooks, messenger) {
|
|
50
|
+
const { params, origin } = req;
|
|
51
|
+
const isPermitted = UI_PERMISSIONS.some((permission) => messenger.call('PermissionController:hasPermission', origin, permission));
|
|
52
|
+
if (!isPermitted) {
|
|
56
53
|
return end(providerErrors.unauthorized({
|
|
57
54
|
message: `This method can only be used if the Snap has one of the following permissions: ${UI_PERMISSIONS.join(', ')}.`,
|
|
58
55
|
}));
|
|
59
56
|
}
|
|
60
|
-
const { params } = req;
|
|
61
57
|
try {
|
|
62
58
|
const validatedParams = getValidatedParams(params);
|
|
63
59
|
const { ui, context } = validatedParams;
|
|
64
|
-
res.result = createInterface
|
|
60
|
+
res.result = messenger.call('SnapInterfaceController:createInterface', origin, ui, context);
|
|
65
61
|
}
|
|
66
62
|
catch (error) {
|
|
67
63
|
return end(error);
|