@metamask/snaps-jest 4.0.0 → 5.0.0

package/dist/esm/internals/simulation/methods/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/internals/simulation/methods/constants.ts"],"sourcesContent":["export const EXCLUDED_SNAP_ENDOWMENTS = [];\n\nexport const EXCLUDED_SNAP_PERMISSIONS = [];\n\n/**\n * All unrestricted methods recognized by the `PermissionController`.\n * Unrestricted methods are ignored by the permission system, but every\n * JSON-RPC request seen by the permission system must correspond to a\n * restricted or unrestricted method, or the request will be rejected with a\n * \"method not found\" error.\n */\nexport const UNRESTRICTED_METHODS = Object.freeze([\n  'eth_blockNumber',\n  'eth_call',\n  'eth_chainId',\n  'eth_coinbase',\n  'eth_decrypt',\n  'eth_estimateGas',\n  'eth_feeHistory',\n  'eth_gasPrice',\n  'eth_getBalance',\n  'eth_getBlockByHash',\n  'eth_getBlockByNumber',\n  'eth_getBlockTransactionCountByHash',\n  'eth_getBlockTransactionCountByNumber',\n  'eth_getCode',\n  'eth_getEncryptionPublicKey',\n  'eth_getFilterChanges',\n  'eth_getFilterLogs',\n  'eth_getLogs',\n  'eth_getProof',\n  'eth_getStorageAt',\n  'eth_getTransactionByBlockHashAndIndex',\n  'eth_getTransactionByBlockNumberAndIndex',\n  'eth_getTransactionByHash',\n  'eth_getTransactionCount',\n  'eth_getTransactionReceipt',\n  'eth_getUncleByBlockHashAndIndex',\n  'eth_getUncleByBlockNumberAndIndex',\n  'eth_getUncleCountByBlockHash',\n  'eth_getUncleCountByBlockNumber',\n  'eth_getWork',\n  'eth_hashrate',\n  'eth_mining',\n  'eth_newBlockFilter',\n  'eth_newFilter',\n  'eth_newPendingTransactionFilter',\n  'eth_protocolVersion',\n  'eth_sendRawTransaction',\n  'eth_sendTransaction',\n  'eth_sign',\n  'eth_signTypedData',\n  'eth_signTypedData_v1',\n  'eth_signTypedData_v3',\n  'eth_signTypedData_v4',\n  'eth_submitHashrate',\n  'eth_submitWork',\n  'eth_syncing',\n  'eth_uninstallFilter',\n  'metamask_getProviderState',\n  'metamask_watchAsset',\n  'net_listening',\n  'net_peerCount',\n  'net_version',\n  'personal_ecRecover',\n  'personal_sign',\n  'wallet_watchAsset',\n  'web3_clientVersion',\n  'web3_sha3',\n]);\n"],"names":["EXCLUDED_SNAP_ENDOWMENTS","EXCLUDED_SNAP_PERMISSIONS","UNRESTRICTED_METHODS","Object","freeze"],"mappings":"AAAA,OAAO,MAAMA,2BAA2B,EAAE,CAAC;AAE3C,OAAO,MAAMC,4BAA4B,EAAE,CAAC;AAE5C;;;;;;CAMC,GACD,OAAO,MAAMC,uBAAuBC,OAAOC,MAAM,CAAC;IAChD;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACD,EAAE"}

package/dist/esm/internals/simulation/methods/hooks/encryption.js

@@ -0,0 +1,39 @@
+/**
+ * Mocks encrypting a value using a password. This is not a real encryption
+ * method, but rather is used to simulate encryption in the tests.
+ *
+ * Ideally we would use a real encryption method, such as
+ * `@metamask/browser-passworder`, but it doesn't seem to work with Node.js 18
+ * without some mocking. We can switch to a real encryption method once we
+ * drop support for Node.js 18.
+ *
+ * @param password - The password to use.
+ * @param value - The value to encrypt.
+ * @returns The "encrypted" value.
+ */ export function encryptImplementation(password, value) {
+    return JSON.stringify({
+        password,
+        value
+    });
+}
+/**
+ * Mocks decrypting a value using a password. This is not a real encryption
+ * method, but rather is used to simulate encryption in the tests.
+ *
+ * Ideally we would use a real decryption method, such as
+ * `@metamask/browser-passworder`, but it doesn't seem to work with Node.js 18
+ * without some mocking. We can switch to a real encryption method once we
+ * drop support for Node.js 18.
+ *
+ * @param password - The password to use.
+ * @param value - The value to decrypt.
+ * @returns The "decrypted" value.
+ */ export function decryptImplementation(password, value) {
+    const decryptedValue = JSON.parse(value);
+    if (decryptedValue.password !== password) {
+        throw new Error('Incorrect password. This is a bug in `@metamask/snaps-jest`, please report it.');
+    }
+    return decryptedValue.value;
+}
+
+//# sourceMappingURL=encryption.js.map

package/dist/esm/internals/simulation/methods/hooks/encryption.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/encryption.ts"],"sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Mocks encrypting a value using a password. This is not a real encryption\n * method, but rather is used to simulate encryption in the tests.\n *\n * Ideally we would use a real encryption method, such as\n * `@metamask/browser-passworder`, but it doesn't seem to work with Node.js 18\n * without some mocking. We can switch to a real encryption method once we\n * drop support for Node.js 18.\n *\n * @param password - The password to use.\n * @param value - The value to encrypt.\n * @returns The \"encrypted\" value.\n */\nexport function encryptImplementation(password: string, value: Json) {\n  return JSON.stringify({\n    password,\n    value,\n  });\n}\n\n/**\n * Mocks decrypting a value using a password. This is not a real encryption\n * method, but rather is used to simulate encryption in the tests.\n *\n * Ideally we would use a real decryption method, such as\n * `@metamask/browser-passworder`, but it doesn't seem to work with Node.js 18\n * without some mocking. We can switch to a real encryption method once we\n * drop support for Node.js 18.\n *\n * @param password - The password to use.\n * @param value - The value to decrypt.\n * @returns The \"decrypted\" value.\n */\nexport function decryptImplementation(password: string, value: string) {\n  const decryptedValue = JSON.parse(value);\n  if (decryptedValue.password !== password) {\n    throw new Error(\n      'Incorrect password. This is a bug in `@metamask/snaps-jest`, please report it.',\n    );\n  }\n\n  return decryptedValue.value;\n}\n"],"names":["encryptImplementation","password","value","JSON","stringify","decryptImplementation","decryptedValue","parse","Error"],"mappings":"AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASA,sBAAsBC,QAAgB,EAAEC,KAAW;IACjE,OAAOC,KAAKC,SAAS,CAAC;QACpBH;QACAC;IACF;AACF;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASG,sBAAsBJ,QAAgB,EAAEC,KAAa;IACnE,MAAMI,iBAAiBH,KAAKI,KAAK,CAACL;IAClC,IAAII,eAAeL,QAAQ,KAAKA,UAAU;QACxC,MAAM,IAAIO,MACR;IAEJ;IAEA,OAAOF,eAAeJ,KAAK;AAC7B"}

package/dist/esm/internals/simulation/methods/hooks/get-locale.js

@@ -0,0 +1,13 @@
+/**
+ * Get the implementation of the `getLocale` hook.
+ *
+ * @param options - The simulation options.
+ * @param options.locale - The locale to use.
+ * @returns The implementation of the `getLocale` hook.
+ */ export function getGetLocaleMethodImplementation({ locale }) {
+    return async ()=>{
+        return locale;
+    };
+}
+
+//# sourceMappingURL=get-locale.js.map

package/dist/esm/internals/simulation/methods/hooks/get-locale.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/get-locale.ts"],"sourcesContent":["import type { SimulationOptions } from '../../options';\n\n/**\n * Get the implementation of the `getLocale` hook.\n *\n * @param options - The simulation options.\n * @param options.locale - The locale to use.\n * @returns The implementation of the `getLocale` hook.\n */\nexport function getGetLocaleMethodImplementation({\n  locale,\n}: SimulationOptions) {\n  return async () => {\n    return locale;\n  };\n}\n"],"names":["getGetLocaleMethodImplementation","locale"],"mappings":"AAEA;;;;;;CAMC,GACD,OAAO,SAASA,iCAAiC,EAC/CC,MAAM,EACY;IAClB,OAAO;QACL,OAAOA;IACT;AACF"}

package/dist/esm/internals/simulation/methods/hooks/index.js

@@ -0,0 +1,8 @@
+export * from './encryption';
+export * from './get-locale';
+export * from './notifications';
+export * from './show-dialog';
+export * from './state';
+export * from './interface';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/internals/simulation/methods/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/index.ts"],"sourcesContent":["export * from './encryption';\nexport * from './get-locale';\nexport * from './notifications';\nexport * from './show-dialog';\nexport * from './state';\nexport * from './interface';\n"],"names":[],"mappings":"AAAA,cAAc,eAAe;AAC7B,cAAc,eAAe;AAC7B,cAAc,kBAAkB;AAChC,cAAc,gBAAgB;AAC9B,cAAc,UAAU;AACxB,cAAc,cAAc"}

package/dist/esm/internals/simulation/methods/hooks/interface.js

@@ -0,0 +1,18 @@
+/**
+ * Get the implementation of the `createInterface` hook.
+ *
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @returns The implementation of the `createInterface` hook.
+ */ export function getCreateInterfaceImplementation(controllerMessenger) {
+    return async (snapId, content)=>controllerMessenger.call('SnapInterfaceController:createInterface', snapId, content);
+}
+/**
+ * Get the implementation of the `getInterface` hook.
+ *
+ * @param controllerMessenger - The controller messenger used to call actions.
+ * @returns The implementation of the `getInterface` hook.
+ */ export function getGetInterfaceImplementation(controllerMessenger) {
+    return (snapId, id)=>controllerMessenger.call('SnapInterfaceController:getInterface', snapId, id);
+}
+
+//# sourceMappingURL=interface.js.map

package/dist/esm/internals/simulation/methods/hooks/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/interface.ts"],"sourcesContent":["import type { Component, SnapId } from '@metamask/snaps-sdk';\n\nimport type { RootControllerMessenger } from '../../controllers';\n\n/**\n * Get the implementation of the `createInterface` hook.\n *\n * @param controllerMessenger - The controller messenger used to call actions.\n * @returns The implementation of the `createInterface` hook.\n */\nexport function getCreateInterfaceImplementation(\n  controllerMessenger: RootControllerMessenger,\n) {\n  return async (snapId: SnapId, content: Component) =>\n    controllerMessenger.call(\n      'SnapInterfaceController:createInterface',\n      snapId,\n      content,\n    );\n}\n\n/**\n * Get the implementation of the `getInterface` hook.\n *\n * @param controllerMessenger - The controller messenger used to call actions.\n * @returns The implementation of the `getInterface` hook.\n */\nexport function getGetInterfaceImplementation(\n  controllerMessenger: RootControllerMessenger,\n) {\n  return (snapId: SnapId, id: string) =>\n    controllerMessenger.call(\n      'SnapInterfaceController:getInterface',\n      snapId,\n      id,\n    );\n}\n"],"names":["getCreateInterfaceImplementation","controllerMessenger","snapId","content","call","getGetInterfaceImplementation","id"],"mappings":"AAIA;;;;;CAKC,GACD,OAAO,SAASA,iCACdC,mBAA4C;IAE5C,OAAO,OAAOC,QAAgBC,UAC5BF,oBAAoBG,IAAI,CACtB,2CACAF,QACAC;AAEN;AAEA;;;;;CAKC,GACD,OAAO,SAASE,8BACdJ,mBAA4C;IAE5C,OAAO,CAACC,QAAgBI,KACtBL,oBAAoBG,IAAI,CACtB,wCACAF,QACAI;AAEN"}

package/dist/esm/internals/simulation/methods/hooks/notifications.js

@@ -0,0 +1,58 @@
+import { NotificationType } from '@metamask/snaps-sdk';
+import { nanoid } from '@reduxjs/toolkit';
+import { put } from 'redux-saga/effects';
+import { addNotification } from '../../store';
+/**
+ * Show a native notification to the user.
+ *
+ * @param _snapId - The ID of the Snap that created the notification.
+ * @param options - The notification options.
+ * @param options.message - The message to show in the notification.
+ * @yields Adds the notification to the store.
+ * @returns `null`.
+ */ function* showNativeNotificationImplementation(_snapId, { message }) {
+    yield put(addNotification({
+        id: nanoid(),
+        type: NotificationType.Native,
+        message
+    }));
+    return null;
+}
+/**
+ * Get a method that can be used to show a native notification.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @returns A method that can be used to show a native notification.
+ */ export function getShowNativeNotificationImplementation(runSaga) {
+    return async (...args)=>{
+        return await runSaga(showNativeNotificationImplementation, ...args).toPromise();
+    };
+}
+/**
+ * Show an in-app notification to the user.
+ *
+ * @param _snapId - The ID of the Snap that created the notification.
+ * @param options - The notification options.
+ * @param options.message - The message to show in the notification.
+ * @yields Adds the notification to the store.
+ * @returns `null`.
+ */ function* showInAppNotificationImplementation(_snapId, { message }) {
+    yield put(addNotification({
+        id: nanoid(),
+        type: NotificationType.InApp,
+        message
+    }));
+    return null;
+}
+/**
+ * Get a method that can be used to show an in-app notification.
+ *
+ * @param runSaga - A function to run a saga outside the usual Redux flow.
+ * @returns A method that can be used to show an in-app notification.
+ */ export function getShowInAppNotificationImplementation(runSaga) {
+    return async (...args)=>{
+        return await runSaga(showInAppNotificationImplementation, ...args).toPromise();
+    };
+}
+
+//# sourceMappingURL=notifications.js.map

package/dist/esm/internals/simulation/methods/hooks/notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/notifications.ts"],"sourcesContent":["import type { NotifyParams } from '@metamask/snaps-sdk';\nimport { NotificationType } from '@metamask/snaps-sdk';\nimport { nanoid } from '@reduxjs/toolkit';\nimport type { SagaIterator } from 'redux-saga';\nimport { put } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { addNotification } from '../../store';\n\n/**\n * Show a native notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showNativeNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.Native, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show a native notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show a native notification.\n */\nexport function getShowNativeNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showNativeNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showNativeNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n\n/**\n * Show an in-app notification to the user.\n *\n * @param _snapId - The ID of the Snap that created the notification.\n * @param options - The notification options.\n * @param options.message - The message to show in the notification.\n * @yields Adds the notification to the store.\n * @returns `null`.\n */\nfunction* showInAppNotificationImplementation(\n  _snapId: string,\n  { message }: NotifyParams,\n): SagaIterator<null> {\n  yield put(\n    addNotification({ id: nanoid(), type: NotificationType.InApp, message }),\n  );\n\n  return null;\n}\n\n/**\n * Get a method that can be used to show an in-app notification.\n *\n * @param runSaga - A function to run a saga outside the usual Redux flow.\n * @returns A method that can be used to show an in-app notification.\n */\nexport function getShowInAppNotificationImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (\n    ...args: Parameters<typeof showInAppNotificationImplementation>\n  ) => {\n    return await runSaga(\n      showInAppNotificationImplementation,\n      ...args,\n    ).toPromise();\n  };\n}\n"],"names":["NotificationType","nanoid","put","addNotification","showNativeNotificationImplementation","_snapId","message","id","type","Native","getShowNativeNotificationImplementation","runSaga","args","toPromise","showInAppNotificationImplementation","InApp","getShowInAppNotificationImplementation"],"mappings":"AACA,SAASA,gBAAgB,QAAQ,sBAAsB;AACvD,SAASC,MAAM,QAAQ,mBAAmB;AAE1C,SAASC,GAAG,QAAQ,qBAAqB;AAGzC,SAASC,eAAe,QAAQ,cAAc;AAE9C;;;;;;;;CAQC,GACD,UAAUC,qCACRC,OAAe,EACf,EAAEC,OAAO,EAAgB;IAEzB,MAAMJ,IACJC,gBAAgB;QAAEI,IAAIN;QAAUO,MAAMR,iBAAiBS,MAAM;QAAEH;IAAQ;IAGzE,OAAO;AACT;AAEA;;;;;CAKC,GACD,OAAO,SAASI,wCACdC,OAAwB;IAExB,OAAO,OACL,GAAGC;QAEH,OAAO,MAAMD,QACXP,yCACGQ,MACHC,SAAS;IACb;AACF;AAEA;;;;;;;;CAQC,GACD,UAAUC,oCACRT,OAAe,EACf,EAAEC,OAAO,EAAgB;IAEzB,MAAMJ,IACJC,gBAAgB;QAAEI,IAAIN;QAAUO,MAAMR,iBAAiBe,KAAK;QAAET;IAAQ;IAGxE,OAAO;AACT;AAEA;;;;;CAKC,GACD,OAAO,SAASU,uCACdL,OAAwB;IAExB,OAAO,OACL,GAAGC;QAEH,OAAO,MAAMD,QACXG,wCACGF,MACHC,SAAS;IACb;AACF"}

package/dist/esm/internals/simulation/methods/hooks/show-dialog.js

@@ -0,0 +1,38 @@
+import { put, take } from 'redux-saga/effects';
+import { resolveInterface, setInterface, closeInterface } from '../../store';
+/**
+ * Show a dialog to the user. This will wait for `resolveUserInterface` to be
+ * dispatched before returning.
+ *
+ * @param _snapId - The ID of the Snap that created the dialog. This is ignored
+ * because the simulator only supports one Snap.
+ * @param type - The type of dialog to show.
+ * @param id - The interface ID.
+ * @param _placeholder - The placeholder text to show in the dialog. This is
+ * not implemented yet.
+ * @yields Sets the dialog in the store, waits for the user to resolve the
+ * dialog, and closes the dialog.
+ * @returns The result of the dialog.
+ */ function* showDialogImplementation(_snapId, type, id, _placeholder) {
+    yield put(setInterface({
+        type,
+        id
+    }));
+    // We use `take` to wait for `resolveUserInterface` to be dispatched, which
+    // indicates that the user has resolved the dialog.
+    const { payload } = yield take(resolveInterface.type);
+    yield put(closeInterface());
+    return payload;
+}
+/**
+ * Get the implementation of the `showDialog` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `showDialog` hook.
+ */ export function getShowDialogImplementation(runSaga) {
+    return async (...args)=>{
+        return await runSaga(showDialogImplementation, ...args).toPromise();
+    };
+}
+
+//# sourceMappingURL=show-dialog.js.map

package/dist/esm/internals/simulation/methods/hooks/show-dialog.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/show-dialog.ts"],"sourcesContent":["import type { DialogType } from '@metamask/snaps-sdk';\nimport type { SagaIterator } from 'redux-saga';\nimport { put, take } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { resolveInterface, setInterface, closeInterface } from '../../store';\n\n/**\n * Show a dialog to the user. This will wait for `resolveUserInterface` to be\n * dispatched before returning.\n *\n * @param _snapId - The ID of the Snap that created the dialog. This is ignored\n * because the simulator only supports one Snap.\n * @param type - The type of dialog to show.\n * @param id - The interface ID.\n * @param _placeholder - The placeholder text to show in the dialog. This is\n * not implemented yet.\n * @yields Sets the dialog in the store, waits for the user to resolve the\n * dialog, and closes the dialog.\n * @returns The result of the dialog.\n */\nfunction* showDialogImplementation(\n  _snapId: string,\n  type: DialogType,\n  id: string,\n  _placeholder?: string,\n): SagaIterator<unknown> {\n  yield put(setInterface({ type, id }));\n\n  // We use `take` to wait for `resolveUserInterface` to be dispatched, which\n  // indicates that the user has resolved the dialog.\n  const { payload } = yield take(resolveInterface.type);\n  yield put(closeInterface());\n\n  return payload;\n}\n\n/**\n * Get the implementation of the `showDialog` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `showDialog` hook.\n */\nexport function getShowDialogImplementation(runSaga: RunSagaFunction) {\n  return async (...args: Parameters<typeof showDialogImplementation>) => {\n    return await runSaga(showDialogImplementation, ...args).toPromise();\n  };\n}\n"],"names":["put","take","resolveInterface","setInterface","closeInterface","showDialogImplementation","_snapId","type","id","_placeholder","payload","getShowDialogImplementation","runSaga","args","toPromise"],"mappings":"AAEA,SAASA,GAAG,EAAEC,IAAI,QAAQ,qBAAqB;AAG/C,SAASC,gBAAgB,EAAEC,YAAY,EAAEC,cAAc,QAAQ,cAAc;AAE7E;;;;;;;;;;;;;CAaC,GACD,UAAUC,yBACRC,OAAe,EACfC,IAAgB,EAChBC,EAAU,EACVC,YAAqB;IAErB,MAAMT,IAAIG,aAAa;QAAEI;QAAMC;IAAG;IAElC,2EAA2E;IAC3E,mDAAmD;IACnD,MAAM,EAAEE,OAAO,EAAE,GAAG,MAAMT,KAAKC,iBAAiBK,IAAI;IACpD,MAAMP,IAAII;IAEV,OAAOM;AACT;AAEA;;;;;CAKC,GACD,OAAO,SAASC,4BAA4BC,OAAwB;IAClE,OAAO,OAAO,GAAGC;QACf,OAAO,MAAMD,QAAQP,6BAA6BQ,MAAMC,SAAS;IACnE;AACF"}

package/dist/esm/internals/simulation/methods/hooks/state.js

@@ -0,0 +1,74 @@
+import { put, select } from 'redux-saga/effects';
+import { clearState, getState, setState } from '../../store';
+/**
+ * Get the Snap state from the store.
+ *
+ * @param _snapId - The ID of the Snap to get the state for. This is ignored
+ * because the simulator only supports one Snap.
+ * @param encrypted - Whether to get the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @returns The state of the Snap.
+ * @yields Selects the state from the store.
+ */ function* getSnapStateImplementation(_snapId, encrypted = true) {
+    return yield select(getState(encrypted));
+}
+/**
+ * Get the implementation of the `getSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `getSnapState` hook.
+ */ export function getGetSnapStateMethodImplementation(runSaga) {
+    return (...args)=>{
+        return runSaga(getSnapStateImplementation, ...args).result();
+    };
+}
+/**
+ * Update the Snap state in the store.
+ *
+ * @param _snapId - The ID of the Snap to update the state for. This is ignored
+ * because the simulator only supports one Snap.
+ * @param newState - The new state.
+ * @param encrypted - Whether to update the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @yields Puts the new state in the store.
+ */ function* updateSnapStateImplementation(_snapId, newState, encrypted = true) {
+    yield put(setState({
+        state: newState,
+        encrypted
+    }));
+}
+/**
+ * Get the implementation of the `updateSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `updateSnapState` hook.
+ */ export function getUpdateSnapStateMethodImplementation(runSaga) {
+    return (...args)=>{
+        runSaga(updateSnapStateImplementation, ...args).result();
+    };
+}
+/**
+ * Clear the Snap state in the store.
+ *
+ * @param _snapId - The ID of the Snap to clear the state for. This is ignored
+ * because the simulator only supports one Snap.
+ * @param encrypted - Whether to clear the encrypted or unencrypted state.
+ * Defaults to encrypted state.
+ * @yields Puts the new state in the store.
+ */ function* clearSnapStateImplementation(_snapId, encrypted = true) {
+    yield put(clearState({
+        encrypted
+    }));
+}
+/**
+ * Get the implementation of the `clearSnapState` hook.
+ *
+ * @param runSaga - The function to run a saga outside the usual Redux flow.
+ * @returns The implementation of the `clearSnapState` hook.
+ */ export function getClearSnapStateMethodImplementation(runSaga) {
+    return async (...args)=>{
+        runSaga(clearSnapStateImplementation, ...args).result();
+    };
+}
+
+//# sourceMappingURL=state.js.map

package/dist/esm/internals/simulation/methods/hooks/state.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/methods/hooks/state.ts"],"sourcesContent":["import type { SagaIterator } from 'redux-saga';\nimport { put, select } from 'redux-saga/effects';\n\nimport type { RunSagaFunction } from '../../store';\nimport { clearState, getState, setState } from '../../store';\n\n/**\n * Get the Snap state from the store.\n *\n * @param _snapId - The ID of the Snap to get the state for. This is ignored\n * because the simulator only supports one Snap.\n * @param encrypted - Whether to get the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @returns The state of the Snap.\n * @yields Selects the state from the store.\n */\nfunction* getSnapStateImplementation(\n  _snapId: string,\n  encrypted = true,\n): SagaIterator<string> {\n  return yield select(getState(encrypted));\n}\n\n/**\n * Get the implementation of the `getSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `getSnapState` hook.\n */\nexport function getGetSnapStateMethodImplementation(runSaga: RunSagaFunction) {\n  return (...args: Parameters<typeof getSnapStateImplementation>) => {\n    return runSaga(getSnapStateImplementation, ...args).result();\n  };\n}\n\n/**\n * Update the Snap state in the store.\n *\n * @param _snapId - The ID of the Snap to update the state for. This is ignored\n * because the simulator only supports one Snap.\n * @param newState - The new state.\n * @param encrypted - Whether to update the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* updateSnapStateImplementation(\n  _snapId: string,\n  newState: string,\n  encrypted = true,\n): SagaIterator<void> {\n  yield put(setState({ state: newState, encrypted }));\n}\n\n/**\n * Get the implementation of the `updateSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `updateSnapState` hook.\n */\nexport function getUpdateSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return (...args: Parameters<typeof updateSnapStateImplementation>) => {\n    runSaga(updateSnapStateImplementation, ...args).result();\n  };\n}\n\n/**\n * Clear the Snap state in the store.\n *\n * @param _snapId - The ID of the Snap to clear the state for. This is ignored\n * because the simulator only supports one Snap.\n * @param encrypted - Whether to clear the encrypted or unencrypted state.\n * Defaults to encrypted state.\n * @yields Puts the new state in the store.\n */\nfunction* clearSnapStateImplementation(\n  _snapId: string,\n  encrypted = true,\n): SagaIterator<void> {\n  yield put(clearState({ encrypted }));\n}\n\n/**\n * Get the implementation of the `clearSnapState` hook.\n *\n * @param runSaga - The function to run a saga outside the usual Redux flow.\n * @returns The implementation of the `clearSnapState` hook.\n */\nexport function getClearSnapStateMethodImplementation(\n  runSaga: RunSagaFunction,\n) {\n  return async (...args: Parameters<typeof clearSnapStateImplementation>) => {\n    runSaga(clearSnapStateImplementation, ...args).result();\n  };\n}\n"],"names":["put","select","clearState","getState","setState","getSnapStateImplementation","_snapId","encrypted","getGetSnapStateMethodImplementation","runSaga","args","result","updateSnapStateImplementation","newState","state","getUpdateSnapStateMethodImplementation","clearSnapStateImplementation","getClearSnapStateMethodImplementation"],"mappings":"AACA,SAASA,GAAG,EAAEC,MAAM,QAAQ,qBAAqB;AAGjD,SAASC,UAAU,EAAEC,QAAQ,EAAEC,QAAQ,QAAQ,cAAc;AAE7D;;;;;;;;;CASC,GACD,UAAUC,2BACRC,OAAe,EACfC,YAAY,IAAI;IAEhB,OAAO,MAAMN,OAAOE,SAASI;AAC/B;AAEA;;;;;CAKC,GACD,OAAO,SAASC,oCAAoCC,OAAwB;IAC1E,OAAO,CAAC,GAAGC;QACT,OAAOD,QAAQJ,+BAA+BK,MAAMC,MAAM;IAC5D;AACF;AAEA;;;;;;;;;CASC,GACD,UAAUC,8BACRN,OAAe,EACfO,QAAgB,EAChBN,YAAY,IAAI;IAEhB,MAAMP,IAAII,SAAS;QAAEU,OAAOD;QAAUN;IAAU;AAClD;AAEA;;;;;CAKC,GACD,OAAO,SAASQ,uCACdN,OAAwB;IAExB,OAAO,CAAC,GAAGC;QACTD,QAAQG,kCAAkCF,MAAMC,MAAM;IACxD;AACF;AAEA;;;;;;;;CAQC,GACD,UAAUK,6BACRV,OAAe,EACfC,YAAY,IAAI;IAEhB,MAAMP,IAAIE,WAAW;QAAEK;IAAU;AACnC;AAEA;;;;;CAKC,GACD,OAAO,SAASU,sCACdR,OAAwB;IAExB,OAAO,OAAO,GAAGC;QACfD,QAAQO,iCAAiCN,MAAMC,MAAM;IACvD;AACF"}

package/dist/esm/internals/simulation/methods/index.js

@@ -0,0 +1,3 @@
+export * from './specifications';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/internals/simulation/methods/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/internals/simulation/methods/index.ts"],"sourcesContent":["export * from './specifications';\n"],"names":[],"mappings":"AAAA,cAAc,mBAAmB"}

package/dist/esm/internals/simulation/methods/specifications.js

@@ -0,0 +1,84 @@
+import { endowmentPermissionBuilders, buildSnapEndowmentSpecifications, buildSnapRestrictedMethodSpecifications } from '@metamask/snaps-rpc-methods';
+import { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';
+import { EXCLUDED_SNAP_ENDOWMENTS, EXCLUDED_SNAP_PERMISSIONS } from './constants';
+import { getGetLocaleMethodImplementation, getClearSnapStateMethodImplementation, getGetSnapStateMethodImplementation, getUpdateSnapStateMethodImplementation, getShowDialogImplementation, getShowInAppNotificationImplementation, getShowNativeNotificationImplementation, encryptImplementation, decryptImplementation, getCreateInterfaceImplementation, getGetInterfaceImplementation } from './hooks';
+/**
+ * Get a function which resolves with the specified result.
+ *
+ * @param result - The result to return.
+ * @returns The function implementation.
+ */ export function resolve(result) {
+    return ()=>result;
+}
+/**
+ * Get a function which resolves with the specified result.
+ *
+ * @param result - The result to return. If not specified, the function will
+ * resolve with `undefined`.
+ * @returns The function implementation.
+ */ export function asyncResolve(result) {
+    return async ()=>result;
+}
+/**
+ * Get the permission specifications for the Snap.
+ *
+ * @param options - The options.
+ * @param options.controllerMessenger - The controller messenger.
+ * @param options.hooks - The hooks.
+ * @param options.runSaga - The function to run a saga outside the usual Redux
+ * flow.
+ * @param options.options - The simulation options.
+ * @returns The permission specifications for the Snap.
+ */ export function getPermissionSpecifications({ controllerMessenger, hooks, runSaga, options }) {
+    return {
+        ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),
+        ...buildSnapRestrictedMethodSpecifications(EXCLUDED_SNAP_PERMISSIONS, {
+            // Shared hooks.
+            ...hooks,
+            // Encryption and decryption hooks.
+            // TODO: Swap these out for the real implementations.
+            encrypt: encryptImplementation,
+            decrypt: decryptImplementation,
+            // Snaps-specific hooks.
+            clearSnapState: getClearSnapStateMethodImplementation(runSaga),
+            getLocale: getGetLocaleMethodImplementation(options),
+            getSnapState: getGetSnapStateMethodImplementation(runSaga),
+            getUnlockPromise: asyncResolve(true),
+            // TODO: Allow the user to specify the result of this function.
+            isOnPhishingList: resolve(false),
+            maybeUpdatePhishingList: asyncResolve(),
+            showDialog: getShowDialogImplementation(runSaga),
+            showInAppNotification: getShowInAppNotificationImplementation(runSaga),
+            showNativeNotification: getShowNativeNotificationImplementation(runSaga),
+            updateSnapState: getUpdateSnapStateMethodImplementation(runSaga),
+            createInterface: getCreateInterfaceImplementation(controllerMessenger),
+            getInterface: getGetInterfaceImplementation(controllerMessenger)
+        })
+    };
+}
+/**
+ * Get the endowments for the Snap.
+ *
+ * @param permissionController - The permission controller.
+ * @param snapId - The ID of the Snap.
+ * @returns The endowments for the Snap.
+ */ export async function getEndowments(permissionController, snapId) {
+    const allEndowments = await Object.keys(endowmentPermissionBuilders).reduce(async (promise, permissionName)=>{
+        const accumulator = await promise;
+        if (permissionController.hasPermission(snapId, permissionName)) {
+            const endowments = await permissionController.getEndowments(snapId, permissionName);
+            if (endowments) {
+                return accumulator.concat(endowments);
+            }
+        }
+        return accumulator;
+    }, Promise.resolve([]));
+    return [
+        ...new Set([
+            ...DEFAULT_ENDOWMENTS,
+            ...allEndowments
+        ])
+    ];
+}
+
+//# sourceMappingURL=specifications.js.map

package/dist/esm/internals/simulation/methods/specifications.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/internals/simulation/methods/specifications.ts"],"sourcesContent":["import type { GenericPermissionController } from '@metamask/permission-controller';\nimport {\n  endowmentPermissionBuilders,\n  buildSnapEndowmentSpecifications,\n  buildSnapRestrictedMethodSpecifications,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DEFAULT_ENDOWMENTS } from '@metamask/snaps-utils';\n\nimport type { RootControllerMessenger } from '../controllers';\nimport type { SimulationOptions } from '../options';\nimport type { RunSagaFunction } from '../store';\nimport {\n  EXCLUDED_SNAP_ENDOWMENTS,\n  EXCLUDED_SNAP_PERMISSIONS,\n} from './constants';\nimport {\n  getGetLocaleMethodImplementation,\n  getClearSnapStateMethodImplementation,\n  getGetSnapStateMethodImplementation,\n  getUpdateSnapStateMethodImplementation,\n  getShowDialogImplementation,\n  getShowInAppNotificationImplementation,\n  getShowNativeNotificationImplementation,\n  encryptImplementation,\n  decryptImplementation,\n  getCreateInterfaceImplementation,\n  getGetInterfaceImplementation,\n} from './hooks';\n\nexport type PermissionSpecificationsHooks = {\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\nexport type GetPermissionSpecificationsOptions = {\n  controllerMessenger: RootControllerMessenger;\n  hooks: PermissionSpecificationsHooks;\n  runSaga: RunSagaFunction;\n  options: SimulationOptions;\n};\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return.\n * @returns The function implementation.\n */\nexport function resolve(result: unknown) {\n  return () => result;\n}\n\n/**\n * Get a function which resolves with the specified result.\n *\n * @param result - The result to return. If not specified, the function will\n * resolve with `undefined`.\n * @returns The function implementation.\n */\nexport function asyncResolve(result?: unknown) {\n  return async () => result;\n}\n\n/**\n * Get the permission specifications for the Snap.\n *\n * @param options - The options.\n * @param options.controllerMessenger - The controller messenger.\n * @param options.hooks - The hooks.\n * @param options.runSaga - The function to run a saga outside the usual Redux\n * flow.\n * @param options.options - The simulation options.\n * @returns The permission specifications for the Snap.\n */\nexport function getPermissionSpecifications({\n  controllerMessenger,\n  hooks,\n  runSaga,\n  options,\n}: GetPermissionSpecificationsOptions) {\n  return {\n    ...buildSnapEndowmentSpecifications(EXCLUDED_SNAP_ENDOWMENTS),\n    ...buildSnapRestrictedMethodSpecifications(EXCLUDED_SNAP_PERMISSIONS, {\n      // Shared hooks.\n      ...hooks,\n\n      // Encryption and decryption hooks.\n      // TODO: Swap these out for the real implementations.\n      encrypt: encryptImplementation,\n      decrypt: decryptImplementation,\n\n      // Snaps-specific hooks.\n      clearSnapState: getClearSnapStateMethodImplementation(runSaga),\n      getLocale: getGetLocaleMethodImplementation(options),\n      getSnapState: getGetSnapStateMethodImplementation(runSaga),\n      getUnlockPromise: asyncResolve(true),\n\n      // TODO: Allow the user to specify the result of this function.\n      isOnPhishingList: resolve(false),\n\n      maybeUpdatePhishingList: asyncResolve(),\n      showDialog: getShowDialogImplementation(runSaga),\n      showInAppNotification: getShowInAppNotificationImplementation(runSaga),\n      showNativeNotification: getShowNativeNotificationImplementation(runSaga),\n      updateSnapState: getUpdateSnapStateMethodImplementation(runSaga),\n      createInterface: getCreateInterfaceImplementation(controllerMessenger),\n      getInterface: getGetInterfaceImplementation(controllerMessenger),\n    }),\n  };\n}\n\n/**\n * Get the endowments for the Snap.\n *\n * @param permissionController - The permission controller.\n * @param snapId - The ID of the Snap.\n * @returns The endowments for the Snap.\n */\nexport async function getEndowments(\n  permissionController: GenericPermissionController,\n  snapId: SnapId,\n) {\n  const allEndowments = await Object.keys(endowmentPermissionBuilders).reduce<\n    Promise<string[]>\n  >(async (promise, permissionName) => {\n    const accumulator = await promise;\n    if (permissionController.hasPermission(snapId, permissionName)) {\n      const endowments = await permissionController.getEndowments(\n        snapId,\n        permissionName,\n      );\n\n      if (endowments) {\n        return accumulator.concat(endowments as string[]);\n      }\n    }\n\n    return accumulator;\n  }, Promise.resolve([]));\n\n  return [...new Set([...DEFAULT_ENDOWMENTS, ...allEndowments])];\n}\n"],"names":["endowmentPermissionBuilders","buildSnapEndowmentSpecifications","buildSnapRestrictedMethodSpecifications","DEFAULT_ENDOWMENTS","EXCLUDED_SNAP_ENDOWMENTS","EXCLUDED_SNAP_PERMISSIONS","getGetLocaleMethodImplementation","getClearSnapStateMethodImplementation","getGetSnapStateMethodImplementation","getUpdateSnapStateMethodImplementation","getShowDialogImplementation","getShowInAppNotificationImplementation","getShowNativeNotificationImplementation","encryptImplementation","decryptImplementation","getCreateInterfaceImplementation","getGetInterfaceImplementation","resolve","result","asyncResolve","getPermissionSpecifications","controllerMessenger","hooks","runSaga","options","encrypt","decrypt","clearSnapState","getLocale","getSnapState","getUnlockPromise","isOnPhishingList","maybeUpdatePhishingList","showDialog","showInAppNotification","showNativeNotification","updateSnapState","createInterface","getInterface","getEndowments","permissionController","snapId","allEndowments","Object","keys","reduce","promise","permissionName","accumulator","hasPermission","endowments","concat","Promise","Set"],"mappings":"AACA,SACEA,2BAA2B,EAC3BC,gCAAgC,EAChCC,uCAAuC,QAClC,8BAA8B;AAErC,SAASC,kBAAkB,QAAQ,wBAAwB;AAK3D,SACEC,wBAAwB,EACxBC,yBAAyB,QACpB,cAAc;AACrB,SACEC,gCAAgC,EAChCC,qCAAqC,EACrCC,mCAAmC,EACnCC,sCAAsC,EACtCC,2BAA2B,EAC3BC,sCAAsC,EACtCC,uCAAuC,EACvCC,qBAAqB,EACrBC,qBAAqB,EACrBC,gCAAgC,EAChCC,6BAA6B,QACxB,UAAU;AAkBjB;;;;;CAKC,GACD,OAAO,SAASC,QAAQC,MAAe;IACrC,OAAO,IAAMA;AACf;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,aAAaD,MAAgB;IAC3C,OAAO,UAAYA;AACrB;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASE,4BAA4B,EAC1CC,mBAAmB,EACnBC,KAAK,EACLC,OAAO,EACPC,OAAO,EAC4B;IACnC,OAAO;QACL,GAAGvB,iCAAiCG,yBAAyB;QAC7D,GAAGF,wCAAwCG,2BAA2B;YACpE,gBAAgB;YAChB,GAAGiB,KAAK;YAER,mCAAmC;YACnC,qDAAqD;YACrDG,SAASZ;YACTa,SAASZ;YAET,wBAAwB;YACxBa,gBAAgBpB,sCAAsCgB;YACtDK,WAAWtB,iCAAiCkB;YAC5CK,cAAcrB,oCAAoCe;YAClDO,kBAAkBX,aAAa;YAE/B,+DAA+D;YAC/DY,kBAAkBd,QAAQ;YAE1Be,yBAAyBb;YACzBc,YAAYvB,4BAA4Ba;YACxCW,uBAAuBvB,uCAAuCY;YAC9DY,wBAAwBvB,wCAAwCW;YAChEa,iBAAiB3B,uCAAuCc;YACxDc,iBAAiBtB,iCAAiCM;YAClDiB,cAActB,8BAA8BK;QAC9C,EAAE;IACJ;AACF;AAEA;;;;;;CAMC,GACD,OAAO,eAAekB,cACpBC,oBAAiD,EACjDC,MAAc;IAEd,MAAMC,gBAAgB,MAAMC,OAAOC,IAAI,CAAC5C,6BAA6B6C,MAAM,CAEzE,OAAOC,SAASC;QAChB,MAAMC,cAAc,MAAMF;QAC1B,IAAIN,qBAAqBS,aAAa,CAACR,QAAQM,iBAAiB;YAC9D,MAAMG,aAAa,MAAMV,qBAAqBD,aAAa,CACzDE,QACAM;YAGF,IAAIG,YAAY;gBACd,OAAOF,YAAYG,MAAM,CAACD;YAC5B;QACF;QAEA,OAAOF;IACT,GAAGI,QAAQnC,OAAO,CAAC,EAAE;IAErB,OAAO;WAAI,IAAIoC,IAAI;eAAIlD;eAAuBuC;SAAc;KAAE;AAChE"}

package/dist/esm/internals/simulation/middleware/engine.js

@@ -0,0 +1,33 @@
+import { createFetchMiddleware } from '@metamask/eth-json-rpc-middleware';
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
+import { createSnapsMethodMiddleware } from '@metamask/snaps-rpc-methods';
+import { DEFAULT_JSON_RPC_ENDPOINT } from '../constants';
+import { createInternalMethodsMiddleware } from './internal-methods';
+import { createMockMiddleware } from './mock';
+/**
+ * Create a JSON-RPC engine for use in a simulated environment. This engine
+ * should be used to handle all JSON-RPC requests. It is set up to handle
+ * requests that would normally be handled internally by the MetaMask client, as
+ * well as Snap-specific requests.
+ *
+ * @param options - The options to use when creating the engine.
+ * @param options.store - The Redux store to use.
+ * @param options.hooks - Any hooks used by the middleware handlers.
+ * @param options.permissionMiddleware - The permission middleware to use.
+ * @param options.endpoint - The JSON-RPC endpoint to use for Ethereum requests.
+ * @returns A JSON-RPC engine.
+ */ export function createJsonRpcEngine({ store, hooks, permissionMiddleware, endpoint = DEFAULT_JSON_RPC_ENDPOINT }) {
+    const engine = new JsonRpcEngine();
+    engine.push(createMockMiddleware(store));
+    engine.push(createInternalMethodsMiddleware(hooks));
+    engine.push(createSnapsMethodMiddleware(true, hooks));
+    engine.push(permissionMiddleware);
+    engine.push(createFetchMiddleware({
+        btoa: globalThis.btoa,
+        fetch: globalThis.fetch,
+        rpcUrl: endpoint
+    }));
+    return engine;
+}
+
+//# sourceMappingURL=engine.js.map

package/dist/esm/internals/simulation/middleware/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/internals/simulation/middleware/engine.ts"],"sourcesContent":["import { createFetchMiddleware } from '@metamask/eth-json-rpc-middleware';\nimport type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport type { RestrictedMethodParameters } from '@metamask/permission-controller';\nimport { createSnapsMethodMiddleware } from '@metamask/snaps-rpc-methods';\nimport type { Json } from '@metamask/utils';\n\nimport { DEFAULT_JSON_RPC_ENDPOINT } from '../constants';\nimport type { MiddlewareHooks } from '../simulation';\nimport type { Store } from '../store';\nimport { createInternalMethodsMiddleware } from './internal-methods';\nimport { createMockMiddleware } from './mock';\n\nexport type CreateJsonRpcEngineOptions = {\n  store: Store;\n  hooks: MiddlewareHooks;\n  permissionMiddleware: JsonRpcMiddleware<RestrictedMethodParameters, Json>;\n  endpoint?: string;\n};\n\n/**\n * Create a JSON-RPC engine for use in a simulated environment. This engine\n * should be used to handle all JSON-RPC requests. It is set up to handle\n * requests that would normally be handled internally by the MetaMask client, as\n * well as Snap-specific requests.\n *\n * @param options - The options to use when creating the engine.\n * @param options.store - The Redux store to use.\n * @param options.hooks - Any hooks used by the middleware handlers.\n * @param options.permissionMiddleware - The permission middleware to use.\n * @param options.endpoint - The JSON-RPC endpoint to use for Ethereum requests.\n * @returns A JSON-RPC engine.\n */\nexport function createJsonRpcEngine({\n  store,\n  hooks,\n  permissionMiddleware,\n  endpoint = DEFAULT_JSON_RPC_ENDPOINT,\n}: CreateJsonRpcEngineOptions) {\n  const engine = new JsonRpcEngine();\n  engine.push(createMockMiddleware(store));\n  engine.push(createInternalMethodsMiddleware(hooks));\n  engine.push(createSnapsMethodMiddleware(true, hooks));\n  engine.push(permissionMiddleware);\n  engine.push(\n    createFetchMiddleware({\n      btoa: globalThis.btoa,\n      fetch: globalThis.fetch,\n      rpcUrl: endpoint,\n    }),\n  );\n\n  return engine;\n}\n"],"names":["createFetchMiddleware","JsonRpcEngine","createSnapsMethodMiddleware","DEFAULT_JSON_RPC_ENDPOINT","createInternalMethodsMiddleware","createMockMiddleware","createJsonRpcEngine","store","hooks","permissionMiddleware","endpoint","engine","push","btoa","globalThis","fetch","rpcUrl"],"mappings":"AAAA,SAASA,qBAAqB,QAAQ,oCAAoC;AAE1E,SAASC,aAAa,QAAQ,4BAA4B;AAE1D,SAASC,2BAA2B,QAAQ,8BAA8B;AAG1E,SAASC,yBAAyB,QAAQ,eAAe;AAGzD,SAASC,+BAA+B,QAAQ,qBAAqB;AACrE,SAASC,oBAAoB,QAAQ,SAAS;AAS9C;;;;;;;;;;;;CAYC,GACD,OAAO,SAASC,oBAAoB,EAClCC,KAAK,EACLC,KAAK,EACLC,oBAAoB,EACpBC,WAAWP,yBAAyB,EACT;IAC3B,MAAMQ,SAAS,IAAIV;IACnBU,OAAOC,IAAI,CAACP,qBAAqBE;IACjCI,OAAOC,IAAI,CAACR,gCAAgCI;IAC5CG,OAAOC,IAAI,CAACV,4BAA4B,MAAMM;IAC9CG,OAAOC,IAAI,CAACH;IACZE,OAAOC,IAAI,CACTZ,sBAAsB;QACpBa,MAAMC,WAAWD,IAAI;QACrBE,OAAOD,WAAWC,KAAK;QACvBC,QAAQN;IACV;IAGF,OAAOC;AACT"}

package/dist/esm/internals/simulation/middleware/index.js

@@ -0,0 +1,3 @@
+export * from './engine';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/internals/simulation/middleware/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../src/internals/simulation/middleware/index.ts"],"sourcesContent":["export * from './engine';\n"],"names":[],"mappings":"AAAA,cAAc,WAAW"}

package/dist/esm/internals/simulation/middleware/internal-methods/accounts.js

@@ -0,0 +1,31 @@
+import { BIP44Node } from '@metamask/key-tree';
+/**
+ * A mock handler for account related methods that always returns the first
+ * address for the selected secret recovery phrase.
+ *
+ * @param _request - Incoming JSON-RPC request. This is ignored for this
+ * specific handler.
+ * @param response - The outgoing JSON-RPC response, modified to return the
+ * result.
+ * @param _next - The `json-rpc-engine` middleware next handler.
+ * @param end - The `json-rpc-engine` middleware end handler.
+ * @param hooks - Any hooks required by this handler.
+ */ export async function getAccountsHandler(_request, response, _next, end, hooks) {
+    const { getMnemonic } = hooks;
+    const node = await BIP44Node.fromDerivationPath({
+        derivationPath: [
+            await getMnemonic(),
+            `bip32:44'`,
+            `bip32:60'`,
+            `bip32:0'`,
+            `bip32:0`,
+            `bip32:0`
+        ]
+    });
+    response.result = [
+        node.address
+    ];
+    return end();
+}
+
+//# sourceMappingURL=accounts.js.map

package/dist/esm/internals/simulation/middleware/internal-methods/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/middleware/internal-methods/accounts.ts"],"sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport { BIP44Node } from '@metamask/key-tree';\nimport type {\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\nexport type GetAccountsHandlerHooks = {\n  getMnemonic: () => Promise<Uint8Array>;\n};\n\n/**\n * A mock handler for account related methods that always returns the first\n * address for the selected secret recovery phrase.\n *\n * @param _request - Incoming JSON-RPC request. This is ignored for this\n * specific handler.\n * @param response - The outgoing JSON-RPC response, modified to return the\n * result.\n * @param _next - The `json-rpc-engine` middleware next handler.\n * @param end - The `json-rpc-engine` middleware end handler.\n * @param hooks - Any hooks required by this handler.\n */\nexport async function getAccountsHandler(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<Json>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n  hooks: GetAccountsHandlerHooks,\n) {\n  const { getMnemonic } = hooks;\n\n  const node = await BIP44Node.fromDerivationPath({\n    derivationPath: [\n      await getMnemonic(),\n      `bip32:44'`,\n      `bip32:60'`,\n      `bip32:0'`,\n      `bip32:0`,\n      `bip32:0`,\n    ],\n  });\n\n  response.result = [node.address];\n  return end();\n}\n"],"names":["BIP44Node","getAccountsHandler","_request","response","_next","end","hooks","getMnemonic","node","fromDerivationPath","derivationPath","result","address"],"mappings":"AAIA,SAASA,SAAS,QAAQ,qBAAqB;AAW/C;;;;;;;;;;;CAWC,GACD,OAAO,eAAeC,mBACpBC,QAAwB,EACxBC,QAAsC,EACtCC,KAAgC,EAChCC,GAA6B,EAC7BC,KAA8B;IAE9B,MAAM,EAAEC,WAAW,EAAE,GAAGD;IAExB,MAAME,OAAO,MAAMR,UAAUS,kBAAkB,CAAC;QAC9CC,gBAAgB;YACd,MAAMH;YACN,CAAC,SAAS,CAAC;YACX,CAAC,SAAS,CAAC;YACX,CAAC,QAAQ,CAAC;YACV,CAAC,OAAO,CAAC;YACT,CAAC,OAAO,CAAC;SACV;IACH;IAEAJ,SAASQ,MAAM,GAAG;QAACH,KAAKI,OAAO;KAAC;IAChC,OAAOP;AACT"}

package/dist/esm/internals/simulation/middleware/internal-methods/index.js

@@ -0,0 +1,3 @@
+export * from './middleware';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/internals/simulation/middleware/internal-methods/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/middleware/internal-methods/index.ts"],"sourcesContent":["export * from './middleware';\n"],"names":[],"mappings":"AAAA,cAAc,eAAe"}

package/dist/esm/internals/simulation/middleware/internal-methods/middleware.js

@@ -0,0 +1,37 @@
+import { logError } from '@metamask/snaps-utils';
+import { getAccountsHandler } from './accounts';
+import { getProviderStateHandler } from './provider-state';
+const methodHandlers = {
+    /* eslint-disable @typescript-eslint/naming-convention */ metamask_getProviderState: getProviderStateHandler,
+    eth_requestAccounts: getAccountsHandler,
+    eth_accounts: getAccountsHandler
+};
+/**
+ * Create a middleware for handling JSON-RPC methods normally handled internally
+ * by the MetaMask client.
+ *
+ * NOTE: This middleware provides all `hooks` to all handlers and should
+ * therefore NOT be used outside of the simulation environment. It is intended
+ * for testing purposes only.
+ *
+ * @param hooks - Any hooks used by the middleware handlers.
+ * @returns A middleware function.
+ */ export function createInternalMethodsMiddleware(hooks) {
+    // This should probably use createAsyncMiddleware.
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    return async function methodMiddleware(request, response, next, end) {
+        const handler = methodHandlers[request.method];
+        if (handler) {
+            try {
+                // Implementations may or may not be async, so we must await them.
+                return await handler(request, response, next, end, hooks);
+            } catch (error) {
+                logError(error);
+                return end(error);
+            }
+        }
+        return next();
+    };
+}
+
+//# sourceMappingURL=middleware.js.map

package/dist/esm/internals/simulation/middleware/internal-methods/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/middleware/internal-methods/middleware.ts"],"sourcesContent":["import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine';\nimport { logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcParams } from '@metamask/utils';\n\nimport { getAccountsHandler } from './accounts';\nimport { getProviderStateHandler } from './provider-state';\n\nexport type InternalMethodsMiddlewareHooks = {\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\nconst methodHandlers = {\n  /* eslint-disable @typescript-eslint/naming-convention */\n  metamask_getProviderState: getProviderStateHandler,\n  eth_requestAccounts: getAccountsHandler,\n  eth_accounts: getAccountsHandler,\n  /* eslint-enable @typescript-eslint/naming-convention */\n};\n\n/**\n * Create a middleware for handling JSON-RPC methods normally handled internally\n * by the MetaMask client.\n *\n * NOTE: This middleware provides all `hooks` to all handlers and should\n * therefore NOT be used outside of the simulation environment. It is intended\n * for testing purposes only.\n *\n * @param hooks - Any hooks used by the middleware handlers.\n * @returns A middleware function.\n */\nexport function createInternalMethodsMiddleware(\n  hooks: InternalMethodsMiddlewareHooks,\n): JsonRpcMiddleware<JsonRpcParams, Json> {\n  // This should probably use createAsyncMiddleware.\n  // eslint-disable-next-line @typescript-eslint/no-misused-promises\n  return async function methodMiddleware(request, response, next, end) {\n    const handler =\n      methodHandlers[request.method as keyof typeof methodHandlers];\n    if (handler) {\n      try {\n        // Implementations may or may not be async, so we must await them.\n        return await handler(request, response, next, end, hooks);\n      } catch (error: any) {\n        logError(error);\n        return end(error);\n      }\n    }\n\n    return next();\n  };\n}\n"],"names":["logError","getAccountsHandler","getProviderStateHandler","methodHandlers","metamask_getProviderState","eth_requestAccounts","eth_accounts","createInternalMethodsMiddleware","hooks","methodMiddleware","request","response","next","end","handler","method","error"],"mappings":"AACA,SAASA,QAAQ,QAAQ,wBAAwB;AAGjD,SAASC,kBAAkB,QAAQ,aAAa;AAChD,SAASC,uBAAuB,QAAQ,mBAAmB;AAW3D,MAAMC,iBAAiB;IACrB,uDAAuD,GACvDC,2BAA2BF;IAC3BG,qBAAqBJ;IACrBK,cAAcL;AAEhB;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASM,gCACdC,KAAqC;IAErC,kDAAkD;IAClD,kEAAkE;IAClE,OAAO,eAAeC,iBAAiBC,OAAO,EAAEC,QAAQ,EAAEC,IAAI,EAAEC,GAAG;QACjE,MAAMC,UACJX,cAAc,CAACO,QAAQK,MAAM,CAAgC;QAC/D,IAAID,SAAS;YACX,IAAI;gBACF,kEAAkE;gBAClE,OAAO,MAAMA,QAAQJ,SAASC,UAAUC,MAAMC,KAAKL;YACrD,EAAE,OAAOQ,OAAY;gBACnBhB,SAASgB;gBACT,OAAOH,IAAIG;YACb;QACF;QAEA,OAAOJ;IACT;AACF"}

package/dist/esm/internals/simulation/middleware/internal-methods/provider-state.js

@@ -0,0 +1,23 @@
+/**
+ * A mock handler for metamask_getProviderState that always returns a specific
+ * hardcoded result.
+ *
+ * @param _request - Incoming JSON-RPC request. Ignored for this specific
+ * handler.
+ * @param response - The outgoing JSON-RPC response, modified to return the
+ * result.
+ * @param _next - The `json-rpc-engine` middleware next handler.
+ * @param end - The `json-rpc-engine` middleware end handler.
+ */ export async function getProviderStateHandler(_request, response, _next, end) {
+    // For now this will return a mocked result, this should probably match
+    // whatever network the simulation is using.
+    response.result = {
+        isUnlocked: true,
+        chainId: '0x01',
+        networkVersion: '0x01',
+        accounts: []
+    };
+    return end();
+}
+
+//# sourceMappingURL=provider-state.js.map

package/dist/esm/internals/simulation/middleware/internal-methods/provider-state.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../src/internals/simulation/middleware/internal-methods/provider-state.ts"],"sourcesContent":["import type {\n  JsonRpcEngineEndCallback,\n  JsonRpcEngineNextCallback,\n} from '@metamask/json-rpc-engine';\nimport type {\n  Json,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\n\n/**\n * A mock handler for metamask_getProviderState that always returns a specific\n * hardcoded result.\n *\n * @param _request - Incoming JSON-RPC request. Ignored for this specific\n * handler.\n * @param response - The outgoing JSON-RPC response, modified to return the\n * result.\n * @param _next - The `json-rpc-engine` middleware next handler.\n * @param end - The `json-rpc-engine` middleware end handler.\n */\nexport async function getProviderStateHandler(\n  _request: JsonRpcRequest,\n  response: PendingJsonRpcResponse<Json>,\n  _next: JsonRpcEngineNextCallback,\n  end: JsonRpcEngineEndCallback,\n) {\n  // For now this will return a mocked result, this should probably match\n  // whatever network the simulation is using.\n  response.result = {\n    isUnlocked: true,\n    chainId: '0x01',\n    networkVersion: '0x01',\n    accounts: [],\n  };\n\n  return end();\n}\n"],"names":["getProviderStateHandler","_request","response","_next","end","result","isUnlocked","chainId","networkVersion","accounts"],"mappings":"AAUA;;;;;;;;;;CAUC,GACD,OAAO,eAAeA,wBACpBC,QAAwB,EACxBC,QAAsC,EACtCC,KAAgC,EAChCC,GAA6B;IAE7B,uEAAuE;IACvE,4CAA4C;IAC5CF,SAASG,MAAM,GAAG;QAChBC,YAAY;QACZC,SAAS;QACTC,gBAAgB;QAChBC,UAAU,EAAE;IACd;IAEA,OAAOL;AACT"}