feat!: support decoding multiple ABIs at the same time, including ds-note library logs

src/ape/api/transactions.py

@@ -9,7 +9,7 @@
 from tqdm import tqdm  # type: ignore
 
 from ape.api.explorers import ExplorerAPI
-from ape.exceptions import TransactionError
+from ape.exceptions import DecodingError, TransactionError
 from ape.logging import logger
 from ape.types import ContractLog, TransactionSignature
 from ape.utils import BaseInterfaceModel, abstractmethod, raises_not_implemented
@@ -221,7 +221,9 @@ def raise_for_status(self):
         :class:`~api.providers.TransactionStatusEnum`.
         """
 
-    def decode_logs(self, abi: Union[EventABI, "ContractEvent"]) -> Iterator[ContractLog]:
+    def decode_logs(
+        self, abi: Optional[Union[EventABI, "ContractEvent"]] = None
+    ) -> Iterator[ContractLog]:
         """
         Decode the logs on the receipt.
 
@@ -231,10 +233,27 @@ def decode_logs(self, abi: Union[EventABI, "ContractEvent"]) -> Iterator[Contrac
         Returns:
             Iterator[:class:`~ape.types.ContractLog`]
         """
-        if not isinstance(abi, EventABI):
-            abi = abi.abi
+        if abi:
+            if not isinstance(abi, EventABI):
+                abi = abi.abi
 
-        yield from self.provider.network.ecosystem.decode_logs(abi, self.logs)
+            yield from self.provider.network.ecosystem.decode_logs(abi, self.logs)
+        else:
+            # if abi is not provided, decode all events
+            for log in self.logs:
+                contract_type = self.chain_manager.contracts.get(log["address"])
+                if not contract_type:
+                    logger.warning(f"Failed to locate contract at '{log['address']}'.")
+                    continue
+
+                try:
+                    event_abi = contract_type.events[log["topics"][0]]
+                    yield from self.provider.network.ecosystem.decode_logs(event_abi, [log])
+                except (StopIteration, KeyError, DecodingError):
+                    try:
+                        yield self.provider.network.ecosystem.decode_ds_note(log)  # type: ignore
+                    except (DecodingError, AttributeError):
+                        yield log  # type: ignore
 
     def await_confirmations(self) -> "ReceiptAPI":
         """

src/ape_ethereum/ecosystem.py

@@ -490,3 +490,37 @@ def decode_value(t, v) -> Any:
                 block_hash=log["blockHash"],
                 block_number=log["blockNumber"],
             )  # type: ignore
+
+    def decode_ds_note(self, log: dict) -> ContractLog:
+        """
+        Decode anonymous events emitted by the DSNote library.
+        """
+        # the first topic encodes the function selector
+        selector, tail = log["topics"][0][:4], log["topics"][0][4:]
+        if sum(tail):
+            raise DecodingError("ds-note: non-zero bytes found after selector")
+
+        contract_type = self.chain_manager.contracts.get(log["address"])
+        if contract_type is None:
+            raise DecodingError(f"ds-note: contract type for {log['address']} not found")
+
+        try:
+            abi = contract_type.mutable_methods[selector]
+        except KeyError:
+            raise DecodingError(f"ds-note: selector {selector.hex()} not found in {log['address']}")
+
+        # ds-note data field uses either (uint256,bytes) or (bytes) encoding
+        # instead of guessing, assume the payload begins right after the selector
+        data = decode_hex(log["data"])
+        input_types = [i.canonical_type for i in abi.inputs]
+        start_index = data.index(selector) + 4
+        values = decode_abi(input_types, data[start_index:])
+
+        return ContractLog(  # type: ignore
+            name=abi.name,
+            event_arguments={input.name: value for input, value in zip(abi.inputs, values)},
+            transaction_hash=log["transactionHash"],
+            block_number=log["blockNumber"],
+            block_hash=log["blockHash"],
+            index=log["logIndex"],
+        )

tests/functional/conftest.py

@@ -210,3 +210,21 @@ def dependency_config(temp_config):
 @pytest.fixture
 def base_projects_directory():
     return BASE_PROJECTS_DIRECTORY
+
+
+@pytest.fixture
+def mainnet_contract(chain):
+    def contract_getter(address):
+        path = (
+            Path(__file__).parent
+            / "data"
+            / "contracts"
+            / "ethereum"
+            / "mainnet"
+            / f"{address}.json"
+        )
+        contract = ContractType.parse_file(path)
+        chain.contracts._local_contracts[address] = contract
+        return contract
+
+    return contract_getter

tests/functional/data/contracts/ethereum/mainnet/0x35D1b3F3D7966A1DFe207aa4514C12a259A0492B.json

@@ -0,0 +1 @@
+{"abi":[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":true,"inputs":[{"indexed":true,"internalType":"bytes4","name":"sig","type":"bytes4"},{"indexed":true,"internalType":"bytes32","name":"arg1","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"arg2","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"arg3","type":"bytes32"},{"indexed":false,"internalType":"bytes","name":"data","type":"bytes"}],"name":"LogNote","type":"event"},{"inputs":[],"name":"Line","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"cage","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"can","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"dai","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"debt","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"usr","type":"address"}],"name":"deny","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"ilk","type":"bytes32"},{"internalType":"bytes32","name":"what","type":"bytes32"},{"internalType":"uint256","name":"data","type":"uint256"}],"name":"file","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"what","type":"bytes32"},{"internalType":"uint256","name":"data","type":"uint256"}],"name":"file","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"ilk","type":"bytes32"},{"internalType":"address","name":"src","type":"address"},{"internalType":"address","name":"dst","type":"address"},{"internalType":"uint256","name":"wad","type":"uint256"}],"name":"flux","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"i","type":"bytes32"},{"internalType":"address","name":"u","type":"address"},{"internalType":"int256","name":"rate","type":"int256"}],"name":"fold","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"ilk","type":"bytes32"},{"internalType":"address","name":"src","type":"address"},{"internalType":"address","name":"dst","type":"address"},{"internalType":"int256","name":"dink","type":"int256"},{"internalType":"int256","name":"dart","type":"int256"}],"name":"fork","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"i","type":"bytes32"},{"internalType":"address","name":"u","type":"address"},{"internalType":"address","name":"v","type":"address"},{"internalType":"address","name":"w","type":"address"},{"internalType":"int256","name":"dink","type":"int256"},{"internalType":"int256","name":"dart","type":"int256"}],"name":"frob","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"},{"internalType":"address","name":"","type":"address"}],"name":"gem","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"i","type":"bytes32"},{"internalType":"address","name":"u","type":"address"},{"internalType":"address","name":"v","type":"address"},{"internalType":"address","name":"w","type":"address"},{"internalType":"int256","name":"dink","type":"int256"},{"internalType":"int256","name":"dart","type":"int256"}],"name":"grab","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"rad","type":"uint256"}],"name":"heal","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"usr","type":"address"}],"name":"hope","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"ilks","outputs":[{"internalType":"uint256","name":"Art","type":"uint256"},{"internalType":"uint256","name":"rate","type":"uint256"},{"internalType":"uint256","name":"spot","type":"uint256"},{"internalType":"uint256","name":"line","type":"uint256"},{"internalType":"uint256","name":"dust","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"ilk","type":"bytes32"}],"name":"init","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"live","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"src","type":"address"},{"internalType":"address","name":"dst","type":"address"},{"internalType":"uint256","name":"rad","type":"uint256"}],"name":"move","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"usr","type":"address"}],"name":"nope","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"usr","type":"address"}],"name":"rely","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"sin","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"ilk","type":"bytes32"},{"internalType":"address","name":"usr","type":"address"},{"internalType":"int256","name":"wad","type":"int256"}],"name":"slip","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"u","type":"address"},{"internalType":"address","name":"v","type":"address"},{"internalType":"uint256","name":"rad","type":"uint256"}],"name":"suck","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"},{"internalType":"address","name":"","type":"address"}],"name":"urns","outputs":[{"internalType":"uint256","name":"ink","type":"uint256"},{"internalType":"uint256","name":"art","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"vice","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"wards","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}],"contractName":"Vat"}

tests/functional/test_contracts.py

@@ -100,6 +100,14 @@ def assert_receipt_logs(receipt: ReceiptAPI, num: int):
     assert_receipt_logs(receipt_2, 3)
 
 
+def test_contract_decode_logs_no_abi(owner, contract_instance):
+    receipt = contract_instance.setNumber(1, sender=owner)
+    events = list(receipt.decode_logs())  # no abi
+    assert len(events) == 1
+    assert events[0].name == "NumberChange"
+    assert events[0].newNum == 1
+
+
 def test_contract_logs_from_event_type(contract_instance, owner, assert_log_values):
     event_type = contract_instance.NumberChange
 

tests/functional/test_ethereum.py

@@ -1,4 +1,5 @@
 import pytest
+from eth_abi import encode_single
 from eth_typing import HexAddress, HexStr
 from hexbytes import HexBytes
 
@@ -109,3 +110,34 @@ def test_block_handles_snake_case_parent_hash(eth_tester_provider, sender, recei
 
     redefined_block = Block.parse_obj(latest_block_dict)
     assert redefined_block.parent_hash == latest_block.parent_hash
+
+
+def test_decode_ds_note(ethereum, mainnet_contract, chain):
+    mainnet_contract("0x35D1b3F3D7966A1DFe207aa4514C12a259A0492B")
+    log = {
+        "address": "0x35D1b3F3D7966A1DFe207aa4514C12a259A0492B",
+        "topics": [
+            HexBytes("0x7608870300000000000000000000000000000000000000000000000000000000"),
+            HexBytes("0x5946492d41000000000000000000000000000000000000000000000000000000"),
+            HexBytes("0x0000000000000000000000000abb839063ef747c8432b2acc60bf8f70ec09a45"),
+            HexBytes("0x0000000000000000000000000abb839063ef747c8432b2acc60bf8f70ec09a45"),
+        ],
+        "data": "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000e0760887035946492d410000000000000000000000000000000000000000000000000000000000000000000000000000000abb839063ef747c8432b2acc60bf8f70ec09a450000000000000000000000000abb839063ef747c8432b2acc60bf8f70ec09a450000000000000000000000000abb839063ef747c8432b2acc60bf8f70ec09a450000000000000000000000000000000000000000000000000000000000000000fffffffffffffffffffffffffffffffffffffffffffa050e82a57b7fc6b6020c00000000000000000000000000000000000000000000000000000000",  # noqa: E501
+        "blockNumber": 14623434,
+        "transactionHash": HexBytes(
+            "0xa322a9fd0e627e22bfe1b0877cca1d1f2e697d076007231d0b7a366d1a0fdd51"
+        ),
+        "transactionIndex": 333,
+        "blockHash": HexBytes("0x0fd77b0af3fa471aa040a02d4fcd1ec0a35122a4166d0bb7c31354e23823de49"),
+        "logIndex": 376,
+        "removed": False,
+    }
+    ilk = encode_single("bytes32", b"YFI-A")
+    assert ethereum.decode_ds_note(log).event_arguments == {
+        "i": ilk,
+        "u": "0x0abb839063ef747c8432b2acc60bf8f70ec09a45",
+        "v": "0x0abb839063ef747c8432b2acc60bf8f70ec09a45",
+        "w": "0x0abb839063ef747c8432b2acc60bf8f70ec09a45",
+        "dink": 0,
+        "dart": -7229675416790010075676148,
+    }