Add tests related to ENSIP-10 implementation:

- Test wildcard resolver functionality using a basic resolver with support for the `resolve()` method and validate the parent ens domain and its subdomains within the resolve method of the contract.
- Test the new ``ens_encode_name()`` from the ``ens.utils`` module.
- Test the new ``ENS.parent()`` method to extract a parent from an ENS name.

Author: fselmo

ens/contract_data.py

@@ -256,7 +256,7 @@ def is_valid_ens_name(ens_name: str) -> bool:
     return True
 
 
-# borrowed from similar method at `web._utils.abi` due to circular dependency
+# borrowed from similar method at `web3._utils.abi` due to circular dependency
 def get_abi_output_types(abi: 'ABIFunction') -> List[str]:
     return (
         [] if abi['type'] == 'fallback'

ens/utils.py

@@ -8,6 +8,9 @@
 
 from ens import ENS
 from ens.contract_data import (
+    extended_resolver_abi,
+    extended_resolver_bytecode,
+    extended_resolver_bytecode_runtime,
     registrar_abi,
     registrar_bytecode,
     registrar_bytecode_runtime,
@@ -89,6 +92,15 @@ def SimpleResolver(w3):
     )
 
 
+def ExtendedResolver(w3):
+    return w3.eth.contract(
+        bytecode=extended_resolver_bytecode,
+        bytecode_runtime=extended_resolver_bytecode_runtime,
+        abi=extended_resolver_abi,
+        ContractFactoryClass=Contract,
+    )
+
+
 def ENSFactory(w3):
     return w3.eth.contract(
         bytecode="6060604052341561000f57600080fd5b60008080526020527fad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb58054600160a060020a033316600160a060020a0319909116179055610501806100626000396000f300606060405236156100805763ffffffff7c01000000000000000000000000000000000000000000000000000000006000350416630178b8bf811461008557806302571be3146100b757806306ab5923146100cd57806314ab9038146100f457806316a25cbd146101175780631896f70a1461014a5780635b0fc9c31461016c575b600080fd5b341561009057600080fd5b61009b60043561018e565b604051600160a060020a03909116815260200160405180910390f35b34156100c257600080fd5b61009b6004356101ac565b34156100d857600080fd5b6100f2600435602435600160a060020a03604435166101c7565b005b34156100ff57600080fd5b6100f260043567ffffffffffffffff60243516610289565b341561012257600080fd5b61012d600435610355565b60405167ffffffffffffffff909116815260200160405180910390f35b341561015557600080fd5b6100f2600435600160a060020a036024351661038c565b341561017757600080fd5b6100f2600435600160a060020a0360243516610432565b600090815260208190526040902060010154600160a060020a031690565b600090815260208190526040902054600160a060020a031690565b600083815260208190526040812054849033600160a060020a039081169116146101f057600080fd5b8484604051918252602082015260409081019051908190039020915083857fce0457fe73731f824cc272376169235128c118b49d344817417c6d108d155e8285604051600160a060020a03909116815260200160405180910390a3506000908152602081905260409020805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a03929092169190911790555050565b600082815260208190526040902054829033600160a060020a039081169116146102b257600080fd5b827f1d4f9bbfc9cab89d66e1a1562f2233ccbf1308cb4f63de2ead5787adddb8fa688360405167ffffffffffffffff909116815260200160405180910390a250600091825260208290526040909120600101805467ffffffffffffffff90921674010000000000000000000000000000000000000000027fffffffff0000000000000000ffffffffffffffffffffffffffffffffffffffff909216919091179055565b60009081526020819052604090206001015474010000000000000000000000000000000000000000900467ffffffffffffffff1690565b600082815260208190526040902054829033600160a060020a039081169116146103b557600080fd5b827f335721b01866dc23fbee8b6b2c7b1e14d6f05c28cd35a2c934239f94095602a083604051600160a060020a03909116815260200160405180910390a250600091825260208290526040909120600101805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a03909216919091179055565b600082815260208190526040902054829033600160a060020a0390811691161461045b57600080fd5b827fd4735d920b0f87494915f556dd9b54c8f309026070caea5c737245152564d26683604051600160a060020a03909116815260200160405180910390a250600091825260208290526040909120805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a039092169190911790555600a165627a7a7230582050975b6c54a16d216b563f4c4960d6ebc5881eb1ec73c2ef1f87920a251159530029",  # noqa: E501
@@ -226,13 +238,38 @@ def ens_setup():
         second_account
     ).transact({'from': ens_key})
 
-    simple_resolver_namehash = bytes32(0x65db4c1c4f4ab9e6917fa7896ce546b1fe03e9341e98187e3917afb60aa9835a)  # noqa: E501
+    # ns.namehash('simple-resolver.eth')
+    simple_resolver_namehash = bytes32(
+        0x65db4c1c4f4ab9e6917fa7896ce546b1fe03e9341e98187e3917afb60aa9835a
+    )
 
     ens_contract.functions.setResolver(
         simple_resolver_namehash,
         simple_resolver.address
     ).transact({'from': second_account})
 
+    # --- setup extended resolver example --- #
+
+    # create extended resolver
+    extended_resolver = deploy(w3, ExtendedResolver, ens_key, args=[ens_contract.address])
+
+    # set owner of extended-resolver.eth to an account controlled by tests
+    ens_contract.functions.setSubnodeOwner(
+        eth_namehash,
+        w3.keccak(text='extended-resolver'),
+        second_account
+    ).transact({'from': ens_key})
+
+    # ns.namehash('extended-resolver.eth')
+    extended_resolver_namehash = bytes32(
+        0xf0a378cc2afe91730d0105e67d6bb037cc5b8b6bfec5b5962d9b637ff6497e55
+    )
+
+    ens_contract.functions.setResolver(
+        extended_resolver_namehash,
+        extended_resolver.address
+    ).transact({'from': second_account})
+
     # --- finish setup --- #
 
     # make the registrar the owner of the 'eth' name

tests/ens/conftest.py

@@ -0,0 +1,127 @@
+/**
+ * The SimpleExtendedResolver is really only meant to test the validation of the parent ens domain
+ * `extended-resolver.eth` and, separately, the subdomains of this parent domain. We then "resolve"
+ * to arbitrary addresses 0x000000000000000000000000000000000000dEaD for subdomain validations and
+ * 0x000000000000000000000000000000000000bEEF for the parent domain validation so that we can be
+ * sure each case was validated via the appropriate logic via the `resolve()` function of the contract.
+ */
+
+
+pragma solidity >=0.4.24;
+
+interface ENS {
+
+    // Logged when the owner of a node assigns a new owner to a subnode.
+    event NewOwner(bytes32 node, bytes32 label, address owner);
+
+    // Logged when the owner of a node transfers ownership to a new account.
+    event Transfer(bytes32 node, address owner);
+
+    // Logged when the resolver for a node changes.
+    event NewResolver(bytes32  node, address resolver);
+
+    // Logged when the TTL of a node changes
+    event NewTTL(bytes32  node, uint64 ttl);
+
+
+    function setSubnodeOwner(bytes32 node, bytes32 label, address owner) external;
+    function setResolver(bytes32 node, address resolver) external;
+    function setOwner(bytes32 node, address owner) external;
+    function setTTL(bytes32 node, uint64 ttl) external;
+    function owner(bytes32 node) external view returns (address);
+    function resolver(bytes32 node) external view returns (address);
+    function ttl(bytes32 node) external view returns (uint64);
+}
+
+pragma solidity >= 0.7.0;
+
+abstract contract ResolverBase {
+    bytes4 private constant INTERFACE_META_ID = 0x01ffc9a7;
+
+    function supportsInterface(bytes4 interfaceID) virtual public pure returns(bool) {
+        return interfaceID == INTERFACE_META_ID;
+    }
+
+    function isAuthorised(bytes32 node) internal virtual view returns(bool);
+
+    modifier authorised(bytes32 node) {
+        require(isAuthorised(node));
+        _;
+    }
+
+    function bytesToAddress(bytes memory b) internal pure returns(address payable a) {
+        require(b.length == 20);
+        assembly {
+            a := div(mload(add(b, 32)), exp(256, 12))
+        }
+    }
+
+    function addressToBytes(address a) internal pure returns(bytes memory b) {
+        b = new bytes(20);
+        assembly {
+            mstore(add(b, 32), mul(a, exp(256, 12)))
+        }
+    }
+}
+
+contract ExtendedResolver is ResolverBase  {
+    ENS ens;
+
+    bytes4 constant private EXTENDED_RESOLVER_INTERFACE_ID = 0x9061b923;
+    string constant extendedResolverParentDomain = "\x11extended-resolver\x03eth\x00";
+    bytes32 constant extendedResolverNamehash = 0xf0a378cc2afe91730d0105e67d6bb037cc5b8b6bfec5b5962d9b637ff6497e55;
+
+    /**
+     * A mapping of authorisations. An address that is authorised for a name
+     * may make any changes to the name that the owner could, but may not update
+     * the set of authorisations.
+     * (node, owner, caller) => isAuthorised
+     */
+    mapping(bytes32=>mapping(address=>mapping(address=>bool))) public authorisations;
+
+    event AuthorisationChanged(bytes32  node, address  owner, address  target, bool isAuthorised);
+
+    constructor(ENS _ens) public {
+        ens = _ens;
+    }
+
+    /**
+     * @dev Sets or clears an authorisation.
+     * Authorisations are specific to the caller. Any account can set an authorisation
+     * for any name, but the authorisation that is checked will be that of the
+     * current owner of a name. Thus, transferring a name effectively clears any
+     * existing authorisations, and new authorisations can be set in advance of
+     * an ownership transfer if desired.
+     *
+     * @param node The name to change the authorisation on.
+     * @param target The address that is to be authorised or deauthorised.
+     * @param isAuthorised True if the address should be authorised, or false if it should be deauthorised.
+     */
+    function setAuthorisation(bytes32 node, address target, bool isAuthorised) external {
+        authorisations[node][msg.sender][target] = isAuthorised;
+        emit AuthorisationChanged(node, msg.sender, target, isAuthorised);
+    }
+
+    function isAuthorised(bytes32 node) override internal view returns(bool) {
+        address owner = ens.owner(node);
+        return owner == msg.sender || authorisations[node][owner][msg.sender];
+    }
+
+    function supportsInterface(bytes4 interfaceID) override public pure returns(bool) {
+        return interfaceID == EXTENDED_RESOLVER_INTERFACE_ID || super.supportsInterface(interfaceID);
+    }
+
+    // Simple resolve method solely used to test ENSIP-10 / Wildcard Resolution functionality
+    function resolve(bytes calldata dnsName, bytes calldata data) external view returns (bytes memory) {
+        // validate 'extended-resolver.eth' parent domain
+        if (keccak256(dnsName) == keccak256(bytes(extendedResolverParentDomain)) && data.length >= 36) {
+            require(bytes32(data[4:36]) == extendedResolverNamehash, "parent domain not validated appropriately");
+            return abi.encode(address(0x000000000000000000000000000000000000bEEF));
+        } else {
+            uint length = uint8(dnsName[0]);
+            // validate subdomains of 'extended-resolver.eth' parent domain
+            require(keccak256(dnsName[1 + length:]) == keccak256(bytes(extendedResolverParentDomain)), "subdomain not validated appropriately");
+            return abi.encode(address(0x000000000000000000000000000000000000dEaD));
+        }
+    }
+}

tests/ens/test_contracts/ExtendedResolver.sol

@@ -0,0 +1,13 @@
+pragma solidity ^0.8.13;
+
+contract SimpleResolver {
+    // deployed on ropsten at address = 0xD4D522c96111679bF86220deFE75e0aA1df890b4
+
+    function supportsInterface(bytes4 interfaceID) public returns (bool) {
+        return interfaceID == 0x3b3b57de;
+    }
+
+    function addr(bytes32 nodeID) public returns (address) {
+        return address(this);
+    }
+}

tests/ens/test_contracts/SimpleResolver.sol

@@ -73,5 +73,5 @@ def test_get_text_resolver_not_found(ens):
 
 
 def test_get_text_for_resolver_with_unsupported_function(ens):
-    with pytest.raises(UnsupportedFunction):
+    with pytest.raises(UnsupportedFunction, match="does not support `text` function"):
         ens.get_text('simple-resolver.eth', 'any_key')

tests/ens/test_get_text.py

@@ -0,0 +1,28 @@
+import pytest
+
+
+def test_resolve(ens):
+    acct = ens.w3.eth.accounts[2]
+    ens.setup_address('tester.eth', acct)
+
+    assert ens.resolve('tester.eth') == acct
+
+    # clean up
+    ens.setup_address('tester.eth', None)
+
+
+@pytest.mark.parametrize('subdomain', ('sub1', 'sub2', 'rändöm', '🌈rainbow', 'faß'))
+def test_wildcard_resolution_with_extended_resolver_for_subdomains(ens, subdomain):
+    # validate subdomains of `extended-resolver.eth` by asserting it returns the specified
+    # hard-coded address from `tests/test_contracts/ExtendedResolver.sol` which requires
+    # certain conditions to be met that are specific to subdomains only
+    resolved_child_address = ens.resolve(f'{subdomain}.extended-resolver.eth')
+    assert resolved_child_address == '0x000000000000000000000000000000000000dEaD'
+
+
+def test_wildcard_resolution_with_extended_resolver_for_parent_ens_domain(ens):
+    # validate `extended-resolver.eth` by asserting it returns the specified hard-coded address from
+    # `tests/test_contracts/ExtendedResolver.sol` which requires a specific condition to be
+    # met for the parent domain `extended-resolver.eth`
+    resolved_parent_address = ens.resolve('extended-resolver.eth')
+    assert resolved_parent_address == '0x000000000000000000000000000000000000bEEF'

tests/ens/test_resolve.py

@@ -1,5 +1,12 @@
+import pytest
+
+from eth_utils import (
+    ValidationError,
+    to_bytes,
+)
 
 from ens.utils import (
+    ens_encode_name,
     init_web3,
 )
 
@@ -8,3 +15,84 @@ def test_init_adds_middlewares():
     w3 = init_web3()
     middlewares = map(str, w3.manager.middleware_onion)
     assert 'stalecheck_middleware' in next(middlewares)
+
+
+@pytest.mark.parametrize(
+    'name,expected',
+    (
+        # test some allowed cases
+        ('tester.eth', b'\x06tester\x03eth\x00'),
+        (
+            'a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p',
+            b'\x01a\x01b\x01c\x01d\x01e\x01f\x01g\x01h\x01i\x01j\x01k\x01l\x01m\x01n\x01o\x01p\x00'
+        ),
+        ('1.2.3.4.5.6.7.8.9.10', b'\x011\x012\x013\x014\x015\x016\x017\x018\x019\x0210\x00'),
+        ('abc.123.def-456.eth', b'\x03abc\x03123\x07def-456\x03eth\x00'),
+        ('abc.123.def-456.eth', b'\x03abc\x03123\x07def-456\x03eth\x00'),
+        ('nhéééééé.eth', b'\x0enh\xc3\xa9\xc3\xa9\xc3\xa9\xc3\xa9\xc3\xa9\xc3\xa9\x03eth\x00'),
+        ('🌈rainbow.eth', b'\x0b\xf0\x9f\x8c\x88rainbow\x03eth\x00'),
+        ('🐔🐔.tk', b'\x08\xf0\x9f\x90\x94\xf0\x9f\x90\x94\x02tk\x00'),
+
+        # test that label length may be less than 64
+        (f"{'a' * 63}.b", b'?' + (b'a' * 63) + b'\x01b\x00'),
+        (f"a.{'b'* 63}", b'\x01a' + b'?' + (b'b' * 63) + b'\x00'),
+        (f"abc-123.{'b'* 63}", b'\x07abc-123' + b'?' + b'b' * 63 + b'\x00'),
+    )
+)
+def test_ens_encode_name(name, expected):
+    assert ens_encode_name(name) == expected
+
+
+@pytest.mark.parametrize(
+    'name,expected',
+    (
+        (
+            f"{'a' * 63}.{'b' * 63}.{'c' * 63}.{'d' * 63}.{'e' * 63}.{'f' * 63}.{'g' * 63}",
+            b''.join([b'?' + to_bytes(text=label) * 63 for label in 'abcdefg']) + b'\x00'
+        ),
+        (
+            f"{'a-1' * 21}.{'b-2' * 21}.{'c-3' * 21}.{'d-4' * 21}.{'e-5' * 21}.{'f-6' * 21}",
+            b''.join([
+                b'?' + to_bytes(text=label) * 21 for label in [
+                    'a-1', 'b-2', 'c-3', 'd-4', 'e-5', 'f-6',
+                ]
+            ]) + b'\x00'
+        ),
+    )
+)
+def test_ens_encode_name_validating_total_encoded_name_size(name, expected):
+    # This test is important because dns encoding technically limits the total encoded domain name
+    # size to 255. ENSIP-10 expects the name to be DNS encoded with one of the exceptions
+    # being that the total encoded size can be any length.
+    ens_encoded = ens_encode_name(name)
+    assert len(ens_encoded) > 255
+    assert ens_encoded == expected
+
+
+@pytest.mark.parametrize('empty_name', ('', '.'))
+def test_ens_encode_name_returns_single_zero_byte_for_empty_name(empty_name):
+    assert ens_encode_name(empty_name) == b'\00'
+
+
+@pytest.mark.parametrize(
+    'name,invalid_label_index',
+    (
+        ('a' * 64, 0),
+        (f"{'a' * 64}.b", 0),
+        (f"a.{'b-1' * 21}x", 1),
+        (f"{'a' * 64}.{'1' * 63}.{'b' * 63}", 0),
+        (f"{'a' * 63}.{'1' * 64}.{'b' * 63}", 1),
+        (f"{'a' * 63}.{'1' * 63}.{'b' * 64}", 2),
+    )
+)
+def test_ens_encode_name_raises_ValidationError_on_label_lengths_over_63(name, invalid_label_index):
+    with pytest.raises(ValidationError, match=f'Label at position {invalid_label_index} too long'):
+        ens_encode_name(name)
+
+
+def test_ens_encode_name_normalizes_name_before_encoding():
+    assert ens_encode_name('Öbb.at') == ens_encode_name('öbb.at')
+    assert ens_encode_name('nhÉéÉéÉé.eth') == ens_encode_name('nhéééééé.eth')
+    assert ens_encode_name('TESTER.eth') == ens_encode_name('tester.eth')
+    assert ens_encode_name('test\u200btest.com') == ens_encode_name('testtest.com')
+    assert ens_encode_name("O\u0308bb.at") == ens_encode_name("öbb.at")