feat: add NetworkController NetworkConfiguration actions and events

[Prithpal-Sooriya]

Explanation

This adds and exposes some new actions and events inside the network controller.

Events:

• NetworkController:networkRemoved

Actions

• NetworkController:updateNetwork
• NetworkController:addNetwork
• NetworkController:removeNetwork

These will be used for the network syncing feature (see references)

References

https://consensyssoftware.atlassian.net/browse/NOTIFY-1089

Changelog

@metamask/network-controller

• ADDED: (BREAKING) add new event NetworkController:networkRemoved
• ADDED: (BREAKING) add new actions NetworkController:addNetwork; NetworkController:removeNetwork; NetworkController:updateNetwork

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[mathieuartu]

LGTM!!

[mcmire]

One missing test, but otherwise this looks good to me.

[mcmire]

@Prithpal-Sooriya The addition of the actions/events will be breaking changes to the NetworkController (since clients will need to amend the allowlists they pass to the NetworkController messenger). That's fine, but can you update the PR description to reflect this? Typically we just prepend the changelog entries that refer to breaking changes with **BREAKING:**. This way we know to bump network-controller by a major when the time comes to release these changes.

[Prithpal-Sooriya]

@Prithpal-Sooriya The addition of the actions/events will be breaking changes to the NetworkController (since clients will need to amend the allowlists they pass to the NetworkController messenger). That's fine, but can you update the PR description to reflect this? Typically we just prepend the changelog entries that refer to breaking changes with **BREAKING:**. This way we know to bump network-controller by a major when the time comes to release these changes.

@mcmire Done.

Do additions (new actions/events) count as breaking? Wouldn't clients/consumers of this controller need to update their allowedActions/events only if they do call/subscribe to them

[mcmire]

@Prithpal-Sooriya Good point! If the controller calls new actions or subscribes to new events outside of itself, then those actions/events would need to be added to the controller messenger's allowlists, and the client would have to do that. But in this case since the actions/events being added are internal to NetworkController, you are right, it wouldn't cause anything to break immediately. So maybe it's inappropriate to mark these changes as breaking. Sorry for the confusion.

[mcmire]

Sorry one more thing!

[mcmire]

Looks good!

[Gudahtt]

These changes aren't breaking, right? There are no new allowed actions/events here. No restricted messenger changes.