Skip to content

[token-detection-controller] Refactor detectTokens method #3928

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

Closed
MajorLift wants to merge 1 commit into from
Closed

[token-detection-controller] Refactor detectTokens method #3928

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
166 changes: 105 additions & 61 deletions packages/assets-controllers/src/TokenDetectionController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,12 @@ export class TokenDetectionController extends StaticIntervalPollingController<

#networkClientId: NetworkClientId;

#chainIdAgainstWhichToDetect: Hex;

#addressAgainstWhichToDetect: string;

#networkClientIdAgainstWhichToDetect: NetworkClientId;

#disabled: boolean;

#isUnlocked: boolean;
Expand Down Expand Up @@ -229,14 +235,18 @@ export class TokenDetectionController extends StaticIntervalPollingController<
this.#disabled = disabled;
this.setIntervalLength(interval);

this.#networkClientId = networkClientId;
this.#selectedAddress =
selectedAddress ??
this.messagingSystem.call('AccountsController:getSelectedAccount')
.address;
const { chainId } =
this.#addressAgainstWhichToDetect = this.#selectedAddress;

const { chainId, networkClientId: correctNetworkClientId } =
this.#getCorrectChainIdAndNetworkClientId(networkClientId);
this.#chainId = chainId;
this.#chainIdAgainstWhichToDetect = this.#chainId;
this.#networkClientId = correctNetworkClientId;
this.#networkClientIdAgainstWhichToDetect = this.#networkClientId;

const { useTokenDetection: defaultUseTokenDetection } =
this.messagingSystem.call('PreferencesController:getState');
Expand Down Expand Up @@ -483,33 +493,52 @@ export class TokenDetectionController extends StaticIntervalPollingController<
return;
}

const addressAgainstWhichToDetect = accountAddress ?? this.#selectedAddress;
const {
chainId: chainIdAgainstWhichToDetect,
networkClientId: networkClientIdAgainstWhichToDetect,
} = this.#getCorrectChainIdAndNetworkClientId(networkClientId);
this.#addressAgainstWhichToDetect = accountAddress ?? this.#selectedAddress;
const { chainId, networkClientId: selectedNetworkClientId } =
this.#getCorrectChainIdAndNetworkClientId(networkClientId);
this.#chainIdAgainstWhichToDetect = chainId;
this.#networkClientIdAgainstWhichToDetect = selectedNetworkClientId;

if (!isTokenDetectionSupportedForNetwork(chainIdAgainstWhichToDetect)) {
if (
!isTokenDetectionSupportedForNetwork(this.#chainIdAgainstWhichToDetect)
) {
return;
}

if (
!this.#isDetectionEnabledFromPreferences &&
chainIdAgainstWhichToDetect !== ChainId.mainnet
this.#chainIdAgainstWhichToDetect !== ChainId.mainnet
) {
return;
}
const { tokenList, slicesOfTokensToDetect } =
this.#getTokenListAndSlicesOfTokensToDetect();
for (const tokensSlice of slicesOfTokensToDetect) {
if (tokensSlice.length === 0) {
break;
}
await this.#addDetectedTokens({
tokenList,
tokensSlice,
});
}
}

#getTokenListAndSlicesOfTokensToDetect(): {
tokenList: Record<
string,
Pick<TokenListToken, 'address' | 'decimals' | 'symbol'>
>;
slicesOfTokensToDetect: string[][];
} {
const isTokenDetectionInactiveInMainnet =
!this.#isDetectionEnabledFromPreferences &&
chainIdAgainstWhichToDetect === ChainId.mainnet;
this.#chainIdAgainstWhichToDetect === ChainId.mainnet;
const { tokensChainsCache } = this.messagingSystem.call(
'TokenListController:getState',
);
const tokenList =
tokensChainsCache[chainIdAgainstWhichToDetect]?.data ?? {};
const tokenListUsed = isTokenDetectionInactiveInMainnet
const tokenList = isTokenDetectionInactiveInMainnet
? STATIC_MAINNET_TOKEN_LIST
: tokenList;
: tokensChainsCache[this.#chainIdAgainstWhichToDetect]?.data ?? {};

const { allTokens, allDetectedTokens, allIgnoredTokens } =
this.messagingSystem.call('TokensController:getState');
Expand All @@ -519,9 +548,12 @@ export class TokenDetectionController extends StaticIntervalPollingController<
allIgnoredTokens,
].map((tokens) =>
(
tokens[chainIdAgainstWhichToDetect]?.[addressAgainstWhichToDetect] ?? []
tokens[this.#chainIdAgainstWhichToDetect]?.[
this.#addressAgainstWhichToDetect
] ?? []
).map((value) => (typeof value === 'string' ? value : value.address)),
);

const tokensToDetect: string[] = [];
for (const tokenAddress of Object.keys(tokenList)) {
if (
Expand All @@ -535,60 +567,72 @@ export class TokenDetectionController extends StaticIntervalPollingController<
tokensToDetect.push(tokenAddress);
}
}

const slicesOfTokensToDetect = [];
slicesOfTokensToDetect[0] = tokensToDetect.slice(0, 1000);
slicesOfTokensToDetect[1] = tokensToDetect.slice(
1000,
tokensToDetect.length - 1,
);
for (const tokensSlice of slicesOfTokensToDetect) {
if (tokensSlice.length === 0) {
break;

return { tokenList, slicesOfTokensToDetect };
}

async #addDetectedTokens({
tokenList,
tokensSlice,
}: {
tokenList: Record<
string,
Partial<TokenListToken> & Pick<Token, 'address' | 'symbol' | 'decimals'>
>;
tokensSlice: string[];
}): Promise<void> {
await safelyExecute(async () => {
const balances = await this.#getBalancesInSingleCall(
this.#addressAgainstWhichToDetect,
tokensSlice,
this.#networkClientIdAgainstWhichToDetect,
);

const tokensWithBalance: Token[] = [];
const eventTokensDetails: string[] = [];
for (const nonZeroTokenAddress of Object.keys(balances)) {
const { decimals, symbol, aggregators, iconUrl, name } =
tokenList[nonZeroTokenAddress];
eventTokensDetails.push(`${symbol} - ${nonZeroTokenAddress}`);
tokensWithBalance.push({
address: nonZeroTokenAddress,
decimals,
symbol,
aggregators,
image: iconUrl,
isERC721: false,
name,
});
}

await safelyExecute(async () => {
const balances = await this.#getBalancesInSingleCall(
addressAgainstWhichToDetect,
tokensSlice,
networkClientIdAgainstWhichToDetect,
if (tokensWithBalance.length) {
this.#trackMetaMetricsEvent({
event: 'Token Detected',
category: 'Wallet',
properties: {
tokens: eventTokensDetails,
token_standard: 'ERC20',
asset_type: 'TOKEN',
},
});

await this.messagingSystem.call(
'TokensController:addDetectedTokens',
tokensWithBalance,
{
selectedAddress: this.#addressAgainstWhichToDetect,
chainId: this.#chainIdAgainstWhichToDetect,
},
);
const tokensWithBalance: Token[] = [];
const eventTokensDetails: string[] = [];
for (const nonZeroTokenAddress of Object.keys(balances)) {
const { decimals, symbol, aggregators, iconUrl, name } =
tokenListUsed[nonZeroTokenAddress];
eventTokensDetails.push(`${symbol} - ${nonZeroTokenAddress}`);
tokensWithBalance.push({
address: nonZeroTokenAddress,
decimals,
symbol,
aggregators,
image: iconUrl,
isERC721: false,
name,
});
}
if (tokensWithBalance.length) {
this.#trackMetaMetricsEvent({
event: 'Token Detected',
category: 'Wallet',
properties: {
tokens: eventTokensDetails,
token_standard: 'ERC20',
asset_type: 'TOKEN',
},
});
await this.messagingSystem.call(
'TokensController:addDetectedTokens',
tokensWithBalance,
{
selectedAddress: addressAgainstWhichToDetect,
chainId: chainIdAgainstWhichToDetect,
},
);
}
});
}
}
});
}
}

Expand Down