@metamask/ens-controller 2.0.0 → 3.1.0
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 +13 -2
- package/dist/EnsController.d.ts +43 -14
- package/dist/EnsController.d.ts.map +1 -0
- package/dist/EnsController.js +156 -21
- package/dist/EnsController.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -0
- package/package.json +9 -5
package/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
+
## [3.1.0]
|
|
10
|
+
### Changed
|
|
11
|
+
- Add support for reverse ENS address resolution ([#1170](https://github.com/MetaMask/core/pull/1170))
|
|
12
|
+
- This controller can now resolve a network address to an ENS address. This feature was ported from the extension ENS controller.
|
|
13
|
+
|
|
14
|
+
## [3.0.0]
|
|
15
|
+
### Changed
|
|
16
|
+
- **BREAKING:** Convert the ENS controller to the BaseController v2 API ([#1134](https://github.com/MetaMask/core/pull/1134))
|
|
17
|
+
|
|
9
18
|
## [2.0.0]
|
|
10
19
|
### Removed
|
|
11
20
|
- **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
|
|
@@ -14,7 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
14
23
|
## [1.0.2]
|
|
15
24
|
### Changed
|
|
16
25
|
- Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
|
|
17
|
-
- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041))
|
|
26
|
+
- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041))
|
|
18
27
|
|
|
19
28
|
## [1.0.1]
|
|
20
29
|
### Changed
|
|
@@ -29,7 +38,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
29
38
|
|
|
30
39
|
All changes listed after this point were applied to this package following the monorepo conversion.
|
|
31
40
|
|
|
32
|
-
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@
|
|
41
|
+
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@3.1.0...HEAD
|
|
42
|
+
[3.1.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@3.0.0...@metamask/ens-controller@3.1.0
|
|
43
|
+
[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@2.0.0...@metamask/ens-controller@3.0.0
|
|
33
44
|
[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@1.0.2...@metamask/ens-controller@2.0.0
|
|
34
45
|
[1.0.2]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@1.0.1...@metamask/ens-controller@1.0.2
|
|
35
46
|
[1.0.1]: https://github.com/MetaMask/core/compare/@metamask/ens-controller@1.0.0...@metamask/ens-controller@1.0.1
|
package/dist/EnsController.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { BaseControllerV2, RestrictedControllerMessenger } from '@metamask/base-controller';
|
|
2
|
+
import { ExternalProvider, JsonRpcFetchFunc } from '@ethersproject/providers';
|
|
3
|
+
declare const name = "EnsController";
|
|
2
4
|
/**
|
|
3
5
|
* @type EnsEntry
|
|
4
6
|
*
|
|
@@ -7,40 +9,59 @@ import { BaseController, BaseConfig, BaseState } from '@metamask/base-controller
|
|
|
7
9
|
* @property ensName - The ENS name
|
|
8
10
|
* @property address - Hex address with the ENS name, or null
|
|
9
11
|
*/
|
|
10
|
-
export
|
|
12
|
+
export declare type EnsEntry = {
|
|
11
13
|
chainId: string;
|
|
12
14
|
ensName: string;
|
|
13
15
|
address: string | null;
|
|
14
|
-
}
|
|
16
|
+
};
|
|
15
17
|
/**
|
|
16
|
-
* @type
|
|
18
|
+
* @type EnsControllerState
|
|
17
19
|
*
|
|
18
20
|
* ENS controller state
|
|
19
21
|
* @property ensEntries - Object of ENS entry objects
|
|
20
22
|
*/
|
|
21
|
-
export
|
|
23
|
+
export declare type EnsControllerState = {
|
|
22
24
|
ensEntries: {
|
|
23
25
|
[chainId: string]: {
|
|
24
26
|
[ensName: string]: EnsEntry;
|
|
25
27
|
};
|
|
26
28
|
};
|
|
27
|
-
|
|
29
|
+
ensResolutionsByAddress: {
|
|
30
|
+
[key: string]: string;
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export declare type EnsControllerMessenger = RestrictedControllerMessenger<typeof name, never, never, never, never>;
|
|
28
34
|
/**
|
|
29
35
|
* Controller that manages a list ENS names and their resolved addresses
|
|
30
36
|
* by chainId. A null address indicates an unresolved ENS name.
|
|
31
37
|
*/
|
|
32
|
-
export declare class EnsController extends
|
|
33
|
-
|
|
34
|
-
* Name of this controller used during composition
|
|
35
|
-
*/
|
|
36
|
-
name: string;
|
|
38
|
+
export declare class EnsController extends BaseControllerV2<typeof name, EnsControllerState, EnsControllerMessenger> {
|
|
39
|
+
#private;
|
|
37
40
|
/**
|
|
38
41
|
* Creates an EnsController instance.
|
|
39
42
|
*
|
|
40
|
-
* @param
|
|
41
|
-
* @param
|
|
43
|
+
* @param options - Constructor options.
|
|
44
|
+
* @param options.messenger - A reference to the messaging system.
|
|
45
|
+
* @param options.state - Initial state to set on this controller.
|
|
46
|
+
* @param options.provider - Provider instance.
|
|
47
|
+
* @param options.onNetworkStateChange - Allows registering an event handler for
|
|
48
|
+
* when the network controller state updated.
|
|
42
49
|
*/
|
|
43
|
-
constructor(
|
|
50
|
+
constructor({ messenger, state, provider, onNetworkStateChange, }: {
|
|
51
|
+
messenger: EnsControllerMessenger;
|
|
52
|
+
state?: Partial<EnsControllerState>;
|
|
53
|
+
provider?: ExternalProvider | JsonRpcFetchFunc;
|
|
54
|
+
onNetworkStateChange?: (listener: (networkState: {
|
|
55
|
+
network: string;
|
|
56
|
+
providerConfig: {
|
|
57
|
+
chainId: string;
|
|
58
|
+
};
|
|
59
|
+
}) => void) => void;
|
|
60
|
+
});
|
|
61
|
+
/**
|
|
62
|
+
* Clears ensResolutionsByAddress state property.
|
|
63
|
+
*/
|
|
64
|
+
resetState(): void;
|
|
44
65
|
/**
|
|
45
66
|
* Remove all chain Ids and ENS entries from state.
|
|
46
67
|
*/
|
|
@@ -72,5 +93,13 @@ export declare class EnsController extends BaseController<BaseConfig, EnsState>
|
|
|
72
93
|
* @returns Boolean indicating if the entry was set.
|
|
73
94
|
*/
|
|
74
95
|
set(chainId: string, ensName: string, address: string | null): boolean;
|
|
96
|
+
/**
|
|
97
|
+
* Resolve ens by address.
|
|
98
|
+
*
|
|
99
|
+
* @param nonChecksummedAddress - address
|
|
100
|
+
* @returns ens resolution
|
|
101
|
+
*/
|
|
102
|
+
reverseResolveAddress(nonChecksummedAddress: string): Promise<string | undefined>;
|
|
75
103
|
}
|
|
76
104
|
export default EnsController;
|
|
105
|
+
//# sourceMappingURL=EnsController.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EnsController.d.ts","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,0BAA0B,CAAC;AA8BlC,QAAA,MAAM,IAAI,kBAAkB,CAAC;AAE7B;;;;;;;GAOG;AACH,oBAAY,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,kBAAkB,GAAG;IAC/B,UAAU,EAAE;QACV,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC;SAC7B,CAAC;KACH,CAAC;IACF,uBAAuB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACpD,CAAC;AAEF,oBAAY,sBAAsB,GAAG,6BAA6B,CAChE,OAAO,IAAI,EACX,KAAK,EACL,KAAK,EACL,KAAK,EACL,KAAK,CACN,CAAC;AAeF;;;GAGG;AACH,qBAAa,aAAc,SAAQ,gBAAgB,CACjD,OAAO,IAAI,EACX,kBAAkB,EAClB,sBAAsB,CACvB;;IAGC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAU,EACV,QAAQ,EACR,oBAAoB,GACrB,EAAE;QACD,SAAS,EAAE,sBAAsB,CAAC;QAClC,KAAK,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACpC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;QAC/C,oBAAoB,CAAC,EAAE,CACrB,QAAQ,EAAE,CAAC,YAAY,EAAE;YACvB,OAAO,EAAE,MAAM,CAAC;YAChB,cAAc,EAAE;gBACd,OAAO,EAAE,MAAM,CAAC;aACjB,CAAC;SACH,KAAK,IAAI,KACP,IAAI,CAAC;KACX;IAgCD;;OAEG;IACH,UAAU;IAMV;;OAEG;IACH,KAAK;IAML;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAoBjD;;;;;;OAMG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAUtD;;;;;;;;;OASG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAqDtE;;;;;OAKG;IACG,qBAAqB,CAAC,qBAAqB,EAAE,MAAM;CAkD1D;AAED,eAAe,aAAa,CAAC"}
|
package/dist/EnsController.js
CHANGED
|
@@ -1,33 +1,115 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
12
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
13
|
+
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");
|
|
14
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
15
|
+
};
|
|
16
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
17
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
18
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
19
|
+
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");
|
|
20
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
21
|
+
};
|
|
22
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
23
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
24
|
+
};
|
|
25
|
+
var _EnsController_instances, _EnsController_ethProvider, _EnsController_getNetworkEnsSupport;
|
|
2
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
27
|
exports.EnsController = void 0;
|
|
4
28
|
const base_controller_1 = require("@metamask/base-controller");
|
|
29
|
+
const providers_1 = require("@ethersproject/providers");
|
|
30
|
+
const utils_1 = require("@metamask/utils");
|
|
5
31
|
const controller_utils_1 = require("@metamask/controller-utils");
|
|
32
|
+
const punycode_1 = require("punycode/");
|
|
33
|
+
const ethereum_ens_network_map_1 = __importDefault(require("ethereum-ens-network-map"));
|
|
34
|
+
const log = (0, utils_1.createProjectLogger)('ens-controller');
|
|
35
|
+
/**
|
|
36
|
+
* Checks whether the given string is a known network ID.
|
|
37
|
+
*
|
|
38
|
+
* @param networkId - Network id.
|
|
39
|
+
* @returns Boolean indicating if the network ID is recognized.
|
|
40
|
+
*/
|
|
41
|
+
function isKnownNetworkId(networkId) {
|
|
42
|
+
return (networkId !== null &&
|
|
43
|
+
(0, controller_utils_1.hasProperty)(controller_utils_1.NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP, networkId));
|
|
44
|
+
}
|
|
45
|
+
const name = 'EnsController';
|
|
46
|
+
const metadata = {
|
|
47
|
+
ensEntries: { persist: true, anonymous: false },
|
|
48
|
+
ensResolutionsByAddress: { persist: true, anonymous: false },
|
|
49
|
+
};
|
|
50
|
+
const defaultState = {
|
|
51
|
+
ensEntries: {},
|
|
52
|
+
ensResolutionsByAddress: {},
|
|
53
|
+
};
|
|
54
|
+
const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';
|
|
55
|
+
const ZERO_X_ERROR_ADDRESS = '0x';
|
|
6
56
|
/**
|
|
7
57
|
* Controller that manages a list ENS names and their resolved addresses
|
|
8
58
|
* by chainId. A null address indicates an unresolved ENS name.
|
|
9
59
|
*/
|
|
10
|
-
class EnsController extends base_controller_1.
|
|
60
|
+
class EnsController extends base_controller_1.BaseControllerV2 {
|
|
11
61
|
/**
|
|
12
62
|
* Creates an EnsController instance.
|
|
13
63
|
*
|
|
14
|
-
* @param
|
|
15
|
-
* @param
|
|
64
|
+
* @param options - Constructor options.
|
|
65
|
+
* @param options.messenger - A reference to the messaging system.
|
|
66
|
+
* @param options.state - Initial state to set on this controller.
|
|
67
|
+
* @param options.provider - Provider instance.
|
|
68
|
+
* @param options.onNetworkStateChange - Allows registering an event handler for
|
|
69
|
+
* when the network controller state updated.
|
|
16
70
|
*/
|
|
17
|
-
constructor(
|
|
18
|
-
super(
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
71
|
+
constructor({ messenger, state = {}, provider, onNetworkStateChange, }) {
|
|
72
|
+
super({
|
|
73
|
+
name,
|
|
74
|
+
metadata,
|
|
75
|
+
messenger,
|
|
76
|
+
state: Object.assign(Object.assign({}, defaultState), state),
|
|
77
|
+
});
|
|
78
|
+
_EnsController_instances.add(this);
|
|
79
|
+
_EnsController_ethProvider.set(this, null);
|
|
80
|
+
if (provider && onNetworkStateChange) {
|
|
81
|
+
onNetworkStateChange((networkState) => {
|
|
82
|
+
this.resetState();
|
|
83
|
+
const currentNetwork = networkState.network === 'loading' ? null : networkState.network;
|
|
84
|
+
if (isKnownNetworkId(currentNetwork) &&
|
|
85
|
+
__classPrivateFieldGet(this, _EnsController_instances, "m", _EnsController_getNetworkEnsSupport).call(this, currentNetwork)) {
|
|
86
|
+
__classPrivateFieldSet(this, _EnsController_ethProvider, new providers_1.Web3Provider(provider, {
|
|
87
|
+
chainId: (0, controller_utils_1.convertHexToDecimal)(networkState.providerConfig.chainId),
|
|
88
|
+
name: controller_utils_1.NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP[currentNetwork],
|
|
89
|
+
ensAddress: ethereum_ens_network_map_1.default[currentNetwork],
|
|
90
|
+
}), "f");
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
__classPrivateFieldSet(this, _EnsController_ethProvider, null, "f");
|
|
94
|
+
}
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Clears ensResolutionsByAddress state property.
|
|
100
|
+
*/
|
|
101
|
+
resetState() {
|
|
102
|
+
this.update((currentState) => {
|
|
103
|
+
currentState.ensResolutionsByAddress = {};
|
|
104
|
+
});
|
|
25
105
|
}
|
|
26
106
|
/**
|
|
27
107
|
* Remove all chain Ids and ENS entries from state.
|
|
28
108
|
*/
|
|
29
109
|
clear() {
|
|
30
|
-
this.update(
|
|
110
|
+
this.update((state) => {
|
|
111
|
+
state.ensEntries = {};
|
|
112
|
+
});
|
|
31
113
|
}
|
|
32
114
|
/**
|
|
33
115
|
* Delete an ENS entry.
|
|
@@ -43,12 +125,12 @@ class EnsController extends base_controller_1.BaseController {
|
|
|
43
125
|
!this.state.ensEntries[chainId][normalizedEnsName]) {
|
|
44
126
|
return false;
|
|
45
127
|
}
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
128
|
+
this.update((state) => {
|
|
129
|
+
delete state.ensEntries[chainId][normalizedEnsName];
|
|
130
|
+
if (Object.keys(state.ensEntries[chainId]).length === 0) {
|
|
131
|
+
delete state.ensEntries[chainId];
|
|
132
|
+
}
|
|
133
|
+
});
|
|
52
134
|
return true;
|
|
53
135
|
}
|
|
54
136
|
/**
|
|
@@ -93,16 +175,69 @@ class EnsController extends base_controller_1.BaseController {
|
|
|
93
175
|
subState[normalizedEnsName].address === normalizedAddress) {
|
|
94
176
|
return false;
|
|
95
177
|
}
|
|
96
|
-
this.update({
|
|
97
|
-
ensEntries
|
|
178
|
+
this.update((state) => {
|
|
179
|
+
state.ensEntries = Object.assign(Object.assign({}, this.state.ensEntries), { [chainId]: Object.assign(Object.assign({}, this.state.ensEntries[chainId]), { [normalizedEnsName]: {
|
|
98
180
|
address: normalizedAddress,
|
|
99
181
|
chainId,
|
|
100
182
|
ensName: normalizedEnsName,
|
|
101
|
-
} }) })
|
|
183
|
+
} }) });
|
|
102
184
|
});
|
|
103
185
|
return true;
|
|
104
186
|
}
|
|
187
|
+
/**
|
|
188
|
+
* Resolve ens by address.
|
|
189
|
+
*
|
|
190
|
+
* @param nonChecksummedAddress - address
|
|
191
|
+
* @returns ens resolution
|
|
192
|
+
*/
|
|
193
|
+
reverseResolveAddress(nonChecksummedAddress) {
|
|
194
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
195
|
+
if (!__classPrivateFieldGet(this, _EnsController_ethProvider, "f")) {
|
|
196
|
+
return undefined;
|
|
197
|
+
}
|
|
198
|
+
const address = (0, controller_utils_1.toChecksumHexAddress)(nonChecksummedAddress);
|
|
199
|
+
if (this.state.ensResolutionsByAddress[address]) {
|
|
200
|
+
return this.state.ensResolutionsByAddress[address];
|
|
201
|
+
}
|
|
202
|
+
let domain;
|
|
203
|
+
try {
|
|
204
|
+
domain = yield __classPrivateFieldGet(this, _EnsController_ethProvider, "f").lookupAddress(address);
|
|
205
|
+
}
|
|
206
|
+
catch (error) {
|
|
207
|
+
log(error);
|
|
208
|
+
return undefined;
|
|
209
|
+
}
|
|
210
|
+
if (!domain) {
|
|
211
|
+
return undefined;
|
|
212
|
+
}
|
|
213
|
+
let registeredAddress;
|
|
214
|
+
try {
|
|
215
|
+
registeredAddress = yield __classPrivateFieldGet(this, _EnsController_ethProvider, "f").resolveName(domain);
|
|
216
|
+
}
|
|
217
|
+
catch (error) {
|
|
218
|
+
log(error);
|
|
219
|
+
return undefined;
|
|
220
|
+
}
|
|
221
|
+
if (!registeredAddress) {
|
|
222
|
+
return undefined;
|
|
223
|
+
}
|
|
224
|
+
if (registeredAddress === ZERO_ADDRESS ||
|
|
225
|
+
registeredAddress === ZERO_X_ERROR_ADDRESS) {
|
|
226
|
+
return undefined;
|
|
227
|
+
}
|
|
228
|
+
if ((0, controller_utils_1.toChecksumHexAddress)(registeredAddress) !== address) {
|
|
229
|
+
return undefined;
|
|
230
|
+
}
|
|
231
|
+
this.update((state) => {
|
|
232
|
+
state.ensResolutionsByAddress[address] = (0, punycode_1.toASCII)(domain);
|
|
233
|
+
});
|
|
234
|
+
return domain;
|
|
235
|
+
});
|
|
236
|
+
}
|
|
105
237
|
}
|
|
106
238
|
exports.EnsController = EnsController;
|
|
239
|
+
_EnsController_ethProvider = new WeakMap(), _EnsController_instances = new WeakSet(), _EnsController_getNetworkEnsSupport = function _EnsController_getNetworkEnsSupport(networkId) {
|
|
240
|
+
return Boolean(ethereum_ens_network_map_1.default[networkId]);
|
|
241
|
+
};
|
|
107
242
|
exports.default = EnsController;
|
|
108
243
|
//# sourceMappingURL=EnsController.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EnsController.js","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":";;;AAAA,+DAImC;AACnC,iEAIoC;AA0BpC;;;GAGG;AACH,MAAa,aAAc,SAAQ,gCAAoC;IAMrE;;;;;OAKG;IACH,YAAY,MAA4B,EAAE,KAAyB;QACjE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAZvB;;WAEG;QACM,SAAI,GAAG,eAAe,CAAC;QAW9B,IAAI,CAAC,YAAY,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAEvC,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAe,EAAE,OAAe;QACrC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,IACE,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,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5D,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,CAAC;QAE9C,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YACjD,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC;SAC5B;QAED,IAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,OAAe,EAAE,OAAe;QAClC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,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,OAAe,EAAE,OAAe,EAAE,OAAsB;QAC1D,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,IAAA,oCAAiB,EAAC,OAAO,CAAC,CAAC,EACxC;YACA,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,aAAa,OAAO,aAAa,OAAO,GAAG,CACnF,CAAC;SACH;QAED,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,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,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,IACE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,iBAAiB,CAAC;YAC7B,QAAQ,CAAC,iBAAiB,CAAC,CAAC,OAAO,KAAK,iBAAiB,EACzD;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,CAAC,MAAM,CAAC;YACV,UAAU,kCACL,IAAI,CAAC,KAAK,CAAC,UAAU,KACxB,CAAC,OAAO,CAAC,kCACJ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,KACjC,CAAC,iBAAiB,CAAC,EAAE;wBACnB,OAAO,EAAE,iBAAiB;wBAC1B,OAAO;wBACP,OAAO,EAAE,iBAAiB;qBAC3B,MAEJ;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5HD,sCA4HC;AAED,kBAAe,aAAa,CAAC","sourcesContent":["import {\n BaseController,\n BaseConfig,\n BaseState,\n} from '@metamask/base-controller';\nimport {\n normalizeEnsName,\n isValidHexAddress,\n toChecksumHexAddress,\n} from '@metamask/controller-utils';\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 interface EnsEntry {\n chainId: string;\n ensName: string;\n address: string | null;\n}\n\n/**\n * @type EnsState\n *\n * ENS controller state\n * @property ensEntries - Object of ENS entry objects\n */\nexport interface EnsState extends BaseState {\n ensEntries: { [chainId: string]: { [ensName: string]: EnsEntry } };\n}\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<BaseConfig, EnsState> {\n /**\n * Name of this controller used during composition\n */\n override name = 'EnsController';\n\n /**\n * Creates an EnsController instance.\n *\n * @param config - Initial options used to configure this controller.\n * @param state - Initial state to set on this controller.\n */\n constructor(config?: Partial<BaseConfig>, state?: Partial<EnsState>) {\n super(config, state);\n\n this.defaultState = { ensEntries: {} };\n\n this.initialize();\n }\n\n /**\n * Remove all chain Ids and ENS entries from state.\n */\n clear() {\n this.update({ ensEntries: {} });\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: string, ensName: string): boolean {\n const normalizedEnsName = normalizeEnsName(ensName);\n if (\n !normalizedEnsName ||\n !this.state.ensEntries[chainId] ||\n !this.state.ensEntries[chainId][normalizedEnsName]\n ) {\n return false;\n }\n\n const ensEntries = Object.assign({}, this.state.ensEntries);\n delete ensEntries[chainId][normalizedEnsName];\n\n if (Object.keys(ensEntries[chainId]).length === 0) {\n delete ensEntries[chainId];\n }\n\n this.update({ ensEntries });\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: string, 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: string, 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 `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({\n 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\nexport default EnsController;\n"]}
|
|
1
|
+
{"version":3,"file":"EnsController.js","sourceRoot":"","sources":["../src/EnsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAGmC;AACnC,wDAIkC;AAClC,2CAAsD;AACtD,iEAOoC;AACpC,wCAAoC;AACpC,wFAAqD;AAErD,MAAM,GAAG,GAAG,IAAA,2BAAmB,EAAC,gBAAgB,CAAC,CAAC;AAElD;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,SAAwB;IAExB,OAAO,CACL,SAAS,KAAK,IAAI;QAClB,IAAA,8BAAW,EAAC,wDAAqC,EAAE,SAAS,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,MAAM,IAAI,GAAG,eAAe,CAAC;AAuC7B,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,MAAa,aAAc,SAAQ,kCAIlC;IAGC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,EACV,QAAQ,EACR,oBAAoB,GAarB;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,kCACA,YAAY,GACZ,KAAK,CACT;SACF,CAAC,CAAC;;QAtCL,qCAAoC,IAAI,EAAC;QAwCvC,IAAI,QAAQ,IAAI,oBAAoB,EAAE;YACpC,oBAAoB,CAAC,CAAC,YAAY,EAAE,EAAE;gBACpC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,MAAM,cAAc,GAClB,YAAY,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;gBACnE,IACE,gBAAgB,CAAC,cAAc,CAAC;oBAChC,uBAAA,IAAI,qEAAsB,MAA1B,IAAI,EAAuB,cAAc,CAAC,EAC1C;oBACA,uBAAA,IAAI,8BAAgB,IAAI,wBAAY,CAAC,QAAQ,EAAE;wBAC7C,OAAO,EAAE,IAAA,sCAAmB,EAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC;wBACjE,IAAI,EAAE,wDAAqC,CAAC,cAAc,CAAC;wBAC3D,UAAU,EAAE,kCAAa,CAAC,cAAc,CAAC;qBAC1C,CAAC,MAAA,CAAC;iBACJ;qBAAM;oBACL,uBAAA,IAAI,8BAAgB,IAAI,MAAA,CAAC;iBAC1B;YACH,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,OAAe,EAAE,OAAe;QACrC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,OAAO,CAAC,CAAC;QACpD,IACE,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,OAAe,EAAE,OAAe;QAClC,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,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,OAAe,EAAE,OAAe,EAAE,OAAsB;QAC1D,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,IAAA,oCAAiB,EAAC,OAAO,CAAC,CAAC,EACxC;YACA,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,aAAa,OAAO,aAAa,OAAO,GAAG,CACnF,CAAC;SACH;QAED,MAAM,iBAAiB,GAAG,IAAA,mCAAgB,EAAC,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,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhD,IACE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,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,mCACX,IAAI,CAAC,KAAK,CAAC,UAAU,KACxB,CAAC,OAAO,CAAC,kCACJ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,KACjC,CAAC,iBAAiB,CAAC,EAAE;wBACnB,OAAO,EAAE,iBAAiB;wBAC1B,OAAO;wBACP,OAAO,EAAE,iBAAiB;qBAC3B,MAEJ,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAYD;;;;;OAKG;IACG,qBAAqB,CAAC,qBAA6B;;YACvD,IAAI,CAAC,uBAAA,IAAI,kCAAa,EAAE;gBACtB,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,OAAO,GAAG,IAAA,uCAAoB,EAAC,qBAAqB,CAAC,CAAC;YAC5D,IAAI,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,EAAE;gBAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;aACpD;YAED,IAAI,MAAqB,CAAC;YAC1B,IAAI;gBACF,MAAM,GAAG,MAAM,uBAAA,IAAI,kCAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aACzD;YAAC,OAAO,KAAK,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,CAAC;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,CAAC,MAAM,EAAE;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,iBAAgC,CAAC;YACrC,IAAI;gBACF,iBAAiB,GAAG,MAAM,uBAAA,IAAI,kCAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;aACjE;YAAC,OAAO,KAAK,EAAE;gBACd,GAAG,CAAC,KAAK,CAAC,CAAC;gBACX,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,CAAC,iBAAiB,EAAE;gBACtB,OAAO,SAAS,CAAC;aAClB;YAED,IACE,iBAAiB,KAAK,YAAY;gBAClC,iBAAiB,KAAK,oBAAoB,EAC1C;gBACA,OAAO,SAAS,CAAC;aAClB;YACD,IAAI,IAAA,uCAAoB,EAAC,iBAAiB,CAAC,KAAK,OAAO,EAAE;gBACvD,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,GAAG,IAAA,kBAAO,EAAC,MAAgB,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AAvPD,sCAuPC;yKA5DuB,SAAiB;IACrC,OAAO,OAAO,CAAC,kCAAa,CAAC,SAAS,CAAC,CAAC,CAAC;AAC3C,CAAC;AA4DH,kBAAe,aAAa,CAAC","sourcesContent":["import {\n BaseControllerV2,\n RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n Web3Provider,\n ExternalProvider,\n JsonRpcFetchFunc,\n} from '@ethersproject/providers';\nimport { createProjectLogger } from '@metamask/utils';\nimport {\n normalizeEnsName,\n isValidHexAddress,\n toChecksumHexAddress,\n NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP,\n convertHexToDecimal,\n hasProperty,\n} from '@metamask/controller-utils';\nimport { toASCII } from 'punycode/';\nimport ensNetworkMap from 'ethereum-ens-network-map';\n\nconst log = createProjectLogger('ens-controller');\n\n/**\n * Checks whether the given string is a known network ID.\n *\n * @param networkId - Network id.\n * @returns Boolean indicating if the network ID is recognized.\n */\nfunction isKnownNetworkId(\n networkId: string | null,\n): networkId is keyof typeof NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP {\n return (\n networkId !== null &&\n hasProperty(NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP, networkId)\n );\n}\n\nconst name = 'EnsController';\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: string;\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: string]: {\n [ensName: string]: EnsEntry;\n };\n };\n ensResolutionsByAddress: { [key: string]: string };\n};\n\nexport type EnsControllerMessenger = RestrictedControllerMessenger<\n typeof name,\n never,\n never,\n never,\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 BaseControllerV2<\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.messenger - A reference to the messaging system.\n * @param options.state - Initial state to set on this controller.\n * @param options.provider - Provider instance.\n * @param options.onNetworkStateChange - Allows registering an event handler for\n * when the network controller state updated.\n */\n constructor({\n messenger,\n state = {},\n provider,\n onNetworkStateChange,\n }: {\n messenger: EnsControllerMessenger;\n state?: Partial<EnsControllerState>;\n provider?: ExternalProvider | JsonRpcFetchFunc;\n onNetworkStateChange?: (\n listener: (networkState: {\n network: string;\n providerConfig: {\n chainId: string;\n };\n }) => void,\n ) => void;\n }) {\n super({\n name,\n metadata,\n messenger,\n state: {\n ...defaultState,\n ...state,\n },\n });\n\n if (provider && onNetworkStateChange) {\n onNetworkStateChange((networkState) => {\n this.resetState();\n const currentNetwork =\n networkState.network === 'loading' ? null : networkState.network;\n if (\n isKnownNetworkId(currentNetwork) &&\n this.#getNetworkEnsSupport(currentNetwork)\n ) {\n this.#ethProvider = new Web3Provider(provider, {\n chainId: convertHexToDecimal(networkState.providerConfig.chainId),\n name: NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP[currentNetwork],\n ensAddress: ensNetworkMap[currentNetwork],\n });\n } else {\n this.#ethProvider = null;\n }\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: string, ensName: string): boolean {\n const normalizedEnsName = normalizeEnsName(ensName);\n if (\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: string, 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: string, 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 `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 /**\n * Check if network supports ENS.\n *\n * @param networkId - Network id.\n * @returns Boolean indicating if the network supports ENS.\n */\n #getNetworkEnsSupport(networkId: string) {\n return Boolean(ensNetworkMap[networkId]);\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.d.ts
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@metamask/ens-controller",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Maps ENS names to their resolved addresses by chain id",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"MetaMask",
|
|
@@ -29,15 +29,19 @@
|
|
|
29
29
|
"test:watch": "jest --watch"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
+
"@ethersproject/providers": "^5.7.0",
|
|
32
33
|
"@metamask/base-controller": "^2.0.0",
|
|
33
|
-
"@metamask/controller-utils": "^3.
|
|
34
|
+
"@metamask/controller-utils": "^3.4.0",
|
|
35
|
+
"@metamask/utils": "^5.0.1",
|
|
36
|
+
"ethereum-ens-network-map": "^1.0.2",
|
|
37
|
+
"punycode": "^2.1.1"
|
|
34
38
|
},
|
|
35
39
|
"devDependencies": {
|
|
36
40
|
"@metamask/auto-changelog": "^3.1.0",
|
|
37
|
-
"@types/jest": "^
|
|
41
|
+
"@types/jest": "^27.4.1",
|
|
38
42
|
"deepmerge": "^4.2.2",
|
|
39
|
-
"jest": "^
|
|
40
|
-
"ts-jest": "^
|
|
43
|
+
"jest": "^27.5.1",
|
|
44
|
+
"ts-jest": "^27.1.4",
|
|
41
45
|
"typedoc": "^0.22.15",
|
|
42
46
|
"typedoc-plugin-missing-exports": "^0.22.6",
|
|
43
47
|
"typescript": "~4.6.3"
|