Additional testing for async ENS from PR ethereum#2501

Author: dbfreem

tests/ens/conftest.py

@@ -407,6 +407,15 @@ def async_extended_resolver(async_w3):
     )
 
 
+def async_offchain_resolver(async_w3):
+    return async_w3.eth.contract(
+        bytecode=offchain_resolver_bytecode,
+        bytecode_runtime=offchain_resolver_bytecode_runtime,
+        abi=offchain_resolver_abi,
+        ContractFactoryClass=AsyncContract,
+    )
+
+
 def async_ENS_factory(async_w3):
     return async_w3.eth.contract(
         bytecode="6060604052341561000f57600080fd5b60008080526020527fad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb58054600160a060020a033316600160a060020a0319909116179055610501806100626000396000f300606060405236156100805763ffffffff7c01000000000000000000000000000000000000000000000000000000006000350416630178b8bf811461008557806302571be3146100b757806306ab5923146100cd57806314ab9038146100f457806316a25cbd146101175780631896f70a1461014a5780635b0fc9c31461016c575b600080fd5b341561009057600080fd5b61009b60043561018e565b604051600160a060020a03909116815260200160405180910390f35b34156100c257600080fd5b61009b6004356101ac565b34156100d857600080fd5b6100f2600435602435600160a060020a03604435166101c7565b005b34156100ff57600080fd5b6100f260043567ffffffffffffffff60243516610289565b341561012257600080fd5b61012d600435610355565b60405167ffffffffffffffff909116815260200160405180910390f35b341561015557600080fd5b6100f2600435600160a060020a036024351661038c565b341561017757600080fd5b6100f2600435600160a060020a0360243516610432565b600090815260208190526040902060010154600160a060020a031690565b600090815260208190526040902054600160a060020a031690565b600083815260208190526040812054849033600160a060020a039081169116146101f057600080fd5b8484604051918252602082015260409081019051908190039020915083857fce0457fe73731f824cc272376169235128c118b49d344817417c6d108d155e8285604051600160a060020a03909116815260200160405180910390a3506000908152602081905260409020805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a03929092169190911790555050565b600082815260208190526040902054829033600160a060020a039081169116146102b257600080fd5b827f1d4f9bbfc9cab89d66e1a1562f2233ccbf1308cb4f63de2ead5787adddb8fa688360405167ffffffffffffffff909116815260200160405180910390a250600091825260208290526040909120600101805467ffffffffffffffff90921674010000000000000000000000000000000000000000027fffffffff0000000000000000ffffffffffffffffffffffffffffffffffffffff909216919091179055565b60009081526020819052604090206001015474010000000000000000000000000000000000000000900467ffffffffffffffff1690565b600082815260208190526040902054829033600160a060020a039081169116146103b557600080fd5b827f335721b01866dc23fbee8b6b2c7b1e14d6f05c28cd35a2c934239f94095602a083604051600160a060020a03909116815260200160405180910390a250600091825260208290526040909120600101805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a03909216919091179055565b600082815260208190526040902054829033600160a060020a0390811691161461045b57600080fd5b827fd4735d920b0f87494915f556dd9b54c8f309026070caea5c737245152564d26683604051600160a060020a03909116815260200160405180910390a250600091825260208290526040909120805473ffffffffffffffffffffffffffffffffffffffff1916600160a060020a039092169190911790555600a165627a7a7230582050975b6c54a16d216b563f4c4960d6ebc5881eb1ec73c2ef1f87920a251159530029",  # noqa: E501
@@ -583,6 +592,39 @@ async def async_ens_setup():
         extended_resolver.address
     ).transact({'from': second_account})
 
+    # --- setup offchain resolver example --- #
+
+    # create offchain resolver
+    offchain_resolver = await async_deploy(
+        async_w3, async_offchain_resolver, ens_key,
+
+        # use a made up url and mock the call to this endpoint in tests
+        args=[
+            [
+                "https://web3.py/gateway/{sender}/{data}.json",  # for GET request testing
+                "https://web3.py/gateway/{sender}.json",  # for POST request testing
+            ],
+            [to_checksum_address('0x4c40caf7f24a545095299972c381862469b080fb')]
+        ]
+    )
+
+    # set owner of offchainexample.eth to an account controlled by tests
+    await ens_contract.functions.setSubnodeOwner(
+        eth_namehash,
+        async_w3.keccak(text='offchainexample'),
+        second_account
+    ).transact({'from': ens_key})
+
+    # ns.namehash('offchainexample.eth')
+    offchain_example_namehash = bytes32(
+        0x42041b0018edd29d7c17154b0c671acc0502ea0b3693cafbeadf58e6beaaa16c
+    )
+
+    await ens_contract.functions.setResolver(
+        offchain_example_namehash,
+        offchain_resolver.address
+    ).transact({'from': second_account})
+
     # --- finish setup --- #
 
     # make the registrar the owner of the 'eth' name

tests/ens/test_offchain_resolution.py

@@ -1,5 +1,8 @@
 import pytest
 
+from aiohttp import (
+    ClientSession,
+)
 import requests
 
 from ens.utils import (
@@ -70,6 +73,44 @@ def raise_for_status(): pass  # noqa: E704
     def json(): return {'not_data': OFFCHAIN_RESOLVER_DATA}  # noqa: E704
 
 
+class AsyncMockHttpSuccessResponse:
+    status_code = 200
+
+    def __init__(self, request_type, *args, **_kwargs):
+        # validate the expected urls
+        if request_type == 'get':
+            assert args[1] == EXPECTED_GET_URL
+        elif request_type == 'post':
+            assert args[1] == EXPECTED_POST_URL
+
+    @staticmethod
+    def raise_for_status(): pass  # noqa: E704
+
+    @staticmethod
+    async def json(): return {'data': OFFCHAIN_RESOLVER_DATA}  # noqa: E704
+
+    @property
+    def status(self):
+        return self.status_code
+
+
+class AsyncMockHttpBadFormatResponse:
+    status_code = 200
+
+    def __init__(self, *args):
+        assert args[1] == EXPECTED_GET_URL
+
+    @staticmethod
+    def raise_for_status(): pass  # noqa: E704
+
+    @staticmethod
+    async def json(): return {'not_data': OFFCHAIN_RESOLVER_DATA}  # noqa: E704'
+
+    @property
+    def status(self):
+        return self.status_code
+
+
 def test_offchain_resolution_with_get_request(ens, monkeypatch):
     # mock GET response with real return data from 'offchainexample.eth' resolver
     def mock_get(*args, **kwargs):
@@ -123,3 +164,45 @@ def test_offchain_resolver_function_call_raises_with_ccip_read_disabled(ens, mon
             ens_encode_name('offchainexample.eth'),
             ENCODED_ADDR_CALLDATA,
         )
+
+
+@pytest.mark.asyncio
+async def test_async_offchain_resolution_with_get_request(async_ens, monkeypatch):
+    # mock GET response with real return data from 'offchainexample.eth' resolver
+    async def mock_get(*args, **kwargs):
+        return AsyncMockHttpSuccessResponse('get', *args, **kwargs)
+
+    monkeypatch.setattr(ClientSession, 'get', mock_get)
+
+    assert await async_ens.address('offchainexample.eth') == EXPECTED_RESOLVED_ADDRESS
+
+
+@pytest.mark.asyncio
+async def test_async_offchain_resolution_with_post_request(async_ens, monkeypatch):
+    # mock POST response with real return data from 'offchainexample.eth' resolver
+    async def mock_post(*args, **kwargs):
+        return AsyncMockHttpSuccessResponse('post', *args, **kwargs)
+
+    monkeypatch.setattr(ClientSession, 'post', mock_post)
+
+    assert await async_ens.address('offchainexample.eth') == EXPECTED_RESOLVED_ADDRESS
+
+
+@pytest.mark.asyncio
+async def test_async_offchain_resolution_raises_when_all_supplied_urls_fail(async_ens):
+    # with no mocked responses, requests to all urls will fail
+    with pytest.raises(Exception, match='Offchain lookup failed for supplied urls.'):
+        await async_ens.address('offchainexample.eth')
+
+
+@pytest.mark.asyncio
+async def test_async_offchain_resolution_with_improperly_formatted_http_response(async_ens,
+                                                                                 monkeypatch):
+    async def mock_get(*args, **_):
+        return AsyncMockHttpBadFormatResponse(*args)
+
+    monkeypatch.setattr(ClientSession, 'get', mock_get)
+    with pytest.raises(ValidationError, match=(
+        "Improperly formatted response for offchain lookup HTTP request - missing 'data' field."
+    )):
+        await async_ens.address('offchainexample.eth')

tests/ens/test_wildcard_resolution.py

@@ -10,9 +10,29 @@ def test_wildcard_resolution_with_extended_resolver_for_subdomains(ens, subdomai
     assert resolved_child_address == '0x000000000000000000000000000000000000dEaD'
 
 
-def test_wildcard_resolution_with_extended_resolver_for_parent_ens_domain(ens):
+def test_async_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.address('extended-resolver.eth')
     assert resolved_parent_address == '0x000000000000000000000000000000000000bEEF'
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize('subdomain', ('sub1', 'sub2', 'rändöm', '🌈rainbow', 'faß'))
+async def test_async_wildcard_resolution_with_extended_resolver_for_subdomains(async_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 = await async_ens.address(f'{subdomain}.extended-resolver.eth')
+    assert resolved_child_address == '0x000000000000000000000000000000000000dEaD'
+
+
+@pytest.mark.asyncio
+async def test_wildcard_resolution_with_extended_resolver_for_parent_ens_domain(async_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 = await async_ens.address('extended-resolver.eth')
+    assert resolved_parent_address == '0x000000000000000000000000000000000000bEEF'