Improve sample-controllers to be more useful examples

packages/sample-controllers/CHANGELOG.md

@@ -7,10 +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
 
-- Bump `@metamask/utils` from `^11.2.0` to `^11.4.2` ([#6054](https://github.com/MetaMask/core/pull/6054))
+- **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/base-controller` from `^8.0.1` to `^8.2.0` ([#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355))
+- 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
+- **BREAKING:** Remove `SampleAbstractGasPricesService` ([#6168](https://github.com/MetaMask/core/pull/6168))
 
 ## [1.0.0]
 

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,3 +1,10 @@
+export type {
+  SampleGasPricesServiceActions,
+  SampleGasPricesServiceEvents,
+  SampleGasPricesServiceMessenger,
+} from './sample-gas-prices-service/sample-gas-prices-service';
+export type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';
+export { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';
 export type {
   SampleGasPricesControllerActions,
   SampleGasPricesControllerEvents,
@@ -7,9 +14,10 @@ export type {
   SampleGasPricesControllerStateChangeEvent,
 } from './sample-gas-prices-controller';
 export {
-  getDefaultSampleGasPricesControllerState,
   SampleGasPricesController,
+  getDefaultSampleGasPricesControllerState,
 } from './sample-gas-prices-controller';
+export type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';
 export type {
   SamplePetnamesControllerActions,
   SamplePetnamesControllerEvents,
@@ -18,8 +26,8 @@ export type {
   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';
+export type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';

packages/sample-controllers/src/sample-gas-prices-controller-method-action-types.ts

@@ -0,0 +1,24 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+
+import type { SampleGasPricesController } from './sample-gas-prices-controller';
+
+/**
+ * Fetches the latest gas prices for the given chain and persists them to
+ * state.
+ *
+ * @param args - The arguments to the function.
+ * @param args.chainId - The chain ID for which to fetch gas prices.
+ */
+export type SampleGasPricesControllerUpdateGasPricesAction = {
+  type: `SampleGasPricesController:updateGasPrices`;
+  handler: SampleGasPricesController['updateGasPrices'];
+};
+
+/**
+ * Union of all SampleGasPricesController action types.
+ */
+export type SampleGasPricesControllerMethodActions =
+  SampleGasPricesControllerUpdateGasPricesAction;