From 3748f243f5d6d55bc626007d7561592cab7b5f1e Mon Sep 17 00:00:00 2001 From: cryptodev-2s <109512101+cryptodev-2s@users.noreply.github.com> Date: Tue, 4 Feb 2025 17:52:03 +0100 Subject: [PATCH] chore(earn): Rename ControllerMessenger to Messenger (#5268) ## Explanation Rename `RestrictedControllerMessenger` to `RestrictedMessenger` and `ControllerMessenger` to `Messenger` in the `@metamask/earn-controller` package. ## References Relates to #4538 ## Changelog No functional changes. ## 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 highlighted breaking changes using the "BREAKING" category above as appropriate - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes --- packages/earn-controller/src/EarnController.test.ts | 8 ++++---- packages/earn-controller/src/EarnController.ts | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/earn-controller/src/EarnController.test.ts b/packages/earn-controller/src/EarnController.test.ts index d0f6f906627..3b0ab5ca796 100644 --- a/packages/earn-controller/src/EarnController.test.ts +++ b/packages/earn-controller/src/EarnController.test.ts @@ -1,5 +1,5 @@ import type { AccountsController } from '@metamask/accounts-controller'; -import { ControllerMessenger } from '@metamask/base-controller'; +import { Messenger } from '@metamask/base-controller'; import { getDefaultNetworkControllerState } from '@metamask/network-controller'; import { StakeSdk, StakingApiService } from '@metamask/stake-sdk'; @@ -30,12 +30,12 @@ jest.mock('@metamask/stake-sdk', () => ({ })); /** - * Builds a new instance of the ControllerMessenger class for the AccountsController. + * Builds a new instance of the Messenger class for the AccountsController. * - * @returns A new instance of the ControllerMessenger class for the AccountsController. + * @returns A new instance of the Messenger class for the AccountsController. */ function buildMessenger() { - return new ControllerMessenger< + return new Messenger< EarnControllerActions | AllowedActions, EarnControllerEvents | AllowedEvents >(); diff --git a/packages/earn-controller/src/EarnController.ts b/packages/earn-controller/src/EarnController.ts index 03ca548f8eb..5ce6e71280e 100644 --- a/packages/earn-controller/src/EarnController.ts +++ b/packages/earn-controller/src/EarnController.ts @@ -6,7 +6,7 @@ import type { import type { ControllerGetStateAction, ControllerStateChangeEvent, - RestrictedControllerMessenger, + RestrictedMessenger, StateMetadata, } from '@metamask/base-controller'; import { BaseController } from '@metamask/base-controller'; @@ -163,7 +163,7 @@ export type AllowedEvents = * The messenger which is restricted to actions and events accessed by * EarnController. */ -export type EarnControllerMessenger = RestrictedControllerMessenger< +export type EarnControllerMessenger = RestrictedMessenger< typeof controllerName, EarnControllerActions | AllowedActions, EarnControllerEvents | AllowedEvents,