@metamask/snaps-execution-environments 3.3.0 → 3.4.1

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

@@ -1,5 +1,6 @@
 import type { StreamProvider } from '@metamask/providers';
 import type { SnapsProvider } from '@metamask/snaps-sdk';
+import type { NotifyFunction } from '../BaseSnapExecutor';
 /**
  * Gets the endowments for a particular Snap. Some endowments, like `setTimeout`
  * and `clearTimeout`, must be attenuated so that they can only affect behavior
@@ -7,13 +8,21 @@ import type { SnapsProvider } from '@metamask/snaps-sdk';
  * such attenuated / modified endowments. Otherwise, the value that's on the
  * root realm global will be used.
  *
- * @param snap - The Snaps global API object.
- * @param ethereum - The Snap's EIP-1193 provider object.
- * @param snapId - The id of the snap that will use the created endowments.
- * @param endowments - The list of endowments to provide to the snap.
+ * @param options - An options bag.
+ * @param options.snap - The Snaps global API object.
+ * @param options.ethereum - The Snap's EIP-1193 provider object.
+ * @param options.snapId - The id of the snap that will use the created endowments.
+ * @param options.endowments - The list of endowments to provide to the snap.
+ * @param options.notify - A reference to the notify function of the snap executor.
  * @returns An object containing the Snap's endowments.
  */
-export declare function createEndowments(snap: SnapsProvider, ethereum: StreamProvider, snapId: string, endowments?: string[]): {
+export declare function createEndowments({ snap, ethereum, snapId, endowments, notify, }: {
+    snap: SnapsProvider;
+    ethereum: StreamProvider;
+    snapId: string;
+    endowments: string[];
+    notify: NotifyFunction;
+}): {
     endowments: Record<string, unknown>;
     teardown: () => Promise<void>;
 };

package/dist/types/common/endowments/network.d.ts

@@ -1,6 +1,7 @@
+import type { EndowmentFactoryOptions } from './commonEndowmentFactory';
 declare const endowmentModule: {
     names: readonly ["fetch", "Request", "Headers", "Response"];
-    factory: () => {
+    factory: ({ notify }?: EndowmentFactoryOptions) => {
         fetch: typeof fetch;
         Request: {
             new (input: URL | RequestInfo, init?: RequestInit | undefined): Request;

package/dist/types/common/validation.d.ts

@@ -3,14 +3,14 @@ import type { Json, JsonRpcSuccess } from '@metamask/utils';
 import type { Infer } from 'superstruct';
 export declare const JsonRpcRequestWithoutIdStruct: import("superstruct").Struct<{
     method: string;
-    jsonrpc: "2.0";
-    params?: Record<string, Json> | Json[] | undefined;
     id?: string | number | null | undefined;
+    jsonrpc?: "2.0" | undefined;
+    params?: Record<string, Json> | Json[] | undefined;
 }, {
+    jsonrpc: import("superstruct").Struct<"2.0" | undefined, "2.0">;
     id: import("superstruct").Struct<string | number | null | undefined, null>;
-    params: import("superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
     method: import("superstruct").Struct<string, null>;
-    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
+    params: import("superstruct").Struct<Record<string, Json> | Json[] | undefined, null>;
 }>;
 export declare type JsonRpcRequestWithoutId = Infer<typeof JsonRpcRequestWithoutIdStruct>;
 export declare const EndowmentStruct: import("superstruct").Struct<string, null>;
@@ -31,12 +31,12 @@ export declare function isEndowment(value: unknown): value is Endowment;
 export declare function isEndowmentsArray(value: unknown): value is Endowment[];
 export declare const PingRequestArgumentsStruct: import("superstruct").Struct<unknown[] | undefined, null>;
 export declare const TerminateRequestArgumentsStruct: import("superstruct").Struct<unknown[] | undefined, null>;
-export declare const ExecuteSnapRequestArgumentsStruct: import("superstruct").Struct<[string, string, string[] | undefined], null>;
+export declare const ExecuteSnapRequestArgumentsStruct: import("superstruct").Struct<[string, string, string[]], null>;
 export declare const SnapRpcRequestArgumentsStruct: import("superstruct").Struct<[string, HandlerType, string, {
     method: string;
-    jsonrpc: "2.0";
-    params?: Record<string, Json> | undefined;
     id?: string | number | null | undefined;
+    jsonrpc?: "2.0" | undefined;
+    params?: Record<string, Json> | undefined;
 }], null>;
 export declare type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;
 export declare type TerminateRequestArguments = Infer<typeof TerminateRequestArgumentsStruct>;
@@ -87,23 +87,19 @@ export declare type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {
  */
 export declare function assertIsOnNameLookupRequestArguments(value: unknown): asserts value is OnNameLookupRequestArguments;
 declare const OkResponseStruct: import("superstruct").Struct<{
+    result: "OK";
     id: string | number | null;
     jsonrpc: "2.0";
-    result: "OK";
 }, {
-    result: import("superstruct").Struct<"OK", "OK">;
     id: import("superstruct").Struct<string | number | null, null>;
     jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
+    result: import("superstruct").Struct<"OK", "OK">;
 }>;
 declare const SnapRpcResponse: import("superstruct").Struct<{
     id: string | number | null;
     jsonrpc: "2.0";
     result: Json;
-}, {
-    id: import("superstruct").Struct<string | number | null, null>;
-    jsonrpc: import("superstruct").Struct<"2.0", "2.0">;
-    result: import("superstruct").Struct<Json, unknown>;
-}>;
+}, unknown>;
 export declare type OkResponse = Infer<typeof OkResponseStruct>;
 export declare type SnapRpcResponse = Infer<typeof SnapRpcResponse>;
 export declare type Response = OkResponse | SnapRpcResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-execution-environments",
-  "version": "3.3.0",
+  "version": "3.4.1",
   "description": "Snap sandbox environments for executing SES javascript",
   "repository": {
     "type": "git",
@@ -44,15 +44,16 @@
     "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@metamask/json-rpc-engine": "^7.1.1",
-    "@metamask/object-multiplex": "^1.2.0",
+    "@metamask/json-rpc-engine": "^7.3.0",
+    "@metamask/object-multiplex": "^2.0.0",
     "@metamask/post-message-stream": "^7.0.0",
-    "@metamask/providers": "^13.0.0",
+    "@metamask/providers": "^14.0.1",
     "@metamask/rpc-errors": "^6.1.0",
-    "@metamask/snaps-sdk": "^1.0.0",
-    "@metamask/snaps-utils": "^4.0.0",
-    "@metamask/utils": "^8.1.0",
+    "@metamask/snaps-sdk": "^1.2.0",
+    "@metamask/snaps-utils": "^5.0.0",
+    "@metamask/utils": "^8.2.1",
     "nanoid": "^3.1.31",
+    "readable-stream": "^3.6.2",
     "superstruct": "^1.0.3"
   },
   "devDependencies": {