Skip to content
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.

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

chore: Core controllers v300 #13528

Merged
merged 10 commits into from
Feb 17, 2025
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
17 changes: 7 additions & 10 deletions app/components/UI/NonEvmTokens/index.test.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
import React from 'react';
import NonEvmTokens from './';
import renderWithProvider from '../../../util/test/renderWithProvider';
import {
MultichainNetworks,
MultichainNativeAssets,
Cryptocurrency,
} from '@metamask/assets-controllers';
import { Cryptocurrency } from '@metamask/assets-controllers';
import { MULTICHAIN_PROVIDER_CONFIGS } from '../../../core/Multichain/constants';
import { WalletViewSelectorsIDs } from '../../../../e2e/selectors/wallet/WalletView.selectors';
import {
Expand All @@ -14,6 +10,8 @@ import {
} from '../../../util/test/accountsControllerTestUtils';
import { createStackNavigator } from '@react-navigation/stack';
import { RootState } from '../../../reducers';
import { SolScope } from '@metamask/keyring-api';
import { MultichainNativeAssets } from '../../../selectors/multichain';

const mockNavigate = jest.fn();
const mockPush = jest.fn();
Expand Down Expand Up @@ -46,7 +44,7 @@ const initialState = {
},
AccountTrackerController: {
accountsByChainId: {
[MultichainNetworks.Solana]: {
[SolScope.Mainnet]: {
[MOCK_SOLANA_ACCOUNT.address]: {
balance: '5.5',
},
Expand Down Expand Up @@ -76,16 +74,15 @@ const initialState = {
},
MultichainController: {
selectedNetwork: {
chainId: MultichainNetworks.Solana,
nickname:
MULTICHAIN_PROVIDER_CONFIGS[MultichainNetworks.Solana].nickname,
chainId: SolScope.Mainnet,
nickname: MULTICHAIN_PROVIDER_CONFIGS[SolScope.Mainnet].nickname,
isEvmNetwork: false,
},
defaultToken: {
symbol: 'SOL',
decimals: 9,
isNative: true,
name: MULTICHAIN_PROVIDER_CONFIGS[MultichainNetworks.Solana].nickname,
name: MULTICHAIN_PROVIDER_CONFIGS[SolScope.Mainnet].nickname,
},
selectedAccountCachedBalance: '5.5',
},
Expand Down
15 changes: 10 additions & 5 deletions app/components/UI/NonEvmTokens/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
MULTICHAIN_TOKEN_IMAGES,
MultichainProviderConfig,
} from '../../../core/Multichain/constants';
import { selectSelectedInternalAccount } from '../../../selectors/accountsController';

// We need this type to match ScrollableTabView's requirements
interface NonEvmTokensProps {
Expand All @@ -37,6 +38,7 @@ const NonEvmTokens: React.FC<NonEvmTokensProps> = () => {
const conversionRate = useSelector(selectMultichainConversionRate);
const shouldShowFiat = useSelector(selectMultichainShouldShowFiat);
const networkConfig = useSelector(selectMultichainCurrentNetwork);
const selectedAccount = useSelector(selectSelectedInternalAccount);

function getMultiChainFiatBalance(): string {
if (conversionRate) {
Expand Down Expand Up @@ -79,11 +81,14 @@ const NonEvmTokens: React.FC<NonEvmTokensProps> = () => {
setRefreshing(true);

const { MultichainBalancesController } = Engine.context;

const actions = [MultichainBalancesController.updateBalances()];
await Promise.all(actions).catch((error) => {
Logger.error(error, 'Error while refreshing NonEvm tokens');
});
if (selectedAccount) {
const actions = [
MultichainBalancesController.updateBalance(selectedAccount?.id),
];
await Promise.all(actions).catch((error) => {
Logger.error(error, 'Error while refreshing NonEvm tokens');
});
}
setRefreshing(false);
});
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import {
selectIsBitcoinTestnetSupportEnabled,
selectIsSolanaSupportEnabled,
} from '../../../selectors/multichain';
import { MultichainNetworks } from '@metamask/assets-controllers';
import { BtcScope, SolScope } from '@metamask/keyring-api';
///: END:ONLY_INCLUDE_IF

const AddAccountActions = ({ onBack }: AddAccountActionsProps) => {
Expand Down Expand Up @@ -158,7 +158,7 @@ const AddAccountActions = ({ onBack }: AddAccountActionsProps) => {
actionTitle={strings('account_actions.add_solana_account')}
iconName={IconName.Add}
onPress={async () => {
await createSolanaAccount(MultichainNetworks.Solana);
await createSolanaAccount(SolScope.Mainnet);
}}
disabled={isLoading}
testID={
Expand All @@ -173,7 +173,7 @@ const AddAccountActions = ({ onBack }: AddAccountActionsProps) => {
)}
iconName={IconName.Add}
onPress={async () => {
await createBitcoinAccount(MultichainNetworks.Bitcoin);
await createBitcoinAccount(BtcScope.Mainnet);
}}
disabled={isLoading || isBtcMainnetAccountAlreadyCreated}
testID={
Expand All @@ -188,7 +188,7 @@ const AddAccountActions = ({ onBack }: AddAccountActionsProps) => {
)}
iconName={IconName.Add}
onPress={async () => {
await createBitcoinAccount(MultichainNetworks.BitcoinTestnet);
await createBitcoinAccount(BtcScope.Testnet);
}}
disabled={isLoading || isBtcTestnetAccountAlreadyCreated}
testID={
Expand Down
1 change: 1 addition & 0 deletions app/core/Engine/Engine.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ describe('Engine', () => {
expect(engine.context).toHaveProperty('SelectedNetworkController');
expect(engine.context).toHaveProperty('MultichainBalancesController');
expect(engine.context).toHaveProperty('RatesController');
expect(engine.context).toHaveProperty('MultichainNetworkController');
});

it('calling Engine.init twice returns the same instance', () => {
Expand Down
83 changes: 61 additions & 22 deletions app/core/Engine/Engine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ import {
AccountsControllerSetAccountNameAction,
AccountsControllerListMultichainAccountsAction,
AccountsControllerAccountRemovedEvent,
AccountsControllerAccountAssetListUpdatedEvent,

///: END:ONLY_INCLUDE_IF
AccountsControllerGetAccountAction,
AccountsControllerGetSelectedAccountAction,
Expand All @@ -173,7 +175,11 @@ import SmartTransactionsController from '@metamask/smart-transactions-controller
import { getAllowedSmartTransactionsChainIds } from '../../../app/constants/smartTransactions';
import { selectBasicFunctionalityEnabled } from '../../selectors/settings';
import { selectShouldUseSmartTransaction } from '../../selectors/smartTransactionsController';
import { selectSwapsChainFeatureFlags, selectSwapsQuotes, selectSwapsTopAggId } from '../../reducers/swaps';
import {
selectSwapsChainFeatureFlags,
selectSwapsQuotes,
selectSwapsTopAggId,
} from '../../reducers/swaps';
import {
SmartTransactionStatuses,
ClientId,
Expand Down Expand Up @@ -203,7 +209,10 @@ import { setupCurrencyRateSync } from './controllers/RatesController/subscriptio
import { HandleSnapRequestArgs } from '../Snaps/types';
import { handleSnapRequest } from '../Snaps/utils';
///: END:ONLY_INCLUDE_IF
import { getSmartTransactionMetricsProperties, getGasIncludedTransactionFees } from '../../util/smart-transactions';
import {
getSmartTransactionMetricsProperties,
getGasIncludedTransactionFees,
} from '../../util/smart-transactions';
import { trace } from '../../util/trace';
import { MetricsEventBuilder } from '../Analytics/MetricsEventBuilder';
import { JsonMap } from '../Analytics/MetaMetrics.types';
Expand Down Expand Up @@ -236,6 +245,10 @@ import {
SnapKeyringAccountBalancesUpdatedEvent,
SnapKeyringAccountTransactionsUpdatedEvent,
} from '../SnapKeyring/constants';
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
import { createMultichainAssetsController } from './controllers/MultichainAssetsController';
///: END:ONLY_INCLUDE_IF
import { createMultichainNetworkController } from './controllers/MultichainNetworkController';

const NON_EMPTY = 'NON_EMPTY';

Expand Down Expand Up @@ -363,8 +376,22 @@ export class Engine {

networkController.initializeProvider();

const multichainNetworkControllerMessenger =
this.controllerMessenger.getRestricted({
name: 'MultichainNetworkController',
allowedActions: [
'NetworkController:setActiveNetwork',
'NetworkController:getState',
],
allowedEvents: ['AccountsController:selectedAccountChange'],
});

const multichainNetworkController = createMultichainNetworkController({
messenger: multichainNetworkControllerMessenger,
initialState: initialState.MultichainNetworkController,
});

const assetsContractController = new AssetsContractController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'AssetsContractController',
allowedActions: [
Expand Down Expand Up @@ -392,6 +419,7 @@ export class Engine {
SnapKeyringAccountAssetListUpdatedEvent,
SnapKeyringAccountBalancesUpdatedEvent,
SnapKeyringAccountTransactionsUpdatedEvent,
'MultichainNetworkController:networkDidChange',
],
allowedActions: [
'KeyringController:getAccounts',
Expand All @@ -405,13 +433,31 @@ export class Engine {
});

///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.

const multichainAssetsControllerMessenger =
this.controllerMessenger.getRestricted({
name: 'MultichainAssetsController',
allowedEvents: [
AccountsControllerAccountAddedEvent,
AccountsControllerAccountRemovedEvent,
AccountsControllerAccountAssetListUpdatedEvent,
],
allowedActions: [AccountsControllerListMultichainAccountsAction],
});

const multichainAssetsController = createMultichainAssetsController({
messenger: multichainAssetsControllerMessenger,
initialState: initialState.MultichainAssetsController,
});

const multichainBalancesControllerMessenger: MultichainBalancesControllerMessenger =
this.controllerMessenger.getRestricted({
name: 'MultichainBalancesController',
allowedEvents: [
AccountsControllerAccountAddedEvent,
AccountsControllerAccountRemovedEvent,
'AccountsController:accountBalancesUpdated',
'MultichainAssetsController:stateChange',
],
allowedActions: [
AccountsControllerListMultichainAccountsAction,
Expand All @@ -432,7 +478,6 @@ export class Engine {
});

const multichainRatesController = createMultichainRatesController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: multichainRatesControllerMessenger,
initialState: initialState.RatesController,
});
Expand All @@ -447,7 +492,6 @@ export class Engine {
const nftController = new NftController({
chainId: getGlobalChainId(networkController),
useIpfsSubdomains: false,
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'NftController',
allowedActions: [
Expand Down Expand Up @@ -488,7 +532,6 @@ export class Engine {
// @ts-expect-error at this point in time the provider will be defined by the `networkController.initializeProvider`
provider: networkController.getProviderAndBlockTracker().provider,
state: initialState.TokensController,
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'TokensController',
allowedActions: [
Expand All @@ -513,15 +556,13 @@ export class Engine {
AppConstants.NETWORK_STATE_CHANGE_EVENT,
listener,
),
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'TokenListController',
allowedActions: [`${networkController.name}:getNetworkClientById`],
allowedEvents: [`${networkController.name}:stateChange`],
}),
});
const currencyRateController = new CurrencyRateController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'CurrencyRateController',
allowedActions: [`${networkController.name}:getNetworkClientById`],
Expand Down Expand Up @@ -795,7 +836,6 @@ export class Engine {
});

const accountTrackerController = new AccountTrackerController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'AccountTrackerController',
allowedActions: [
Expand Down Expand Up @@ -1231,13 +1271,12 @@ export class Engine {
networkController.getNetworkClientRegistry.bind(networkController),
getNetworkState: () => networkController.state,
hooks: {
publish: (transactionMeta) => {
publish: (transactionMeta) => {
const state = store.getState();
const shouldUseSmartTransaction = selectShouldUseSmartTransaction(
state,
);
const shouldUseSmartTransaction =
selectShouldUseSmartTransaction(state);
const swapsQuotes = selectSwapsQuotes(state);
// We can choose the top agg id for now. Once selection is enabled, we need
// We can choose the top agg id for now. Once selection is enabled, we need
// to look for a selected agg id.
const swapsTopAggId = selectSwapsTopAggId(state);
const selectedQuote = swapsQuotes?.[swapsTopAggId];
Expand All @@ -1251,7 +1290,7 @@ export class Engine {
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
controllerMessenger: this.controllerMessenger,
featureFlags: selectSwapsChainFeatureFlags(state),
transactionFees
transactionFees,
}) as Promise<{ transactionHash: string }>;
},
},
Expand Down Expand Up @@ -1365,7 +1404,6 @@ export class Engine {
TokensController: tokensController,
TokenListController: tokenListController,
TokenDetectionController: new TokenDetectionController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'TokenDetectionController',
allowedActions: [
Expand Down Expand Up @@ -1413,7 +1451,6 @@ export class Engine {
disabled: false,
}),
NftDetectionController: new NftDetectionController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'NftDetectionController',
allowedEvents: [
Expand All @@ -1437,7 +1474,6 @@ export class Engine {
PhishingController: phishingController,
PreferencesController: preferencesController,
TokenBalancesController: new TokenBalancesController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'TokenBalancesController',
allowedActions: [
Expand All @@ -1458,7 +1494,6 @@ export class Engine {
state: initialState.TokenBalancesController,
}),
TokenRatesController: new TokenRatesController({
// @ts-expect-error TODO: Resolve mismatch between base-controller versions.
messenger: this.controllerMessenger.getRestricted({
name: 'TokenRatesController',
allowedActions: [
Expand Down Expand Up @@ -1587,7 +1622,9 @@ export class Engine {
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
MultichainBalancesController: multichainBalancesController,
RatesController: multichainRatesController,
MultichainAssetsController: multichainAssetsController,
///: END:ONLY_INCLUDE_IF
MultichainNetworkController: multichainNetworkController,
};

const childControllers = Object.assign({}, this.context);
Expand Down Expand Up @@ -1784,8 +1821,6 @@ export class Engine {
TransactionController.startIncomingTransactionPolling([chainId]);

///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
this.context.MultichainBalancesController.start();
this.context.MultichainBalancesController.updateBalances();
this.context.RatesController.start();
///: END:ONLY_INCLUDE_IF
}
Expand Down Expand Up @@ -2211,7 +2246,9 @@ export default {
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
MultichainBalancesController,
RatesController,
MultichainAssetsController,
///: END:ONLY_INCLUDE_IF
MultichainNetworkController,
} = instance.datamodel.state;

return {
Expand Down Expand Up @@ -2250,7 +2287,9 @@ export default {
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
MultichainBalancesController,
RatesController,
MultichainAssetsController,
///: END:ONLY_INCLUDE_IF
MultichainNetworkController,
};
},

Expand Down
2 changes: 2 additions & 0 deletions app/core/Engine/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,7 @@ export const BACKGROUND_STATE_CHANGE_EVENT_NAMES = [
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
MultichainBalancesControllerStateChangeEvent,
RatesControllerStateChangeEvent,
// TODO: Export this from the assets controller
'MultichainAssetsController:stateChange',
///: END:ONLY_INCLUDE_IF
] as const;
Loading
Loading