@metamask/ens-controller 13.0.1 → 14.0.1

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.
@@ -1,11 +1,259 @@
1
- import {
2
- DEFAULT_ENS_NETWORK_MAP,
3
- EnsController,
4
- EnsController_default
5
- } from "./chunk-QYSGUYCU.mjs";
6
- export {
7
- DEFAULT_ENS_NETWORK_MAP,
8
- EnsController,
9
- EnsController_default as default
1
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
+ 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");
4
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
10
5
  };
6
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
7
+ if (kind === "m") throw new TypeError("Private method is not writable");
8
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
9
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
10
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
11
+ };
12
+ var _EnsController_instances, _EnsController_ethProvider, _EnsController_setDefaultEthProvider, _EnsController_setEthProvider, _EnsController_getChainEnsSupport;
13
+ import { Web3Provider } from "@ethersproject/providers";
14
+ import { BaseController } from "@metamask/base-controller";
15
+ import { normalizeEnsName, isValidHexAddress, isSafeDynamicKey, toChecksumHexAddress, CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP, convertHexToDecimal, toHex } from "@metamask/controller-utils";
16
+ import { createProjectLogger } from "@metamask/utils";
17
+ import $punycodepunycodejs from "punycode/punycode.js";
18
+ const { toASCII } = $punycodepunycodejs;
19
+ const log = createProjectLogger('ens-controller');
20
+ const name = 'EnsController';
21
+ // Map of chainIDs and ENS registry contract addresses
22
+ export const DEFAULT_ENS_NETWORK_MAP = {
23
+ // Mainnet
24
+ 1: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
25
+ // Ropsten
26
+ 3: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
27
+ // Rinkeby
28
+ 4: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
29
+ // Goerli
30
+ 5: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
31
+ // Holesky
32
+ 17000: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
33
+ // Sepolia
34
+ 11155111: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
35
+ };
36
+ const metadata = {
37
+ ensEntries: { persist: true, anonymous: false },
38
+ ensResolutionsByAddress: { persist: true, anonymous: false },
39
+ };
40
+ const defaultState = {
41
+ ensEntries: {},
42
+ ensResolutionsByAddress: {},
43
+ };
44
+ const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';
45
+ const ZERO_X_ERROR_ADDRESS = '0x';
46
+ /**
47
+ * Controller that manages a list ENS names and their resolved addresses
48
+ * by chainId. A null address indicates an unresolved ENS name.
49
+ */
50
+ export class EnsController extends BaseController {
51
+ /**
52
+ * Creates an EnsController instance.
53
+ *
54
+ * @param options - Constructor options.
55
+ * @param options.registriesByChainId - Map between chain IDs and ENS contract addresses.
56
+ * @param options.messenger - A reference to the messaging system.
57
+ * @param options.state - Initial state to set on this controller.
58
+ * @param options.onNetworkDidChange - Allows subscribing to network controller networkDidChange events.
59
+ */
60
+ constructor({ registriesByChainId = DEFAULT_ENS_NETWORK_MAP, messenger, state = {}, onNetworkDidChange, }) {
61
+ super({
62
+ name,
63
+ metadata,
64
+ messenger,
65
+ state: {
66
+ ...defaultState,
67
+ ensEntries: Object.fromEntries(Object.entries(registriesByChainId).map(([chainId, address]) => [
68
+ toHex(chainId),
69
+ {
70
+ '.': {
71
+ address,
72
+ chainId: toHex(chainId),
73
+ ensName: '.',
74
+ },
75
+ },
76
+ ])),
77
+ ...state,
78
+ },
79
+ });
80
+ _EnsController_instances.add(this);
81
+ _EnsController_ethProvider.set(this, null);
82
+ __classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_setDefaultEthProvider).call(this, registriesByChainId);
83
+ if (onNetworkDidChange) {
84
+ onNetworkDidChange(({ selectedNetworkClientId }) => {
85
+ this.resetState();
86
+ __classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_setEthProvider).call(this, selectedNetworkClientId, registriesByChainId);
87
+ });
88
+ }
89
+ }
90
+ /**
91
+ * Clears ensResolutionsByAddress state property.
92
+ */
93
+ resetState() {
94
+ this.update((currentState) => {
95
+ currentState.ensResolutionsByAddress = {};
96
+ });
97
+ }
98
+ /**
99
+ * Remove all chain Ids and ENS entries from state.
100
+ */
101
+ clear() {
102
+ this.update((state) => {
103
+ state.ensEntries = {};
104
+ });
105
+ }
106
+ /**
107
+ * Delete an ENS entry.
108
+ *
109
+ * @param chainId - Parent chain of the ENS entry to delete.
110
+ * @param ensName - Name of the ENS entry to delete.
111
+ * @returns Boolean indicating if the entry was deleted.
112
+ */
113
+ delete(chainId, ensName) {
114
+ const normalizedEnsName = normalizeEnsName(ensName);
115
+ if (!isSafeDynamicKey(chainId) ||
116
+ !normalizedEnsName ||
117
+ !this.state.ensEntries[chainId] ||
118
+ !this.state.ensEntries[chainId][normalizedEnsName]) {
119
+ return false;
120
+ }
121
+ this.update((state) => {
122
+ delete state.ensEntries[chainId][normalizedEnsName];
123
+ if (Object.keys(state.ensEntries[chainId]).length === 0) {
124
+ delete state.ensEntries[chainId];
125
+ }
126
+ });
127
+ return true;
128
+ }
129
+ /**
130
+ * Retrieve a DNS entry.
131
+ *
132
+ * @param chainId - Parent chain of the ENS entry to retrieve.
133
+ * @param ensName - Name of the ENS entry to retrieve.
134
+ * @returns The EnsEntry or null if it does not exist.
135
+ */
136
+ get(chainId, ensName) {
137
+ const normalizedEnsName = normalizeEnsName(ensName);
138
+ // TODO Explicitly handle the case where `normalizedEnsName` is `null`
139
+ // eslint-disable-next-line no-implicit-coercion
140
+ return !!normalizedEnsName && this.state.ensEntries[chainId]
141
+ ? this.state.ensEntries[chainId][normalizedEnsName] || null
142
+ : null;
143
+ }
144
+ /**
145
+ * Add or update an ENS entry by chainId and ensName.
146
+ *
147
+ * A null address indicates that the ENS name does not resolve.
148
+ *
149
+ * @param chainId - Id of the associated chain.
150
+ * @param ensName - The ENS name.
151
+ * @param address - Associated address (or null) to add or update.
152
+ * @returns Boolean indicating if the entry was set.
153
+ */
154
+ set(chainId, ensName, address) {
155
+ if (!Number.isInteger(Number.parseInt(chainId, 10)) ||
156
+ !ensName ||
157
+ typeof ensName !== 'string' ||
158
+ (address && !isValidHexAddress(address))) {
159
+ throw new Error(
160
+ // TODO: Either fix this lint violation or explain why it's necessary to ignore.
161
+ // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
162
+ `Invalid ENS entry: { chainId:${chainId}, ensName:${ensName}, address:${address}}`);
163
+ }
164
+ const normalizedEnsName = normalizeEnsName(ensName);
165
+ if (!normalizedEnsName) {
166
+ throw new Error(`Invalid ENS name: ${ensName}`);
167
+ }
168
+ const normalizedAddress = address ? toChecksumHexAddress(address) : null;
169
+ const subState = this.state.ensEntries[chainId];
170
+ if (subState?.[normalizedEnsName] &&
171
+ subState[normalizedEnsName].address === normalizedAddress) {
172
+ return false;
173
+ }
174
+ this.update((state) => {
175
+ state.ensEntries = {
176
+ ...this.state.ensEntries,
177
+ [chainId]: {
178
+ ...this.state.ensEntries[chainId],
179
+ [normalizedEnsName]: {
180
+ address: normalizedAddress,
181
+ chainId,
182
+ ensName: normalizedEnsName,
183
+ },
184
+ },
185
+ };
186
+ });
187
+ return true;
188
+ }
189
+ /**
190
+ * Resolve ens by address.
191
+ *
192
+ * @param nonChecksummedAddress - address
193
+ * @returns ens resolution
194
+ */
195
+ async reverseResolveAddress(nonChecksummedAddress) {
196
+ if (!__classPrivateFieldGet(this, _EnsController_ethProvider, "f")) {
197
+ return undefined;
198
+ }
199
+ const address = toChecksumHexAddress(nonChecksummedAddress);
200
+ if (this.state.ensResolutionsByAddress[address]) {
201
+ return this.state.ensResolutionsByAddress[address];
202
+ }
203
+ let domain;
204
+ try {
205
+ domain = await __classPrivateFieldGet(this, _EnsController_ethProvider, "f").lookupAddress(address);
206
+ }
207
+ catch (error) {
208
+ log(error);
209
+ return undefined;
210
+ }
211
+ if (!domain) {
212
+ return undefined;
213
+ }
214
+ let registeredAddress;
215
+ try {
216
+ registeredAddress = await __classPrivateFieldGet(this, _EnsController_ethProvider, "f").resolveName(domain);
217
+ }
218
+ catch (error) {
219
+ log(error);
220
+ return undefined;
221
+ }
222
+ if (!registeredAddress) {
223
+ return undefined;
224
+ }
225
+ if (registeredAddress === ZERO_ADDRESS ||
226
+ registeredAddress === ZERO_X_ERROR_ADDRESS) {
227
+ return undefined;
228
+ }
229
+ if (toChecksumHexAddress(registeredAddress) !== address) {
230
+ return undefined;
231
+ }
232
+ this.update((state) => {
233
+ state.ensResolutionsByAddress[address] = toASCII(domain);
234
+ });
235
+ return domain;
236
+ }
237
+ }
238
+ _EnsController_ethProvider = new WeakMap(), _EnsController_instances = new WeakSet(), _EnsController_setDefaultEthProvider = function _EnsController_setDefaultEthProvider(registriesByChainId) {
239
+ const { selectedNetworkClientId } = this.messagingSystem.call('NetworkController:getState');
240
+ __classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_setEthProvider).call(this, selectedNetworkClientId, registriesByChainId);
241
+ }, _EnsController_setEthProvider = function _EnsController_setEthProvider(selectedNetworkClientId, registriesByChainId) {
242
+ const { configuration: { chainId: currentChainId }, provider, } = this.messagingSystem.call('NetworkController:getNetworkClientById', selectedNetworkClientId);
243
+ if (registriesByChainId &&
244
+ registriesByChainId[parseInt(currentChainId, 16)] &&
245
+ __classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_getChainEnsSupport).call(this, currentChainId)) {
246
+ __classPrivateFieldSet(this, _EnsController_ethProvider, new Web3Provider(provider, {
247
+ chainId: convertHexToDecimal(currentChainId),
248
+ name: CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP[currentChainId],
249
+ ensAddress: registriesByChainId[parseInt(currentChainId, 16)],
250
+ }), "f");
251
+ }
252
+ else {
253
+ __classPrivateFieldSet(this, _EnsController_ethProvider, null, "f");
254
+ }
255
+ }, _EnsController_getChainEnsSupport = function _EnsController_getChainEnsSupport(chainId) {
256
+ return Boolean(this.state.ensEntries[chainId]);
257
+ };
258
+ export default EnsController;
11
259
  //# sourceMappingURL=EnsController.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
1
+ {"version":3,"file":"EnsController.mjs","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAExD,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,mCAAmC,EACnC,mBAAmB,EACnB,KAAK,EACN,mCAAmC;AAOpC,OAAO,EAAE,mBAAmB,EAAE,wBAAwB;;;AAGtD,MAAM,GAAG,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;AAElD,MAAM,IAAI,GAAG,eAAe,CAAC;AAE7B,sDAAsD;AACtD,MAAM,CAAC,MAAM,uBAAuB,GAAwB;IAC1D,UAAU;IACV,CAAC,EAAE,4CAA4C;IAC/C,UAAU;IACV,CAAC,EAAE,4CAA4C;IAC/C,UAAU;IACV,CAAC,EAAE,4CAA4C;IAC/C,SAAS;IACT,CAAC,EAAE,4CAA4C;IAC/C,UAAU;IACV,KAAK,EAAE,4CAA4C;IACnD,UAAU;IACV,QAAQ,EAAE,4CAA4C;CACvD,CAAC;AA2CF,MAAM,QAAQ,GAAG;IACf,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC/C,uBAAuB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;CAC7D,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,UAAU,EAAE,EAAE;IACd,uBAAuB,EAAE,EAAE;CAC5B,CAAC;AAEF,MAAM,YAAY,GAAG,4CAA4C,CAAC;AAClE,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAElC;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,cAIlC;IAGC;;;;;;;;OAQG;IACH,YAAY,EACV,mBAAmB,GAAG,uBAAuB,EAC7C,SAAS,EACT,KAAK,GAAG,EAAE,EACV,kBAAkB,GAQnB;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,YAAY;gBACf,UAAU,EAAE,MAAM,CAAC,WAAW,CAC5B,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC;oBAC9D,KAAK,CAAC,OAAO,CAAC;oBACd;wBACE,GAAG,EAAE;4BACH,OAAO;4BACP,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;4BACvB,OAAO,EAAE,GAAG;yBACb;qBACF;iBACF,CAAC,CACH;gBACD,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA5CL,qCAAoC,IAAI,EAAC;QA8CvC,uBAAA,IAAI,sEAAuB,MAA3B,IAAI,EAAwB,mBAAmB,CAAC,CAAC;QAEjD,IAAI,kBAAkB,EAAE;YACtB,kBAAkB,CAAC,CAAC,EAAE,uBAAuB,EAAE,EAAE,EAAE;gBACjD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,uBAAA,IAAI,+DAAgB,MAApB,IAAI,EAAiB,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3B,YAAY,CAAC,uBAAuB,GAAG,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAY,EAAE,OAAe;QAClC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpD,IACE,CAAC,gBAAgB,CAAC,OAAO,CAAC;YAC1B,CAAC,iBAAiB;YAClB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YAC/B,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,EAClD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,CAAC;YAEpD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvD,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,OAAY,EAAE,OAAe;QAC/B,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAEpD,sEAAsE;QACtE,gDAAgD;QAChD,OAAO,CAAC,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,IAAI,IAAI;YAC3D,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,OAAY,EAAE,OAAe,EAAE,OAAsB;QACvD,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC/C,CAAC,OAAO;YACR,OAAO,OAAO,KAAK,QAAQ;YAC3B,CAAC,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EACxC;YACA,MAAM,IAAI,KAAK;YACb,gFAAgF;YAChF,4EAA4E;YAC5E,gCAAgC,OAAO,aAAa,OAAO,aAAa,OAAO,GAAG,CACnF,CAAC;SACH;QAED,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC;SACjD;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,IACE,QAAQ,EAAE,CAAC,iBAAiB,CAAC;YAC7B,QAAQ,CAAC,iBAAiB,CAAC,CAAC,OAAO,KAAK,iBAAiB,EACzD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,UAAU,GAAG;gBACjB,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU;gBACxB,CAAC,OAAO,CAAC,EAAE;oBACT,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;oBACjC,CAAC,iBAAiB,CAAC,EAAE;wBACnB,OAAO,EAAE,iBAAiB;wBAC1B,OAAO;wBACP,OAAO,EAAE,iBAAiB;qBAC3B;iBACF;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IA8CD;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CAAC,qBAA6B;QACvD,IAAI,CAAC,uBAAA,IAAI,kCAAa,EAAE;YACtB,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,OAAO,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,EAAE;YAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;SACpD;QAED,IAAI,MAAqB,CAAC;QAC1B,IAAI;YACF,MAAM,GAAG,MAAM,uBAAA,IAAI,kCAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;SACzD;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,KAAK,CAAC,CAAC;YACX,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,iBAAgC,CAAC;QACrC,IAAI;YACF,iBAAiB,GAAG,MAAM,uBAAA,IAAI,kCAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;SACjE;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,KAAK,CAAC,CAAC;YACX,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,CAAC,iBAAiB,EAAE;YACtB,OAAO,SAAS,CAAC;SAClB;QAED,IACE,iBAAiB,KAAK,YAAY;YAClC,iBAAiB,KAAK,oBAAoB,EAC1C;YACA,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,oBAAoB,CAAC,iBAAiB,CAAC,KAAK,OAAO,EAAE;YACvD,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAgB,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;2KApGwB,mBAAyC;IAC9D,MAAM,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3D,4BAA4B,CAC7B,CAAC;IACF,uBAAA,IAAI,+DAAgB,MAApB,IAAI,EAAiB,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;AACrE,CAAC,yEAGC,uBAA+B,EAC/B,mBAAyC;IAEzC,MAAM,EACJ,aAAa,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,EAC1C,QAAQ,GACT,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3B,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IAEF,IACE,mBAAmB;QACnB,mBAAmB,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QACjD,uBAAA,IAAI,mEAAoB,MAAxB,IAAI,EAAqB,cAAc,CAAC,EACxC;QACA,uBAAA,IAAI,8BAAgB,IAAI,YAAY,CAAC,QAAQ,EAAE;YAC7C,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC;YAC5C,IAAI,EAAE,mCAAmC,CAAC,cAAyB,CAAC;YACpE,UAAU,EAAE,mBAAmB,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;SAC9D,CAAC,MAAA,CAAC;KACJ;SAAM;QACL,uBAAA,IAAI,8BAAgB,IAAI,MAAA,CAAC;KAC1B;AACH,CAAC,iFAQmB,OAAY;IAC9B,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AACjD,CAAC;AA4DH,eAAe,aAAa,CAAC","sourcesContent":["import { Web3Provider } from '@ethersproject/providers';\nimport type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { ChainId } from '@metamask/controller-utils';\nimport {\n normalizeEnsName,\n isValidHexAddress,\n isSafeDynamicKey,\n toChecksumHexAddress,\n CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP,\n convertHexToDecimal,\n toHex,\n} from '@metamask/controller-utils';\nimport type {\n NetworkControllerGetNetworkClientByIdAction,\n NetworkControllerGetStateAction,\n NetworkState,\n} from '@metamask/network-controller';\nimport type { Hex } from '@metamask/utils';\nimport { createProjectLogger } from '@metamask/utils';\nimport { toASCII } from 'punycode/punycode.js';\n\nconst log = createProjectLogger('ens-controller');\n\nconst name = 'EnsController';\n\n// Map of chainIDs and ENS registry contract addresses\nexport const DEFAULT_ENS_NETWORK_MAP: Record<number, Hex> = {\n // Mainnet\n 1: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',\n // Ropsten\n 3: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',\n // Rinkeby\n 4: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',\n // Goerli\n 5: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',\n // Holesky\n 17000: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',\n // Sepolia\n 11155111: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',\n};\n\n/**\n * @type EnsEntry\n *\n * ENS entry representation\n * @property chainId - Id of the associated chain\n * @property ensName - The ENS name\n * @property address - Hex address with the ENS name, or null\n */\nexport type EnsEntry = {\n chainId: Hex;\n ensName: string;\n address: string | null;\n};\n\n/**\n * @type EnsControllerState\n *\n * ENS controller state\n * @property ensEntries - Object of ENS entry objects\n */\nexport type EnsControllerState = {\n ensEntries: {\n [chainId: Hex]: {\n [ensName: string]: EnsEntry;\n };\n };\n ensResolutionsByAddress: { [key: string]: string };\n};\n\nexport type AllowedActions =\n | NetworkControllerGetNetworkClientByIdAction\n | NetworkControllerGetStateAction;\n\nexport type EnsControllerMessenger = RestrictedControllerMessenger<\n typeof name,\n AllowedActions,\n never,\n AllowedActions['type'],\n never\n>;\n\nconst metadata = {\n ensEntries: { persist: true, anonymous: false },\n ensResolutionsByAddress: { persist: true, anonymous: false },\n};\n\nconst defaultState = {\n ensEntries: {},\n ensResolutionsByAddress: {},\n};\n\nconst ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';\nconst ZERO_X_ERROR_ADDRESS = '0x';\n\n/**\n * Controller that manages a list ENS names and their resolved addresses\n * by chainId. A null address indicates an unresolved ENS name.\n */\nexport class EnsController extends BaseController<\n typeof name,\n EnsControllerState,\n EnsControllerMessenger\n> {\n #ethProvider: Web3Provider | null = null;\n\n /**\n * Creates an EnsController instance.\n *\n * @param options - Constructor options.\n * @param options.registriesByChainId - Map between chain IDs and ENS contract addresses.\n * @param options.messenger - A reference to the messaging system.\n * @param options.state - Initial state to set on this controller.\n * @param options.onNetworkDidChange - Allows subscribing to network controller networkDidChange events.\n */\n constructor({\n registriesByChainId = DEFAULT_ENS_NETWORK_MAP,\n messenger,\n state = {},\n onNetworkDidChange,\n }: {\n registriesByChainId?: Record<number, Hex>;\n messenger: EnsControllerMessenger;\n state?: Partial<EnsControllerState>;\n onNetworkDidChange?: (\n listener: (networkState: NetworkState) => void,\n ) => void;\n }) {\n super({\n name,\n metadata,\n messenger,\n state: {\n ...defaultState,\n ensEntries: Object.fromEntries(\n Object.entries(registriesByChainId).map(([chainId, address]) => [\n toHex(chainId),\n {\n '.': {\n address,\n chainId: toHex(chainId),\n ensName: '.',\n },\n },\n ]),\n ),\n ...state,\n },\n });\n\n this.#setDefaultEthProvider(registriesByChainId);\n\n if (onNetworkDidChange) {\n onNetworkDidChange(({ selectedNetworkClientId }) => {\n this.resetState();\n this.#setEthProvider(selectedNetworkClientId, registriesByChainId);\n });\n }\n }\n\n /**\n * Clears ensResolutionsByAddress state property.\n */\n resetState() {\n this.update((currentState) => {\n currentState.ensResolutionsByAddress = {};\n });\n }\n\n /**\n * Remove all chain Ids and ENS entries from state.\n */\n clear() {\n this.update((state) => {\n state.ensEntries = {};\n });\n }\n\n /**\n * Delete an ENS entry.\n *\n * @param chainId - Parent chain of the ENS entry to delete.\n * @param ensName - Name of the ENS entry to delete.\n * @returns Boolean indicating if the entry was deleted.\n */\n delete(chainId: Hex, ensName: string): boolean {\n const normalizedEnsName = normalizeEnsName(ensName);\n if (\n !isSafeDynamicKey(chainId) ||\n !normalizedEnsName ||\n !this.state.ensEntries[chainId] ||\n !this.state.ensEntries[chainId][normalizedEnsName]\n ) {\n return false;\n }\n\n this.update((state) => {\n delete state.ensEntries[chainId][normalizedEnsName];\n\n if (Object.keys(state.ensEntries[chainId]).length === 0) {\n delete state.ensEntries[chainId];\n }\n });\n return true;\n }\n\n /**\n * Retrieve a DNS entry.\n *\n * @param chainId - Parent chain of the ENS entry to retrieve.\n * @param ensName - Name of the ENS entry to retrieve.\n * @returns The EnsEntry or null if it does not exist.\n */\n get(chainId: Hex, ensName: string): EnsEntry | null {\n const normalizedEnsName = normalizeEnsName(ensName);\n\n // TODO Explicitly handle the case where `normalizedEnsName` is `null`\n // eslint-disable-next-line no-implicit-coercion\n return !!normalizedEnsName && this.state.ensEntries[chainId]\n ? this.state.ensEntries[chainId][normalizedEnsName] || null\n : null;\n }\n\n /**\n * Add or update an ENS entry by chainId and ensName.\n *\n * A null address indicates that the ENS name does not resolve.\n *\n * @param chainId - Id of the associated chain.\n * @param ensName - The ENS name.\n * @param address - Associated address (or null) to add or update.\n * @returns Boolean indicating if the entry was set.\n */\n set(chainId: Hex, ensName: string, address: string | null): boolean {\n if (\n !Number.isInteger(Number.parseInt(chainId, 10)) ||\n !ensName ||\n typeof ensName !== 'string' ||\n (address && !isValidHexAddress(address))\n ) {\n throw new Error(\n // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n `Invalid ENS entry: { chainId:${chainId}, ensName:${ensName}, address:${address}}`,\n );\n }\n\n const normalizedEnsName = normalizeEnsName(ensName);\n if (!normalizedEnsName) {\n throw new Error(`Invalid ENS name: ${ensName}`);\n }\n\n const normalizedAddress = address ? toChecksumHexAddress(address) : null;\n const subState = this.state.ensEntries[chainId];\n\n if (\n subState?.[normalizedEnsName] &&\n subState[normalizedEnsName].address === normalizedAddress\n ) {\n return false;\n }\n\n this.update((state) => {\n state.ensEntries = {\n ...this.state.ensEntries,\n [chainId]: {\n ...this.state.ensEntries[chainId],\n [normalizedEnsName]: {\n address: normalizedAddress,\n chainId,\n ensName: normalizedEnsName,\n },\n },\n };\n });\n return true;\n }\n\n #setDefaultEthProvider(registriesByChainId?: Record<number, Hex>) {\n const { selectedNetworkClientId } = this.messagingSystem.call(\n 'NetworkController:getState',\n );\n this.#setEthProvider(selectedNetworkClientId, registriesByChainId);\n }\n\n #setEthProvider(\n selectedNetworkClientId: string,\n registriesByChainId?: Record<number, Hex>,\n ) {\n const {\n configuration: { chainId: currentChainId },\n provider,\n } = this.messagingSystem.call(\n 'NetworkController:getNetworkClientById',\n selectedNetworkClientId,\n );\n\n if (\n registriesByChainId &&\n registriesByChainId[parseInt(currentChainId, 16)] &&\n this.#getChainEnsSupport(currentChainId)\n ) {\n this.#ethProvider = new Web3Provider(provider, {\n chainId: convertHexToDecimal(currentChainId),\n name: CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP[currentChainId as ChainId],\n ensAddress: registriesByChainId[parseInt(currentChainId, 16)],\n });\n } else {\n this.#ethProvider = null;\n }\n }\n\n /**\n * Check if the chain supports ENS.\n *\n * @param chainId - chain id.\n * @returns Boolean indicating if the chain supports ENS.\n */\n #getChainEnsSupport(chainId: Hex) {\n return Boolean(this.state.ensEntries[chainId]);\n }\n\n /**\n * Resolve ens by address.\n *\n * @param nonChecksummedAddress - address\n * @returns ens resolution\n */\n async reverseResolveAddress(nonChecksummedAddress: string) {\n if (!this.#ethProvider) {\n return undefined;\n }\n\n const address = toChecksumHexAddress(nonChecksummedAddress);\n if (this.state.ensResolutionsByAddress[address]) {\n return this.state.ensResolutionsByAddress[address];\n }\n\n let domain: string | null;\n try {\n domain = await this.#ethProvider.lookupAddress(address);\n } catch (error) {\n log(error);\n return undefined;\n }\n\n if (!domain) {\n return undefined;\n }\n\n let registeredAddress: string | null;\n try {\n registeredAddress = await this.#ethProvider.resolveName(domain);\n } catch (error) {\n log(error);\n return undefined;\n }\n\n if (!registeredAddress) {\n return undefined;\n }\n\n if (\n registeredAddress === ZERO_ADDRESS ||\n registeredAddress === ZERO_X_ERROR_ADDRESS\n ) {\n return undefined;\n }\n if (toChecksumHexAddress(registeredAddress) !== address) {\n return undefined;\n }\n\n this.update((state) => {\n state.ensResolutionsByAddress[address] = toASCII(domain as string);\n });\n\n return domain;\n }\n}\n\nexport default EnsController;\n"]}
package/dist/index.cjs ADDED
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./EnsController.cjs"), exports);
18
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAgC","sourcesContent":["export * from './EnsController';\n"]}
@@ -0,0 +1,2 @@
1
+ export * from "./EnsController.cjs";
2
+ //# sourceMappingURL=index.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oCAAgC"}
@@ -0,0 +1,2 @@
1
+ export * from "./EnsController.mjs";
2
+ //# sourceMappingURL=index.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oCAAgC"}
package/dist/index.mjs CHANGED
@@ -1,9 +1,2 @@
1
- import {
2
- DEFAULT_ENS_NETWORK_MAP,
3
- EnsController
4
- } from "./chunk-QYSGUYCU.mjs";
5
- export {
6
- DEFAULT_ENS_NETWORK_MAP,
7
- EnsController
8
- };
1
+ export * from "./EnsController.mjs";
9
2
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oCAAgC","sourcesContent":["export * from './EnsController';\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/ens-controller",
3
- "version": "13.0.1",
3
+ "version": "14.0.1",
4
4
  "description": "Maps ENS names to their resolved addresses by chain id",
5
5
  "keywords": [
6
6
  "MetaMask",
@@ -18,23 +18,29 @@
18
18
  "sideEffects": false,
19
19
  "exports": {
20
20
  ".": {
21
- "import": "./dist/index.mjs",
22
- "require": "./dist/index.js",
23
- "types": "./dist/types/index.d.ts"
21
+ "import": {
22
+ "types": "./dist/index.d.mts",
23
+ "default": "./dist/index.mjs"
24
+ },
25
+ "require": {
26
+ "types": "./dist/index.d.cts",
27
+ "default": "./dist/index.cjs"
28
+ }
24
29
  },
25
30
  "./package.json": "./package.json"
26
31
  },
27
- "main": "./dist/index.js",
28
- "types": "./dist/types/index.d.ts",
32
+ "main": "./dist/index.cjs",
33
+ "types": "./dist/index.d.cts",
29
34
  "files": [
30
35
  "dist/"
31
36
  ],
32
37
  "scripts": {
33
- "build": "tsup --config ../../tsup.config.ts --tsconfig ./tsconfig.build.json --clean",
38
+ "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
34
39
  "build:docs": "typedoc",
35
40
  "changelog:update": "../../scripts/update-changelog.sh @metamask/ens-controller",
36
41
  "changelog:validate": "../../scripts/validate-changelog.sh @metamask/ens-controller",
37
42
  "publish:preview": "yarn npm publish --tag preview",
43
+ "since-latest-release": "../../scripts/since-latest-release.sh",
38
44
  "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
39
45
  "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
40
46
  "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
@@ -42,24 +48,24 @@
42
48
  },
43
49
  "dependencies": {
44
50
  "@ethersproject/providers": "^5.7.0",
45
- "@metamask/base-controller": "^6.0.2",
46
- "@metamask/controller-utils": "^11.0.2",
51
+ "@metamask/base-controller": "^7.0.1",
52
+ "@metamask/controller-utils": "^11.3.0",
47
53
  "@metamask/utils": "^9.1.0",
48
54
  "punycode": "^2.1.1"
49
55
  },
50
56
  "devDependencies": {
51
57
  "@metamask/auto-changelog": "^3.4.4",
52
- "@metamask/network-controller": "^20.1.0",
58
+ "@metamask/network-controller": "^21.0.1",
53
59
  "@types/jest": "^27.4.1",
54
60
  "deepmerge": "^4.2.2",
55
61
  "jest": "^27.5.1",
56
62
  "ts-jest": "^27.1.4",
57
63
  "typedoc": "^0.24.8",
58
64
  "typedoc-plugin-missing-exports": "^2.0.0",
59
- "typescript": "~5.0.4"
65
+ "typescript": "~5.2.2"
60
66
  },
61
67
  "peerDependencies": {
62
- "@metamask/network-controller": "^20.0.0"
68
+ "@metamask/network-controller": "^21.0.0"
63
69
  },
64
70
  "engines": {
65
71
  "node": "^18.18 || >=20"
@@ -1,11 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
-
3
-
4
-
5
- var _chunkBG4UCEGMjs = require('./chunk-BG4UCEGM.js');
6
-
7
-
8
-
9
-
10
- exports.DEFAULT_ENS_NETWORK_MAP = _chunkBG4UCEGMjs.DEFAULT_ENS_NETWORK_MAP; exports.EnsController = _chunkBG4UCEGMjs.EnsController; exports.default = _chunkBG4UCEGMjs.EnsController_default;
11
- //# sourceMappingURL=EnsController.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":[],"names":[],"mappings":""}