docs: publish example controllers and service as @metamask/sample-controllers (#5363)

## Explanation

Publish existing sample controllers as @metamask/sample-controllers so
it can be used in sample code.


## References
* Related to https://github.com/MetaMask/MetaMask-planning/issues/3850
<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/sample-controllers`

- **ADDED**: Initial sample controllers and service –
(GasPricesController, PetNamesController, GasPricesService)

## 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
- [ ] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: dbrans

.github/CODEOWNERS

@@ -54,7 +54,7 @@
 /packages/build-utils                  @MetaMask/wallet-framework-engineers
 /packages/composable-controller        @MetaMask/wallet-framework-engineers
 /packages/controller-utils             @MetaMask/wallet-framework-engineers
-/packages/example-controllers          @MetaMask/wallet-framework-engineers
+/packages/sample-controllers          @MetaMask/wallet-framework-engineers
 /packages/polling-controller           @MetaMask/wallet-framework-engineers
 /packages/preferences-controller       @MetaMask/wallet-framework-engineers
 

README.md

@@ -55,6 +55,7 @@ Each package in this repository has its own README where you can find installati
 - [`@metamask/queued-request-controller`](packages/queued-request-controller)
 - [`@metamask/rate-limit-controller`](packages/rate-limit-controller)
 - [`@metamask/remote-feature-flag-controller`](packages/remote-feature-flag-controller)
+- [`@metamask/sample-controllers`](packages/sample-controllers)
 - [`@metamask/selected-network-controller`](packages/selected-network-controller)
 - [`@metamask/signature-controller`](packages/signature-controller)
 - [`@metamask/token-search-discovery-controller`](packages/token-search-discovery-controller)
@@ -104,6 +105,7 @@ linkStyle default opacity:0.5
   queued_request_controller(["@metamask/queued-request-controller"]);
   rate_limit_controller(["@metamask/rate-limit-controller"]);
   remote_feature_flag_controller(["@metamask/remote-feature-flag-controller"]);
+  sample_controllers(["@metamask/sample-controllers"]);
   selected_network_controller(["@metamask/selected-network-controller"]);
   signature_controller(["@metamask/signature-controller"]);
   token_search_discovery_controller(["@metamask/token-search-discovery-controller"]);
@@ -129,15 +131,15 @@ linkStyle default opacity:0.5
   bridge_controller --> base_controller;
   bridge_controller --> controller_utils;
   bridge_controller --> polling_controller;
-  bridge_controller --> transaction_controller;
   bridge_controller --> accounts_controller;
   bridge_controller --> eth_json_rpc_provider;
   bridge_controller --> network_controller;
+  bridge_controller --> transaction_controller;
   bridge_status_controller --> base_controller;
+  bridge_status_controller --> bridge_controller;
   bridge_status_controller --> controller_utils;
   bridge_status_controller --> polling_controller;
   bridge_status_controller --> accounts_controller;
-  bridge_status_controller --> bridge_controller;
   bridge_status_controller --> network_controller;
   bridge_status_controller --> transaction_controller;
   composable_controller --> base_controller;
@@ -207,6 +209,9 @@ linkStyle default opacity:0.5
   rate_limit_controller --> base_controller;
   remote_feature_flag_controller --> base_controller;
   remote_feature_flag_controller --> controller_utils;
+  sample_controllers --> base_controller;
+  sample_controllers --> controller_utils;
+  sample_controllers --> network_controller;
   selected_network_controller --> base_controller;
   selected_network_controller --> json_rpc_engine;
   selected_network_controller --> network_controller;

eslint-warning-thresholds.json

@@ -1,18 +1,4 @@
 {
-  "examples/example-controllers/src/gas-prices-controller.test.ts": {
-    "import-x/order": 1
-  },
-  "examples/example-controllers/src/gas-prices-controller.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "prettier/prettier": 1
-  },
-  "examples/example-controllers/src/gas-prices-service/gas-prices-service.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/require-returns": 1
-  },
-  "examples/example-controllers/src/pet-names-controller.test.ts": {
-    "import-x/order": 2
-  },
   "packages/accounts-controller/src/AccountsController.test.ts": {
     "import-x/namespace": 1
   },

examples/example-controllers/src/gas-prices-service/abstract-gas-prices-service.ts

@@ -28,7 +28,7 @@ module.exports = {
   coverageDirectory: 'coverage',
 
   // An array of regexp pattern strings used to skip coverage collection
-  coveragePathIgnorePatterns: ['./src/index.ts'],
+  coveragePathIgnorePatterns: ['.*/index\\.ts'],
 
   // Indicates which provider should be used to instrument code for coverage
   coverageProvider: 'babel',

examples/example-controllers/src/index.ts

@@ -227,7 +227,7 @@ type RootEvent = ExtractAvailableEvent<MultichainAssetsControllerMessenger>;
  * Constructs the unrestricted messenger. This can be used to call actions and
  * publish events within the tests for this controller.
  *
- * @returns The unrestricted messenger suited for PetNamesController.
+ * @returns The unrestricted messenger suited for MultichainAssetsController.
  */
 function getRootMessenger(): Messenger<RootAction, RootEvent> {
   return new Messenger<RootAction, RootEvent>();

jest.config.packages.js

@@ -114,7 +114,7 @@ type RootEvent = ExtractAvailableEvent<MultichainBalancesControllerMessenger>;
  * Constructs the unrestricted messenger. This can be used to call actions and
  * publish events within the tests for this controller.
  *
- * @returns The unrestricted messenger suited for PetNamesController.
+ * @returns The unrestricted messenger suited for MultichainBalancesController.
  */
 function getRootMessenger(): Messenger<RootAction, RootEvent> {
   return new Messenger<RootAction, RootEvent>();

packages/assets-controllers/src/MultichainAssetsController/MultichainAssetsController.test.ts

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 MetaMask
+Copyright (c) 2025 MetaMask
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal