Skip to content

refactor(ens-controller): migrate from @ethersproject/providers to viem for ENS resolution #9745

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

Draft
yashgo0018 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

refactor(ens-controller): migrate from @ethersproject/providers to viem for ENS resolution #9745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion eslint-suppressions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,7 +963,7 @@
},
"packages/ens-controller/src/EnsController.test.ts": {
"@typescript-eslint/explicit-function-return-type": {
"count": 11
"count": 10
},
"@typescript-eslint/prefer-nullish-coalescing": {
"count": 1
Expand Down
8 changes: 8 additions & 0 deletions packages/ens-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- **BREAKING:** `DEFAULT_ENS_NETWORK_MAP` now maps Mainnet and Sepolia to the ENS Universal Resolver contract address (`0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe`)
- Previously it mapped Mainnet, Ropsten, Rinkeby, Goerli, Holesky, and Sepolia to the ENS registry contract address; the default `ensEntries` state seeded from this map (under the `.` key) changes accordingly
- Reverse resolution is no longer available on Holesky by default; Ropsten, Rinkeby, and Goerli have been shut down and could not resolve anyway
- Replace `@ethersproject/providers` with `viem` for ENS resolution
- Reverse resolution now goes through the ENS Universal Resolver (ENSIP-23), which makes the controller compatible with ENSv2 when it launches

## [19.1.6]

### Changed
Expand Down
4 changes: 2 additions & 2 deletions packages/ens-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@
"test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
},
"dependencies": {
"@ethersproject/providers": "^5.7.0",
"@metamask/base-controller": "^9.1.0",
"@metamask/controller-utils": "^12.3.0",
"@metamask/messenger": "^2.0.0",
"@metamask/network-controller": "^35.0.0",
"@metamask/utils": "^11.11.0",
"punycode": "^2.1.1"
"punycode": "^2.1.1",
"viem": "2.55.8"
},
"devDependencies": {
"@metamask/auto-changelog": "^6.1.0",
Expand Down
205 changes: 57 additions & 148 deletions packages/ens-controller/src/EnsController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import * as providersModule from '@ethersproject/providers';
import { deriveStateFromMetadata } from '@metamask/base-controller';
import {
toChecksumHexAddress,
Expand All @@ -16,6 +15,7 @@ import type {
NetworkController,
NetworkState,
} from '@metamask/network-controller';
import { getEnsAddress, getEnsName } from 'viem/actions';

import {
buildMockGetNetworkClientById,
Expand Down Expand Up @@ -44,14 +44,14 @@ for (const [cid, address] of Object.entries(DEFAULT_ENS_NETWORK_MAP)) {
}
Object.freeze(defaultState);

jest.mock('@ethersproject/providers', () => {
const originalModule = jest.requireActual('@ethersproject/providers');
jest.mock('viem/actions', () => ({
__esModule: true,
getEnsAddress: jest.fn(),
getEnsName: jest.fn(),
}));

return {
__esModule: true,
...originalModule,
};
});
const getEnsNameMock = jest.mocked(getEnsName);
const getEnsAddressMock = jest.mocked(getEnsAddress);

type AllEnsControllerActions = MessengerActions<EnsControllerMessenger>;

Expand Down Expand Up @@ -135,15 +135,6 @@ function getEnsControllerMessenger(
return ensControllerMessenger;
}

/**
* Creates a mock provider.
*
* @returns mock provider
*/
function getProvider() {
return () => Promise.resolve(null);
}

describe('EnsController', () => {
it('should set default state', () => {
const rootMessenger = getRootMessenger();
Expand All @@ -154,15 +145,15 @@ describe('EnsController', () => {
expect(controller.state).toStrictEqual(defaultState);
});

it('should return registry address for `.`', () => {
it('should return universal resolver address for `.`', () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const controller = new EnsController({
messenger: ensControllerMessenger,
});
expect(controller.get('0x1', '.')).toStrictEqual({
ensName: '.',
address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
address: '0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe',
chainId: '0x1',
});
});
Expand Down Expand Up @@ -579,12 +570,8 @@ describe('EnsController', () => {
it('should only resolve an ENS name once', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const ethProvider = new providersModule.Web3Provider(getProvider());
jest.spyOn(ethProvider, 'resolveName').mockResolvedValue(address1);
jest
.spyOn(ethProvider, 'lookupAddress')
.mockResolvedValue('peaksignal.eth');
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsAddressMock.mockResolvedValue(address1);
getEnsNameMock.mockResolvedValue('peaksignal.eth');

const ens = new EnsController({
messenger: ensControllerMessenger,
Expand All @@ -598,14 +585,13 @@ describe('EnsController', () => {

expect(await ens.reverseResolveAddress(address1)).toBe('peaksignal.eth');
expect(await ens.reverseResolveAddress(address1)).toBe('peaksignal.eth');
expect(getEnsNameMock).toHaveBeenCalledTimes(1);
});

it('should fail if lookupAddress through an error', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const ethProvider = new providersModule.Web3Provider(getProvider());
jest.spyOn(ethProvider, 'lookupAddress').mockRejectedValue('error');
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsNameMock.mockRejectedValue(new Error('error'));
const ens = new EnsController({
messenger: ensControllerMessenger,
onNetworkDidChange: (listener) => {
Expand All @@ -622,9 +608,7 @@ describe('EnsController', () => {
it('should fail if lookupAddress returns a null value', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const ethProvider = new providersModule.Web3Provider(getProvider());
jest.spyOn(ethProvider, 'lookupAddress').mockResolvedValue(null);
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsNameMock.mockResolvedValue(null);
const ens = new EnsController({
messenger: ensControllerMessenger,
onNetworkDidChange: (listener) => {
Expand All @@ -641,12 +625,8 @@ describe('EnsController', () => {
it('should fail if resolveName through an error', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const ethProvider = new providersModule.Web3Provider(getProvider());
jest
.spyOn(ethProvider, 'lookupAddress')
.mockResolvedValue('peaksignal.eth');
jest.spyOn(ethProvider, 'resolveName').mockRejectedValue('error');
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsNameMock.mockResolvedValue('peaksignal.eth');
getEnsAddressMock.mockRejectedValue(new Error('error'));
const ens = new EnsController({
messenger: ensControllerMessenger,
onNetworkDidChange: (listener) => {
Expand All @@ -663,12 +643,8 @@ describe('EnsController', () => {
it('should fail if resolveName returns a null value', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const ethProvider = new providersModule.Web3Provider(getProvider());
jest.spyOn(ethProvider, 'resolveName').mockResolvedValue(null);
jest
.spyOn(ethProvider, 'lookupAddress')
.mockResolvedValue('peaksignal.eth');
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsNameMock.mockResolvedValue('peaksignal.eth');
getEnsAddressMock.mockResolvedValue(null);
const ens = new EnsController({
messenger: ensControllerMessenger,
onNetworkDidChange: (listener) => {
Expand All @@ -685,14 +661,8 @@ describe('EnsController', () => {
it('should fail if registred address is zero x error address', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);
const ethProvider = new providersModule.Web3Provider(getProvider());
jest
.spyOn(ethProvider, 'resolveName')
.mockResolvedValue(ZERO_X_ERROR_ADDRESS);
jest
.spyOn(ethProvider, 'lookupAddress')
.mockResolvedValue('peaksignal.eth');
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsNameMock.mockResolvedValue('peaksignal.eth');
getEnsAddressMock.mockResolvedValue(ZERO_X_ERROR_ADDRESS);
const ens = new EnsController({
messenger: ensControllerMessenger,
onNetworkDidChange: (listener) => {
Expand All @@ -709,13 +679,8 @@ describe('EnsController', () => {
it('should fail if the name is registered to a different address than the reverse resolved', async () => {
const rootMessenger = getRootMessenger();
const ensControllerMessenger = getEnsControllerMessenger(rootMessenger);

const ethProvider = new providersModule.Web3Provider(getProvider());
jest.spyOn(ethProvider, 'resolveName').mockResolvedValue(address2);
jest
.spyOn(ethProvider, 'lookupAddress')
.mockResolvedValue('peaksignal.eth');
jest.spyOn(providersModule, 'Web3Provider').mockReturnValue(ethProvider);
getEnsNameMock.mockResolvedValue('peaksignal.eth');
getEnsAddressMock.mockResolvedValue(address2);
const ens = new EnsController({
messenger: ensControllerMessenger,
onNetworkDidChange: (listener) => {
Expand All @@ -728,6 +693,34 @@ describe('EnsController', () => {

expect(await ens.reverseResolveAddress(address1)).toBeUndefined();
});

it('should return undefined on a chain without a known universal resolver', async () => {
const rootMessenger = getRootMessenger();
const getNetworkClientById = buildMockGetNetworkClientById({
'AAAA-AAAA-AAAA-AAAA': buildCustomNetworkClientConfiguration({
chainId: '0x2105',
}),
});
const ensControllerMessenger = getEnsControllerMessenger(
rootMessenger,
getNetworkClientById,
);
const ens = new EnsController({
messenger: ensControllerMessenger,
registriesByChainId: {
8453: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376',
},
onNetworkDidChange: (listener): void => {
listener({
...getDefaultNetworkControllerState(),
selectedNetworkClientId: 'AAAA-AAAA-AAAA-AAAA',
});
},
});

expect(await ens.reverseResolveAddress(address1)).toBeUndefined();
expect(getEnsNameMock).not.toHaveBeenCalled();
});
});

describe('metadata', () => {
Expand Down Expand Up @@ -765,42 +758,14 @@ describe('EnsController', () => {
"ensEntries": {
"0x1": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"address": "0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe",
"chainId": "0x1",
"ensName": ".",
},
},
"0x3": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x3",
"ensName": ".",
},
},
"0x4": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x4",
"ensName": ".",
},
},
"0x4268": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x4268",
"ensName": ".",
},
},
"0x5": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x5",
"ensName": ".",
},
},
"0xaa36a7": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"address": "0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe",
"chainId": "0xaa36a7",
"ensName": ".",
},
Expand Down Expand Up @@ -829,42 +794,14 @@ describe('EnsController', () => {
"ensEntries": {
"0x1": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"address": "0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe",
"chainId": "0x1",
"ensName": ".",
},
},
"0x3": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x3",
"ensName": ".",
},
},
"0x4": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x4",
"ensName": ".",
},
},
"0x4268": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x4268",
"ensName": ".",
},
},
"0x5": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x5",
"ensName": ".",
},
},
"0xaa36a7": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"address": "0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe",
"chainId": "0xaa36a7",
"ensName": ".",
},
Expand Down Expand Up @@ -893,42 +830,14 @@ describe('EnsController', () => {
"ensEntries": {
"0x1": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"address": "0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe",
"chainId": "0x1",
"ensName": ".",
},
},
"0x3": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x3",
"ensName": ".",
},
},
"0x4": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x4",
"ensName": ".",
},
},
"0x4268": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x4268",
"ensName": ".",
},
},
"0x5": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"chainId": "0x5",
"ensName": ".",
},
},
"0xaa36a7": {
".": {
"address": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
"address": "0xeEeEEEeE14D718C2B47D9923Deab1335E144EeEe",
"chainId": "0xaa36a7",
"ensName": ".",
},
Expand Down
Loading