@metamask-previews/config-registry-controller 5.0.0-preview-eb6c0745c → 5.0.0-preview-e53b41ba2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/dist/ConfigRegistryController.js +5 -5
- package/dist/ConfigRegistryController.js.map +1 -1
- package/dist/config-registry-api-service/config-registry-api-service.d.ts +18 -47
- package/dist/config-registry-api-service/config-registry-api-service.d.ts.map +1 -1
- package/dist/config-registry-api-service/config-registry-api-service.js +52 -119
- package/dist/config-registry-api-service/config-registry-api-service.js.map +1 -1
- package/dist/config-registry-api-service/types.d.ts +153 -17
- package/dist/config-registry-api-service/types.d.ts.map +1 -1
- package/dist/config-registry-api-service/types.js +25 -7
- package/dist/config-registry-api-service/types.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +19 -19
package/CHANGELOG.md
CHANGED
|
@@ -7,11 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Add support for Node.js 26 ([#10981](https://github.com/MetaMask/core/pull/10981))
|
|
13
|
+
|
|
10
14
|
### Changed
|
|
11
15
|
|
|
16
|
+
- **BREAKING:** Change `FetchConfigResult` and `FetchEventsConfigResult` to use `null` instead of omitted properties ([#11134](https://github.com/MetaMask/core/pull/11134))
|
|
17
|
+
- `etag` is now `string | null`, and is `null` when the response has no `ETag` header. Previously it was `undefined`.
|
|
18
|
+
- `data` is now `null` when the server returns 304 and the service has no cached data. Previously it was omitted.
|
|
12
19
|
- Bump `reselect` from `^5.1.1` to `^5.3.0` ([#10532](https://github.com/MetaMask/core/pull/10532))
|
|
13
20
|
- Bump `@metamask/keyring-controller` from `^28.1.0` to `^28.2.0` ([#10851](https://github.com/MetaMask/core/pull/10851))
|
|
14
21
|
- Bump `@metamask/base-controller` from `^10.0.0` to `^10.1.0` ([#10864](https://github.com/MetaMask/core/pull/10864))
|
|
22
|
+
- Bump `@metamask/utils` from `^12.0.0` to `^12.0.1` ([#11107](https://github.com/MetaMask/core/pull/11107))
|
|
23
|
+
|
|
24
|
+
### Removed
|
|
25
|
+
|
|
26
|
+
- **BREAKING:** Remove `ConfigRegistryApiService.onRetry`, `ConfigRegistryApiService.onBreak`, and `ConfigRegistryApiService.onDegraded` ([#11134](https://github.com/MetaMask/core/pull/11134))
|
|
15
27
|
|
|
16
28
|
## [5.0.0]
|
|
17
29
|
|
|
@@ -96,8 +96,8 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
96
96
|
if (!result.modified) {
|
|
97
97
|
this.update((state) => {
|
|
98
98
|
state.lastFetched = Date.now();
|
|
99
|
-
if (result.etag !==
|
|
100
|
-
state.etag = result.etag
|
|
99
|
+
if (result.etag !== null) {
|
|
100
|
+
state.etag = result.etag;
|
|
101
101
|
}
|
|
102
102
|
});
|
|
103
103
|
return;
|
|
@@ -113,7 +113,7 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
113
113
|
state.configs.networks = newConfigs;
|
|
114
114
|
state.version = result.data.data.version;
|
|
115
115
|
state.lastFetched = Date.now();
|
|
116
|
-
state.etag = result.etag
|
|
116
|
+
state.etag = result.etag;
|
|
117
117
|
});
|
|
118
118
|
}
|
|
119
119
|
catch (error) {
|
|
@@ -127,7 +127,7 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
127
127
|
etag: this.state.eventsConfigEtag ?? undefined,
|
|
128
128
|
});
|
|
129
129
|
if (!result.modified) {
|
|
130
|
-
if (result.etag !==
|
|
130
|
+
if (result.etag !== null) {
|
|
131
131
|
this.update((state) => {
|
|
132
132
|
state.eventsConfigEtag = result.etag;
|
|
133
133
|
});
|
|
@@ -136,7 +136,7 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
136
136
|
}
|
|
137
137
|
this.update((state) => {
|
|
138
138
|
state.configs.eventsConfig = result.data.data;
|
|
139
|
-
state.eventsConfigEtag = result.etag
|
|
139
|
+
state.eventsConfigEtag = result.etag;
|
|
140
140
|
});
|
|
141
141
|
}
|
|
142
142
|
catch (error) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConfigRegistryController.js","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAG/E,OAAO,EAAe,QAAQ,EAAE,cAAc,EAAQ,MAAM,iBAAiB,CAAC;AAY9E,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAElD,MAAM,CAAC,MAAM,wBAAwB,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AAExE,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AA4CpD,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,IAAI;QACxB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;IACD,WAAW,EAAE;QACX,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,IAAI;QACxB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAE1E,MAAM,yBAAyB,GAAG;IAChC,cAAc;IACd,aAAa;IACb,gCAAgC;CACxB,CAAC;AAoEX,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IACC;;;;;;;;;;OAUG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,eAAe,GAAG,wBAAwB,EAC1C,cAAc,GAAG,uBAAuB,GACR;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE;gBACL,OAAO,EAAE;oBACP,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,GAAG,cAAc,EAAE;oBAC1D,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,YAAY,IAAI,IAAI;iBAClD;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;gBACxB,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,IAAI,IAAI;aACjD;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QACF,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,8BAA8B,CAC5B,YAAyB;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,sCAAsC,EACtC;gBACE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,SAAS;aACnC,CACF,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC/B,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;wBAC9B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;oBACnC,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YAC1C,MAAM,UAAU,GAA0C,EAAE,CAAC;YAC7D,wDAAwD;YACxD,SAAS,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBAChC,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;gBAChC,UAAU,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC;gBACpC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBACzC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,aAAa,GACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,4CAA4C,EAC5C;gBACE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,SAAS;aAC/C,CACF,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,gBAAgB,GAAG,MAAM,CAAC,IAAc,CAAC;oBACjD,CAAC,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO;YACT,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC9C,KAAK,CAAC,gBAAgB,GAAG,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,aAAa,GACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,kEAAkE;QAClE,4EAA4E;QAC5E,+CAA+C;QAC/C,KAAK,CAAC,cAAc,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,0BAA0B,EAC1B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5E,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,yCAAyC,EACzC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EACpC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS;QACP,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,gBAAsB;QACzC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAEzE,IACE,OAAO,gBAAgB,KAAK,SAAS;YACrC,gBAAgB;YAChB,UAAU,EACV,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAC1C,sCAAsC,CACvC,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QAEvC,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangedEvent,\n StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n KeyringControllerGetStateAction,\n KeyringControllerLockEvent,\n KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport type { RemoteFeatureFlagControllerStateChangeEvent } from '@metamask/remote-feature-flag-controller';\nimport { CaipChainId, Duration, inMilliseconds, Json } from '@metamask/utils';\n\nimport type {\n ConfigRegistryApiServiceFetchConfigAction,\n ConfigRegistryApiServiceFetchEventsConfigAction,\n} from './config-registry-api-service/config-registry-api-service-method-action-types.js';\nimport type {\n RegistryEventsConfig,\n RegistryNetworkConfig,\n} from './config-registry-api-service/types.js';\nimport type { ConfigRegistryControllerMethodActions } from './ConfigRegistryController-method-action-types.js';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\n\nconst FEATURE_FLAG_KEY = 'configRegistryApiEnabled';\n\n/**\n * State for the ConfigRegistryController.\n *\n * Tracks network configurations fetched from the config registry API,\n * along with metadata about the fetch status and caching.\n */\nexport type ConfigRegistryControllerState = {\n /**\n * Configurations fetched from the config registry API.\n * Stores network configs and events config.\n */\n configs: {\n networks: Record<CaipChainId, RegistryNetworkConfig>;\n eventsConfig?: RegistryEventsConfig | null;\n };\n /**\n * Semantic version string of the configuration data from the API.\n * Indicates the version/schema of the configuration structure itself\n * (e.g., \"v1.0.0\", \"1.0.0\").\n * This is different from `etag` which is used for HTTP cache validation.\n */\n version: string | null;\n /**\n * Timestamp (milliseconds since epoch) of when the configuration\n * was last successfully fetched from the API.\n */\n lastFetched: number | null;\n /**\n * HTTP entity tag (ETag) used for cache validation.\n * Sent as `If-None-Match` header in subsequent requests to check\n * if the content has changed. If the server returns 304 Not Modified,\n * the full response body is not downloaded, improving efficiency.\n * This is different from `version` which is a semantic version string\n * indicating the schema/version of the configuration data itself.\n */\n etag: string | null;\n /**\n * HTTP entity tag (ETag) for the events-config endpoint cache validation.\n */\n eventsConfigEtag?: string | null;\n};\n\nconst stateMetadata = {\n configs: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: true,\n usedInUi: true,\n },\n version: {\n persist: true,\n includeInStateLogs: true,\n includeInDebugSnapshot: true,\n usedInUi: false,\n },\n lastFetched: {\n persist: true,\n includeInStateLogs: true,\n includeInDebugSnapshot: true,\n usedInUi: false,\n },\n etag: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: false,\n usedInUi: false,\n },\n eventsConfigEtag: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: false,\n usedInUi: false,\n },\n} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\nconst MESSENGER_EXPOSED_METHODS = [\n 'startPolling',\n 'stopPolling',\n 'getNetworkConfigByCaip2ChainId',\n] as const;\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangedEvent =\n ControllerStateChangedEvent<\n typeof controllerName,\n ConfigRegistryControllerState\n >;\n\n/**\n * Retrieves the state of the {@link ConfigRegistryController}.\n */\nexport type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<\n typeof controllerName,\n ConfigRegistryControllerState\n>;\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n | KeyringControllerGetStateAction\n | RemoteFeatureFlagControllerGetStateAction\n | ConfigRegistryApiServiceFetchConfigAction\n | ConfigRegistryApiServiceFetchEventsConfigAction;\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n ConfigRegistryControllerStateChangedEvent;\n\n/**\n * Events from other messengers that {@link ConfigRegistryControllerMessenger}\n * subscribes to.\n */\ntype AllowedEvents =\n | KeyringControllerUnlockEvent\n | KeyringControllerLockEvent\n | RemoteFeatureFlagControllerStateChangeEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ConfigRegistryController}.\n */\nexport type ConfigRegistryControllerMessenger = Messenger<\n typeof controllerName,\n ConfigRegistryControllerActions | AllowedActions,\n ConfigRegistryControllerEvents | AllowedEvents\n>;\n\nexport type ConfigRegistryControllerOptions = {\n messenger: ConfigRegistryControllerMessenger;\n state?: Partial<ConfigRegistryControllerState>;\n pollingInterval?: number;\n fallbackConfig?: Record<string, RegistryNetworkConfig>;\n};\n\nexport class ConfigRegistryController extends StaticIntervalPollingController<null>()<\n typeof controllerName,\n ConfigRegistryControllerState,\n ConfigRegistryControllerMessenger\n> {\n /**\n * @param options - The controller options.\n * @param options.messenger - The controller messenger. Must have\n * `ConfigRegistryApiService:fetchConfig` and\n * `ConfigRegistryApiService:fetchEventsConfig` action handlers registered\n * (e.g. by instantiating {@link ConfigRegistryApiService} with the same\n * messenger).\n * @param options.state - Initial state.\n * @param options.pollingInterval - Polling interval in milliseconds.\n * @param options.fallbackConfig - Fallback configuration.\n */\n constructor({\n messenger,\n state = {},\n pollingInterval = DEFAULT_POLLING_INTERVAL,\n fallbackConfig = DEFAULT_FALLBACK_CONFIG,\n }: ConfigRegistryControllerOptions) {\n super({\n name: controllerName,\n metadata: stateMetadata,\n messenger,\n state: {\n configs: {\n networks: state.configs?.networks ?? { ...fallbackConfig },\n eventsConfig: state.configs?.eventsConfig ?? null,\n },\n version: state.version ?? null,\n lastFetched: state.lastFetched ?? null,\n etag: state.etag ?? null,\n eventsConfigEtag: state.eventsConfigEtag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n\n this.messenger.registerMethodActionHandlers(\n this,\n MESSENGER_EXPOSED_METHODS,\n );\n this.#setupEventListeners();\n }\n\n /**\n * Get the network configuration for a given CAIP-2 chain ID.\n *\n * @param caip2ChainId - The CAIP-2 chain ID (e.g., \"eip155:1\").\n * @returns The network configuration if found, otherwise undefined.\n */\n getNetworkConfigByCaip2ChainId(\n caip2ChainId: CaipChainId,\n ): RegistryNetworkConfig | undefined {\n return this.state.configs.networks[caip2ChainId];\n }\n\n async _executePoll(_input: null): Promise<void> {\n await Promise.all([this.#fetchNetworksConfig(), this.#fetchEventsConfig()]);\n }\n\n async #fetchNetworksConfig(): Promise<void> {\n try {\n const result = await this.messenger.call(\n 'ConfigRegistryApiService:fetchConfig',\n {\n etag: this.state.etag ?? undefined,\n },\n );\n\n if (!result.modified) {\n this.update((state) => {\n state.lastFetched = Date.now();\n if (result.etag !== undefined) {\n state.etag = result.etag ?? null;\n }\n });\n return;\n }\n\n const apiChains = result.data.data.chains;\n const newConfigs: Record<string, RegistryNetworkConfig> = {};\n // duplicate chainIds from API response are not expected\n apiChains.forEach((chainConfig) => {\n const { chainId } = chainConfig;\n newConfigs[chainId] = chainConfig;\n });\n\n this.update((state) => {\n state.configs.networks = newConfigs;\n state.version = result.data.data.version;\n state.lastFetched = Date.now();\n state.etag = result.etag ?? null;\n });\n } catch (error) {\n const errorInstance =\n error instanceof Error ? error : new Error(String(error));\n\n this.messenger.captureException?.(errorInstance);\n }\n }\n\n async #fetchEventsConfig(): Promise<void> {\n try {\n const result = await this.messenger.call(\n 'ConfigRegistryApiService:fetchEventsConfig',\n {\n etag: this.state.eventsConfigEtag ?? undefined,\n },\n );\n\n if (!result.modified) {\n if (result.etag !== undefined) {\n this.update((state) => {\n state.eventsConfigEtag = result.etag as string;\n });\n }\n return;\n }\n\n this.update((state) => {\n state.configs.eventsConfig = result.data.data;\n state.eventsConfigEtag = result.etag ?? null;\n });\n } catch (error) {\n const errorInstance =\n error instanceof Error ? error : new Error(String(error));\n\n this.messenger.captureException?.(errorInstance);\n }\n }\n\n /**\n * Stop all polling.\n */\n stopPolling(): void {\n // This is a wrapper around `super.stopAllPolling()` for backwards\n // compatibility, while allowing this method to be exposed via the messenger\n // using the `MESSENGER_EXPOSED_METHODS` array.\n super.stopAllPolling();\n }\n\n /**\n * Setup messenger event listeners necessary for the controller lifecycle\n */\n #setupEventListeners(): void {\n this.messenger.subscribe(\n 'KeyringController:unlock',\n this.#onUnlock.bind(this),\n );\n\n this.messenger.subscribe('KeyringController:lock', this.#onLock.bind(this));\n\n this.messenger.subscribe(\n 'RemoteFeatureFlagController:stateChange',\n this.#onFeatureFlagChange.bind(this),\n (stateSelector) => stateSelector.remoteFeatureFlags[FEATURE_FLAG_KEY],\n );\n }\n\n /**\n * Handle wallet unlock event by starting polling if the config registry API is enabled.\n */\n #onUnlock(): void {\n if (this.#isFeatureFlagEnabled()) {\n this.startPolling(null);\n }\n }\n\n /**\n * Handle wallet lock event by stopping all polling to prevent unnecessary API calls.\n */\n #onLock(): void {\n this.stopAllPolling();\n }\n\n /**\n * Handle changes to the config registry API feature flag by\n * starting or stopping polling accordingly.\n *\n * @param featureFlagValue - The new value of the feature flag.\n */\n #onFeatureFlagChange(featureFlagValue: Json): void {\n const { isUnlocked } = this.messenger.call('KeyringController:getState');\n\n if (\n typeof featureFlagValue === 'boolean' &&\n featureFlagValue &&\n isUnlocked\n ) {\n this.startPolling(null);\n } else {\n this.stopAllPolling();\n }\n }\n\n /**\n * Get the current status of the config registry feature flag.\n *\n * @returns Whether the config registry API is enabled.\n */\n #isFeatureFlagEnabled(): boolean {\n const featureFlagValue = this.messenger.call(\n 'RemoteFeatureFlagController:getState',\n ).remoteFeatureFlags[FEATURE_FLAG_KEY];\n\n if (typeof featureFlagValue !== 'boolean') {\n return false;\n }\n\n return featureFlagValue;\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"ConfigRegistryController.js","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAG/E,OAAO,EAAe,QAAQ,EAAE,cAAc,EAAQ,MAAM,iBAAiB,CAAC;AAY9E,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAElD,MAAM,CAAC,MAAM,wBAAwB,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AAExE,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AA4CpD,MAAM,aAAa,GAAG;IACpB,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,IAAI;QACxB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;IACD,WAAW,EAAE;QACX,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,IAAI;QACxB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAE1E,MAAM,yBAAyB,GAAG;IAChC,cAAc;IACd,aAAa;IACb,gCAAgC;CACxB,CAAC;AAoEX,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IACC;;;;;;;;;;OAUG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,eAAe,GAAG,wBAAwB,EAC1C,cAAc,GAAG,uBAAuB,GACR;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,aAAa;YACvB,SAAS;YACT,KAAK,EAAE;gBACL,OAAO,EAAE;oBACP,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,IAAI,EAAE,GAAG,cAAc,EAAE;oBAC1D,YAAY,EAAE,KAAK,CAAC,OAAO,EAAE,YAAY,IAAI,IAAI;iBAClD;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;gBACxB,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,IAAI,IAAI;aACjD;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QACF,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,8BAA8B,CAC5B,YAAyB;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,sCAAsC,EACtC;gBACE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,SAAS;aACnC,CACF,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC/B,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;wBACzB,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;oBAC3B,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;YAC1C,MAAM,UAAU,GAA0C,EAAE,CAAC;YAC7D,wDAAwD;YACxD,SAAS,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBAChC,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;gBAChC,UAAU,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC;YACpC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC;gBACpC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBACzC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC/B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,aAAa,GACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,4CAA4C,EAC5C;gBACE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,SAAS;aAC/C,CACF,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACzB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC;oBACvC,CAAC,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO;YACT,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC9C,KAAK,CAAC,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC;YACvC,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,aAAa,GACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,kEAAkE;QAClE,4EAA4E;QAC5E,+CAA+C;QAC/C,KAAK,CAAC,cAAc,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,0BAA0B,EAC1B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5E,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,yCAAyC,EACzC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EACpC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS;QACP,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,gBAAsB;QACzC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAEzE,IACE,OAAO,gBAAgB,KAAK,SAAS;YACrC,gBAAgB;YAChB,UAAU,EACV,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAC1C,sCAAsC,CACvC,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QAEvC,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangedEvent,\n StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n KeyringControllerGetStateAction,\n KeyringControllerLockEvent,\n KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport type { RemoteFeatureFlagControllerStateChangeEvent } from '@metamask/remote-feature-flag-controller';\nimport { CaipChainId, Duration, inMilliseconds, Json } from '@metamask/utils';\n\nimport type {\n ConfigRegistryApiServiceFetchConfigAction,\n ConfigRegistryApiServiceFetchEventsConfigAction,\n} from './config-registry-api-service/config-registry-api-service-method-action-types.js';\nimport type {\n RegistryEventsConfig,\n RegistryNetworkConfig,\n} from './config-registry-api-service/types.js';\nimport type { ConfigRegistryControllerMethodActions } from './ConfigRegistryController-method-action-types.js';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\n\nconst FEATURE_FLAG_KEY = 'configRegistryApiEnabled';\n\n/**\n * State for the ConfigRegistryController.\n *\n * Tracks network configurations fetched from the config registry API,\n * along with metadata about the fetch status and caching.\n */\nexport type ConfigRegistryControllerState = {\n /**\n * Configurations fetched from the config registry API.\n * Stores network configs and events config.\n */\n configs: {\n networks: Record<CaipChainId, RegistryNetworkConfig>;\n eventsConfig?: RegistryEventsConfig | null;\n };\n /**\n * Semantic version string of the configuration data from the API.\n * Indicates the version/schema of the configuration structure itself\n * (e.g., \"v1.0.0\", \"1.0.0\").\n * This is different from `etag` which is used for HTTP cache validation.\n */\n version: string | null;\n /**\n * Timestamp (milliseconds since epoch) of when the configuration\n * was last successfully fetched from the API.\n */\n lastFetched: number | null;\n /**\n * HTTP entity tag (ETag) used for cache validation.\n * Sent as `If-None-Match` header in subsequent requests to check\n * if the content has changed. If the server returns 304 Not Modified,\n * the full response body is not downloaded, improving efficiency.\n * This is different from `version` which is a semantic version string\n * indicating the schema/version of the configuration data itself.\n */\n etag: string | null;\n /**\n * HTTP entity tag (ETag) for the events-config endpoint cache validation.\n */\n eventsConfigEtag?: string | null;\n};\n\nconst stateMetadata = {\n configs: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: true,\n usedInUi: true,\n },\n version: {\n persist: true,\n includeInStateLogs: true,\n includeInDebugSnapshot: true,\n usedInUi: false,\n },\n lastFetched: {\n persist: true,\n includeInStateLogs: true,\n includeInDebugSnapshot: true,\n usedInUi: false,\n },\n etag: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: false,\n usedInUi: false,\n },\n eventsConfigEtag: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: false,\n usedInUi: false,\n },\n} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\nconst MESSENGER_EXPOSED_METHODS = [\n 'startPolling',\n 'stopPolling',\n 'getNetworkConfigByCaip2ChainId',\n] as const;\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangedEvent =\n ControllerStateChangedEvent<\n typeof controllerName,\n ConfigRegistryControllerState\n >;\n\n/**\n * Retrieves the state of the {@link ConfigRegistryController}.\n */\nexport type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<\n typeof controllerName,\n ConfigRegistryControllerState\n>;\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n | KeyringControllerGetStateAction\n | RemoteFeatureFlagControllerGetStateAction\n | ConfigRegistryApiServiceFetchConfigAction\n | ConfigRegistryApiServiceFetchEventsConfigAction;\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n ConfigRegistryControllerStateChangedEvent;\n\n/**\n * Events from other messengers that {@link ConfigRegistryControllerMessenger}\n * subscribes to.\n */\ntype AllowedEvents =\n | KeyringControllerUnlockEvent\n | KeyringControllerLockEvent\n | RemoteFeatureFlagControllerStateChangeEvent;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ConfigRegistryController}.\n */\nexport type ConfigRegistryControllerMessenger = Messenger<\n typeof controllerName,\n ConfigRegistryControllerActions | AllowedActions,\n ConfigRegistryControllerEvents | AllowedEvents\n>;\n\nexport type ConfigRegistryControllerOptions = {\n messenger: ConfigRegistryControllerMessenger;\n state?: Partial<ConfigRegistryControllerState>;\n pollingInterval?: number;\n fallbackConfig?: Record<string, RegistryNetworkConfig>;\n};\n\nexport class ConfigRegistryController extends StaticIntervalPollingController<null>()<\n typeof controllerName,\n ConfigRegistryControllerState,\n ConfigRegistryControllerMessenger\n> {\n /**\n * @param options - The controller options.\n * @param options.messenger - The controller messenger. Must have\n * `ConfigRegistryApiService:fetchConfig` and\n * `ConfigRegistryApiService:fetchEventsConfig` action handlers registered\n * (e.g. by instantiating {@link ConfigRegistryApiService} with the same\n * messenger).\n * @param options.state - Initial state.\n * @param options.pollingInterval - Polling interval in milliseconds.\n * @param options.fallbackConfig - Fallback configuration.\n */\n constructor({\n messenger,\n state = {},\n pollingInterval = DEFAULT_POLLING_INTERVAL,\n fallbackConfig = DEFAULT_FALLBACK_CONFIG,\n }: ConfigRegistryControllerOptions) {\n super({\n name: controllerName,\n metadata: stateMetadata,\n messenger,\n state: {\n configs: {\n networks: state.configs?.networks ?? { ...fallbackConfig },\n eventsConfig: state.configs?.eventsConfig ?? null,\n },\n version: state.version ?? null,\n lastFetched: state.lastFetched ?? null,\n etag: state.etag ?? null,\n eventsConfigEtag: state.eventsConfigEtag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n\n this.messenger.registerMethodActionHandlers(\n this,\n MESSENGER_EXPOSED_METHODS,\n );\n this.#setupEventListeners();\n }\n\n /**\n * Get the network configuration for a given CAIP-2 chain ID.\n *\n * @param caip2ChainId - The CAIP-2 chain ID (e.g., \"eip155:1\").\n * @returns The network configuration if found, otherwise undefined.\n */\n getNetworkConfigByCaip2ChainId(\n caip2ChainId: CaipChainId,\n ): RegistryNetworkConfig | undefined {\n return this.state.configs.networks[caip2ChainId];\n }\n\n async _executePoll(_input: null): Promise<void> {\n await Promise.all([this.#fetchNetworksConfig(), this.#fetchEventsConfig()]);\n }\n\n async #fetchNetworksConfig(): Promise<void> {\n try {\n const result = await this.messenger.call(\n 'ConfigRegistryApiService:fetchConfig',\n {\n etag: this.state.etag ?? undefined,\n },\n );\n\n if (!result.modified) {\n this.update((state) => {\n state.lastFetched = Date.now();\n if (result.etag !== null) {\n state.etag = result.etag;\n }\n });\n return;\n }\n\n const apiChains = result.data.data.chains;\n const newConfigs: Record<string, RegistryNetworkConfig> = {};\n // duplicate chainIds from API response are not expected\n apiChains.forEach((chainConfig) => {\n const { chainId } = chainConfig;\n newConfigs[chainId] = chainConfig;\n });\n\n this.update((state) => {\n state.configs.networks = newConfigs;\n state.version = result.data.data.version;\n state.lastFetched = Date.now();\n state.etag = result.etag;\n });\n } catch (error) {\n const errorInstance =\n error instanceof Error ? error : new Error(String(error));\n\n this.messenger.captureException?.(errorInstance);\n }\n }\n\n async #fetchEventsConfig(): Promise<void> {\n try {\n const result = await this.messenger.call(\n 'ConfigRegistryApiService:fetchEventsConfig',\n {\n etag: this.state.eventsConfigEtag ?? undefined,\n },\n );\n\n if (!result.modified) {\n if (result.etag !== null) {\n this.update((state) => {\n state.eventsConfigEtag = result.etag;\n });\n }\n return;\n }\n\n this.update((state) => {\n state.configs.eventsConfig = result.data.data;\n state.eventsConfigEtag = result.etag;\n });\n } catch (error) {\n const errorInstance =\n error instanceof Error ? error : new Error(String(error));\n\n this.messenger.captureException?.(errorInstance);\n }\n }\n\n /**\n * Stop all polling.\n */\n stopPolling(): void {\n // This is a wrapper around `super.stopAllPolling()` for backwards\n // compatibility, while allowing this method to be exposed via the messenger\n // using the `MESSENGER_EXPOSED_METHODS` array.\n super.stopAllPolling();\n }\n\n /**\n * Setup messenger event listeners necessary for the controller lifecycle\n */\n #setupEventListeners(): void {\n this.messenger.subscribe(\n 'KeyringController:unlock',\n this.#onUnlock.bind(this),\n );\n\n this.messenger.subscribe('KeyringController:lock', this.#onLock.bind(this));\n\n this.messenger.subscribe(\n 'RemoteFeatureFlagController:stateChange',\n this.#onFeatureFlagChange.bind(this),\n (stateSelector) => stateSelector.remoteFeatureFlags[FEATURE_FLAG_KEY],\n );\n }\n\n /**\n * Handle wallet unlock event by starting polling if the config registry API is enabled.\n */\n #onUnlock(): void {\n if (this.#isFeatureFlagEnabled()) {\n this.startPolling(null);\n }\n }\n\n /**\n * Handle wallet lock event by stopping all polling to prevent unnecessary API calls.\n */\n #onLock(): void {\n this.stopAllPolling();\n }\n\n /**\n * Handle changes to the config registry API feature flag by\n * starting or stopping polling accordingly.\n *\n * @param featureFlagValue - The new value of the feature flag.\n */\n #onFeatureFlagChange(featureFlagValue: Json): void {\n const { isUnlocked } = this.messenger.call('KeyringController:getState');\n\n if (\n typeof featureFlagValue === 'boolean' &&\n featureFlagValue &&\n isUnlocked\n ) {\n this.startPolling(null);\n } else {\n this.stopAllPolling();\n }\n }\n\n /**\n * Get the current status of the config registry feature flag.\n *\n * @returns Whether the config registry API is enabled.\n */\n #isFeatureFlagEnabled(): boolean {\n const featureFlagValue = this.messenger.call(\n 'RemoteFeatureFlagController:getState',\n ).remoteFeatureFlags[FEATURE_FLAG_KEY];\n\n if (typeof featureFlagValue !== 'boolean') {\n return false;\n }\n\n return featureFlagValue;\n }\n}\n"]}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { BaseDataService } from '@metamask/base-data-service';
|
|
2
|
+
import type { CreateServicePolicyOptions, DataServiceCacheUpdatedEvent, DataServiceGranularCacheUpdatedEvent, DataServiceInvalidateQueriesAction } from '@metamask/base-data-service';
|
|
2
3
|
import type { Messenger } from '@metamask/messenger';
|
|
3
|
-
import type { IDisposable } from 'cockatiel';
|
|
4
4
|
import type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';
|
|
5
5
|
import type { FetchConfigOptions, FetchConfigResult, FetchEventsConfigResult } from './types.js';
|
|
6
6
|
export declare enum ConfigRegistryApiEnv {
|
|
@@ -13,18 +13,31 @@ export declare enum ConfigRegistryApiEnv {
|
|
|
13
13
|
* service's actions and events.
|
|
14
14
|
*/
|
|
15
15
|
export declare const serviceName = "ConfigRegistryApiService";
|
|
16
|
+
/**
|
|
17
|
+
* Invalidates cached queries for {@link ConfigRegistryApiService}.
|
|
18
|
+
*/
|
|
19
|
+
export type ConfigRegistryApiServiceInvalidateQueriesAction = DataServiceInvalidateQueriesAction<typeof serviceName>;
|
|
16
20
|
/**
|
|
17
21
|
* Actions that {@link ConfigRegistryApiService} exposes to other consumers.
|
|
18
22
|
*/
|
|
19
|
-
export type ConfigRegistryApiServiceActions = ConfigRegistryApiServiceMethodActions;
|
|
23
|
+
export type ConfigRegistryApiServiceActions = ConfigRegistryApiServiceMethodActions | ConfigRegistryApiServiceInvalidateQueriesAction;
|
|
20
24
|
/**
|
|
21
25
|
* Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.
|
|
22
26
|
*/
|
|
23
27
|
type AllowedActions = never;
|
|
28
|
+
/**
|
|
29
|
+
* Published when {@link ConfigRegistryApiService}'s cache is updated.
|
|
30
|
+
*/
|
|
31
|
+
export type ConfigRegistryApiServiceCacheUpdatedEvent = DataServiceCacheUpdatedEvent<typeof serviceName>;
|
|
32
|
+
/**
|
|
33
|
+
* Published when a key within {@link ConfigRegistryApiService}'s cache is
|
|
34
|
+
* updated.
|
|
35
|
+
*/
|
|
36
|
+
export type ConfigRegistryApiServiceGranularCacheUpdatedEvent = DataServiceGranularCacheUpdatedEvent<typeof serviceName>;
|
|
24
37
|
/**
|
|
25
38
|
* Events that {@link ConfigRegistryApiService} exposes to other consumers.
|
|
26
39
|
*/
|
|
27
|
-
export type ConfigRegistryApiServiceEvents =
|
|
40
|
+
export type ConfigRegistryApiServiceEvents = ConfigRegistryApiServiceCacheUpdatedEvent | ConfigRegistryApiServiceGranularCacheUpdatedEvent;
|
|
28
41
|
/**
|
|
29
42
|
* Events from other messengers that {@link ConfigRegistryApiService} subscribes to.
|
|
30
43
|
*/
|
|
@@ -48,9 +61,8 @@ export type ConfigRegistryApiServiceOptions = {
|
|
|
48
61
|
*/
|
|
49
62
|
policyOptions?: CreateServicePolicyOptions;
|
|
50
63
|
};
|
|
51
|
-
export declare class ConfigRegistryApiService {
|
|
64
|
+
export declare class ConfigRegistryApiService extends BaseDataService<typeof serviceName, ConfigRegistryApiServiceMessenger> {
|
|
52
65
|
#private;
|
|
53
|
-
readonly name: typeof serviceName;
|
|
54
66
|
/**
|
|
55
67
|
* Construct a Config Registry API Service.
|
|
56
68
|
*
|
|
@@ -61,47 +73,6 @@ export declare class ConfigRegistryApiService {
|
|
|
61
73
|
* @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.
|
|
62
74
|
*/
|
|
63
75
|
constructor({ messenger, env, fetch: customFetch, policyOptions, }: ConfigRegistryApiServiceOptions);
|
|
64
|
-
/**
|
|
65
|
-
* Registers a handler that will be called after a request returns a non-500
|
|
66
|
-
* response, causing a retry. Primarily useful in tests where timers are being
|
|
67
|
-
* mocked.
|
|
68
|
-
*
|
|
69
|
-
* @param listener - The handler to be called.
|
|
70
|
-
* @returns An object that can be used to unregister the handler. See
|
|
71
|
-
* {@link CockatielEvent}.
|
|
72
|
-
* @see {@link createServicePolicy}
|
|
73
|
-
*/
|
|
74
|
-
onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable;
|
|
75
|
-
/**
|
|
76
|
-
* Registers a handler that will be called after a set number of retry rounds
|
|
77
|
-
* prove that requests to the API endpoint consistently return a 5xx response.
|
|
78
|
-
*
|
|
79
|
-
* @param args - The arguments passed to the underlying policy's onBreak method
|
|
80
|
-
* (e.g. the listener to be called).
|
|
81
|
-
* @returns An object that can be used to unregister the handler. See
|
|
82
|
-
* {@link CockatielEvent}.
|
|
83
|
-
* @see {@link createServicePolicy}
|
|
84
|
-
*/
|
|
85
|
-
onBreak(...args: Parameters<ServicePolicy['onBreak']>): ReturnType<ServicePolicy['onBreak']>;
|
|
86
|
-
/**
|
|
87
|
-
* Registers a handler that will be called under one of two circumstances:
|
|
88
|
-
*
|
|
89
|
-
* 1. After a set number of retries prove that requests to the API
|
|
90
|
-
* consistently result in one of the following failures:
|
|
91
|
-
* 1. A connection initiation error
|
|
92
|
-
* 2. A connection reset error
|
|
93
|
-
* 3. A timeout error
|
|
94
|
-
* 4. A non-JSON response
|
|
95
|
-
* 5. A 502, 503, or 504 response
|
|
96
|
-
* 2. After a successful request is made to the API, but the response takes
|
|
97
|
-
* longer than a set duration to return.
|
|
98
|
-
*
|
|
99
|
-
* @param args - The arguments passed to the underlying policy's onDegraded
|
|
100
|
-
* method (e.g. the listener to be called).
|
|
101
|
-
* @returns An object that can be used to unregister the handler. See
|
|
102
|
-
* {@link CockatielEvent}.
|
|
103
|
-
*/
|
|
104
|
-
onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): ReturnType<ServicePolicy['onDegraded']>;
|
|
105
76
|
fetchConfig(options?: FetchConfigOptions): Promise<FetchConfigResult>;
|
|
106
77
|
fetchEventsConfig(options?: FetchConfigOptions): Promise<FetchEventsConfigResult>;
|
|
107
78
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config-registry-api-service.d.ts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"config-registry-api-service.d.ts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC5B,oCAAoC,EACpC,kCAAkC,EACnC,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,sDAAsD,CAAC;AAClH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EAGxB,MAAM,YAAY,CAAC;AASpB,oBAAY,oBAAoB;IAC9B,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,SAAS;CACb;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,6BAA6B,CAAC;AAMtD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,kCAAkC,CAAC,OAAO,WAAW,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,qCAAqC,GACrC,+CAA+C,CAAC;AAEpD;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,4BAA4B,CAAC,OAAO,WAAW,CAAC,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,iDAAiD,GAC3D,oCAAoC,CAAC,OAAO,WAAW,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,yCAAyC,GACzC,iDAAiD,CAAC;AAEtD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,WAAW,EAClB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAmBF,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;;OAGG;IACH,SAAS,EAAE,iCAAiC,CAAC;IAC7C,GAAG,CAAC,EAAE,oBAAoB,CAAC;IAC3B,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF,qBAAa,wBAAyB,SAAQ,eAAe,CAC3D,OAAO,WAAW,EAClB,iCAAiC,CAClC;;IAOC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAA8B,EAC9B,KAAK,EAAE,WAA8B,EACrC,aAAkB,GACnB,EAAE,+BAA+B,EAkBjC;IAEK,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,iBAAiB,CAAC,CAwC5B;IAEK,iBAAiB,CACrB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,uBAAuB,CAAC,CAyClC;CACF"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { BaseDataService } from '@metamask/base-data-service';
|
|
2
|
+
import { HttpError } from '@metamask/controller-utils';
|
|
3
|
+
import { FetchConfigResultStruct, FetchEventsConfigResultStruct, } from './types.js';
|
|
3
4
|
const NETWORKS_ENDPOINT_PATH = '/config/networks';
|
|
4
5
|
const EVENTS_CONFIG_ENDPOINT_PATH = '/config/events-config';
|
|
5
6
|
export var ConfigRegistryApiEnv;
|
|
@@ -27,17 +28,10 @@ function getConfigRegistryUrl(env, endpointPath) {
|
|
|
27
28
|
const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;
|
|
28
29
|
return `https://client-config.${envPrefix}api.cx.metamask.io/v1${endpointPath}`;
|
|
29
30
|
}
|
|
30
|
-
export class ConfigRegistryApiService {
|
|
31
|
-
name;
|
|
32
|
-
#messenger;
|
|
33
|
-
#policy;
|
|
31
|
+
export class ConfigRegistryApiService extends BaseDataService {
|
|
34
32
|
#networksUrl;
|
|
35
33
|
#eventsConfigUrl;
|
|
36
34
|
#fetch;
|
|
37
|
-
/** Cached response from the last successful networks fetch. Used when server returns 304. */
|
|
38
|
-
#cachedResponse = null;
|
|
39
|
-
/** Cached response from the last successful events-config fetch. Used when server returns 304. */
|
|
40
|
-
#cachedEventsConfigResponse = null;
|
|
41
35
|
/**
|
|
42
36
|
* Construct a Config Registry API Service.
|
|
43
37
|
*
|
|
@@ -48,60 +42,15 @@ export class ConfigRegistryApiService {
|
|
|
48
42
|
* @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.
|
|
49
43
|
*/
|
|
50
44
|
constructor({ messenger, env = ConfigRegistryApiEnv.UAT, fetch: customFetch = globalThis.fetch, policyOptions = {}, }) {
|
|
51
|
-
|
|
52
|
-
|
|
45
|
+
super({
|
|
46
|
+
name: serviceName,
|
|
47
|
+
messenger,
|
|
48
|
+
policyOptions,
|
|
49
|
+
});
|
|
53
50
|
this.#networksUrl = getConfigRegistryUrl(env, NETWORKS_ENDPOINT_PATH);
|
|
54
51
|
this.#eventsConfigUrl = getConfigRegistryUrl(env, EVENTS_CONFIG_ENDPOINT_PATH);
|
|
55
52
|
this.#fetch = customFetch;
|
|
56
|
-
this
|
|
57
|
-
this.#messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* Registers a handler that will be called after a request returns a non-500
|
|
61
|
-
* response, causing a retry. Primarily useful in tests where timers are being
|
|
62
|
-
* mocked.
|
|
63
|
-
*
|
|
64
|
-
* @param listener - The handler to be called.
|
|
65
|
-
* @returns An object that can be used to unregister the handler. See
|
|
66
|
-
* {@link CockatielEvent}.
|
|
67
|
-
* @see {@link createServicePolicy}
|
|
68
|
-
*/
|
|
69
|
-
onRetry(listener) {
|
|
70
|
-
return this.#policy.onRetry(listener);
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* Registers a handler that will be called after a set number of retry rounds
|
|
74
|
-
* prove that requests to the API endpoint consistently return a 5xx response.
|
|
75
|
-
*
|
|
76
|
-
* @param args - The arguments passed to the underlying policy's onBreak method
|
|
77
|
-
* (e.g. the listener to be called).
|
|
78
|
-
* @returns An object that can be used to unregister the handler. See
|
|
79
|
-
* {@link CockatielEvent}.
|
|
80
|
-
* @see {@link createServicePolicy}
|
|
81
|
-
*/
|
|
82
|
-
onBreak(...args) {
|
|
83
|
-
return this.#policy.onBreak(...args);
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* Registers a handler that will be called under one of two circumstances:
|
|
87
|
-
*
|
|
88
|
-
* 1. After a set number of retries prove that requests to the API
|
|
89
|
-
* consistently result in one of the following failures:
|
|
90
|
-
* 1. A connection initiation error
|
|
91
|
-
* 2. A connection reset error
|
|
92
|
-
* 3. A timeout error
|
|
93
|
-
* 4. A non-JSON response
|
|
94
|
-
* 5. A 502, 503, or 504 response
|
|
95
|
-
* 2. After a successful request is made to the API, but the response takes
|
|
96
|
-
* longer than a set duration to return.
|
|
97
|
-
*
|
|
98
|
-
* @param args - The arguments passed to the underlying policy's onDegraded
|
|
99
|
-
* method (e.g. the listener to be called).
|
|
100
|
-
* @returns An object that can be used to unregister the handler. See
|
|
101
|
-
* {@link CockatielEvent}.
|
|
102
|
-
*/
|
|
103
|
-
onDegraded(...args) {
|
|
104
|
-
return this.#policy.onDegraded(...args);
|
|
53
|
+
this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
|
|
105
54
|
}
|
|
106
55
|
async fetchConfig(options = {}) {
|
|
107
56
|
const headers = {
|
|
@@ -110,35 +59,28 @@ export class ConfigRegistryApiService {
|
|
|
110
59
|
if (options.etag) {
|
|
111
60
|
headers['If-None-Match'] = options.etag;
|
|
112
61
|
}
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
62
|
+
return this.fetchQuery({
|
|
63
|
+
queryKey: [`${this.name}:fetchConfig`],
|
|
64
|
+
staleTime: 0,
|
|
65
|
+
responseStruct: FetchConfigResultStruct,
|
|
66
|
+
queryFn: async ({ client, queryKey, }) => {
|
|
67
|
+
const res = await this.#fetch(this.#networksUrl, { headers });
|
|
68
|
+
const etag = res.headers.get('ETag');
|
|
69
|
+
if (res.status === 304) {
|
|
70
|
+
const previous = client.getQueryData(queryKey);
|
|
71
|
+
return { modified: false, etag, data: previous?.data ?? null };
|
|
72
|
+
}
|
|
73
|
+
if (!res.ok) {
|
|
74
|
+
throw new HttpError(res.status, `Failed to fetch config: ${res.status} ${res.statusText}`);
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
modified: true,
|
|
78
|
+
etag,
|
|
79
|
+
// Casting to satisfy linter, the struct will validate this is actually true.
|
|
80
|
+
data: (await res.json()),
|
|
81
|
+
};
|
|
82
|
+
},
|
|
124
83
|
});
|
|
125
|
-
if (response.status === 304) {
|
|
126
|
-
const etag = response.headers.get('ETag') ?? undefined;
|
|
127
|
-
return {
|
|
128
|
-
modified: false,
|
|
129
|
-
etag,
|
|
130
|
-
...(this.#cachedResponse !== null && { data: this.#cachedResponse }),
|
|
131
|
-
};
|
|
132
|
-
}
|
|
133
|
-
const etag = response.headers.get('ETag') ?? undefined;
|
|
134
|
-
const jsonData = await response.json();
|
|
135
|
-
validateRegistryConfigApiResponse(jsonData);
|
|
136
|
-
this.#cachedResponse = jsonData;
|
|
137
|
-
return {
|
|
138
|
-
data: jsonData,
|
|
139
|
-
etag,
|
|
140
|
-
modified: true,
|
|
141
|
-
};
|
|
142
84
|
}
|
|
143
85
|
async fetchEventsConfig(options = {}) {
|
|
144
86
|
const headers = {
|
|
@@ -147,37 +89,28 @@ export class ConfigRegistryApiService {
|
|
|
147
89
|
if (options.etag) {
|
|
148
90
|
headers['If-None-Match'] = options.etag;
|
|
149
91
|
}
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
92
|
+
return this.fetchQuery({
|
|
93
|
+
queryKey: [`${this.name}:fetchEventsConfig`],
|
|
94
|
+
staleTime: 0,
|
|
95
|
+
responseStruct: FetchEventsConfigResultStruct,
|
|
96
|
+
queryFn: async ({ client, queryKey, }) => {
|
|
97
|
+
const res = await this.#fetch(this.#eventsConfigUrl, { headers });
|
|
98
|
+
const etag = res.headers.get('ETag');
|
|
99
|
+
if (res.status === 304) {
|
|
100
|
+
const previous = client.getQueryData(queryKey);
|
|
101
|
+
return { modified: false, etag, data: previous?.data ?? null };
|
|
102
|
+
}
|
|
103
|
+
if (!res.ok) {
|
|
104
|
+
throw new HttpError(res.status, `Failed to fetch events config: ${res.status} ${res.statusText}`);
|
|
105
|
+
}
|
|
106
|
+
return {
|
|
107
|
+
modified: true,
|
|
108
|
+
etag,
|
|
109
|
+
// Casting to satisfy linter, the struct will validate this is actually true.
|
|
110
|
+
data: (await res.json()),
|
|
111
|
+
};
|
|
112
|
+
},
|
|
161
113
|
});
|
|
162
|
-
if (response.status === 304) {
|
|
163
|
-
const etag = response.headers.get('ETag') ?? undefined;
|
|
164
|
-
return {
|
|
165
|
-
modified: false,
|
|
166
|
-
etag,
|
|
167
|
-
...(this.#cachedEventsConfigResponse !== null && {
|
|
168
|
-
data: this.#cachedEventsConfigResponse,
|
|
169
|
-
}),
|
|
170
|
-
};
|
|
171
|
-
}
|
|
172
|
-
const etag = response.headers.get('ETag') ?? undefined;
|
|
173
|
-
const jsonData = await response.json();
|
|
174
|
-
validateRegistryEventsConfigApiResponse(jsonData);
|
|
175
|
-
this.#cachedEventsConfigResponse = jsonData;
|
|
176
|
-
return {
|
|
177
|
-
data: jsonData,
|
|
178
|
-
etag,
|
|
179
|
-
modified: true,
|
|
180
|
-
};
|
|
181
114
|
}
|
|
182
115
|
}
|
|
183
116
|
//# sourceMappingURL=config-registry-api-service.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config-registry-api-service.js","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAgB5E,OAAO,EACL,iCAAiC,EACjC,uCAAuC,GACxC,MAAM,YAAY,CAAC;AAEpB,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AAClD,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;AAE5D,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mCAAW,CAAA;IACX,mCAAW,CAAA;IACX,oCAAY,CAAA;AACd,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAEtD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,aAAa,EAAE,mBAAmB,CAAU,CAAC;AAiChF,6BAA6B;AAE7B;;;;;;GAMG;AACH,SAAS,oBAAoB,CAC3B,GAAyB,EACzB,YAAoB;IAEpB,MAAM,SAAS,GAAG,GAAG,KAAK,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACpE,OAAO,yBAAyB,SAAS,wBAAwB,YAAY,EAAE,CAAC;AAClF,CAAC;AAiBD,MAAM,OAAO,wBAAwB;IAC1B,IAAI,CAAqB;IAEzB,UAAU,CAAoC;IAE9C,OAAO,CAAgB;IAEvB,YAAY,CAAS;IAErB,gBAAgB,CAAS;IAEzB,MAAM,CAAe;IAE9B,6FAA6F;IAC7F,eAAe,GAAqC,IAAI,CAAC;IAEzD,kGAAkG;IAClG,2BAA2B,GAA2C,IAAI,CAAC;IAE3E;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,oBAAoB,CAAC,GAAG,EAC9B,KAAK,EAAE,WAAW,GAAG,UAAU,CAAC,KAAK,EACrC,aAAa,GAAG,EAAE,GACc;QAChC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;QACtE,IAAI,CAAC,gBAAgB,GAAG,oBAAoB,CAC1C,GAAG,EACH,2BAA2B,CAC5B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAElD,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAA0C;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAA6C;QAEhD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAAO,GAAuB,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE;gBAC/C,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACb,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,2BAA2B,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;YACvD,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,IAAI;gBACJ,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;aACrE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAY,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEhD,iCAAiC,CAAC,QAAQ,CAAC,CAAC;QAE5C,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,OAAO,GAAuB,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACnD,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACb,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,kCAAkC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CACjE,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;YACvD,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,IAAI;gBACJ,GAAG,CAAC,IAAI,CAAC,2BAA2B,KAAK,IAAI,IAAI;oBAC/C,IAAI,EAAE,IAAI,CAAC,2BAA2B;iBACvC,CAAC;aACH,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAY,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEhD,uCAAuC,CAAC,QAAQ,CAAC,CAAC;QAElD,IAAI,CAAC,2BAA2B,GAAG,QAAQ,CAAC;QAE5C,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type {\n CreateServicePolicyOptions,\n ServicePolicy,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';\nimport type {\n FetchConfigOptions,\n FetchConfigResult,\n FetchEventsConfigResult,\n RegistryConfigApiResponse,\n RegistryEventsConfigApiResponse,\n} from './types.js';\nimport {\n validateRegistryConfigApiResponse,\n validateRegistryEventsConfigApiResponse,\n} from './types.js';\n\nconst NETWORKS_ENDPOINT_PATH = '/config/networks';\nconst EVENTS_CONFIG_ENDPOINT_PATH = '/config/events-config';\n\nexport enum ConfigRegistryApiEnv {\n DEV = 'dev',\n UAT = 'uat',\n PRD = 'prod',\n}\n\n/**\n * The name of the {@link ConfigRegistryApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ConfigRegistryApiService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchConfig', 'fetchEventsConfig'] as const;\n\n/**\n * Actions that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceActions =\n ConfigRegistryApiServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ConfigRegistryApiService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceMessenger = Messenger<\n typeof serviceName,\n ConfigRegistryApiServiceActions | AllowedActions,\n ConfigRegistryApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the config registry API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @param endpointPath - The endpoint path to append.\n * @returns The full URL for the endpoint.\n */\nfunction getConfigRegistryUrl(\n env: ConfigRegistryApiEnv,\n endpointPath: string,\n): string {\n const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;\n return `https://client-config.${envPrefix}api.cx.metamask.io/v1${endpointPath}`;\n}\n\nexport type ConfigRegistryApiServiceOptions = {\n /**\n * The messenger suited for this service. Required so the service can be used\n * independently and register its actions.\n */\n messenger: ConfigRegistryApiServiceMessenger;\n env?: ConfigRegistryApiEnv;\n fetch?: typeof fetch;\n /**\n * Options to pass to `createServicePolicy`, which wraps each request.\n * See {@link CreateServicePolicyOptions}.\n */\n policyOptions?: CreateServicePolicyOptions;\n};\n\nexport class ConfigRegistryApiService {\n readonly name: typeof serviceName;\n\n readonly #messenger: ConfigRegistryApiServiceMessenger;\n\n readonly #policy: ServicePolicy;\n\n readonly #networksUrl: string;\n\n readonly #eventsConfigUrl: string;\n\n readonly #fetch: typeof fetch;\n\n /** Cached response from the last successful networks fetch. Used when server returns 304. */\n #cachedResponse: RegistryConfigApiResponse | null = null;\n\n /** Cached response from the last successful events-config fetch. Used when server returns 304. */\n #cachedEventsConfigResponse: RegistryEventsConfigApiResponse | null = null;\n\n /**\n * Construct a Config Registry API Service.\n *\n * @param options - The options for constructing the service.\n * @param options.messenger - The messenger suited for this service.\n * @param options.env - The environment to determine the correct API endpoints. Defaults to UAT.\n * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.\n * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.\n */\n constructor({\n messenger,\n env = ConfigRegistryApiEnv.UAT,\n fetch: customFetch = globalThis.fetch,\n policyOptions = {},\n }: ConfigRegistryApiServiceOptions) {\n this.name = serviceName;\n this.#messenger = messenger;\n this.#networksUrl = getConfigRegistryUrl(env, NETWORKS_ENDPOINT_PATH);\n this.#eventsConfigUrl = getConfigRegistryUrl(\n env,\n EVENTS_CONFIG_ENDPOINT_PATH,\n );\n this.#fetch = customFetch;\n\n this.#policy = createServicePolicy(policyOptions);\n\n this.#messenger.registerMethodActionHandlers(\n this,\n MESSENGER_EXPOSED_METHODS,\n );\n }\n\n /**\n * Registers a handler that will be called after a request returns a non-500\n * response, causing a retry. Primarily useful in tests where timers are being\n * mocked.\n *\n * @param listener - The handler to be called.\n * @returns An object that can be used to unregister the handler. See\n * {@link CockatielEvent}.\n * @see {@link createServicePolicy}\n */\n onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n return this.#policy.onRetry(listener);\n }\n\n /**\n * Registers a handler that will be called after a set number of retry rounds\n * prove that requests to the API endpoint consistently return a 5xx response.\n *\n * @param args - The arguments passed to the underlying policy's onBreak method\n * (e.g. the listener to be called).\n * @returns An object that can be used to unregister the handler. See\n * {@link CockatielEvent}.\n * @see {@link createServicePolicy}\n */\n onBreak(\n ...args: Parameters<ServicePolicy['onBreak']>\n ): ReturnType<ServicePolicy['onBreak']> {\n return this.#policy.onBreak(...args);\n }\n\n /**\n * Registers a handler that will be called under one of two circumstances:\n *\n * 1. After a set number of retries prove that requests to the API\n * consistently result in one of the following failures:\n * 1. A connection initiation error\n * 2. A connection reset error\n * 3. A timeout error\n * 4. A non-JSON response\n * 5. A 502, 503, or 504 response\n * 2. After a successful request is made to the API, but the response takes\n * longer than a set duration to return.\n *\n * @param args - The arguments passed to the underlying policy's onDegraded\n * method (e.g. the listener to be called).\n * @returns An object that can be used to unregister the handler. See\n * {@link CockatielEvent}.\n */\n onDegraded(\n ...args: Parameters<ServicePolicy['onDegraded']>\n ): ReturnType<ServicePolicy['onDegraded']> {\n return this.#policy.onDegraded(...args);\n }\n\n async fetchConfig(\n options: FetchConfigOptions = {},\n ): Promise<FetchConfigResult> {\n const headers: HeadersInit = {\n 'Cache-Control': 'no-cache',\n };\n\n if (options.etag) {\n headers['If-None-Match'] = options.etag;\n }\n\n const response = await this.#policy.execute(async () => {\n const res = await this.#fetch(this.#networksUrl, {\n headers,\n });\n\n if (res.status === 304) {\n return res;\n }\n\n if (!res.ok) {\n throw new HttpError(\n res.status,\n `Failed to fetch config: ${res.status} ${res.statusText}`,\n );\n }\n\n return res;\n });\n\n if (response.status === 304) {\n const etag = response.headers.get('ETag') ?? undefined;\n return {\n modified: false,\n etag,\n ...(this.#cachedResponse !== null && { data: this.#cachedResponse }),\n };\n }\n\n const etag = response.headers.get('ETag') ?? undefined;\n const jsonData: unknown = await response.json();\n\n validateRegistryConfigApiResponse(jsonData);\n\n this.#cachedResponse = jsonData;\n\n return {\n data: jsonData,\n etag,\n modified: true,\n };\n }\n\n async fetchEventsConfig(\n options: FetchConfigOptions = {},\n ): Promise<FetchEventsConfigResult> {\n const headers: HeadersInit = {\n 'Cache-Control': 'no-cache',\n };\n\n if (options.etag) {\n headers['If-None-Match'] = options.etag;\n }\n\n const response = await this.#policy.execute(async () => {\n const res = await this.#fetch(this.#eventsConfigUrl, {\n headers,\n });\n\n if (res.status === 304) {\n return res;\n }\n\n if (!res.ok) {\n throw new HttpError(\n res.status,\n `Failed to fetch events config: ${res.status} ${res.statusText}`,\n );\n }\n\n return res;\n });\n\n if (response.status === 304) {\n const etag = response.headers.get('ETag') ?? undefined;\n return {\n modified: false,\n etag,\n ...(this.#cachedEventsConfigResponse !== null && {\n data: this.#cachedEventsConfigResponse,\n }),\n };\n }\n\n const etag = response.headers.get('ETag') ?? undefined;\n const jsonData: unknown = await response.json();\n\n validateRegistryEventsConfigApiResponse(jsonData);\n\n this.#cachedEventsConfigResponse = jsonData;\n\n return {\n data: jsonData,\n etag,\n modified: true,\n };\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"config-registry-api-service.js","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAO9D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAYvD,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,YAAY,CAAC;AAEpB,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AAClD,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;AAE5D,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mCAAW,CAAA;IACX,mCAAW,CAAA;IACX,oCAAY,CAAA;AACd,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAEtD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,aAAa,EAAE,mBAAmB,CAAU,CAAC;AAuDhF,6BAA6B;AAE7B;;;;;;GAMG;AACH,SAAS,oBAAoB,CAC3B,GAAyB,EACzB,YAAoB;IAEpB,MAAM,SAAS,GAAG,GAAG,KAAK,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACpE,OAAO,yBAAyB,SAAS,wBAAwB,YAAY,EAAE,CAAC;AAClF,CAAC;AAiBD,MAAM,OAAO,wBAAyB,SAAQ,eAG7C;IACU,YAAY,CAAS;IAErB,gBAAgB,CAAS;IAEzB,MAAM,CAAe;IAE9B;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,oBAAoB,CAAC,GAAG,EAC9B,KAAK,EAAE,WAAW,GAAG,UAAU,CAAC,KAAK,EACrC,aAAa,GAAG,EAAE,GACc;QAChC,KAAK,CAAC;YACJ,IAAI,EAAE,WAAW;YACjB,SAAS;YACT,aAAa;SACd,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;QACtE,IAAI,CAAC,gBAAgB,GAAG,oBAAoB,CAC1C,GAAG,EACH,2BAA2B,CAC5B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAAO,GAAuB,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC;YACtC,SAAS,EAAE,CAAC;YACZ,cAAc,EAAE,uBAAuB;YACvC,OAAO,EAAE,KAAK,EAAE,EACd,MAAM,EACN,QAAQ,GACuB,EAA8B,EAAE;gBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC9D,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAErC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAoB,QAAQ,CAAC,CAAC;oBAClE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;gBACjE,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;oBACZ,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,2BAA2B,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,QAAQ,EAAE,IAAI;oBACd,IAAI;oBACJ,6EAA6E;oBAC7E,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B;iBACtD,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,OAAO,GAAuB,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,oBAAoB,CAAC;YAC5C,SAAS,EAAE,CAAC;YACZ,cAAc,EAAE,6BAA6B;YAC7C,OAAO,EAAE,KAAK,EAAE,EACd,MAAM,EACN,QAAQ,GACuB,EAAoC,EAAE;gBACrE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;gBAClE,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAErC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBACvB,MAAM,QAAQ,GACZ,MAAM,CAAC,YAAY,CAA0B,QAAQ,CAAC,CAAC;oBACzD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;gBACjE,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;oBACZ,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,kCAAkC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CACjE,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,QAAQ,EAAE,IAAI;oBACd,IAAI;oBACJ,6EAA6E;oBAC7E,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAoC;iBAC5D,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { BaseDataService } from '@metamask/base-data-service';\nimport type {\n CreateServicePolicyOptions,\n DataServiceCacheUpdatedEvent,\n DataServiceGranularCacheUpdatedEvent,\n DataServiceInvalidateQueriesAction,\n} from '@metamask/base-data-service';\nimport { HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { QueryFunctionContext } from '@tanstack/query-core';\n\nimport type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';\nimport type {\n FetchConfigOptions,\n FetchConfigResult,\n FetchEventsConfigResult,\n RegistryConfigApiResponse,\n RegistryEventsConfigApiResponse,\n} from './types.js';\nimport {\n FetchConfigResultStruct,\n FetchEventsConfigResultStruct,\n} from './types.js';\n\nconst NETWORKS_ENDPOINT_PATH = '/config/networks';\nconst EVENTS_CONFIG_ENDPOINT_PATH = '/config/events-config';\n\nexport enum ConfigRegistryApiEnv {\n DEV = 'dev',\n UAT = 'uat',\n PRD = 'prod',\n}\n\n/**\n * The name of the {@link ConfigRegistryApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ConfigRegistryApiService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchConfig', 'fetchEventsConfig'] as const;\n\n/**\n * Invalidates cached queries for {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceInvalidateQueriesAction =\n DataServiceInvalidateQueriesAction<typeof serviceName>;\n\n/**\n * Actions that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceActions =\n | ConfigRegistryApiServiceMethodActions\n | ConfigRegistryApiServiceInvalidateQueriesAction;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when {@link ConfigRegistryApiService}'s cache is updated.\n */\nexport type ConfigRegistryApiServiceCacheUpdatedEvent =\n DataServiceCacheUpdatedEvent<typeof serviceName>;\n\n/**\n * Published when a key within {@link ConfigRegistryApiService}'s cache is\n * updated.\n */\nexport type ConfigRegistryApiServiceGranularCacheUpdatedEvent =\n DataServiceGranularCacheUpdatedEvent<typeof serviceName>;\n\n/**\n * Events that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceEvents =\n | ConfigRegistryApiServiceCacheUpdatedEvent\n | ConfigRegistryApiServiceGranularCacheUpdatedEvent;\n\n/**\n * Events from other messengers that {@link ConfigRegistryApiService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceMessenger = Messenger<\n typeof serviceName,\n ConfigRegistryApiServiceActions | AllowedActions,\n ConfigRegistryApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the config registry API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @param endpointPath - The endpoint path to append.\n * @returns The full URL for the endpoint.\n */\nfunction getConfigRegistryUrl(\n env: ConfigRegistryApiEnv,\n endpointPath: string,\n): string {\n const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;\n return `https://client-config.${envPrefix}api.cx.metamask.io/v1${endpointPath}`;\n}\n\nexport type ConfigRegistryApiServiceOptions = {\n /**\n * The messenger suited for this service. Required so the service can be used\n * independently and register its actions.\n */\n messenger: ConfigRegistryApiServiceMessenger;\n env?: ConfigRegistryApiEnv;\n fetch?: typeof fetch;\n /**\n * Options to pass to `createServicePolicy`, which wraps each request.\n * See {@link CreateServicePolicyOptions}.\n */\n policyOptions?: CreateServicePolicyOptions;\n};\n\nexport class ConfigRegistryApiService extends BaseDataService<\n typeof serviceName,\n ConfigRegistryApiServiceMessenger\n> {\n readonly #networksUrl: string;\n\n readonly #eventsConfigUrl: string;\n\n readonly #fetch: typeof fetch;\n\n /**\n * Construct a Config Registry API Service.\n *\n * @param options - The options for constructing the service.\n * @param options.messenger - The messenger suited for this service.\n * @param options.env - The environment to determine the correct API endpoints. Defaults to UAT.\n * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.\n * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.\n */\n constructor({\n messenger,\n env = ConfigRegistryApiEnv.UAT,\n fetch: customFetch = globalThis.fetch,\n policyOptions = {},\n }: ConfigRegistryApiServiceOptions) {\n super({\n name: serviceName,\n messenger,\n policyOptions,\n });\n\n this.#networksUrl = getConfigRegistryUrl(env, NETWORKS_ENDPOINT_PATH);\n this.#eventsConfigUrl = getConfigRegistryUrl(\n env,\n EVENTS_CONFIG_ENDPOINT_PATH,\n );\n this.#fetch = customFetch;\n\n this.messenger.registerMethodActionHandlers(\n this,\n MESSENGER_EXPOSED_METHODS,\n );\n }\n\n async fetchConfig(\n options: FetchConfigOptions = {},\n ): Promise<FetchConfigResult> {\n const headers: HeadersInit = {\n 'Cache-Control': 'no-cache',\n };\n\n if (options.etag) {\n headers['If-None-Match'] = options.etag;\n }\n\n return this.fetchQuery({\n queryKey: [`${this.name}:fetchConfig`],\n staleTime: 0,\n responseStruct: FetchConfigResultStruct,\n queryFn: async ({\n client,\n queryKey,\n }: QueryFunctionContext<[string]>): Promise<FetchConfigResult> => {\n const res = await this.#fetch(this.#networksUrl, { headers });\n const etag = res.headers.get('ETag');\n\n if (res.status === 304) {\n const previous = client.getQueryData<FetchConfigResult>(queryKey);\n return { modified: false, etag, data: previous?.data ?? null };\n }\n\n if (!res.ok) {\n throw new HttpError(\n res.status,\n `Failed to fetch config: ${res.status} ${res.statusText}`,\n );\n }\n\n return {\n modified: true,\n etag,\n // Casting to satisfy linter, the struct will validate this is actually true.\n data: (await res.json()) as RegistryConfigApiResponse,\n };\n },\n });\n }\n\n async fetchEventsConfig(\n options: FetchConfigOptions = {},\n ): Promise<FetchEventsConfigResult> {\n const headers: HeadersInit = {\n 'Cache-Control': 'no-cache',\n };\n\n if (options.etag) {\n headers['If-None-Match'] = options.etag;\n }\n\n return this.fetchQuery({\n queryKey: [`${this.name}:fetchEventsConfig`],\n staleTime: 0,\n responseStruct: FetchEventsConfigResultStruct,\n queryFn: async ({\n client,\n queryKey,\n }: QueryFunctionContext<[string]>): Promise<FetchEventsConfigResult> => {\n const res = await this.#fetch(this.#eventsConfigUrl, { headers });\n const etag = res.headers.get('ETag');\n\n if (res.status === 304) {\n const previous =\n client.getQueryData<FetchEventsConfigResult>(queryKey);\n return { modified: false, etag, data: previous?.data ?? null };\n }\n\n if (!res.ok) {\n throw new HttpError(\n res.status,\n `Failed to fetch events config: ${res.status} ${res.statusText}`,\n );\n }\n\n return {\n modified: true,\n etag,\n // Casting to satisfy linter, the struct will validate this is actually true.\n data: (await res.json()) as RegistryEventsConfigApiResponse,\n };\n },\n });\n }\n}\n"]}
|
|
@@ -490,7 +490,6 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
|
|
|
490
490
|
}>;
|
|
491
491
|
export type RegistryNetworkConfig = Infer<typeof RegistryNetworkConfigSchema>;
|
|
492
492
|
export type RegistryConfigApiResponse = Infer<typeof RegistryConfigApiResponseSchema>;
|
|
493
|
-
export declare function validateRegistryConfigApiResponse(data: unknown): asserts data is RegistryConfigApiResponse;
|
|
494
493
|
/**
|
|
495
494
|
* Schema for the events-config API response.
|
|
496
495
|
* Maps event names to their allowed analytics purposes.
|
|
@@ -517,30 +516,167 @@ export declare const RegistryEventsConfigApiResponseSchema: import("@metamask/su
|
|
|
517
516
|
}>;
|
|
518
517
|
export type RegistryEventsConfigApiResponse = Infer<typeof RegistryEventsConfigApiResponseSchema>;
|
|
519
518
|
export type RegistryEventsConfig = RegistryEventsConfigApiResponse['data'];
|
|
520
|
-
export declare
|
|
519
|
+
export declare const FetchConfigResultStruct: import("@metamask/superstruct").Struct<{
|
|
520
|
+
modified: false;
|
|
521
|
+
etag: string | null;
|
|
522
|
+
data: {
|
|
523
|
+
data: {
|
|
524
|
+
version: string;
|
|
525
|
+
timestamp: number;
|
|
526
|
+
chains: {
|
|
527
|
+
chainId: `${string}:${string}`;
|
|
528
|
+
name: string;
|
|
529
|
+
imageUrl: string;
|
|
530
|
+
coingeckoPlatformId: string;
|
|
531
|
+
geckoTerminalPlatformId?: string | undefined;
|
|
532
|
+
assets: {
|
|
533
|
+
listUrl?: string | undefined;
|
|
534
|
+
native: {
|
|
535
|
+
assetId: string;
|
|
536
|
+
imageUrl: string;
|
|
537
|
+
name: string;
|
|
538
|
+
symbol: string;
|
|
539
|
+
decimals: number;
|
|
540
|
+
coingeckoCoinId?: string | undefined;
|
|
541
|
+
};
|
|
542
|
+
governance?: {
|
|
543
|
+
assetId: string;
|
|
544
|
+
imageUrl: string;
|
|
545
|
+
name: string;
|
|
546
|
+
symbol: string;
|
|
547
|
+
decimals: number;
|
|
548
|
+
coingeckoCoinId?: string | undefined;
|
|
549
|
+
} | undefined;
|
|
550
|
+
};
|
|
551
|
+
rpcProviders: {
|
|
552
|
+
default: {
|
|
553
|
+
url: string;
|
|
554
|
+
type: string;
|
|
555
|
+
networkClientId: string;
|
|
556
|
+
};
|
|
557
|
+
fallbacks: string[];
|
|
558
|
+
};
|
|
559
|
+
blockExplorerUrls: {
|
|
560
|
+
default: string;
|
|
561
|
+
fallbacks: string[];
|
|
562
|
+
};
|
|
563
|
+
config: {
|
|
564
|
+
isActive: boolean;
|
|
565
|
+
isTestnet: boolean;
|
|
566
|
+
isDefault: boolean;
|
|
567
|
+
isFeatured: boolean;
|
|
568
|
+
isDeprecated: boolean;
|
|
569
|
+
isDeletable: boolean;
|
|
570
|
+
isAutoEnabled?: boolean | undefined;
|
|
571
|
+
priority: number;
|
|
572
|
+
};
|
|
573
|
+
contracts?: {
|
|
574
|
+
multicall3?: `0x${string}` | undefined;
|
|
575
|
+
} | undefined;
|
|
576
|
+
}[];
|
|
577
|
+
};
|
|
578
|
+
} | null;
|
|
579
|
+
} | {
|
|
580
|
+
modified: true;
|
|
581
|
+
etag: string | null;
|
|
582
|
+
data: {
|
|
583
|
+
data: {
|
|
584
|
+
version: string;
|
|
585
|
+
timestamp: number;
|
|
586
|
+
chains: {
|
|
587
|
+
chainId: `${string}:${string}`;
|
|
588
|
+
name: string;
|
|
589
|
+
imageUrl: string;
|
|
590
|
+
coingeckoPlatformId: string;
|
|
591
|
+
geckoTerminalPlatformId?: string | undefined;
|
|
592
|
+
assets: {
|
|
593
|
+
listUrl?: string | undefined;
|
|
594
|
+
native: {
|
|
595
|
+
assetId: string;
|
|
596
|
+
imageUrl: string;
|
|
597
|
+
name: string;
|
|
598
|
+
symbol: string;
|
|
599
|
+
decimals: number;
|
|
600
|
+
coingeckoCoinId?: string | undefined;
|
|
601
|
+
};
|
|
602
|
+
governance?: {
|
|
603
|
+
assetId: string;
|
|
604
|
+
imageUrl: string;
|
|
605
|
+
name: string;
|
|
606
|
+
symbol: string;
|
|
607
|
+
decimals: number;
|
|
608
|
+
coingeckoCoinId?: string | undefined;
|
|
609
|
+
} | undefined;
|
|
610
|
+
};
|
|
611
|
+
rpcProviders: {
|
|
612
|
+
default: {
|
|
613
|
+
url: string;
|
|
614
|
+
type: string;
|
|
615
|
+
networkClientId: string;
|
|
616
|
+
};
|
|
617
|
+
fallbacks: string[];
|
|
618
|
+
};
|
|
619
|
+
blockExplorerUrls: {
|
|
620
|
+
default: string;
|
|
621
|
+
fallbacks: string[];
|
|
622
|
+
};
|
|
623
|
+
config: {
|
|
624
|
+
isActive: boolean;
|
|
625
|
+
isTestnet: boolean;
|
|
626
|
+
isDefault: boolean;
|
|
627
|
+
isFeatured: boolean;
|
|
628
|
+
isDeprecated: boolean;
|
|
629
|
+
isDeletable: boolean;
|
|
630
|
+
isAutoEnabled?: boolean | undefined;
|
|
631
|
+
priority: number;
|
|
632
|
+
};
|
|
633
|
+
contracts?: {
|
|
634
|
+
multicall3?: `0x${string}` | undefined;
|
|
635
|
+
} | undefined;
|
|
636
|
+
}[];
|
|
637
|
+
};
|
|
638
|
+
};
|
|
639
|
+
}, null>;
|
|
640
|
+
export declare const FetchEventsConfigResultStruct: import("@metamask/superstruct").Struct<{
|
|
641
|
+
modified: false;
|
|
642
|
+
etag: string | null;
|
|
643
|
+
data: {
|
|
644
|
+
data: {
|
|
645
|
+
schemaVersion: string;
|
|
646
|
+
version: string;
|
|
647
|
+
timestamp: number;
|
|
648
|
+
events: Record<string, string[]>;
|
|
649
|
+
};
|
|
650
|
+
} | null;
|
|
651
|
+
} | {
|
|
652
|
+
modified: true;
|
|
653
|
+
etag: string | null;
|
|
654
|
+
data: {
|
|
655
|
+
data: {
|
|
656
|
+
schemaVersion: string;
|
|
657
|
+
version: string;
|
|
658
|
+
timestamp: number;
|
|
659
|
+
events: Record<string, string[]>;
|
|
660
|
+
};
|
|
661
|
+
};
|
|
662
|
+
}, null>;
|
|
521
663
|
export type FetchConfigOptions = {
|
|
522
664
|
etag?: string;
|
|
523
665
|
};
|
|
524
|
-
|
|
666
|
+
type FetchResult<Data> = {
|
|
525
667
|
modified: false;
|
|
526
|
-
etag
|
|
668
|
+
etag: string | null;
|
|
527
669
|
/**
|
|
528
670
|
* Cached data from the service when available (e.g. after a previous
|
|
529
|
-
* successful fetch).
|
|
671
|
+
* successful fetch). `null` when the service has no cache yet.
|
|
530
672
|
*/
|
|
531
|
-
data
|
|
532
|
-
} | {
|
|
533
|
-
modified: true;
|
|
534
|
-
data: RegistryConfigApiResponse;
|
|
535
|
-
etag?: string;
|
|
536
|
-
};
|
|
537
|
-
export type FetchEventsConfigResult = {
|
|
538
|
-
modified: false;
|
|
539
|
-
etag?: string;
|
|
540
|
-
data?: RegistryEventsConfigApiResponse;
|
|
673
|
+
data: Data | null;
|
|
541
674
|
} | {
|
|
542
675
|
modified: true;
|
|
543
|
-
|
|
544
|
-
|
|
676
|
+
etag: string | null;
|
|
677
|
+
data: Data;
|
|
545
678
|
};
|
|
679
|
+
export type FetchConfigResult = FetchResult<RegistryConfigApiResponse>;
|
|
680
|
+
export type FetchEventsConfigResult = FetchResult<RegistryEventsConfigApiResponse>;
|
|
681
|
+
export {};
|
|
546
682
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config-registry-api-service/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config-registry-api-service/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AA6DnD;;;GAGG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWtC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAM1C,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAE9E,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAC3C,OAAO,+BAA+B,CACvC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;;;;;;;;;;;EAOhD,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,KAAK,CACjD,OAAO,qCAAqC,CAC7C,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,MAAM,CAAC,CAAC;AAE3E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAWlC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;QAWxC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,WAAW,CAAC,IAAI,IACjB;IACE,QAAQ,EAAE,KAAK,CAAC;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;;OAGG;IACH,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB,GACD;IACE,QAAQ,EAAE,IAAI,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEN,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,yBAAyB,CAAC,CAAC;AAEvE,MAAM,MAAM,uBAAuB,GACjC,WAAW,CAAC,+BAA+B,CAAC,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { array,
|
|
1
|
+
import { array, boolean, literal, nullable, number, optional, record, string, type, union, } from '@metamask/superstruct';
|
|
2
2
|
import { CaipChainIdStruct, StrictHexStruct } from '@metamask/utils';
|
|
3
3
|
const AssetSchema = type({
|
|
4
4
|
assetId: string(),
|
|
@@ -65,9 +65,6 @@ export const RegistryConfigApiResponseSchema = type({
|
|
|
65
65
|
chains: array(RegistryNetworkConfigSchema),
|
|
66
66
|
}),
|
|
67
67
|
});
|
|
68
|
-
export function validateRegistryConfigApiResponse(data) {
|
|
69
|
-
assert(data, RegistryConfigApiResponseSchema);
|
|
70
|
-
}
|
|
71
68
|
/**
|
|
72
69
|
* Schema for the events-config API response.
|
|
73
70
|
* Maps event names to their allowed analytics purposes.
|
|
@@ -80,7 +77,28 @@ export const RegistryEventsConfigApiResponseSchema = type({
|
|
|
80
77
|
events: record(string(), array(string())),
|
|
81
78
|
}),
|
|
82
79
|
});
|
|
83
|
-
export
|
|
84
|
-
|
|
85
|
-
|
|
80
|
+
export const FetchConfigResultStruct = union([
|
|
81
|
+
type({
|
|
82
|
+
modified: literal(false),
|
|
83
|
+
etag: nullable(string()),
|
|
84
|
+
data: nullable(RegistryConfigApiResponseSchema),
|
|
85
|
+
}),
|
|
86
|
+
type({
|
|
87
|
+
modified: literal(true),
|
|
88
|
+
etag: nullable(string()),
|
|
89
|
+
data: RegistryConfigApiResponseSchema,
|
|
90
|
+
}),
|
|
91
|
+
]);
|
|
92
|
+
export const FetchEventsConfigResultStruct = union([
|
|
93
|
+
type({
|
|
94
|
+
modified: literal(false),
|
|
95
|
+
etag: nullable(string()),
|
|
96
|
+
data: nullable(RegistryEventsConfigApiResponseSchema),
|
|
97
|
+
}),
|
|
98
|
+
type({
|
|
99
|
+
modified: literal(true),
|
|
100
|
+
etag: nullable(string()),
|
|
101
|
+
data: RegistryEventsConfigApiResponseSchema,
|
|
102
|
+
}),
|
|
103
|
+
]);
|
|
86
104
|
//# sourceMappingURL=types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/config-registry-api-service/types.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/config-registry-api-service/types.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,OAAO,EACP,OAAO,EACP,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,IAAI,EACJ,KAAK,GACN,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAErE,MAAM,WAAW,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,EAAE;IACjB,QAAQ,EAAE,MAAM,EAAE;IAClB,IAAI,EAAE,MAAM,EAAE;IACd,MAAM,EAAE,MAAM,EAAE;IAChB,QAAQ,EAAE,MAAM,EAAE;IAClB,eAAe,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC3B,MAAM,EAAE,WAAW;IACnB,UAAU,EAAE,QAAQ,CAAC,WAAW,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,IAAI,CAAC;IAC7B,GAAG,EAAE,MAAM,EAAE;IACb,IAAI,EAAE,MAAM,EAAE;IACd,eAAe,EAAE,MAAM,EAAE;CAC1B,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,IAAI,CAAC;IAC9B,OAAO,EAAE,iBAAiB;IAC1B,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,uBAAuB,GAAG,IAAI,CAAC;IACnC,OAAO,EAAE,MAAM,EAAE;IACjB,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,IAAI,CAAC;IAC7B,QAAQ,EAAE,OAAO,EAAE;IACnB,SAAS,EAAE,OAAO,EAAE;IACpB,SAAS,EAAE,OAAO,EAAE;IACpB,UAAU,EAAE,OAAO,EAAE;IACrB,YAAY,EAAE,OAAO,EAAE;IACvB,WAAW,EAAE,OAAO,EAAE;IACtB,aAAa,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IAClC,QAAQ,EAAE,MAAM,EAAE;CACnB,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,QAAQ,CAAC,eAAe,CAAC;CACtC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,CAAC;IAC9C,OAAO,EAAE,iBAAiB;IAC1B,IAAI,EAAE,MAAM,EAAE;IACd,QAAQ,EAAE,MAAM,EAAE;IAClB,mBAAmB,EAAE,MAAM,EAAE;IAC7B,uBAAuB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC3C,MAAM,EAAE,YAAY;IACpB,YAAY,EAAE,kBAAkB;IAChC,iBAAiB,EAAE,uBAAuB;IAC1C,MAAM,EAAE,iBAAiB;IACzB,SAAS,EAAE,QAAQ,CAAC,sBAAsB,CAAC;CAC5C,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,IAAI,CAAC;IAClD,IAAI,EAAE,IAAI,CAAC;QACT,OAAO,EAAE,MAAM,EAAE;QACjB,SAAS,EAAE,MAAM,EAAE;QACnB,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC;KAC3C,CAAC;CACH,CAAC,CAAC;AAQH;;;GAGG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,IAAI,CAAC;IACxD,IAAI,EAAE,IAAI,CAAC;QACT,aAAa,EAAE,MAAM,EAAE;QACvB,OAAO,EAAE,MAAM,EAAE;QACjB,SAAS,EAAE,MAAM,EAAE;QACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;KAC1C,CAAC;CACH,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,CAAC;IAC3C,IAAI,CAAC;QACH,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC;QACxB,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,IAAI,EAAE,QAAQ,CAAC,+BAA+B,CAAC;KAChD,CAAC;IACF,IAAI,CAAC;QACH,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC;QACvB,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,IAAI,EAAE,+BAA+B;KACtC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,CAAC;IACjD,IAAI,CAAC;QACH,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC;QACxB,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,IAAI,EAAE,QAAQ,CAAC,qCAAqC,CAAC;KACtD,CAAC;IACF,IAAI,CAAC;QACH,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC;QACvB,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,IAAI,EAAE,qCAAqC;KAC5C,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n array,\n boolean,\n literal,\n nullable,\n number,\n optional,\n record,\n string,\n type,\n union,\n} from '@metamask/superstruct';\nimport { CaipChainIdStruct, StrictHexStruct } from '@metamask/utils';\n\nconst AssetSchema = type({\n assetId: string(),\n imageUrl: string(),\n name: string(),\n symbol: string(),\n decimals: number(),\n coingeckoCoinId: optional(string()),\n});\n\nconst AssetsSchema = type({\n listUrl: optional(string()),\n native: AssetSchema,\n governance: optional(AssetSchema),\n});\n\nconst RpcProviderSchema = type({\n url: string(),\n type: string(),\n networkClientId: string(),\n});\n\nconst RpcProvidersSchema = type({\n default: RpcProviderSchema,\n fallbacks: array(string()),\n});\n\nconst BlockExplorerUrlsSchema = type({\n default: string(),\n fallbacks: array(string()),\n});\n\nconst ChainConfigSchema = type({\n isActive: boolean(),\n isTestnet: boolean(),\n isDefault: boolean(),\n isFeatured: boolean(),\n isDeprecated: boolean(),\n isDeletable: boolean(),\n isAutoEnabled: optional(boolean()),\n priority: number(),\n});\n\nconst NetworkContractsSchema = type({\n multicall3: optional(StrictHexStruct),\n});\n\n/**\n * Schema for a single chain in the CAIP-2 config registry API response.\n * chainId is in CAIP-2 format (e.g. \"eip155:1\", \"solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp\").\n */\nexport const RegistryNetworkConfigSchema = type({\n chainId: CaipChainIdStruct,\n name: string(),\n imageUrl: string(),\n coingeckoPlatformId: string(),\n geckoTerminalPlatformId: optional(string()),\n assets: AssetsSchema,\n rpcProviders: RpcProvidersSchema,\n blockExplorerUrls: BlockExplorerUrlsSchema,\n config: ChainConfigSchema,\n contracts: optional(NetworkContractsSchema),\n});\n\n/**\n * Top-level API response shape. Uses `data.chains` (CAIP-2) and `data.version`.\n */\nexport const RegistryConfigApiResponseSchema = type({\n data: type({\n version: string(),\n timestamp: number(),\n chains: array(RegistryNetworkConfigSchema),\n }),\n});\n\nexport type RegistryNetworkConfig = Infer<typeof RegistryNetworkConfigSchema>;\n\nexport type RegistryConfigApiResponse = Infer<\n typeof RegistryConfigApiResponseSchema\n>;\n\n/**\n * Schema for the events-config API response.\n * Maps event names to their allowed analytics purposes.\n */\nexport const RegistryEventsConfigApiResponseSchema = type({\n data: type({\n schemaVersion: string(),\n version: string(),\n timestamp: number(),\n events: record(string(), array(string())),\n }),\n});\n\nexport type RegistryEventsConfigApiResponse = Infer<\n typeof RegistryEventsConfigApiResponseSchema\n>;\n\nexport type RegistryEventsConfig = RegistryEventsConfigApiResponse['data'];\n\nexport const FetchConfigResultStruct = union([\n type({\n modified: literal(false),\n etag: nullable(string()),\n data: nullable(RegistryConfigApiResponseSchema),\n }),\n type({\n modified: literal(true),\n etag: nullable(string()),\n data: RegistryConfigApiResponseSchema,\n }),\n]);\n\nexport const FetchEventsConfigResultStruct = union([\n type({\n modified: literal(false),\n etag: nullable(string()),\n data: nullable(RegistryEventsConfigApiResponseSchema),\n }),\n type({\n modified: literal(true),\n etag: nullable(string()),\n data: RegistryEventsConfigApiResponseSchema,\n }),\n]);\n\nexport type FetchConfigOptions = {\n etag?: string;\n};\n\ntype FetchResult<Data> =\n | {\n modified: false;\n etag: string | null;\n /**\n * Cached data from the service when available (e.g. after a previous\n * successful fetch). `null` when the service has no cache yet.\n */\n data: Data | null;\n }\n | {\n modified: true;\n etag: string | null;\n data: Data;\n };\n\nexport type FetchConfigResult = FetchResult<RegistryConfigApiResponse>;\n\nexport type FetchEventsConfigResult =\n FetchResult<RegistryEventsConfigApiResponse>;\n"]}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ export type { ConfigRegistryControllerStartPollingAction, ConfigRegistryControll
|
|
|
3
3
|
export { ConfigRegistryController, DEFAULT_POLLING_INTERVAL, } from './ConfigRegistryController.js';
|
|
4
4
|
export { selectFeaturedNetworks, selectNetworks, selectEvmAutoEnabledNetworksChainIds, } from './selectors.js';
|
|
5
5
|
export type { FetchConfigOptions, FetchConfigResult, FetchEventsConfigResult, RegistryNetworkConfig, RegistryConfigApiResponse, RegistryEventsConfig, RegistryEventsConfigApiResponse, } from './config-registry-api-service/types.js';
|
|
6
|
-
export type { ConfigRegistryApiServiceOptions, ConfigRegistryApiServiceActions, ConfigRegistryApiServiceEvents, ConfigRegistryApiServiceMessenger, } from './config-registry-api-service/config-registry-api-service.js';
|
|
6
|
+
export type { ConfigRegistryApiServiceOptions, ConfigRegistryApiServiceActions, ConfigRegistryApiServiceEvents, ConfigRegistryApiServiceInvalidateQueriesAction, ConfigRegistryApiServiceCacheUpdatedEvent, ConfigRegistryApiServiceGranularCacheUpdatedEvent, ConfigRegistryApiServiceMessenger, } from './config-registry-api-service/config-registry-api-service.js';
|
|
7
7
|
export type { ConfigRegistryApiServiceFetchConfigAction, ConfigRegistryApiServiceFetchEventsConfigAction, ConfigRegistryApiServiceMethodActions, } from './config-registry-api-service/config-registry-api-service-method-action-types.js';
|
|
8
8
|
export type { NetworkFilterOptions } from './config-registry-api-service/filters.js';
|
|
9
9
|
export { ConfigRegistryApiService, ConfigRegistryApiEnv, } from './config-registry-api-service/config-registry-api-service.js';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,+BAA+B,EAC/B,+BAA+B,EAC/B,sCAAsC,EACtC,yCAAyC,EACzC,8BAA8B,EAC9B,iCAAiC,GAClC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACV,0CAA0C,EAC1C,yCAAyC,EACzC,4DAA4D,GAC7D,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,oCAAoC,GACrC,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,oBAAoB,EACpB,+BAA+B,GAChC,MAAM,wCAAwC,CAAC;AAChD,YAAY,EACV,+BAA+B,EAC/B,+BAA+B,EAC/B,8BAA8B,EAC9B,iCAAiC,GAClC,MAAM,8DAA8D,CAAC;AACtE,YAAY,EACV,yCAAyC,EACzC,+CAA+C,EAC/C,qCAAqC,GACtC,MAAM,kFAAkF,CAAC;AAC1F,YAAY,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,EACL,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,8DAA8D,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,6BAA6B,EAC7B,+BAA+B,EAC/B,+BAA+B,EAC/B,sCAAsC,EACtC,yCAAyC,EACzC,8BAA8B,EAC9B,iCAAiC,GAClC,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACV,0CAA0C,EAC1C,yCAAyC,EACzC,4DAA4D,GAC7D,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,oCAAoC,GACrC,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,oBAAoB,EACpB,+BAA+B,GAChC,MAAM,wCAAwC,CAAC;AAChD,YAAY,EACV,+BAA+B,EAC/B,+BAA+B,EAC/B,8BAA8B,EAC9B,+CAA+C,EAC/C,yCAAyC,EACzC,iDAAiD,EACjD,iCAAiC,GAClC,MAAM,8DAA8D,CAAC;AACtE,YAAY,EACV,yCAAyC,EACzC,+CAA+C,EAC/C,qCAAqC,GACtC,MAAM,kFAAkF,CAAC;AAC1F,YAAY,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,EACL,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,8DAA8D,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,oCAAoC,GACrC,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,oCAAoC,GACrC,MAAM,gBAAgB,CAAC;AAyBxB,OAAO,EACL,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,8DAA8D,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC","sourcesContent":["export type {\n ConfigRegistryControllerState,\n ConfigRegistryControllerOptions,\n ConfigRegistryControllerActions,\n ConfigRegistryControllerGetStateAction,\n ConfigRegistryControllerStateChangedEvent,\n ConfigRegistryControllerEvents,\n ConfigRegistryControllerMessenger,\n} from './ConfigRegistryController.js';\nexport type {\n ConfigRegistryControllerStartPollingAction,\n ConfigRegistryControllerStopPollingAction,\n ConfigRegistryControllerGetNetworkConfigByCaip2ChainIdAction,\n} from './ConfigRegistryController-method-action-types.js';\nexport {\n ConfigRegistryController,\n DEFAULT_POLLING_INTERVAL,\n} from './ConfigRegistryController.js';\nexport {\n selectFeaturedNetworks,\n selectNetworks,\n selectEvmAutoEnabledNetworksChainIds,\n} from './selectors.js';\nexport type {\n FetchConfigOptions,\n FetchConfigResult,\n FetchEventsConfigResult,\n RegistryNetworkConfig,\n RegistryConfigApiResponse,\n RegistryEventsConfig,\n RegistryEventsConfigApiResponse,\n} from './config-registry-api-service/types.js';\nexport type {\n ConfigRegistryApiServiceOptions,\n ConfigRegistryApiServiceActions,\n ConfigRegistryApiServiceEvents,\n ConfigRegistryApiServiceInvalidateQueriesAction,\n ConfigRegistryApiServiceCacheUpdatedEvent,\n ConfigRegistryApiServiceGranularCacheUpdatedEvent,\n ConfigRegistryApiServiceMessenger,\n} from './config-registry-api-service/config-registry-api-service.js';\nexport type {\n ConfigRegistryApiServiceFetchConfigAction,\n ConfigRegistryApiServiceFetchEventsConfigAction,\n ConfigRegistryApiServiceMethodActions,\n} from './config-registry-api-service/config-registry-api-service-method-action-types.js';\nexport type { NetworkFilterOptions } from './config-registry-api-service/filters.js';\nexport {\n ConfigRegistryApiService,\n ConfigRegistryApiEnv,\n} from './config-registry-api-service/config-registry-api-service.js';\nexport { filterNetworks } from './config-registry-api-service/filters.js';\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask-previews/config-registry-controller",
|
|
3
|
-
"version": "5.0.0-preview-
|
|
3
|
+
"version": "5.0.0-preview-e53b41ba2",
|
|
4
4
|
"description": "Manages configuration registry for MetaMask",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Ethereum",
|
|
@@ -38,44 +38,44 @@
|
|
|
38
38
|
"build:docs": "typedoc",
|
|
39
39
|
"build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
|
|
40
40
|
"changelog:update": "../../scripts/update-changelog.sh @metamask/config-registry-controller",
|
|
41
|
-
"changelog:validate": "../../scripts/validate-changelog.sh
|
|
42
|
-
"lint:tsconfigs": "node --import ../../scripts/resolver/register.ts
|
|
43
|
-
"lint:tsconfigs:fix": "node --import ../../scripts/resolver/register.ts
|
|
44
|
-
"messenger-action-types:check": "node --import ../../scripts/resolver/register.ts
|
|
45
|
-
"messenger-action-types:generate": "node --import ../../scripts/resolver/register.ts
|
|
41
|
+
"changelog:validate": "../../scripts/validate-changelog.sh",
|
|
42
|
+
"lint:tsconfigs": "node --import ../../scripts/resolver/register.ts ../../scripts/lint-tsconfigs/lint-tsconfigs.ts",
|
|
43
|
+
"lint:tsconfigs:fix": "node --import ../../scripts/resolver/register.ts ../../scripts/lint-tsconfigs/lint-tsconfigs.ts --fix",
|
|
44
|
+
"messenger-action-types:check": "node --import ../../scripts/resolver/register.ts ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --check",
|
|
45
|
+
"messenger-action-types:generate": "node --import ../../scripts/resolver/register.ts ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --generate",
|
|
46
46
|
"publish:preview": "yarn npm publish --tag preview",
|
|
47
47
|
"since-latest-release": "../../scripts/since-latest-release.sh",
|
|
48
|
-
"test": "
|
|
49
|
-
"test:clean": "
|
|
50
|
-
"test:
|
|
51
|
-
"test:
|
|
48
|
+
"test": "vitest",
|
|
49
|
+
"test:clean": "vitest --clearCache",
|
|
50
|
+
"test:coverage": "vitest --coverage",
|
|
51
|
+
"test:verbose": "vitest --reporter=verbose",
|
|
52
|
+
"test:watch": "vitest --watch"
|
|
52
53
|
},
|
|
53
54
|
"dependencies": {
|
|
54
55
|
"@metamask/base-controller": "^10.1.0",
|
|
56
|
+
"@metamask/base-data-service": "^2.1.0",
|
|
55
57
|
"@metamask/controller-utils": "^13.0.0",
|
|
56
58
|
"@metamask/keyring-controller": "^28.2.0",
|
|
57
59
|
"@metamask/messenger": "^3.0.0",
|
|
58
60
|
"@metamask/polling-controller": "^17.0.0",
|
|
59
61
|
"@metamask/remote-feature-flag-controller": "^7.0.0",
|
|
60
62
|
"@metamask/superstruct": "^3.4.1",
|
|
61
|
-
"@metamask/utils": "^12.0.
|
|
63
|
+
"@metamask/utils": "^12.0.1",
|
|
64
|
+
"@tanstack/query-core": "^5.103.2",
|
|
62
65
|
"reselect": "^5.3.0"
|
|
63
66
|
},
|
|
64
67
|
"devDependencies": {
|
|
65
68
|
"@lavamoat/allow-scripts": "^5.1.0",
|
|
66
|
-
"@metamask/auto-changelog": "^
|
|
67
|
-
"@types/jest": "^30.0.0",
|
|
69
|
+
"@metamask/auto-changelog": "^7.1.0",
|
|
68
70
|
"@typescript/native": "npm:typescript@^7.0.2",
|
|
69
|
-
"
|
|
70
|
-
"jest": "^30.5.2",
|
|
71
|
-
"nock": "^13.5.6",
|
|
71
|
+
"nock": "^15.0.5",
|
|
72
72
|
"rimraf": "^6.1.3",
|
|
73
|
-
"ts-jest": "^29.4.14",
|
|
74
73
|
"typedoc": "^0.28.20",
|
|
75
74
|
"typedoc-plugin-missing-exports": "^4.1.4",
|
|
76
|
-
"typescript": "npm:@typescript/typescript6@^6.0.2"
|
|
75
|
+
"typescript": "npm:@typescript/typescript6@^6.0.2",
|
|
76
|
+
"vitest": "5.0.3"
|
|
77
77
|
},
|
|
78
78
|
"engines": {
|
|
79
|
-
"node": "^22.14.0 || ^24"
|
|
79
|
+
"node": "^22.14.0 || ^24 || ^26"
|
|
80
80
|
}
|
|
81
81
|
}
|