Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion app/core/Engine/Engine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ import {
NativeEventSubscription,
} from 'react-native';
///: END:ONLY_INCLUDE_IF
import { CodefiTokenPricesServiceV2 } from '@metamask/assets-controllers';
import {
CodefiTokenPricesServiceV2,
TokenListService,
} from '@metamask/assets-controllers';
import { AccountsController } from '@metamask/accounts-controller';
import {
KeyringController,
Expand Down Expand Up @@ -273,6 +276,12 @@ export class Engine {
CaveatSpecificationConstraint
>;

/**
* Shared token list service. Stored so destroyEngineInstance can call
* destroy() to abort in-flight requests and clear the TanStack Query cache.
*/
private tokenListService: TokenListService;

/**
* Creates a CoreController instance
*/
Expand All @@ -287,6 +296,8 @@ export class Engine {
this.controllerMessenger = getRootExtendedMessenger();

const codefiTokenApiV2 = new CodefiTokenPricesServiceV2();
const tokenListService = new TokenListService();
Comment thread
juanmigdr marked this conversation as resolved.
this.tokenListService = tokenListService;

const initRequest = {
getState: () => store.getState(),
Expand All @@ -298,6 +309,7 @@ export class Engine {
initialKeyringState: keyringState,
qrKeyringScanner: this.qrKeyringScanner,
codefiTokenApiV2,
tokenListService,
};
const { messengerClientsByName } = initMessengerClients({
initFunctions: {
Expand Down Expand Up @@ -1221,6 +1233,7 @@ export class Engine {
controller.destroy();
}
});
this.tokenListService.destroy();
this.removeAllListeners();
await this.resetState();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ describe('TokenDetectionControllerInit', () => {
messenger: expect.any(Object),
disabled: false,
getBalancesInSingleCall: expect.any(Function),
tokenListService: expect.any(Object),
useTokenDetection: expect.any(Function),
useExternalServices: expect.any(Function),
trackMetaMetricsEvent: expect.any(Function),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@ export const tokenDetectionControllerInit: MessengerClientInitFunction<
TokenDetectionController,
TokenDetectionControllerMessenger,
TokenDetectionControllerInitMessenger
> = ({ controllerMessenger, initMessenger, getMessengerClient, getState }) => {
> = ({
controllerMessenger,
initMessenger,
getMessengerClient,
getState,
tokenListService,
}) => {
const networkController = getMessengerClient('NetworkController');

const getBalancesInSingleCall = (
Expand All @@ -44,6 +50,7 @@ export const tokenDetectionControllerInit: MessengerClientInitFunction<
messenger: controllerMessenger,
disabled: false,
getBalancesInSingleCall,
tokenListService,
useTokenDetection: () => selectUseTokenDetection(getState()),
useExternalServices: () => selectBasicFunctionalityEnabled(getState()),
trackMetaMetricsEvent: () => {
Expand Down
1 change: 1 addition & 0 deletions app/core/Engine/controllers/tokens-controller-init.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ describe('tokensControllerInit', () => {
state: undefined,
chainId: '0x1',
provider: {},
tokenListService: expect.any(Object),
});
});
});
2 changes: 2 additions & 0 deletions app/core/Engine/controllers/tokens-controller-init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export const tokensControllerInit: MessengerClientInitFunction<
initMessenger,
persistedState,
getMessengerClient,
tokenListService,
}) => {
const networkController = getMessengerClient('NetworkController');
const { provider } =
Expand All @@ -35,6 +36,7 @@ export const tokensControllerInit: MessengerClientInitFunction<
messenger: controllerMessenger,
chainId: getGlobalChainId(networkController),
provider,
tokenListService,
});

return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ export function getTokenDetectionControllerMessenger(
'NetworkController:getState',
'TokensController:getState',
'TokensController:addDetectedTokens',
'TokenListController:getState',
'PreferencesController:getState',
'TokensController:addTokens',
'NetworkController:findNetworkClientIdByChainId',
Expand All @@ -49,7 +48,6 @@ export function getTokenDetectionControllerMessenger(
'KeyringController:lock',
'KeyringController:unlock',
'NetworkController:networkDidChange',
'TokenListController:stateChange',
'PreferencesController:stateChange',
'TransactionController:transactionConfirmed',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ export function getTokensControllerMessenger(
events: [
'NetworkController:networkDidChange',
'NetworkController:stateChange',
'TokenListController:stateChange',
'AccountsController:selectedEvmAccountChange',
'KeyringController:accountRemoved',
],
Expand Down
10 changes: 10 additions & 0 deletions app/core/Engine/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
TokenListControllerActions,
TokenListControllerEvents,
TokenListState,
TokenListService,
TokensController,
TokensControllerActions,
TokensControllerEvents,
Expand Down Expand Up @@ -1070,6 +1071,14 @@ export type MessengerClientInitRequest<
*/
codefiTokenApiV2: CodefiTokenPricesServiceV2;

/**
* Shared token list service instance.
* Owns a TanStack Query cache (4-hour stale time) so that both
* TokenDetectionController and TokensController share the same in-memory
* cache without redundant network requests.
*/
tokenListService: TokenListService;

/**
* Controller messenger for the client.
* Used to generate controller for each controller.
Expand Down Expand Up @@ -1175,6 +1184,7 @@ export interface InitMessengerClientsFunctionRequest {
initialKeyringState?: KeyringControllerState | null;
qrKeyringScanner: QrKeyringDeferredPromiseBridge;
codefiTokenApiV2: CodefiTokenPricesServiceV2;
tokenListService: TokenListService;
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
removeAccount: (address: string) => Promise<void>;
///: END:ONLY_INCLUDE_IF
Expand Down
9 changes: 8 additions & 1 deletion app/core/Engine/utils/test-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import {
MessengerClientInitRequest,
} from '../types';
import { QrKeyringDeferredPromiseBridge } from '@metamask/eth-qr-keyring';
import { CodefiTokenPricesServiceV2 } from '@metamask/assets-controllers';
import {
CodefiTokenPricesServiceV2,
TokenListService,
} from '@metamask/assets-controllers';

/**
* Build a mock for the MessengerClientInitRequest.
Expand All @@ -20,6 +23,10 @@ export function buildMessengerClientInitRequestMock(
): jest.Mocked<MessengerClientInitRequest<ControllerMessenger>> {
return {
codefiTokenApiV2: jest.fn() as unknown as CodefiTokenPricesServiceV2,
tokenListService: {
fetchTokensByChainId: jest.fn(),
destroy: jest.fn(),
} as unknown as TokenListService,
controllerMessenger: controllerMessenger as unknown as ControllerMessenger,
getMessengerClient: jest.fn(),
getGlobalChainId: jest.fn(),
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@
"@metamask/app-metadata-controller": "^2.0.0",
"@metamask/approval-controller": "^9.0.0",
"@metamask/assets-controller": "^6.2.1",
"@metamask/assets-controllers": "^105.0.0",
"@metamask/assets-controllers": "^106.0.0",
"@metamask/authenticated-user-storage": "^1.0.0",
"@metamask/base-controller": "^9.0.1",
"@metamask/bitcoin-wallet-snap": "^1.10.1",
Expand Down
2 changes: 1 addition & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -35241,7 +35241,7 @@ __metadata:
"@metamask/app-metadata-controller": "npm:^2.0.0"
"@metamask/approval-controller": "npm:^9.0.0"
"@metamask/assets-controller": "npm:^6.2.1"
"@metamask/assets-controllers": "npm:^105.0.0"
"@metamask/assets-controllers": "npm:^106.0.0"
"@metamask/authenticated-user-storage": "npm:^1.0.0"
"@metamask/auto-changelog": "npm:^5.3.0"
"@metamask/base-controller": "npm:^9.0.1"
Expand Down
Loading