Add configurable reverse node to ReverseRegistrar (#85)

Author: stevieraykatz

script/deploy/DeployReverseRegistrar.s.sol

@@ -18,14 +18,15 @@ contract DeployReverseRegistrar is Script {
 
         ReverseRegistrar revRegstrar = new ReverseRegistrar(
             Registry(ensAddress),
-            deployerAddress // deployer as owner
+            deployerAddress, // deployer as owner
+            BASE_REVERSE_NODE
         );
 
         // establish the reverse registrar as the owner of the 'addr.reverse' node
         bytes32 reverseLabel = keccak256("reverse");
-        bytes32 addrLabel = keccak256("addr");
+        bytes32 baseReverseLabel = keccak256("80002105");
         registry.setSubnodeOwner(0x0, reverseLabel, deployerAddress);
-        registry.setSubnodeOwner(REVERSE_NODE, addrLabel, address(revRegstrar));
+        registry.setSubnodeOwner(REVERSE_NODE, baseReverseLabel, address(revRegstrar));
 
         console.log(address(revRegstrar));
 

src/L2/ReverseRegistrar.sol

@@ -5,16 +5,15 @@ import {ENS} from "ens-contracts/registry/ENS.sol";
 import {NameResolver} from "ens-contracts/resolvers/profiles/NameResolver.sol";
 import {Ownable} from "solady/auth/Ownable.sol";
 
-import {BASE_REVERSE_NODE} from "src/util/Constants.sol";
 import {Sha3} from "src/lib/Sha3.sol";
 
 /// @title Reverse Registrar
 ///
 /// @notice Registrar which allows registrants to establish a name as their "primary" record for reverse resolution.
 ///         Inspired by ENS's ReverseRegistrar implementation:
 ///         https://github.com/ensdomains/ens-contracts/blob/staging/contracts/reverseRegistrar/ReverseRegistrar.sol
-///         Writes records to the base-specific reverse node, compliant with ENSIP-19
-///         https://docs.ens.domains/ensip/19
+///         Writes records to the network-specific reverse node set on construction via `reverseNode`.
+///         Compliant with ENSIP-19: https://docs.ens.domains/ensip/19
 ///
 /// @author Coinbase (https://github.com/base-org/usernames)
 /// @author ENS (https://github.com/ensdomains/ens-contracts)
@@ -26,6 +25,9 @@ contract ReverseRegistrar is Ownable {
     /// @notice The Registry contract.
     ENS public immutable registry;
 
+    /// @notice The reverse node this registrar manages.
+    bytes32 public immutable reverseNode;
+
     /// @notice Permissioned controller contracts.
     mapping(address controller => bool approved) public controllers;
 
@@ -97,9 +99,10 @@ contract ReverseRegistrar is Ownable {
     ///
     /// @param registry_ The ENS registry, will be stored as `registry`.
     /// @param owner_ The permissioned address initialized as the `owner` in the `Ownable` context.
-    constructor(ENS registry_, address owner_) {
+    constructor(ENS registry_, address owner_, bytes32 reverseNode_) {
         _initializeOwner(owner_);
         registry = registry_;
+        reverseNode = reverseNode_;
     }
 
     /// @notice Allows the owner to change the address of the default resolver.
@@ -111,7 +114,7 @@ contract ReverseRegistrar is Ownable {
     function setDefaultResolver(address resolver) public onlyOwner {
         if (address(resolver) == address(0)) revert NoZeroAddress();
         defaultResolver = NameResolver(resolver);
-        registry.setResolver(BASE_REVERSE_NODE, resolver);
+        registry.setResolver(reverseNode, resolver);
         emit DefaultResolverChanged(defaultResolver);
     }
 
@@ -150,9 +153,9 @@ contract ReverseRegistrar is Ownable {
         returns (bytes32)
     {
         bytes32 labelHash = Sha3.hexAddress(addr);
-        bytes32 baseReverseNode = keccak256(abi.encodePacked(BASE_REVERSE_NODE, labelHash));
+        bytes32 baseReverseNode = keccak256(abi.encodePacked(reverseNode, labelHash));
         emit BaseReverseClaimed(addr, baseReverseNode);
-        registry.setSubnodeRecord(BASE_REVERSE_NODE, labelHash, owner, resolver, 0);
+        registry.setSubnodeRecord(reverseNode, labelHash, owner, resolver, 0);
         return baseReverseNode;
     }
 
@@ -202,8 +205,8 @@ contract ReverseRegistrar is Ownable {
     /// @param addr The address to hash.
     ///
     /// @return The base-specific reverse node hash.
-    function node(address addr) public pure returns (bytes32) {
-        return keccak256(abi.encodePacked(BASE_REVERSE_NODE, Sha3.hexAddress(addr)));
+    function node(address addr) public view returns (bytes32) {
+        return keccak256(abi.encodePacked(reverseNode, Sha3.hexAddress(addr)));
     }
 
     /// @notice Allows this contract to check if msg.sender is the `Ownable:owner()` for `addr`.

test/IntegrationTest.t.sol

@@ -22,7 +22,7 @@ import {
     ETH_NODE,
     BASE_ETH_NODE,
     REVERSE_NODE,
-    ADDR_REVERSE_NODE,
+    BASE_REVERSE_NODE,
     GRACE_PERIOD,
     BASE_ETH_NAME
 } from "src/util/Constants.sol";
@@ -59,7 +59,7 @@ contract IntegrationTest is Test {
         payments = makeAddr("payments");
 
         registry = new Registry(owner);
-        reverseRegistrar = new ReverseRegistrar(registry, owner);
+        reverseRegistrar = new ReverseRegistrar(registry, owner, BASE_REVERSE_NODE);
 
         uint256[] memory rentPrices = new uint256[](6);
         rentPrices[0] = 317_097_919_837;
@@ -107,10 +107,8 @@ contract IntegrationTest is Test {
         registry.setSubnodeOwner(ROOT_NODE, ETH_LABEL, owner);
         registry.setSubnodeOwner(ETH_NODE, BASE_LABEL, address(baseRegistrar));
 
-        // establish addr.reverse namespace and assign ownership of addr.reverse to the reverse registrar
-        registry.setSubnodeOwner(ROOT_NODE, REVERSE_LABEL, owner);
-        registry.setSubnodeOwner(REVERSE_NODE, ADDR_LABEL, address(reverseRegistrar));
         // establish 80002105.reverse namespace and assign ownership to the reverse registrar
+        registry.setSubnodeOwner(ROOT_NODE, REVERSE_LABEL, owner);
         registry.setSubnodeOwner(REVERSE_NODE, keccak256("80002105"), address(reverseRegistrar));
         vm.stopPrank();
     }

test/ReverseRegistrar/ReverseRegistrarBase.t.sol

@@ -5,7 +5,7 @@ import {Test} from "forge-std/Test.sol";
 import {ReverseRegistrar} from "src/L2/ReverseRegistrar.sol";
 import {Registry} from "src/L2/Registry.sol";
 import {ENS} from "ens-contracts/registry/ENS.sol";
-import {ETH_NODE, REVERSE_NODE} from "src/util/Constants.sol";
+import {ETH_NODE, REVERSE_NODE, BASE_REVERSE_NODE} from "src/util/Constants.sol";
 
 contract ReverseRegistrarBase is Test {
     address public owner = makeAddr("owner");
@@ -17,7 +17,7 @@ contract ReverseRegistrarBase is Test {
 
     function setUp() public {
         registry = new Registry(owner);
-        reverse = new ReverseRegistrar(ENS(address(registry)), owner);
+        reverse = new ReverseRegistrar(ENS(address(registry)), owner, BASE_REVERSE_NODE);
         vm.prank(owner);
         reverse.setControllerApproval(controller, true);
         _registrySetup();