@metamask-previews/config-registry-controller 0.0.0-preview-32ed9958c → 0.0.0-preview-42e3e713e
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/LICENSE +1 -1
- package/dist/ConfigRegistryController.cjs +48 -19
- package/dist/ConfigRegistryController.cjs.map +1 -1
- package/dist/ConfigRegistryController.d.cts +11 -15
- package/dist/ConfigRegistryController.d.cts.map +1 -1
- package/dist/ConfigRegistryController.d.mts +11 -15
- package/dist/ConfigRegistryController.d.mts.map +1 -1
- package/dist/ConfigRegistryController.mjs +49 -20
- package/dist/ConfigRegistryController.mjs.map +1 -1
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.cjs +3 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.cjs.map +1 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.cts +16 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.cts.map +1 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.mts +16 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.mts.map +1 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.mjs +2 -0
- package/dist/config-registry-api-service/config-registry-api-service-method-action-types.mjs.map +1 -0
- package/dist/config-registry-api-service/config-registry-api-service.cjs +31 -5
- package/dist/config-registry-api-service/config-registry-api-service.cjs.map +1 -1
- package/dist/config-registry-api-service/config-registry-api-service.d.cts +49 -1
- package/dist/config-registry-api-service/config-registry-api-service.d.cts.map +1 -1
- package/dist/config-registry-api-service/config-registry-api-service.d.mts +49 -1
- package/dist/config-registry-api-service/config-registry-api-service.d.mts.map +1 -1
- package/dist/config-registry-api-service/config-registry-api-service.mjs +31 -5
- package/dist/config-registry-api-service/config-registry-api-service.mjs.map +1 -1
- package/dist/config-registry-api-service/filters.cjs.map +1 -1
- package/dist/config-registry-api-service/filters.mjs.map +1 -1
- package/dist/config-registry-api-service/types.d.cts +59 -59
- package/dist/config-registry-api-service/types.d.mts +59 -59
- package/dist/index.cjs +3 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -3
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +7 -3
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +2 -1
- package/dist/index.mjs.map +1 -1
- package/dist/selectors.cjs +2 -2
- package/dist/selectors.cjs.map +1 -1
- package/dist/selectors.d.cts +43 -43
- package/dist/selectors.d.cts.map +1 -1
- package/dist/selectors.d.mts +43 -43
- package/dist/selectors.d.mts.map +1 -1
- package/dist/selectors.mjs +1 -1
- package/dist/selectors.mjs.map +1 -1
- package/dist/utils/feature-flags.cjs +9 -14
- package/dist/utils/feature-flags.cjs.map +1 -1
- package/dist/utils/feature-flags.d.cts +5 -4
- package/dist/utils/feature-flags.d.cts.map +1 -1
- package/dist/utils/feature-flags.d.mts +5 -4
- package/dist/utils/feature-flags.d.mts.map +1 -1
- package/dist/utils/feature-flags.mjs +9 -14
- package/dist/utils/feature-flags.mjs.map +1 -1
- package/package.json +3 -2
- package/dist/config-registry-api-service/index.cjs +0 -8
- package/dist/config-registry-api-service/index.cjs.map +0 -1
- package/dist/config-registry-api-service/index.d.cts +0 -6
- package/dist/config-registry-api-service/index.d.cts.map +0 -1
- package/dist/config-registry-api-service/index.d.mts +0 -6
- package/dist/config-registry-api-service/index.d.mts.map +0 -1
- package/dist/config-registry-api-service/index.mjs +0 -3
- package/dist/config-registry-api-service/index.mjs.map +0 -1
package/LICENSE
CHANGED
|
@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
10
10
|
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
11
11
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
12
12
|
};
|
|
13
|
-
var
|
|
13
|
+
var _ConfigRegistryController_keyringLocked;
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
15
|
exports.ConfigRegistryController = exports.DEFAULT_POLLING_INTERVAL = void 0;
|
|
16
16
|
const polling_controller_1 = require("@metamask/polling-controller");
|
|
@@ -52,14 +52,14 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
52
52
|
/**
|
|
53
53
|
* @param options - The controller options.
|
|
54
54
|
* @param options.messenger - The controller messenger. Must have
|
|
55
|
-
*
|
|
55
|
+
* `ConfigRegistryApiService:fetchConfig` action handler registered
|
|
56
|
+
* (e.g. by instantiating {@link ConfigRegistryApiService} with the same
|
|
57
|
+
* messenger).
|
|
56
58
|
* @param options.state - Initial state.
|
|
57
59
|
* @param options.pollingInterval - Polling interval in milliseconds.
|
|
58
60
|
* @param options.fallbackConfig - Fallback configuration.
|
|
59
|
-
* @param options.isConfigRegistryApiEnabled - Function to check if the config
|
|
60
|
-
* registry API is enabled. Defaults to checking the remote feature flag.
|
|
61
61
|
*/
|
|
62
|
-
constructor({ messenger, state = {}, pollingInterval = exports.DEFAULT_POLLING_INTERVAL, fallbackConfig = DEFAULT_FALLBACK_CONFIG,
|
|
62
|
+
constructor({ messenger, state = {}, pollingInterval = exports.DEFAULT_POLLING_INTERVAL, fallbackConfig = DEFAULT_FALLBACK_CONFIG, }) {
|
|
63
63
|
super({
|
|
64
64
|
name: controllerName,
|
|
65
65
|
metadata: stateMetadata,
|
|
@@ -73,25 +73,56 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
73
73
|
etag: state.etag ?? null,
|
|
74
74
|
},
|
|
75
75
|
});
|
|
76
|
-
|
|
76
|
+
_ConfigRegistryController_keyringLocked.set(this, true);
|
|
77
77
|
this.setIntervalLength(pollingInterval);
|
|
78
|
-
__classPrivateFieldSet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, isConfigRegistryApiEnabled, "f");
|
|
79
78
|
this.messenger.registerActionHandler(`${controllerName}:startPolling`, this.startPolling.bind(this));
|
|
80
79
|
this.messenger.registerActionHandler(`${controllerName}:stopPolling`, this.stopAllPolling.bind(this));
|
|
81
|
-
this.messenger.subscribe('KeyringController:unlock', () =>
|
|
82
|
-
|
|
80
|
+
this.messenger.subscribe('KeyringController:unlock', () => {
|
|
81
|
+
__classPrivateFieldSet(this, _ConfigRegistryController_keyringLocked, false, "f");
|
|
82
|
+
try {
|
|
83
|
+
if ((0, feature_flags_1.isConfigRegistryApiEnabled)(this.messenger.call('RemoteFeatureFlagController:getState'))) {
|
|
84
|
+
this.startPolling(null);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
catch {
|
|
88
|
+
// RemoteFeatureFlagController unavailable; do not start polling.
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
this.messenger.subscribe('KeyringController:lock', () => {
|
|
92
|
+
__classPrivateFieldSet(this, _ConfigRegistryController_keyringLocked, true, "f");
|
|
93
|
+
this.stopAllPolling();
|
|
94
|
+
});
|
|
95
|
+
this.messenger.subscribe('RemoteFeatureFlagController:stateChange', () => {
|
|
96
|
+
let enabled = false;
|
|
97
|
+
try {
|
|
98
|
+
enabled = (0, feature_flags_1.isConfigRegistryApiEnabled)(this.messenger.call('RemoteFeatureFlagController:getState'));
|
|
99
|
+
}
|
|
100
|
+
catch {
|
|
101
|
+
// RemoteFeatureFlagController unavailable; treat as disabled.
|
|
102
|
+
}
|
|
103
|
+
if (enabled) {
|
|
104
|
+
if (!__classPrivateFieldGet(this, _ConfigRegistryController_keyringLocked, "f")) {
|
|
105
|
+
this.stopAllPolling();
|
|
106
|
+
this.startPolling(null);
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
else {
|
|
110
|
+
this.stopAllPolling();
|
|
111
|
+
}
|
|
112
|
+
});
|
|
83
113
|
}
|
|
84
114
|
async _executePoll(_input) {
|
|
85
|
-
|
|
115
|
+
let isApiEnabled = false;
|
|
116
|
+
try {
|
|
117
|
+
isApiEnabled = (0, feature_flags_1.isConfigRegistryApiEnabled)(this.messenger.call('RemoteFeatureFlagController:getState'));
|
|
118
|
+
}
|
|
119
|
+
catch {
|
|
120
|
+
// RemoteFeatureFlagController unavailable; skip fetch.
|
|
121
|
+
}
|
|
86
122
|
// Skip fetch when API is disabled; client uses static config.
|
|
87
123
|
if (!isApiEnabled) {
|
|
88
124
|
return;
|
|
89
125
|
}
|
|
90
|
-
const interval = this.getIntervalLength() ?? exports.DEFAULT_POLLING_INTERVAL;
|
|
91
|
-
if (this.state.lastFetched !== null &&
|
|
92
|
-
Date.now() - this.state.lastFetched < interval) {
|
|
93
|
-
return;
|
|
94
|
-
}
|
|
95
126
|
try {
|
|
96
127
|
const result = await this.messenger.call('ConfigRegistryApiService:fetchConfig', {
|
|
97
128
|
etag: this.state.etag ?? undefined,
|
|
@@ -116,9 +147,7 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
116
147
|
state.configs.networks = newConfigs;
|
|
117
148
|
state.version = result.data.data.version;
|
|
118
149
|
state.lastFetched = Date.now();
|
|
119
|
-
|
|
120
|
-
state.etag = result.etag;
|
|
121
|
-
}
|
|
150
|
+
state.etag = result.etag ?? null;
|
|
122
151
|
});
|
|
123
152
|
}
|
|
124
153
|
catch (error) {
|
|
@@ -128,5 +157,5 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
128
157
|
}
|
|
129
158
|
}
|
|
130
159
|
exports.ConfigRegistryController = ConfigRegistryController;
|
|
131
|
-
|
|
160
|
+
_ConfigRegistryController_keyringLocked = new WeakMap();
|
|
132
161
|
//# sourceMappingURL=ConfigRegistryController.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConfigRegistryController.cjs","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAUA,qEAA+E;AAE/E,2CAA2D;AAO3D,6DAAwG;AAExG,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAErC,QAAA,wBAAwB,GAAG,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,GAAG,CAAC,CAAC;AAwCxE,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;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAwF1E,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IAKC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,eAAe,GAAG,gCAAwB,EAC1C,cAAc,GAAG,uBAAuB,EACxC,0BAA0B,GAAG,0CAAiC,GAC9B;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;iBAC3D;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;aACzB;SACF,CAAC,CAAC;QAjCI,uEAEI;QAiCX,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACxC,uBAAA,IAAI,wDAA+B,0BAA0B,MAAA,CAAC;QAE9D,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,eAAe,EAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,cAAc,EAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE,CACxD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,MAAM,YAAY,GAAG,uBAAA,IAAI,4DAA4B,MAAhC,IAAI,EAA6B,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,IAAI,gCAAwB,CAAC;QACtE,IACE,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI;YAC/B,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,QAAQ,EAC9C,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAsB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACzD,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,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;gBAC3B,CAAC;YACH,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;CACF;AAvHD,4DAuHC","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangeEvent,\n StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n KeyringControllerLockEvent,\n KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n FetchConfigOptions,\n FetchConfigResult,\n RegistryNetworkConfig,\n} from './config-registry-api-service';\nimport { isConfigRegistryApiEnabled as defaultIsConfigRegistryApiEnabled } from './utils/feature-flags';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\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 * Network configurations organized by chain ID.\n * Stores the full API response including isFeatured, isTestnet, etc.\n * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.\n */\n configs: {\n networks: Record<string, RegistryNetworkConfig>;\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\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} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangeEvent =\n ControllerStateChangeEvent<\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 * Starts polling the config registry API. Returns a polling token that can be\n * used to stop this polling session.\n */\nexport type ConfigRegistryControllerStartPollingAction = {\n type: `${typeof controllerName}:startPolling`;\n handler: (input: null) => string;\n};\n\n/**\n * Stops all config registry polling.\n */\nexport type ConfigRegistryControllerStopPollingAction = {\n type: `${typeof controllerName}:stopPolling`;\n handler: () => void;\n};\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerStartPollingAction\n | ConfigRegistryControllerStopPollingAction;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n | RemoteFeatureFlagControllerGetStateAction\n | {\n type: 'ConfigRegistryApiService:fetchConfig';\n handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;\n };\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n ConfigRegistryControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ConfigRegistryControllerMessenger}\n * subscribes to.\n */\ntype AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;\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\n/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */\nexport type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;\n\nexport type ConfigRegistryControllerOptions = {\n messenger: ConfigRegistryMessenger;\n state?: Partial<ConfigRegistryControllerState>;\n pollingInterval?: number;\n fallbackConfig?: Record<string, RegistryNetworkConfig>;\n isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;\n};\n\nexport class ConfigRegistryController extends StaticIntervalPollingController<null>()<\n typeof controllerName,\n ConfigRegistryControllerState,\n ConfigRegistryMessenger\n> {\n readonly #isConfigRegistryApiEnabled: (\n messenger: ConfigRegistryMessenger,\n ) => boolean;\n\n /**\n * @param options - The controller options.\n * @param options.messenger - The controller messenger. Must have\n * `ConfigRegistryApiService:fetchConfig` action handler registered.\n * @param options.state - Initial state.\n * @param options.pollingInterval - Polling interval in milliseconds.\n * @param options.fallbackConfig - Fallback configuration.\n * @param options.isConfigRegistryApiEnabled - Function to check if the config\n * registry API is enabled. Defaults to checking the remote feature flag.\n */\n constructor({\n messenger,\n state = {},\n pollingInterval = DEFAULT_POLLING_INTERVAL,\n fallbackConfig = DEFAULT_FALLBACK_CONFIG,\n isConfigRegistryApiEnabled = defaultIsConfigRegistryApiEnabled,\n }: ConfigRegistryControllerOptions) {\n super({\n name: controllerName,\n metadata: stateMetadata,\n messenger,\n state: {\n configs: {\n networks: state.configs?.networks ?? { ...fallbackConfig },\n },\n version: state.version ?? null,\n lastFetched: state.lastFetched ?? null,\n etag: state.etag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n this.#isConfigRegistryApiEnabled = isConfigRegistryApiEnabled;\n\n this.messenger.registerActionHandler(\n `${controllerName}:startPolling`,\n this.startPolling.bind(this),\n );\n\n this.messenger.registerActionHandler(\n `${controllerName}:stopPolling`,\n this.stopAllPolling.bind(this),\n );\n\n this.messenger.subscribe('KeyringController:unlock', () =>\n this.startPolling(null),\n );\n\n this.messenger.subscribe('KeyringController:lock', () =>\n this.stopAllPolling(),\n );\n }\n\n async _executePoll(_input: null): Promise<void> {\n const isApiEnabled = this.#isConfigRegistryApiEnabled(this.messenger);\n\n // Skip fetch when API is disabled; client uses static config.\n if (!isApiEnabled) {\n return;\n }\n\n const interval = this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;\n if (\n this.state.lastFetched !== null &&\n Date.now() - this.state.lastFetched < interval\n ) {\n return;\n }\n\n try {\n const result: FetchConfigResult = 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 if (result.etag !== undefined) {\n state.etag = result.etag;\n }\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"]}
|
|
1
|
+
{"version":3,"file":"ConfigRegistryController.cjs","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAUA,qEAA+E;AAG/E,2CAA2D;AAI3D,6DAAmE;AAEnE,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAErC,QAAA,wBAAwB,GAAG,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,GAAG,CAAC,CAAC;AAwCxE,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;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAoF1E,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IAGC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,eAAe,GAAG,gCAAwB,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;iBAC3D;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;aACzB;SACF,CAAC,CAAC;QA9BL,kDAAiB,IAAI,EAAC;QAgCpB,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,eAAe,EAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,cAAc,EAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,uBAAA,IAAI,2CAAkB,KAAK,MAAA,CAAC;YAC5B,IAAI,CAAC;gBACH,IACE,IAAA,0CAA0B,EACxB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAC5D,EACD,CAAC;oBACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,iEAAiE;YACnE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtD,uBAAA,IAAI,2CAAkB,IAAI,MAAA,CAAC;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACvE,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC;gBACH,OAAO,GAAG,IAAA,0CAA0B,EAClC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAC5D,CAAC;YACJ,CAAC;YAAC,MAAM,CAAC;gBACP,8DAA8D;YAChE,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC,uBAAA,IAAI,+CAAe,EAAE,CAAC;oBACzB,IAAI,CAAC,cAAc,EAAE,CAAC;oBACtB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC;YACH,YAAY,GAAG,IAAA,0CAA0B,EACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAC5D,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,uDAAuD;QACzD,CAAC;QAED,8DAA8D;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,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;CACF;AA/ID,4DA+IC","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangeEvent,\n StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n KeyringControllerLockEvent,\n KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport type { RemoteFeatureFlagControllerStateChangeEvent } from '@metamask/remote-feature-flag-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type { ConfigRegistryApiServiceFetchConfigAction } from './config-registry-api-service/config-registry-api-service-method-action-types';\nimport type { RegistryNetworkConfig } from './config-registry-api-service/types';\nimport { isConfigRegistryApiEnabled } from './utils/feature-flags';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\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 * Network configurations organized by chain ID.\n * Stores the full API response including isFeatured, isTestnet, etc.\n * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.\n */\n configs: {\n networks: Record<string, RegistryNetworkConfig>;\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\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} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangeEvent =\n ControllerStateChangeEvent<\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 * Starts polling the config registry API. Returns a polling token that can be\n * used to stop this polling session.\n */\nexport type ConfigRegistryControllerStartPollingAction = {\n type: `${typeof controllerName}:startPolling`;\n handler: (input: null) => string;\n};\n\n/**\n * Stops all config registry polling.\n */\nexport type ConfigRegistryControllerStopPollingAction = {\n type: `${typeof controllerName}:stopPolling`;\n handler: () => void;\n};\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerStartPollingAction\n | ConfigRegistryControllerStopPollingAction;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n | RemoteFeatureFlagControllerGetStateAction\n | ConfigRegistryApiServiceFetchConfigAction;\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n ConfigRegistryControllerStateChangeEvent;\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 #keyringLocked = true;\n\n /**\n * @param options - The controller options.\n * @param options.messenger - The controller messenger. Must have\n * `ConfigRegistryApiService:fetchConfig` action handler 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 },\n version: state.version ?? null,\n lastFetched: state.lastFetched ?? null,\n etag: state.etag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n\n this.messenger.registerActionHandler(\n `${controllerName}:startPolling`,\n this.startPolling.bind(this),\n );\n\n this.messenger.registerActionHandler(\n `${controllerName}:stopPolling`,\n this.stopAllPolling.bind(this),\n );\n\n this.messenger.subscribe('KeyringController:unlock', () => {\n this.#keyringLocked = false;\n try {\n if (\n isConfigRegistryApiEnabled(\n this.messenger.call('RemoteFeatureFlagController:getState'),\n )\n ) {\n this.startPolling(null);\n }\n } catch {\n // RemoteFeatureFlagController unavailable; do not start polling.\n }\n });\n\n this.messenger.subscribe('KeyringController:lock', () => {\n this.#keyringLocked = true;\n this.stopAllPolling();\n });\n\n this.messenger.subscribe('RemoteFeatureFlagController:stateChange', () => {\n let enabled = false;\n try {\n enabled = isConfigRegistryApiEnabled(\n this.messenger.call('RemoteFeatureFlagController:getState'),\n );\n } catch {\n // RemoteFeatureFlagController unavailable; treat as disabled.\n }\n if (enabled) {\n if (!this.#keyringLocked) {\n this.stopAllPolling();\n this.startPolling(null);\n }\n } else {\n this.stopAllPolling();\n }\n });\n }\n\n async _executePoll(_input: null): Promise<void> {\n let isApiEnabled = false;\n try {\n isApiEnabled = isConfigRegistryApiEnabled(\n this.messenger.call('RemoteFeatureFlagController:getState'),\n );\n } catch {\n // RemoteFeatureFlagController unavailable; skip fetch.\n }\n\n // Skip fetch when API is disabled; client uses static config.\n if (!isApiEnabled) {\n return;\n }\n\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"]}
|
|
@@ -2,7 +2,9 @@ import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@meta
|
|
|
2
2
|
import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
|
|
3
3
|
import type { Messenger } from "@metamask/messenger";
|
|
4
4
|
import { RemoteFeatureFlagControllerGetStateAction } from "@metamask/remote-feature-flag-controller";
|
|
5
|
-
import type {
|
|
5
|
+
import type { RemoteFeatureFlagControllerStateChangeEvent } from "@metamask/remote-feature-flag-controller";
|
|
6
|
+
import type { ConfigRegistryApiServiceFetchConfigAction } from "./config-registry-api-service/config-registry-api-service-method-action-types.cjs";
|
|
7
|
+
import type { RegistryNetworkConfig } from "./config-registry-api-service/types.cjs";
|
|
6
8
|
declare const controllerName = "ConfigRegistryController";
|
|
7
9
|
export declare const DEFAULT_POLLING_INTERVAL: number;
|
|
8
10
|
/**
|
|
@@ -73,10 +75,7 @@ export type ConfigRegistryControllerActions = ConfigRegistryControllerGetStateAc
|
|
|
73
75
|
* Actions from other messengers that {@link ConfigRegistryControllerMessenger}
|
|
74
76
|
* calls.
|
|
75
77
|
*/
|
|
76
|
-
type AllowedActions = RemoteFeatureFlagControllerGetStateAction |
|
|
77
|
-
type: 'ConfigRegistryApiService:fetchConfig';
|
|
78
|
-
handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;
|
|
79
|
-
};
|
|
78
|
+
type AllowedActions = RemoteFeatureFlagControllerGetStateAction | ConfigRegistryApiServiceFetchConfigAction;
|
|
80
79
|
/**
|
|
81
80
|
* Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
|
|
82
81
|
*/
|
|
@@ -85,20 +84,17 @@ export type ConfigRegistryControllerEvents = ConfigRegistryControllerStateChange
|
|
|
85
84
|
* Events from other messengers that {@link ConfigRegistryControllerMessenger}
|
|
86
85
|
* subscribes to.
|
|
87
86
|
*/
|
|
88
|
-
type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;
|
|
87
|
+
type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent | RemoteFeatureFlagControllerStateChangeEvent;
|
|
89
88
|
/**
|
|
90
89
|
* The messenger restricted to actions and events accessed by
|
|
91
90
|
* {@link ConfigRegistryController}.
|
|
92
91
|
*/
|
|
93
92
|
export type ConfigRegistryControllerMessenger = Messenger<typeof controllerName, ConfigRegistryControllerActions | AllowedActions, ConfigRegistryControllerEvents | AllowedEvents>;
|
|
94
|
-
/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */
|
|
95
|
-
export type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;
|
|
96
93
|
export type ConfigRegistryControllerOptions = {
|
|
97
|
-
messenger:
|
|
94
|
+
messenger: ConfigRegistryControllerMessenger;
|
|
98
95
|
state?: Partial<ConfigRegistryControllerState>;
|
|
99
96
|
pollingInterval?: number;
|
|
100
97
|
fallbackConfig?: Record<string, RegistryNetworkConfig>;
|
|
101
|
-
isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;
|
|
102
98
|
};
|
|
103
99
|
declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
|
|
104
100
|
readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
|
|
@@ -115,19 +111,19 @@ declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
|
|
|
115
111
|
stopPollingByPollingToken(pollingToken: string): void;
|
|
116
112
|
onPollingComplete(input: null, callback: (input: null) => void): void;
|
|
117
113
|
}) & typeof import("@metamask/base-controller").BaseController;
|
|
118
|
-
export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState,
|
|
114
|
+
export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState, ConfigRegistryControllerMessenger> {
|
|
119
115
|
#private;
|
|
120
116
|
/**
|
|
121
117
|
* @param options - The controller options.
|
|
122
118
|
* @param options.messenger - The controller messenger. Must have
|
|
123
|
-
*
|
|
119
|
+
* `ConfigRegistryApiService:fetchConfig` action handler registered
|
|
120
|
+
* (e.g. by instantiating {@link ConfigRegistryApiService} with the same
|
|
121
|
+
* messenger).
|
|
124
122
|
* @param options.state - Initial state.
|
|
125
123
|
* @param options.pollingInterval - Polling interval in milliseconds.
|
|
126
124
|
* @param options.fallbackConfig - Fallback configuration.
|
|
127
|
-
* @param options.isConfigRegistryApiEnabled - Function to check if the config
|
|
128
|
-
* registry API is enabled. Defaults to checking the remote feature flag.
|
|
129
125
|
*/
|
|
130
|
-
constructor({ messenger, state, pollingInterval, fallbackConfig,
|
|
126
|
+
constructor({ messenger, state, pollingInterval, fallbackConfig, }: ConfigRegistryControllerOptions);
|
|
131
127
|
_executePoll(_input: null): Promise<void>;
|
|
132
128
|
}
|
|
133
129
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConfigRegistryController.d.cts","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,yCAAyC,EAAE,iDAAiD;
|
|
1
|
+
{"version":3,"file":"ConfigRegistryController.d.cts","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,yCAAyC,EAAE,iDAAiD;AACrG,OAAO,KAAK,EAAE,2CAA2C,EAAE,iDAAiD;AAG5G,OAAO,KAAK,EAAE,yCAAyC,EAAE,0FAAsF;AAC/I,OAAO,KAAK,EAAE,qBAAqB,EAAE,gDAA4C;AAGjF,QAAA,MAAM,cAAc,6BAA6B,CAAC;AAElD,eAAO,MAAM,wBAAwB,QAAkC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;KACjD,CAAC;IACF;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAkCF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,GAAG,OAAO,cAAc,eAAe,CAAC;IAC9C,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,MAAM,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,0CAA0C,GAC1C,yCAAyC,CAAC;AAE9C;;;GAGG;AACH,KAAK,cAAc,GACf,yCAAyC,GACzC,yCAAyC,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GACd,4BAA4B,GAC5B,0BAA0B,GAC1B,2CAA2C,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,SAAS,EAAE,iCAAiC,CAAC;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CACxD,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;IAGC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,eAA0C,EAC1C,cAAwC,GACzC,EAAE,+BAA+B;IAmE5B,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAsDhD"}
|
|
@@ -2,7 +2,9 @@ import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@meta
|
|
|
2
2
|
import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
|
|
3
3
|
import type { Messenger } from "@metamask/messenger";
|
|
4
4
|
import { RemoteFeatureFlagControllerGetStateAction } from "@metamask/remote-feature-flag-controller";
|
|
5
|
-
import type {
|
|
5
|
+
import type { RemoteFeatureFlagControllerStateChangeEvent } from "@metamask/remote-feature-flag-controller";
|
|
6
|
+
import type { ConfigRegistryApiServiceFetchConfigAction } from "./config-registry-api-service/config-registry-api-service-method-action-types.mjs";
|
|
7
|
+
import type { RegistryNetworkConfig } from "./config-registry-api-service/types.mjs";
|
|
6
8
|
declare const controllerName = "ConfigRegistryController";
|
|
7
9
|
export declare const DEFAULT_POLLING_INTERVAL: number;
|
|
8
10
|
/**
|
|
@@ -73,10 +75,7 @@ export type ConfigRegistryControllerActions = ConfigRegistryControllerGetStateAc
|
|
|
73
75
|
* Actions from other messengers that {@link ConfigRegistryControllerMessenger}
|
|
74
76
|
* calls.
|
|
75
77
|
*/
|
|
76
|
-
type AllowedActions = RemoteFeatureFlagControllerGetStateAction |
|
|
77
|
-
type: 'ConfigRegistryApiService:fetchConfig';
|
|
78
|
-
handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;
|
|
79
|
-
};
|
|
78
|
+
type AllowedActions = RemoteFeatureFlagControllerGetStateAction | ConfigRegistryApiServiceFetchConfigAction;
|
|
80
79
|
/**
|
|
81
80
|
* Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
|
|
82
81
|
*/
|
|
@@ -85,20 +84,17 @@ export type ConfigRegistryControllerEvents = ConfigRegistryControllerStateChange
|
|
|
85
84
|
* Events from other messengers that {@link ConfigRegistryControllerMessenger}
|
|
86
85
|
* subscribes to.
|
|
87
86
|
*/
|
|
88
|
-
type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;
|
|
87
|
+
type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent | RemoteFeatureFlagControllerStateChangeEvent;
|
|
89
88
|
/**
|
|
90
89
|
* The messenger restricted to actions and events accessed by
|
|
91
90
|
* {@link ConfigRegistryController}.
|
|
92
91
|
*/
|
|
93
92
|
export type ConfigRegistryControllerMessenger = Messenger<typeof controllerName, ConfigRegistryControllerActions | AllowedActions, ConfigRegistryControllerEvents | AllowedEvents>;
|
|
94
|
-
/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */
|
|
95
|
-
export type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;
|
|
96
93
|
export type ConfigRegistryControllerOptions = {
|
|
97
|
-
messenger:
|
|
94
|
+
messenger: ConfigRegistryControllerMessenger;
|
|
98
95
|
state?: Partial<ConfigRegistryControllerState>;
|
|
99
96
|
pollingInterval?: number;
|
|
100
97
|
fallbackConfig?: Record<string, RegistryNetworkConfig>;
|
|
101
|
-
isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;
|
|
102
98
|
};
|
|
103
99
|
declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
|
|
104
100
|
readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
|
|
@@ -115,19 +111,19 @@ declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
|
|
|
115
111
|
stopPollingByPollingToken(pollingToken: string): void;
|
|
116
112
|
onPollingComplete(input: null, callback: (input: null) => void): void;
|
|
117
113
|
}) & typeof import("@metamask/base-controller").BaseController;
|
|
118
|
-
export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState,
|
|
114
|
+
export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState, ConfigRegistryControllerMessenger> {
|
|
119
115
|
#private;
|
|
120
116
|
/**
|
|
121
117
|
* @param options - The controller options.
|
|
122
118
|
* @param options.messenger - The controller messenger. Must have
|
|
123
|
-
*
|
|
119
|
+
* `ConfigRegistryApiService:fetchConfig` action handler registered
|
|
120
|
+
* (e.g. by instantiating {@link ConfigRegistryApiService} with the same
|
|
121
|
+
* messenger).
|
|
124
122
|
* @param options.state - Initial state.
|
|
125
123
|
* @param options.pollingInterval - Polling interval in milliseconds.
|
|
126
124
|
* @param options.fallbackConfig - Fallback configuration.
|
|
127
|
-
* @param options.isConfigRegistryApiEnabled - Function to check if the config
|
|
128
|
-
* registry API is enabled. Defaults to checking the remote feature flag.
|
|
129
125
|
*/
|
|
130
|
-
constructor({ messenger, state, pollingInterval, fallbackConfig,
|
|
126
|
+
constructor({ messenger, state, pollingInterval, fallbackConfig, }: ConfigRegistryControllerOptions);
|
|
131
127
|
_executePoll(_input: null): Promise<void>;
|
|
132
128
|
}
|
|
133
129
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConfigRegistryController.d.mts","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,yCAAyC,EAAE,iDAAiD;
|
|
1
|
+
{"version":3,"file":"ConfigRegistryController.d.mts","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,yCAAyC,EAAE,iDAAiD;AACrG,OAAO,KAAK,EAAE,2CAA2C,EAAE,iDAAiD;AAG5G,OAAO,KAAK,EAAE,yCAAyC,EAAE,0FAAsF;AAC/I,OAAO,KAAK,EAAE,qBAAqB,EAAE,gDAA4C;AAGjF,QAAA,MAAM,cAAc,6BAA6B,CAAC;AAElD,eAAO,MAAM,wBAAwB,QAAkC,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;OAIG;IACH,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;KACjD,CAAC;IACF;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;;;;OAOG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAkCF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,0BAA0B,CACxB,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,wBAAwB,CAC3E,OAAO,cAAc,EACrB,6BAA6B,CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,GAAG,OAAO,cAAc,eAAe,CAAC;IAC9C,OAAO,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,MAAM,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,GAAG,OAAO,cAAc,cAAc,CAAC;IAC7C,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,0CAA0C,GAC1C,yCAAyC,CAAC;AAE9C;;;GAGG;AACH,KAAK,cAAc,GACf,yCAAyC,GACzC,yCAAyC,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,wCAAwC,CAAC;AAE3C;;;GAGG;AACH,KAAK,aAAa,GACd,4BAA4B,GAC5B,0BAA0B,GAC1B,2CAA2C,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,cAAc,EACrB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,SAAS,EAAE,iCAAiC,CAAC;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CACxD,CAAC;;;;;;;;;;;;;;;;AAEF,qBAAa,wBAAyB,SAAQ,8BAC5C,OAAO,cAAc,EACrB,6BAA6B,EAC7B,iCAAiC,CAClC;;IAGC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,eAA0C,EAC1C,cAAwC,GACzC,EAAE,+BAA+B;IAmE5B,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAsDhD"}
|
|
@@ -9,10 +9,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
9
9
|
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
10
10
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
11
11
|
};
|
|
12
|
-
var
|
|
12
|
+
var _ConfigRegistryController_keyringLocked;
|
|
13
13
|
import { StaticIntervalPollingController } from "@metamask/polling-controller";
|
|
14
14
|
import { Duration, inMilliseconds } from "@metamask/utils";
|
|
15
|
-
import { isConfigRegistryApiEnabled
|
|
15
|
+
import { isConfigRegistryApiEnabled } from "./utils/feature-flags.mjs";
|
|
16
16
|
const controllerName = 'ConfigRegistryController';
|
|
17
17
|
export const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);
|
|
18
18
|
const stateMetadata = {
|
|
@@ -49,14 +49,14 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
49
49
|
/**
|
|
50
50
|
* @param options - The controller options.
|
|
51
51
|
* @param options.messenger - The controller messenger. Must have
|
|
52
|
-
*
|
|
52
|
+
* `ConfigRegistryApiService:fetchConfig` action handler registered
|
|
53
|
+
* (e.g. by instantiating {@link ConfigRegistryApiService} with the same
|
|
54
|
+
* messenger).
|
|
53
55
|
* @param options.state - Initial state.
|
|
54
56
|
* @param options.pollingInterval - Polling interval in milliseconds.
|
|
55
57
|
* @param options.fallbackConfig - Fallback configuration.
|
|
56
|
-
* @param options.isConfigRegistryApiEnabled - Function to check if the config
|
|
57
|
-
* registry API is enabled. Defaults to checking the remote feature flag.
|
|
58
58
|
*/
|
|
59
|
-
constructor({ messenger, state = {}, pollingInterval = DEFAULT_POLLING_INTERVAL, fallbackConfig = DEFAULT_FALLBACK_CONFIG,
|
|
59
|
+
constructor({ messenger, state = {}, pollingInterval = DEFAULT_POLLING_INTERVAL, fallbackConfig = DEFAULT_FALLBACK_CONFIG, }) {
|
|
60
60
|
super({
|
|
61
61
|
name: controllerName,
|
|
62
62
|
metadata: stateMetadata,
|
|
@@ -70,25 +70,56 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
70
70
|
etag: state.etag ?? null,
|
|
71
71
|
},
|
|
72
72
|
});
|
|
73
|
-
|
|
73
|
+
_ConfigRegistryController_keyringLocked.set(this, true);
|
|
74
74
|
this.setIntervalLength(pollingInterval);
|
|
75
|
-
__classPrivateFieldSet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, isConfigRegistryApiEnabled, "f");
|
|
76
75
|
this.messenger.registerActionHandler(`${controllerName}:startPolling`, this.startPolling.bind(this));
|
|
77
76
|
this.messenger.registerActionHandler(`${controllerName}:stopPolling`, this.stopAllPolling.bind(this));
|
|
78
|
-
this.messenger.subscribe('KeyringController:unlock', () =>
|
|
79
|
-
|
|
77
|
+
this.messenger.subscribe('KeyringController:unlock', () => {
|
|
78
|
+
__classPrivateFieldSet(this, _ConfigRegistryController_keyringLocked, false, "f");
|
|
79
|
+
try {
|
|
80
|
+
if (isConfigRegistryApiEnabled(this.messenger.call('RemoteFeatureFlagController:getState'))) {
|
|
81
|
+
this.startPolling(null);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
catch {
|
|
85
|
+
// RemoteFeatureFlagController unavailable; do not start polling.
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
this.messenger.subscribe('KeyringController:lock', () => {
|
|
89
|
+
__classPrivateFieldSet(this, _ConfigRegistryController_keyringLocked, true, "f");
|
|
90
|
+
this.stopAllPolling();
|
|
91
|
+
});
|
|
92
|
+
this.messenger.subscribe('RemoteFeatureFlagController:stateChange', () => {
|
|
93
|
+
let enabled = false;
|
|
94
|
+
try {
|
|
95
|
+
enabled = isConfigRegistryApiEnabled(this.messenger.call('RemoteFeatureFlagController:getState'));
|
|
96
|
+
}
|
|
97
|
+
catch {
|
|
98
|
+
// RemoteFeatureFlagController unavailable; treat as disabled.
|
|
99
|
+
}
|
|
100
|
+
if (enabled) {
|
|
101
|
+
if (!__classPrivateFieldGet(this, _ConfigRegistryController_keyringLocked, "f")) {
|
|
102
|
+
this.stopAllPolling();
|
|
103
|
+
this.startPolling(null);
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
else {
|
|
107
|
+
this.stopAllPolling();
|
|
108
|
+
}
|
|
109
|
+
});
|
|
80
110
|
}
|
|
81
111
|
async _executePoll(_input) {
|
|
82
|
-
|
|
112
|
+
let isApiEnabled = false;
|
|
113
|
+
try {
|
|
114
|
+
isApiEnabled = isConfigRegistryApiEnabled(this.messenger.call('RemoteFeatureFlagController:getState'));
|
|
115
|
+
}
|
|
116
|
+
catch {
|
|
117
|
+
// RemoteFeatureFlagController unavailable; skip fetch.
|
|
118
|
+
}
|
|
83
119
|
// Skip fetch when API is disabled; client uses static config.
|
|
84
120
|
if (!isApiEnabled) {
|
|
85
121
|
return;
|
|
86
122
|
}
|
|
87
|
-
const interval = this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;
|
|
88
|
-
if (this.state.lastFetched !== null &&
|
|
89
|
-
Date.now() - this.state.lastFetched < interval) {
|
|
90
|
-
return;
|
|
91
|
-
}
|
|
92
123
|
try {
|
|
93
124
|
const result = await this.messenger.call('ConfigRegistryApiService:fetchConfig', {
|
|
94
125
|
etag: this.state.etag ?? undefined,
|
|
@@ -113,9 +144,7 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
113
144
|
state.configs.networks = newConfigs;
|
|
114
145
|
state.version = result.data.data.version;
|
|
115
146
|
state.lastFetched = Date.now();
|
|
116
|
-
|
|
117
|
-
state.etag = result.etag;
|
|
118
|
-
}
|
|
147
|
+
state.etag = result.etag ?? null;
|
|
119
148
|
});
|
|
120
149
|
}
|
|
121
150
|
catch (error) {
|
|
@@ -124,5 +153,5 @@ export class ConfigRegistryController extends StaticIntervalPollingController()
|
|
|
124
153
|
}
|
|
125
154
|
}
|
|
126
155
|
}
|
|
127
|
-
|
|
156
|
+
_ConfigRegistryController_keyringLocked = new WeakMap();
|
|
128
157
|
//# sourceMappingURL=ConfigRegistryController.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ConfigRegistryController.mjs","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAUA,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;AAE/E,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAO3D,OAAO,EAAE,0BAA0B,IAAI,iCAAiC,EAAE,kCAA8B;AAExG,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAElD,MAAM,CAAC,MAAM,wBAAwB,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AAwCxE,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;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAwF1E,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IAKC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,eAAe,GAAG,wBAAwB,EAC1C,cAAc,GAAG,uBAAuB,EACxC,0BAA0B,GAAG,iCAAiC,GAC9B;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;iBAC3D;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;aACzB;SACF,CAAC,CAAC;QAjCI,uEAEI;QAiCX,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACxC,uBAAA,IAAI,wDAA+B,0BAA0B,MAAA,CAAC;QAE9D,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,eAAe,EAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,cAAc,EAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE,CACxD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CACxB,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE,CACtD,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,MAAM,YAAY,GAAG,uBAAA,IAAI,4DAA4B,MAAhC,IAAI,EAA6B,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtE,8DAA8D;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,IAAI,wBAAwB,CAAC;QACtE,IACE,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI;YAC/B,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,QAAQ,EAC9C,CAAC;YACD,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAsB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACzD,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,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBAC9B,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;gBAC3B,CAAC;YACH,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;CACF","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangeEvent,\n StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n KeyringControllerLockEvent,\n KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n FetchConfigOptions,\n FetchConfigResult,\n RegistryNetworkConfig,\n} from './config-registry-api-service';\nimport { isConfigRegistryApiEnabled as defaultIsConfigRegistryApiEnabled } from './utils/feature-flags';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\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 * Network configurations organized by chain ID.\n * Stores the full API response including isFeatured, isTestnet, etc.\n * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.\n */\n configs: {\n networks: Record<string, RegistryNetworkConfig>;\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\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} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangeEvent =\n ControllerStateChangeEvent<\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 * Starts polling the config registry API. Returns a polling token that can be\n * used to stop this polling session.\n */\nexport type ConfigRegistryControllerStartPollingAction = {\n type: `${typeof controllerName}:startPolling`;\n handler: (input: null) => string;\n};\n\n/**\n * Stops all config registry polling.\n */\nexport type ConfigRegistryControllerStopPollingAction = {\n type: `${typeof controllerName}:stopPolling`;\n handler: () => void;\n};\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerStartPollingAction\n | ConfigRegistryControllerStopPollingAction;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n | RemoteFeatureFlagControllerGetStateAction\n | {\n type: 'ConfigRegistryApiService:fetchConfig';\n handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;\n };\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n ConfigRegistryControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ConfigRegistryControllerMessenger}\n * subscribes to.\n */\ntype AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent;\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\n/** @deprecated Use {@link ConfigRegistryControllerMessenger} instead. */\nexport type ConfigRegistryMessenger = ConfigRegistryControllerMessenger;\n\nexport type ConfigRegistryControllerOptions = {\n messenger: ConfigRegistryMessenger;\n state?: Partial<ConfigRegistryControllerState>;\n pollingInterval?: number;\n fallbackConfig?: Record<string, RegistryNetworkConfig>;\n isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;\n};\n\nexport class ConfigRegistryController extends StaticIntervalPollingController<null>()<\n typeof controllerName,\n ConfigRegistryControllerState,\n ConfigRegistryMessenger\n> {\n readonly #isConfigRegistryApiEnabled: (\n messenger: ConfigRegistryMessenger,\n ) => boolean;\n\n /**\n * @param options - The controller options.\n * @param options.messenger - The controller messenger. Must have\n * `ConfigRegistryApiService:fetchConfig` action handler registered.\n * @param options.state - Initial state.\n * @param options.pollingInterval - Polling interval in milliseconds.\n * @param options.fallbackConfig - Fallback configuration.\n * @param options.isConfigRegistryApiEnabled - Function to check if the config\n * registry API is enabled. Defaults to checking the remote feature flag.\n */\n constructor({\n messenger,\n state = {},\n pollingInterval = DEFAULT_POLLING_INTERVAL,\n fallbackConfig = DEFAULT_FALLBACK_CONFIG,\n isConfigRegistryApiEnabled = defaultIsConfigRegistryApiEnabled,\n }: ConfigRegistryControllerOptions) {\n super({\n name: controllerName,\n metadata: stateMetadata,\n messenger,\n state: {\n configs: {\n networks: state.configs?.networks ?? { ...fallbackConfig },\n },\n version: state.version ?? null,\n lastFetched: state.lastFetched ?? null,\n etag: state.etag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n this.#isConfigRegistryApiEnabled = isConfigRegistryApiEnabled;\n\n this.messenger.registerActionHandler(\n `${controllerName}:startPolling`,\n this.startPolling.bind(this),\n );\n\n this.messenger.registerActionHandler(\n `${controllerName}:stopPolling`,\n this.stopAllPolling.bind(this),\n );\n\n this.messenger.subscribe('KeyringController:unlock', () =>\n this.startPolling(null),\n );\n\n this.messenger.subscribe('KeyringController:lock', () =>\n this.stopAllPolling(),\n );\n }\n\n async _executePoll(_input: null): Promise<void> {\n const isApiEnabled = this.#isConfigRegistryApiEnabled(this.messenger);\n\n // Skip fetch when API is disabled; client uses static config.\n if (!isApiEnabled) {\n return;\n }\n\n const interval = this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;\n if (\n this.state.lastFetched !== null &&\n Date.now() - this.state.lastFetched < interval\n ) {\n return;\n }\n\n try {\n const result: FetchConfigResult = 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 if (result.etag !== undefined) {\n state.etag = result.etag;\n }\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"]}
|
|
1
|
+
{"version":3,"file":"ConfigRegistryController.mjs","sourceRoot":"","sources":["../src/ConfigRegistryController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAUA,OAAO,EAAE,+BAA+B,EAAE,qCAAqC;AAG/E,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAI3D,OAAO,EAAE,0BAA0B,EAAE,kCAA8B;AAEnE,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAElD,MAAM,CAAC,MAAM,wBAAwB,GAAG,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;AAwCxE,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;CACqD,CAAC;AAEzD;;GAEG;AACH,MAAM,uBAAuB,GAA0C,EAAE,CAAC;AAoF1E,MAAM,OAAO,wBAAyB,SAAQ,+BAA+B,EAI5E;IAGC;;;;;;;;;OASG;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;iBAC3D;gBACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,IAAI;gBACtC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;aACzB;SACF,CAAC,CAAC;QA9BL,kDAAiB,IAAI,EAAC;QAgCpB,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,eAAe,EAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAC7B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,cAAc,EAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACxD,uBAAA,IAAI,2CAAkB,KAAK,MAAA,CAAC;YAC5B,IAAI,CAAC;gBACH,IACE,0BAA0B,CACxB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAC5D,EACD,CAAC;oBACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,iEAAiE;YACnE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtD,uBAAA,IAAI,2CAAkB,IAAI,MAAA,CAAC;YAC3B,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACvE,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,CAAC;gBACH,OAAO,GAAG,0BAA0B,CAClC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAC5D,CAAC;YACJ,CAAC;YAAC,MAAM,CAAC;gBACP,8DAA8D;YAChE,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC,uBAAA,IAAI,+CAAe,EAAE,CAAC;oBACzB,IAAI,CAAC,cAAc,EAAE,CAAC;oBACtB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC;YACH,YAAY,GAAG,0BAA0B,CACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAC5D,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,uDAAuD;QACzD,CAAC;QAED,8DAA8D;QAC9D,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,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;CACF","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangeEvent,\n StateMetadata,\n} from '@metamask/base-controller';\nimport type {\n KeyringControllerLockEvent,\n KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';\nimport type { RemoteFeatureFlagControllerStateChangeEvent } from '@metamask/remote-feature-flag-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type { ConfigRegistryApiServiceFetchConfigAction } from './config-registry-api-service/config-registry-api-service-method-action-types';\nimport type { RegistryNetworkConfig } from './config-registry-api-service/types';\nimport { isConfigRegistryApiEnabled } from './utils/feature-flags';\n\nconst controllerName = 'ConfigRegistryController';\n\nexport const DEFAULT_POLLING_INTERVAL = inMilliseconds(1, Duration.Day);\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 * Network configurations organized by chain ID.\n * Stores the full API response including isFeatured, isTestnet, etc.\n * Use selectors (e.g. selectFeaturedNetworks) to filter when needed.\n */\n configs: {\n networks: Record<string, RegistryNetworkConfig>;\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\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} satisfies StateMetadata<ConfigRegistryControllerState>;\n\n/**\n * Default fallback configuration when no configs are available.\n */\nconst DEFAULT_FALLBACK_CONFIG: Record<string, RegistryNetworkConfig> = {};\n\n/**\n * Published when the state of {@link ConfigRegistryController} changes.\n */\nexport type ConfigRegistryControllerStateChangeEvent =\n ControllerStateChangeEvent<\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 * Starts polling the config registry API. Returns a polling token that can be\n * used to stop this polling session.\n */\nexport type ConfigRegistryControllerStartPollingAction = {\n type: `${typeof controllerName}:startPolling`;\n handler: (input: null) => string;\n};\n\n/**\n * Stops all config registry polling.\n */\nexport type ConfigRegistryControllerStopPollingAction = {\n type: `${typeof controllerName}:stopPolling`;\n handler: () => void;\n};\n\n/**\n * Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerStartPollingAction\n | ConfigRegistryControllerStopPollingAction;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryControllerMessenger}\n * calls.\n */\ntype AllowedActions =\n | RemoteFeatureFlagControllerGetStateAction\n | ConfigRegistryApiServiceFetchConfigAction;\n\n/**\n * Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.\n */\nexport type ConfigRegistryControllerEvents =\n ConfigRegistryControllerStateChangeEvent;\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 #keyringLocked = true;\n\n /**\n * @param options - The controller options.\n * @param options.messenger - The controller messenger. Must have\n * `ConfigRegistryApiService:fetchConfig` action handler 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 },\n version: state.version ?? null,\n lastFetched: state.lastFetched ?? null,\n etag: state.etag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n\n this.messenger.registerActionHandler(\n `${controllerName}:startPolling`,\n this.startPolling.bind(this),\n );\n\n this.messenger.registerActionHandler(\n `${controllerName}:stopPolling`,\n this.stopAllPolling.bind(this),\n );\n\n this.messenger.subscribe('KeyringController:unlock', () => {\n this.#keyringLocked = false;\n try {\n if (\n isConfigRegistryApiEnabled(\n this.messenger.call('RemoteFeatureFlagController:getState'),\n )\n ) {\n this.startPolling(null);\n }\n } catch {\n // RemoteFeatureFlagController unavailable; do not start polling.\n }\n });\n\n this.messenger.subscribe('KeyringController:lock', () => {\n this.#keyringLocked = true;\n this.stopAllPolling();\n });\n\n this.messenger.subscribe('RemoteFeatureFlagController:stateChange', () => {\n let enabled = false;\n try {\n enabled = isConfigRegistryApiEnabled(\n this.messenger.call('RemoteFeatureFlagController:getState'),\n );\n } catch {\n // RemoteFeatureFlagController unavailable; treat as disabled.\n }\n if (enabled) {\n if (!this.#keyringLocked) {\n this.stopAllPolling();\n this.startPolling(null);\n }\n } else {\n this.stopAllPolling();\n }\n });\n }\n\n async _executePoll(_input: null): Promise<void> {\n let isApiEnabled = false;\n try {\n isApiEnabled = isConfigRegistryApiEnabled(\n this.messenger.call('RemoteFeatureFlagController:getState'),\n );\n } catch {\n // RemoteFeatureFlagController unavailable; skip fetch.\n }\n\n // Skip fetch when API is disabled; client uses static config.\n if (!isApiEnabled) {\n return;\n }\n\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"]}
|
package/dist/config-registry-api-service/config-registry-api-service-method-action-types.cjs.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-registry-api-service-method-action-types.cjs","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service-method-action-types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ConfigRegistryApiService } from './config-registry-api-service';\n\n/**\n * Fetches the latest config from the config registry API.\n *\n * @param args - The arguments to the function.\n * @param args.options - Optional fetch options (e.g. etag for cache validation).\n */\nexport type ConfigRegistryApiServiceFetchConfigAction = {\n type: 'ConfigRegistryApiService:fetchConfig';\n handler: ConfigRegistryApiService['fetchConfig'];\n};\n\n/**\n * Union of all ConfigRegistryApiService action types.\n */\nexport type ConfigRegistryApiServiceMethodActions =\n ConfigRegistryApiServiceFetchConfigAction;\n"]}
|
package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.cts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { ConfigRegistryApiService } from "./config-registry-api-service.cjs";
|
|
2
|
+
/**
|
|
3
|
+
* Fetches the latest config from the config registry API.
|
|
4
|
+
*
|
|
5
|
+
* @param args - The arguments to the function.
|
|
6
|
+
* @param args.options - Optional fetch options (e.g. etag for cache validation).
|
|
7
|
+
*/
|
|
8
|
+
export type ConfigRegistryApiServiceFetchConfigAction = {
|
|
9
|
+
type: 'ConfigRegistryApiService:fetchConfig';
|
|
10
|
+
handler: ConfigRegistryApiService['fetchConfig'];
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Union of all ConfigRegistryApiService action types.
|
|
14
|
+
*/
|
|
15
|
+
export type ConfigRegistryApiServiceMethodActions = ConfigRegistryApiServiceFetchConfigAction;
|
|
16
|
+
//# sourceMappingURL=config-registry-api-service-method-action-types.d.cts.map
|
package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.cts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-registry-api-service-method-action-types.d.cts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service-method-action-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,0CAAsC;AAE9E;;;;;GAKG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,wBAAwB,CAAC,aAAa,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,yCAAyC,CAAC"}
|
package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.mts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { ConfigRegistryApiService } from "./config-registry-api-service.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Fetches the latest config from the config registry API.
|
|
4
|
+
*
|
|
5
|
+
* @param args - The arguments to the function.
|
|
6
|
+
* @param args.options - Optional fetch options (e.g. etag for cache validation).
|
|
7
|
+
*/
|
|
8
|
+
export type ConfigRegistryApiServiceFetchConfigAction = {
|
|
9
|
+
type: 'ConfigRegistryApiService:fetchConfig';
|
|
10
|
+
handler: ConfigRegistryApiService['fetchConfig'];
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Union of all ConfigRegistryApiService action types.
|
|
14
|
+
*/
|
|
15
|
+
export type ConfigRegistryApiServiceMethodActions = ConfigRegistryApiServiceFetchConfigAction;
|
|
16
|
+
//# sourceMappingURL=config-registry-api-service-method-action-types.d.mts.map
|
package/dist/config-registry-api-service/config-registry-api-service-method-action-types.d.mts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-registry-api-service-method-action-types.d.mts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service-method-action-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,0CAAsC;AAE9E;;;;;GAKG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,wBAAwB,CAAC,aAAa,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,yCAAyC,CAAC"}
|
package/dist/config-registry-api-service/config-registry-api-service-method-action-types.mjs.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-registry-api-service-method-action-types.mjs","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service-method-action-types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ConfigRegistryApiService } from './config-registry-api-service';\n\n/**\n * Fetches the latest config from the config registry API.\n *\n * @param args - The arguments to the function.\n * @param args.options - Optional fetch options (e.g. etag for cache validation).\n */\nexport type ConfigRegistryApiServiceFetchConfigAction = {\n type: 'ConfigRegistryApiService:fetchConfig';\n handler: ConfigRegistryApiService['fetchConfig'];\n};\n\n/**\n * Union of all ConfigRegistryApiService action types.\n */\nexport type ConfigRegistryApiServiceMethodActions =\n ConfigRegistryApiServiceFetchConfigAction;\n"]}
|