Breaking changes for Snaps in MetaMask Flask 10.17

[Montoya]

The following are breaking changes for Snaps in the upcoming release of MetaMask Flask 10.17:

Migration to CommonJS style module export

CommonJS style module export: deprecate wallet.registerRpcMessageHandler(...) and use module.exports.onRpcRequest = ... instead. As part of this change, the arguments of the function to be named were changed as well. See the examples below.

Old style:

wallet.registerRpcMessageHandler(async (originString, requestObject) => {
  switch (requestObject.method) {
    case 'add':
      return await ipfs.add(requestObject.params[0]);
    case 'cat':
      return await ipfs.cat(requestObject.params[0]);
    default:
      throw rpcErrors.eth.methodNotFound(requestObject);
  }
});

New style:

module.exports.onRpcRequest = async ({ origin, request }) => {
  switch (request.method) {
    case 'add':
      return await ipfs.add(request.params[0]);
    case 'cat':
      return await ipfs.cat(request.params[0]);
    default:
      throw rpcErrors.eth.methodNotFound(request);
  }
};

Encrypting snap state by default

Snap state (data stored with the manageState permission) will be encrypted by default. Any snap with stored state will need to be re-installed and the prior data will be lost.