@metamask-previews/config-registry-controller 0.0.1-preview-839e62c2 → 0.1.0-preview-ccd74c3b
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 +5 -9
- package/LICENSE +1 -1
- package/dist/ConfigRegistryController.cjs +58 -210
- package/dist/ConfigRegistryController.cjs.map +1 -1
- package/dist/ConfigRegistryController.d.cts +55 -58
- package/dist/ConfigRegistryController.d.cts.map +1 -1
- package/dist/ConfigRegistryController.d.mts +55 -58
- package/dist/ConfigRegistryController.d.mts.map +1 -1
- package/dist/ConfigRegistryController.mjs +59 -211
- 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 +65 -16
- 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 +82 -15
- 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 +82 -15
- 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 +66 -16
- package/dist/config-registry-api-service/config-registry-api-service.mjs.map +1 -1
- package/dist/config-registry-api-service/filters.cjs +30 -0
- package/dist/config-registry-api-service/filters.cjs.map +1 -0
- package/dist/config-registry-api-service/{transformers.d.cts → filters.d.cts} +4 -4
- package/dist/config-registry-api-service/filters.d.cts.map +1 -0
- package/dist/config-registry-api-service/{transformers.d.mts → filters.d.mts} +4 -4
- package/dist/config-registry-api-service/filters.d.mts.map +1 -0
- package/dist/config-registry-api-service/filters.mjs +26 -0
- package/dist/config-registry-api-service/filters.mjs.map +1 -0
- package/dist/config-registry-api-service/types.cjs +43 -15
- package/dist/config-registry-api-service/types.cjs.map +1 -1
- package/dist/config-registry-api-service/types.d.cts +432 -199
- package/dist/config-registry-api-service/types.d.cts.map +1 -1
- package/dist/config-registry-api-service/types.d.mts +432 -199
- package/dist/config-registry-api-service/types.d.mts.map +1 -1
- package/dist/config-registry-api-service/types.mjs +43 -15
- package/dist/config-registry-api-service/types.mjs.map +1 -1
- package/dist/index.cjs +7 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +8 -3
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +8 -3
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +3 -1
- package/dist/index.mjs.map +1 -1
- package/dist/selectors.cjs +34 -0
- package/dist/selectors.cjs.map +1 -0
- package/dist/selectors.d.cts +314 -0
- package/dist/selectors.d.cts.map +1 -0
- package/dist/selectors.d.mts +314 -0
- package/dist/selectors.d.mts.map +1 -0
- package/dist/selectors.mjs +30 -0
- package/dist/selectors.mjs.map +1 -0
- 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 +12 -11
- package/dist/config-registry-api-service/index.cjs +0 -9
- 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/dist/config-registry-api-service/transformers.cjs +0 -40
- package/dist/config-registry-api-service/transformers.cjs.map +0 -1
- package/dist/config-registry-api-service/transformers.d.cts.map +0 -1
- package/dist/config-registry-api-service/transformers.d.mts.map +0 -1
- package/dist/config-registry-api-service/transformers.mjs +0 -36
- package/dist/config-registry-api-service/transformers.mjs.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,15 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.1.0]
|
|
11
|
+
|
|
10
12
|
### Added
|
|
11
13
|
|
|
12
|
-
- Initial release
|
|
13
|
-
- Controller for fetching and managing network configurations from a remote API
|
|
14
|
-
- ConfigRegistryApiService with ETag support, retries, circuit breaker, and timeout handling
|
|
15
|
-
- Network filtering to only include featured, active, non-testnet networks
|
|
16
|
-
- Feature flag integration using `config_registry_api_enabled` to enable/disable API fetching
|
|
17
|
-
- Fallback configuration support when API is unavailable or feature flag is disabled
|
|
18
|
-
- State persistence for configs, version, lastFetched, and etag
|
|
19
|
-
- Uses StaticIntervalPollingController for periodic updates (default: 24 hours)
|
|
14
|
+
- Initial release ([#7668](https://github.com/MetaMask/core/pull/7668), [#7809](https://github.com/MetaMask/core/pull/7809))
|
|
20
15
|
|
|
21
|
-
[Unreleased]: https://github.com/MetaMask/core/
|
|
16
|
+
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/config-registry-controller@0.1.0...HEAD
|
|
17
|
+
[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/config-registry-controller@0.1.0
|
package/LICENSE
CHANGED
|
@@ -10,12 +10,11 @@ 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");
|
|
17
17
|
const utils_1 = require("@metamask/utils");
|
|
18
|
-
const config_registry_api_service_1 = require("./config-registry-api-service/index.cjs");
|
|
19
18
|
const feature_flags_1 = require("./utils/feature-flags.cjs");
|
|
20
19
|
const controllerName = 'ConfigRegistryController';
|
|
21
20
|
exports.DEFAULT_POLLING_INTERVAL = (0, utils_1.inMilliseconds)(1, utils_1.Duration.Day);
|
|
@@ -38,12 +37,6 @@ const stateMetadata = {
|
|
|
38
37
|
includeInDebugSnapshot: true,
|
|
39
38
|
usedInUi: false,
|
|
40
39
|
},
|
|
41
|
-
fetchError: {
|
|
42
|
-
persist: true,
|
|
43
|
-
includeInStateLogs: false,
|
|
44
|
-
includeInDebugSnapshot: false,
|
|
45
|
-
usedInUi: false,
|
|
46
|
-
},
|
|
47
40
|
etag: {
|
|
48
41
|
persist: true,
|
|
49
42
|
includeInStateLogs: false,
|
|
@@ -51,19 +44,22 @@ const stateMetadata = {
|
|
|
51
44
|
usedInUi: false,
|
|
52
45
|
},
|
|
53
46
|
};
|
|
47
|
+
/**
|
|
48
|
+
* Default fallback configuration when no configs are available.
|
|
49
|
+
*/
|
|
54
50
|
const DEFAULT_FALLBACK_CONFIG = {};
|
|
55
51
|
class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPollingController)() {
|
|
56
52
|
/**
|
|
57
53
|
* @param options - The controller options.
|
|
58
54
|
* @param options.messenger - The controller messenger. Must have
|
|
59
|
-
*
|
|
55
|
+
* `ConfigRegistryApiService:fetchConfig` action handler registered
|
|
56
|
+
* (e.g. by instantiating {@link ConfigRegistryApiService} with the same
|
|
57
|
+
* messenger).
|
|
60
58
|
* @param options.state - Initial state.
|
|
61
59
|
* @param options.pollingInterval - Polling interval in milliseconds.
|
|
62
60
|
* @param options.fallbackConfig - Fallback configuration.
|
|
63
|
-
* @param options.isConfigRegistryApiEnabled - Function to check if the config
|
|
64
|
-
* registry API is enabled. Defaults to checking the remote feature flag.
|
|
65
61
|
*/
|
|
66
|
-
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, }) {
|
|
67
63
|
super({
|
|
68
64
|
name: controllerName,
|
|
69
65
|
metadata: stateMetadata,
|
|
@@ -74,62 +70,57 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
74
70
|
},
|
|
75
71
|
version: state.version ?? null,
|
|
76
72
|
lastFetched: state.lastFetched ?? null,
|
|
77
|
-
fetchError: state.fetchError ?? null,
|
|
78
73
|
etag: state.etag ?? null,
|
|
79
74
|
},
|
|
80
75
|
});
|
|
81
|
-
|
|
82
|
-
_ConfigRegistryController_fallbackConfig.set(this, void 0);
|
|
83
|
-
_ConfigRegistryController_isConfigRegistryApiEnabled.set(this, void 0);
|
|
84
|
-
_ConfigRegistryController_unlockHandler.set(this, void 0);
|
|
85
|
-
_ConfigRegistryController_lockHandler.set(this, void 0);
|
|
86
|
-
_ConfigRegistryController_delayedPollTimeoutId.set(this, null);
|
|
87
|
-
_ConfigRegistryController_delayedPollTokenMap.set(this, new Map());
|
|
76
|
+
_ConfigRegistryController_keyringLocked.set(this, true);
|
|
88
77
|
this.setIntervalLength(pollingInterval);
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
78
|
+
this.messenger.registerActionHandler(`${controllerName}:startPolling`, this.startPolling.bind(this));
|
|
79
|
+
this.messenger.registerActionHandler(`${controllerName}:stopPolling`, this.stopAllPolling.bind(this));
|
|
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
|
+
});
|
|
101
113
|
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* and starting polling if already unlocked.
|
|
105
|
-
*
|
|
106
|
-
* This method should be called after all controllers have been initialized
|
|
107
|
-
* to avoid runtime dependencies during construction. If KeyringController
|
|
108
|
-
* is not available, this method will silently skip initialization.
|
|
109
|
-
*/
|
|
110
|
-
init() {
|
|
114
|
+
async _executePoll(_input) {
|
|
115
|
+
let isApiEnabled = false;
|
|
111
116
|
try {
|
|
112
|
-
|
|
113
|
-
if (isUnlocked) {
|
|
114
|
-
this.startPolling(null);
|
|
115
|
-
}
|
|
117
|
+
isApiEnabled = (0, feature_flags_1.isConfigRegistryApiEnabled)(this.messenger.call('RemoteFeatureFlagController:getState'));
|
|
116
118
|
}
|
|
117
119
|
catch {
|
|
118
|
-
//
|
|
120
|
+
// RemoteFeatureFlagController unavailable; skip fetch.
|
|
119
121
|
}
|
|
120
|
-
|
|
121
|
-
async _executePoll(_input) {
|
|
122
|
-
const isApiEnabled = __classPrivateFieldGet(this, _ConfigRegistryController_isConfigRegistryApiEnabled, "f").call(this, this.messenger);
|
|
122
|
+
// Skip fetch when API is disabled; client uses static config.
|
|
123
123
|
if (!isApiEnabled) {
|
|
124
|
-
__classPrivateFieldGet(this, _ConfigRegistryController_instances, "m", _ConfigRegistryController_useFallbackConfig).call(this, 'Feature flag disabled - using fallback configuration');
|
|
125
|
-
return;
|
|
126
|
-
}
|
|
127
|
-
// Check if enough time has passed since last fetch to respect the polling interval
|
|
128
|
-
const pollingInterval = this.getIntervalLength() ?? exports.DEFAULT_POLLING_INTERVAL;
|
|
129
|
-
const now = Date.now();
|
|
130
|
-
const { lastFetched } = this.state;
|
|
131
|
-
if (lastFetched !== null && now - lastFetched < pollingInterval) {
|
|
132
|
-
// Not enough time has passed, skip the fetch
|
|
133
124
|
return;
|
|
134
125
|
}
|
|
135
126
|
try {
|
|
@@ -138,7 +129,6 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
138
129
|
});
|
|
139
130
|
if (!result.modified) {
|
|
140
131
|
this.update((state) => {
|
|
141
|
-
state.fetchError = null;
|
|
142
132
|
state.lastFetched = Date.now();
|
|
143
133
|
if (result.etag !== undefined) {
|
|
144
134
|
state.etag = result.etag ?? null;
|
|
@@ -146,168 +136,26 @@ class ConfigRegistryController extends (0, polling_controller_1.StaticIntervalPo
|
|
|
146
136
|
});
|
|
147
137
|
return;
|
|
148
138
|
}
|
|
149
|
-
|
|
150
|
-
const filteredNetworks = (0, config_registry_api_service_1.filterNetworks)(result.data.data.networks, {
|
|
151
|
-
isFeatured: true,
|
|
152
|
-
isActive: true,
|
|
153
|
-
isTestnet: false,
|
|
154
|
-
});
|
|
155
|
-
// Group networks by chainId to detect duplicates
|
|
156
|
-
const networksByChainId = new Map();
|
|
157
|
-
filteredNetworks.forEach((network, index) => {
|
|
158
|
-
const existing = networksByChainId.get(network.chainId) ?? [];
|
|
159
|
-
existing.push({ network, index });
|
|
160
|
-
networksByChainId.set(network.chainId, existing);
|
|
161
|
-
});
|
|
162
|
-
// Build configs, handling duplicates by keeping highest priority network
|
|
139
|
+
const apiChains = result.data.data.chains;
|
|
163
140
|
const newConfigs = {};
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
.join(', ');
|
|
170
|
-
const warningMessage = `Duplicate chainId ${chainId} detected in config registry API response. Networks: ${duplicateNames}. Keeping network with highest priority.`;
|
|
171
|
-
if (this.messenger.captureException) {
|
|
172
|
-
this.messenger.captureException(new Error(warningMessage));
|
|
173
|
-
}
|
|
174
|
-
// Sort by priority (lower number = higher priority), then by index (first occurrence)
|
|
175
|
-
networks.sort((a, b) => {
|
|
176
|
-
const priorityDiff = a.network.priority - b.network.priority;
|
|
177
|
-
if (priorityDiff === 0) {
|
|
178
|
-
return a.index - b.index;
|
|
179
|
-
}
|
|
180
|
-
return priorityDiff;
|
|
181
|
-
});
|
|
182
|
-
}
|
|
183
|
-
// Use the first network (highest priority if duplicates existed)
|
|
184
|
-
const selectedNetwork = networks[0].network;
|
|
185
|
-
newConfigs[chainId] = {
|
|
186
|
-
key: chainId,
|
|
187
|
-
value: selectedNetwork,
|
|
188
|
-
};
|
|
189
|
-
}
|
|
141
|
+
// duplicate chainIds from API response are not expected
|
|
142
|
+
apiChains.forEach((chainConfig) => {
|
|
143
|
+
const { chainId } = chainConfig;
|
|
144
|
+
newConfigs[chainId] = chainConfig;
|
|
145
|
+
});
|
|
190
146
|
this.update((state) => {
|
|
191
|
-
|
|
192
|
-
// @ts-ignore - Type instantiation is excessively deep
|
|
193
|
-
state.configs = {
|
|
194
|
-
networks: newConfigs,
|
|
195
|
-
};
|
|
147
|
+
state.configs.networks = newConfigs;
|
|
196
148
|
state.version = result.data.data.version;
|
|
197
149
|
state.lastFetched = Date.now();
|
|
198
|
-
state.fetchError = null;
|
|
199
150
|
state.etag = result.etag ?? null;
|
|
200
151
|
});
|
|
201
152
|
}
|
|
202
153
|
catch (error) {
|
|
203
154
|
const errorInstance = error instanceof Error ? error : new Error(String(error));
|
|
204
|
-
|
|
205
|
-
this.messenger.captureException(errorInstance);
|
|
206
|
-
}
|
|
207
|
-
__classPrivateFieldGet(this, _ConfigRegistryController_instances, "m", _ConfigRegistryController_handleFetchError).call(this, error);
|
|
208
|
-
}
|
|
209
|
-
}
|
|
210
|
-
startPolling(input = null) {
|
|
211
|
-
// Calculate delay based on lastFetched to respect 24-hour interval
|
|
212
|
-
const pollingInterval = this.getIntervalLength() ?? exports.DEFAULT_POLLING_INTERVAL;
|
|
213
|
-
const now = Date.now();
|
|
214
|
-
const { lastFetched } = this.state;
|
|
215
|
-
if (lastFetched !== null) {
|
|
216
|
-
const timeSinceLastFetch = now - lastFetched;
|
|
217
|
-
const remainingTime = pollingInterval - timeSinceLastFetch;
|
|
218
|
-
if (remainingTime > 0) {
|
|
219
|
-
// Not enough time has passed, delay the first poll
|
|
220
|
-
// Clear any existing timeout before scheduling a new one
|
|
221
|
-
if (__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTimeoutId, "f") !== null) {
|
|
222
|
-
clearTimeout(__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTimeoutId, "f"));
|
|
223
|
-
__classPrivateFieldSet(this, _ConfigRegistryController_delayedPollTimeoutId, null, "f");
|
|
224
|
-
}
|
|
225
|
-
// Generate a placeholder token that will map to the actual token
|
|
226
|
-
const placeholderToken = `delayed-${Date.now()}-${Math.random()}`;
|
|
227
|
-
// Schedule the first poll after the remaining time
|
|
228
|
-
__classPrivateFieldSet(this, _ConfigRegistryController_delayedPollTimeoutId, setTimeout(() => {
|
|
229
|
-
__classPrivateFieldSet(this, _ConfigRegistryController_delayedPollTimeoutId, null, "f");
|
|
230
|
-
const actualToken = super.startPolling(input);
|
|
231
|
-
__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTokenMap, "f").set(placeholderToken, actualToken);
|
|
232
|
-
}, remainingTime), "f");
|
|
233
|
-
return placeholderToken;
|
|
234
|
-
}
|
|
155
|
+
this.messenger.captureException?.(errorInstance);
|
|
235
156
|
}
|
|
236
|
-
// Enough time has passed or first time, proceed with normal polling
|
|
237
|
-
return super.startPolling(input);
|
|
238
|
-
}
|
|
239
|
-
stopPolling(token) {
|
|
240
|
-
// Clear any pending delayed poll timeout
|
|
241
|
-
if (__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTimeoutId, "f") !== null) {
|
|
242
|
-
clearTimeout(__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTimeoutId, "f"));
|
|
243
|
-
__classPrivateFieldSet(this, _ConfigRegistryController_delayedPollTimeoutId, null, "f");
|
|
244
|
-
}
|
|
245
|
-
if (token) {
|
|
246
|
-
// Check if this is a placeholder token that needs mapping
|
|
247
|
-
const actualToken = __classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTokenMap, "f").get(token);
|
|
248
|
-
if (actualToken) {
|
|
249
|
-
// Remove from map and stop the actual polling session
|
|
250
|
-
__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTokenMap, "f").delete(token);
|
|
251
|
-
super.stopPollingByPollingToken(actualToken);
|
|
252
|
-
}
|
|
253
|
-
else {
|
|
254
|
-
// Stop specific polling session by token
|
|
255
|
-
super.stopPollingByPollingToken(token);
|
|
256
|
-
}
|
|
257
|
-
}
|
|
258
|
-
else {
|
|
259
|
-
// Stop all polling (backward compatible)
|
|
260
|
-
__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTokenMap, "f").clear();
|
|
261
|
-
super.stopAllPolling();
|
|
262
|
-
}
|
|
263
|
-
}
|
|
264
|
-
/**
|
|
265
|
-
* Prepares the controller for garbage collection by cleaning up event listeners,
|
|
266
|
-
* action handlers, and timers.
|
|
267
|
-
*/
|
|
268
|
-
destroy() {
|
|
269
|
-
// Stop polling and clear any pending timeouts
|
|
270
|
-
this.stopPolling();
|
|
271
|
-
__classPrivateFieldGet(this, _ConfigRegistryController_delayedPollTokenMap, "f").clear();
|
|
272
|
-
// Unsubscribe from event listeners
|
|
273
|
-
try {
|
|
274
|
-
this.messenger.unsubscribe('KeyringController:unlock', __classPrivateFieldGet(this, _ConfigRegistryController_unlockHandler, "f"));
|
|
275
|
-
}
|
|
276
|
-
catch {
|
|
277
|
-
// Handler may not be subscribed, silently handle
|
|
278
|
-
}
|
|
279
|
-
try {
|
|
280
|
-
this.messenger.unsubscribe('KeyringController:lock', __classPrivateFieldGet(this, _ConfigRegistryController_lockHandler, "f"));
|
|
281
|
-
}
|
|
282
|
-
catch {
|
|
283
|
-
// Handler may not be subscribed, silently handle
|
|
284
|
-
}
|
|
285
|
-
// Unregister action handlers
|
|
286
|
-
this.messenger.unregisterActionHandler(`${controllerName}:startPolling`);
|
|
287
|
-
this.messenger.unregisterActionHandler(`${controllerName}:stopPolling`);
|
|
288
|
-
// Call parent destroy to clean up base controller subscriptions
|
|
289
|
-
super.destroy();
|
|
290
157
|
}
|
|
291
158
|
}
|
|
292
159
|
exports.ConfigRegistryController = ConfigRegistryController;
|
|
293
|
-
|
|
294
|
-
this.update((state) => {
|
|
295
|
-
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
296
|
-
// @ts-ignore - Type instantiation is excessively deep
|
|
297
|
-
state.configs.networks = { ...__classPrivateFieldGet(this, _ConfigRegistryController_fallbackConfig, "f") };
|
|
298
|
-
state.fetchError = errorMessage;
|
|
299
|
-
state.etag = null;
|
|
300
|
-
});
|
|
301
|
-
}, _ConfigRegistryController_handleFetchError = function _ConfigRegistryController_handleFetchError(error) {
|
|
302
|
-
const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
|
|
303
|
-
this.update((state) => {
|
|
304
|
-
state.fetchError = errorMessage;
|
|
305
|
-
state.lastFetched = Date.now();
|
|
306
|
-
});
|
|
307
|
-
}, _ConfigRegistryController_registerKeyringEventListeners = function _ConfigRegistryController_registerKeyringEventListeners() {
|
|
308
|
-
// Subscribe to unlock event - start polling
|
|
309
|
-
this.messenger.subscribe('KeyringController:unlock', __classPrivateFieldGet(this, _ConfigRegistryController_unlockHandler, "f"));
|
|
310
|
-
// Subscribe to lock event - stop polling
|
|
311
|
-
this.messenger.subscribe('KeyringController:lock', __classPrivateFieldGet(this, _ConfigRegistryController_lockHandler, "f"));
|
|
312
|
-
};
|
|
160
|
+
_ConfigRegistryController_keyringLocked = new WeakMap();
|
|
313
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;AAQ3D,yFAA+D;AAC/D,6DAAwG;AAExG,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAErC,QAAA,wBAAwB,GAAG,IAAA,sBAAc,EAAC,CAAC,EAAE,gBAAQ,CAAC,GAAG,CAAC,CAAC;AAkDxE,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,UAAU,EAAE;QACV,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,kBAAkB,EAAE,KAAK;QACzB,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CAC2C,CAAC;AAE/C,MAAM,uBAAuB,GAAuC,EAAE,CAAC;AAwDvE,MAAa,wBAAyB,SAAQ,IAAA,oDAA+B,GAI5E;IAeC;;;;;;;;;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,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,IAAI;gBACpC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;aACzB;SACF,CAAC,CAAC;;QA5CI,2DAAoD;QAEpD,uEAEI;QAEJ,0DAA2B;QAE3B,wDAAyB;QAElC,yDAA8D,IAAI,EAAC;QAE1D,wDAA4C,IAAI,GAAG,EAAE,EAAC;QAkC7D,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QACxC,uBAAA,IAAI,4CAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,wDAA+B,0BAA0B,MAAA,CAAC;QAE9D,6BAA6B;QAC7B,uBAAA,IAAI,2CAAkB,GAAS,EAAE;YAC/B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,MAAA,CAAC;QAEF,uBAAA,IAAI,yCAAgB,GAAS,EAAE;YAC7B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,CAAC,MAAA,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,eAAe,EAChC,CAAC,KAAW,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAC1C,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAClC,GAAG,cAAc,cAAc,EAC/B,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAC5C,CAAC;QAEF,uBAAA,IAAI,oGAA+B,MAAnC,IAAI,CAAiC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,IAAI;QACF,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YACzE,IAAI,UAAU,EAAE,CAAC;gBACf,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,0DAA0D;QAC5D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAY;QAC7B,MAAM,YAAY,GAAG,uBAAA,IAAI,4DAA4B,MAAhC,IAAI,EAA6B,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EACF,sDAAsD,CACvD,CAAC;YACF,OAAO;QACT,CAAC;QAED,mFAAmF;QACnF,MAAM,eAAe,GACnB,IAAI,CAAC,iBAAiB,EAAE,IAAI,gCAAwB,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEnC,IAAI,WAAW,KAAK,IAAI,IAAI,GAAG,GAAG,WAAW,GAAG,eAAe,EAAE,CAAC;YAChE,6CAA6C;YAC7C,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,UAAU,GAAG,IAAI,CAAC;oBACxB,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,+DAA+D;YAC/D,MAAM,gBAAgB,GAAG,IAAA,4CAAc,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACjE,UAAU,EAAE,IAAI;gBAChB,QAAQ,EAAE,IAAI;gBACd,SAAS,EAAE,KAAK;aACjB,CAAC,CAAC;YAEH,iDAAiD;YACjD,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAG9B,CAAC;YACJ,gBAAgB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;gBAClC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YAEH,yEAAyE;YACzE,MAAM,UAAU,GAAuC,EAAE,CAAC;YAC1D,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,iBAAiB,EAAE,CAAC;gBACpD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxB,sEAAsE;oBACtE,MAAM,cAAc,GAAG,QAAQ;yBAC5B,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;yBAChD,IAAI,CAAC,IAAI,CAAC,CAAC;oBACd,MAAM,cAAc,GAAG,qBAAqB,OAAO,wDAAwD,cAAc,0CAA0C,CAAC;oBAEpK,IAAI,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;wBACpC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;oBAC7D,CAAC;oBAED,sFAAsF;oBACtF,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;wBACrB,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;wBAC7D,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;4BACvB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;wBAC3B,CAAC;wBACD,OAAO,YAAY,CAAC;oBACtB,CAAC,CAAC,CAAC;gBACL,CAAC;gBAED,iEAAiE;gBACjE,MAAM,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;gBAC5C,UAAU,CAAC,OAAO,CAAC,GAAG;oBACpB,GAAG,EAAE,OAAO;oBACZ,KAAK,EAAE,eAAe;iBACvB,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,6DAA6D;gBAC7D,sDAAsD;gBACrD,KAAK,CAAC,OAA0C,GAAG;oBAClD,QAAQ,EAAE,UAAU;iBACrB,CAAC;gBACF,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,UAAU,GAAG,IAAI,CAAC;gBACxB,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,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;gBACpC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACjD,CAAC;YAED,uBAAA,IAAI,uFAAkB,MAAtB,IAAI,EAAmB,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAkCD,YAAY,CAAC,QAAc,IAAI;QAC7B,mEAAmE;QACnE,MAAM,eAAe,GACnB,IAAI,CAAC,iBAAiB,EAAE,IAAI,gCAAwB,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEnC,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACzB,MAAM,kBAAkB,GAAG,GAAG,GAAG,WAAW,CAAC;YAC7C,MAAM,aAAa,GAAG,eAAe,GAAG,kBAAkB,CAAC;YAE3D,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACtB,mDAAmD;gBACnD,yDAAyD;gBACzD,IAAI,uBAAA,IAAI,sDAAsB,KAAK,IAAI,EAAE,CAAC;oBACxC,YAAY,CAAC,uBAAA,IAAI,sDAAsB,CAAC,CAAC;oBACzC,uBAAA,IAAI,kDAAyB,IAAI,MAAA,CAAC;gBACpC,CAAC;gBAED,iEAAiE;gBACjE,MAAM,gBAAgB,GAAG,WAAW,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;gBAElE,mDAAmD;gBACnD,uBAAA,IAAI,kDAAyB,UAAU,CAAC,GAAG,EAAE;oBAC3C,uBAAA,IAAI,kDAAyB,IAAI,MAAA,CAAC;oBAClC,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBAC9C,uBAAA,IAAI,qDAAqB,CAAC,GAAG,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;gBAC/D,CAAC,EAAE,aAAa,CAAC,MAAA,CAAC;gBAElB,OAAO,gBAAgB,CAAC;YAC1B,CAAC;QACH,CAAC;QAED,oEAAoE;QACpE,OAAO,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,WAAW,CAAC,KAAc;QACxB,yCAAyC;QACzC,IAAI,uBAAA,IAAI,sDAAsB,KAAK,IAAI,EAAE,CAAC;YACxC,YAAY,CAAC,uBAAA,IAAI,sDAAsB,CAAC,CAAC;YACzC,uBAAA,IAAI,kDAAyB,IAAI,MAAA,CAAC;QACpC,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,0DAA0D;YAC1D,MAAM,WAAW,GAAG,uBAAA,IAAI,qDAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACzD,IAAI,WAAW,EAAE,CAAC;gBAChB,sDAAsD;gBACtD,uBAAA,IAAI,qDAAqB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxC,KAAK,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,yCAAyC;gBACzC,KAAK,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,yCAAyC;YACzC,uBAAA,IAAI,qDAAqB,CAAC,KAAK,EAAE,CAAC;YAClC,KAAK,CAAC,cAAc,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAED;;;OAGG;IACM,OAAO;QACd,8CAA8C;QAC9C,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,uBAAA,IAAI,qDAAqB,CAAC,KAAK,EAAE,CAAC;QAElC,mCAAmC;QACnC,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,WAAW,CACxB,0BAA0B,EAC1B,uBAAA,IAAI,+CAAe,CACpB,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,iDAAiD;QACnD,CAAC;QAED,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,wBAAwB,EAAE,uBAAA,IAAI,6CAAa,CAAC,CAAC;QAC1E,CAAC;QAAC,MAAM,CAAC;YACP,iDAAiD;QACnD,CAAC;QAED,6BAA6B;QAC7B,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,cAAc,eAAe,CAAC,CAAC;QACzE,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,cAAc,cAAc,CAAC,CAAC;QAExE,gEAAgE;QAChE,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AA/UD,4DA+UC;ugBA9HoB,YAAoB;IACrC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,6DAA6D;QAC7D,sDAAsD;QACtD,KAAK,CAAC,OAAO,CAAC,QAAQ,GAAG,EAAE,GAAG,uBAAA,IAAI,gDAAgB,EAAE,CAAC;QACrD,KAAK,CAAC,UAAU,GAAG,YAAY,CAAC;QAChC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC,mGAEiB,KAAc;IAC9B,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB,CAAC;IAEpE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,UAAU,GAAG,YAAY,CAAC;QAChC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;IAOC,4CAA4C;IAC5C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,0BAA0B,EAAE,uBAAA,IAAI,+CAAe,CAAC,CAAC;IAE1E,yCAAyC;IACzC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wBAAwB,EAAE,uBAAA,IAAI,6CAAa,CAAC,CAAC;AACxE,CAAC","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 type { RemoteFeatureFlagControllerState } from '@metamask/remote-feature-flag-controller';\nimport { Duration, inMilliseconds } from '@metamask/utils';\nimport type { Json } from '@metamask/utils';\n\nimport type {\n FetchConfigOptions,\n FetchConfigResult,\n RegistryNetworkConfig,\n} from './config-registry-api-service';\nimport { filterNetworks } 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\nexport type NetworkConfigEntry = {\n key: string;\n value: RegistryNetworkConfig;\n metadata?: Json;\n};\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 ConfigRegistryState = {\n /**\n * Network configurations organized by chain ID.\n * Contains the actual network configuration data fetched from the API.\n */\n configs: {\n networks: Record<string, NetworkConfigEntry>;\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 * Error message if the last fetch attempt failed.\n * Null if the last fetch was successful.\n */\n fetchError: string | 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 fetchError: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: false,\n usedInUi: false,\n },\n etag: {\n persist: true,\n includeInStateLogs: false,\n includeInDebugSnapshot: false,\n usedInUi: false,\n },\n} satisfies StateMetadata<ConfigRegistryState>;\n\nconst DEFAULT_FALLBACK_CONFIG: Record<string, NetworkConfigEntry> = {};\n\nexport type ConfigRegistryControllerStateChangeEvent =\n ControllerStateChangeEvent<typeof controllerName, ConfigRegistryState>;\n\nexport type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<\n typeof controllerName,\n ConfigRegistryState\n>;\n\nexport type ConfigRegistryControllerStartPollingAction = {\n type: `${typeof controllerName}:startPolling`;\n handler: (input: null) => string;\n};\n\nexport type ConfigRegistryControllerStopPollingAction = {\n type: `${typeof controllerName}:stopPolling`;\n handler: (token?: string) => void;\n};\n\nexport type ConfigRegistryControllerActions =\n | ConfigRegistryControllerGetStateAction\n | ConfigRegistryControllerStartPollingAction\n | ConfigRegistryControllerStopPollingAction\n | {\n type: 'RemoteFeatureFlagController:getState';\n handler: () => RemoteFeatureFlagControllerState;\n }\n | {\n type: 'KeyringController:getState';\n handler: () => { isUnlocked: boolean };\n }\n | {\n type: 'ConfigRegistryApiService:fetchConfig';\n handler: (options?: FetchConfigOptions) => Promise<FetchConfigResult>;\n };\n\nexport type ConfigRegistryControllerEvents =\n | KeyringControllerUnlockEvent\n | KeyringControllerLockEvent\n | ConfigRegistryControllerStateChangeEvent;\n\nexport type ConfigRegistryMessenger = Messenger<\n typeof controllerName,\n ConfigRegistryControllerActions,\n ConfigRegistryControllerEvents\n>;\n\nexport type ConfigRegistryControllerOptions = {\n messenger: ConfigRegistryMessenger;\n state?: Partial<ConfigRegistryState>;\n pollingInterval?: number;\n fallbackConfig?: Record<string, NetworkConfigEntry>;\n isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;\n};\n\nexport class ConfigRegistryController extends StaticIntervalPollingController<null>()<\n typeof controllerName,\n ConfigRegistryState,\n ConfigRegistryMessenger\n> {\n readonly #fallbackConfig: Record<string, NetworkConfigEntry>;\n\n readonly #isConfigRegistryApiEnabled: (\n messenger: ConfigRegistryMessenger,\n ) => boolean;\n\n readonly #unlockHandler: () => void;\n\n readonly #lockHandler: () => void;\n\n #delayedPollTimeoutId: ReturnType<typeof setTimeout> | null = null;\n\n readonly #delayedPollTokenMap: Map<string, string> = new Map();\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 fetchError: state.fetchError ?? null,\n etag: state.etag ?? null,\n },\n });\n\n this.setIntervalLength(pollingInterval);\n this.#fallbackConfig = fallbackConfig;\n this.#isConfigRegistryApiEnabled = isConfigRegistryApiEnabled;\n\n // Store handlers for cleanup\n this.#unlockHandler = (): void => {\n this.startPolling(null);\n };\n\n this.#lockHandler = (): void => {\n this.stopPolling();\n };\n\n this.messenger.registerActionHandler(\n `${controllerName}:startPolling`,\n (input: null) => this.startPolling(input),\n );\n\n this.messenger.registerActionHandler(\n `${controllerName}:stopPolling`,\n (token?: string) => this.stopPolling(token),\n );\n\n this.#registerKeyringEventListeners();\n }\n\n /**\n * Initializes the controller by checking the KeyringController unlock state\n * and starting polling if already unlocked.\n *\n * This method should be called after all controllers have been initialized\n * to avoid runtime dependencies during construction. If KeyringController\n * is not available, this method will silently skip initialization.\n */\n init(): void {\n try {\n const { isUnlocked } = this.messenger.call('KeyringController:getState');\n if (isUnlocked) {\n this.startPolling(null);\n }\n } catch {\n // KeyringController may not be available, silently handle\n }\n }\n\n async _executePoll(_input: null): Promise<void> {\n const isApiEnabled = this.#isConfigRegistryApiEnabled(this.messenger);\n\n if (!isApiEnabled) {\n this.#useFallbackConfig(\n 'Feature flag disabled - using fallback configuration',\n );\n return;\n }\n\n // Check if enough time has passed since last fetch to respect the polling interval\n const pollingInterval =\n this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;\n const now = Date.now();\n const { lastFetched } = this.state;\n\n if (lastFetched !== null && now - lastFetched < pollingInterval) {\n // Not enough time has passed, skip the fetch\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.fetchError = null;\n state.lastFetched = Date.now();\n if (result.etag !== undefined) {\n state.etag = result.etag ?? null;\n }\n });\n return;\n }\n\n // Filter networks: only featured, active, non-testnet networks\n const filteredNetworks = filterNetworks(result.data.data.networks, {\n isFeatured: true,\n isActive: true,\n isTestnet: false,\n });\n\n // Group networks by chainId to detect duplicates\n const networksByChainId = new Map<\n string,\n { network: RegistryNetworkConfig; index: number }[]\n >();\n filteredNetworks.forEach((network, index) => {\n const existing = networksByChainId.get(network.chainId) ?? [];\n existing.push({ network, index });\n networksByChainId.set(network.chainId, existing);\n });\n\n // Build configs, handling duplicates by keeping highest priority network\n const newConfigs: Record<string, NetworkConfigEntry> = {};\n for (const [chainId, networks] of networksByChainId) {\n if (networks.length > 1) {\n // Duplicate chainIds detected - log warning and keep highest priority\n const duplicateNames = networks\n .map((networkEntry) => networkEntry.network.name)\n .join(', ');\n const warningMessage = `Duplicate chainId ${chainId} detected in config registry API response. Networks: ${duplicateNames}. Keeping network with highest priority.`;\n\n if (this.messenger.captureException) {\n this.messenger.captureException(new Error(warningMessage));\n }\n\n // Sort by priority (lower number = higher priority), then by index (first occurrence)\n networks.sort((a, b) => {\n const priorityDiff = a.network.priority - b.network.priority;\n if (priorityDiff === 0) {\n return a.index - b.index;\n }\n return priorityDiff;\n });\n }\n\n // Use the first network (highest priority if duplicates existed)\n const selectedNetwork = networks[0].network;\n newConfigs[chainId] = {\n key: chainId,\n value: selectedNetwork,\n };\n }\n\n this.update((state) => {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore - Type instantiation is excessively deep\n (state.configs as ConfigRegistryState['configs']) = {\n networks: newConfigs,\n };\n state.version = result.data.data.version;\n state.lastFetched = Date.now();\n state.fetchError = null;\n state.etag = result.etag ?? null;\n });\n } catch (error) {\n const errorInstance =\n error instanceof Error ? error : new Error(String(error));\n\n if (this.messenger.captureException) {\n this.messenger.captureException(errorInstance);\n }\n\n this.#handleFetchError(error);\n }\n }\n\n #useFallbackConfig(errorMessage: string): void {\n this.update((state) => {\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore - Type instantiation is excessively deep\n state.configs.networks = { ...this.#fallbackConfig };\n state.fetchError = errorMessage;\n state.etag = null;\n });\n }\n\n #handleFetchError(error: unknown): void {\n const errorMessage =\n error instanceof Error ? error.message : 'Unknown error occurred';\n\n this.update((state) => {\n state.fetchError = errorMessage;\n state.lastFetched = Date.now();\n });\n }\n\n /**\n * Registers event listeners for KeyringController unlock/lock events.\n * The listeners will automatically start polling when unlocked and stop when locked.\n */\n #registerKeyringEventListeners(): void {\n // Subscribe to unlock event - start polling\n this.messenger.subscribe('KeyringController:unlock', this.#unlockHandler);\n\n // Subscribe to lock event - stop polling\n this.messenger.subscribe('KeyringController:lock', this.#lockHandler);\n }\n\n startPolling(input: null = null): string {\n // Calculate delay based on lastFetched to respect 24-hour interval\n const pollingInterval =\n this.getIntervalLength() ?? DEFAULT_POLLING_INTERVAL;\n const now = Date.now();\n const { lastFetched } = this.state;\n\n if (lastFetched !== null) {\n const timeSinceLastFetch = now - lastFetched;\n const remainingTime = pollingInterval - timeSinceLastFetch;\n\n if (remainingTime > 0) {\n // Not enough time has passed, delay the first poll\n // Clear any existing timeout before scheduling a new one\n if (this.#delayedPollTimeoutId !== null) {\n clearTimeout(this.#delayedPollTimeoutId);\n this.#delayedPollTimeoutId = null;\n }\n\n // Generate a placeholder token that will map to the actual token\n const placeholderToken = `delayed-${Date.now()}-${Math.random()}`;\n\n // Schedule the first poll after the remaining time\n this.#delayedPollTimeoutId = setTimeout(() => {\n this.#delayedPollTimeoutId = null;\n const actualToken = super.startPolling(input);\n this.#delayedPollTokenMap.set(placeholderToken, actualToken);\n }, remainingTime);\n\n return placeholderToken;\n }\n }\n\n // Enough time has passed or first time, proceed with normal polling\n return super.startPolling(input);\n }\n\n stopPolling(token?: string): void {\n // Clear any pending delayed poll timeout\n if (this.#delayedPollTimeoutId !== null) {\n clearTimeout(this.#delayedPollTimeoutId);\n this.#delayedPollTimeoutId = null;\n }\n\n if (token) {\n // Check if this is a placeholder token that needs mapping\n const actualToken = this.#delayedPollTokenMap.get(token);\n if (actualToken) {\n // Remove from map and stop the actual polling session\n this.#delayedPollTokenMap.delete(token);\n super.stopPollingByPollingToken(actualToken);\n } else {\n // Stop specific polling session by token\n super.stopPollingByPollingToken(token);\n }\n } else {\n // Stop all polling (backward compatible)\n this.#delayedPollTokenMap.clear();\n super.stopAllPolling();\n }\n }\n\n /**\n * Prepares the controller for garbage collection by cleaning up event listeners,\n * action handlers, and timers.\n */\n override destroy(): void {\n // Stop polling and clear any pending timeouts\n this.stopPolling();\n this.#delayedPollTokenMap.clear();\n\n // Unsubscribe from event listeners\n try {\n this.messenger.unsubscribe(\n 'KeyringController:unlock',\n this.#unlockHandler,\n );\n } catch {\n // Handler may not be subscribed, silently handle\n }\n\n try {\n this.messenger.unsubscribe('KeyringController:lock', this.#lockHandler);\n } catch {\n // Handler may not be subscribed, silently handle\n }\n\n // Unregister action handlers\n this.messenger.unregisterActionHandler(`${controllerName}:startPolling`);\n this.messenger.unregisterActionHandler(`${controllerName}:stopPolling`);\n\n // Call parent destroy to clean up base controller subscriptions\n super.destroy();\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"]}
|
|
@@ -1,29 +1,26 @@
|
|
|
1
1
|
import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
|
|
2
2
|
import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
|
|
3
3
|
import type { Messenger } from "@metamask/messenger";
|
|
4
|
-
import
|
|
5
|
-
import type {
|
|
6
|
-
import type {
|
|
4
|
+
import { RemoteFeatureFlagControllerGetStateAction } from "@metamask/remote-feature-flag-controller";
|
|
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";
|
|
7
8
|
declare const controllerName = "ConfigRegistryController";
|
|
8
9
|
export declare const DEFAULT_POLLING_INTERVAL: number;
|
|
9
|
-
export type NetworkConfigEntry = {
|
|
10
|
-
key: string;
|
|
11
|
-
value: RegistryNetworkConfig;
|
|
12
|
-
metadata?: Json;
|
|
13
|
-
};
|
|
14
10
|
/**
|
|
15
11
|
* State for the ConfigRegistryController.
|
|
16
12
|
*
|
|
17
13
|
* Tracks network configurations fetched from the config registry API,
|
|
18
14
|
* along with metadata about the fetch status and caching.
|
|
19
15
|
*/
|
|
20
|
-
export type
|
|
16
|
+
export type ConfigRegistryControllerState = {
|
|
21
17
|
/**
|
|
22
18
|
* Network configurations organized by chain ID.
|
|
23
|
-
*
|
|
19
|
+
* Stores the full API response including isFeatured, isTestnet, etc.
|
|
20
|
+
* Use selectors (e.g. selectFeaturedNetworks) to filter when needed.
|
|
24
21
|
*/
|
|
25
22
|
configs: {
|
|
26
|
-
networks: Record<string,
|
|
23
|
+
networks: Record<string, RegistryNetworkConfig>;
|
|
27
24
|
};
|
|
28
25
|
/**
|
|
29
26
|
* Semantic version string of the configuration data from the API.
|
|
@@ -37,11 +34,6 @@ export type ConfigRegistryState = {
|
|
|
37
34
|
* was last successfully fetched from the API.
|
|
38
35
|
*/
|
|
39
36
|
lastFetched: number | null;
|
|
40
|
-
/**
|
|
41
|
-
* Error message if the last fetch attempt failed.
|
|
42
|
-
* Null if the last fetch was successful.
|
|
43
|
-
*/
|
|
44
|
-
fetchError: string | null;
|
|
45
37
|
/**
|
|
46
38
|
* HTTP entity tag (ETag) used for cache validation.
|
|
47
39
|
* Sent as `If-None-Match` header in subsequent requests to check
|
|
@@ -52,36 +44,57 @@ export type ConfigRegistryState = {
|
|
|
52
44
|
*/
|
|
53
45
|
etag: string | null;
|
|
54
46
|
};
|
|
55
|
-
|
|
56
|
-
|
|
47
|
+
/**
|
|
48
|
+
* Published when the state of {@link ConfigRegistryController} changes.
|
|
49
|
+
*/
|
|
50
|
+
export type ConfigRegistryControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ConfigRegistryControllerState>;
|
|
51
|
+
/**
|
|
52
|
+
* Retrieves the state of the {@link ConfigRegistryController}.
|
|
53
|
+
*/
|
|
54
|
+
export type ConfigRegistryControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ConfigRegistryControllerState>;
|
|
55
|
+
/**
|
|
56
|
+
* Starts polling the config registry API. Returns a polling token that can be
|
|
57
|
+
* used to stop this polling session.
|
|
58
|
+
*/
|
|
57
59
|
export type ConfigRegistryControllerStartPollingAction = {
|
|
58
60
|
type: `${typeof controllerName}:startPolling`;
|
|
59
61
|
handler: (input: null) => string;
|
|
60
62
|
};
|
|
63
|
+
/**
|
|
64
|
+
* Stops all config registry polling.
|
|
65
|
+
*/
|
|
61
66
|
export type ConfigRegistryControllerStopPollingAction = {
|
|
62
67
|
type: `${typeof controllerName}:stopPolling`;
|
|
63
|
-
handler: (
|
|
68
|
+
handler: () => void;
|
|
64
69
|
};
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
export type ConfigRegistryControllerEvents =
|
|
78
|
-
|
|
70
|
+
/**
|
|
71
|
+
* Actions that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
|
|
72
|
+
*/
|
|
73
|
+
export type ConfigRegistryControllerActions = ConfigRegistryControllerGetStateAction | ConfigRegistryControllerStartPollingAction | ConfigRegistryControllerStopPollingAction;
|
|
74
|
+
/**
|
|
75
|
+
* Actions from other messengers that {@link ConfigRegistryControllerMessenger}
|
|
76
|
+
* calls.
|
|
77
|
+
*/
|
|
78
|
+
type AllowedActions = RemoteFeatureFlagControllerGetStateAction | ConfigRegistryApiServiceFetchConfigAction;
|
|
79
|
+
/**
|
|
80
|
+
* Events that {@link ConfigRegistryControllerMessenger} exposes to other consumers.
|
|
81
|
+
*/
|
|
82
|
+
export type ConfigRegistryControllerEvents = ConfigRegistryControllerStateChangeEvent;
|
|
83
|
+
/**
|
|
84
|
+
* Events from other messengers that {@link ConfigRegistryControllerMessenger}
|
|
85
|
+
* subscribes to.
|
|
86
|
+
*/
|
|
87
|
+
type AllowedEvents = KeyringControllerUnlockEvent | KeyringControllerLockEvent | RemoteFeatureFlagControllerStateChangeEvent;
|
|
88
|
+
/**
|
|
89
|
+
* The messenger restricted to actions and events accessed by
|
|
90
|
+
* {@link ConfigRegistryController}.
|
|
91
|
+
*/
|
|
92
|
+
export type ConfigRegistryControllerMessenger = Messenger<typeof controllerName, ConfigRegistryControllerActions | AllowedActions, ConfigRegistryControllerEvents | AllowedEvents>;
|
|
79
93
|
export type ConfigRegistryControllerOptions = {
|
|
80
|
-
messenger:
|
|
81
|
-
state?: Partial<
|
|
94
|
+
messenger: ConfigRegistryControllerMessenger;
|
|
95
|
+
state?: Partial<ConfigRegistryControllerState>;
|
|
82
96
|
pollingInterval?: number;
|
|
83
|
-
fallbackConfig?: Record<string,
|
|
84
|
-
isConfigRegistryApiEnabled?: (messenger: ConfigRegistryMessenger) => boolean;
|
|
97
|
+
fallbackConfig?: Record<string, RegistryNetworkConfig>;
|
|
85
98
|
};
|
|
86
99
|
declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
|
|
87
100
|
readonly "__#15@#intervalIds": Record<string, NodeJS.Timeout>;
|
|
@@ -98,36 +111,20 @@ declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
|
|
|
98
111
|
stopPollingByPollingToken(pollingToken: string): void;
|
|
99
112
|
onPollingComplete(input: null, callback: (input: null) => void): void;
|
|
100
113
|
}) & typeof import("@metamask/base-controller").BaseController;
|
|
101
|
-
export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName,
|
|
114
|
+
export declare class ConfigRegistryController extends ConfigRegistryController_base<typeof controllerName, ConfigRegistryControllerState, ConfigRegistryControllerMessenger> {
|
|
102
115
|
#private;
|
|
103
116
|
/**
|
|
104
117
|
* @param options - The controller options.
|
|
105
118
|
* @param options.messenger - The controller messenger. Must have
|
|
106
|
-
*
|
|
119
|
+
* `ConfigRegistryApiService:fetchConfig` action handler registered
|
|
120
|
+
* (e.g. by instantiating {@link ConfigRegistryApiService} with the same
|
|
121
|
+
* messenger).
|
|
107
122
|
* @param options.state - Initial state.
|
|
108
123
|
* @param options.pollingInterval - Polling interval in milliseconds.
|
|
109
124
|
* @param options.fallbackConfig - Fallback configuration.
|
|
110
|
-
* @param options.isConfigRegistryApiEnabled - Function to check if the config
|
|
111
|
-
* registry API is enabled. Defaults to checking the remote feature flag.
|
|
112
|
-
*/
|
|
113
|
-
constructor({ messenger, state, pollingInterval, fallbackConfig, isConfigRegistryApiEnabled, }: ConfigRegistryControllerOptions);
|
|
114
|
-
/**
|
|
115
|
-
* Initializes the controller by checking the KeyringController unlock state
|
|
116
|
-
* and starting polling if already unlocked.
|
|
117
|
-
*
|
|
118
|
-
* This method should be called after all controllers have been initialized
|
|
119
|
-
* to avoid runtime dependencies during construction. If KeyringController
|
|
120
|
-
* is not available, this method will silently skip initialization.
|
|
121
125
|
*/
|
|
122
|
-
|
|
126
|
+
constructor({ messenger, state, pollingInterval, fallbackConfig, }: ConfigRegistryControllerOptions);
|
|
123
127
|
_executePoll(_input: null): Promise<void>;
|
|
124
|
-
startPolling(input?: null): string;
|
|
125
|
-
stopPolling(token?: string): void;
|
|
126
|
-
/**
|
|
127
|
-
* Prepares the controller for garbage collection by cleaning up event listeners,
|
|
128
|
-
* action handlers, and timers.
|
|
129
|
-
*/
|
|
130
|
-
destroy(): void;
|
|
131
128
|
}
|
|
132
129
|
export {};
|
|
133
130
|
//# sourceMappingURL=ConfigRegistryController.d.cts.map
|