Skip to content

Commit ca7494f

Browse files
authored
chore: Use consistent variable name for messenger (#6957)
## Explanation Various variables have been renamed from `messagingSystem` to `messenger` for consistency. These packages have all updated to the next version of the `BaseController`, which dropped the term `messagingSystem` in #6337. ## References N/A ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes <!-- CURSOR_SUMMARY --> --- > [!NOTE] > <sup>[Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) is generating a summary for commit f56bc49. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 59d4b78 commit ca7494f

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

packages/assets-controllers/src/AssetsContractController.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ export type StakedBalance = string | undefined;
216216
export class AssetsContractController {
217217
readonly name: typeof name = name;
218218

219-
protected messagingSystem: AssetsContractControllerMessenger;
219+
protected messenger: AssetsContractControllerMessenger;
220220

221221
#provider: Provider | undefined;
222222

@@ -238,7 +238,7 @@ export class AssetsContractController {
238238
messenger: AssetsContractControllerMessenger;
239239
chainId: Hex;
240240
}) {
241-
this.messagingSystem = messenger;
241+
this.messenger = messenger;
242242
this.#provider = undefined;
243243
this.#ipfsGateway = IPFS_DEFAULT_GATEWAY_URL;
244244
this.#chainId = initialChainId;
@@ -251,7 +251,7 @@ export class AssetsContractController {
251251
#registerActionHandlers() {
252252
const methodsExcludedFromMessenger = [
253253
'constructor',
254-
'messagingSystem',
254+
'messenger',
255255
'setProvider',
256256
'provider',
257257
'ipfsGateway',
@@ -265,7 +265,7 @@ export class AssetsContractController {
265265
!methodsExcludedFromMessenger.find((e) => e === key) &&
266266
typeof this[key] === 'function')(method)
267267
) {
268-
this.messagingSystem.registerActionHandler(
268+
this.messenger.registerActionHandler(
269269
`${name}:${method}`,
270270
// TODO: Write a generic for-loop implementation that iterates over an input union type in tandem with the input array.
271271
// @ts-expect-error Both assigned argument and assignee parameter are using the entire union type for `method` instead of the type for the current element
@@ -277,14 +277,14 @@ export class AssetsContractController {
277277
}
278278

279279
#registerEventSubscriptions() {
280-
this.messagingSystem.subscribe(
280+
this.messenger.subscribe(
281281
`PreferencesController:stateChange`,
282282
({ ipfsGateway }) => {
283283
this.#ipfsGateway = ipfsGateway;
284284
},
285285
);
286286

287-
this.messagingSystem.subscribe(
287+
this.messenger.subscribe(
288288
`NetworkController:networkDidChange`,
289289
({ selectedNetworkClientId }) => {
290290
const chainId = this.#getCorrectChainId(selectedNetworkClientId);
@@ -323,11 +323,11 @@ export class AssetsContractController {
323323
*/
324324
#getCorrectProvider(networkClientId?: NetworkClientId): Web3Provider {
325325
const provider = networkClientId
326-
? this.messagingSystem.call(
326+
? this.messenger.call(
327327
`NetworkController:getNetworkClientById`,
328328
networkClientId,
329329
).provider
330-
: (this.messagingSystem.call('NetworkController:getSelectedNetworkClient')
330+
: (this.messenger.call('NetworkController:getSelectedNetworkClient')
331331
?.provider ?? this.#provider);
332332

333333
if (provider === undefined) {
@@ -345,18 +345,18 @@ export class AssetsContractController {
345345
*/
346346
#getCorrectChainId(networkClientId?: NetworkClientId): Hex {
347347
if (networkClientId) {
348-
const networkClientConfiguration = this.messagingSystem.call(
348+
const networkClientConfiguration = this.messenger.call(
349349
'NetworkController:getNetworkConfigurationByNetworkClientId',
350350
networkClientId,
351351
);
352352
if (networkClientConfiguration) {
353353
return networkClientConfiguration.chainId;
354354
}
355355
}
356-
const { selectedNetworkClientId } = this.messagingSystem.call(
356+
const { selectedNetworkClientId } = this.messenger.call(
357357
'NetworkController:getState',
358358
);
359-
const networkClient = this.messagingSystem.call(
359+
const networkClient = this.messenger.call(
360360
'NetworkController:getNetworkClientById',
361361
selectedNetworkClientId,
362362
);

packages/bridge-status-controller/src/utils/gas.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export const getTxGasEstimates = ({
6262

6363
export const calculateGasFees = async (
6464
disable7702: boolean,
65-
messagingSystem: BridgeStatusControllerMessenger,
65+
messenger: BridgeStatusControllerMessenger,
6666
estimateGasFeeFn: typeof TransactionController.prototype.estimateGasFee,
6767
{ chainId: _, gasLimit, ...trade }: TxData,
6868
networkClientId: string,
@@ -82,7 +82,7 @@ export const calculateGasFees = async (
8282
to: trade.to as `0x${string}`,
8383
value: trade.value as `0x${string}`,
8484
};
85-
const { gasFeeEstimates } = messagingSystem.call('GasFeeController:getState');
85+
const { gasFeeEstimates } = messenger.call('GasFeeController:getState');
8686
const { estimates: txGasFeeEstimates } = await estimateGasFeeFn({
8787
transactionParams,
8888
chainId,

packages/bridge-status-controller/src/utils/transaction.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import type {
3636
export const generateActionId = () => (Date.now() + Math.random()).toString();
3737

3838
export const getUSDTAllowanceResetTx = async (
39-
messagingSystem: BridgeStatusControllerMessenger,
39+
messenger: BridgeStatusControllerMessenger,
4040
quoteResponse: QuoteResponse & Partial<QuoteMetadata>,
4141
) => {
4242
const hexChainId = formatChainIdToHex(quoteResponse.quote.srcChainId);
@@ -45,7 +45,7 @@ export const getUSDTAllowanceResetTx = async (
4545
isEthUsdt(hexChainId, quoteResponse.quote.srcAsset.address)
4646
) {
4747
const allowance = new BigNumber(
48-
await messagingSystem.call(
48+
await messenger.call(
4949
'BridgeController:getBridgeERC20Allowance',
5050
quoteResponse.quote.srcAsset.address,
5151
hexChainId,

packages/composable-controller/src/ComposableController.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ class FooController extends BaseController<
6767
FooControllerState,
6868
FooMessenger
6969
> {
70-
constructor(messagingSystem: FooMessenger) {
70+
constructor(messenger: FooMessenger) {
7171
super({
72-
messenger: messagingSystem,
72+
messenger,
7373
metadata: fooControllerStateMetadata,
7474
name: 'FooController',
7575
state: { foo: 'foo' },
@@ -116,9 +116,9 @@ class QuzController extends BaseController<
116116
QuzControllerState,
117117
QuzMessenger
118118
> {
119-
constructor(messagingSystem: QuzMessenger) {
119+
constructor(messenger: QuzMessenger) {
120120
super({
121-
messenger: messagingSystem,
121+
messenger,
122122
metadata: quzControllerStateMetadata,
123123
name: 'QuzController',
124124
state: { quz: 'quz' },

0 commit comments

Comments
 (0)