Skip to content

Commit 55c30e2

Browse files
BelfordZBelfordZ
authored
Change naming of provider to providerConfig where applicable (#995)
fixes #994
1 parent 5f1f69d commit 55c30e2

18 files changed

+136
-130
lines changed

‎packages/assets-controllers/src/AssetsContractController.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ export class AssetsContractController extends BaseController<
114114
});
115115

116116
onNetworkStateChange((networkState) => {
117-
if (this.config.chainId !== networkState.provider.chainId) {
117+
if (this.config.chainId !== networkState.providerConfig.chainId) {
118118
this.configure({
119-
chainId: networkState.provider.chainId,
119+
chainId: networkState.providerConfig.chainId,
120120
});
121121
}
122122
});

‎packages/assets-controllers/src/NftController.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -952,8 +952,8 @@ export class NftController extends BaseController<NftConfig, NftState> {
952952
},
953953
);
954954

955-
onNetworkStateChange(({ provider }) => {
956-
const { chainId } = provider;
955+
onNetworkStateChange(({ providerConfig }) => {
956+
const { chainId } = providerConfig;
957957
this.configure({ chainId });
958958
});
959959
}

‎packages/assets-controllers/src/NftDetectionController.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,10 @@ export class NftDetectionController extends BaseController<
267267
}
268268
});
269269

270-
onNetworkStateChange(({ provider }) => {
270+
onNetworkStateChange(({ providerConfig }) => {
271271
this.configure({
272-
networkType: provider.type,
273-
chainId: provider.chainId as NftDetectionConfig['chainId'],
272+
networkType: providerConfig.type,
273+
chainId: providerConfig.chainId as NftDetectionConfig['chainId'],
274274
});
275275
});
276276
this.getOpenSeaApiKey = getOpenSeaApiKey;

‎packages/assets-controllers/src/TokenDetectionController.test.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { BN } from 'ethereumjs-util';
44
import {
55
NetworkController,
66
NetworkControllerMessenger,
7-
NetworkControllerProviderChangeEvent,
7+
NetworkControllerProviderConfigChangeEvent,
88
NetworkControllerStateChangeEvent,
99
} from '@metamask/network-controller';
1010
import { NetworksChainId, MAINNET } from '@metamask/controller-utils';
@@ -86,7 +86,7 @@ const sampleTokenB: Token = {
8686
type MainControllerMessenger = ControllerMessenger<
8787
GetTokenListState,
8888
| TokenListStateChange
89-
| NetworkControllerProviderChangeEvent
89+
| NetworkControllerProviderConfigChangeEvent
9090
| NetworkControllerStateChangeEvent
9191
>;
9292

@@ -100,7 +100,7 @@ const setupNetworkController = (
100100
const networkMessenger = controllerMessenger.getRestricted({
101101
name: 'NetworkController',
102102
allowedEvents: [
103-
'NetworkController:providerChange',
103+
'NetworkController:providerConfigChange',
104104
'NetworkController:stateChange',
105105
],
106106
allowedActions: [],
@@ -122,7 +122,7 @@ const setupTokenListController = (
122122
allowedActions: [],
123123
allowedEvents: [
124124
'TokenListController:stateChange',
125-
'NetworkController:providerChange',
125+
'NetworkController:providerConfigChange',
126126
],
127127
});
128128

@@ -468,7 +468,7 @@ describe('TokenDetectionController', () => {
468468
tokenDetection.stop();
469469
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
470470
await networkStateChangeListener!({
471-
provider: { chainId: polygonDecimalChainId },
471+
providerConfig: { chainId: polygonDecimalChainId },
472472
});
473473

474474
expect(getBalancesInSingleCallMock.called).toBe(false);
@@ -572,7 +572,7 @@ describe('TokenDetectionController', () => {
572572

573573
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
574574
await networkStateChangeListener!({
575-
provider: { chainId: NetworksChainId.mainnet },
575+
providerConfig: { chainId: NetworksChainId.mainnet },
576576
});
577577

578578
expect(getBalancesInSingleCallMock.called).toBe(true);

‎packages/assets-controllers/src/TokenDetectionController.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ export class TokenDetectionController extends BaseController<
105105
state?: Partial<BaseState>,
106106
) {
107107
const {
108-
provider: { chainId: defaultChainId },
108+
providerConfig: { chainId: defaultChainId },
109109
} = getNetworkState();
110110
const { useTokenDetection: defaultUseTokenDetection } =
111111
getPreferencesState();
@@ -159,7 +159,7 @@ export class TokenDetectionController extends BaseController<
159159
}
160160
});
161161

162-
onNetworkStateChange(({ provider: { chainId } }) => {
162+
onNetworkStateChange(({ providerConfig: { chainId } }) => {
163163
const { chainId: currentChainId } = this.config;
164164
const isDetectionEnabledForNetwork =
165165
isTokenDetectionSupportedForNetwork(chainId);

‎packages/assets-controllers/src/TokenListController.test.ts

+25-25
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import nock from 'nock';
33
import { ControllerMessenger } from '@metamask/base-controller';
44
import {
55
NetworkController,
6-
NetworkControllerProviderChangeEvent,
6+
NetworkControllerProviderConfigChangeEvent,
77
} from '@metamask/network-controller';
88
import { NetworksChainId } from '@metamask/controller-utils';
99
import {
@@ -473,7 +473,7 @@ const expiredCacheExistingState: TokenListState = {
473473

474474
type MainControllerMessenger = ControllerMessenger<
475475
GetTokenListState,
476-
TokenListStateChange | NetworkControllerProviderChangeEvent
476+
TokenListStateChange | NetworkControllerProviderConfigChangeEvent
477477
>;
478478

479479
const getControllerMessenger = (): MainControllerMessenger => {
@@ -485,7 +485,7 @@ const setupNetworkController = (
485485
) => {
486486
const networkMessenger = controllerMessenger.getRestricted({
487487
name: 'NetworkController',
488-
allowedEvents: ['NetworkController:providerChange'],
488+
allowedEvents: ['NetworkController:providerConfigChange'],
489489
allowedActions: [],
490490
});
491491

@@ -505,7 +505,7 @@ const getRestrictedMessenger = (
505505
allowedActions: [],
506506
allowedEvents: [
507507
'TokenListController:stateChange',
508-
'NetworkController:providerChange',
508+
'NetworkController:providerConfigChange',
509509
],
510510
});
511511

@@ -536,7 +536,7 @@ describe('TokenListController', () => {
536536

537537
controller.destroy();
538538
controllerMessenger.clearEventSubscriptions(
539-
'NetworkController:providerChange',
539+
'NetworkController:providerConfigChange',
540540
);
541541
});
542542

@@ -586,7 +586,7 @@ describe('TokenListController', () => {
586586

587587
controller.destroy();
588588
controllerMessenger.clearEventSubscriptions(
589-
'NetworkController:providerChange',
589+
'NetworkController:providerConfigChange',
590590
);
591591
});
592592

@@ -607,7 +607,7 @@ describe('TokenListController', () => {
607607

608608
controller.destroy();
609609
controllerMessenger.clearEventSubscriptions(
610-
'NetworkController:providerChange',
610+
'NetworkController:providerConfigChange',
611611
);
612612
});
613613

@@ -627,7 +627,7 @@ describe('TokenListController', () => {
627627

628628
controller.destroy();
629629
controllerMessenger.clearEventSubscriptions(
630-
'NetworkController:providerChange',
630+
'NetworkController:providerConfigChange',
631631
);
632632
});
633633

@@ -645,7 +645,7 @@ describe('TokenListController', () => {
645645
chainId: NetworksChainId.mainnet,
646646
onNetworkStateChange: (callback) =>
647647
controllerMessenger.subscribe(
648-
'NetworkController:providerChange',
648+
'NetworkController:providerConfigChange',
649649
callback,
650650
),
651651
preventPollingOnNetworkRestart: false,
@@ -663,7 +663,7 @@ describe('TokenListController', () => {
663663
expect(controller.state.tokenList).toStrictEqual({});
664664
controller.destroy();
665665
controllerMessenger.clearEventSubscriptions(
666-
'NetworkController:providerChange',
666+
'NetworkController:providerConfigChange',
667667
);
668668
});
669669

@@ -692,7 +692,7 @@ describe('TokenListController', () => {
692692

693693
controller.destroy();
694694
controllerMessenger.clearEventSubscriptions(
695-
'NetworkController:providerChange',
695+
'NetworkController:providerConfigChange',
696696
);
697697
});
698698

@@ -723,7 +723,7 @@ describe('TokenListController', () => {
723723

724724
controller.destroy();
725725
controllerMessenger.clearEventSubscriptions(
726-
'NetworkController:providerChange',
726+
'NetworkController:providerConfigChange',
727727
);
728728
});
729729

@@ -758,7 +758,7 @@ describe('TokenListController', () => {
758758
expect(tokenListMock.calledThrice).toBe(true);
759759
controller.destroy();
760760
controllerMessenger.clearEventSubscriptions(
761-
'NetworkController:providerChange',
761+
'NetworkController:providerConfigChange',
762762
);
763763
});
764764

@@ -784,7 +784,7 @@ describe('TokenListController', () => {
784784
expect(tokenListMock.called).toBe(true);
785785
controller.destroy();
786786
controllerMessenger.clearEventSubscriptions(
787-
'NetworkController:providerChange',
787+
'NetworkController:providerConfigChange',
788788
);
789789
});
790790

@@ -812,7 +812,7 @@ describe('TokenListController', () => {
812812
controller.destroy();
813813
tokenListMock.restore();
814814
controllerMessenger.clearEventSubscriptions(
815-
'NetworkController:providerChange',
815+
'NetworkController:providerConfigChange',
816816
);
817817
});
818818

@@ -852,7 +852,7 @@ describe('TokenListController', () => {
852852
);
853853
controller.destroy();
854854
controllerMessenger.clearEventSubscriptions(
855-
'NetworkController:providerChange',
855+
'NetworkController:providerConfigChange',
856856
);
857857
} finally {
858858
controller.destroy();
@@ -892,7 +892,7 @@ describe('TokenListController', () => {
892892
);
893893
controller.destroy();
894894
controllerMessenger.clearEventSubscriptions(
895-
'NetworkController:providerChange',
895+
'NetworkController:providerConfigChange',
896896
);
897897
});
898898

@@ -919,7 +919,7 @@ describe('TokenListController', () => {
919919
);
920920
controller.destroy();
921921
controllerMessenger.clearEventSubscriptions(
922-
'NetworkController:providerChange',
922+
'NetworkController:providerConfigChange',
923923
);
924924
});
925925

@@ -966,7 +966,7 @@ describe('TokenListController', () => {
966966
).toStrictEqual(sampleWithDuplicateSymbolsTokensChainsCache);
967967
controller.destroy();
968968
controllerMessenger.clearEventSubscriptions(
969-
'NetworkController:providerChange',
969+
'NetworkController:providerConfigChange',
970970
);
971971
});
972972

@@ -994,7 +994,7 @@ describe('TokenListController', () => {
994994
).toStrictEqual(sampleWith3OrMoreOccurrences);
995995
controller.destroy();
996996
controllerMessenger.clearEventSubscriptions(
997-
'NetworkController:providerChange',
997+
'NetworkController:providerConfigChange',
998998
);
999999
});
10001000

@@ -1026,7 +1026,7 @@ describe('TokenListController', () => {
10261026
);
10271027
controller.destroy();
10281028
controllerMessenger.clearEventSubscriptions(
1029-
'NetworkController:providerChange',
1029+
'NetworkController:providerConfigChange',
10301030
);
10311031
});
10321032

@@ -1061,7 +1061,7 @@ describe('TokenListController', () => {
10611061
);
10621062
controller.destroy();
10631063
controllerMessenger.clearEventSubscriptions(
1064-
'NetworkController:providerChange',
1064+
'NetworkController:providerConfigChange',
10651065
);
10661066
});
10671067

@@ -1127,7 +1127,7 @@ describe('TokenListController', () => {
11271127

11281128
controller.destroy();
11291129
controllerMessenger.clearEventSubscriptions(
1130-
'NetworkController:providerChange',
1130+
'NetworkController:providerConfigChange',
11311131
);
11321132
});
11331133

@@ -1149,7 +1149,7 @@ describe('TokenListController', () => {
11491149

11501150
controller.destroy();
11511151
controllerMessenger.clearEventSubscriptions(
1152-
'NetworkController:providerChange',
1152+
'NetworkController:providerConfigChange',
11531153
);
11541154
});
11551155

@@ -1206,7 +1206,7 @@ describe('TokenListController', () => {
12061206
messenger.clearEventSubscriptions('TokenListController:stateChange');
12071207
controller.destroy();
12081208
controllerMessenger.clearEventSubscriptions(
1209-
'NetworkController:providerChange',
1209+
'NetworkController:providerConfigChange',
12101210
);
12111211
resolve();
12121212
});

‎packages/assets-controllers/src/TokenListController.ts

+7-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
} from '@metamask/base-controller';
88
import { safelyExecute } from '@metamask/controller-utils';
99
import {
10-
NetworkControllerProviderChangeEvent,
10+
NetworkControllerProviderConfigChangeEvent,
1111
NetworkState,
1212
ProviderConfig,
1313
} from '@metamask/network-controller';
@@ -62,9 +62,10 @@ export type GetTokenListState = {
6262
type TokenListMessenger = RestrictedControllerMessenger<
6363
typeof name,
6464
GetTokenListState,
65-
TokenListStateChange | NetworkControllerProviderChangeEvent,
65+
TokenListStateChange | NetworkControllerProviderConfigChangeEvent,
6666
never,
67-
TokenListStateChange['type'] | NetworkControllerProviderChangeEvent['type']
67+
| TokenListStateChange['type']
68+
| NetworkControllerProviderConfigChangeEvent['type']
6869
>;
6970

7071
const metadata = {
@@ -146,9 +147,9 @@ export class TokenListController extends BaseControllerV2<
146147
// this check for "provider" is for testing purposes, since in the extension this callback will receive
147148
// an object typed as NetworkState but within repo we can only simulate as if the callback receives an
148149
// object typed as ProviderConfig
149-
if ('provider' in networkStateOrProviderConfig) {
150+
if ('providerConfig' in networkStateOrProviderConfig) {
150151
await this.#onNetworkStateChangeCallback(
151-
networkStateOrProviderConfig.provider,
152+
networkStateOrProviderConfig.providerConfig,
152153
);
153154
} else {
154155
await this.#onNetworkStateChangeCallback(
@@ -158,7 +159,7 @@ export class TokenListController extends BaseControllerV2<
158159
});
159160
} else {
160161
this.messagingSystem.subscribe(
161-
'NetworkController:providerChange',
162+
'NetworkController:providerConfigChange',
162163
async (providerConfig) => {
163164
await this.#onNetworkStateChangeCallback(providerConfig);
164165
},

‎packages/assets-controllers/src/TokenRatesController.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ describe('TokenRatesController', () => {
453453

454454
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
455455
await networkChangeListener!({
456-
provider: { chainId: '4' },
456+
providerConfig: { chainId: '4' },
457457
});
458458

459459
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion

‎packages/assets-controllers/src/TokenRatesController.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,8 @@ export class TokenRatesController extends BaseController<
212212
this.configure({ nativeCurrency: currencyRateState.nativeCurrency });
213213
});
214214

215-
onNetworkStateChange(({ provider }) => {
216-
const { chainId } = provider;
215+
onNetworkStateChange(({ providerConfig }) => {
216+
const { chainId } = providerConfig;
217217
this.update({ contractExchangeRates: {} });
218218
this.configure({ chainId });
219219
});

0 commit comments

Comments
 (0)