Skip to content

Commit

Permalink
fix: avoid attempting to cache None for a contract-type (#2517)
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey authored Feb 19, 2025
1 parent d504d18 commit e69daba
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 5 deletions.
16 changes: 11 additions & 5 deletions src/ape/managers/_contractscache.py
Original file line number Diff line number Diff line change
Expand Up @@ -577,15 +577,21 @@ def get(
if fetch_from_explorer
else None
)
if proxy_contract_type:
contract_type_to_cache = _get_combined_contract_type(
if proxy_contract_type is not None and implementation_contract_type is not None:
combined_contract = _get_combined_contract_type(
proxy_contract_type, proxy_info, implementation_contract_type
)
else:
self.contract_types[address_key] = combined_contract
return combined_contract

elif implementation_contract_type is not None:
contract_type_to_cache = implementation_contract_type
self.contract_types[address_key] = implementation_contract_type
return contract_type_to_cache

self.contract_types[address_key] = contract_type_to_cache
return contract_type_to_cache
elif proxy_contract_type is not None:
self.contract_types[address_key] = proxy_contract_type
return proxy_contract_type

# Also gets cached to disk for faster lookup next time.
if fetch_from_explorer:
Expand Down
54 changes: 54 additions & 0 deletions tests/functional/test_contracts_cache.py
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,60 @@ def test_cache_non_checksum_address(chain, vyper_contract_instance):
assert chain.contracts[vyper_contract_instance.address] == vyper_contract_instance.contract_type


def test_get_when_proxy(chain, owner, minimal_proxy_container, vyper_contract_instance):
placeholder = "0xBEbeBeBEbeBebeBeBEBEbebEBeBeBebeBeBebebe"
if placeholder in chain.contracts:
del chain.contracts[placeholder]

minimal_proxy = owner.deploy(minimal_proxy_container, sender=owner)
chain.provider.network.__dict__["explorer"] = None # Ensure no explorer, messes up test.

actual = chain.contracts.get(minimal_proxy.address)
assert actual == minimal_proxy.contract_type


def test_get_when_proxy_but_implementation_missing(chain, owner, vyper_contract_container):
"""
Proxy is cached but implementation is missing.
"""
placeholder = vyper_contract_container.deploy(1001, sender=owner)
assert chain.contracts[placeholder.address] # This must be cached!

proxy_container = _make_minimal_proxy(placeholder.address)
minimal_proxy = owner.deploy(proxy_container, sender=owner)
chain.provider.network.__dict__["explorer"] = None # Ensure no explorer, messes up test.

if minimal_proxy.address in chain.contracts:
# Delete the proxy but make sure it does not delete the implementation!
# (which it normally does here).
del chain.contracts[minimal_proxy.address]
chain.contracts[placeholder.address] = placeholder

actual = chain.contracts.get(minimal_proxy.address)
assert actual == minimal_proxy.contract_type


def test_get_pass_along_proxy_info(chain, owner, minimal_proxy_container, ethereum):
placeholder = "0xBEbeBeBEbeBebeBeBEBEbebEBeBeBebeBeBebebe"
if placeholder in chain.contracts:
del chain.contracts[placeholder]

minimal_proxy = owner.deploy(minimal_proxy_container, sender=owner)
chain.provider.network.__dict__["explorer"] = None # Ensure no explorer, messes up test.
info = ethereum.get_proxy_info(minimal_proxy.address)
assert info

# Ensure not already cached.
if minimal_proxy.address in chain.contracts:
del chain.contracts[minimal_proxy.address]

actual = chain.contracts.get(minimal_proxy.address, proxy_info=info)
assert actual is None # It can't find the contact anymore.

# Ensure it does store 'None' (was a bug where it did).
assert minimal_proxy.address not in chain.contracts.contract_types


def test_get_creation_metadata(chain, vyper_contract_instance, owner):
address = vyper_contract_instance.address
creation = chain.contracts.get_creation_metadata(address)
Expand Down

0 comments on commit e69daba

Please sign in to comment.