Improve info validation

Author: rekmarks

jest.config.js

@@ -45,10 +45,10 @@ const baseConfig = {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 61.49,
-      functions: 62.92,
-      lines: 64.82,
-      statements: 64.95,
+      branches: 62.37,
+      functions: 63.73,
+      lines: 64.93,
+      statements: 65.06,
     },
   },
 

src/EIP6963.test.ts

@@ -7,20 +7,76 @@ const getProviderInfo = () => ({
   uuid: '1449211e-5560-4235-9ab1-582cbe2b165f',
 });
 
+const providerInfoValidationError = () =>
+  new Error(
+    'Invalid EIP-6963 provider info. See https://eips.ethereum.org/EIPS/eip-6963 for requirements.',
+  );
+
 describe('EIP6963', () => {
   describe('announceProvider', () => {
-    it('throws if the UUID is invalid', () => {
-      ['foo', null, undefined, Symbol('bar')].forEach((invalidUuid) => {
-        const provider: any = { name: 'test' };
-        const providerDetail = { info: getProviderInfo(), provider };
-        providerDetail.info.uuid = invalidUuid as any;
-
-        expect(() => announceProvider(providerDetail)).toThrow(
-          new Error('Invalid `uuid` field. Must be a v4 UUID.'),
+    describe('provider info validation', () => {
+      it('throws if the info is not a plain object', () => {
+        [null, undefined, Symbol('bar'), []].forEach((invalidUuid) => {
+          const provider: any = { name: 'test' };
+          const providerDetail = { info: getProviderInfo(), provider };
+          providerDetail.info.uuid = invalidUuid as any;
+
+          expect(() => announceProvider(providerDetail)).toThrow(
+            providerInfoValidationError(),
+          );
+        });
+      });
+
+      it('throws if the `icon` field is invalid', () => {
+        [null, undefined, '', 'not-a-url', Symbol('bar')].forEach(
+          (invalidUuid) => {
+            const provider: any = { name: 'test' };
+            const providerDetail = { info: getProviderInfo(), provider };
+            providerDetail.info.uuid = invalidUuid as any;
+
+            expect(() => announceProvider(providerDetail)).toThrow(
+              providerInfoValidationError(),
+            );
+          },
         );
       });
-    });
 
+      it('throws if the `name` field is invalid', () => {
+        [null, undefined, '', {}, [], Symbol('bar')].forEach((invalidUuid) => {
+          const provider: any = { name: 'test' };
+          const providerDetail = { info: getProviderInfo(), provider };
+          providerDetail.info.uuid = invalidUuid as any;
+
+          expect(() => announceProvider(providerDetail)).toThrow(
+            providerInfoValidationError(),
+          );
+        });
+      });
+
+      it('throws if the `uuid` field is invalid', () => {
+        [null, undefined, '', 'foo', Symbol('bar')].forEach((invalidUuid) => {
+          const provider: any = { name: 'test' };
+          const providerDetail = { info: getProviderInfo(), provider };
+          providerDetail.info.uuid = invalidUuid as any;
+
+          expect(() => announceProvider(providerDetail)).toThrow(
+            providerInfoValidationError(),
+          );
+        });
+      });
+
+      it('throws if the `walletId` field is invalid', () => {
+        [null, undefined, '', {}, [], Symbol('bar')].forEach((invalidUuid) => {
+          const provider: any = { name: 'test' };
+          const providerDetail = { info: getProviderInfo(), provider };
+          providerDetail.info.uuid = invalidUuid as any;
+
+          expect(() => announceProvider(providerDetail)).toThrow(
+            providerInfoValidationError(),
+          );
+        });
+      });
+    });
     it('should announce a provider', () => {
       const provider: any = { name: 'test' };
       const providerDetail = { info: getProviderInfo(), provider };

src/EIP6963.ts

@@ -92,8 +92,10 @@ export function announceProvider({
   info,
   provider,
 }: EIP6963ProviderDetail): void {
-  if (typeof info.uuid !== 'string' || !UUID_V4_REGEX.test(info.uuid)) {
-    throw new Error('Invalid `uuid` field. Must be a v4 UUID.');
+  if (!isValidInfo(info)) {
+    throw new Error(
+      'Invalid EIP-6963 provider info. See https://eips.ethereum.org/EIPS/eip-6963 for requirements.',
+    );
   }
 
   const _announceProvider = () =>
@@ -111,3 +113,42 @@ export function announceProvider({
     },
   );
 }
+
+/**
+ * Validates an {@link EIP6963ProviderInfo} object.
+ *
+ * @param info - The {@link EIP6963ProviderInfo} to validate.
+ * @returns Whether the {@link EIP6963ProviderInfo} is valid.
+ */
+function isValidInfo(info: unknown): info is EIP6963ProviderInfo {
+  if (!isObject(info)) {
+    return false;
+  }
+
+  return (
+    typeof info.icon === 'string' &&
+    isValidUrl(info.icon) &&
+    typeof info.name === 'string' &&
+    Boolean(info.name) &&
+    typeof info.uuid === 'string' &&
+    UUID_V4_REGEX.test(info.uuid) &&
+    typeof info.walletId === 'string' &&
+    Boolean(info.walletId)
+  );
+}
+
+/**
+ * Checks if a string is a valid URL.
+ *
+ * @param url - The string to check.
+ * @returns Whether the string is a valid URL.
+ */
+function isValidUrl(url: string) {
+  try {
+    // eslint-disable-next-line no-new
+    new URL(url);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}