@metamask/snaps-jest 6.0.2 → 7.0.1

package/dist/{chunk-T2BE4O5H.js → chunk-IDGD7TZ7.js}

@@ -27,6 +27,7 @@ var _crypto = require('crypto');
 
 
 
+
 var _superstruct = require('superstruct');
 var BytesLikeStruct = _superstruct.union.call(void 0, [
   _superstruct.bigint.call(void 0, ),
@@ -197,30 +198,39 @@ var JsonRpcMockOptionsStruct = _superstruct.object.call(void 0, {
 var InterfaceStruct = _superstruct.type.call(void 0, {
   content: _superstruct.optional.call(void 0, _snapssdk.ComponentStruct)
 });
-var SnapResponseStruct = _superstruct.assign.call(void 0, 
-  InterfaceStruct,
+var SnapResponseWithoutInterfaceStruct = _superstruct.object.call(void 0, {
+  id: _superstruct.string.call(void 0, ),
+  response: _superstruct.union.call(void 0, [
+    _superstruct.object.call(void 0, {
+      result: _utils.JsonStruct
+    }),
+    _superstruct.object.call(void 0, {
+      error: _utils.JsonStruct
+    })
+  ]),
+  notifications: _superstruct.array.call(void 0, 
+    _superstruct.object.call(void 0, {
+      id: _superstruct.string.call(void 0, ),
+      message: _superstruct.string.call(void 0, ),
+      type: _superstruct.union.call(void 0, [
+        _snapssdk.enumValue.call(void 0, _snapssdk.NotificationType.InApp),
+        _snapssdk.enumValue.call(void 0, _snapssdk.NotificationType.Native)
+      ])
+    })
+  )
+});
+var SnapResponseWithInterfaceStruct = _superstruct.assign.call(void 0, 
+  SnapResponseWithoutInterfaceStruct,
   _superstruct.object.call(void 0, {
-    id: _superstruct.string.call(void 0, ),
-    response: _superstruct.union.call(void 0, [
-      _superstruct.object.call(void 0, {
-        result: _utils.JsonStruct
-      }),
-      _superstruct.object.call(void 0, {
-        error: _utils.JsonStruct
-      })
-    ]),
-    notifications: _superstruct.array.call(void 0, 
-      _superstruct.object.call(void 0, {
-        id: _superstruct.string.call(void 0, ),
-        message: _superstruct.string.call(void 0, ),
-        type: _superstruct.union.call(void 0, [
-          _snapssdk.enumValue.call(void 0, _snapssdk.NotificationType.InApp),
-          _snapssdk.enumValue.call(void 0, _snapssdk.NotificationType.Native)
-        ])
-      })
-    )
+    getInterface: _superstruct.func.call(void 0, )
   })
 );
+var SnapResponseStruct = _superstruct.union.call(void 0, [
+  SnapResponseWithoutInterfaceStruct,
+  SnapResponseWithInterfaceStruct
+]);
+
+
 
 
 
@@ -229,5 +239,5 @@ var SnapResponseStruct = _superstruct.assign.call(void 0,
 
 
 
-exports.TransactionOptionsStruct = TransactionOptionsStruct; exports.SignatureOptionsStruct = SignatureOptionsStruct; exports.SnapOptionsStruct = SnapOptionsStruct; exports.JsonRpcMockOptionsStruct = JsonRpcMockOptionsStruct; exports.InterfaceStruct = InterfaceStruct; exports.SnapResponseStruct = SnapResponseStruct;
-//# sourceMappingURL=chunk-T2BE4O5H.js.map
+exports.TransactionOptionsStruct = TransactionOptionsStruct; exports.SignatureOptionsStruct = SignatureOptionsStruct; exports.SnapOptionsStruct = SnapOptionsStruct; exports.JsonRpcMockOptionsStruct = JsonRpcMockOptionsStruct; exports.InterfaceStruct = InterfaceStruct; exports.SnapResponseWithoutInterfaceStruct = SnapResponseWithoutInterfaceStruct; exports.SnapResponseWithInterfaceStruct = SnapResponseWithInterfaceStruct; exports.SnapResponseStruct = SnapResponseStruct;
+//# sourceMappingURL=chunk-IDGD7TZ7.js.map

package/dist/chunk-IDGD7TZ7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/structs.ts"],"names":[],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,mBAAmB;AAC5B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP,IAAM,kBAAkB,MAAM;AAAA,EAC5B,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AAAA,EACP,SAAS,UAAU;AACrB,CAAC;AAEM,IAAM,2BAA2B,OAAO;AAAA;AAAA;AAAA;AAAA,EAI7C,SAAS,UAAU,OAAO,GAAG,UAAU;AAAA;AAAA;AAAA;AAAA,EAKvC,QAAQ,UAAU,OAAO,GAAG,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzC,MAAM,OAAO,iBAAiB,SAAS,eAAe,GAAG,CAAC,UAAU;AAClE,QAAI,OAAO;AACT,aAAO,WAAW,aAAa,KAAK,CAAC;AAAA,IACvC;AAEA,WAAO,WAAW,YAAY,EAAE,CAAC;AAAA,EACnC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOD,IAAI,OAAO,iBAAiB,SAAS,eAAe,GAAG,CAAC,UAAU;AAChE,QAAI,OAAO;AACT,aAAO,WAAW,aAAa,KAAK,CAAC;AAAA,IACvC;AAEA,WAAO,WAAW,YAAY,EAAE,CAAC;AAAA,EACnC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMD,OAAO;AAAA,IACL;AAAA,MAAO;AAAA,MAAiB;AAAA,MAAiB,CAAC,UACxC,WAAW,aAAa,KAAK,CAAC;AAAA,IAChC;AAAA,IACA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAU;AAAA,IACR;AAAA,MAAO;AAAA,MAAiB;AAAA,MAAiB,CAAC,UACxC,WAAW,aAAa,KAAK,CAAC;AAAA,IAChC;AAAA,IACA,aAAa,IAAM;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,cAAc;AAAA,IACZ;AAAA,MAAO;AAAA,MAAiB;AAAA,MAAiB,CAAC,UACxC,WAAW,aAAa,KAAK,CAAC;AAAA,IAChC;AAAA,IACA,aAAa,CAAC;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,sBAAsB;AAAA,IACpB;AAAA,MAAO;AAAA,MAAiB;AAAA,MAAiB,CAAC,UACxC,WAAW,aAAa,KAAK,CAAC;AAAA,IAChC;AAAA,IACA,aAAa,CAAC;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO;AAAA,IACL;AAAA,MAAO;AAAA,MAAiB;AAAA,MAAiB,CAAC,UACxC,WAAW,aAAa,KAAK,CAAC;AAAA,IAChC;AAAA,IACA,aAAa,CAAC;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM;AAAA,IACJ;AAAA,MAAO,MAAM,CAAC,iBAAiB,QAAQ,IAAI,CAAC,CAAC;AAAA,MAAG;AAAA,MAAiB,CAAC,UAChE,WAAW,aAAa,KAAK,CAAC;AAAA,IAChC;AAAA,IACA;AAAA,EACF;AACF,CAAC;AAEM,IAAM,yBAAyB,OAAO;AAAA;AAAA;AAAA;AAAA,EAI3C,QAAQ,UAAU,OAAO,GAAG,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,MAAM,OAAO,iBAAiB,SAAS,eAAe,GAAG,CAAC,UAAU;AAClE,QAAI,OAAO;AACT,aAAO,WAAW,aAAa,KAAK,CAAC;AAAA,IACvC;AAEA,WAAO,WAAW,YAAY,EAAE,CAAC;AAAA,EACnC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOD,MAAM;AAAA,IACJ,MAAM;AAAA,MACJ;AAAA,MACA,QAAQ,IAAI;AAAA,MACZ,OAAO,OAAO,GAAG,IAAI,CAAC;AAAA,MACtB,MAAM,OAAO,OAAO,GAAG,IAAI,CAAC,CAAC;AAAA,IAC/B,CAAC;AAAA,IACD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,iBAAiB;AAAA,IACf,MAAM;AAAA,MACJ,QAAQ,UAAU;AAAA,MAClB,QAAQ,eAAe;AAAA,MACvB,QAAQ,mBAAmB;AAAA,MAC3B,QAAQ,sBAAsB;AAAA,MAC9B,QAAQ,sBAAsB;AAAA,IAChC,CAAC;AAAA,IACD;AAAA,EACF;AACF,CAAC;AAEM,IAAM,oBAAoB,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKtC,SAAS,UAAU,SAAS,OAAO,CAAC,GAAG,GAAI;AAC7C,CAAC;AAEM,IAAM,2BAA2B,OAAO;AAAA,EAC7C,QAAQ,OAAO;AAAA,EACf,QAAQ;AACV,CAAC;AAEM,IAAM,kBAAkB,KAAK;AAAA,EAClC,SAAS,SAAS,eAAe;AACnC,CAAC;AAEM,IAAM,qCAAqC,OAAO;AAAA,EACvD,IAAI,OAAO;AAAA,EAEX,UAAU,MAAM;AAAA,IACd,OAAO;AAAA,MACL,QAAQ;AAAA,IACV,CAAC;AAAA,IACD,OAAO;AAAA,MACL,OAAO;AAAA,IACT,CAAC;AAAA,EACH,CAAC;AAAA,EAED,eAAe;AAAA,IACb,OAAO;AAAA,MACL,IAAI,OAAO;AAAA,MACX,SAAS,OAAO;AAAA,MAChB,MAAM,MAAM;AAAA,QACV,UAAU,iBAAiB,KAAK;AAAA,QAChC,UAAU,iBAAiB,MAAM;AAAA,MACnC,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF,CAAC;AAEM,IAAM,kCAAkC;AAAA,EAC7C;AAAA,EACA,OAAO;AAAA,IACL,cAAc,KAAK;AAAA,EACrB,CAAC;AACH;AAEO,IAAM,qBAAqB,MAAM;AAAA,EACtC;AAAA,EACA;AACF,CAAC","sourcesContent":["import {\n  ComponentStruct,\n  NotificationType,\n  enumValue,\n} from '@metamask/snaps-sdk';\nimport {\n  bytesToHex,\n  JsonStruct,\n  StrictHexStruct,\n  valueToBytes,\n} from '@metamask/utils';\nimport { randomBytes } from 'crypto';\nimport {\n  array,\n  assign,\n  bigint,\n  coerce,\n  defaulted,\n  instance,\n  literal,\n  number,\n  object,\n  optional,\n  string,\n  union,\n  record,\n  any,\n  func,\n  type,\n} from 'superstruct';\n\n// TODO: Export this from `@metamask/utils` instead.\nconst BytesLikeStruct = union([\n  bigint(),\n  number(),\n  string(),\n  instance(Uint8Array),\n]);\n\nexport const TransactionOptionsStruct = object({\n  /**\n   * The CAIP-2 chain ID to send the transaction on. Defaults to `eip155:1`.\n   */\n  chainId: defaulted(string(), 'eip155:1'),\n\n  /**\n   * The origin to send the transaction from. Defaults to `metamask.io`.\n   */\n  origin: defaulted(string(), 'metamask.io'),\n\n  /**\n   * The address to send the transaction from. Defaults to a randomly generated\n   * address.\n   */\n  // TODO: Move this coercer to `@metamask/utils`.\n  from: coerce(StrictHexStruct, optional(BytesLikeStruct), (value) => {\n    if (value) {\n      return bytesToHex(valueToBytes(value));\n    }\n\n    return bytesToHex(randomBytes(20));\n  }),\n\n  /**\n   * The address to send the transaction to. Defaults to a randomly generated\n   * address.\n   */\n  // TODO: Move this coercer to `@metamask/utils`.\n  to: coerce(StrictHexStruct, optional(BytesLikeStruct), (value) => {\n    if (value) {\n      return bytesToHex(valueToBytes(value));\n    }\n\n    return bytesToHex(randomBytes(20));\n  }),\n\n  /**\n   * The value to send with the transaction. The value may be specified as a\n   * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.\n   */\n  value: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    '0x0',\n  ),\n\n  /**\n   * The gas limit to use for the transaction. The gas limit may be specified\n   * as a `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `21_000`.\n   */\n  gasLimit: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(21_000),\n  ),\n\n  /**\n   * The max fee per gas (in Wei) to use for the transaction. The max fee per\n   * gas may be specified as a `number`, `bigint`, `string`, or `Uint8Array`.\n   * Defaults to `1`.\n   */\n  maxFeePerGas: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(1),\n  ),\n\n  /**\n   * The max priority fee per gas (in Wei) to use for the transaction. The max\n   * priority fee per gas may be specified as a `number`, `bigint`, `string`,\n   * or `Uint8Array`. Defaults to `1`.\n   */\n  maxPriorityFeePerGas: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(1),\n  ),\n\n  /**\n   * The nonce to use for the transaction. The nonce may be specified as a\n   * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0`.\n   */\n  nonce: defaulted(\n    coerce(StrictHexStruct, BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    valueToBytes(0),\n  ),\n\n  /**\n   * The data to send with the transaction. The data may be specified as a\n   * `number`, `bigint`, `string`, or `Uint8Array`. Defaults to `0x`.\n   */\n  data: defaulted(\n    coerce(union([StrictHexStruct, literal('0x')]), BytesLikeStruct, (value) =>\n      bytesToHex(valueToBytes(value)),\n    ),\n    '0x',\n  ),\n});\n\nexport const SignatureOptionsStruct = object({\n  /**\n   * The origin making the signature request.\n   */\n  origin: defaulted(string(), 'metamask.io'),\n\n  /**\n   * The address signing the signature request. Defaults to a randomly generated\n   * address.\n   */\n  from: coerce(StrictHexStruct, optional(BytesLikeStruct), (value) => {\n    if (value) {\n      return bytesToHex(valueToBytes(value));\n    }\n\n    return bytesToHex(randomBytes(20));\n  }),\n\n  /**\n   * The data to send with the transaction. The data may be specified as a\n   * `string`, an object, or an array of objects. This covers the data types\n   * for the supported signature methods. Defaults to `0x`.\n   */\n  data: defaulted(\n    union([\n      StrictHexStruct,\n      literal('0x'),\n      record(string(), any()),\n      array(record(string(), any())),\n    ]),\n    '0x',\n  ),\n\n  /**\n   * The signature method being used.\n   */\n  signatureMethod: defaulted(\n    union([\n      literal('eth_sign'),\n      literal('personal_sign'),\n      literal('eth_signTypedData'),\n      literal('eth_signTypedData_v3'),\n      literal('eth_signTypedData_v4'),\n    ]),\n    'personal_sign',\n  ),\n});\n\nexport const SnapOptionsStruct = object({\n  /**\n   * The timeout in milliseconds to use for requests to the snap. Defaults to\n   * `1000`.\n   */\n  timeout: defaulted(optional(number()), 1000),\n});\n\nexport const JsonRpcMockOptionsStruct = object({\n  method: string(),\n  result: JsonStruct,\n});\n\nexport const InterfaceStruct = type({\n  content: optional(ComponentStruct),\n});\n\nexport const SnapResponseWithoutInterfaceStruct = object({\n  id: string(),\n\n  response: union([\n    object({\n      result: JsonStruct,\n    }),\n    object({\n      error: JsonStruct,\n    }),\n  ]),\n\n  notifications: array(\n    object({\n      id: string(),\n      message: string(),\n      type: union([\n        enumValue(NotificationType.InApp),\n        enumValue(NotificationType.Native),\n      ]),\n    }),\n  ),\n});\n\nexport const SnapResponseWithInterfaceStruct = assign(\n  SnapResponseWithoutInterfaceStruct,\n  object({\n    getInterface: func(),\n  }),\n);\n\nexport const SnapResponseStruct = union([\n  SnapResponseWithoutInterfaceStruct,\n  SnapResponseWithInterfaceStruct,\n]);\n"]}

package/dist/chunk-KR7CYXCR.js

@@ -0,0 +1,213 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkPZDTZGSIjs = require('./chunk-PZDTZGSI.js');
+
+// src/internals/simulation/interface.ts
+
+
+
+
+
+
+var _snapssdk = require('@metamask/snaps-sdk');
+var _snapsutils = require('@metamask/snaps-utils');
+var _effects = require('redux-saga/effects');
+function getInterfaceResponse(runSaga, type, content, interfaceActions) {
+  switch (type) {
+    case _snapssdk.DialogType.Alert:
+      return {
+        ...interfaceActions,
+        type,
+        content,
+        ok: resolveWith(runSaga, null)
+      };
+    case _snapssdk.DialogType.Confirmation:
+      return {
+        ...interfaceActions,
+        type,
+        content,
+        ok: resolveWith(runSaga, true),
+        cancel: resolveWith(runSaga, false)
+      };
+    case _snapssdk.DialogType.Prompt:
+      return {
+        ...interfaceActions,
+        type,
+        content,
+        ok: resolveWithInput(runSaga),
+        cancel: resolveWith(runSaga, null)
+      };
+    default:
+      throw new Error(`Unknown or unsupported dialog type: "${String(type)}".`);
+  }
+}
+function resolveWith(runSaga, value) {
+  function* resolveWithSaga() {
+    yield _effects.put.call(void 0, _chunkPZDTZGSIjs.resolveInterface.call(void 0, value));
+  }
+  return async () => {
+    await runSaga(resolveWithSaga).toPromise();
+  };
+}
+function resolveWithInput(runSaga) {
+  function* resolveWithSaga(value) {
+    yield _effects.put.call(void 0, _chunkPZDTZGSIjs.resolveInterface.call(void 0, value));
+  }
+  return async (value = "") => {
+    await runSaga(resolveWithSaga, value).toPromise();
+  };
+}
+function* getStoredInterface(controllerMessenger, snapId) {
+  const currentInterface = yield _effects.select.call(void 0, _chunkPZDTZGSIjs.getCurrentInterface);
+  if (currentInterface) {
+    const { content: content2 } = controllerMessenger.call(
+      "SnapInterfaceController:getInterface",
+      snapId,
+      currentInterface.id
+    );
+    return { ...currentInterface, content: content2 };
+  }
+  const { payload } = yield _effects.take.call(void 0, _chunkPZDTZGSIjs.setInterface.type);
+  const { content } = controllerMessenger.call(
+    "SnapInterfaceController:getInterface",
+    snapId,
+    payload.id
+  );
+  return { ...payload, content };
+}
+function getElement(content, name) {
+  const { type } = content;
+  if ((type === _snapssdk.NodeType.Button || type === _snapssdk.NodeType.Input) && content.name === name) {
+    return { element: content };
+  }
+  if (_snapsutils.hasChildren.call(void 0, content)) {
+    for (const element of content.children) {
+      const result = getElement(element, name);
+      const form = type === _snapssdk.NodeType.Form ? content.name : result?.form;
+      if (result) {
+        return { element: result.element, form };
+      }
+    }
+  }
+  return void 0;
+}
+async function handleEvent(controllerMessenger, snapId, id, event) {
+  try {
+    await controllerMessenger.call(
+      "ExecutionService:handleRpcRequest",
+      snapId,
+      {
+        origin: "",
+        handler: _snapsutils.HandlerType.OnUserInput,
+        request: {
+          jsonrpc: "2.0",
+          method: " ",
+          params: {
+            event,
+            id
+          }
+        }
+      }
+    );
+  } catch (error) {
+    const [unwrapped] = _snapsutils.unwrapError.call(void 0, error);
+    throw unwrapped;
+  }
+}
+async function clickElement(controllerMessenger, id, content, snapId, name) {
+  const result = getElement(content, name);
+  _snapssdk.assert.call(void 0, 
+    result !== void 0 && result.element.type === _snapssdk.NodeType.Button,
+    "No button found in the interface."
+  );
+  await handleEvent(controllerMessenger, snapId, id, {
+    type: _snapssdk.UserInputEventType.ButtonClickEvent,
+    name: result.element.name
+  });
+  if (result.form && result.element.buttonType === _snapssdk.ButtonType.Submit) {
+    const { state } = controllerMessenger.call(
+      "SnapInterfaceController:getInterface",
+      snapId,
+      id
+    );
+    await handleEvent(controllerMessenger, snapId, id, {
+      type: _snapssdk.UserInputEventType.FormSubmitEvent,
+      name: result.form,
+      value: state[result.form]
+    });
+  }
+}
+function mergeValue(state, name, value, form) {
+  if (form) {
+    return {
+      ...state,
+      [form]: {
+        ...state[form],
+        [name]: value
+      }
+    };
+  }
+  return { ...state, [name]: value };
+}
+async function typeInField(controllerMessenger, id, content, snapId, name, value) {
+  const result = getElement(content, name);
+  _snapssdk.assert.call(void 0, 
+    result !== void 0 && result.element.type === _snapssdk.NodeType.Input,
+    "No input found in the interface."
+  );
+  const { state } = controllerMessenger.call(
+    "SnapInterfaceController:getInterface",
+    snapId,
+    id
+  );
+  const newState = mergeValue(state, name, value, result.form);
+  controllerMessenger.call(
+    "SnapInterfaceController:updateInterfaceState",
+    id,
+    newState
+  );
+  await controllerMessenger.call("ExecutionService:handleRpcRequest", snapId, {
+    origin: "",
+    handler: _snapsutils.HandlerType.OnUserInput,
+    request: {
+      jsonrpc: "2.0",
+      method: " ",
+      params: {
+        event: {
+          type: _snapssdk.UserInputEventType.InputChangeEvent,
+          name: result.element.name,
+          value
+        },
+        id
+      }
+    }
+  });
+}
+function* getInterface(runSaga, snapId, controllerMessenger) {
+  const { type, id, content } = yield _effects.call.call(void 0, 
+    getStoredInterface,
+    controllerMessenger,
+    snapId
+  );
+  const interfaceActions = {
+    clickElement: async (name) => {
+      await clickElement(controllerMessenger, id, content, snapId, name);
+    },
+    typeInField: async (name, value) => {
+      await typeInField(controllerMessenger, id, content, snapId, name, value);
+    }
+  };
+  return getInterfaceResponse(runSaga, type, content, interfaceActions);
+}
+
+
+
+
+
+
+
+
+exports.getInterfaceResponse = getInterfaceResponse; exports.getElement = getElement; exports.clickElement = clickElement; exports.mergeValue = mergeValue; exports.typeInField = typeInField; exports.getInterface = getInterface;
+//# sourceMappingURL=chunk-KR7CYXCR.js.map

package/dist/chunk-KR7CYXCR.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/interface.ts"],"names":["content"],"mappings":";;;;;;;AASA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,aAAa,aAAa,mBAAmB;AAGtD,SAAS,MAAM,KAAK,QAAQ,YAAY;AAgBjC,SAAS,qBACd,SACA,MACA,SACA,kBACe;AACf,UAAQ,MAAM;AAAA,IACZ,KAAK,WAAW;AACd,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,QACA,IAAI,YAAY,SAAS,IAAI;AAAA,MAC/B;AAAA,IAEF,KAAK,WAAW;AACd,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,QAEA,IAAI,YAAY,SAAS,IAAI;AAAA,QAC7B,QAAQ,YAAY,SAAS,KAAK;AAAA,MACpC;AAAA,IAEF,KAAK,WAAW;AACd,aAAO;AAAA,QACL,GAAG;AAAA,QACH;AAAA,QACA;AAAA,QAEA,IAAI,iBAAiB,OAAO;AAAA,QAC5B,QAAQ,YAAY,SAAS,IAAI;AAAA,MACnC;AAAA,IAEF;AACE,YAAM,IAAI,MAAM,wCAAwC,OAAO,IAAI,CAAC,IAAI;AAAA,EAC5E;AACF;AAUA,SAAS,YAAY,SAA0B,OAAgB;AAM7D,YAAU,kBAAgC;AACxC,UAAM,IAAI,iBAAiB,KAAK,CAAC;AAAA,EACnC;AAEA,SAAO,YAAY;AACjB,UAAM,QAAQ,eAAe,EAAE,UAAU;AAAA,EAC3C;AACF;AASA,SAAS,iBAAiB,SAA0B;AAOlD,YAAU,gBAAgB,OAA6B;AACrD,UAAM,IAAI,iBAAiB,KAAK,CAAC;AAAA,EACnC;AAEA,SAAO,OAAO,QAAQ,OAAO;AAC3B,UAAM,QAAQ,iBAAiB,KAAK,EAAE,UAAU;AAAA,EAClD;AACF;AAUA,UAAU,mBACR,qBACA,QACkD;AAClD,QAAM,mBAAqC,MAAM,OAAO,mBAAmB;AAE3E,MAAI,kBAAkB;AACpB,UAAM,EAAE,SAAAA,SAAQ,IAAI,oBAAoB;AAAA,MACtC;AAAA,MACA;AAAA,MACA,iBAAiB;AAAA,IACnB;AAEA,WAAO,EAAE,GAAG,kBAAkB,SAAAA,SAAQ;AAAA,EACxC;AAEA,QAAM,EAAE,QAAQ,IAA8B,MAAM,KAAK,aAAa,IAAI;AAE1E,QAAM,EAAE,QAAQ,IAAI,oBAAoB;AAAA,IACtC;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,EACV;AAEA,SAAO,EAAE,GAAG,SAAS,QAAQ;AAC/B;AASO,SAAS,WACd,SACA,MAMY;AACZ,QAAM,EAAE,KAAK,IAAI;AAEjB,OACG,SAAS,SAAS,UAAU,SAAS,SAAS,UAC/C,QAAQ,SAAS,MACjB;AACA,WAAO,EAAE,SAAS,QAAQ;AAAA,EAC5B;AAEA,MAAI,YAAY,OAAO,GAAG;AACxB,eAAW,WAAW,QAAQ,UAAU;AACtC,YAAM,SAAS,WAAW,SAAS,IAAI;AACvC,YAAM,OAAO,SAAS,SAAS,OAAO,QAAQ,OAAO,QAAQ;AAE7D,UAAI,QAAQ;AACV,eAAO,EAAE,SAAS,OAAO,SAAS,KAAK;AAAA,MACzC;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AASA,eAAe,YACb,qBACA,QACA,IACA,OACA;AACA,MAAI;AACF,UAAM,oBAAoB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,QACR,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,SAAS;AAAA,UACT,QAAQ;AAAA,UACR,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,UAAM,CAAC,SAAS,IAAI,YAAY,KAAK;AACrC,UAAM;AAAA,EACR;AACF;AAWA,eAAsB,aACpB,qBACA,IACA,SACA,QACA,MACe;AACf,QAAM,SAAS,WAAW,SAAS,IAAI;AACvC;AAAA,IACE,WAAW,UAAa,OAAO,QAAQ,SAAS,SAAS;AAAA,IACzD;AAAA,EACF;AAGA,QAAM,YAAY,qBAAqB,QAAQ,IAAI;AAAA,IACjD,MAAM,mBAAmB;AAAA,IACzB,MAAM,OAAO,QAAQ;AAAA,EACvB,CAAC;AAED,MAAI,OAAO,QAAQ,OAAO,QAAQ,eAAe,WAAW,QAAQ;AAClE,UAAM,EAAE,MAAM,IAAI,oBAAoB;AAAA,MACpC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,UAAM,YAAY,qBAAqB,QAAQ,IAAI;AAAA,MACjD,MAAM,mBAAmB;AAAA,MACzB,MAAM,OAAO;AAAA,MACb,OAAO,MAAM,OAAO,IAAI;AAAA,IAC1B,CAAC;AAAA,EACH;AACF;AAWO,SAAS,WACd,OACA,MACA,OACA,MACgB;AAChB,MAAI,MAAM;AACR,WAAO;AAAA,MACL,GAAG;AAAA,MACH,CAAC,IAAI,GAAG;AAAA,QACN,GAAI,MAAM,IAAI;AAAA,QACd,CAAC,IAAI,GAAG;AAAA,MACV;AAAA,IACF;AAAA,EACF;AAEA,SAAO,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,MAAM;AACnC;AAYA,eAAsB,YACpB,qBACA,IACA,SACA,QACA,MACA,OACA;AACA,QAAM,SAAS,WAAW,SAAS,IAAI;AAEvC;AAAA,IACE,WAAW,UAAa,OAAO,QAAQ,SAAS,SAAS;AAAA,IACzD;AAAA,EACF;AAEA,QAAM,EAAE,MAAM,IAAI,oBAAoB;AAAA,IACpC;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW,WAAW,OAAO,MAAM,OAAO,OAAO,IAAI;AAE3D,sBAAoB;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,oBAAoB,KAAK,qCAAqC,QAAQ;AAAA,IAC1E,QAAQ;AAAA,IACR,SAAS,YAAY;AAAA,IACrB,SAAS;AAAA,MACP,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,QAAQ;AAAA,QACN,OAAO;AAAA,UACL,MAAM,mBAAmB;AAAA,UACzB,MAAM,OAAO,QAAQ;AAAA,UACrB;AAAA,QACF;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAWO,UAAU,aACf,SACA,QACA,qBAC6B;AAC7B,QAAM,EAAE,MAAM,IAAI,QAAQ,IAAI,MAAM;AAAA,IAClC;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,mBAAmB;AAAA,IACvB,cAAc,OAAO,SAAiB;AACpC,YAAM,aAAa,qBAAqB,IAAI,SAAS,QAAQ,IAAI;AAAA,IACnE;AAAA,IACA,aAAa,OAAO,MAAc,UAAkB;AAClD,YAAM,YAAY,qBAAqB,IAAI,SAAS,QAAQ,MAAM,KAAK;AAAA,IACzE;AAAA,EACF;AAEA,SAAO,qBAAqB,SAAS,MAAM,SAAS,gBAAgB;AACtE","sourcesContent":["import type {\n  Button,\n  Component,\n  FormState,\n  Input,\n  InterfaceState,\n  SnapId,\n  UserInputEvent,\n} from '@metamask/snaps-sdk';\nimport {\n  ButtonType,\n  DialogType,\n  NodeType,\n  UserInputEventType,\n  assert,\n} from '@metamask/snaps-sdk';\nimport { HandlerType, hasChildren, unwrapError } from '@metamask/snaps-utils';\nimport type { PayloadAction } from '@reduxjs/toolkit';\nimport { type SagaIterator } from 'redux-saga';\nimport { call, put, select, take } from 'redux-saga/effects';\n\nimport type { SnapInterface, SnapInterfaceActions } from '../../types';\nimport type { RootControllerMessenger } from './controllers';\nimport type { Interface, RunSagaFunction } from './store';\nimport { getCurrentInterface, resolveInterface, setInterface } from './store';\n\n/**\n * Get a user interface object from a type and content object.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @param type - The type of the interface.\n * @param content - The content to show in the interface.\n * @param interfaceActions - The actions to interact with the interface.\n * @returns The user interface object.\n */\nexport function getInterfaceResponse(\n  runSaga: RunSagaFunction,\n  type: DialogType,\n  content: Component,\n  interfaceActions: SnapInterfaceActions,\n): SnapInterface {\n  switch (type) {\n    case DialogType.Alert:\n      return {\n        ...interfaceActions,\n        type,\n        content,\n        ok: resolveWith(runSaga, null),\n      };\n\n    case DialogType.Confirmation:\n      return {\n        ...interfaceActions,\n        type,\n        content,\n\n        ok: resolveWith(runSaga, true),\n        cancel: resolveWith(runSaga, false),\n      };\n\n    case DialogType.Prompt:\n      return {\n        ...interfaceActions,\n        type,\n        content,\n\n        ok: resolveWithInput(runSaga),\n        cancel: resolveWith(runSaga, null),\n      };\n\n    default:\n      throw new Error(`Unknown or unsupported dialog type: \"${String(type)}\".`);\n  }\n}\n\n/**\n * Resolve the current user interface with the given value. This returns a\n * function that can be used to resolve the user interface.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @param value - The value to resolve the user interface with.\n * @returns A function that can be used to resolve the user interface.\n */\nfunction resolveWith(runSaga: RunSagaFunction, value: unknown) {\n  /**\n   * Resolve the current user interface with the given value.\n   *\n   * @yields Puts the resolve user interface action.\n   */\n  function* resolveWithSaga(): SagaIterator {\n    yield put(resolveInterface(value));\n  }\n\n  return async () => {\n    await runSaga(resolveWithSaga).toPromise();\n  };\n}\n\n/**\n * Resolve the current user interface with the provided input. This returns a\n * function that can be used to resolve the user interface.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A function that can be used to resolve the user interface.\n */\nfunction resolveWithInput(runSaga: RunSagaFunction) {\n  /**\n   * Resolve the current user interface with the given value.\n   *\n   * @param value - The value to resolve the user interface with.\n   * @yields Puts the resolve user interface action.\n   */\n  function* resolveWithSaga(value: string): SagaIterator {\n    yield put(resolveInterface(value));\n  }\n\n  return async (value = '') => {\n    await runSaga(resolveWithSaga, value).toPromise();\n  };\n}\n\n/**\n * Get the stored user interface from the store.\n *\n * @param controllerMessenger - The controller messenger used to call actions.\n * @param snapId - The Snap ID.\n * @yields Takes the set interface action.\n * @returns The user interface object.\n */\nfunction* getStoredInterface(\n  controllerMessenger: RootControllerMessenger,\n  snapId: SnapId,\n): SagaIterator<Interface & { content: Component }> {\n  const currentInterface: Interface | null = yield select(getCurrentInterface);\n\n  if (currentInterface) {\n    const { content } = controllerMessenger.call(\n      'SnapInterfaceController:getInterface',\n      snapId,\n      currentInterface.id,\n    );\n\n    return { ...currentInterface, content };\n  }\n\n  const { payload }: PayloadAction<Interface> = yield take(setInterface.type);\n\n  const { content } = controllerMessenger.call(\n    'SnapInterfaceController:getInterface',\n    snapId,\n    payload.id,\n  );\n\n  return { ...payload, content };\n}\n\n/**\n * Get a Button or an Input from an interface.\n *\n * @param content - The interface content.\n * @param name - The element name.\n * @returns An object containing the element and the form name if it's contained in a form, otherwise undefined.\n */\nexport function getElement(\n  content: Component,\n  name: string,\n):\n  | {\n      element: Button | Input;\n      form?: string;\n    }\n  | undefined {\n  const { type } = content;\n\n  if (\n    (type === NodeType.Button || type === NodeType.Input) &&\n    content.name === name\n  ) {\n    return { element: content };\n  }\n\n  if (hasChildren(content)) {\n    for (const element of content.children) {\n      const result = getElement(element, name);\n      const form = type === NodeType.Form ? content.name : result?.form;\n\n      if (result) {\n        return { element: result.element, form };\n      }\n    }\n  }\n\n  return undefined;\n}\n/**\n * Handle submitting event requests to OnUserInput including unwrapping potential errors.\n *\n * @param controllerMessenger - The controller messenger used to call actions.\n * @param snapId - The Snap ID.\n * @param id - The interface ID.\n * @param event - The event to submit.\n */\nasync function handleEvent(\n  controllerMessenger: RootControllerMessenger,\n  snapId: SnapId,\n  id: string,\n  event: UserInputEvent,\n) {\n  try {\n    await controllerMessenger.call(\n      'ExecutionService:handleRpcRequest',\n      snapId,\n      {\n        origin: '',\n        handler: HandlerType.OnUserInput,\n        request: {\n          jsonrpc: '2.0',\n          method: ' ',\n          params: {\n            event,\n            id,\n          },\n        },\n      },\n    );\n  } catch (error) {\n    const [unwrapped] = unwrapError(error);\n    throw unwrapped;\n  }\n}\n\n/**\n * Click on an element of the Snap interface.\n *\n * @param controllerMessenger - The controller messenger used to call actions.\n * @param id - The interface ID.\n * @param content - The interface content.\n * @param snapId - The Snap ID.\n * @param name - The element name.\n */\nexport async function clickElement(\n  controllerMessenger: RootControllerMessenger,\n  id: string,\n  content: Component,\n  snapId: SnapId,\n  name: string,\n): Promise<void> {\n  const result = getElement(content, name);\n  assert(\n    result !== undefined && result.element.type === NodeType.Button,\n    'No button found in the interface.',\n  );\n\n  // Button click events are always triggered.\n  await handleEvent(controllerMessenger, snapId, id, {\n    type: UserInputEventType.ButtonClickEvent,\n    name: result.element.name,\n  });\n\n  if (result.form && result.element.buttonType === ButtonType.Submit) {\n    const { state } = controllerMessenger.call(\n      'SnapInterfaceController:getInterface',\n      snapId,\n      id,\n    );\n\n    await handleEvent(controllerMessenger, snapId, id, {\n      type: UserInputEventType.FormSubmitEvent,\n      name: result.form,\n      value: state[result.form] as Record<string, string | null>,\n    });\n  }\n}\n\n/**\n * Merge a value in the interface state.\n *\n * @param state - The actual interface state.\n * @param name - The component name that changed value.\n * @param value - The new value.\n * @param form - The form name if the element is in one.\n * @returns The state with the merged value.\n */\nexport function mergeValue(\n  state: InterfaceState,\n  name: string,\n  value: string | null,\n  form?: string,\n): InterfaceState {\n  if (form) {\n    return {\n      ...state,\n      [form]: {\n        ...(state[form] as FormState),\n        [name]: value,\n      },\n    };\n  }\n\n  return { ...state, [name]: value };\n}\n\n/**\n * Type a value in an interface element.\n *\n * @param controllerMessenger - The controller messenger used to call actions.\n * @param id - The interface ID.\n * @param content - The interface Components.\n * @param snapId - The Snap ID.\n * @param name - The element name.\n * @param value - The value to type in the element.\n */\nexport async function typeInField(\n  controllerMessenger: RootControllerMessenger,\n  id: string,\n  content: Component,\n  snapId: SnapId,\n  name: string,\n  value: string,\n) {\n  const result = getElement(content, name);\n\n  assert(\n    result !== undefined && result.element.type === NodeType.Input,\n    'No input found in the interface.',\n  );\n\n  const { state } = controllerMessenger.call(\n    'SnapInterfaceController:getInterface',\n    snapId,\n    id,\n  );\n\n  const newState = mergeValue(state, name, value, result.form);\n\n  controllerMessenger.call(\n    'SnapInterfaceController:updateInterfaceState',\n    id,\n    newState,\n  );\n\n  await controllerMessenger.call('ExecutionService:handleRpcRequest', snapId, {\n    origin: '',\n    handler: HandlerType.OnUserInput,\n    request: {\n      jsonrpc: '2.0',\n      method: ' ',\n      params: {\n        event: {\n          type: UserInputEventType.InputChangeEvent,\n          name: result.element.name,\n          value,\n        },\n        id,\n      },\n    },\n  });\n}\n\n/**\n * Get a user interface object from a Snap.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger used to call actions.\n * @yields Takes the set interface action.\n * @returns The user interface object.\n */\nexport function* getInterface(\n  runSaga: RunSagaFunction,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): SagaIterator<SnapInterface> {\n  const { type, id, content } = yield call(\n    getStoredInterface,\n    controllerMessenger,\n    snapId,\n  );\n\n  const interfaceActions = {\n    clickElement: async (name: string) => {\n      await clickElement(controllerMessenger, id, content, snapId, name);\n    },\n    typeInField: async (name: string, value: string) => {\n      await typeInField(controllerMessenger, id, content, snapId, name, value);\n    },\n  };\n\n  return getInterfaceResponse(runSaga, type, content, interfaceActions);\n}\n"]}

package/dist/{chunk-BS24WMRW.mjs → chunk-LG3VKXGH.mjs}

@@ -1,6 +1,6 @@
 import {
   getPermissionSpecifications
-} from "./chunk-HBLJOACO.mjs";
+} from "./chunk-TAIJXTLU.mjs";
 import {
   UNRESTRICTED_METHODS
 } from "./chunk-57SGDM5B.mjs";
@@ -92,4 +92,4 @@ export {
   getControllers,
   registerSnap
 };
-//# sourceMappingURL=chunk-BS24WMRW.mjs.map
+//# sourceMappingURL=chunk-LG3VKXGH.mjs.map

package/dist/{chunk-5PLDD7ZC.js → chunk-LMCG5RIX.js}

@@ -1,21 +1,22 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkHNH5UAKZjs = require('./chunk-HNH5UAKZ.js');
+var _chunk2JTGBHPRjs = require('./chunk-2JTGBHPR.js');
 
 
-var _chunkTZB4LBT7js = require('./chunk-TZB4LBT7.js');
+var _chunk7L5S3PIDjs = require('./chunk-7L5S3PID.js');
 
 
+var _chunkTZB4LBT7js = require('./chunk-TZB4LBT7.js');
 
 
-var _chunkT2BE4O5Hjs = require('./chunk-T2BE4O5H.js');
 
 
 
-var _chunkLACTK6EOjs = require('./chunk-LACTK6EO.js');
+var _chunkIDGD7TZ7js = require('./chunk-IDGD7TZ7.js');
 
 
-var _chunk2JTGBHPRjs = require('./chunk-2JTGBHPR.js');
+
+var _chunkLACTK6EOjs = require('./chunk-LACTK6EO.js');
 
 // src/helpers.ts
 var _snapsutils = require('@metamask/snaps-utils');
@@ -28,6 +29,9 @@ function getOptions(snapId, options) {
   }
   return [snapId, options];
 }
+function assertIsResponseWithInterface(response) {
+  _utils.assertStruct.call(void 0, response, _chunkIDGD7TZ7js.SnapResponseWithInterfaceStruct);
+}
 async function installSnap(snapId, options = {}) {
   const resolvedOptions = getOptions(snapId, options);
   const {
@@ -43,8 +47,8 @@ async function installSnap(snapId, options = {}) {
       origin: transactionOrigin,
       chainId,
       ...transaction
-    } = _superstruct.create.call(void 0, request, _chunkT2BE4O5Hjs.TransactionOptionsStruct);
-    return _chunkHNH5UAKZjs.handleRequest.call(void 0, {
+    } = _superstruct.create.call(void 0, request, _chunkIDGD7TZ7js.TransactionOptionsStruct);
+    const response = await _chunk7L5S3PIDjs.handleRequest.call(void 0, {
       snapId: installedSnapId,
       store,
       executionService,
@@ -60,10 +64,12 @@ async function installSnap(snapId, options = {}) {
         }
       }
     });
+    assertIsResponseWithInterface(response);
+    return response;
   };
   const onCronjob = (request) => {
     log("Running cronjob %o.", options);
-    return _chunkHNH5UAKZjs.handleRequest.call(void 0, {
+    return _chunk7L5S3PIDjs.handleRequest.call(void 0, {
       snapId: installedSnapId,
       store,
       executionService,
@@ -76,7 +82,7 @@ async function installSnap(snapId, options = {}) {
   return {
     request: (request) => {
       log("Sending request %o.", request);
-      return _chunkHNH5UAKZjs.handleRequest.call(void 0, {
+      return _chunk7L5S3PIDjs.handleRequest.call(void 0, {
         snapId: installedSnapId,
         store,
         executionService,
@@ -92,9 +98,9 @@ async function installSnap(snapId, options = {}) {
       log("Requesting signature %o.", request);
       const { origin: signatureOrigin, ...signature } = _superstruct.create.call(void 0, 
         request,
-        _chunkT2BE4O5Hjs.SignatureOptionsStruct
+        _chunkIDGD7TZ7js.SignatureOptionsStruct
       );
-      return _chunkHNH5UAKZjs.handleRequest.call(void 0, {
+      const response = await _chunk7L5S3PIDjs.handleRequest.call(void 0, {
         snapId: installedSnapId,
         store,
         executionService,
@@ -109,12 +115,14 @@ async function installSnap(snapId, options = {}) {
           }
         }
       });
+      assertIsResponseWithInterface(response);
+      return response;
     },
     onCronjob,
     runCronjob: onCronjob,
     onHomePage: async () => {
       log("Rendering home page.");
-      return _chunkHNH5UAKZjs.handleRequest.call(void 0, {
+      const response = await _chunk7L5S3PIDjs.handleRequest.call(void 0, {
         snapId: installedSnapId,
         store,
         executionService,
@@ -125,10 +133,12 @@ async function installSnap(snapId, options = {}) {
           method: ""
         }
       });
+      assertIsResponseWithInterface(response);
+      return response;
     },
     mockJsonRpc(mock) {
       log("Mocking JSON-RPC request %o.", mock);
-      const { method, result } = _superstruct.create.call(void 0, mock, _chunkT2BE4O5Hjs.JsonRpcMockOptionsStruct);
+      const { method, result } = _superstruct.create.call(void 0, mock, _chunkIDGD7TZ7js.JsonRpcMockOptionsStruct);
       store.dispatch(_chunkLACTK6EOjs.addJsonRpcMock.call(void 0, { method, result }));
       return {
         unmock() {
@@ -150,4 +160,4 @@ async function installSnap(snapId, options = {}) {
 
 
 exports.installSnap = installSnap;
-//# sourceMappingURL=chunk-5PLDD7ZC.js.map
+//# sourceMappingURL=chunk-LMCG5RIX.js.map

package/dist/chunk-LMCG5RIX.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,SAAS,aAAa,eAAe;AACrC,SAAS,cAAc,0BAA0B;AACjD,SAAS,cAAc;AAyBvB,IAAM,MAAM,mBAAmB,YAAY,SAAS;AASpD,SAAS,WAKP,QACA,SAC4D;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,CAAC,QAAW,MAAM;AAAA,EAC3B;AAEA,SAAO,CAAC,QAAQ,OAAO;AACzB;AAOA,SAAS,8BACP,UAC+C;AAC/C,eAAa,UAAU,+BAA+B;AACxD;AAqIA,eAAsB,YAKpB,QACA,UAAgD,CAAC,GAClC;AACf,QAAM,kBAAkB,WAAW,QAAQ,OAAO;AAClD,QAAM;AAAA,IACJ,QAAQ;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI,MAAM,eAAe,EAAE,YAAY,GAAG,eAAe;AAEzD,QAAM,gBAAgB,OACpB,YACuC;AACvC,QAAI,2BAA2B,OAAO;AAEtC,UAAM;AAAA,MACJ,QAAQ;AAAA,MACR;AAAA,MACA,GAAG;AAAA,IACL,IAAI,OAAO,SAAS,wBAAwB;AAE5C,UAAM,WAAW,MAAM,cAAc;AAAA,MACnC,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,YAAY;AAAA,MACrB,SAAS;AAAA,QACP,QAAQ;AAAA,QACR,QAAQ;AAAA,UACN;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,kCAA8B,QAAQ;AAEtC,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,CAAC,YAA4B;AAC7C,QAAI,uBAAuB,OAAO;AAElC,WAAO,cAAc;AAAA,MACnB,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,YAAY;AAAA,MACrB;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,SAAS,CAAC,YAAY;AACpB,UAAI,uBAAuB,OAAO;AAElC,aAAO,cAAc;AAAA,QACnB,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA;AAAA,IACA,iBAAiB;AAAA,IAEjB,aAAa,OACX,YACuC;AACvC,UAAI,4BAA4B,OAAO;AAEvC,YAAM,EAAE,QAAQ,iBAAiB,GAAG,UAAU,IAAI;AAAA,QAChD;AAAA,QACA;AAAA,MACF;AAEA,YAAM,WAAW,MAAM,cAAc;AAAA,QACnC,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,QAAQ;AAAA,UACR,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF,CAAC;AAED,oCAA8B,QAAQ;AAEtC,aAAO;AAAA,IACT;AAAA,IAEA;AAAA,IACA,YAAY;AAAA,IAEZ,YAAY,YAAgD;AAC1D,UAAI,sBAAsB;AAE1B,YAAM,WAAW,MAAM,cAAc;AAAA,QACnC,QAAQ;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,SAAS,YAAY;AAAA,QACrB,SAAS;AAAA,UACP,QAAQ;AAAA,QACV;AAAA,MACF,CAAC;AAED,oCAA8B,QAAQ;AAEtC,aAAO;AAAA,IACT;AAAA,IAEA,YAAY,MAA0B;AACpC,UAAI,gCAAgC,IAAI;AAExC,YAAM,EAAE,QAAQ,OAAO,IAAI,OAAO,MAAM,wBAAwB;AAChE,YAAM,SAAS,eAAe,EAAE,QAAQ,OAAO,CAAC,CAAC;AAEjD,aAAO;AAAA,QACL,SAAS;AACP,cAAI,kCAAkC,IAAI;AAE1C,gBAAM,SAAS,kBAAkB,MAAM,CAAC;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,IAEA,OAAO,YAAY;AACjB,UAAI,4BAA4B;AAChC;AAAA,QACE;AAAA,MACF;AAEA,YAAM,iBAAiB,kBAAkB;AAAA,IAC3C;AAAA,EACF;AACF","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType, logInfo } from '@metamask/snaps-utils';\nimport { assertStruct, createModuleLogger } from '@metamask/utils';\nimport { create } from 'superstruct';\n\nimport {\n  rootLogger,\n  handleRequest,\n  TransactionOptionsStruct,\n  getEnvironment,\n  JsonRpcMockOptionsStruct,\n  SignatureOptionsStruct,\n  SnapResponseWithInterfaceStruct,\n} from './internals';\nimport type { InstallSnapOptions } from './internals';\nimport {\n  addJsonRpcMock,\n  removeJsonRpcMock,\n} from './internals/simulation/store/mocks';\nimport type {\n  SnapResponseWithInterface,\n  CronjobOptions,\n  JsonRpcMockOptions,\n  Snap,\n  SnapResponse,\n  TransactionOptions,\n} from './types';\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * Get the options for {@link installSnap}.\n *\n * @param snapId - The ID of the Snap, or the options.\n * @param options - The options, if any.\n * @returns The options.\n */\nfunction getOptions<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId | Partial<InstallSnapOptions<Service>> | undefined,\n  options: Partial<InstallSnapOptions<Service>>,\n): [SnapId | undefined, Partial<InstallSnapOptions<Service>>] {\n  if (typeof snapId === 'object') {\n    return [undefined, snapId];\n  }\n\n  return [snapId, options];\n}\n\n/**\n * Ensure that the actual response contains `getInterface`.\n *\n * @param response - The response of the handler.\n */\nfunction assertIsResponseWithInterface(\n  response: SnapResponse,\n): asserts response is SnapResponseWithInterface {\n  assertStruct(response, SnapResponseWithInterfaceStruct);\n}\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap(): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(options: Partial<InstallSnapOptions<Service>>): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId,\n  options?: Partial<InstallSnapOptions<Service>>,\n): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n *   it('should do something', async () => {\n *     const { request } = await installSnap('local:my-snap');\n *     const response = await request({\n *       method: 'foo',\n *       params: ['bar'],\n *     });\n *     expect(response).toRespondWith('bar');\n *   });\n * });\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId?: SnapId | Partial<InstallSnapOptions<Service>>,\n  options: Partial<InstallSnapOptions<Service>> = {},\n): Promise<Snap> {\n  const resolvedOptions = getOptions(snapId, options);\n  const {\n    snapId: installedSnapId,\n    store,\n    executionService,\n    runSaga,\n    controllerMessenger,\n  } = await getEnvironment().installSnap(...resolvedOptions);\n\n  const onTransaction = async (\n    request: TransactionOptions,\n  ): Promise<SnapResponseWithInterface> => {\n    log('Sending transaction %o.', request);\n\n    const {\n      origin: transactionOrigin,\n      chainId,\n      ...transaction\n    } = create(request, TransactionOptionsStruct);\n\n    const response = await handleRequest({\n      snapId: installedSnapId,\n      store,\n      executionService,\n      runSaga,\n      controllerMessenger,\n      handler: HandlerType.OnTransaction,\n      request: {\n        method: '',\n        params: {\n          chainId,\n          transaction,\n          transactionOrigin,\n        },\n      },\n    });\n\n    assertIsResponseWithInterface(response);\n\n    return response;\n  };\n\n  const onCronjob = (request: CronjobOptions) => {\n    log('Running cronjob %o.', options);\n\n    return handleRequest({\n      snapId: installedSnapId,\n      store,\n      executionService,\n      controllerMessenger,\n      runSaga,\n      handler: HandlerType.OnCronjob,\n      request,\n    });\n  };\n\n  return {\n    request: (request) => {\n      log('Sending request %o.', request);\n\n      return handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnRpcRequest,\n        request,\n      });\n    },\n\n    onTransaction,\n    sendTransaction: onTransaction,\n\n    onSignature: async (\n      request: unknown,\n    ): Promise<SnapResponseWithInterface> => {\n      log('Requesting signature %o.', request);\n\n      const { origin: signatureOrigin, ...signature } = create(\n        request,\n        SignatureOptionsStruct,\n      );\n\n      const response = await handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnSignature,\n        request: {\n          method: '',\n          params: {\n            signature,\n            signatureOrigin,\n          },\n        },\n      });\n\n      assertIsResponseWithInterface(response);\n\n      return response;\n    },\n\n    onCronjob,\n    runCronjob: onCronjob,\n\n    onHomePage: async (): Promise<SnapResponseWithInterface> => {\n      log('Rendering home page.');\n\n      const response = await handleRequest({\n        snapId: installedSnapId,\n        store,\n        executionService,\n        controllerMessenger,\n        runSaga,\n        handler: HandlerType.OnHomePage,\n        request: {\n          method: '',\n        },\n      });\n\n      assertIsResponseWithInterface(response);\n\n      return response;\n    },\n\n    mockJsonRpc(mock: JsonRpcMockOptions) {\n      log('Mocking JSON-RPC request %o.', mock);\n\n      const { method, result } = create(mock, JsonRpcMockOptionsStruct);\n      store.dispatch(addJsonRpcMock({ method, result }));\n\n      return {\n        unmock() {\n          log('Unmocking JSON-RPC request %o.', mock);\n\n          store.dispatch(removeJsonRpcMock(method));\n        },\n      };\n    },\n\n    close: async () => {\n      log('Closing execution service.');\n      logInfo(\n        'Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.',\n      );\n\n      await executionService.terminateAllSnaps();\n    },\n  };\n}\n"]}

package/dist/{chunk-C2ONPIIB.js → chunk-MCYTJUDG.js}

@@ -3,20 +3,20 @@
 var _chunkXWGECIXIjs = require('./chunk-XWGECIXI.js');
 
 
-var _chunkVXPCUDBIjs = require('./chunk-VXPCUDBI.js');
+var _chunkTVD4SWH7js = require('./chunk-TVD4SWH7.js');
 
 
+var _chunkVXPCUDBIjs = require('./chunk-VXPCUDBI.js');
 
-var _chunk6HW5NGCBjs = require('./chunk-6HW5NGCB.js');
 
 
-var _chunkLXSNRZV4js = require('./chunk-LXSNRZV4.js');
+var _chunkDTDYOBCIjs = require('./chunk-DTDYOBCI.js');
 
 
-var _chunkTO46ICOZjs = require('./chunk-TO46ICOZ.js');
+var _chunkZWN4SO2Vjs = require('./chunk-ZWN4SO2V.js');
 
 
-var _chunkTVD4SWH7js = require('./chunk-TVD4SWH7.js');
+var _chunkWMLSD6B5js = require('./chunk-WMLSD6B5.js');
 
 // src/internals/simulation/simulation.ts
 var _basecontroller = require('@metamask/base-controller');
@@ -28,7 +28,6 @@ var _keytree = require('@metamask/key-tree');
 
 
 var _node = require('@metamask/snaps-controllers/node');
-var _snapsrpcmethods = require('@metamask/snaps-rpc-methods');
 var _snapsutils = require('@metamask/snaps-utils');
 var _readablestream = require('readable-stream');
 async function handleInstallSnap(snapId, {
@@ -41,15 +40,11 @@ async function handleInstallSnap(snapId, {
     allowLocal: true
   });
   const snapFiles = await _node.fetchSnap.call(void 0, snapId, location);
-  const password = await _snapsrpcmethods.getEncryptionKey.call(void 0, {
-    mnemonicPhrase: _keytree.mnemonicPhraseToBytes.call(void 0, options.secretRecoveryPhrase),
-    snapId
-  });
-  const { store, runSaga } = _chunkTO46ICOZjs.createStore.call(void 0, password, options);
+  const { store, runSaga } = _chunkWMLSD6B5js.createStore.call(void 0, options);
   const controllerMessenger = new (0, _basecontroller.ControllerMessenger)();
   registerActions(controllerMessenger);
   const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);
-  const { subjectMetadataController, permissionController } = _chunk6HW5NGCBjs.getControllers.call(void 0, {
+  const { subjectMetadataController, permissionController } = _chunkDTDYOBCIjs.getControllers.call(void 0, {
     controllerMessenger,
     hooks,
     runSaga,
@@ -81,14 +76,14 @@ async function handleInstallSnap(snapId, {
       });
     }
   });
-  await _chunk6HW5NGCBjs.registerSnap.call(void 0, snapId, snapFiles.manifest.result, {
+  await _chunkDTDYOBCIjs.registerSnap.call(void 0, snapId, snapFiles.manifest.result, {
     permissionController,
     subjectMetadataController
   });
   await service.executeSnap({
     snapId,
     sourceCode: snapFiles.sourceCode.toString("utf8"),
-    endowments: await _chunkLXSNRZV4js.getEndowments.call(void 0, permissionController, snapId)
+    endowments: await _chunkZWN4SO2Vjs.getEndowments.call(void 0, permissionController, snapId)
   });
   return {
     snapId,
@@ -136,4 +131,4 @@ function registerActions(controllerMessenger) {
 
 
 exports.handleInstallSnap = handleInstallSnap; exports.getHooks = getHooks; exports.registerActions = registerActions;
-//# sourceMappingURL=chunk-C2ONPIIB.js.map
+//# sourceMappingURL=chunk-MCYTJUDG.js.map

package/dist/chunk-MCYTJUDG.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/internals/simulation/simulation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAIA,SAAS,2BAA2B;AACpC,SAAS,0BAA0B;AACnC,SAAS,6BAA6B;AAEtC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAQP,SAAS,gBAAgB;AAEzB,SAAS,gBAAgB;AAyGzB,eAAsB,kBAKpB,QACA;AAAA,EACE;AAAA,EACA;AAAA,EACA,SAAS,aAAa,CAAC;AACzB,IAA0C,CAAC,GACnB;AACxB,QAAM,UAAU,WAAW,UAAU;AAGrC,QAAM,WAAW,mBAAmB,QAAQ;AAAA,IAC1C,YAAY;AAAA,EACd,CAAC;AAED,QAAM,YAAY,MAAM,UAAU,QAAQ,QAAQ;AAGlD,QAAM,EAAE,OAAO,QAAQ,IAAI,YAAY,OAAO;AAE9C,QAAM,sBAAsB,IAAI,oBAA8B;AAE9D,kBAAgB,mBAAmB;AAGnC,QAAM,QAAQ,SAAS,SAAS,WAAW,QAAQ,mBAAmB;AAEtE,QAAM,EAAE,2BAA2B,qBAAqB,IAAI,eAAe;AAAA,IACzE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,SAAS,oBAAoB;AAAA,IACjC;AAAA,IACA;AAAA,IACA,sBAAsB,qBAAqB,2BAA2B;AAAA,MACpE,QAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AAGD,QAAM,mBAAmB,oBAAoB;AAC7C,QAAM,UAAU,IAAI,iBAAiB;AAAA,IACnC,GAAG;AAAA,IACH,WAAW,oBAAoB,cAAc;AAAA,MAC3C,MAAM;AAAA,MACN,gBAAgB,CAAC;AAAA,MACjB,eAAe,CAAC;AAAA,IAClB,CAAC;AAAA,IACD,mBAAmB,CAAC,SAAiB,cAAsB;AACzD,YAAM,MAAM,eAAe,WAAW,YAAY;AAClD,YAAM,SAAS,IAAI,aAAa,mBAAmB;AACnD,YAAM,iBAAiB,mBAAmB,EAAE,OAAO,CAAC;AAIpD,eAAS,QAAQ,gBAAgB,QAAQ,CAAC,UAAmB;AAC3D,YAAI,OAAO;AACT,mBAAS,4BAA4B,KAAK;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,CAAC;AAID,QAAM,aAAa,QAAQ,UAAU,SAAS,QAAQ;AAAA,IACpD;AAAA,IACA;AAAA,EACF,CAAC;AAGD,QAAM,QAAQ,YAAY;AAAA,IACxB;AAAA,IACA,YAAY,UAAU,WAAW,SAAS,MAAM;AAAA,IAChD,YAAY,MAAM,cAAc,sBAAsB,MAAM;AAAA,EAC9D,CAAC;AAED,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,kBAAkB;AAAA,IAClB;AAAA,IACA;AAAA,EACF;AACF;AAWO,SAAS,SACd,SACA,WACA,QACA,qBACiB;AACjB,SAAO;AAAA,IACL,aAAa,YACX,QAAQ,QAAQ,sBAAsB,QAAQ,oBAAoB,CAAC;AAAA,IACrE,aAAa,OAAO,MAAc,aAChC,MAAM,YAAY,UAAU,gBAAgB,MAAM,QAAQ;AAAA,IAC5D,aAAa,MAAM;AAAA,IACnB,iBAAiB,UAAU,SACzB,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL;AAAA,IACF,iBAAiB,UAAU,SACzB,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL;AAAA,IACF,mBAAmB,IAAI,SACrB,oBAAoB;AAAA,MAClB;AAAA,MACA;AAAA,MACA,GAAG;AAAA,IACL,EAAE;AAAA,EACN;AACF;AAOO,SAAS,gBAAgB,qBAA8C;AAC5E,sBAAoB;AAAA,IAClB;AAAA,IACA,YAAY,QAAQ,QAAQ;AAAA,EAC9B;AAEA,sBAAoB;AAAA,IAClB;AAAA,IACA,OAAO,EAAE,QAAQ,OAAO,MAAM,MAAM;AAAA,EACtC;AACF","sourcesContent":["import type {\n  ActionConstraint,\n  EventConstraint,\n} from '@metamask/base-controller';\nimport { ControllerMessenger } from '@metamask/base-controller';\nimport { createEngineStream } from '@metamask/json-rpc-middleware-stream';\nimport { mnemonicPhraseToBytes } from '@metamask/key-tree';\nimport type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport {\n  fetchSnap,\n  detectSnapLocation,\n  NodeThreadExecutionService,\n  setupMultiplex,\n} from '@metamask/snaps-controllers/node';\nimport type {\n  SnapId,\n  AuxiliaryFileEncoding,\n  Component,\n  InterfaceState,\n} from '@metamask/snaps-sdk';\nimport type { FetchedSnapFiles } from '@metamask/snaps-utils';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Duplex } from 'readable-stream';\nimport { pipeline } from 'readable-stream';\n\nimport type { RootControllerMessenger } from './controllers';\nimport { getControllers, registerSnap } from './controllers';\nimport { getSnapFile } from './files';\nimport { getEndowments } from './methods';\nimport { createJsonRpcEngine } from './middleware';\nimport type { SimulationOptions, SimulationUserOptions } from './options';\nimport { getOptions } from './options';\nimport type { RunSagaFunction, Store } from './store';\nimport { createStore } from './store';\n\n/**\n * Options for the execution service, without the options that are shared\n * between all execution services.\n *\n * @template Service - The type of the execution service, i.e., the class that\n * creates the execution service.\n */\nexport type ExecutionServiceOptions<\n  Service extends new (...args: any[]) => any,\n> = Omit<\n  ConstructorParameters<Service>[0],\n  keyof ConstructorParameters<typeof AbstractExecutionService<unknown>>[0]\n>;\n\n/**\n * The options for running a Snap in a simulated environment.\n *\n * @property executionService - The execution service to use.\n * @property executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @property options - The simulation options.\n * @template Service - The type of the execution service.\n */\nexport type InstallSnapOptions<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService<unknown>\n  >,\n> = ExecutionServiceOptions<Service> extends Record<string, never>\n  ? {\n      executionService: Service;\n      executionServiceOptions?: ExecutionServiceOptions<Service>;\n      options?: SimulationUserOptions;\n    }\n  : {\n      executionService: Service;\n      executionServiceOptions: ExecutionServiceOptions<Service>;\n      options?: SimulationUserOptions;\n    };\n\nexport type InstalledSnap = {\n  snapId: SnapId;\n  store: Store;\n  executionService: InstanceType<typeof AbstractExecutionService>;\n  controllerMessenger: ControllerMessenger<ActionConstraint, EventConstraint>;\n  runSaga: RunSagaFunction;\n};\n\nexport type MiddlewareHooks = {\n  /**\n   * A hook that returns the user's secret recovery phrase.\n   *\n   * @returns The user's secret recovery phrase.\n   */\n  getMnemonic: () => Promise<Uint8Array>;\n\n  /**\n   * A hook that returns the Snap's auxiliary file for the given path.\n   *\n   * @param path - The path of the auxiliary file to get.\n   * @param encoding - The encoding to use when returning the file.\n   * @returns The Snap's auxiliary file for the given path.\n   */\n  getSnapFile: (\n    path: string,\n    encoding: AuxiliaryFileEncoding,\n  ) => Promise<string | null>;\n\n  /**\n   * A hook that returns whether the client is locked or not.\n   *\n   * @returns A boolean flag signaling whether the client is locked.\n   */\n  getIsLocked: () => boolean;\n  createInterface: (content: Component) => Promise<string>;\n  updateInterface: (id: string, content: Component) => Promise<void>;\n  getInterfaceState: (id: string) => InterfaceState;\n};\n\n/**\n * Install a Snap in a simulated environment. This will fetch the Snap files,\n * create a Redux store, set up the controllers and JSON-RPC stack, register the\n * Snap, and run the Snap code in the execution service.\n *\n * @param snapId - The ID of the Snap to install.\n * @param options - The options to use when installing the Snap.\n * @param options.executionService - The execution service to use.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @template Service - The type of the execution service.\n */\nexport async function handleInstallSnap<\n  Service extends new (...args: any[]) => InstanceType<\n    typeof AbstractExecutionService\n  >,\n>(\n  snapId: SnapId,\n  {\n    executionService,\n    executionServiceOptions,\n    options: rawOptions = {},\n  }: Partial<InstallSnapOptions<Service>> = {},\n): Promise<InstalledSnap> {\n  const options = getOptions(rawOptions);\n\n  // Fetch Snap files.\n  const location = detectSnapLocation(snapId, {\n    allowLocal: true,\n  });\n\n  const snapFiles = await fetchSnap(snapId, location);\n\n  // Create Redux store.\n  const { store, runSaga } = createStore(options);\n\n  const controllerMessenger = new ControllerMessenger<any, any>();\n\n  registerActions(controllerMessenger);\n\n  // Set up controllers and JSON-RPC stack.\n  const hooks = getHooks(options, snapFiles, snapId, controllerMessenger);\n\n  const { subjectMetadataController, permissionController } = getControllers({\n    controllerMessenger,\n    hooks,\n    runSaga,\n    options,\n  });\n\n  const engine = createJsonRpcEngine({\n    store,\n    hooks,\n    permissionMiddleware: permissionController.createPermissionMiddleware({\n      origin: snapId,\n    }),\n  });\n\n  // Create execution service.\n  const ExecutionService = executionService ?? NodeThreadExecutionService;\n  const service = new ExecutionService({\n    ...executionServiceOptions,\n    messenger: controllerMessenger.getRestricted({\n      name: 'ExecutionService',\n      allowedActions: [],\n      allowedEvents: [],\n    }),\n    setupSnapProvider: (_snapId: string, rpcStream: Duplex) => {\n      const mux = setupMultiplex(rpcStream, 'snapStream');\n      const stream = mux.createStream('metamask-provider');\n      const providerStream = createEngineStream({ engine });\n\n      // Error function is difficult to test, so we ignore it.\n      /* istanbul ignore next 2 */\n      pipeline(stream, providerStream, stream, (error: unknown) => {\n        if (error) {\n          logError(`Provider stream failure.`, error);\n        }\n      });\n    },\n  });\n\n  // Register the Snap. This sets up the Snap's permissions and subject\n  // metadata.\n  await registerSnap(snapId, snapFiles.manifest.result, {\n    permissionController,\n    subjectMetadataController,\n  });\n\n  // Run the Snap code in the execution service.\n  await service.executeSnap({\n    snapId,\n    sourceCode: snapFiles.sourceCode.toString('utf8'),\n    endowments: await getEndowments(permissionController, snapId),\n  });\n\n  return {\n    snapId,\n    store,\n    executionService: service,\n    controllerMessenger,\n    runSaga,\n  };\n}\n\n/**\n * Get the hooks for the simulation.\n *\n * @param options - The simulation options.\n * @param snapFiles - The Snap files.\n * @param snapId - The Snap ID.\n * @param controllerMessenger - The controller messenger.\n * @returns The hooks for the simulation.\n */\nexport function getHooks(\n  options: SimulationOptions,\n  snapFiles: FetchedSnapFiles,\n  snapId: SnapId,\n  controllerMessenger: RootControllerMessenger,\n): MiddlewareHooks {\n  return {\n    getMnemonic: async () =>\n      Promise.resolve(mnemonicPhraseToBytes(options.secretRecoveryPhrase)),\n    getSnapFile: async (path: string, encoding: AuxiliaryFileEncoding) =>\n      await getSnapFile(snapFiles.auxiliaryFiles, path, encoding),\n    getIsLocked: () => false,\n    createInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:createInterface',\n        snapId,\n        ...args,\n      ),\n    updateInterface: async (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:updateInterface',\n        snapId,\n        ...args,\n      ),\n    getInterfaceState: (...args) =>\n      controllerMessenger.call(\n        'SnapInterfaceController:getInterface',\n        snapId,\n        ...args,\n      ).state,\n  };\n}\n\n/**\n * Register mocked action handlers.\n *\n * @param controllerMessenger - The controller messenger.\n */\nexport function registerActions(controllerMessenger: RootControllerMessenger) {\n  controllerMessenger.registerActionHandler(\n    'PhishingController:maybeUpdateState',\n    async () => Promise.resolve(),\n  );\n\n  controllerMessenger.registerActionHandler(\n    'PhishingController:testOrigin',\n    () => ({ result: false, type: 'all' }),\n  );\n}\n"]}