Add snap_getState, snap_setState, snap_clearState methods (#2916)

Author: Mrtenz

packages/examples/packages/browserify-plugin/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "REliam7FRJGwKCI4NaC2G3mBSD5iYR7DCEhrXLcBDqA=",
+    "shasum": "82KbG3cf0wtxooJpWzHeM1g4FhO8O7zSYCAAGNPshfM=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/examples/packages/browserify/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "NItYOhAaWlS9q2r59/zlpoyVUyxojfsc5xMh65mLIwQ=",
+    "shasum": "5LsB950haZGnl0q5K7M4XgSh5J2e0p5O1Ptl/e6kpSQ=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/examples/packages/manage-state/package.json

@@ -43,7 +43,8 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/snaps-sdk": "workspace:^"
+    "@metamask/snaps-sdk": "workspace:^",
+    "@metamask/utils": "^10.0.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",

packages/examples/packages/manage-state/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "source": {
-    "shasum": "3jbTBm2Gtm5+qWdWgNR2sgwEGwWmKsGK7QPeXN9yOpE=",
+    "shasum": "fIXije73reQctVWFkOL9kdLWns7uDs7UWbPPL1J0f2o=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/examples/packages/manage-state/src/index.test.ts

@@ -20,13 +20,13 @@ describe('onRpcRequest', () => {
     });
   });
 
-  describe('setState', () => {
+  describe('legacy_setState', () => {
     it('sets the state to the params', async () => {
       const { request } = await installSnap();
 
       expect(
         await request({
-          method: 'setState',
+          method: 'legacy_setState',
           params: {
             items: ['foo'],
           },
@@ -35,7 +35,7 @@ describe('onRpcRequest', () => {
 
       expect(
         await request({
-          method: 'getState',
+          method: 'legacy_getState',
         }),
       ).toRespondWith({
         items: ['foo'],
@@ -47,7 +47,7 @@ describe('onRpcRequest', () => {
 
       expect(
         await request({
-          method: 'setState',
+          method: 'legacy_setState',
           params: {
             items: ['foo'],
             encrypted: false,
@@ -57,15 +57,15 @@ describe('onRpcRequest', () => {
 
       expect(
         await request({
-          method: 'getState',
+          method: 'legacy_getState',
         }),
       ).toRespondWith({
         items: [],
       });
 
       expect(
         await request({
-          method: 'getState',
+          method: 'legacy_getState',
           params: {
             encrypted: false,
           },
@@ -76,12 +76,12 @@ describe('onRpcRequest', () => {
     });
   });
 
-  describe('getState', () => {
+  describe('legacy_getState', () => {
     it('returns the state if no state has been set', async () => {
       const { request } = await installSnap();
 
       const response = await request({
-        method: 'getState',
+        method: 'legacy_getState',
       });
 
       expect(response).toRespondWith({
@@ -93,14 +93,14 @@ describe('onRpcRequest', () => {
       const { request } = await installSnap();
 
       await request({
-        method: 'setState',
+        method: 'legacy_setState',
         params: {
           items: ['foo'],
         },
       });
 
       const response = await request({
-        method: 'getState',
+        method: 'legacy_getState',
       });
 
       expect(response).toRespondWith({
@@ -118,7 +118,7 @@ describe('onRpcRequest', () => {
       });
 
       const response = await request({
-        method: 'getState',
+        method: 'legacy_getState',
         params: {
           encrypted: false,
         },
@@ -130,26 +130,26 @@ describe('onRpcRequest', () => {
     });
   });
 
-  describe('clearState', () => {
+  describe('legacy_clearState', () => {
     it('clears the state', async () => {
       const { request } = await installSnap();
 
       await request({
-        method: 'setState',
+        method: 'legacy_setState',
         params: {
           items: ['foo'],
         },
       });
 
       expect(
         await request({
-          method: 'clearState',
+          method: 'legacy_clearState',
         }),
       ).toRespondWith(true);
 
       expect(
         await request({
-          method: 'getState',
+          method: 'legacy_getState',
         }),
       ).toRespondWith({
         items: [],
@@ -160,7 +160,7 @@ describe('onRpcRequest', () => {
       const { request } = await installSnap();
 
       await request({
-        method: 'setState',
+        method: 'legacy_setState',
         params: {
           items: ['foo'],
           encrypted: false,
@@ -169,7 +169,7 @@ describe('onRpcRequest', () => {
 
       expect(
         await request({
-          method: 'clearState',
+          method: 'legacy_clearState',
           params: {
             encrypted: false,
           },
@@ -178,7 +178,7 @@ describe('onRpcRequest', () => {
 
       expect(
         await request({
-          method: 'getState',
+          method: 'legacy_getState',
           params: {
             encrypted: false,
           },

packages/examples/packages/manage-state/src/index.ts

@@ -3,7 +3,12 @@ import {
   type OnRpcRequestHandler,
 } from '@metamask/snaps-sdk';
 
-import type { BaseParams, SetStateParams } from './types';
+import type {
+  BaseParams,
+  LegacyParams,
+  LegacySetStateParams,
+  SetStateParams,
+} from './types';
 import { clearState, getState, setState } from './utils';
 
 /**
@@ -34,21 +39,55 @@ export const onRpcRequest: OnRpcRequestHandler = async ({ request }) => {
   switch (request.method) {
     case 'setState': {
       const params = request.params as SetStateParams;
+      return await snap.request({
+        method: 'snap_setState',
+        params: {
+          key: params?.key,
+          value: params?.value,
+          encrypted: params?.encrypted,
+        },
+      });
+    }
+
+    case 'getState': {
+      const params = request.params as BaseParams;
+      return await snap.request({
+        method: 'snap_getState',
+        params: {
+          key: params?.key,
+          encrypted: params?.encrypted,
+        },
+      });
+    }
 
+    case 'clearState': {
+      const params = request.params as BaseParams;
+      return await snap.request({
+        method: 'snap_clearState',
+        params: {
+          encrypted: params?.encrypted,
+        },
+      });
+    }
+
+    case 'legacy_setState': {
+      const params = request.params as LegacySetStateParams;
       if (params.items) {
         await setState({ items: params.items }, params.encrypted);
       }
+
       return true;
     }
 
-    case 'getState': {
-      const params = request.params as BaseParams;
+    case 'legacy_getState': {
+      const params = request.params as LegacyParams;
       return await getState(params?.encrypted);
     }
 
-    case 'clearState': {
-      const params = request.params as BaseParams;
+    case 'legacy_clearState': {
+      const params = request.params as LegacyParams;
       await clearState(params?.encrypted);
+
       return true;
     }
 

packages/examples/packages/manage-state/src/types.ts

@@ -1,10 +1,19 @@
+import type { Json } from '@metamask/utils';
+
 import type { State } from './utils';
 
-export type BaseParams = { encrypted?: boolean };
+export type LegacyParams = { encrypted?: boolean };
+
+export type BaseParams = { key?: string; encrypted?: boolean };
 
 /**
  * The parameters for the `setState` JSON-RPC method.
- *
- * The current state will be merged with the new state.
  */
-export type SetStateParams = BaseParams & Partial<State>;
+export type SetStateParams = BaseParams & {
+  value: Json;
+};
+
+/**
+ * The parameters for the `legacy_setState` JSON-RPC method.
+ */
+export type LegacySetStateParams = LegacyParams & Partial<State>;

packages/snaps-rpc-methods/jest.config.js

@@ -10,10 +10,10 @@ module.exports = deepmerge(baseConfig, {
   ],
   coverageThreshold: {
     global: {
-      branches: 92.94,
-      functions: 97.29,
-      lines: 97.88,
-      statements: 97.41,
+      branches: 93.33,
+      functions: 97.46,
+      lines: 98.03,
+      statements: 97.61,
     },
   },
 });