Skip to content

Commit

Permalink
stash
Browse files Browse the repository at this point in the history
  • Loading branch information
@MajorLift
MajorLift committed Feb 22, 2024
1 parent 34df597 commit 9bf4d14
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 41 deletions.
36 changes: 17 additions & 19 deletions app/scripts/controllers/detect-tokens.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import nock from 'nock';
import BigNumber from 'bignumber.js';
import { ControllerMessenger } from '@metamask/base-controller';
import {
TokenDetectionController,
TokenListController,
TokensController,
AssetsContractController,
Expand All @@ -17,14 +18,13 @@ import { NetworkController } from '@metamask/network-controller';
import { AccountsController } from '@metamask/accounts-controller';
import { NETWORK_TYPES } from '../../../shared/constants/network';
import { toChecksumHexAddress } from '../../../shared/modules/hexstring-utils';
import DetectTokensController from './detect-tokens';
import PreferencesController from './preferences';

const flushPromises = () => {
return new Promise(jest.requireActual('timers').setImmediate);
};

describe('DetectTokensController', function () {
describe('TokenDetectionController', function () {
let sandbox,
interval,
assetsContractController,
Expand All @@ -35,15 +35,13 @@ describe('DetectTokensController', function () {
tokenListController,
accountsController,
preferencesControllerMessenger,
getCurrentSelectedAccount,
getNetworkClientById,
messenger;

const noop = () => undefined;

const getRestrictedMessenger = () => {
return messenger.getRestricted({
name: 'DetectTokensController',
name: 'TokenDetectionController',
allowedActions: ['KeyringController:getState'],
allowedEvents: [
'NetworkController:stateChange',
Expand Down Expand Up @@ -361,7 +359,7 @@ describe('DetectTokensController', function () {
it('should poll on correct interval', async function () {
const stub = sinon.stub(global, 'setInterval');
// eslint-disable-next-line no-new
new DetectTokensController({
new TokenDetectionController({
messenger: getRestrictedMessenger(),
interval: 1337,
getCurrentSelectedAccount:
Expand All @@ -374,7 +372,7 @@ describe('DetectTokensController', function () {
it('should be called on every polling period', async function () {
const clock = sandbox.useFakeTimers();
await network.setProviderType(NETWORK_TYPES.MAINNET);
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand Down Expand Up @@ -412,7 +410,7 @@ describe('DetectTokensController', function () {
messenger: tokenListMessengerSepolia,
});
await tokenListController.start();
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand All @@ -437,7 +435,7 @@ describe('DetectTokensController', function () {
it('should skip adding tokens listed in ignoredTokens array', async function () {
sandbox.useFakeTimers();
await network.setProviderType(NETWORK_TYPES.MAINNET);
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand Down Expand Up @@ -491,7 +489,7 @@ describe('DetectTokensController', function () {
it('should check and add tokens while on supported networks', async function () {
sandbox.useFakeTimers();
await network.setProviderType(NETWORK_TYPES.MAINNET);
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand Down Expand Up @@ -568,7 +566,7 @@ describe('DetectTokensController', function () {

it('should trigger detect new tokens when change address', async function () {
sandbox.useFakeTimers();
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand All @@ -591,7 +589,7 @@ describe('DetectTokensController', function () {

it('should trigger detect new tokens when submit password', async function () {
sandbox.useFakeTimers();
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand All @@ -613,7 +611,7 @@ describe('DetectTokensController', function () {

it('should not be active after lock event is emitted', async function () {
sandbox.useFakeTimers();
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand All @@ -634,7 +632,7 @@ describe('DetectTokensController', function () {
it('should not trigger detect new tokens when not unlocked', async function () {
const clock = sandbox.useFakeTimers();
await network.setProviderType(NETWORK_TYPES.MAINNET);
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand All @@ -657,7 +655,7 @@ describe('DetectTokensController', function () {
it('should not trigger detect new tokens when not open', async function () {
const clock = sandbox.useFakeTimers();
await network.setProviderType(NETWORK_TYPES.MAINNET);
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand All @@ -682,7 +680,7 @@ describe('DetectTokensController', function () {

it('should poll on the correct interval by networkClientId', async function () {
jest.useFakeTimers();
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger: getRestrictedMessenger(),
preferences,
network,
Expand Down Expand Up @@ -721,7 +719,7 @@ describe('DetectTokensController', function () {
});

it('should restart token detection on selected account change', async () => {
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger,
interval,
preferences,
Expand Down Expand Up @@ -749,7 +747,7 @@ describe('DetectTokensController', function () {
});

it('should restart token detection on useTokenDetection change', async () => {
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger,
interval,
preferences,
Expand All @@ -771,7 +769,7 @@ describe('DetectTokensController', function () {
});

it('should restart token detection on network state change', async () => {
const controller = new DetectTokensController({
const controller = new TokenDetectionController({
messenger,
interval,
preferences,
Expand Down
51 changes: 29 additions & 22 deletions app/scripts/metamask-controller.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
CurrencyRateController,
NftController,
NftDetectionController,
TokenDetectionController,
TokenListController,
TokenRatesController,
TokensController,
Expand Down Expand Up @@ -261,7 +262,6 @@ import AlertController from './controllers/alert';
import OnboardingController from './controllers/onboarding';
import Backup from './lib/backup';
import DecryptMessageController from './controllers/decrypt-message';
import DetectTokensController from './controllers/detect-tokens';
import SwapsController from './controllers/swaps';
import MetaMetricsController from './controllers/metametrics';
import { segment } from './lib/segment';
Expand Down Expand Up @@ -1348,35 +1348,40 @@ export default class MetamaskController extends EventEmitter {
});
///: END:ONLY_INCLUDE_IF

const detectTokensControllerMessenger =
const tokenDetectionControllerMessenger =
this.controllerMessenger.getRestricted({
name: 'DetectTokensController',
allowedActions: ['KeyringController:getState'],
name: 'tokenDetectionController',
allowedActions: [
'KeyringController:getState',
'NetworkController:getNetworkConfigurationByClientId',
'PreferencesController:getState',
'TokenListController:getState',
'TokensController:getState',
'TokensController:addDetectedTokens',
],
allowedEvents: [
'NetworkController:stateChange',
'AccountsController:selectedAccountChange',
'KeyringController:lock',
'KeyringController:unlock',
'AccountsController:selectedAccountChange',
'NetworkController:networkDidChange',
'PreferencesController:stateChange',
'TokenListController:stateChange',
],
});
this.detectTokensController = new DetectTokensController({
messenger: detectTokensControllerMessenger,
preferences: this.preferencesController,
tokensController: this.tokensController,
this.tokenDetectionController = new TokenDetectionController({
messenger: tokenDetectionControllerMessenger,
networkClientId: this.networkController.state.selectedNetworkClientId,
getBalancesInSingleCall:
this.assetsContractController.getBalancesInSingleCall.bind(
this.assetsContractController,
),
getCurrentSelectedAccount:
this.accountsController.getSelectedAccount.bind(
this.accountsController,
),
assetsContractController: this.assetsContractController,
network: this.networkController,
tokenList: this.tokenListController,
trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind(
this.metaMetricsController,
),
getNetworkClientById: this.networkController.getNetworkClientById.bind(
this.networkController,
),
});

this.addressBookController = new AddressBookController(
Expand Down Expand Up @@ -2653,7 +2658,7 @@ export default class MetamaskController extends EventEmitter {
nftController,
nftDetectionController,
currencyRateController,
detectTokensController,
tokenDetectionController,
ensController,
gasFeeController,
metaMetricsController,
Expand Down Expand Up @@ -3318,9 +3323,9 @@ export default class MetamaskController extends EventEmitter {
backupUserData: backup.backupUserData.bind(backup),
restoreUserData: backup.restoreUserData.bind(backup),

// DetectTokenController
detectNewTokens: detectTokensController.detectNewTokens.bind(
detectTokensController,
// TokenDetectionController
detectTokens: tokenDetectionController.detectTokens.bind(
tokenDetectionController,
),

// DetectCollectibleController
Expand Down Expand Up @@ -3549,7 +3554,7 @@ export default class MetamaskController extends EventEmitter {

if (balance === '0x0') {
// This account has no balance, so check for tokens
await this.detectTokensController.detectNewTokens({
await this.tokenDetectionController.detectTokens({
selectedAddress: address,
});

Expand Down Expand Up @@ -5431,7 +5436,9 @@ export default class MetamaskController extends EventEmitter {
*/
set isClientOpen(open) {
this._isClientOpen = open;
this.detectTokensController.isOpen = open;
(open
? this.tokenDetectionController.enable()
: this.tokenDetectionController.disable())();
}
/* eslint-enable accessor-pairs */

Expand Down

0 comments on commit 9bf4d14

Please sign in to comment.