Migrate PreferencesController to BaseController v2

[mcmire]

What is this about?

Following the Wallet Framework team's OKRs for Q3 2024, we want to bring PreferencesController up to date with our latest controller patterns.

Scenario

No response

Design

No response

Technical Details

No response

Threat Modeling Framework

No response

Acceptance Criteria

• A constant called controllerName exists which holds the name of the controller.
• A constant called controllerMetadata exists which holds the metadata for the state.
• The default state object is extracted to a function called getDefaultPreferencesControllerState.
• PreferencesController inherits from BaseController instead of EventEmitter.
  • The PreferencesController constructor signature is updated to take a partial state option instead of initState.
  • The PreferencesController constructor is updated to super to the superclass.
  • PreferencesController uses this.messagingSystem to refer to the messenger.
  • PreferencesController no longer registers PreferencesController:getState or an initial event payload for PreferencesController:stateChange (as this is done automatically).
  • PreferencesController no longer takes or sets a network property.
  • PreferencesController uses NetworkController:getState to get networkConfigurationsByChainId instead of taking a networkConfigurationsByChainId option.
  • this.state is used to access state instead of this.store.getState.
  • this.update is used to update state instead of this.store.updateState.
• Supporting types exist.
  • The PreferencesControllerState type exists and represents the current shape of the state object.
  • The PreferencesControllerGetStateAction and PreferencesControllerStateChangeEvent types exist.
  • The PreferencesControllerActions and PreferencesControllerEvents types exist.
  • The AllowedActions and AllowedEvents types exist.
  • The PreferencesControllerMessenger type exists and expects AccountsController:stateChange, NetworkController:getState, AccountsController:getAccountByAddress, AccountsController:setSelectedAccount, and AccountsController:setAccountName to be allowed.
  • PreferencesControllerState exists and represents the current shape of the state object.
• The tests are updated to follow suit.
  • preferencesController.state is used to access state instead of preferencesController.store.getState().
  • ❌ The use of beforeEach is not corrected, as this would take too long. We can solve this in another PR.

Stakeholder review needed before the work gets merged

• Engineering (needed in most cases)
• Design
• Product
• QA (automation tests are required to pass before merging PRs but not all changes are covered by automation tests - please review if QA is needed beyond automation tests)
• Security
• Legal
• Marketing
• Management (please specify)
• Other (please specify)

References

• Ensure that all controllers used across clients are using BaseControllerV2 core#1509