@metamask-previews/sample-controllers 1.0.0-preview-9a5f096 → 1.0.0-preview-f3f2e8c8

package/CHANGELOG.md

@@ -7,33 +7,10 @@ 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))
-- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6471](https://github.com/MetaMask/core/pull/6471))
-
 ### 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/base-controller` from `^8.0.1` to `^8.3.0` ([#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))
 - 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))
+- Bump `@metamask/base-controller` from `^8.0.1` to `^8.1.0` ([#6284](https://github.com/MetaMask/core/pull/6284))
 
 ## [1.0.0]
 

package/dist/index.cjs

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultPetnamesControllerState = exports.SamplePetnamesController = exports.getDefaultSampleGasPricesControllerState = exports.SampleGasPricesController = exports.SampleGasPricesService = void 0;
-var sample_gas_prices_service_1 = require("./sample-gas-prices-service/sample-gas-prices-service.cjs");
-Object.defineProperty(exports, "SampleGasPricesService", { enumerable: true, get: function () { return sample_gas_prices_service_1.SampleGasPricesService; } });
+exports.SampleGasPricesService = exports.SamplePetnamesController = exports.SampleGasPricesController = exports.getDefaultSampleGasPricesControllerState = void 0;
 var sample_gas_prices_controller_1 = require("./sample-gas-prices-controller.cjs");
-Object.defineProperty(exports, "SampleGasPricesController", { enumerable: true, get: function () { return sample_gas_prices_controller_1.SampleGasPricesController; } });
 Object.defineProperty(exports, "getDefaultSampleGasPricesControllerState", { enumerable: true, get: function () { return sample_gas_prices_controller_1.getDefaultSampleGasPricesControllerState; } });
+Object.defineProperty(exports, "SampleGasPricesController", { enumerable: true, get: function () { return sample_gas_prices_controller_1.SampleGasPricesController; } });
 var sample_petnames_controller_1 = require("./sample-petnames-controller.cjs");
 Object.defineProperty(exports, "SamplePetnamesController", { enumerable: true, get: function () { return sample_petnames_controller_1.SamplePetnamesController; } });
-Object.defineProperty(exports, "getDefaultPetnamesControllerState", { enumerable: true, get: function () { return sample_petnames_controller_1.getDefaultPetnamesControllerState; } });
+var sample_gas_prices_service_1 = require("./sample-gas-prices-service/index.cjs");
+Object.defineProperty(exports, "SampleGasPricesService", { enumerable: true, get: function () { return sample_gas_prices_service_1.SampleGasPricesService; } });
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAMA,uGAA+F;AAAtF,mIAAA,sBAAsB,OAAA;AAS/B,mFAGwC;AAFtC,yIAAA,yBAAyB,OAAA;AACzB,wJAAA,wCAAwC,OAAA;AAW1C,+EAGsC;AAFpC,sIAAA,wBAAwB,OAAA;AACxB,+IAAA,iCAAiC,OAAA","sourcesContent":["export type {\n  SampleGasPricesServiceActions,\n  SampleGasPricesServiceEvents,\n  SampleGasPricesServiceMessenger,\n} from './sample-gas-prices-service/sample-gas-prices-service';\nexport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\nexport { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';\nexport type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  SampleGasPricesController,\n  getDefaultSampleGasPricesControllerState,\n} from './sample-gas-prices-controller';\nexport type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport {\n  SamplePetnamesController,\n  getDefaultPetnamesControllerState,\n} from './sample-petnames-controller';\nexport type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,mFAGwC;AAFtC,wJAAA,wCAAwC,OAAA;AACxC,yIAAA,yBAAyB,OAAA;AAU3B,+EAAwE;AAA/D,sIAAA,wBAAwB,OAAA;AACjC,mFAGqC;AAFnC,mIAAA,sBAAsB,OAAA","sourcesContent":["export type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  getDefaultSampleGasPricesControllerState,\n  SampleGasPricesController,\n} from './sample-gas-prices-controller';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport { SamplePetnamesController } from './sample-petnames-controller';\nexport {\n  SampleGasPricesService,\n  type SampleAbstractGasPricesService,\n} from './sample-gas-prices-service';\n"]}

package/dist/index.d.cts

@@ -1,10 +1,6 @@
-export type { SampleGasPricesServiceActions, SampleGasPricesServiceEvents, SampleGasPricesServiceMessenger, } from "./sample-gas-prices-service/sample-gas-prices-service.cjs";
-export type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.cjs";
-export { SampleGasPricesService } from "./sample-gas-prices-service/sample-gas-prices-service.cjs";
 export type { SampleGasPricesControllerActions, SampleGasPricesControllerEvents, SampleGasPricesControllerGetStateAction, SampleGasPricesControllerMessenger, SampleGasPricesControllerState, SampleGasPricesControllerStateChangeEvent, } from "./sample-gas-prices-controller.cjs";
-export { SampleGasPricesController, getDefaultSampleGasPricesControllerState, } from "./sample-gas-prices-controller.cjs";
-export type { SampleGasPricesControllerUpdateGasPricesAction } from "./sample-gas-prices-controller-method-action-types.cjs";
+export { getDefaultSampleGasPricesControllerState, SampleGasPricesController, } from "./sample-gas-prices-controller.cjs";
 export type { SamplePetnamesControllerActions, SamplePetnamesControllerEvents, SamplePetnamesControllerGetStateAction, SamplePetnamesControllerMessenger, SamplePetnamesControllerState, SamplePetnamesControllerStateChangeEvent, } from "./sample-petnames-controller.cjs";
-export { SamplePetnamesController, getDefaultPetnamesControllerState, } from "./sample-petnames-controller.cjs";
-export type { SamplePetnamesControllerAssignPetnameAction } from "./sample-petnames-controller-method-action-types.cjs";
+export { SamplePetnamesController } from "./sample-petnames-controller.cjs";
+export { SampleGasPricesService, type SampleAbstractGasPricesService, } from "./sample-gas-prices-service/index.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,4BAA4B,EAC5B,+BAA+B,GAChC,kEAA8D;AAC/D,YAAY,EAAE,0CAA0C,EAAE,sFAAkF;AAC5I,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAC/F,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,yBAAyB,EACzB,wCAAwC,GACzC,2CAAuC;AACxC,YAAY,EAAE,8CAA8C,EAAE,+DAA2D;AACzH,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,GAClC,yCAAqC;AACtC,YAAY,EAAE,2CAA2C,EAAE,6DAAyD"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,wCAAwC,EACxC,yBAAyB,GAC1B,2CAAuC;AACxC,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EAAE,wBAAwB,EAAE,yCAAqC;AACxE,OAAO,EACL,sBAAsB,EACtB,KAAK,8BAA8B,GACpC,8CAAoC"}

package/dist/index.d.mts

@@ -1,10 +1,6 @@
-export type { SampleGasPricesServiceActions, SampleGasPricesServiceEvents, SampleGasPricesServiceMessenger, } from "./sample-gas-prices-service/sample-gas-prices-service.mjs";
-export type { SampleGasPricesServiceFetchGasPricesAction } from "./sample-gas-prices-service/sample-gas-prices-service-method-action-types.mjs";
-export { SampleGasPricesService } from "./sample-gas-prices-service/sample-gas-prices-service.mjs";
 export type { SampleGasPricesControllerActions, SampleGasPricesControllerEvents, SampleGasPricesControllerGetStateAction, SampleGasPricesControllerMessenger, SampleGasPricesControllerState, SampleGasPricesControllerStateChangeEvent, } from "./sample-gas-prices-controller.mjs";
-export { SampleGasPricesController, getDefaultSampleGasPricesControllerState, } from "./sample-gas-prices-controller.mjs";
-export type { SampleGasPricesControllerUpdateGasPricesAction } from "./sample-gas-prices-controller-method-action-types.mjs";
+export { getDefaultSampleGasPricesControllerState, SampleGasPricesController, } from "./sample-gas-prices-controller.mjs";
 export type { SamplePetnamesControllerActions, SamplePetnamesControllerEvents, SamplePetnamesControllerGetStateAction, SamplePetnamesControllerMessenger, SamplePetnamesControllerState, SamplePetnamesControllerStateChangeEvent, } from "./sample-petnames-controller.mjs";
-export { SamplePetnamesController, getDefaultPetnamesControllerState, } from "./sample-petnames-controller.mjs";
-export type { SamplePetnamesControllerAssignPetnameAction } from "./sample-petnames-controller-method-action-types.mjs";
+export { SamplePetnamesController } from "./sample-petnames-controller.mjs";
+export { SampleGasPricesService, type SampleAbstractGasPricesService, } from "./sample-gas-prices-service/index.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,4BAA4B,EAC5B,+BAA+B,GAChC,kEAA8D;AAC/D,YAAY,EAAE,0CAA0C,EAAE,sFAAkF;AAC5I,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAC/F,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,yBAAyB,EACzB,wCAAwC,GACzC,2CAAuC;AACxC,YAAY,EAAE,8CAA8C,EAAE,+DAA2D;AACzH,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,GAClC,yCAAqC;AACtC,YAAY,EAAE,2CAA2C,EAAE,6DAAyD"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,gCAAgC,EAChC,+BAA+B,EAC/B,uCAAuC,EACvC,kCAAkC,EAClC,8BAA8B,EAC9B,yCAAyC,GAC1C,2CAAuC;AACxC,OAAO,EACL,wCAAwC,EACxC,yBAAyB,GAC1B,2CAAuC;AACxC,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,yCAAqC;AACtC,OAAO,EAAE,wBAAwB,EAAE,yCAAqC;AACxE,OAAO,EACL,sBAAsB,EACtB,KAAK,8BAA8B,GACpC,8CAAoC"}

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { SampleGasPricesService } from "./sample-gas-prices-service/sample-gas-prices-service.mjs";
-export { SampleGasPricesController, getDefaultSampleGasPricesControllerState } from "./sample-gas-prices-controller.mjs";
-export { SamplePetnamesController, getDefaultPetnamesControllerState } from "./sample-petnames-controller.mjs";
+export { getDefaultSampleGasPricesControllerState, SampleGasPricesController } from "./sample-gas-prices-controller.mjs";
+export { SamplePetnamesController } from "./sample-petnames-controller.mjs";
+export { SampleGasPricesService } from "./sample-gas-prices-service/index.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,sBAAsB,EAAE,kEAA8D;AAS/F,OAAO,EACL,yBAAyB,EACzB,wCAAwC,EACzC,2CAAuC;AAUxC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAClC,yCAAqC","sourcesContent":["export type {\n  SampleGasPricesServiceActions,\n  SampleGasPricesServiceEvents,\n  SampleGasPricesServiceMessenger,\n} from './sample-gas-prices-service/sample-gas-prices-service';\nexport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\nexport { SampleGasPricesService } from './sample-gas-prices-service/sample-gas-prices-service';\nexport type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  SampleGasPricesController,\n  getDefaultSampleGasPricesControllerState,\n} from './sample-gas-prices-controller';\nexport type { SampleGasPricesControllerUpdateGasPricesAction } from './sample-gas-prices-controller-method-action-types';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport {\n  SamplePetnamesController,\n  getDefaultPetnamesControllerState,\n} from './sample-petnames-controller';\nexport type { SamplePetnamesControllerAssignPetnameAction } from './sample-petnames-controller-method-action-types';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,wCAAwC,EACxC,yBAAyB,EAC1B,2CAAuC;AASxC,OAAO,EAAE,wBAAwB,EAAE,yCAAqC;AACxE,OAAO,EACL,sBAAsB,EAEvB,8CAAoC","sourcesContent":["export type {\n  SampleGasPricesControllerActions,\n  SampleGasPricesControllerEvents,\n  SampleGasPricesControllerGetStateAction,\n  SampleGasPricesControllerMessenger,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerStateChangeEvent,\n} from './sample-gas-prices-controller';\nexport {\n  getDefaultSampleGasPricesControllerState,\n  SampleGasPricesController,\n} from './sample-gas-prices-controller';\nexport type {\n  SamplePetnamesControllerActions,\n  SamplePetnamesControllerEvents,\n  SamplePetnamesControllerGetStateAction,\n  SamplePetnamesControllerMessenger,\n  SamplePetnamesControllerState,\n  SamplePetnamesControllerStateChangeEvent,\n} from './sample-petnames-controller';\nexport { SamplePetnamesController } from './sample-petnames-controller';\nexport {\n  SampleGasPricesService,\n  type SampleAbstractGasPricesService,\n} from './sample-gas-prices-service';\n"]}

package/dist/network-controller-types.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultNetworkControllerState = void 0;
+/**
+ * Constructs a default representation of a theoretical NetworkController's
+ * state.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ *
+ * @returns The default network controller state.
+ */
+function getDefaultNetworkControllerState() {
+    return {
+        networkName: 'Some Network',
+        chainId: '0x1',
+    };
+}
+exports.getDefaultNetworkControllerState = getDefaultNetworkControllerState;
+//# sourceMappingURL=network-controller-types.cjs.map

package/dist/network-controller-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-controller-types.cjs","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":";;;AAaA;;;;;;;;GAQG;AACH,SAAgB,gCAAgC;IAC9C,OAAO;QACL,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE,KAAK;KACf,CAAC;AACJ,CAAC;AALD,4EAKC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\n/**\n * Describes the shape of the state object for a theoretical NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\ntype NetworkControllerState = {\n  networkName: string;\n  chainId: Hex;\n};\n\n/**\n * Constructs a default representation of a theoretical NetworkController's\n * state.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n *\n * @returns The default network controller state.\n */\nexport function getDefaultNetworkControllerState(): NetworkControllerState {\n  return {\n    networkName: 'Some Network',\n    chainId: '0x1',\n  };\n}\n\n/**\n * The action which can be used to obtain the state for a theoretical\n * NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\nexport type NetworkControllerGetStateAction = {\n  type: 'NetworkController:getState';\n  handler: () => NetworkControllerState;\n};\n"]}

package/dist/network-controller-types.d.cts

@@ -0,0 +1,34 @@
+import type { Hex } from "@metamask/utils";
+/**
+ * Describes the shape of the state object for a theoretical NetworkController.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ */
+type NetworkControllerState = {
+    networkName: string;
+    chainId: Hex;
+};
+/**
+ * Constructs a default representation of a theoretical NetworkController's
+ * state.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ *
+ * @returns The default network controller state.
+ */
+export declare function getDefaultNetworkControllerState(): NetworkControllerState;
+/**
+ * The action which can be used to obtain the state for a theoretical
+ * NetworkController.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ */
+export type NetworkControllerGetStateAction = {
+    type: 'NetworkController:getState';
+    handler: () => NetworkControllerState;
+};
+export {};
+//# sourceMappingURL=network-controller-types.d.cts.map

package/dist/network-controller-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-controller-types.d.cts","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;;;GAKG;AACH,KAAK,sBAAsB,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,IAAI,sBAAsB,CAKzE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM,sBAAsB,CAAC;CACvC,CAAC"}

package/dist/network-controller-types.d.mts

@@ -0,0 +1,34 @@
+import type { Hex } from "@metamask/utils";
+/**
+ * Describes the shape of the state object for a theoretical NetworkController.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ */
+type NetworkControllerState = {
+    networkName: string;
+    chainId: Hex;
+};
+/**
+ * Constructs a default representation of a theoretical NetworkController's
+ * state.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ *
+ * @returns The default network controller state.
+ */
+export declare function getDefaultNetworkControllerState(): NetworkControllerState;
+/**
+ * The action which can be used to obtain the state for a theoretical
+ * NetworkController.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ */
+export type NetworkControllerGetStateAction = {
+    type: 'NetworkController:getState';
+    handler: () => NetworkControllerState;
+};
+export {};
+//# sourceMappingURL=network-controller-types.d.mts.map

package/dist/network-controller-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-controller-types.d.mts","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;;;GAKG;AACH,KAAK,sBAAsB,GAAG;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,gCAAgC,IAAI,sBAAsB,CAKzE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,MAAM,sBAAsB,CAAC;CACvC,CAAC"}

package/dist/network-controller-types.mjs

@@ -0,0 +1,16 @@
+/**
+ * Constructs a default representation of a theoretical NetworkController's
+ * state.
+ *
+ * Note that this package does not supply a NetworkController; this type is only
+ * here so it is possible to write a complete example.
+ *
+ * @returns The default network controller state.
+ */
+export function getDefaultNetworkControllerState() {
+    return {
+        networkName: 'Some Network',
+        chainId: '0x1',
+    };
+}
+//# sourceMappingURL=network-controller-types.mjs.map

package/dist/network-controller-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-controller-types.mjs","sourceRoot":"","sources":["../src/network-controller-types.ts"],"names":[],"mappings":"AAaA;;;;;;;;GAQG;AACH,MAAM,UAAU,gCAAgC;IAC9C,OAAO;QACL,WAAW,EAAE,cAAc;QAC3B,OAAO,EAAE,KAAK;KACf,CAAC;AACJ,CAAC","sourcesContent":["import type { Hex } from '@metamask/utils';\n\n/**\n * Describes the shape of the state object for a theoretical NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\ntype NetworkControllerState = {\n  networkName: string;\n  chainId: Hex;\n};\n\n/**\n * Constructs a default representation of a theoretical NetworkController's\n * state.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n *\n * @returns The default network controller state.\n */\nexport function getDefaultNetworkControllerState(): NetworkControllerState {\n  return {\n    networkName: 'Some Network',\n    chainId: '0x1',\n  };\n}\n\n/**\n * The action which can be used to obtain the state for a theoretical\n * NetworkController.\n *\n * Note that this package does not supply a NetworkController; this type is only\n * here so it is possible to write a complete example.\n */\nexport type NetworkControllerGetStateAction = {\n  type: 'NetworkController:getState';\n  handler: () => NetworkControllerState;\n};\n"]}

package/dist/sample-gas-prices-controller.cjs

@@ -1,16 +1,16 @@
 "use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _SampleGasPricesController_instances, _SampleGasPricesController_selectedChainId, _SampleGasPricesController_onSelectedNetworkClientIdChange;
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SampleGasPricesController_gasPricesService;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SampleGasPricesController = exports.getDefaultSampleGasPricesControllerState = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
@@ -26,10 +26,8 @@ exports.controllerName = 'SampleGasPricesController';
  */
 const gasPricesControllerMetadata = {
     gasPricesByChainId: {
-        includeInStateLogs: true,
         persist: true,
         anonymous: false,
-        usedInUi: true,
     },
 };
 /**
@@ -46,8 +44,6 @@ function getDefaultSampleGasPricesControllerState() {
     };
 }
 exports.getDefaultSampleGasPricesControllerState = getDefaultSampleGasPricesControllerState;
-// === MESSENGER ===
-const MESSENGER_EXPOSED_METHODS = ['updateGasPrices'];
 // === CONTROLLER DEFINITION ===
 /**
  * `SampleGasPricesController` fetches and persists gas prices for various chains.
@@ -56,60 +52,36 @@ const MESSENGER_EXPOSED_METHODS = ['updateGasPrices'];
  *
  * ``` ts
  * import { Messenger } from '@metamask/base-controller';
- * import type {
- *   NetworkControllerActions,
- *   NetworkControllerEvents,
- * } from '@metamask/network-controller';
- * import type {
- *   SampleGasPricesControllerActions,
- *   SampleGasPricesControllerEvents,
- *   SampleGasPricesServiceActions,
- *   SampleGasPricesServiceEvents,
- * } from '@metamask/sample-controllers';
  * import {
  *   SampleGasPricesController,
- *   SampleGasPricesService,
- *   selectGasPrices,
- * } from '@metamask/sample-controllers';
+ *   SampleGasPricesService
+ * } from '@metamask/example-controllers';
+ * import type {
+ *   SampleGasPricesControllerActions,
+ *   SampleGasPricesControllerEvents
+ * } from '@metamask/example-controllers';
+ * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';
  *
- * const globalMessenger = new Messenger<
- *  SampleGasPricesServiceActions
- *  | SampleGasPricesControllerActions
- *  | NetworkControllerActions,
- *  SampleGasPricesServiceEvents
- *  | SampleGasPricesControllerEvents
- *  | NetworkControllerEvents
+ * // Assuming that you're using this in the browser
+ * const gasPricesService = new SampleGasPricesService({ fetch });
+ * const rootMessenger = new Messenger<
+ *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,
+ *  SampleGasPricesControllerEvents
  * >();
- * const gasPricesServiceMessenger = globalMessenger.getRestricted({
- *   name: 'SampleGasPricesService',
- *   allowedActions: [],
- *   allowedEvents: [],
- * });
- * // Instantiate the service to register its actions on the messenger
- * new SampleGasPricesService({
- *   messenger: gasPricesServiceMessenger,
- *   // We assume you're using this in the browser.
- *   fetch,
- * });
- * const gasPricesControllerMessenger = globalMessenger.getRestricted({
+ * const gasPricesMessenger = rootMessenger.getRestricted({
  *   name: 'SampleGasPricesController',
- *   allowedActions: ['NetworkController:getNetworkClientById'],
- *   allowedEvents: ['NetworkController:stateChange'],
+ *   allowedActions: ['NetworkController:getState'],
+ *   allowedEvents: [],
  * });
- * // Instantiate the controller to register its actions on the messenger
- * new SampleGasPricesController({
- *   messenger: gasPricesControllerMessenger,
+ * const gasPricesController = new SampleGasPricesController({
+ *   messenger: gasPricesMessenger,
+ *   gasPricesService,
  * });
  *
- * // Later...
- * await globalMessenger.call(
- *   'SampleGasPricesController:updateGasPrices',
- *   { chainId: '0x42' },
- * );
- * const gasPricesControllerState = await globalMessenger.call(
- *   'SampleGasPricesController:getState',
- * );
- * gasPricesControllerState.gasPricesByChainId
+ * // Assuming that `NetworkController:getState` returns an object with a
+ * // `chainId` of `0x42`...
+ * await gasPricesController.updateGasPrices();
+ * gasPricesController.state.gasPricesByChainId
  * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }
  * ```
  */
@@ -117,12 +89,14 @@ class SampleGasPricesController extends base_controller_1.BaseController {
     /**
      * Constructs a new {@link SampleGasPricesController}.
      *
-     * @param args - The constructor arguments.
+     * @param args - The arguments to the controller.
      * @param args.messenger - The messenger suited for this controller.
      * @param args.state - The desired state with which to initialize this
      * controller. Missing properties will be filled in with defaults.
+     * @param args.gasPricesService - The service object that will be used to
+     * obtain gas prices.
      */
-    constructor({ messenger, state, }) {
+    constructor({ messenger, state, gasPricesService, }) {
         super({
             messenger,
             metadata: gasPricesControllerMetadata,
@@ -132,23 +106,20 @@ class SampleGasPricesController extends base_controller_1.BaseController {
                 ...state,
             },
         });
-        _SampleGasPricesController_instances.add(this);
         /**
-         * The globally selected chain ID.
+         * The service object that is used to obtain gas prices.
          */
-        _SampleGasPricesController_selectedChainId.set(this, void 0);
-        this.messagingSystem.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-        this.messagingSystem.subscribe('NetworkController:stateChange', __classPrivateFieldGet(this, _SampleGasPricesController_instances, "m", _SampleGasPricesController_onSelectedNetworkClientIdChange).bind(this), (networkControllerState) => networkControllerState.selectedNetworkClientId);
+        _SampleGasPricesController_gasPricesService.set(this, void 0);
+        __classPrivateFieldSet(this, _SampleGasPricesController_gasPricesService, gasPricesService, "f");
+        this.messagingSystem.registerActionHandler(`${exports.controllerName}:updateGasPrices`, this.updateGasPrices.bind(this));
     }
     /**
-     * Fetches the latest gas prices for the given chain and persists them to
+     * Fetches the latest gas prices for the current chain, persisting them to
      * state.
-     *
-     * @param args - The arguments to the function.
-     * @param args.chainId - The chain ID for which to fetch gas prices.
      */
-    async updateGasPrices({ chainId }) {
-        const gasPricesResponse = await this.messagingSystem.call('SampleGasPricesService:fetchGasPrices', chainId);
+    async updateGasPrices() {
+        const { chainId } = this.messagingSystem.call('NetworkController:getState');
+        const gasPricesResponse = await __classPrivateFieldGet(this, _SampleGasPricesController_gasPricesService, "f").fetchGasPrices(chainId);
         this.update((state) => {
             state.gasPricesByChainId[chainId] = {
                 ...gasPricesResponse,
@@ -158,18 +129,5 @@ class SampleGasPricesController extends base_controller_1.BaseController {
     }
 }
 exports.SampleGasPricesController = SampleGasPricesController;
-_SampleGasPricesController_selectedChainId = new WeakMap(), _SampleGasPricesController_instances = new WeakSet(), _SampleGasPricesController_onSelectedNetworkClientIdChange = 
-/**
- * Callback to call when the globally selected network client ID changes,
- * ensuring that gas prices get updated.
- *
- * @param selectedNetworkClientId - The globally selected network client ID.
- */
-async function _SampleGasPricesController_onSelectedNetworkClientIdChange(selectedNetworkClientId) {
-    const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', selectedNetworkClientId);
-    if (chainId !== __classPrivateFieldGet(this, _SampleGasPricesController_selectedChainId, "f")) {
-        __classPrivateFieldSet(this, _SampleGasPricesController_selectedChainId, chainId, "f");
-        await this.updateGasPrices({ chainId });
-    }
-};
+_SampleGasPricesController_gasPricesService = new WeakMap();
 //# sourceMappingURL=sample-gas-prices-controller.cjs.map

package/dist/sample-gas-prices-controller.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"sample-gas-prices-controller.cjs","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,+DAA2D;AAW3D,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,2BAA2B,CAAC;AAsC1D;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;CACsD,CAAC;AAE1D;;;;;;;GAOG;AACH,SAAgB,wCAAwC;IACtD,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AAJD,4FAIC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,iBAAiB,CAAU,CAAC;AAyD/D,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAa,yBAA0B,SAAQ,gCAI9C;IAMC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,2BAA2B;YACrC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,wCAAwC,EAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA5BL;;WAEG;QACH,6DAAkC;QA2BhC,IAAI,CAAC,eAAe,CAAC,4BAA4B,CAC/C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,+BAA+B,EAC/B,uBAAA,IAAI,wGAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,EAChD,CAAC,sBAAsB,EAAE,EAAE,CACzB,sBAAsB,CAAC,uBAAuB,CACjD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,EAAE,OAAO,EAAoB;QACjD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CACvD,uCAAuC,EACvC,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG;gBAClC,GAAG,iBAAiB;gBACpB,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;aACtC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CAuBF;AA1FD,8DA0FC;;AArBC;;;;;GAKG;AACH,KAAK,qEACH,uBAAwC;IAExC,MAAM,EACJ,aAAa,EAAE,EAAE,OAAO,EAAE,GAC3B,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3B,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IAEF,IAAI,OAAO,KAAK,uBAAA,IAAI,kDAAiB,EAAE;QACrC,uBAAA,IAAI,8CAAoB,OAAO,MAAA,CAAC;QAChC,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;KACzC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerStateChangeEvent,\n} from '@metamask/network-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SampleGasPricesControllerMethodActions } from './sample-gas-prices-controller-method-action-types';\nimport type { SampleGasPricesServiceFetchGasPricesAction } from './sample-gas-prices-service/sample-gas-prices-service-method-action-types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SampleGasPricesController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'SampleGasPricesController';\n\n// === STATE ===\n\n/**\n * The collection of gas price data fetched periodically.\n */\ntype GasPrices = {\n  /**\n   * The total estimated gas in the \"low\" bucket.\n   */\n  low: number;\n  /**\n   * The total estimated gas in the \"average\" bucket.\n   */\n  average: number;\n  /**\n   * The total estimated gas in the \"high\" bucket.\n   */\n  high: number;\n  /**\n   * The date/time (in ISO-8601 format) when prices were fetched.\n   */\n  fetchedDate: string;\n};\n\n/**\n * Describes the shape of the state object for {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerState = {\n  /**\n   * Fetched gas prices categorized by chain ID.\n   */\n  gasPricesByChainId: {\n    [chainId: Hex]: GasPrices;\n  };\n};\n\n/**\n * The metadata for each property in {@link SampleGasPricesControllerState}.\n */\nconst gasPricesControllerMetadata = {\n  gasPricesByChainId: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<SampleGasPricesControllerState>;\n\n/**\n * Constructs the default {@link SampleGasPricesController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link SampleGasPricesController} state.\n */\nexport function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState {\n  return {\n    gasPricesByChainId: {},\n  };\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['updateGasPrices'] as const;\n\n/**\n * Retrieves the state of the {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SampleGasPricesControllerState\n>;\n\n/**\n * Actions that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SampleGasPricesControllerActions =\n  | SampleGasPricesControllerGetStateAction\n  | SampleGasPricesControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link SampleGasPricesMessenger} calls.\n */\ntype AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | SampleGasPricesServiceFetchGasPricesAction;\n\n/**\n * Published when the state of {@link SampleGasPricesController} changes.\n */\nexport type SampleGasPricesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    SampleGasPricesControllerState\n  >;\n\n/**\n * Events that {@link SampleGasPricesMessenger} exposes to other consumers.\n */\nexport type SampleGasPricesControllerEvents =\n  SampleGasPricesControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link SampleGasPricesMessenger} subscribes\n * to.\n */\ntype AllowedEvents = NetworkControllerStateChangeEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SampleGasPricesControllerActions | AllowedActions,\n  SampleGasPricesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `SampleGasPricesController` fetches and persists gas prices for various chains.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/base-controller';\n * import type {\n *   NetworkControllerActions,\n *   NetworkControllerEvents,\n * } from '@metamask/network-controller';\n * import type {\n *   SampleGasPricesControllerActions,\n *   SampleGasPricesControllerEvents,\n *   SampleGasPricesServiceActions,\n *   SampleGasPricesServiceEvents,\n * } from '@metamask/sample-controllers';\n * import {\n *   SampleGasPricesController,\n *   SampleGasPricesService,\n *   selectGasPrices,\n * } from '@metamask/sample-controllers';\n *\n * const globalMessenger = new Messenger<\n *  SampleGasPricesServiceActions\n *  | SampleGasPricesControllerActions\n *  | NetworkControllerActions,\n *  SampleGasPricesServiceEvents\n *  | SampleGasPricesControllerEvents\n *  | NetworkControllerEvents\n * >();\n * const gasPricesServiceMessenger = globalMessenger.getRestricted({\n *   name: 'SampleGasPricesService',\n *   allowedActions: [],\n *   allowedEvents: [],\n * });\n * // Instantiate the service to register its actions on the messenger\n * new SampleGasPricesService({\n *   messenger: gasPricesServiceMessenger,\n *   // We assume you're using this in the browser.\n *   fetch,\n * });\n * const gasPricesControllerMessenger = globalMessenger.getRestricted({\n *   name: 'SampleGasPricesController',\n *   allowedActions: ['NetworkController:getNetworkClientById'],\n *   allowedEvents: ['NetworkController:stateChange'],\n * });\n * // Instantiate the controller to register its actions on the messenger\n * new SampleGasPricesController({\n *   messenger: gasPricesControllerMessenger,\n * });\n *\n * // Later...\n * await globalMessenger.call(\n *   'SampleGasPricesController:updateGasPrices',\n *   { chainId: '0x42' },\n * );\n * const gasPricesControllerState = await globalMessenger.call(\n *   'SampleGasPricesController:getState',\n * );\n * gasPricesControllerState.gasPricesByChainId\n * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }\n * ```\n */\nexport class SampleGasPricesController extends BaseController<\n  typeof controllerName,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerMessenger\n> {\n  /**\n   * The globally selected chain ID.\n   */\n  #selectedChainId: Hex | undefined;\n\n  /**\n   * Constructs a new {@link SampleGasPricesController}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: SampleGasPricesControllerMessenger;\n    state?: Partial<SampleGasPricesControllerState>;\n  }) {\n    super({\n      messenger,\n      metadata: gasPricesControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultSampleGasPricesControllerState(),\n        ...state,\n      },\n    });\n\n    this.messagingSystem.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    this.messagingSystem.subscribe(\n      'NetworkController:stateChange',\n      this.#onSelectedNetworkClientIdChange.bind(this),\n      (networkControllerState) =>\n        networkControllerState.selectedNetworkClientId,\n    );\n  }\n\n  /**\n   * Fetches the latest gas prices for the given chain and persists them to\n   * state.\n   *\n   * @param args - The arguments to the function.\n   * @param args.chainId - The chain ID for which to fetch gas prices.\n   */\n  async updateGasPrices({ chainId }: { chainId: Hex }) {\n    const gasPricesResponse = await this.messagingSystem.call(\n      'SampleGasPricesService:fetchGasPrices',\n      chainId,\n    );\n\n    this.update((state) => {\n      state.gasPricesByChainId[chainId] = {\n        ...gasPricesResponse,\n        fetchedDate: new Date().toISOString(),\n      };\n    });\n  }\n\n  /**\n   * Callback to call when the globally selected network client ID changes,\n   * ensuring that gas prices get updated.\n   *\n   * @param selectedNetworkClientId - The globally selected network client ID.\n   */\n  async #onSelectedNetworkClientIdChange(\n    selectedNetworkClientId: NetworkClientId,\n  ) {\n    const {\n      configuration: { chainId },\n    } = this.messagingSystem.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n\n    if (chainId !== this.#selectedChainId) {\n      this.#selectedChainId = chainId;\n      await this.updateGasPrices({ chainId });\n    }\n  }\n}\n"]}
+{"version":3,"file":"sample-gas-prices-controller.cjs","sourceRoot":"","sources":["../src/sample-gas-prices-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAMA,+DAA2D;AAM3D,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,2BAA2B,CAAC;AAuC1D;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,kBAAkB,EAAE;QAClB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACsD,CAAC;AAmE1D;;;;;;;GAOG;AACH,SAAgB,wCAAwC;IACtD,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AAJD,4FAIC;AAED,gCAAgC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,yBAA0B,SAAQ,gCAI9C;IAMC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,gBAAgB,GAKjB;QACC,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,2BAA2B;YACrC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,wCAAwC,EAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAhCL;;WAEG;QACM,8DAAkD;QA+BzD,uBAAA,IAAI,+CAAqB,gBAAgB,MAAA,CAAC;QAE1C,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,sBAAc,kBAAkB,EACnC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5E,MAAM,iBAAiB,GACrB,MAAM,uBAAA,IAAI,mDAAkB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG;gBAClC,GAAG,iBAAiB;gBACpB,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;aACtC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,8DA8DC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport type { NetworkControllerGetStateAction } from './network-controller-types';\nimport type { SampleAbstractGasPricesService } from './sample-gas-prices-service';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link SampleGasPricesController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'SampleGasPricesController';\n\n// === STATE ===\n\n/**\n * The collection of gas price data fetched periodically.\n */\ntype GasPrices = {\n  /**\n   * The total estimated gas in the \"low\" bucket.\n   */\n  low: number;\n  /**\n   * The total estimated gas in the \"average\" bucket.\n   */\n  average: number;\n  /**\n   * The total estimated gas in the \"high\" bucket.\n   */\n  high: number;\n  /**\n   * The date/time (in ISO-8601 format) when prices were fetched.\n   */\n  fetchedDate: string;\n};\n\n/**\n * Describes the shape of the state object for {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerState = {\n  /**\n   * The registry of pet names, categorized by chain ID first and address\n   * second.\n   */\n  gasPricesByChainId: {\n    [chainId: Hex]: GasPrices;\n  };\n};\n\n/**\n * The metadata for each property in {@link SampleGasPricesControllerState}.\n */\nconst gasPricesControllerMetadata = {\n  gasPricesByChainId: {\n    persist: true,\n    anonymous: false,\n  },\n} satisfies StateMetadata<SampleGasPricesControllerState>;\n\n// === MESSENGER ===\n\n/**\n * The action which can be used to retrieve the state of the\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SampleGasPricesControllerState\n>;\n\n/**\n * The action which can be used to update gas prices.\n */\nexport type SampleGasPricesControllerUpdateGasPricesAction = {\n  type: `${typeof controllerName}:updateGasPrices`;\n  handler: SampleGasPricesController['updateGasPrices'];\n};\n\n/**\n * All actions that {@link SampleGasPricesController} registers, to be called\n * externally.\n */\nexport type SampleGasPricesControllerActions =\n  | SampleGasPricesControllerGetStateAction\n  | SampleGasPricesControllerUpdateGasPricesAction;\n\n/**\n * All actions that {@link SampleGasPricesController} calls internally.\n */\ntype AllowedActions = NetworkControllerGetStateAction;\n\n/**\n * The event that {@link SampleGasPricesController} publishes when updating state.\n */\nexport type SampleGasPricesControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    SampleGasPricesControllerState\n  >;\n\n/**\n * All events that {@link SampleGasPricesController} publishes, to be subscribed to\n * externally.\n */\nexport type SampleGasPricesControllerEvents =\n  SampleGasPricesControllerStateChangeEvent;\n\n/**\n * All events that {@link SampleGasPricesController} subscribes to internally.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link SampleGasPricesController}.\n */\nexport type SampleGasPricesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  SampleGasPricesControllerActions | AllowedActions,\n  SampleGasPricesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Constructs the default {@link SampleGasPricesController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link SampleGasPricesController} state.\n */\nexport function getDefaultSampleGasPricesControllerState(): SampleGasPricesControllerState {\n  return {\n    gasPricesByChainId: {},\n  };\n}\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * `SampleGasPricesController` fetches and persists gas prices for various chains.\n *\n * @example\n *\n * ``` ts\n * import { Messenger } from '@metamask/base-controller';\n * import {\n *   SampleGasPricesController,\n *   SampleGasPricesService\n * } from '@metamask/example-controllers';\n * import type {\n *   SampleGasPricesControllerActions,\n *   SampleGasPricesControllerEvents\n * } from '@metamask/example-controllers';\n * import type { NetworkControllerGetStateAction } from '@metamask/network-controller';\n *\n * // Assuming that you're using this in the browser\n * const gasPricesService = new SampleGasPricesService({ fetch });\n * const rootMessenger = new Messenger<\n *  SampleGasPricesControllerActions | NetworkControllerGetStateAction,\n *  SampleGasPricesControllerEvents\n * >();\n * const gasPricesMessenger = rootMessenger.getRestricted({\n *   name: 'SampleGasPricesController',\n *   allowedActions: ['NetworkController:getState'],\n *   allowedEvents: [],\n * });\n * const gasPricesController = new SampleGasPricesController({\n *   messenger: gasPricesMessenger,\n *   gasPricesService,\n * });\n *\n * // Assuming that `NetworkController:getState` returns an object with a\n * // `chainId` of `0x42`...\n * await gasPricesController.updateGasPrices();\n * gasPricesController.state.gasPricesByChainId\n * // => { '0x42': { low: 5, average: 10, high: 15, fetchedDate: '2024-01-02T00:00:00.000Z' } }\n * ```\n */\nexport class SampleGasPricesController extends BaseController<\n  typeof controllerName,\n  SampleGasPricesControllerState,\n  SampleGasPricesControllerMessenger\n> {\n  /**\n   * The service object that is used to obtain gas prices.\n   */\n  readonly #gasPricesService: SampleAbstractGasPricesService;\n\n  /**\n   * Constructs a new {@link SampleGasPricesController}.\n   *\n   * @param args - The arguments to the controller.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.state - The desired state with which to initialize this\n   * controller. Missing properties will be filled in with defaults.\n   * @param args.gasPricesService - The service object that will be used to\n   * obtain gas prices.\n   */\n  constructor({\n    messenger,\n    state,\n    gasPricesService,\n  }: {\n    messenger: SampleGasPricesControllerMessenger;\n    state?: Partial<SampleGasPricesControllerState>;\n    gasPricesService: SampleAbstractGasPricesService;\n  }) {\n    super({\n      messenger,\n      metadata: gasPricesControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultSampleGasPricesControllerState(),\n        ...state,\n      },\n    });\n\n    this.#gasPricesService = gasPricesService;\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateGasPrices`,\n      this.updateGasPrices.bind(this),\n    );\n  }\n\n  /**\n   * Fetches the latest gas prices for the current chain, persisting them to\n   * state.\n   */\n  async updateGasPrices() {\n    const { chainId } = this.messagingSystem.call('NetworkController:getState');\n    const gasPricesResponse =\n      await this.#gasPricesService.fetchGasPrices(chainId);\n    this.update((state) => {\n      state.gasPricesByChainId[chainId] = {\n        ...gasPricesResponse,\n        fetchedDate: new Date().toISOString(),\n      };\n    });\n  }\n}\n"]}