Add SupportedTokenDetectionNetworks enum and util for token detection support. (#811)

Author: Cal-L

src/util.test.ts

@@ -7,6 +7,7 @@ import {
   GasPriceValue,
   FeeMarketEIP1559Values,
 } from './transaction/TransactionController';
+import { NetworksChainId } from './network/NetworkController';
 
 const VALID = '4e1fF7229BDdAf0A73DF183a88d9c3a04cc975e0';
 const SOME_API = 'https://someapi.com';
@@ -1267,3 +1268,27 @@ describe('isValidJson', () => {
     expect(util.isValidJson({ foo: 'bar', test: { num: 5 } })).toBe(true);
   });
 });
+
+describe('isTokenDetectionEnabledForNetwork', () => {
+  it('returns true for Mainnet', () => {
+    expect(
+      util.isTokenDetectionEnabledForNetwork(
+        util.SupportedTokenDetectionNetworks.mainnet,
+      ),
+    ).toBe(true);
+  });
+
+  it('returns true for custom network such as BSC', () => {
+    expect(
+      util.isTokenDetectionEnabledForNetwork(
+        util.SupportedTokenDetectionNetworks.bsc,
+      ),
+    ).toBe(true);
+  });
+
+  it('returns false for testnets such as Ropsten', () => {
+    expect(
+      util.isTokenDetectionEnabledForNetwork(NetworksChainId.ropsten),
+    ).toBe(false);
+  });
+});

src/util.ts

@@ -324,7 +324,7 @@ export async function safelyExecute(
 ) {
   try {
     return await operation();
-  } catch (error) {
+  } catch (error: any) {
     /* istanbul ignore next */
     if (logError) {
       console.error(error);
@@ -931,3 +931,25 @@ export function isValidJson(value: unknown): value is Json {
     return false;
   }
 }
+
+/**
+ * Networks where token detection is supported - Values are in decimal format
+ */
+export enum SupportedTokenDetectionNetworks {
+  mainnet = '1',
+  bsc = '56',
+  polygon = '137',
+  avax = '43114',
+}
+
+/**
+ * Check if token detection is enabled for certain networks.
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports token detection
+ */
+export function isTokenDetectionEnabledForNetwork(chainId: string): boolean {
+  return Object.values<string>(SupportedTokenDetectionNetworks).includes(
+    chainId,
+  );
+}