Managed ENS Registrar and Resolver

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on: workflow_dispatch
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -0,0 +1,16 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
+
+/.*

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/ens-contracts"]
+	path = lib/ens-contracts
+	url = https://github.com/ensdomains/ens-contracts
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts

Makefile

@@ -0,0 +1,23 @@
+build:
+	forge build
+
+test:
+	forge test --offline -vv
+
+gas-report:
+	NUM=100 forge test --offline --gas-report --match-test "test_Set|test_Multiset|test_RegisterWithPermit"
+
+fork:
+	anvil --fork-url "$(ETH_RPC_URL)"
+
+deploy:
+	# ENV should include ETH_RPC_URL, ETH_PRIVATE_KEY, ETH_OWNER_ADDRESS
+	forge script script/ManagedENSResolver.s.sol:Deploy --rpc-url "$(ETH_RPC_URL)" --broadcast --verify -vvvv
+
+# Call `make fork` and grab one of the forked private keys
+#   export ETH_PRIVATE_KEY="0x..."
+# Note that this will produce a ./broadcast output
+deploy-forked:
+	forge script script/ManagedENSResolver.s.sol:Deploy --rpc-url "http://127.0.0.1:8545" --broadcast -vvvv
+
+.PHONY: test build

README.md

@@ -1 +1,61 @@
-# skyteller-ens-registry
+# ENS Managed Registry
+
+## Getting Started
+
+```
+$ nix develop  # or install foundry some other way
+$ make test    # or `forge test`
+```
+
+## Overview
+
+### `src/ManagedRegistrar.sol`
+
+A simple managed registrar, allowing an admin to set namehash node to address
+mappings.
+
+Note: ENS operates on recursive domain component hashes ([namehash](https://docs.ens.domains/contract-api-reference/name-processing)) rather than DNS-style domain strings. Roughly speaking, `foo.example.eth`'s namehash is:
+
+```
+sha3(
+    sha3(
+        sha3(
+            bytes32(0x0) + sha3("eth")
+        ) + sha3("example")
+    ) + sha3("foo")
+)
+```
+
+When a client is resolving a domain, the namehash is provided.
+
+
+### `src/Resolver.sol`
+
+A wildcard ENS resolver that uses a registrar (like `ManagedRegistrar` above) as a backend.
+
+Note: [Wildcard resolvers](https://docs.ens.domains/ens-improvement-proposals/ensip-10-wildcard-resolution) are different from the original ENS subnode-based resolver, which relied on registering every subdomain on ENS's central subnode registry. With wildcard resolvers, the client is expected to recursively attempt to find a resolver for each level until it succeeds: First `foo.example.eth`, if no resolver is registered then check `example.eth`, if no resolver then fall back to the default `eth` resolver.
+
+### `src/extended/ManagedENSResolver.sol`
+
+Builds on top of the basic Resolver, except it adds a wrapper `register(...)` helper which also performs subnode registering for each subdomain.
+
+This is mainly to demonstrate what it would take to support even naive resolvers, and to measure the gas difference.
+
+### `src/extended/ChildResolver.sol`
+
+Wrapper around another Resolver which proxies all of the optional fields as available default values. If we want to maintain all of the set field values on today's production resolver without reapplying them to a new resolver's state, we can use this.
+
+### `src/extended/ManagedRegistrarWithReverse.sol`
+
+Builds on top of a basic ManagedRegistrar, but adds reverse name lookup registration. Some DApps use this to convert addresses to ENS names for display purposes.
+
+Setting a name mapping is an additional call, with additional gas costs.
+
+### `src/extended/PermitRegistrarWithReverse.sol`
+
+Builds on top of ManagedRegistrarWithReverse, except the user pays for the gas costs of registering their subdomain. A signature oracle provides a signed digest that a user can use to claim a name. A reverse name mapping is set at the same time.
+
+
+## License
+
+MIT

flake.nix

@@ -0,0 +1,32 @@
+{
+  inputs = {
+    utils.url = "github:numtide/flake-utils";
+    foundry.url = "github:shazow/foundry.nix/monthly"; # Use monthly branch for permanent releases
+  };
+
+  outputs = { self, nixpkgs, utils, foundry }:
+    utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = [ foundry.overlay ];
+        };
+      in {
+
+        devShell = with pkgs; mkShell {
+          buildInputs = [
+            # From the foundry overlay
+            # Note: Can also be referenced without overlaying as: foundry.defaultPackage.${system}
+            foundry-bin
+
+            # ... any other dependencies we need
+            #solc
+          ];
+
+          # Decorative prompt override so we know when we're in a dev shell
+          shellHook = ''
+            export PS1="[dev] $PS1"
+          '';
+        };
+      });
+}

foundry.toml

@@ -0,0 +1,6 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+
+# See more config options https://github.com/foundry-rs/foundry/tree/master/config

script/ManagedENSResolver.s.sol

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import "forge-std/Script.sol";
+
+import {ManagedENSResolver} from "../src/extended/ManagedENSResolver.sol";
+import {ManagedRegistrarWithReverse} from "../src/extended/ManagedRegistrarWithReverse.sol";
+
+import {Helpers} from "../test/Helpers.sol";
+
+contract Deploy is Script {
+    function run() public {
+        uint256 deployerPrivateKey = vm.envUint("ETH_PRIVATE_KEY");
+        address ownerAddress = vm.envAddress("ETH_OWNER_ADDRESS");
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        ManagedRegistrarWithReverse registrar = new ManagedRegistrarWithReverse();
+        new ManagedENSResolver(
+            registrar, // IRegistrar
+            registrar, // INameResolver
+            Helpers.namehash("example", "eth") // parentNode
+        );
+
+        bytes32 ownerNode = Helpers.namehash("owner", "example", "eth");
+        registrar.set(ownerNode, ownerAddress);
+
+        if (ownerAddress != address(0)) {
+            console.log("Changing registrar owner: %s -> %s", registrar.owner(), ownerAddress);
+            registrar.transferOwnership(ownerAddress);
+        }
+
+        vm.stopBroadcast();
+    }
+}

script/OverrideResolver.s.sol

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.13;
+
+import "forge-std/Script.sol";
+
+interface ENS {
+    function resolver(bytes32 node) external view returns (address);
+    function owner(bytes32 node) external view returns (address);
+
+    function setResolver(bytes32 node, address resolver) external;
+}
+
+// FIXME: This isn't working with impersonate. Use the cast-based script instead for now.
+
+// Override replaces the ENS resolver in a forked environment, for testing.
+// We use --unlocked --sender "0x4863A39d26F8b2e40d2AAbFf1eEe55E4B5015C4f"
+contract Override is Script {
+    function run() public {
+        address resolverAddress = vm.envAddress("RESOLVER_ADDRESS");
+
+        ENS ens = ENS(0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e);
+
+        bytes32 exampleNode = 0x3d5d2e21162745e4df4f56471fd7f651f441adaaca25deb70e4738c6f63d1224;
+        address currentOwner = ens.owner(exampleNode);
+
+        vm.startBroadcast(currentOwner);
+
+        // Replace the resolver
+        ens.setResolver(exampleNode, resolverAddress);
+
+        console.log("New resolver: %s", ens.resolver(exampleNode));
+
+        vm.stopBroadcast();
+
+        // $ cast call --rpc-url "http://127.0.0.1:8545" 0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e "resolver(bytes32) returns (address)" "0x3d5d2e21162745e4df4f56471fd7f651f441adaaca25deb70e4738c6f63d1224"
+    }
+}