Improve sample-controllers to be more useful examples

packages/sample-controllers/CHANGELOG.md

@@ -7,11 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- `SampleGasPricesController.updateGasPrices` is now callable via the messaging system ([#6168](https://github.com/MetaMask/core/pull/6168))
+  - An action type, `SampleGasPricesControllerUpdateGasPricesAction`, is now available for use
+- `SamplePetnamesController.assignPetname` is now callable via the messaging system ([#6168](https://github.com/MetaMask/core/pull/6168))
+  - An action type, `SamplePetnamesControllerAssignPetnameAction`, is now available for use
+- Export new types for `SampleGasPricesService` ([#6168](https://github.com/MetaMask/core/pull/6168))
+  - `SampleGasPricesServiceActions`
+  - `SampleGasPricesServiceEvents`
+  - `SampleGasPricesServiceFetchGasPricesAction`
+  - `SampleGasPricesServiceMessenger`
+- Export `getDefaultPetnamesControllerState` ([#6168](https://github.com/MetaMask/core/pull/6168))
+
 ### Changed
 
+- **BREAKING:** The messenger for `SampleGasPricesController` now expects `NetworkController:getNetworkClientById` to be allowed, and no longer expects `NetworkController:getState` to be allowed ([#6168](https://github.com/MetaMask/core/pull/6168))
+- **BREAKING:** `SampleGasPricesController.updateGasPrices` now takes a required `chainId` option ([#6168](https://github.com/MetaMask/core/pull/6168))
+- `SampleGasPricesController` will now automatically update gas prices when the globally selected chain changes ([#6168](https://github.com/MetaMask/core/pull/6168))
 - Bump `@metamask/controller-utils` from `^11.10.0` to `^11.11.0` ([#6069](https://github.com/MetaMask/core/pull/6069))
 - Bump `@metamask/utils` from `^11.2.0` to `^11.4.2` ([#6054](https://github.com/MetaMask/core/pull/6054))
 
+### Removed
+
+- **BREAKING:** `SampleGasPricesController` no longer takes a `gasPricesService` option ([#6168](https://github.com/MetaMask/core/pull/6168))
+  - The controller now expects `SampleGasPricesService` to have been instantiated ahead of time
+
 ## [1.0.0]
 
 ### Changed

packages/sample-controllers/package.json

@@ -58,6 +58,7 @@
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
     "nock": "^13.3.1",
+    "sinon": "^9.2.4",
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",

packages/sample-controllers/src/index.ts

@@ -1,25 +1,33 @@
+export type {
+  SampleGasPricesServiceActions,
+  SampleGasPricesServiceEvents,
+  SampleGasPricesServiceFetchGasPricesAction,
+  SampleGasPricesServiceMessenger,
+} from './sample-gas-prices-service/sample-gas-prices-service';
+export { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';
 export type {
   SampleGasPricesControllerActions,
   SampleGasPricesControllerEvents,
   SampleGasPricesControllerGetStateAction,
   SampleGasPricesControllerMessenger,
   SampleGasPricesControllerState,
   SampleGasPricesControllerStateChangeEvent,
+  SampleGasPricesControllerUpdateGasPricesAction,
 } from './sample-gas-prices-controller';
 export {
-  getDefaultSampleGasPricesControllerState,
   SampleGasPricesController,
+  getDefaultSampleGasPricesControllerState,
 } from './sample-gas-prices-controller';
 export type {
   SamplePetnamesControllerActions,
+  SamplePetnamesControllerAssignPetnameAction,
   SamplePetnamesControllerEvents,
   SamplePetnamesControllerGetStateAction,
   SamplePetnamesControllerMessenger,
   SamplePetnamesControllerState,
   SamplePetnamesControllerStateChangeEvent,
 } from './sample-petnames-controller';
-export { SamplePetnamesController } from './sample-petnames-controller';
 export {
-  SampleGasPricesService,
-  type SampleAbstractGasPricesService,
-} from './sample-gas-prices-service';
+  SamplePetnamesController,
+  getDefaultPetnamesControllerState,
+} from './sample-petnames-controller';