@metamask/snaps-controllers 2.0.2 → 3.0.0

package/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0]
+### Added
+- Add keyring export and endowment ([#1787](https://github.com/MetaMask/snaps/pull/1787))
+- Add optional `allowedOrigins` field to `endowment:rpc` ([#1822](https://github.com/MetaMask/snaps/pull/1822))
+  - This can be used to only accept certain origins in your Snap.
+
+### Changed
+- **BREAKING:** Bump minimum Node.js version to `^18.16.0` ([#1741](https://github.com/MetaMask/snaps/pull/1741))
+
 ## [2.0.2]
 ### Added
 - Add `SnapController:snapUninstalled` event ([#1800](https://github.com/MetaMask/snaps/pull/1800))
@@ -63,7 +72,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@2.0.2...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@2.0.2...@metamask/snaps-controllers@3.0.0
 [2.0.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@2.0.1...@metamask/snaps-controllers@2.0.2
 [2.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@2.0.0...@metamask/snaps-controllers@2.0.1
 [2.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@0.39.0-flask.1...@metamask/snaps-controllers@2.0.0

package/dist/cjs/fsm.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fsm.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\nimport type { EventObject, StateMachine, Typestate } from '@xstate/fsm';\nimport { InterpreterStatus } from '@xstate/fsm';\n\n/**\n * Validates the set-up of a @xstate/fsm machine.\n *\n * 1. Ensures that all named actions in the config have a provided implementation.\n *\n * @param machine - The machine to validate.\n * @throws {@link AssertionError}. If the validation fails.\n */\nexport function validateMachine<\n  TContext extends object,\n  TEvent extends EventObject,\n  TState extends Typestate<TContext>,\n>(machine: StateMachine.Machine<TContext, TEvent, TState>) {\n  assert('_options' in machine, 'The machine is not an @xstate/fsm machine');\n  const typed = machine as StateMachine.Machine<TContext, TEvent, TState> & {\n    _options: { actions?: StateMachine.ActionMap<TContext, TEvent> };\n  };\n\n  // 1.\n  const toArray = <Type>(obj: Type | Type[]): Type[] => {\n    if (Array.isArray(obj)) {\n      return obj;\n    } else if (obj === undefined || obj === null) {\n      return [];\n    }\n    return [obj];\n  };\n\n  const allActions = new Set<string>();\n  const addActions = (actions: any) =>\n    toArray(actions)\n      .flatMap((action) => {\n        if (typeof action === 'string') {\n          return [action];\n        }\n        assert(typeof action === 'function');\n        return [];\n      })\n      .forEach(allActions.add.bind(allActions));\n\n  for (const state of Object.values<typeof typed.config.states[string]>(\n    typed.config.states,\n  )) {\n    addActions(state.entry);\n    addActions(state.exit);\n    for (const transition of Object.values<any>(state.on ?? {})) {\n      addActions(transition.actions);\n    }\n  }\n\n  allActions.forEach((action) =>\n    assert(\n      typed._options.actions !== undefined && action in typed._options.actions,\n      `Action \"${action}\" doesn't have an implementation`,\n    ),\n  );\n}\n\n/**\n * Ensure that the interpreter is strict.\n * Strict means that the transition must occur.\n * The event must exist in .on {} state config and it's guard must succeed.\n *\n * The error will be thrown when an invalid `interpreter.send()` is called\n * and will be bubbled there.\n *\n * TODO(ritave): Doesn't support self transitions.\n *\n * @param interpreter - The interpreter that will be force into strict mode.\n * @throws {@link Error} Thrown when the transition is invalid.\n */\nexport function forceStrict(interpreter: StateMachine.Service<any, any, any>) {\n  // As soon as a listener subscribes, it is called. It might be called in\n  // an initial state which doesn't have the .changed property\n  let onInitialCalled = false;\n  interpreter.subscribe((state) => {\n    assert(!onInitialCalled || state.changed, 'Invalid state transition');\n    onInitialCalled = true;\n  });\n\n  const ogSend = interpreter.send.bind(interpreter);\n  interpreter.send = (...args) => {\n    assert(\n      interpreter.status === InterpreterStatus.Running,\n      'Interpreter is stopped',\n    );\n    return ogSend(...args);\n  };\n}\n"],"names":["validateMachine","forceStrict","machine","assert","typed","toArray","obj","Array","isArray","undefined","allActions","Set","addActions","actions","flatMap","action","forEach","add","bind","state","Object","values","config","states","entry","exit","transition","on","_options","interpreter","onInitialCalled","subscribe","changed","ogSend","send","args","status","InterpreterStatus","Running"],"mappings":";;;;;;;;;;;IAYgBA,eAAe;eAAfA;;IA+DAC,WAAW;eAAXA;;;uBA3EO;qBAEW;AAU3B,SAASD,gBAIdE,OAAuD;IACvDC,IAAAA,aAAM,EAAC,cAAcD,SAAS;IAC9B,MAAME,QAAQF;IAId,KAAK;IACL,MAAMG,UAAU,CAAOC;QACrB,IAAIC,MAAMC,OAAO,CAACF,MAAM;YACtB,OAAOA;QACT,OAAO,IAAIA,QAAQG,aAAaH,QAAQ,MAAM;YAC5C,OAAO,EAAE;QACX;QACA,OAAO;YAACA;SAAI;IACd;IAEA,MAAMI,aAAa,IAAIC;IACvB,MAAMC,aAAa,CAACC,UAClBR,QAAQQ,SACLC,OAAO,CAAC,CAACC;YACR,IAAI,OAAOA,WAAW,UAAU;gBAC9B,OAAO;oBAACA;iBAAO;YACjB;YACAZ,IAAAA,aAAM,EAAC,OAAOY,WAAW;YACzB,OAAO,EAAE;QACX,GACCC,OAAO,CAACN,WAAWO,GAAG,CAACC,IAAI,CAACR;IAEjC,KAAK,MAAMS,SAASC,OAAOC,MAAM,CAC/BjB,MAAMkB,MAAM,CAACC,MAAM,EAClB;QACDX,WAAWO,MAAMK,KAAK;QACtBZ,WAAWO,MAAMM,IAAI;QACrB,KAAK,MAAMC,cAAcN,OAAOC,MAAM,CAAMF,MAAMQ,EAAE,IAAI,CAAC,GAAI;YAC3Df,WAAWc,WAAWb,OAAO;QAC/B;IACF;IAEAH,WAAWM,OAAO,CAAC,CAACD,SAClBZ,IAAAA,aAAM,EACJC,MAAMwB,QAAQ,CAACf,OAAO,KAAKJ,aAAaM,UAAUX,MAAMwB,QAAQ,CAACf,OAAO,EACxE,CAAC,QAAQ,EAAEE,OAAO,gCAAgC,CAAC;AAGzD;AAeO,SAASd,YAAY4B,WAAgD;IAC1E,wEAAwE;IACxE,4DAA4D;IAC5D,IAAIC,kBAAkB;IACtBD,YAAYE,SAAS,CAAC,CAACZ;QACrBhB,IAAAA,aAAM,EAAC,CAAC2B,mBAAmBX,MAAMa,OAAO,EAAE;QAC1CF,kBAAkB;IACpB;IAEA,MAAMG,SAASJ,YAAYK,IAAI,CAAChB,IAAI,CAACW;IACrCA,YAAYK,IAAI,GAAG,CAAC,GAAGC;QACrBhC,IAAAA,aAAM,EACJ0B,YAAYO,MAAM,KAAKC,sBAAiB,CAACC,OAAO,EAChD;QAEF,OAAOL,UAAUE;IACnB;AACF"}
+{"version":3,"sources":["../../src/fsm.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\nimport type { EventObject, StateMachine, Typestate } from '@xstate/fsm';\nimport { InterpreterStatus } from '@xstate/fsm';\n\n/**\n * Validates the set-up of a @xstate/fsm machine.\n *\n * 1. Ensures that all named actions in the config have a provided implementation.\n *\n * @param machine - The machine to validate.\n * @throws {@link AssertionError}. If the validation fails.\n */\nexport function validateMachine<\n  TContext extends object,\n  TEvent extends EventObject,\n  TState extends Typestate<TContext>,\n>(machine: StateMachine.Machine<TContext, TEvent, TState>) {\n  assert('_options' in machine, 'The machine is not an @xstate/fsm machine');\n  const typed = machine as StateMachine.Machine<TContext, TEvent, TState> & {\n    _options: { actions?: StateMachine.ActionMap<TContext, TEvent> };\n  };\n\n  // 1.\n  const toArray = <Type>(obj: Type | Type[]): Type[] => {\n    if (Array.isArray(obj)) {\n      return obj;\n    } else if (obj === undefined || obj === null) {\n      return [];\n    }\n    return [obj];\n  };\n\n  const allActions = new Set<string>();\n  const addActions = (actions: any) =>\n    toArray(actions)\n      .flatMap((action) => {\n        if (typeof action === 'string') {\n          return [action];\n        }\n        assert(typeof action === 'function');\n        return [];\n      })\n      .forEach(allActions.add.bind(allActions));\n\n  for (const state of Object.values<(typeof typed.config.states)[string]>(\n    typed.config.states,\n  )) {\n    addActions(state.entry);\n    addActions(state.exit);\n    for (const transition of Object.values<any>(state.on ?? {})) {\n      addActions(transition.actions);\n    }\n  }\n\n  allActions.forEach((action) =>\n    assert(\n      typed._options.actions !== undefined && action in typed._options.actions,\n      `Action \"${action}\" doesn't have an implementation`,\n    ),\n  );\n}\n\n/**\n * Ensure that the interpreter is strict.\n * Strict means that the transition must occur.\n * The event must exist in .on {} state config and it's guard must succeed.\n *\n * The error will be thrown when an invalid `interpreter.send()` is called\n * and will be bubbled there.\n *\n * TODO(ritave): Doesn't support self transitions.\n *\n * @param interpreter - The interpreter that will be force into strict mode.\n * @throws {@link Error} Thrown when the transition is invalid.\n */\nexport function forceStrict(interpreter: StateMachine.Service<any, any, any>) {\n  // As soon as a listener subscribes, it is called. It might be called in\n  // an initial state which doesn't have the .changed property\n  let onInitialCalled = false;\n  interpreter.subscribe((state) => {\n    assert(!onInitialCalled || state.changed, 'Invalid state transition');\n    onInitialCalled = true;\n  });\n\n  const ogSend = interpreter.send.bind(interpreter);\n  interpreter.send = (...args) => {\n    assert(\n      interpreter.status === InterpreterStatus.Running,\n      'Interpreter is stopped',\n    );\n    return ogSend(...args);\n  };\n}\n"],"names":["validateMachine","forceStrict","machine","assert","typed","toArray","obj","Array","isArray","undefined","allActions","Set","addActions","actions","flatMap","action","forEach","add","bind","state","Object","values","config","states","entry","exit","transition","on","_options","interpreter","onInitialCalled","subscribe","changed","ogSend","send","args","status","InterpreterStatus","Running"],"mappings":";;;;;;;;;;;IAYgBA,eAAe;eAAfA;;IA+DAC,WAAW;eAAXA;;;uBA3EO;qBAEW;AAU3B,SAASD,gBAIdE,OAAuD;IACvDC,IAAAA,aAAM,EAAC,cAAcD,SAAS;IAC9B,MAAME,QAAQF;IAId,KAAK;IACL,MAAMG,UAAU,CAAOC;QACrB,IAAIC,MAAMC,OAAO,CAACF,MAAM;YACtB,OAAOA;QACT,OAAO,IAAIA,QAAQG,aAAaH,QAAQ,MAAM;YAC5C,OAAO,EAAE;QACX;QACA,OAAO;YAACA;SAAI;IACd;IAEA,MAAMI,aAAa,IAAIC;IACvB,MAAMC,aAAa,CAACC,UAClBR,QAAQQ,SACLC,OAAO,CAAC,CAACC;YACR,IAAI,OAAOA,WAAW,UAAU;gBAC9B,OAAO;oBAACA;iBAAO;YACjB;YACAZ,IAAAA,aAAM,EAAC,OAAOY,WAAW;YACzB,OAAO,EAAE;QACX,GACCC,OAAO,CAACN,WAAWO,GAAG,CAACC,IAAI,CAACR;IAEjC,KAAK,MAAMS,SAASC,OAAOC,MAAM,CAC/BjB,MAAMkB,MAAM,CAACC,MAAM,EAClB;QACDX,WAAWO,MAAMK,KAAK;QACtBZ,WAAWO,MAAMM,IAAI;QACrB,KAAK,MAAMC,cAAcN,OAAOC,MAAM,CAAMF,MAAMQ,EAAE,IAAI,CAAC,GAAI;YAC3Df,WAAWc,WAAWb,OAAO;QAC/B;IACF;IAEAH,WAAWM,OAAO,CAAC,CAACD,SAClBZ,IAAAA,aAAM,EACJC,MAAMwB,QAAQ,CAACf,OAAO,KAAKJ,aAAaM,UAAUX,MAAMwB,QAAQ,CAACf,OAAO,EACxE,CAAC,QAAQ,EAAEE,OAAO,gCAAgC,CAAC;AAGzD;AAeO,SAASd,YAAY4B,WAAgD;IAC1E,wEAAwE;IACxE,4DAA4D;IAC5D,IAAIC,kBAAkB;IACtBD,YAAYE,SAAS,CAAC,CAACZ;QACrBhB,IAAAA,aAAM,EAAC,CAAC2B,mBAAmBX,MAAMa,OAAO,EAAE;QAC1CF,kBAAkB;IACpB;IAEA,MAAMG,SAASJ,YAAYK,IAAI,CAAChB,IAAI,CAACW;IACrCA,YAAYK,IAAI,GAAG,CAAC,GAAGC;QACrBhC,IAAAA,aAAM,EACJ0B,YAAYO,MAAM,KAAKC,sBAAiB,CAACC,OAAO,EAChD;QAEF,OAAOL,UAAUE;IACnB;AACF"}

package/dist/cjs/snaps/SnapController.js

@@ -37,6 +37,7 @@ const _fsm1 = require("../fsm");
 const _logging = require("../logging");
 const _utils1 = require("../utils");
 const _endowments = require("./endowments");
+const _keyring = require("./endowments/keyring");
 const _rpc = require("./endowments/rpc");
 const _location = require("./location");
 const _permissions = require("./permissions");
@@ -920,16 +921,15 @@ class SnapController extends _basecontroller.BaseControllerV2 {
         if (!hasPermission) {
             throw new Error(`Snap "${snapId}" is not permitted to use "${permissionName}".`);
         }
-        if (permissionName === _endowments.SnapEndowments.Rpc) {
+        if (permissionName === _endowments.SnapEndowments.Rpc || permissionName === _endowments.SnapEndowments.Keyring) {
             const subject = this.messagingSystem.call('SubjectMetadataController:getSubjectMetadata', origin);
-            const isSnap = subject?.subjectType === _permissioncontroller.SubjectType.Snap;
             const permissions = this.messagingSystem.call('PermissionController:getPermissions', snapId);
-            const rpcPermission = permissions?.[_endowments.SnapEndowments.Rpc];
-            (0, _utils.assert)(rpcPermission);
-            const origins = (0, _rpc.getRpcCaveatOrigins)(rpcPermission);
+            const handlerPermissions = permissions?.[permissionName];
+            (0, _utils.assert)(handlerPermissions);
+            const origins = permissionName === _endowments.SnapEndowments.Rpc ? (0, _rpc.getRpcCaveatOrigins)(handlerPermissions) : (0, _keyring.getKeyringCaveatOrigins)(handlerPermissions);
             (0, _utils.assert)(origins);
-            if (isSnap && !origins.snaps || !isSnap && !origins.dapps) {
-                throw new Error(`Snap "${snapId}" is not permitted to handle JSON-RPC requests from "${origin}".`);
+            if (!(0, _snapsutils.isOriginAllowed)(origins, subject?.subjectType ?? _permissioncontroller.SubjectType.Website, origin)) {
+                throw new Error(`Snap "${snapId}" is not permitted to handle requests from "${origin}".`);
             }
         }
         const handler = await _class_private_method_get(this, _getRpcRequestHandler, getRpcRequestHandler).call(this, snapId);