@metamask/snaps-execution-environments 6.6.2 → 6.7.0

package/dist/{types/common/validation.d.ts → common/validation.d.cts}

@@ -1,6 +1,6 @@
-import { HandlerType } from '@metamask/snaps-utils';
-import type { Infer } from '@metamask/superstruct';
-import type { Json, JsonRpcSuccess } from '@metamask/utils';
+import { HandlerType } from "@metamask/snaps-utils";
+import type { Infer } from "@metamask/superstruct";
+import type { Json, JsonRpcSuccess } from "@metamask/utils";
 export declare const JsonRpcRequestWithoutIdStruct: import("@metamask/superstruct").Struct<{
     method: string;
     id?: string | number | null | undefined;
@@ -12,9 +12,9 @@ export declare const JsonRpcRequestWithoutIdStruct: import("@metamask/superstruc
     method: import("@metamask/superstruct").Struct<string, null>;
     params: import("@metamask/superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
 }>;
-export declare type JsonRpcRequestWithoutId = Infer<typeof JsonRpcRequestWithoutIdStruct>;
+export type JsonRpcRequestWithoutId = Infer<typeof JsonRpcRequestWithoutIdStruct>;
 export declare const EndowmentStruct: import("@metamask/superstruct").Struct<string, null>;
-export declare type Endowment = Infer<typeof EndowmentStruct>;
+export type Endowment = Infer<typeof EndowmentStruct>;
 /**
  * Check if the given value is an endowment.
  *
@@ -38,21 +38,21 @@ export declare const SnapRpcRequestArgumentsStruct: import("@metamask/superstruc
     jsonrpc?: "2.0" | undefined;
     params?: Record<string, Json> | undefined;
 }], null>;
-export declare type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;
-export declare type TerminateRequestArguments = Infer<typeof TerminateRequestArgumentsStruct>;
-export declare type ExecuteSnapRequestArguments = Infer<typeof ExecuteSnapRequestArgumentsStruct>;
-export declare type SnapRpcRequestArguments = Infer<typeof SnapRpcRequestArgumentsStruct>;
-export declare type RequestArguments = PingRequestArguments | TerminateRequestArguments | ExecuteSnapRequestArguments | SnapRpcRequestArguments;
+export type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;
+export type TerminateRequestArguments = Infer<typeof TerminateRequestArgumentsStruct>;
+export type ExecuteSnapRequestArguments = Infer<typeof ExecuteSnapRequestArgumentsStruct>;
+export type SnapRpcRequestArguments = Infer<typeof SnapRpcRequestArgumentsStruct>;
+export type RequestArguments = PingRequestArguments | TerminateRequestArguments | ExecuteSnapRequestArguments | SnapRpcRequestArguments;
 export declare const OnTransactionRequestArgumentsStruct: import("@metamask/superstruct").Struct<{
     chainId: `${string}:${string}`;
-    transaction: Record<string, Json>;
     transactionOrigin: string | null;
+    transaction: Record<string, Json>;
 }, {
     transaction: import("@metamask/superstruct").Struct<Record<string, Json>, null>;
     chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
     transactionOrigin: import("@metamask/superstruct").Struct<string | null, null>;
 }>;
-export declare type OnTransactionRequestArguments = Infer<typeof OnTransactionRequestArgumentsStruct>;
+export type OnTransactionRequestArguments = Infer<typeof OnTransactionRequestArgumentsStruct>;
 /**
  * Asserts that the given value is a valid {@link OnTransactionRequestArguments}
  * object.
@@ -63,13 +63,13 @@ export declare type OnTransactionRequestArguments = Infer<typeof OnTransactionRe
  */
 export declare function assertIsOnTransactionRequestArguments(value: unknown): asserts value is OnTransactionRequestArguments;
 export declare const OnSignatureRequestArgumentsStruct: import("@metamask/superstruct").Struct<{
-    signature: Record<string, Json>;
     signatureOrigin: string | null;
+    signature: Record<string, Json>;
 }, {
     signature: import("@metamask/superstruct").Struct<Record<string, Json>, null>;
     signatureOrigin: import("@metamask/superstruct").Struct<string | null, null>;
 }>;
-export declare type OnSignatureRequestArguments = Infer<typeof OnSignatureRequestArgumentsStruct>;
+export type OnSignatureRequestArguments = Infer<typeof OnSignatureRequestArgumentsStruct>;
 /**
  * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
  * object.
@@ -83,14 +83,14 @@ declare const baseNameLookupArgs: {
     chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
 };
 export declare const OnNameLookupRequestArgumentsStruct: import("@metamask/superstruct").Struct<{
-    chainId: `${string}:${string}`;
     address: string;
+    chainId: `${string}:${string}`;
 } | {
     chainId: `${string}:${string}`;
     domain: string;
 }, null>;
-export declare type OnNameLookupRequestArguments = Infer<typeof OnNameLookupRequestArgumentsStruct>;
-export declare type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {
+export type OnNameLookupRequestArguments = Infer<typeof OnNameLookupRequestArgumentsStruct>;
+export type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {
     address?: string;
     domain?: string;
 };
@@ -109,27 +109,27 @@ export declare const OnUserInputArgumentsStruct: import("@metamask/superstruct")
         type: import("@metamask/snaps-sdk").UserInputEventType.ButtonClickEvent;
         name?: string | undefined;
     } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
+        name: string;
         value: Record<string, string | boolean | {
             name: string;
             size: number;
             contentType: string;
             contents: string;
         } | null>;
-        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
-        name: string;
     } | {
-        value: string | boolean;
         type: import("@metamask/snaps-sdk").UserInputEventType.InputChangeEvent;
         name: string;
+        value: string | boolean;
     } | {
         type: import("@metamask/snaps-sdk").UserInputEventType.FileUploadEvent;
-        name: string;
         file: {
             name: string;
             size: number;
             contentType: string;
             contents: string;
         } | null;
+        name: string;
     };
     context?: Record<string, Json> | null | undefined;
 }, {
@@ -138,31 +138,31 @@ export declare const OnUserInputArgumentsStruct: import("@metamask/superstruct")
         type: import("@metamask/snaps-sdk").UserInputEventType.ButtonClickEvent;
         name?: string | undefined;
     } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
+        name: string;
         value: Record<string, string | boolean | {
             name: string;
             size: number;
             contentType: string;
             contents: string;
         } | null>;
-        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
-        name: string;
     } | {
-        value: string | boolean;
         type: import("@metamask/snaps-sdk").UserInputEventType.InputChangeEvent;
         name: string;
+        value: string | boolean;
     } | {
         type: import("@metamask/snaps-sdk").UserInputEventType.FileUploadEvent;
-        name: string;
         file: {
             name: string;
             size: number;
             contentType: string;
             contents: string;
         } | null;
+        name: string;
     }, null>;
     context: import("@metamask/superstruct").Struct<Record<string, Json> | null | undefined, null>;
 }>;
-export declare type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStruct>;
+export type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStruct>;
 /**
  * Asserts that the given value is a valid {@link OnUserInputArguments}
  * object.
@@ -173,8 +173,8 @@ export declare type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStru
  */
 export declare function assertIsOnUserInputRequestArguments(value: unknown): asserts value is OnUserInputArguments;
 declare const OkResponseStruct: import("@metamask/superstruct").Struct<{
-    result: "OK";
     id: string | number | null;
+    result: "OK";
     jsonrpc: "2.0";
 }, {
     id: import("@metamask/superstruct").Struct<string | number | null, null>;
@@ -186,13 +186,14 @@ declare const SnapRpcResponse: import("@metamask/superstruct").Struct<{
     jsonrpc: "2.0";
     result: Json;
 }, unknown>;
-export declare type OkResponse = Infer<typeof OkResponseStruct>;
-export declare type SnapRpcResponse = Infer<typeof SnapRpcResponse>;
-export declare type Response = OkResponse | SnapRpcResponse;
-declare type RequestParams<Params extends unknown[] | undefined> = Params extends undefined ? [] : Params;
-declare type RequestFunction<Args extends RequestArguments, ResponseType extends JsonRpcSuccess<Json>> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;
-export declare type Ping = RequestFunction<PingRequestArguments, OkResponse>;
-export declare type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;
-export declare type ExecuteSnap = RequestFunction<ExecuteSnapRequestArguments, OkResponse>;
-export declare type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;
+export type OkResponse = Infer<typeof OkResponseStruct>;
+export type SnapRpcResponse = Infer<typeof SnapRpcResponse>;
+export type Response = OkResponse | SnapRpcResponse;
+type RequestParams<Params extends unknown[] | undefined> = Params extends undefined ? [] : Params;
+type RequestFunction<Args extends RequestArguments, ResponseType extends JsonRpcSuccess<Json>> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;
+export type Ping = RequestFunction<PingRequestArguments, OkResponse>;
+export type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;
+export type ExecuteSnap = RequestFunction<ExecuteSnapRequestArguments, OkResponse>;
+export type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;
 export {};
+//# sourceMappingURL=validation.d.cts.map

package/dist/common/validation.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.cts","sourceRoot":"","sources":["../../src/common/validation.ts"],"names":[],"mappings":"AAKA,OAAO,EAAiB,WAAW,EAAE,8BAA8B;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAenD,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAU5D,eAAO,MAAM,6BAA6B;;;;;;;;;;EAKxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF,eAAO,MAAM,eAAe,sDAAW,CAAC;AACxC,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAEtD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,EAAE,CAEtE;AAID,eAAO,MAAM,0BAA0B,qEAEtC,CAAC;AAEF,eAAO,MAAM,+BAA+B,qEAG1C,CAAC;AAEH,eAAO,MAAM,iCAAiC,0EAI5C,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;SAUxC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC5E,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAC3C,OAAO,+BAA+B,CACvC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,oBAAoB,GACpB,yBAAyB,GACzB,2BAA2B,GAC3B,uBAAuB,CAAC;AAE5B,eAAO,MAAM,mCAAmC;;;;;;;;EAK9C,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAC/C,OAAO,mCAAmC,CAC3C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,qCAAqC,CACnD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,6BAA6B,CAOhD;AAED,eAAO,MAAM,iCAAiC;;;;;;EAG5C,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,2BAA2B,CAO9C;AAED,QAAA,MAAM,kBAAkB;;CAA6B,CAAC;AAUtD,eAAO,MAAM,kCAAkC;;;;;;QAG7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,OAAO,kBAAkB,GAAG;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,oCAAoC,CAClD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,4BAA4B,CAO/C;AAED,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE5E;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,oBAAoB,CAOvC;AAED,QAAA,MAAM,gBAAgB;;;;;;;;EAIpB,CAAC;AAEH,QAAA,MAAM,eAAe;;;;WAAuB,CAAC;AAE7C,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AACxD,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE5D,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,eAAe,CAAC;AAEpD,KAAK,aAAa,CAAC,MAAM,SAAS,OAAO,EAAE,GAAG,SAAS,IACrD,MAAM,SAAS,SAAS,GAAG,EAAE,GAAG,MAAM,CAAC;AAEzC,KAAK,eAAe,CAClB,IAAI,SAAS,gBAAgB,EAC7B,YAAY,SAAS,cAAc,CAAC,IAAI,CAAC,IACvC,CAAC,GAAG,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEtE,MAAM,MAAM,IAAI,GAAG,eAAe,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;AACrE,MAAM,MAAM,SAAS,GAAG,eAAe,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC;AAC/E,MAAM,MAAM,WAAW,GAAG,eAAe,CACvC,2BAA2B,EAC3B,UAAU,CACX,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC,uBAAuB,EAAE,eAAe,CAAC,CAAC"}

package/dist/common/validation.d.mts

@@ -0,0 +1,199 @@
+import { HandlerType } from "@metamask/snaps-utils";
+import type { Infer } from "@metamask/superstruct";
+import type { Json, JsonRpcSuccess } from "@metamask/utils";
+export declare const JsonRpcRequestWithoutIdStruct: import("@metamask/superstruct").Struct<{
+    method: string;
+    id?: string | number | null | undefined;
+    jsonrpc?: "2.0" | undefined;
+    params?: Record<string, Json> | Json[] | undefined;
+}, {
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0" | undefined, "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null | undefined, null>;
+    method: import("@metamask/superstruct").Struct<string, null>;
+    params: import("@metamask/superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
+}>;
+export type JsonRpcRequestWithoutId = Infer<typeof JsonRpcRequestWithoutIdStruct>;
+export declare const EndowmentStruct: import("@metamask/superstruct").Struct<string, null>;
+export type Endowment = Infer<typeof EndowmentStruct>;
+/**
+ * Check if the given value is an endowment.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an endowment.
+ */
+export declare function isEndowment(value: unknown): value is Endowment;
+/**
+ * Check if the given value is an array of endowments.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an array of endowments.
+ */
+export declare function isEndowmentsArray(value: unknown): value is Endowment[];
+export declare const PingRequestArgumentsStruct: import("@metamask/superstruct").Struct<unknown[] | undefined, null>;
+export declare const TerminateRequestArgumentsStruct: import("@metamask/superstruct").Struct<unknown[] | undefined, null>;
+export declare const ExecuteSnapRequestArgumentsStruct: import("@metamask/superstruct").Struct<[string, string, string[]], null>;
+export declare const SnapRpcRequestArgumentsStruct: import("@metamask/superstruct").Struct<[string, HandlerType, string, {
+    method: string;
+    id?: string | number | null | undefined;
+    jsonrpc?: "2.0" | undefined;
+    params?: Record<string, Json> | undefined;
+}], null>;
+export type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;
+export type TerminateRequestArguments = Infer<typeof TerminateRequestArgumentsStruct>;
+export type ExecuteSnapRequestArguments = Infer<typeof ExecuteSnapRequestArgumentsStruct>;
+export type SnapRpcRequestArguments = Infer<typeof SnapRpcRequestArgumentsStruct>;
+export type RequestArguments = PingRequestArguments | TerminateRequestArguments | ExecuteSnapRequestArguments | SnapRpcRequestArguments;
+export declare const OnTransactionRequestArgumentsStruct: import("@metamask/superstruct").Struct<{
+    chainId: `${string}:${string}`;
+    transactionOrigin: string | null;
+    transaction: Record<string, Json>;
+}, {
+    transaction: import("@metamask/superstruct").Struct<Record<string, Json>, null>;
+    chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+    transactionOrigin: import("@metamask/superstruct").Struct<string | null, null>;
+}>;
+export type OnTransactionRequestArguments = Infer<typeof OnTransactionRequestArgumentsStruct>;
+/**
+ * Asserts that the given value is a valid {@link OnTransactionRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnTransactionRequestArguments}
+ * object.
+ */
+export declare function assertIsOnTransactionRequestArguments(value: unknown): asserts value is OnTransactionRequestArguments;
+export declare const OnSignatureRequestArgumentsStruct: import("@metamask/superstruct").Struct<{
+    signatureOrigin: string | null;
+    signature: Record<string, Json>;
+}, {
+    signature: import("@metamask/superstruct").Struct<Record<string, Json>, null>;
+    signatureOrigin: import("@metamask/superstruct").Struct<string | null, null>;
+}>;
+export type OnSignatureRequestArguments = Infer<typeof OnSignatureRequestArgumentsStruct>;
+/**
+ * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnSignatureRequestArguments}
+ * object.
+ */
+export declare function assertIsOnSignatureRequestArguments(value: unknown): asserts value is OnSignatureRequestArguments;
+declare const baseNameLookupArgs: {
+    chainId: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+};
+export declare const OnNameLookupRequestArgumentsStruct: import("@metamask/superstruct").Struct<{
+    address: string;
+    chainId: `${string}:${string}`;
+} | {
+    chainId: `${string}:${string}`;
+    domain: string;
+}, null>;
+export type OnNameLookupRequestArguments = Infer<typeof OnNameLookupRequestArgumentsStruct>;
+export type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {
+    address?: string;
+    domain?: string;
+};
+/**
+ * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnNameLookupRequestArguments}
+ * object.
+ */
+export declare function assertIsOnNameLookupRequestArguments(value: unknown): asserts value is OnNameLookupRequestArguments;
+export declare const OnUserInputArgumentsStruct: import("@metamask/superstruct").Struct<{
+    id: string;
+    event: {
+        type: import("@metamask/snaps-sdk").UserInputEventType.ButtonClickEvent;
+        name?: string | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
+        name: string;
+        value: Record<string, string | boolean | {
+            name: string;
+            size: number;
+            contentType: string;
+            contents: string;
+        } | null>;
+    } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.InputChangeEvent;
+        name: string;
+        value: string | boolean;
+    } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.FileUploadEvent;
+        file: {
+            name: string;
+            size: number;
+            contentType: string;
+            contents: string;
+        } | null;
+        name: string;
+    };
+    context?: Record<string, Json> | null | undefined;
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    event: import("@metamask/superstruct").Struct<{
+        type: import("@metamask/snaps-sdk").UserInputEventType.ButtonClickEvent;
+        name?: string | undefined;
+    } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.FormSubmitEvent;
+        name: string;
+        value: Record<string, string | boolean | {
+            name: string;
+            size: number;
+            contentType: string;
+            contents: string;
+        } | null>;
+    } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.InputChangeEvent;
+        name: string;
+        value: string | boolean;
+    } | {
+        type: import("@metamask/snaps-sdk").UserInputEventType.FileUploadEvent;
+        file: {
+            name: string;
+            size: number;
+            contentType: string;
+            contents: string;
+        } | null;
+        name: string;
+    }, null>;
+    context: import("@metamask/superstruct").Struct<Record<string, Json> | null | undefined, null>;
+}>;
+export type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStruct>;
+/**
+ * Asserts that the given value is a valid {@link OnUserInputArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnUserInputArguments}
+ * object.
+ */
+export declare function assertIsOnUserInputRequestArguments(value: unknown): asserts value is OnUserInputArguments;
+declare const OkResponseStruct: import("@metamask/superstruct").Struct<{
+    id: string | number | null;
+    result: "OK";
+    jsonrpc: "2.0";
+}, {
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    result: import("@metamask/superstruct").Struct<"OK", "OK">;
+}>;
+declare const SnapRpcResponse: import("@metamask/superstruct").Struct<{
+    id: string | number | null;
+    jsonrpc: "2.0";
+    result: Json;
+}, unknown>;
+export type OkResponse = Infer<typeof OkResponseStruct>;
+export type SnapRpcResponse = Infer<typeof SnapRpcResponse>;
+export type Response = OkResponse | SnapRpcResponse;
+type RequestParams<Params extends unknown[] | undefined> = Params extends undefined ? [] : Params;
+type RequestFunction<Args extends RequestArguments, ResponseType extends JsonRpcSuccess<Json>> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;
+export type Ping = RequestFunction<PingRequestArguments, OkResponse>;
+export type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;
+export type ExecuteSnap = RequestFunction<ExecuteSnapRequestArguments, OkResponse>;
+export type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;
+export {};
+//# sourceMappingURL=validation.d.mts.map

package/dist/common/validation.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.mts","sourceRoot":"","sources":["../../src/common/validation.ts"],"names":[],"mappings":"AAKA,OAAO,EAAiB,WAAW,EAAE,8BAA8B;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAenD,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,wBAAwB;AAU5D,eAAO,MAAM,6BAA6B;;;;;;;;;;EAKxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF,eAAO,MAAM,eAAe,sDAAW,CAAC;AACxC,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAEtD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,EAAE,CAEtE;AAID,eAAO,MAAM,0BAA0B,qEAEtC,CAAC;AAEF,eAAO,MAAM,+BAA+B,qEAG1C,CAAC;AAEH,eAAO,MAAM,iCAAiC,0EAI5C,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;SAUxC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC5E,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAC3C,OAAO,+BAA+B,CACvC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,oBAAoB,GACpB,yBAAyB,GACzB,2BAA2B,GAC3B,uBAAuB,CAAC;AAE5B,eAAO,MAAM,mCAAmC;;;;;;;;EAK9C,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAC/C,OAAO,mCAAmC,CAC3C,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,qCAAqC,CACnD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,6BAA6B,CAOhD;AAED,eAAO,MAAM,iCAAiC;;;;;;EAG5C,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAC7C,OAAO,iCAAiC,CACzC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,2BAA2B,CAO9C;AAED,QAAA,MAAM,kBAAkB;;CAA6B,CAAC;AAUtD,eAAO,MAAM,kCAAkC;;;;;;QAG7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAC9C,OAAO,kCAAkC,CAC1C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,OAAO,kBAAkB,GAAG;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,oCAAoC,CAClD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,4BAA4B,CAO/C;AAED,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE5E;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,oBAAoB,CAOvC;AAED,QAAA,MAAM,gBAAgB;;;;;;;;EAIpB,CAAC;AAEH,QAAA,MAAM,eAAe;;;;WAAuB,CAAC;AAE7C,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AACxD,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE5D,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,eAAe,CAAC;AAEpD,KAAK,aAAa,CAAC,MAAM,SAAS,OAAO,EAAE,GAAG,SAAS,IACrD,MAAM,SAAS,SAAS,GAAG,EAAE,GAAG,MAAM,CAAC;AAEzC,KAAK,eAAe,CAClB,IAAI,SAAS,gBAAgB,EAC7B,YAAY,SAAS,cAAc,CAAC,IAAI,CAAC,IACvC,CAAC,GAAG,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEtE,MAAM,MAAM,IAAI,GAAG,eAAe,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;AACrE,MAAM,MAAM,SAAS,GAAG,eAAe,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC;AAC/E,MAAM,MAAM,WAAW,GAAG,eAAe,CACvC,2BAA2B,EAC3B,UAAU,CACX,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC,uBAAuB,EAAE,eAAe,CAAC,CAAC"}

package/dist/common/validation.mjs

@@ -1,38 +1,128 @@
-import {
-  EndowmentStruct,
-  ExecuteSnapRequestArgumentsStruct,
-  JsonRpcRequestWithoutIdStruct,
-  OnNameLookupRequestArgumentsStruct,
-  OnSignatureRequestArgumentsStruct,
-  OnTransactionRequestArgumentsStruct,
-  OnUserInputArgumentsStruct,
-  PingRequestArgumentsStruct,
-  SnapRpcRequestArgumentsStruct,
-  TerminateRequestArgumentsStruct,
-  assertIsOnNameLookupRequestArguments,
-  assertIsOnSignatureRequestArguments,
-  assertIsOnTransactionRequestArguments,
-  assertIsOnUserInputRequestArguments,
-  isEndowment,
-  isEndowmentsArray
-} from "../chunk-75RCH4ZX.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  EndowmentStruct,
-  ExecuteSnapRequestArgumentsStruct,
-  JsonRpcRequestWithoutIdStruct,
-  OnNameLookupRequestArgumentsStruct,
-  OnSignatureRequestArgumentsStruct,
-  OnTransactionRequestArgumentsStruct,
-  OnUserInputArgumentsStruct,
-  PingRequestArgumentsStruct,
-  SnapRpcRequestArgumentsStruct,
-  TerminateRequestArgumentsStruct,
-  assertIsOnNameLookupRequestArguments,
-  assertIsOnSignatureRequestArguments,
-  assertIsOnTransactionRequestArguments,
-  assertIsOnUserInputRequestArguments,
-  isEndowment,
-  isEndowmentsArray
-};
+import { rpcErrors } from "@metamask/rpc-errors";
+import { InterfaceContextStruct, UserInputEventStruct } from "@metamask/snaps-sdk";
+import { ChainIdStruct, HandlerType } from "@metamask/snaps-utils";
+import { array, assign, enums, is, literal, nullable, object, optional, record, string, tuple, union } from "@metamask/superstruct";
+import { assertStruct, JsonRpcIdStruct, JsonRpcParamsStruct, JsonRpcSuccessStruct, JsonRpcVersionStruct, JsonStruct } from "@metamask/utils";
+export const JsonRpcRequestWithoutIdStruct = object({
+    jsonrpc: optional(JsonRpcVersionStruct),
+    id: optional(JsonRpcIdStruct),
+    method: string(),
+    params: optional(JsonRpcParamsStruct),
+});
+export const EndowmentStruct = string();
+/**
+ * Check if the given value is an endowment.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an endowment.
+ */
+export function isEndowment(value) {
+    return is(value, EndowmentStruct);
+}
+/**
+ * Check if the given value is an array of endowments.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an array of endowments.
+ */
+export function isEndowmentsArray(value) {
+    return Array.isArray(value) && value.every(isEndowment);
+}
+const OkStruct = literal('OK');
+export const PingRequestArgumentsStruct = optional(union([literal(undefined), array()]));
+export const TerminateRequestArgumentsStruct = union([
+    literal(undefined),
+    array(),
+]);
+export const ExecuteSnapRequestArgumentsStruct = tuple([
+    string(),
+    string(),
+    array(EndowmentStruct),
+]);
+export const SnapRpcRequestArgumentsStruct = tuple([
+    string(),
+    enums(Object.values(HandlerType)),
+    string(),
+    assign(JsonRpcRequestWithoutIdStruct, object({
+        params: optional(record(string(), JsonStruct)),
+    })),
+]);
+export const OnTransactionRequestArgumentsStruct = object({
+    // TODO: Improve `transaction` type.
+    transaction: record(string(), JsonStruct),
+    chainId: ChainIdStruct,
+    transactionOrigin: nullable(string()),
+});
+/**
+ * Asserts that the given value is a valid {@link OnTransactionRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnTransactionRequestArguments}
+ * object.
+ */
+export function assertIsOnTransactionRequestArguments(value) {
+    assertStruct(value, OnTransactionRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
+}
+export const OnSignatureRequestArgumentsStruct = object({
+    signature: record(string(), JsonStruct),
+    signatureOrigin: nullable(string()),
+});
+/**
+ * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnSignatureRequestArguments}
+ * object.
+ */
+export function assertIsOnSignatureRequestArguments(value) {
+    assertStruct(value, OnSignatureRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
+}
+const baseNameLookupArgs = { chainId: ChainIdStruct };
+const domainRequestStruct = object({
+    ...baseNameLookupArgs,
+    address: string(),
+});
+const addressRequestStruct = object({
+    ...baseNameLookupArgs,
+    domain: string(),
+});
+export const OnNameLookupRequestArgumentsStruct = union([
+    domainRequestStruct,
+    addressRequestStruct,
+]);
+/**
+ * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnNameLookupRequestArguments}
+ * object.
+ */
+export function assertIsOnNameLookupRequestArguments(value) {
+    assertStruct(value, OnNameLookupRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
+}
+export const OnUserInputArgumentsStruct = object({
+    id: string(),
+    event: UserInputEventStruct,
+    context: optional(nullable(InterfaceContextStruct)),
+});
+/**
+ * Asserts that the given value is a valid {@link OnUserInputArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnUserInputArguments}
+ * object.
+ */
+export function assertIsOnUserInputRequestArguments(value) {
+    assertStruct(value, OnUserInputArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
+}
+const OkResponseStruct = object({
+    id: JsonRpcIdStruct,
+    jsonrpc: JsonRpcVersionStruct,
+    result: OkStruct,
+});
+const SnapRpcResponse = JsonRpcSuccessStruct;
 //# sourceMappingURL=validation.mjs.map

package/dist/common/validation.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"validation.mjs","sourceRoot":"","sources":["../../src/common/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACrB,4BAA4B;AAC7B,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA8B;AAEnE,OAAO,EACL,KAAK,EACL,MAAM,EACN,KAAK,EACL,EAAE,EACF,OAAO,EACP,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,KAAK,EACL,KAAK,EACN,8BAA8B;AAE/B,OAAO,EACL,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,UAAU,EACX,wBAAwB;AAEzB,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC;IAClD,OAAO,EAAE,QAAQ,CAAC,oBAAoB,CAAC;IACvC,EAAE,EAAE,QAAQ,CAAC,eAAe,CAAC;IAC7B,MAAM,EAAE,MAAM,EAAE;IAChB,MAAM,EAAE,QAAQ,CAAC,mBAAmB,CAAC;CACtC,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC;AAGxC;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,OAAO,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE/B,MAAM,CAAC,MAAM,0BAA0B,GAAG,QAAQ,CAChD,KAAK,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CACrC,CAAC;AAEF,MAAM,CAAC,MAAM,+BAA+B,GAAG,KAAK,CAAC;IACnD,OAAO,CAAC,SAAS,CAAC;IAClB,KAAK,EAAE;CACR,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iCAAiC,GAAG,KAAK,CAAC;IACrD,MAAM,EAAE;IACR,MAAM,EAAE;IACR,KAAK,CAAC,eAAe,CAAC;CACvB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,CAAC;IACjD,MAAM,EAAE;IACR,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACjC,MAAM,EAAE;IACR,MAAM,CACJ,6BAA6B,EAC7B,MAAM,CAAC;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;KAC/C,CAAC,CACH;CACF,CAAC,CAAC;AAqBH,MAAM,CAAC,MAAM,mCAAmC,GAAG,MAAM,CAAC;IACxD,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC;IACzC,OAAO,EAAE,aAAa;IACtB,iBAAiB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACtC,CAAC,CAAC;AAMH;;;;;;;GAOG;AACH,MAAM,UAAU,qCAAqC,CACnD,KAAc;IAEd,YAAY,CACV,KAAK,EACL,mCAAmC,EACnC,wBAAwB,EACxB,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,iCAAiC,GAAG,MAAM,CAAC;IACtD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC;IACvC,eAAe,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACpC,CAAC,CAAC;AAMH;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CACjD,KAAc;IAEd,YAAY,CACV,KAAK,EACL,iCAAiC,EACjC,wBAAwB,EACxB,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED,MAAM,kBAAkB,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;AACtD,MAAM,mBAAmB,GAAG,MAAM,CAAC;IACjC,GAAG,kBAAkB;IACrB,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC,CAAC;AACH,MAAM,oBAAoB,GAAG,MAAM,CAAC;IAClC,GAAG,kBAAkB;IACrB,MAAM,EAAE,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kCAAkC,GAAG,KAAK,CAAC;IACtD,mBAAmB;IACnB,oBAAoB;CACrB,CAAC,CAAC;AAWH;;;;;;;GAOG;AACH,MAAM,UAAU,oCAAoC,CAClD,KAAc;IAEd,YAAY,CACV,KAAK,EACL,kCAAkC,EAClC,wBAAwB,EACxB,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;IAC/C,EAAE,EAAE,MAAM,EAAE;IACZ,KAAK,EAAE,oBAAoB;IAC3B,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;CACpD,CAAC,CAAC;AAIH;;;;;;;GAOG;AACH,MAAM,UAAU,mCAAmC,CACjD,KAAc;IAEd,YAAY,CACV,KAAK,EACL,0BAA0B,EAC1B,wBAAwB,EACxB,SAAS,CAAC,aAAa,CACxB,CAAC;AACJ,CAAC;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;IAC9B,EAAE,EAAE,eAAe;IACnB,OAAO,EAAE,oBAAoB;IAC7B,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,oBAAoB,CAAC","sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  InterfaceContextStruct,\n  UserInputEventStruct,\n} from '@metamask/snaps-sdk';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  array,\n  assign,\n  enums,\n  is,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  tuple,\n  union,\n} from '@metamask/superstruct';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n  assertStruct,\n  JsonRpcIdStruct,\n  JsonRpcParamsStruct,\n  JsonRpcSuccessStruct,\n  JsonRpcVersionStruct,\n  JsonStruct,\n} from '@metamask/utils';\n\nexport const JsonRpcRequestWithoutIdStruct = object({\n  jsonrpc: optional(JsonRpcVersionStruct),\n  id: optional(JsonRpcIdStruct),\n  method: string(),\n  params: optional(JsonRpcParamsStruct),\n});\n\nexport type JsonRpcRequestWithoutId = Infer<\n  typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n  return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n  return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n  union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n  literal(undefined),\n  array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n  string(),\n  string(),\n  array(EndowmentStruct),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n  string(),\n  enums(Object.values(HandlerType)),\n  string(),\n  assign(\n    JsonRpcRequestWithoutIdStruct,\n    object({\n      params: optional(record(string(), JsonStruct)),\n    }),\n  ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n  typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n  typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n  typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n  | PingRequestArguments\n  | TerminateRequestArguments\n  | ExecuteSnapRequestArguments\n  | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n  // TODO: Improve `transaction` type.\n  transaction: record(string(), JsonStruct),\n  chainId: ChainIdStruct,\n  transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n  typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n  value: unknown,\n): asserts value is OnTransactionRequestArguments {\n  assertStruct(\n    value,\n    OnTransactionRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const OnSignatureRequestArgumentsStruct = object({\n  signature: record(string(), JsonStruct),\n  signatureOrigin: nullable(string()),\n});\n\nexport type OnSignatureRequestArguments = Infer<\n  typeof OnSignatureRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnSignatureRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnSignatureRequestArguments}\n * object.\n */\nexport function assertIsOnSignatureRequestArguments(\n  value: unknown,\n): asserts value is OnSignatureRequestArguments {\n  assertStruct(\n    value,\n    OnSignatureRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n  ...baseNameLookupArgs,\n  address: string(),\n});\nconst addressRequestStruct = object({\n  ...baseNameLookupArgs,\n  domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n  domainRequestStruct,\n  addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n  typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n  address?: string;\n  domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n  value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n  assertStruct(\n    value,\n    OnNameLookupRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const OnUserInputArgumentsStruct = object({\n  id: string(),\n  event: UserInputEventStruct,\n  context: optional(nullable(InterfaceContextStruct)),\n});\n\nexport type OnUserInputArguments = Infer<typeof OnUserInputArgumentsStruct>;\n\n/**\n * Asserts that the given value is a valid {@link OnUserInputArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnUserInputArguments}\n * object.\n */\nexport function assertIsOnUserInputRequestArguments(\n  value: unknown,\n): asserts value is OnUserInputArguments {\n  assertStruct(\n    value,\n    OnUserInputArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst OkResponseStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: OkStruct,\n});\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n  Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n  Args extends RequestArguments,\n  ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n  ExecuteSnapRequestArguments,\n  OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"]}

package/dist/iframe/IFrameSnapExecutor.cjs

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IFrameSnapExecutor = void 0;
+const object_multiplex_1 = __importDefault(require("@metamask/object-multiplex"));
+const post_message_stream_1 = require("@metamask/post-message-stream");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const readable_stream_1 = require("readable-stream");
+const BaseSnapExecutor_1 = require("../common/BaseSnapExecutor.cjs");
+const logging_1 = require("../logging.cjs");
+class IFrameSnapExecutor extends BaseSnapExecutor_1.BaseSnapExecutor {
+    /**
+     * Initialize the IFrameSnapExecutor. This creates a post message stream from
+     * and to the parent window, for two-way communication with the iframe.
+     *
+     * @param stream - The stream to use for communication.
+     * @returns An instance of `IFrameSnapExecutor`, with the initialized post
+     * message streams.
+     */
+    static initialize(stream = new post_message_stream_1.WindowPostMessageStream({
+        name: 'child',
+        target: 'parent',
+        targetWindow: self.parent,
+        targetOrigin: '*',
+    })) {
+        (0, logging_1.log)('Worker: Connecting to parent.');
+        const mux = new object_multiplex_1.default();
+        (0, readable_stream_1.pipeline)(stream, mux, stream, (error) => {
+            if (error) {
+                (0, snaps_utils_1.logError)(`Parent stream failure, closing worker.`, error);
+            }
+            self.close();
+        });
+        const commandStream = mux.createStream(snaps_utils_1.SNAP_STREAM_NAMES.COMMAND);
+        const rpcStream = mux.createStream(snaps_utils_1.SNAP_STREAM_NAMES.JSON_RPC);
+        return new IFrameSnapExecutor(commandStream, rpcStream);
+    }
+}
+exports.IFrameSnapExecutor = IFrameSnapExecutor;
+//# sourceMappingURL=IFrameSnapExecutor.cjs.map

package/dist/iframe/IFrameSnapExecutor.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFrameSnapExecutor.cjs","sourceRoot":"","sources":["../../src/iframe/IFrameSnapExecutor.ts"],"names":[],"mappings":";;;;;;AAAA,kFAAyD;AAEzD,uEAAwE;AACxE,uDAAoE;AACpE,qDAA2C;AAE3C,qEAA8D;AAC9D,4CAAiC;AAEjC,MAAa,kBAAmB,SAAQ,mCAAgB;IACtD;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CACf,SAAgC,IAAI,6CAAuB,CAAC;QAC1D,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,QAAQ;QAChB,YAAY,EAAE,IAAI,CAAC,MAAM;QACzB,YAAY,EAAE,GAAG;KAClB,CAAC;QAEF,IAAA,aAAG,EAAC,+BAA+B,CAAC,CAAC;QAErC,MAAM,GAAG,GAAG,IAAI,0BAAe,EAAE,CAAC;QAClC,IAAA,0BAAQ,EAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YACtC,IAAI,KAAK,EAAE,CAAC;gBACV,IAAA,sBAAQ,EAAC,wCAAwC,EAAE,KAAK,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,GAAG,CAAC,YAAY,CAAC,+BAAiB,CAAC,QAAQ,CAAC,CAAC;QAE/D,OAAO,IAAI,kBAAkB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF;AAhCD,gDAgCC","sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\nimport { logError, SNAP_STREAM_NAMES } from '@metamask/snaps-utils';\nimport { pipeline } from 'readable-stream';\n\nimport { BaseSnapExecutor } from '../common/BaseSnapExecutor';\nimport { log } from '../logging';\n\nexport class IFrameSnapExecutor extends BaseSnapExecutor {\n  /**\n   * Initialize the IFrameSnapExecutor. This creates a post message stream from\n   * and to the parent window, for two-way communication with the iframe.\n   *\n   * @param stream - The stream to use for communication.\n   * @returns An instance of `IFrameSnapExecutor`, with the initialized post\n   * message streams.\n   */\n  static initialize(\n    stream: BasePostMessageStream = new WindowPostMessageStream({\n      name: 'child',\n      target: 'parent',\n      targetWindow: self.parent,\n      targetOrigin: '*',\n    }),\n  ) {\n    log('Worker: Connecting to parent.');\n\n    const mux = new ObjectMultiplex();\n    pipeline(stream, mux, stream, (error) => {\n      if (error) {\n        logError(`Parent stream failure, closing worker.`, error);\n      }\n      self.close();\n    });\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    return new IFrameSnapExecutor(commandStream, rpcStream);\n  }\n}\n"]}