Merge pull request #193 from unstoppabledomains/ryan/remove-ens

Author: Ryan Le

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 7.0.0
+
+- ENS support is completely removed
+- Removes `bip44-constants`, `@ensdomains/address-encoder`, and `content-hash`
+  package dependencies
+- Methods that query ENS domains (.eth, .luxe, .xyz, .kred, .reverse) throw
+  UnsupportedDomain
 ## 6.0.3
 - Remove relative imports to avoid issues in bundlers. Restrict relative imports by adding eslint rule.
 

README.md

@@ -27,13 +27,8 @@ Resolution is primarily built and maintained by
 Resolution supports decentralized domains across three main zones:
 
 - Zilliqa Name Service (ZNS)
-  - `.zil`
 
-- Ethereum Name Service (ENS)
-  - `.eth`
-  - `.kred`
-  - `.xyz`
-  - `.luxe`
+  - `.zil`
 
 - Unstoppable Name Service (UNS)
   - `.crypto`
@@ -50,15 +45,6 @@ Resolution supports decentralized domains across three main zones:
 For more information, see our detailed
 [API Referrence](https://unstoppabledomains.github.io/resolution/).
 
-### ENS support
-**Note: Ethereum Name Service requires installing additional packages 
-otherwise library throws error when trying to resolve ENS domain.**
-
-#### Required packages
-- `"bip44-constants": "^8.0.5"`
-- `"@ensdomains/address-encoder": ">= 0.1.x <= 0.2.x"`
-- `"content-hash": "^2.5.2"`
-
 ## Installing Resolution
 
 Resolution can be installed with either `yarn` or `npm`.
@@ -89,7 +75,7 @@ yarn add @unstoppabledomains/resolution
 Create a new file in your project, `address.js`.
 
 ```javascript
-const { default: Resolution } = require('@unstoppabledomains/resolution');
+const {default: Resolution} = require('@unstoppabledomains/resolution');
 const resolution = new Resolution();
 
 function resolve(domain, currency) {
@@ -125,7 +111,7 @@ brad.zil resolves to zil1yu5u4hegy9v3xgluweg4en54zm8f8auwxu0xxj
 Create a new file in your project, `ipfs_hash.js`.
 
 ```javascript
-const { default: Resolution } = require('@unstoppabledomains/resolution');
+const {default: Resolution} = require('@unstoppabledomains/resolution');
 const resolution = new Resolution();
 
 function resolveIpfsHash(domain) {
@@ -154,7 +140,7 @@ You can access this website via a public IPFS gateway: https://gateway.ipfs.io/i
 Create a new file in your project, `custom-resolution.js`.
 
 ```javascript
-const { default: Resolution } = require('@unstoppabledomains/resolution');
+const {default: Resolution} = require('@unstoppabledomains/resolution');
 const resolution = new Resolution();
 
 function resolveCustomRecord(domain, record) {
@@ -196,9 +182,7 @@ Use the `-h` or `--help` flag to see all the available CLI options.
 Resolution provides zero-configuration experience by using built-in
 production-ready [Infura](http://infura.io/) endpoint by default.  
 Default Ethereum provider is free to use without restrictions and rate-limits
-for `CNS (.crypto domains)` resolution.  
-To resolve `ENS` domains on production it's recommended to change Ethereum
-provider.  
+for `UNS` resolution.  
 Default provider can be changed by changing constructor options
 `new Resolution(options)` or by using one of the factory methods:
 
@@ -211,18 +195,23 @@ To see all constructor options and factory methods check
 [Unstoppable API reference](https://unstoppabledomains.github.io/resolution).
 
 ## Autoconfiguration of blockchain network
-In some scenarios system might not be flexible enough to easy distinguish between various Ethereum testnets on compile time.
-For this case Resolution library provide a special async constructor which should be waited for 
-`await Resolution.autonetwork(options)`. This method makes a JSON RPC "net_version" call to the provider to get the network id.
 
-This method configures only Ens and Cns, Zns is supported only on Zilliqa mainnet which is going to be used in any cases.
-You can provide a configured provider or a blockchain url as in the following example:
+In some scenarios system might not be flexible enough to easy distinguish
+between various Ethereum testnets on compile time. For this case Resolution
+library provide a special async constructor which should be waited for
+`await Resolution.autonetwork(options)`. This method makes a JSON RPC
+"net_version" call to the provider to get the network id.
+
+This method configures only Uns. Zns is supported only on Zilliqa mainnet which
+is going to be used in any cases. You can provide a configured provider or a
+blockchain url as in the following example:
+
 ```
 await Resolution.autonetwork({
-  cns: {provider},
-  ens: {url}
+  uns: {provider},
 });
 ```
+
 ## Error Handling
 
 When resolution encounters an error it returns the error code instead of
@@ -264,6 +253,7 @@ or **Linux shell**).
 ### Internal config
 
 #### To update:
+
 - Network config: `$ yarn network-config:pull`
 - Resolver keys: `$ yarn resolver-keys:pull`
 - Both configs: `$ yarn config:pull`

package.json

@@ -47,7 +47,6 @@
     "cns",
     ".crypto",
     "zns",
-    "ens",
     "ethereum",
     "zilliqa",
     "blockchain",
@@ -62,7 +61,6 @@
   },
   "homepage": "https://github.com/unstoppabledomains/resolution.git#readme",
   "devDependencies": {
-    "@ensdomains/address-encoder": "0.2.6",
     "@ethersproject/providers": "^5.4.5",
     "@types/bn.js": "^4.11.6",
     "@types/elliptic": "^6.4.13",
@@ -74,8 +72,6 @@
     "@unstoppabledomains/sizecheck": "^4.0.0",
     "@zilliqa-js/core": "2.3.0-alpha.0",
     "audit-ci": "^3.1.1",
-    "bip44-constants": "^8.0.5",
-    "content-hash": "^2.5.2",
     "dotenv": "^8.2.0",
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^8.3.0",
@@ -105,7 +101,6 @@
     "bn.js": "^4.4.0",
     "cross-fetch": "^3.1.4",
     "elliptic": "^6.5.4",
-    "ethereum-ens-network-map": "^1.0.2",
     "js-sha256": "^0.9.0",
     "js-sha3": "^0.8.0"
   },