Skip to content

chore: stop using swaps fetchTokens function #7712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juanmigdr wants to merge 2 commits into
base: main
Choose a base branch
from
+9 −280
Open

chore: stop using swaps fetchTokens function #7712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32f48d0
chore: stop using swaps fetchTokens function
juanmigdr Jan 23, 2026
85464fc
chore: update assets-controllers CHANGELOG.md with breaking change fo…
cursoragent Jan 23, 2026
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
4 changes: 2 additions & 2 deletions eslint-suppressions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,15 +366,15 @@
},
"packages/assets-controllers/src/TokenSearchDiscoveryDataController/TokenSearchDiscoveryDataController.test.ts": {
"@typescript-eslint/explicit-function-return-type": {
"count": 3
"count": 2
}
},
"packages/assets-controllers/src/TokenSearchDiscoveryDataController/TokenSearchDiscoveryDataController.ts": {
"@typescript-eslint/explicit-function-return-type": {
"count": 1
},
"no-negated-condition": {
"count": 2
"count": 1
}
},
"packages/assets-controllers/src/TokensController.test.ts": {
Expand Down
7 changes: 7 additions & 0 deletions packages/assets-controllers/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Removed

- **BREAKING:** Remove swaps token fetching functionality from TokenSearchDiscoveryDataController ([#7712](https://github.com/MetaMask/core/pull/7712))
- Remove `swapsTokenAddressesByChainId` from controller state
- Remove `swapsSupportedChainIds`, `fetchTokens`, and `fetchSwapsTokensThresholdMs` constructor parameters
- Remove `fetchSwapsTokens` method

## [96.0.0]

### Added
Expand Down
212 changes: 0 additions & 212 deletions ...rollers/src/TokenSearchDiscoveryDataController/TokenSearchDiscoveryDataController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import type {
} from '@metamask/messenger';
import type { Hex } from '@metamask/utils';
import assert from 'assert';
import { useFakeTimers } from 'sinon';

import {
getDefaultTokenSearchDiscoveryDataControllerState,
Expand All @@ -21,7 +20,6 @@ import type {
TokenSearchDiscoveryDataControllerState,
} from './TokenSearchDiscoveryDataController';
import type { NotFoundTokenDisplayData, FoundTokenDisplayData } from './types';
import { advanceTime } from '../../../../tests/helpers';
import type {
AbstractTokenPricesService,
EvmAssetWithMarketData,
Expand Down Expand Up @@ -164,27 +162,12 @@ function buildMockTokenPricesService(
};
}

/**
* Builds a mock fetchTokens function.
*
* @param tokenAddresses - The token addresses to return.
* @returns A function that returns the token addresses.
*/
function buildMockFetchTokens(tokenAddresses: string[] = []) {
return async (_chainId: Hex) => {
return tokenAddresses.map((address) => ({ address }));
};
}

type WithControllerOptions = {
options?: Partial<
ConstructorParameters<typeof TokenSearchDiscoveryDataController>[0]
>;
mockCurrencyRateState?: { currentCurrency: string };
mockTokenPricesService?: Partial<AbstractTokenPricesService>;
mockFetchTokens?: (chainId: Hex) => Promise<{ address: string }[]>;
mockSwapsSupportedChainIds?: Hex[];
mockFetchSwapsTokensThresholdMs?: number;
};

type WithControllerCallback<ReturnValue> = ({
Expand Down Expand Up @@ -244,19 +227,10 @@ async function withController<ReturnValue>(
messenger: controllerMessenger,
state: {
tokenDisplayData: [],
swapsTokenAddressesByChainId: {},
},
tokenPricesService: buildMockTokenPricesService(
options.mockTokenPricesService,
),
swapsSupportedChainIds: options.mockSwapsSupportedChainIds ?? [
ChainId.mainnet,
],
fetchTokens:
options.mockFetchTokens ??
buildMockFetchTokens(['0x6B175474E89094C44Da98b954EedeAC495271d0F']),
fetchSwapsTokensThresholdMs:
options.mockFetchSwapsTokensThresholdMs ?? 86400000,
...options.options,
});

Expand Down Expand Up @@ -285,7 +259,6 @@ describe('TokenSearchDiscoveryDataController', () => {
await withController(async ({ controller }) => {
expect(controller.state).toStrictEqual({
tokenDisplayData: [],
swapsTokenAddressesByChainId: {},
});
});
});
Expand All @@ -305,178 +278,9 @@ describe('TokenSearchDiscoveryDataController', () => {
expect(controller.state.tokenDisplayData).toStrictEqual(
initialState.tokenDisplayData,
);
expect(controller.state.swapsTokenAddressesByChainId).toStrictEqual(
{},
);
},
);
});
});

describe('fetchSwapsTokens', () => {
let clock: sinon.SinonFakeTimers;

beforeEach(() => {
clock = useFakeTimers({ now: Date.now() });
});

afterEach(() => {
clock.restore();
});

it('should not fetch tokens for unsupported chain IDs', async () => {
const mockFetchTokens = jest.fn().mockResolvedValue([]);
const unsupportedChainId = '0x5' as Hex;

await withController(
{
mockFetchTokens,
mockSwapsSupportedChainIds: [ChainId.mainnet],
},
async ({ controller }) => {
await controller.fetchSwapsTokens(unsupportedChainId);

expect(mockFetchTokens).not.toHaveBeenCalled();
expect(
controller.state.swapsTokenAddressesByChainId[unsupportedChainId],
).toBeUndefined();
},
);
});

it('should fetch tokens for supported chain IDs', async () => {
const mockTokens = [{ address: '0xToken1' }, { address: '0xToken2' }];
const mockFetchTokens = jest.fn().mockResolvedValue(mockTokens);

await withController(
{
mockFetchTokens,
mockSwapsSupportedChainIds: [ChainId.mainnet],
},
async ({ controller }) => {
await controller.fetchSwapsTokens(ChainId.mainnet);

expect(mockFetchTokens).toHaveBeenCalledWith(ChainId.mainnet);
expect(
controller.state.swapsTokenAddressesByChainId[ChainId.mainnet],
).toBeDefined();
expect(
controller.state.swapsTokenAddressesByChainId[ChainId.mainnet]
.addresses,
).toStrictEqual(['0xToken1', '0xToken2']);
expect(
controller.state.swapsTokenAddressesByChainId[ChainId.mainnet]
.isFetching,
).toBe(false);
},
);
});

it('should not fetch tokens again if threshold has not passed', async () => {
const mockTokens = [{ address: '0xToken1' }];
const mockFetchTokens = jest.fn().mockResolvedValue(mockTokens);
const fetchThreshold = 10000;

await withController(
{
mockFetchTokens,
mockSwapsSupportedChainIds: [ChainId.mainnet],
mockFetchSwapsTokensThresholdMs: fetchThreshold,
},
async ({ controller }) => {
await controller.fetchSwapsTokens(ChainId.mainnet);
expect(mockFetchTokens).toHaveBeenCalledTimes(1);

mockFetchTokens.mockClear();

await controller.fetchSwapsTokens(ChainId.mainnet);
expect(mockFetchTokens).not.toHaveBeenCalled();

await advanceTime({ clock, duration: fetchThreshold + 1000 });

await controller.fetchSwapsTokens(ChainId.mainnet);
expect(mockFetchTokens).toHaveBeenCalledTimes(1);
},
);
});

it('should set isFetching flag while fetching', async () => {
let resolveTokens: (tokens: { address: string }[]) => void;
const fetchTokensPromise = new Promise<{ address: string }[]>(
(resolve) => {
resolveTokens = resolve;
},
);
const mockFetchTokens = jest.fn().mockReturnValue(fetchTokensPromise);

await withController(
{
mockFetchTokens,
mockSwapsSupportedChainIds: [ChainId.mainnet],
},
async ({ controller }) => {
const fetchPromise = controller.fetchSwapsTokens(ChainId.mainnet);

expect(
controller.state.swapsTokenAddressesByChainId[ChainId.mainnet]
.isFetching,
).toBe(true);

resolveTokens([{ address: '0xToken1' }]);

await fetchPromise;

expect(
controller.state.swapsTokenAddressesByChainId[ChainId.mainnet]
.isFetching,
).toBe(false);
},
);
});

it('should refresh tokens after threshold time has elapsed', async () => {
const chainId = ChainId.mainnet;
const initialAddresses = ['0x123', '0x456'];
const newAddresses = ['0x123', '0x456', '0x789'];
const fetchTokensMock = jest
.fn()
.mockResolvedValueOnce(initialAddresses.map((address) => ({ address })))
.mockResolvedValueOnce(newAddresses.map((address) => ({ address })));

const testClock = useFakeTimers();
const initialTime = Date.now();

try {
testClock.setSystemTime(initialTime);

await withController(
{
mockFetchTokens: fetchTokensMock,
mockFetchSwapsTokensThresholdMs: 1000,
},
async ({ controller }) => {
await controller.fetchSwapsTokens(chainId);
expect(
controller.state.swapsTokenAddressesByChainId[chainId].addresses,
).toStrictEqual(initialAddresses);

await controller.fetchSwapsTokens(chainId);
expect(fetchTokensMock).toHaveBeenCalledTimes(1);

const fetchThreshold = 86400000;
testClock.tick(fetchThreshold + 1000);

await controller.fetchSwapsTokens(chainId);
expect(fetchTokensMock).toHaveBeenCalledTimes(2);
expect(
controller.state.swapsTokenAddressesByChainId[chainId].addresses,
).toStrictEqual(newAddresses);
},
);
} finally {
testClock.restore();
}
});
});

describe('fetchTokenDisplayData', () => {
Expand Down Expand Up @@ -611,19 +415,6 @@ describe('TokenSearchDiscoveryDataController', () => {
);
});

it('should call fetchSwapsTokens before fetching token display data', async () => {
const tokenAddress = '0x0000000000000000000000000000000000000010';
const tokenChainId = ChainId.mainnet;

await withController(async ({ controller }) => {
const fetchSwapsTokensSpy = jest.spyOn(controller, 'fetchSwapsTokens');

await controller.fetchTokenDisplayData(tokenChainId, tokenAddress);

expect(fetchSwapsTokensSpy).toHaveBeenCalledWith(tokenChainId);
});
});

it('should handle currency changes correctly', async () => {
const tokenAddress = '0x0000000000000000000000000000000000000010';
const tokenChainId = ChainId.mainnet;
Expand Down Expand Up @@ -907,7 +698,6 @@ describe('TokenSearchDiscoveryDataController', () => {

expect(defaultState).toStrictEqual({
tokenDisplayData: [],
swapsTokenAddressesByChainId: {},
});
});
});
Expand Down Expand Up @@ -947,7 +737,6 @@ describe('TokenSearchDiscoveryDataController', () => {
),
).toMatchInlineSnapshot(`
Object {
"swapsTokenAddressesByChainId": Object {},
"tokenDisplayData": Array [],
}
`);
Expand All @@ -964,7 +753,6 @@ describe('TokenSearchDiscoveryDataController', () => {
),
).toMatchInlineSnapshot(`
Object {
"swapsTokenAddressesByChainId": Object {},
"tokenDisplayData": Array [],
}
`);
Expand Down
Loading
Loading