Add WebHID endowment

packages/snaps-controllers/coverage.json

@@ -1,6 +1,6 @@
 {
   "branches": 89.19,
-  "functions": 95.01,
-  "lines": 96.45,
-  "statements": 96.35
+  "functions": 95.04,
+  "lines": 96.47,
+  "statements": 96.37
 }

packages/snaps-controllers/src/snaps/endowments/enum.ts

@@ -7,4 +7,5 @@ export enum SnapEndowments {
   EthereumProvider = 'endowment:ethereum-provider',
   Rpc = 'endowment:rpc',
   WebAssemblyAccess = 'endowment:webassembly',
+  WebHID = 'endowment:webhid',
 }

packages/snaps-controllers/src/snaps/endowments/index.ts

@@ -26,6 +26,7 @@ import {
   transactionInsightEndowmentBuilder,
 } from './transaction-insight';
 import { webAssemblyEndowmentBuilder } from './web-assembly';
+import { webhidEndowmentBuilder } from './webhid';
 
 export const endowmentPermissionBuilders = {
   [networkAccessEndowmentBuilder.targetKey]: networkAccessEndowmentBuilder,
@@ -38,6 +39,7 @@ export const endowmentPermissionBuilders = {
     ethereumProviderEndowmentBuilder,
   [rpcEndowmentBuilder.targetKey]: rpcEndowmentBuilder,
   [webAssemblyEndowmentBuilder.targetKey]: webAssemblyEndowmentBuilder,
+  [webhidEndowmentBuilder.targetKey]: webhidEndowmentBuilder,
 } as const;
 
 export const endowmentCaveatSpecifications = {

packages/snaps-controllers/src/snaps/endowments/webhid.test.ts

@@ -0,0 +1,18 @@
+import { PermissionType } from '@metamask/permission-controller';
+
+import { SnapEndowments } from './enum';
+import { webhidEndowmentBuilder } from './webhid';
+
+describe('endowment:webhid', () => {
+  it('builds the expected permission specification', () => {
+    const specification = webhidEndowmentBuilder.specificationBuilder({});
+    expect(specification).toStrictEqual({
+      permissionType: PermissionType.Endowment,
+      targetKey: SnapEndowments.WebHID,
+      endowmentGetter: expect.any(Function),
+      allowedCaveats: null,
+    });
+
+    expect(specification.endowmentGetter()).toStrictEqual(['navigator']);
+  });
+});

packages/snaps-controllers/src/snaps/endowments/webhid.ts

@@ -0,0 +1,44 @@
+import {
+  EndowmentGetterParams,
+  PermissionSpecificationBuilder,
+  PermissionType,
+  ValidPermissionSpecification,
+} from '@metamask/permission-controller';
+
+import { SnapEndowments } from './enum';
+
+const permissionName = SnapEndowments.WebHID;
+
+type WebHIDEndowmentSpecification = ValidPermissionSpecification<{
+  permissionType: PermissionType.Endowment;
+  targetKey: typeof permissionName;
+  endowmentGetter: (_options?: any) => ['navigator'];
+  allowedCaveats: null;
+}>;
+
+/**
+ * `endowment:webhid` returns the name of global browser API(s) that
+ * enable the usage of navigator.webhid. This enables the connection of devices that uses webhid such as Ledger.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the webhid endowment.
+ */
+const specificationBuilder: PermissionSpecificationBuilder<
+  PermissionType.Endowment,
+  any,
+  WebHIDEndowmentSpecification
+> = (_builderOptions?: any) => {
+  return {
+    permissionType: PermissionType.Endowment,
+    targetKey: permissionName,
+    allowedCaveats: null,
+    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {
+      return ['navigator'];
+    },
+  };
+};
+
+export const webhidEndowmentBuilder = Object.freeze({
+  targetKey: permissionName,
+  specificationBuilder,
+} as const);

packages/snaps-execution-environments/coverage.json

@@ -1,6 +1,6 @@
 {
   "branches": 77.41,
-  "functions": 91.26,
-  "lines": 85.23,
-  "statements": 85.32
+  "functions": 91.33,
+  "lines": 85.29,
+  "statements": 85.37
 }

packages/snaps-execution-environments/package.json

@@ -62,6 +62,7 @@
     "@metamask/eslint-config-typescript": "^11.0.0",
     "@types/jest": "^27.5.1",
     "@types/node": "^17.0.36",
+    "@types/w3c-web-hid": "^1.0.3",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
     "@wdio/browser-runner": "^8.3.10",

packages/snaps-execution-environments/src/common/endowments/commonEndowmentFactory.ts

@@ -6,6 +6,7 @@ import network from './network';
 import textDecoder from './textDecoder';
 import textEncoder from './textEncoder';
 import timeout from './timeout';
+import webhid from './webhid';
 
 export type EndowmentFactory = {
   names: readonly string[];
@@ -58,6 +59,7 @@ const buildCommonEndowments = (): EndowmentFactory[] => {
     textDecoder,
     textEncoder,
     date,
+    webhid,
   ];
 
   commonEndowments.forEach((endowmentSpecification) => {

packages/snaps-execution-environments/src/common/endowments/endowments.test.browser.ts

@@ -253,6 +253,7 @@ describe('endowments', () => {
           factory: expect.any(Function),
           names: ['Date'],
         },
+        { factory: expect.any(Function), names: ['navigator'] },
         {
           factory: expect.any(Function),
           names: ['AbortController'],

packages/snaps-execution-environments/src/common/endowments/webhid.test.ts

@@ -0,0 +1,21 @@
+import { rootRealmGlobal } from '../globalObject';
+import Webhid from './webhid';
+
+describe('Webhid endowment', () => {
+  it('has expected properties', () => {
+    expect(Webhid).toMatchObject({
+      names: ['navigator'],
+      factory: expect.any(Function),
+    });
+  });
+
+  it('does not return the navigator from rootRealmGlobal', () => {
+    const { navigator } = Webhid.factory();
+    expect(navigator).not.toStrictEqual(rootRealmGlobal.navigator);
+  });
+
+  it('contains the hid key only', () => {
+    const { navigator } = Webhid.factory();
+    expect(Object.keys(navigator)).toContain('hid');
+  });
+});

packages/snaps-execution-environments/src/common/endowments/webhid.ts

@@ -0,0 +1,24 @@
+import { rootRealmGlobal } from '../globalObject';
+
+/**
+ * Create a {@link navigator} object, with the same properties as the global
+ * {@link navigator} object, but only with access to hid.
+ *
+ * @returns The {@link navigator} object with only access to hid.
+ */
+function createHID() {
+  return {
+    navigator: {
+      // https://developer.mozilla.org/en-US/docs/Web/API/Navigator/hid
+      // https://wicg.github.io/webhid/#dom-navigator-hid
+      hid: rootRealmGlobal.navigator?.hid,
+    },
+  };
+}
+
+const endowmentModule = {
+  names: ['navigator'] as const,
+  factory: createHID,
+};
+
+export default endowmentModule;

packages/snaps-utils/coverage.json

@@ -2,5 +2,5 @@
   "branches": 92.92,
   "functions": 100,
   "lines": 98.94,
-  "statements": 98.95
+  "statements": 98.96
 }

packages/snaps-utils/src/iframe.ts

@@ -36,6 +36,10 @@ export async function createWindow(
     // MDN article for `load` event: https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event
     // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489
     iframe.setAttribute('src', uri);
+
+    // Enable WebHID to be executed in the iframe.
+    iframe.setAttribute('allow', 'hid');
+
     document.body.appendChild(iframe);
 
     iframe.addEventListener('load', () => {

yarn.lock

@@ -3131,6 +3131,7 @@ __metadata:
     "@metamask/utils": ^3.4.1
     "@types/jest": ^27.5.1
     "@types/node": ^17.0.36
+    "@types/w3c-web-hid": ^1.0.3
     "@typescript-eslint/eslint-plugin": ^5.42.1
     "@typescript-eslint/parser": ^5.42.1
     "@wdio/browser-runner": ^8.3.10
@@ -4416,6 +4417,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/w3c-web-hid@npm:^1.0.3":
+  version: 1.0.3
+  resolution: "@types/w3c-web-hid@npm:1.0.3"
+  checksum: 90ee1eeb2acf5d5ddf0b7acefd4f8aaa7d0175d991c3606a9ad62bdfa7a8de93665f5f6218dc4ecb34ea1d2f3e357813b315f46c1ea6b8aa1693e217e436c9b2
+  languageName: node
+  linkType: hard
+
 "@types/watchify@npm:^3.11.1":
   version: 3.11.1
   resolution: "@types/watchify@npm:3.11.1"