Skip to content

feat(config-registry-controller)!: index configs by caip chain id #9606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikesposito merged 4 commits into from
Jul 23, 2026
+7 −5
Merged

feat(config-registry-controller)!: index configs by caip chain id #9606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce88274
feat(config-registry-controller)!: index network configs by caip2 cha…
mikesposito Jul 22, 2026
d8edfcf
update changelog
mikesposito Jul 22, 2026
0e8f02b
Merge branch 'main' into me/config-registry-network-caip2-chainid
mikesposito Jul 22, 2026
8c8a1f8
fix changelog
mikesposito Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/config-registry-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

- Add `ConfigRegistryControllerStateChangedEvent` (`ConfigRegistryController:stateChanged`) to the controller's events ([#9595](https://github.com/MetaMask/core/pull/9595))
- Add `ConfigRegistryController.getNetworkConfigByCaip2ChainId` method to retrieve a network config by its CAIP-2 chain ID ([#9597](https://github.com/MetaMask/core/pull/9597))
- Add `ConfigRegistryController.getNetworkConfigByCaip2ChainId` method to retrieve a network config by its CAIP-2 chain ID ([#9597](https://github.com/MetaMask/core/pull/9597), [#9606](https://github.com/MetaMask/core/pull/9606))
- The method returns the network config if found, or `undefined` if not found.
- The method is also accessible via the controller's messenger as `ConfigRegistryController:getNetworkConfigByCaip2ChainId`.

### Changed

- **BREAKING:** `ConfigRegistryControllerState.configs.networks` is now a `Record<Caip2ChainId, RegistryNetworkConfig>` instead of a `Record<string, RegistryNetworkConfig>` ([#9606](https://github.com/MetaMask/core/pull/9606))
- Bump `@metamask/utils` from `^11.9.0` to `^11.11.0` ([#9074](https://github.com/MetaMask/core/pull/9074))
- Bump `@metamask/controller-utils` from `^12.1.1` to `^12.3.0` ([#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218))
- Bump `@metamask/profile-sync-controller` from `^28.1.1` to `^28.3.0` ([#9119](https://github.com/MetaMask/core/pull/9119), [#9463](https://github.com/MetaMask/core/pull/9463))
Expand Down
6 changes: 3 additions & 3 deletions packages/config-registry-controller/src/ConfigRegistryController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type { Messenger } from '@metamask/messenger';
import { StaticIntervalPollingController } from '@metamask/polling-controller';
import type { RemoteFeatureFlagControllerGetStateAction } from '@metamask/remote-feature-flag-controller';
import type { RemoteFeatureFlagControllerStateChangeEvent } from '@metamask/remote-feature-flag-controller';
import { Duration, inMilliseconds, Json } from '@metamask/utils';
import { CaipChainId, Duration, inMilliseconds, Json } from '@metamask/utils';

import type { ConfigRegistryApiServiceFetchConfigAction } from './config-registry-api-service/config-registry-api-service-method-action-types.js';
import type { RegistryNetworkConfig } from './config-registry-api-service/types.js';
Expand All @@ -37,7 +37,7 @@ export type ConfigRegistryControllerState = {
* Use selectors (e.g. selectFeaturedNetworks) to filter when needed.
*/
configs: {
networks: Record<string, RegistryNetworkConfig>;
networks: Record<CaipChainId, RegistryNetworkConfig>;
};
/**
* Semantic version string of the configuration data from the API.
Expand Down Expand Up @@ -216,7 +216,7 @@ export class ConfigRegistryController extends StaticIntervalPollingController<nu
* @returns The network configuration if found, otherwise undefined.
*/
getNetworkConfigByCaip2ChainId(
caip2ChainId: string,
caip2ChainId: CaipChainId,
): RegistryNetworkConfig | undefined {
return this.state.configs.networks[caip2ChainId];
}
Expand Down
3 changes: 2 additions & 1 deletion packages/config-registry-controller/src/config-registry-api-service/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
string,
type,
} from '@metamask/superstruct';
import { CaipChainIdStruct } from '@metamask/utils';

const AssetSchema = type({
assetId: string(),
Expand Down Expand Up @@ -55,7 +56,7 @@ const ChainConfigSchema = type({
* chainId is in CAIP-2 format (e.g. "eip155:1", "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp").
*/
export const RegistryNetworkConfigSchema = type({
chainId: string(),
chainId: CaipChainIdStruct,
name: string(),
imageUrl: string(),
coingeckoPlatformId: string(),
Expand Down