Toggle option to enable/disable balance and Token rate checking for using third-party API

.storybook/test-data.js

@@ -1225,6 +1225,7 @@ const state = {
     useNonceField: false,
     usePhishDetect: true,
     useTokenDetection: true,
+    useCurrencyRateCheck: true,
     lostIdentities: {},
     forgottenPassword: false,
     ipfsGateway: 'dweb.link',

app/scripts/controllers/detect-tokens.js

@@ -116,7 +116,7 @@ export default class DetectTokensController {
     const tokensToDetect = [];
     for (const tokenAddress in tokenListUsed) {
       if (
-        !this.tokenAddresses.find(({ address }) =>
+        !this.tokenAddresses.find((address) =>
           isEqualCaseInsensitive(address, tokenAddress),
         ) &&
         !this.hiddenTokens.find((address) =>

app/scripts/controllers/detect-tokens.test.js

@@ -11,8 +11,9 @@ import {
 } from '@metamask/assets-controllers';
 import { NETWORK_TYPES } from '../../../shared/constants/network';
 import { toChecksumHexAddress } from '../../../shared/modules/hexstring-utils';
+import { hexToDecimal } from '../../../shared/lib/metamask-controller-utils';
 import DetectTokensController from './detect-tokens';
-import NetworkController from './network';
+import NetworkController, { NETWORK_EVENTS } from './network';
 import PreferencesController from './preferences';
 
 describe('DetectTokensController', function () {
@@ -64,14 +65,34 @@ describe('DetectTokensController', function () {
       onPreferencesStateChange: preferences.store.subscribe.bind(
         preferences.store,
       ),
-      onNetworkStateChange: network.store.subscribe.bind(network.store),
+      onNetworkStateChange: (cb) =>
+        network.store.subscribe((networkState) => {
+          const modifiedNetworkState = {
+            ...networkState,
+            providerConfig: {
+              ...networkState.provider,
+            },
+          };
+          return cb(modifiedNetworkState);
+        }),
     });
 
     assetsContractController = new AssetsContractController({
       onPreferencesStateChange: preferences.store.subscribe.bind(
         preferences.store,
       ),
-      onNetworkStateChange: network.store.subscribe.bind(network.store),
+      onNetworkStateChange: (cb) =>
+        network.on(NETWORK_EVENTS.NETWORK_DID_CHANGE, () => {
+          const networkState = network.store.getState();
+          const modifiedNetworkState = {
+            ...networkState,
+            providerConfig: {
+              ...networkState.provider,
+              chainId: hexToDecimal(networkState.provider.chainId),
+            },
+          };
+          return cb(modifiedNetworkState);
+        }),
     });
 
     sandbox

app/scripts/controllers/preferences.js

@@ -37,6 +37,7 @@ export default class PreferencesController {
       // set to false will be using the static list from contract-metadata
       useTokenDetection: false,
       useNftDetection: false,
+      useCurrencyRateCheck: true,
       openSeaEnabled: false,
       advancedGasFee: null,
 
@@ -156,6 +157,15 @@ export default class PreferencesController {
     this.store.updateState({ useNftDetection });
   }
 
+  /**
+   * Setter for the `useCurrencyRateCheck` property
+   *
+   * @param {boolean} val - Whether or not the user prefers to use currency rate check for ETH and tokens.
+   */
+  setUseCurrencyRateCheck(val) {
+    this.store.updateState({ useCurrencyRateCheck: val });
+  }
+
   /**
    * Setter for the `openSeaEnabled` property
    *

app/scripts/controllers/preferences.test.js

@@ -367,4 +367,23 @@ describe('preferences controller', function () {
       assert.equal(preferencesController.store.getState().theme, 'dark');
     });
   });
+
+  describe('setUseCurrencyRateCheck', function () {
+    it('should default to false', function () {
+      const state = preferencesController.store.getState();
+      assert.equal(state.useCurrencyRateCheck, true);
+    });
+
+    it('should set the useCurrencyRateCheck property in state', function () {
+      assert.equal(
+        preferencesController.store.getState().useCurrencyRateCheck,
+        true,
+      );
+      preferencesController.setUseCurrencyRateCheck(false);
+      assert.equal(
+        preferencesController.store.getState().useCurrencyRateCheck,
+        false,
+      );
+    });
+  });
 });

app/scripts/metamask-controller.js

@@ -266,7 +266,7 @@ export default class MetamaskController extends EventEmitter {
         this.networkController.store.subscribe((networkState) => {
           const modifiedNetworkState = {
             ...networkState,
-            provider: {
+            providerConfig: {
               ...networkState.provider,
               chainId: hexToDecimal(networkState.provider.chainId),
             },
@@ -291,9 +291,16 @@ export default class MetamaskController extends EventEmitter {
       onPreferencesStateChange: this.preferencesController.store.subscribe.bind(
         this.preferencesController.store,
       ),
-      onNetworkStateChange: this.networkController.store.subscribe.bind(
-        this.networkController.store,
-      ),
+      onNetworkStateChange: (cb) =>
+        this.networkController.store.subscribe((networkState) => {
+          const modifiedNetworkState = {
+            ...networkState,
+            providerConfig: {
+              ...networkState.provider,
+            },
+          };
+          return cb(modifiedNetworkState);
+        }),
       config: { provider: this.provider },
       state: initState.TokensController,
     });
@@ -307,7 +314,7 @@ export default class MetamaskController extends EventEmitter {
             const networkState = this.networkController.store.getState();
             const modifiedNetworkState = {
               ...networkState,
-              provider: {
+              providerConfig: {
                 ...networkState.provider,
                 chainId: hexToDecimal(networkState.provider.chainId),
               },
@@ -327,9 +334,16 @@ export default class MetamaskController extends EventEmitter {
           this.preferencesController.store.subscribe.bind(
             this.preferencesController.store,
           ),
-        onNetworkStateChange: this.networkController.store.subscribe.bind(
-          this.networkController.store,
-        ),
+        onNetworkStateChange: (cb) =>
+          this.networkController.store.subscribe((networkState) => {
+            const modifiedNetworkState = {
+              ...networkState,
+              providerConfig: {
+                ...networkState.provider,
+              },
+            };
+            return cb(modifiedNetworkState);
+          }),
         getERC721AssetName:
           this.assetsContractController.getERC721AssetName.bind(
             this.assetsContractController,
@@ -504,17 +518,37 @@ export default class MetamaskController extends EventEmitter {
           this.networkController.store.subscribe((networkState) => {
             const modifiedNetworkState = {
               ...networkState,
-              provider: {
+              providerConfig: {
                 ...networkState.provider,
                 chainId: hexToDecimal(networkState.provider.chainId),
               },
             };
             return cb(modifiedNetworkState);
           }),
       },
-      undefined,
+      {
+        disabled:
+          !this.preferencesController.store.getState().useCurrencyRateCheck,
+      },
       initState.TokenRatesController,
     );
+    this.preferencesController.store.subscribe(
+      previousValueComparator((prevState, currState) => {
+        const { useCurrencyRateCheck: prevUseCurrencyRateCheck } = prevState;
+        const { useCurrencyRateCheck: currUseCurrencyRateCheck } = currState;
+        if (currUseCurrencyRateCheck && !prevUseCurrencyRateCheck) {
+          this.currencyRateController.start();
+          this.tokenRatesController.configure(
+            { disabled: false },
+            false,
+            false,
+          );
+        } else if (!currUseCurrencyRateCheck && prevUseCurrencyRateCheck) {
+          this.currencyRateController.stop();
+          this.tokenRatesController.configure({ disabled: true }, false, false);
+        }
+      }, this.preferencesController.store.getState()),
+    );
 
     this.ensController = new EnsController({
       provider: this.provider,
@@ -1245,7 +1279,9 @@ export default class MetamaskController extends EventEmitter {
   triggerNetworkrequests() {
     this.accountTracker.start();
     this.incomingTransactionsController.start();
-    this.currencyRateController.start();
+    if (this.preferencesController.store.getState().useCurrencyRateCheck) {
+      this.currencyRateController.start();
+    }
     if (this.preferencesController.store.getState().useTokenDetection) {
       this.tokenListController.start();
     }
@@ -1254,7 +1290,9 @@ export default class MetamaskController extends EventEmitter {
   stopNetworkRequests() {
     this.accountTracker.stop();
     this.incomingTransactionsController.stop();
-    this.currencyRateController.stop();
+    if (this.preferencesController.store.getState().useCurrencyRateCheck) {
+      this.currencyRateController.stop();
+    }
     if (this.preferencesController.store.getState().useTokenDetection) {
       this.tokenListController.stop();
     }
@@ -1634,6 +1672,10 @@ export default class MetamaskController extends EventEmitter {
       setUseNftDetection: preferencesController.setUseNftDetection.bind(
         preferencesController,
       ),
+      setUseCurrencyRateCheck:
+        preferencesController.setUseCurrencyRateCheck.bind(
+          preferencesController,
+        ),
       setOpenSeaEnabled: preferencesController.setOpenSeaEnabled.bind(
         preferencesController,
       ),

lavamoat/browserify/beta/policy.json

@@ -501,17 +501,18 @@
         "URL": true,
         "clearInterval": true,
         "clearTimeout": true,
+        "console.info": true,
         "console.log": true,
         "setInterval": true,
         "setTimeout": true
       },
       "packages": {
         "@ethersproject/contracts": true,
         "@ethersproject/providers": true,
-        "@metamask/assets-controllers>@metamask/contract-metadata": true,
         "@metamask/assets-controllers>abort-controller": true,
         "@metamask/assets-controllers>multiformats": true,
         "@metamask/base-controller": true,
+        "@metamask/contract-metadata": true,
         "@metamask/controller-utils": true,
         "@metamask/metamask-eth-abis": true,
         "browserify>events": true,

lavamoat/browserify/flask/policy.json

@@ -501,17 +501,18 @@
         "URL": true,
         "clearInterval": true,
         "clearTimeout": true,
+        "console.info": true,
         "console.log": true,
         "setInterval": true,
         "setTimeout": true
       },
       "packages": {
         "@ethersproject/contracts": true,
         "@ethersproject/providers": true,
-        "@metamask/assets-controllers>@metamask/contract-metadata": true,
         "@metamask/assets-controllers>abort-controller": true,
         "@metamask/assets-controllers>multiformats": true,
         "@metamask/base-controller": true,
+        "@metamask/contract-metadata": true,
         "@metamask/controller-utils": true,
         "@metamask/metamask-eth-abis": true,
         "browserify>events": true,

lavamoat/browserify/main/policy.json

@@ -501,17 +501,18 @@
         "URL": true,
         "clearInterval": true,
         "clearTimeout": true,
+        "console.info": true,
         "console.log": true,
         "setInterval": true,
         "setTimeout": true
       },
       "packages": {
         "@ethersproject/contracts": true,
         "@ethersproject/providers": true,
-        "@metamask/assets-controllers>@metamask/contract-metadata": true,
         "@metamask/assets-controllers>abort-controller": true,
         "@metamask/assets-controllers>multiformats": true,
         "@metamask/base-controller": true,
+        "@metamask/contract-metadata": true,
         "@metamask/controller-utils": true,
         "@metamask/metamask-eth-abis": true,
         "browserify>events": true,

package.json

@@ -209,7 +209,7 @@
     "@metamask/address-book-controller": "^1.0.0",
     "@metamask/announcement-controller": "^1.0.0",
     "@metamask/approval-controller": "^1.0.0",
-    "@metamask/assets-controllers": "^1.0.1",
+    "@metamask/assets-controllers": "^3.0.1",
     "@metamask/base-controller": "^1.0.0",
     "@metamask/contract-metadata": "^2.1.0",
     "@metamask/controller-utils": "^1.0.0",

shared/lib/ui-utils.js

@@ -5,6 +5,11 @@ _supportLink = 'https://metamask-flask.zendesk.com/hc';
 ///: END:ONLY_INCLUDE_IN
 
 export const SUPPORT_LINK = _supportLink;
+
+export const COINGECKO_LINK = 'https://www.coingecko.com/';
+export const CRYPTOCOMPARE_LINK = 'https://www.cryptocompare.com/';
+export const PRIVACY_POLICY_LINK = 'https://consensys.net/privacy-policy/';
+
 // TODO make sure these links are correct
 export const ETHERSCAN_PRIVACY_LINK = 'https://etherscan.io/privacyPolicy';
 export const CONSENSYS_PRIVACY_LINK = 'https://consensys.net/privacy-policy/';

test/data/mock-state.json

@@ -252,6 +252,7 @@
     "unapprovedTypedMessages": {},
     "unapprovedTypedMessagesCount": 0,
     "useTokenDetection": true,
+    "useCurrencyRateCheck": true,
     "advancedGasFee": {
       "maxBaseFee": "75",
       "priorityFee": "2"

test/e2e/fixture-builder.js

@@ -239,6 +239,7 @@ function defaultFixture() {
         useNonceField: false,
         usePhishDetect: true,
         useTokenDetection: false,
+        useCurrencyRateCheck: true,
         useMultiAccountBalanceChecker: true,
       },
       SmartTransactionsController: {
@@ -352,6 +353,7 @@ function onboardingFixture() {
         useNonceField: false,
         usePhishDetect: true,
         useTokenDetection: false,
+        useCurrencyRateCheck: true,
         useMultiAccountBalanceChecker: true,
       },
       SmartTransactionsController: {

test/e2e/restore/MetaMaskUserData.json

@@ -46,6 +46,7 @@
     "useNonceField": false,
     "usePhishDetect": true,
     "useTokenDetection": false,
+    "useCurrencyRateCheck": true,
     "useMultiAccountBalanceChecker": true
   }
 }

test/jest/mock-store.js

@@ -218,6 +218,7 @@ export const createSwapsMockStore = () => {
           postTxBalance: '19a61aaaf06e4bd1',
         },
       ],
+      useCurrencyRateCheck: true,
       conversionRate: 1,
       contractExchangeRates: {
         '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48': 2,