Merge pull request #3301 from ethereum/issue/3010

Adds the possibility to define a custom registry for the ENS module

.gitignore

@@ -18,3 +18,8 @@ packages/web3/dist/
 lerna-debug.log
 !./dist/web3.min.js
 .nyc_output/
+build/
+contracts/
+migrations/
+truffle-config.js
+test/config/ensAddresses.json

.travis.yml

@@ -20,6 +20,8 @@ matrix:
       env: TEST=e2e_ganache
     - node_js: 10
       env: TEST=e2e_mosaic
+    - node_js: 10
+      env: TEST=e2e_ens
     - node_js: 10
       env: TEST=e2e_browsers
       addons:

CHANGELOG.md

@@ -96,8 +96,6 @@ Released with 1.0.0-beta.37 code base.
 
 - Fix npm installation error for scrypt-shim and websocket (#3210)
 
-## [Unreleased]
-
 ## [1.2.5]
 
 ### Added
@@ -126,3 +124,12 @@ Released with 1.0.0-beta.37 code base.
 - callback type definition for ``Accounts.signTransaction`` fixed (#3280)
 - fix: export bloom functions on the index.js
 - Prefer receipt status to code availability on contract deployment (#3298)
+
+
+## [Unreleased]
+
+## [1.2.6]
+
+### Added
+
+- ENS module extended with the possibility to add a custom registry (#3301)

docs/web3-eth-ens.rst

@@ -8,6 +8,35 @@ The ``web3.eth.ens`` functions let you interacting with ENS.
 
 ------------------------------------------------------------------------------
 
+registryAddress
+=====================
+
+.. code-block:: javascript
+
+    web3.eth.ens.registryAddress;
+
+The ``registryAddress`` property can be used to define a custom registry address when you are connected to an unknown chain.
+
+.. note::
+   If no address is defined will it try to detect the registry on the chain you are currently connected with and on the call of ``setProvider`` in the Eth module will it keep the defined address and use it for the ENS module.
+
+-------
+Returns
+-------
+
+``String`` - The address of the custom registry.
+
+-------
+Example
+-------
+
+.. code-block:: javascript
+
+    web3.eth.ens.registryAddress;
+    > "0x314159265dD8dbb310642f98f50C066173C1259b"
+
+------------------------------------------------------------------------------
+
 registry
 =====================