feat!: Add snap_getPreferences

packages/snaps-jest/src/internals/simulation/constants.ts

@@ -10,6 +10,11 @@ export const DEFAULT_SRP =
  */
 export const DEFAULT_LOCALE = 'en';
 
+/**
+ * The default currency.
+ */
+export const DEFAULT_CURRENCY = 'usd';
+
 /**
  * The default JSON-RPC endpoint for Ethereum requests.
  */

packages/snaps-jest/src/internals/simulation/methods/hooks/get-preferences.test.ts

@@ -0,0 +1,34 @@
+import { getMockOptions } from '../../../../test-utils/options';
+import { getGetPreferencesMethodImplementation } from './get-preferences';
+
+describe('getGetPreferencesMethodImplementation', () => {
+  it('returns the implementation of the `getPreferences` hook', async () => {
+    const fn = getGetPreferencesMethodImplementation(
+      getMockOptions({
+        locale: 'en',
+      }),
+    );
+
+    expect(fn()).toStrictEqual({ currency: 'usd', locale: 'en' });
+  });
+
+  it('returns the implementation of the `getPreferences` hook for a different locale', async () => {
+    const fn = getGetPreferencesMethodImplementation(
+      getMockOptions({
+        locale: 'nl',
+      }),
+    );
+
+    expect(fn()).toStrictEqual({ currency: 'usd', locale: 'nl' });
+  });
+
+  it('returns the implementation of the `getPreferences` hook for a different currency', async () => {
+    const fn = getGetPreferencesMethodImplementation(
+      getMockOptions({
+        currency: 'dkk',
+      }),
+    );
+
+    expect(fn()).toStrictEqual({ currency: 'dkk', locale: 'en' });
+  });
+});

packages/snaps-jest/src/internals/simulation/methods/hooks/get-preferences.ts

@@ -0,0 +1,18 @@
+import type { SimulationOptions } from '../../options';
+
+/**
+ * Get the implementation of the `getPreferences` hook.
+ *
+ * @param options - The simulation options.
+ * @param options.currency - The currency to use.
+ * @param options.locale - The locale to use.
+ * @returns The implementation of the `getPreferences` hook.
+ */
+export function getGetPreferencesMethodImplementation({
+  currency,
+  locale,
+}: SimulationOptions) {
+  return () => {
+    return { currency, locale };
+  };
+}

packages/snaps-jest/src/internals/simulation/methods/hooks/index.ts

@@ -1,4 +1,4 @@
-export * from './get-locale';
+export * from './get-preferences';
 export * from './notifications';
 export * from './request-user-approval';
 export * from './state';

packages/snaps-jest/src/internals/simulation/methods/specifications.test.ts

@@ -231,6 +231,15 @@ describe('getPermissionSpecifications', () => {
           ],
           "targetName": "snap_getLocale",
         },
+        "snap_getPreferences": {
+          "allowedCaveats": null,
+          "methodImplementation": [Function],
+          "permissionType": "RestrictedMethod",
+          "subjectTypes": [
+            "snap",
+          ],
+          "targetName": "snap_getPreferences",
+        },
         "snap_manageAccounts": {
           "allowedCaveats": null,
           "methodImplementation": [Function],

packages/snaps-jest/src/internals/simulation/methods/specifications.ts

@@ -15,7 +15,7 @@ import {
   EXCLUDED_SNAP_PERMISSIONS,
 } from './constants';
 import {
-  getGetLocaleMethodImplementation,
+  getGetPreferencesMethodImplementation,
   getClearSnapStateMethodImplementation,
   getGetSnapStateMethodImplementation,
   getUpdateSnapStateMethodImplementation,
@@ -88,7 +88,7 @@ export function getPermissionSpecifications({
 
       // Snaps-specific hooks.
       clearSnapState: getClearSnapStateMethodImplementation(runSaga),
-      getLocale: getGetLocaleMethodImplementation(options),
+      getPreferences: getGetPreferencesMethodImplementation(options),
       getSnapState: getGetSnapStateMethodImplementation(runSaga),
       getUnlockPromise: asyncResolve(true),
 

packages/snaps-jest/src/internals/simulation/options.test.ts

@@ -6,6 +6,7 @@ describe('getOptions', () => {
 
     expect(options).toMatchInlineSnapshot(`
       {
+        "currency": "usd",
         "locale": "en",
         "secretRecoveryPhrase": "test test test test test test test test test test test ball",
         "state": null,
@@ -16,11 +17,13 @@ describe('getOptions', () => {
 
   it('returns the provided options', () => {
     const options = getOptions({
+      currency: 'eur',
       locale: 'nl',
     });
 
     expect(options).toMatchInlineSnapshot(`
       {
+        "currency": "eur",
         "locale": "nl",
         "secretRecoveryPhrase": "test test test test test test test test test test test ball",
         "state": null,

packages/snaps-jest/src/internals/simulation/options.ts

@@ -10,9 +10,10 @@ import {
 } from '@metamask/superstruct';
 import { JsonStruct } from '@metamask/utils';
 
-import { DEFAULT_LOCALE, DEFAULT_SRP } from './constants';
+import { DEFAULT_CURRENCY, DEFAULT_LOCALE, DEFAULT_SRP } from './constants';
 
 const SimulationOptionsStruct = object({
+  currency: defaulted(optional(string()), DEFAULT_CURRENCY),
   secretRecoveryPhrase: defaulted(optional(string()), DEFAULT_SRP),
   locale: defaulted(optional(string()), DEFAULT_LOCALE),
   state: defaulted(optional(nullable(record(string(), JsonStruct))), null),

packages/snaps-jest/src/test-utils/options.ts

@@ -5,19 +5,22 @@ import type { SimulationOptions } from '../internals';
  * Get the options for the simulation.
  *
  * @param options - The options for the simulation.
+ * @param options.currency - The currency to use.
  * @param options.locale - The locale to use.
  * @param options.secretRecoveryPhrase - The secret recovery phrase to use.
  * @param options.state - The state to use.
  * @param options.unencryptedState - The unencrypted state to use.
  * @returns The options for the simulation.
  */
 export function getMockOptions({
+  currency = 'usd',
   locale = 'en',
   secretRecoveryPhrase = DEFAULT_SRP,
   state = null,
   unencryptedState = null,
 }: Partial<SimulationOptions> = {}): SimulationOptions {
   return {
+    currency,
     locale,
     secretRecoveryPhrase,
     state,

packages/snaps-rpc-methods/src/permissions.test.ts

@@ -202,6 +202,15 @@ describe('buildSnapRestrictedMethodSpecifications', () => {
           ],
           "targetName": "snap_getLocale",
         },
+        "snap_getPreferences": {
+          "allowedCaveats": null,
+          "methodImplementation": [Function],
+          "permissionType": "RestrictedMethod",
+          "subjectTypes": [
+            "snap",
+          ],
+          "targetName": "snap_getPreferences",
+        },
         "snap_manageAccounts": {
           "allowedCaveats": null,
           "methodImplementation": [Function],

packages/snaps-rpc-methods/src/restricted/getLocale.test.ts

@@ -6,7 +6,7 @@ describe('snap_getLocale', () => {
   describe('specification', () => {
     it('builds specification', () => {
       const methodHooks = {
-        getLocale: jest.fn(),
+        getPreferences: jest.fn(),
       };
 
       expect(
@@ -26,7 +26,7 @@ describe('snap_getLocale', () => {
   describe('getImplementation', () => {
     it('returns the locale', async () => {
       const methodHooks = {
-        getLocale: jest.fn().mockResolvedValue('en'),
+        getPreferences: jest.fn().mockReturnValue({ locale: 'en' }),
       };
 
       const implementation = getImplementation(methodHooks);

packages/snaps-rpc-methods/src/restricted/getLocale.ts

@@ -5,15 +5,18 @@ import type {
   RestrictedMethodParameters,
 } from '@metamask/permission-controller';
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
-import type { GetLocaleResult } from '@metamask/snaps-sdk';
+import type {
+  GetLocaleResult,
+  GetPreferencesResult,
+} from '@metamask/snaps-sdk';
 import type { NonEmptyArray } from '@metamask/utils';
 
 import type { MethodHooksObject } from '../utils';
 
 const methodName = 'snap_getLocale';
 
 export type GetLocaleMethodHooks = {
-  getLocale: () => Promise<string>;
+  getPreferences: () => GetPreferencesResult;
 };
 
 type SpecificationBuilderOptions = {
@@ -36,6 +39,7 @@ type Specification = ValidPermissionSpecification<{
  * @param options.allowedCaveats - The optional allowed caveats for the permission.
  * @param options.methodHooks - The RPC method hooks needed by the method implementation.
  * @returns The specification for the `snap_getLocale` permission.
+ * @deprecated - To be removed in favor of `snap_getPreferences`.
  */
 export const specificationBuilder: PermissionSpecificationBuilder<
   PermissionType.RestrictedMethod,
@@ -52,7 +56,7 @@ export const specificationBuilder: PermissionSpecificationBuilder<
 };
 
 const methodHooks: MethodHooksObject<GetLocaleMethodHooks> = {
-  getLocale: true,
+  getPreferences: true,
 };
 
 export const getLocaleBuilder = Object.freeze({
@@ -65,13 +69,13 @@ export const getLocaleBuilder = Object.freeze({
  * Builds the method implementation for `snap_getLocale`.
  *
  * @param hooks - The RPC method hooks.
- * @param hooks.getLocale - A function that returns the user selected locale.
+ * @param hooks.getPreferences - A function that returns the user selected preferences.
  * @returns The user selected locale.
  */
-export function getImplementation({ getLocale }: GetLocaleMethodHooks) {
+export function getImplementation({ getPreferences }: GetLocaleMethodHooks) {
   return async function implementation(
     _args: RestrictedMethodOptions<RestrictedMethodParameters>,
   ): Promise<GetLocaleResult> {
-    return getLocale();
+    return getPreferences().locale;
   };
 }

packages/snaps-rpc-methods/src/restricted/getPreferences.test.ts

@@ -0,0 +1,46 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+
+import { getImplementation, specificationBuilder } from './getPreferences';
+
+describe('snap_getPreferences', () => {
+  describe('specification', () => {
+    it('builds specification', () => {
+      const methodHooks = {
+        getPreferences: jest.fn(),
+      };
+
+      expect(
+        specificationBuilder({
+          methodHooks,
+        }),
+      ).toStrictEqual({
+        allowedCaveats: null,
+        methodImplementation: expect.anything(),
+        permissionType: PermissionType.RestrictedMethod,
+        targetName: 'snap_getPreferences',
+        subjectTypes: [SubjectType.Snap],
+      });
+    });
+  });
+
+  describe('getImplementation', () => {
+    it('returns the preferences', async () => {
+      const methodHooks = {
+        getPreferences: jest
+          .fn()
+          .mockReturnValue({ locale: 'en', currency: 'usd' }),
+      };
+
+      const implementation = getImplementation(methodHooks);
+
+      expect(
+        await implementation({
+          context: {
+            origin: 'npm:@metamask/example-snap',
+          },
+          method: 'snap_getPreferences',
+        }),
+      ).toStrictEqual({ locale: 'en', currency: 'usd' });
+    });
+  });
+});