yearn-treasury 0.0.18__cp310-cp310-win32.whl → 0.0.46__cp310-cp310-win32.whl

yearn_treasury/rules/other_income/__init__.py

@@ -1,100 +1,2 @@
-from decimal import Decimal
-from typing import Final
-
-from dao_treasury import TreasuryTx, other_income
-from y import Contract, ContractNotVerified, ERC20, Network  # type: ignore [attr-defined]
-
-from yearn_treasury.rules.constants import ZERO_ADDRESS
-
-
-_POINT_ONE: Final = Decimal("0.1")
-
-
-@other_income("Airdrop", Network.Mainnet)
-def is_airdrop(tx: TreasuryTx) -> bool:
-    txhash = tx.hash
-    return txhash in {
-        "0x327684dab9e3ce61d125b36fe0b59cbfbc8aa5ac7a5b051125ab7cac3b93b90b",
-        "0x3424e8a6688c89f7974968213c8c25f3bd8100f78c54475edb001c11a8ad5d21",  # Gnosis SAFE airdrop
-        "0xb39f2991fdc2c70b43046be3eac36bff35c21c7f66e2888a52afc3956abae451",  # Gnosis SAFE airdrop
-        "0x4923fd32b4eacdc1617700c67176935676ca4d06bbfbb73644730c55534623db",  # Gnosis SAFE airdrop
-        "0x5ba604cae0d355835b182fa23c8a58ae695905e69ed08c7cf8a52f3eca889484",  # Gnosis SAFE airdrop
-        "0x44f7d3b2030799ea45932baf6049528a059aabd6387f3128993d646d01c8e877",  # TKX
-        "0xf2dbe58dffd3bc1476755e9f74e2ae07531579d0a3ea9e2aaac2ef902e080c2a",  # TKX
-        "0x8079e9cae847da196dc5507561bc9d1434f765f05045bc1a82df735ec83bc6ec",  # MTV
-        "0x037a9cc5baa7d63a11d0f0720ee552bbf4ad85118ee5425220a263695fedbe9f",  # Gnosis SAFE airdrop
-        # NOTE: this one was rec'd elsewhere, dumped, and WETH sent to treasury
-        "0xc12ded505ea158717890e4ae6e7ab5eb5cb61edbc13dfd125dd0e6f9b1af9477",  # Gnosis SAFE airdrop
-        "0x7c086a82b43b2f49db93b76a0698cf86a9c620b3bf924f0003175b04a17455ad",  # PRISMA
-    } or (
-        # Gnosis SAFE airdrop
-        txhash == "0xe8b5a4ebf1f04048f6226b22b2865a33621e88ea255dcea0cfd7a975a3a7e387"
-        and tx.log_index == 72
-    )
-
-
-@other_income("aToken Yield", Network.Mainnet)
-def is_atoken_yield(tx: TreasuryTx) -> bool:
-    return (
-        tx.symbol in ("aLEND", "aLINK")
-        and tx.from_address.address == ZERO_ADDRESS
-        and tx.to_nickname in ("Yearn Treasury", "Yearn Treasury V1")
-    )
-
-
-@other_income("RoboVault Thank You", Network.Fantom)
-async def is_robovault_share(tx: TreasuryTx) -> bool:
-    """
-    After Yearn devs helped robovault with a vulnerability, robovault committed to sending Yearn a portion of their fees.
-    """
-    if not tx.symbol.startswith("rv") and tx.from_address.is_contract:
-        return False
-
-    try:
-        strat = await Contract.coroutine(tx.from_address.address)
-    except ContractNotVerified:
-        return False
-
-    if not hasattr(strat, "vault"):
-        return False
-
-    if await strat.vault.coroutine(block_identifier=tx.block) == tx.token:
-        return True
-
-    return (
-        tx.from_nickname == "Contract: Strategy"
-        and tx.symbol == "rv3USDCc"
-        and await ERC20(  # type: ignore [call-overload]
-            await strat.vault.coroutine(block_identifier=tx.block),
-            asynchronous=True,
-        ).symbol
-        == "rv3USDCb"
-    )
-
-
-@other_income("Cowswap Gas Reimbursement", Network.Mainnet)
-def is_cowswap_gas_reimbursement(tx: TreasuryTx) -> bool:
-    return (
-        tx.symbol == "ETH"
-        and tx.from_nickname == "Cowswap Multisig"
-        and tx.to_nickname == "yMechs Multisig"
-    )
-
-
-@other_income("USDS Referral Code", Network.Mainnet)
-def is_usds_referral_code(tx: TreasuryTx) -> bool:
-    """Yearn earns some USDS for referring deposits to Maker"""
-    return (
-        tx.symbol == "USDS"
-        and tx.from_address.address == "0x3C5142F28567E6a0F172fd0BaaF1f2847f49D02F"
-    )
-
-
-@other_income("yETH Application Fee", Network.Mainnet)
-def is_yeth_application_fee(tx: TreasuryTx) -> bool:
-    return tx.symbol == "yETH" and tx.to_nickname == "Yearn Treasury" and tx.amount == _POINT_ONE
-
-
-@other_income("yPRISMA Fees", Network.Mainnet)
-def is_yprisma_fees(tx: TreasuryTx) -> bool:
-    return tx.symbol == "yvmkUSD-A" and tx.from_nickname == "Contract: YPrismaFeeDistributor"
+from yearn_treasury.rules.other_income.airdrops import *
+from yearn_treasury.rules.other_income.misc import *

yearn_treasury/rules/other_income/airdrops.py

@@ -0,0 +1,30 @@
+from typing import Final
+
+from dao_treasury import TreasuryTx, other_income
+from y import Network
+
+
+airdrop: Final = other_income("Airdrop")
+
+_SAFE_AIRDROP_CONTRACTS: Final = (
+    "0xA0b937D5c8E32a80E3a8ed4227CD020221544ee6",
+    "0xC0fde70A65C7569Fe919bE57492228DEE8cDb585",
+)
+
+
+@airdrop("SAFE", Network.Mainnet)
+def is_safe_airdrop(tx: TreasuryTx) -> bool:
+    return tx.symbol == "SAFE" and tx.from_address.address in _SAFE_AIRDROP_CONTRACTS  # type: ignore [union-attr]
+
+
+@airdrop("Other", Network.Mainnet)
+def is_airdrop(tx: TreasuryTx) -> bool:
+    return tx.hash in {
+        "0x327684dab9e3ce61d125b36fe0b59cbfbc8aa5ac7a5b051125ab7cac3b93b90b",
+        "0x44f7d3b2030799ea45932baf6049528a059aabd6387f3128993d646d01c8e877",  # TKX
+        "0xf2dbe58dffd3bc1476755e9f74e2ae07531579d0a3ea9e2aaac2ef902e080c2a",  # TKX
+        "0x8079e9cae847da196dc5507561bc9d1434f765f05045bc1a82df735ec83bc6ec",  # MTV
+        # NOTE: this one was rec'd elsewhere, dumped, and WETH sent to treasury
+        "0xc12ded505ea158717890e4ae6e7ab5eb5cb61edbc13dfd125dd0e6f9b1af9477",  # Gnosis SAFE airdrop
+        "0x7c086a82b43b2f49db93b76a0698cf86a9c620b3bf924f0003175b04a17455ad",  # PRISMA
+    }

yearn_treasury/rules/other_income/match_on_hash.yaml

@@ -1,4 +1,6 @@
 1:
+  YFI Mint:
+    - "0x21a3007a2547a9d6f1bceb44cb9292b36079fcccd8f36f7ec1ca066db261e153"
   yvUSDN Shutdown:
     # The USDN vault was shut down but the pool was so rekt they coulnd't even swap for want. Trace amounts of yield sent to yChad.
     - "0x12b3687f4bfbc73c11dccbd61d18c3f785e6f0f91cb46280d7df08143162ceed"

yearn_treasury/rules/other_income/misc.py

@@ -0,0 +1,80 @@
+# mypy: disable-error-code="union-attr"
+from decimal import Decimal
+from typing import Final, Optional
+
+from dao_treasury import TreasuryTx, other_income
+from y import Contract, ContractNotVerified, ERC20, Network  # type: ignore [attr-defined]
+
+from yearn_treasury.rules.constants import ZERO_ADDRESS
+
+
+_POINT_ONE: Final = Decimal("0.1")
+
+
+@other_income("aToken Yield", Network.Mainnet)
+def is_atoken_yield(tx: TreasuryTx) -> bool:
+    return (
+        tx.symbol in ("aLEND", "aLINK")
+        and tx.from_address.address == ZERO_ADDRESS
+        and tx.to_nickname in ("Yearn Treasury", "Yearn Treasury V1")
+    )
+
+
+@other_income("RoboVault Thank You", Network.Fantom)
+async def is_robovault_share(tx: TreasuryTx) -> bool:
+    """
+    After Yearn devs helped robovault with a vulnerability, robovault committed to sending Yearn a portion of their fees.
+    """
+    if not tx.symbol.startswith("rv") and tx.from_address.is_contract:
+        return False
+
+    try:
+        strat = await tx.from_address.contract_coro
+    except ContractNotVerified:
+        return False
+    else:
+        vault: Optional[Contract] = getattr(strat, "vault", None)
+
+    if vault is None:
+        return False
+
+    if await vault.coroutine(block_identifier=tx.block) == tx.token:
+        return True
+
+    return (
+        tx.from_nickname == "Contract: Strategy"
+        and tx.symbol == "rv3USDCc"
+        and await ERC20(  # type: ignore [call-overload]
+            await vault.coroutine(block_identifier=tx.block),
+            asynchronous=True,
+        ).symbol
+        == "rv3USDCb"
+    )
+
+
+@other_income("Cowswap Gas Reimbursement", Network.Mainnet)
+def is_cowswap_gas_reimbursement(tx: TreasuryTx) -> bool:
+    return (
+        tx.symbol == "ETH"
+        and tx.from_nickname == "Cowswap Multisig"
+        and tx.to_nickname == "yMechs Multisig"
+    )
+
+
+@other_income("USDS Referral Code", Network.Mainnet)
+def is_usds_referral_code(tx: TreasuryTx) -> bool:
+    """Yearn earns some USDS for referring deposits to Maker"""
+    return (
+        tx.symbol == "USDS"
+        and tx.from_address.address == "0x3C5142F28567E6a0F172fd0BaaF1f2847f49D02F"
+    )
+
+
+@other_income("yETH Application Fee", Network.Mainnet)
+def is_yeth_application_fee(tx: TreasuryTx) -> bool:
+    return tx.symbol == "yETH" and tx.to_nickname == "Yearn Treasury" and tx.amount == _POINT_ONE
+
+
+@other_income("yPRISMA Fees", Network.Mainnet)
+def is_yprisma_fees(tx: TreasuryTx) -> bool:
+    return tx.symbol == "yvmkUSD-A" and tx.from_nickname == "Contract: YPrismaFeeDistributor"

yearn_treasury/rules/revenue/vaults.py

@@ -1,9 +1,10 @@
+from decimal import Decimal
 from logging import getLogger
-from typing import Final, Optional
+from typing import Final, Optional, cast
 
-from async_lru import alru_cache
 from dao_treasury import TreasuryTx, revenue
 from eth_typing import ChecksumAddress
+from faster_async_lru import alru_cache
 from y import Contract, Network
 
 from yearn_treasury.vaults import v1, v2
@@ -55,7 +56,7 @@ async def _get_controller(vault: Contract) -> Contract:
 
 @fees("Vaults V1", Network.Mainnet)
 async def is_v1_vault_fees(tx: TreasuryTx) -> bool:
-    token = tx.token.address.address
+    token = tx.token_address
 
     # Fees from single-sided strategies are not denominated in `vault.token` but everything else is
     is_single_sided = _is_single_sided(tx)
@@ -85,7 +86,9 @@ async def is_v1_vault_fees(tx: TreasuryTx) -> bool:
     return False
 
 
-def is_inverse_fees_from_stash_contract(from_address: str, to_nickname: str) -> bool:
+def is_inverse_fees_from_stash_contract(
+    from_address: ChecksumAddress, to_nickname: str | None
+) -> bool:
     return (
         from_address == "0xE376e8e8E3B0793CD61C6F1283bA18548b726C2e"
         and to_nickname == "Token: Curve stETH Pool yVault"
@@ -94,18 +97,19 @@ def is_inverse_fees_from_stash_contract(from_address: str, to_nickname: str) ->
 
 @fees("Vaults V2")
 async def is_v2_vault_fees(tx: TreasuryTx) -> bool:
-    token = tx.token.address.address
-    from_address = tx.from_address.address
+    token = tx.token_address
+    from_address = cast(ChecksumAddress, tx.from_address.address)
     if (
         from_address == token
-        and (vault := v2.get(from_address))  # type: ignore [arg-type]
+        and (vault := v2.get(from_address))
         and tx.to_address == await vault.rewards.coroutine(block_identifier=tx.block)
     ):
         return True
 
-    if is_inverse_fees_from_stash_contract(from_address, tx.to_nickname):  # type: ignore [arg-type]
-        if tx.value_usd > 0:  # type: ignore [operator]
-            tx.value_usd *= -1  # type: ignore [operator]
+    if is_inverse_fees_from_stash_contract(from_address, tx.to_nickname):
+        value_usd = cast(Decimal, tx.value_usd)
+        if value_usd > 0:
+            tx.value_usd = -value_usd
         return True
 
     return False

yearn_treasury/shitcoins.py

@@ -1,8 +1,24 @@
+"""
+List of "shitcoins" (but like, actual shit shitcoins) to ignore in all
+Yearn Treasury analytics.
+
+This module defines, for each blockchain network, a set of token addresses
+known to be unpricable, considered as spam, or otherwise unwanted for
+reporting and analytics. These tokens are passed in to :mod:`eth-portfolio`,
+which contains the logic that prevents these shitcoins from being included in
+any Yearn Treasury outputs.
+
+Since these tokens do nothing but add noise to the outputs, transactions
+involving them are excluded from treasury calculations, reports, and dashboards.
+"""
+
+from typing import Final
+
 from y import Network, convert
 from y.constants import CHAINID
 
 
-_SHITCOINS = {
+_SHITCOINS: Final = {
     Network.Mainnet: (
         "0xC36442b4a4522E871399CD717aBDD847Ab11FE88",  # UNI-V3 NFT, not shitcoin but not pricable
         "0x0329b631464C43f4e8132df7B4ac29a2D89FFdC7",
@@ -34,18 +50,92 @@ _SHITCOINS = {
         "0xe5868468Cb6Dd5d6D7056bd93f084816c6eF075f",
         "0x0a24Bb4842c301276c65086B5d78D5C872993c72",
         "0x63125c0d5Cd9071de9A1ac84c400982f41C697AE",
+        "0x4d22921215cF37e8d49e2Ac6d1F5e9672f63A7c6",
+        "0xe2549E429B78458fa60BC7B1b284d4411E1D5105",
+        "0xCfdD747d041397bcE08B0Fe6ebF7Ef65E9F46795",
+        "0x9745969171a38B40db05c506fe2DA2C36f317627",
+        "0x6051C1354Ccc51b4d561e43b02735DEaE64768B8",
+        "0xf0814d0E47F2390a8082C4a1BD819FDDe50f9bFc",
+        "0x2DBd330bC9B7f3A822a9173aB52172BdDDcAcE2A",
+        # just andre tinkering
+        "0x5cB5e2d7Ab9Fd32021dF8F1D3E5269bD437Ec3Bf",
         # these arent shitcoins per se but we can't price them and dont expect to in the future, lets save cpu cycles
         "0x9d45DAb69f1309F1F55A7280b1f6a2699ec918E8",  # yFamily NFT <3
         "0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85",  # ENS
         "0xD057B63f5E69CF1B929b356b579Cba08D7688048",  # vCOW
         "0x4c1317326fD8EFDeBdBE5e1cd052010D97723bd6",  # deprecated yCRV
         "0x8a0889d47f9Aa0Fac1cC718ba34E26b867437880",  # deprecated st-yCRV
+        "0x55a290f08Bb4CAe8DcF1Ea5635A3FCfd4Da60456",  # BITTO
+        "0x4770F3186225b1A6879983BD88C669CA55463886",  # 69XMins
+        "0x05bAdF8A8e7fE5b43fae112108E26f2f663Bf1a2",  # INUNOMICS
+        "0x3EF9181c9b96BAAafb3717A553E808Ccc72be37D",  # MEMEPEPE
+        "0x5D22c8b4E3c90ca633e1377e6ca280a395fc61C0",  # XMEME
+        "0x57f19E7e1A9066a741f59484481C4D2E9150e9E2",  # MOCO
+        "0xb092D8E13Ba50963D57bEcB17a037728D883D02d",  # BABYLABUBU
+        "0x4E51960bd33A6edA71a8B24A76311834BD98DD9f",  # AICC
+        "0xB85485421d8a41C4648AB80bE1A725fA6b5Bc86d",  # MEGA
+        "0x46D0Fb47b1e91130D53498EbeE7A968e7e6599f9",  # Ghibli
+        "0x4FbB350052Bca5417566f188eB2EBCE5b19BC964",  # GRG
+        "0x1f6DEb07E1a19bAfF90EC4075447eeF6eb96c0BA",  # BABYMANYU
+        "0xD10EFABA11A51237fa120b15153DD432958bbDE3",  # JIFFPOM
+        "0xCd9594cd25ED2a166362b6F76c523da08c4Ef2e5",  # ESTHER
+        "0x16B907b5d1208Ae6086dE983a5EF45E7890eF272",  # JUNFOX
+        "0xdE56173463d6461001B0891bC90DB224965f5762",  # MAGNUS
+        "0x922824A5b3B3D5f4485fF52F4Ab7Cba5eA491874",  # POSEIDON
+        "0x84F7D2f6FB447Bb11d3E7Ce64D83e1c02c2F3078",  # VIRTUAL
+        "0x5C6Ed14E1017cf75C237A4A4b93Ce1D2f83EB002",  # GRVT
+        "0xf76E6eFf109258fd5F52823d9F9feE7c90C97251",  # wkeyDAO
         # test token?
         "0x372d5d02c6b4075bd58892f80300cA590e92d29E",  # tOUSG
         # dETH? don't think this is needed
         "0x3d1E5Cf16077F349e999d6b21A4f646e83Cd90c5",
+        # ai shitcoin spam
+        "0xaf80B7dbeBbb5d9a4d33C453FcbF3d054DA53b25",  # NODEPAY AI
+        "0xf960AbF9ccC883970BEa3E79f65027E27278e1A5",  # ASK AI
+        "0xc136Eb8Abc892723aE87F355d12Cb721C4324D54",  # Grok3
+        "0xc68bCEE3604F163f183Cf8B9a26E610E5961b037",  # TESLA AI
+        "0xa65D56f8e074E773142205cD065FD0796B9aa483",  # MASSIVE AI
+        "0x4e6c80aa486aF0ba20943Fbc067a5557DBcf5458",  # SUNO AI
+        "0xC91223F844772dCdc2c6394585C8c30B3c1BE5C0",  # SEND AI
+        "0x64b3336D1aDC6D3579e356760F53D3b018Cb11Bc",  # ALC AI
+        "0x1495Ac869433698cCD2946c1e62D37bA766294A9",  # NVIDIA AI PC
+        "0x8c0DF275c38092cd90Ae4d6147d8e619B3A24637",  # COLLE AI
+        "0xe38f71fc2Ca5f5761cE21F39Fff2cE70662FA54c",  # CHAINOPERA AI
+        "0xD2F89F59fBC7125b406e3F60A992DFa9FdB76524",  # MISTRAL AI
+        "0xa0CCdBCeB5Da30F9d62F7A727F2B35C69dF08760",  # CHUNK AI
+        "0x7CE31075d7450Aff4A9a82DdDF69D451B1e0C4E9",  # DEEPSEEK AI
+        "0xf0f9C021AF9B6431FA59DAB75C8e6cB80c0dEa37",  # TESLA AI
+        "0x635eeC65a7Ef10dCF96Bfe051D8A6e5960efe180",  # KLING AI
+        "0xa3Efa0929569c15c20f89B591931899Fb05B4663",  # GPT-5
+        "0x0A953979fdCfD82B08C77dB29705327BeC39ff13",  # GROK4 AI
+        "0xc83377b9eE3CEe4Cc03CCd58AfdE1FB12864aEE3",  # E AI
+        "0x927402ab67c0CDA3c187E9DFE34554AC581441f2",  # SAITABIT
+        "0x691539810DF6e879A377C24CfEE130BBE92708d8",  # NVIDIA AI
+        "0xdC82aC0A89197854cb2240FaBF7E7760a4fF4d9e",  # NVIDIA
+        "0x5Fba8ea5A559CF5c99BA6dd884Ae17C1d621fE5B",  # OSCAR AI
+        # matt furry spam
+        "0x73228b3D33cC71cB721Fc62950577bE63bd9c8C9",  # Maskman by Matt Furie
+        "0x7c28e66436C93BB9F657dDF2BA0eeeCf61369b92",  # Bloodboy by Matt Furie
+        "0x70c5e1124569f17B1Be71E15833EaF1331f8727F",  # Pac-hat by Matt Furie
+        "0xBd6555eC87C8A9a2280dCD6df45b9b074fC93Df2",  # Bork by Matt Furie
+        # test token
+        "0x2F375Ce83EE85e505150d24E85A1742fd03cA593",  # TEST
     ),
 }
+"""
+Mapping of blockchain networks to tuples of token addresses that should be
+ignored in Yearn Treasury analytics. These tokens are considered unpricable,
+spam, or otherwise unwanted for reporting and analytics purposes.
+
+Each tuple contains token contract addresses that will be excluded from
+treasury calculations, reports, and dashboards for the corresponding network.
+"""
+
 
+SHITCOINS: Final = {convert.to_address(shitcoin) for shitcoin in _SHITCOINS.get(CHAINID, ())}  # type: ignore [call-overload]
+"""Set of checksummed token addresses to ignore for the current chain.
 
-SHITCOINS = {convert.to_address(shitcoin) for shitcoin in _SHITCOINS.get(CHAINID, ())}  # type: ignore [call-overload]
+This set is derived from the _SHITCOINS mapping for the current CHAINID,
+and is used to filter out unpricable, spam, or otherwise unwanted tokens
+from all Yearn Treasury analytics and reporting.
+"""

yearn_treasury/vaults.py

@@ -1,4 +1,18 @@
-from typing import Dict, Final, List
+"""
+Vault discovery and tracking utilities for Yearn Treasury.
+
+This module discovers Yearn vault contracts and maps them to their
+underlying assets using Yearn's on-chain registry contracts. It
+provides dictionaries for v1 and v2 vaults, supporting transaction
+classification, analytics, and reporting across the Yearn Treasury
+system.
+
+Key Responsibilities:
+    - Discover and map all v1 and v2 vault contracts to underlying assets at startup.
+    - Provide lookup tables for use in vault deposit/withdrawal sort rules.
+"""
+
+from typing import Dict, Final
 
 from brownie import chain
 from eth_typing import ChecksumAddress
@@ -27,11 +41,10 @@ if chain.id == Network.Mainnet:
 
     # TODO: make resolve_ens util in eth-port and refactor this out
     v2_registries = [
-        event["newAddress"].hex()  # type: ignore [attr-defined]
-        for event in Events(addresses=resolver, topics=topics).events(now)
+        event["newAddress"].hex() for event in Events(addresses=resolver, topics=topics).events(now)
     ]
 
     for event in Events(addresses=list(map(str, v2_registries))).events(now):
         if event.name == "NewVault":
             vault_address = event["vault"]
-            v2[vault_address] = Contract(vault_address)  # type: ignore [index]
+            v2[vault_address] = Contract(vault_address)

yearn_treasury/wallets.yaml

@@ -38,4 +38,17 @@
 "0xC001d00d425Fa92C4F840baA8f1e0c27c4297a0B":
 
 # veFarming wallet
-"0x4fc1b14cD213e7B6212145Ba4f180C3d53d1A11e":
+"0x4fc1b14cD213e7B6212145Ba4f180C3d53d1A11e":
+
+### yRoboTreasury Wallets ###
+# https://github.com/yearn/yRoboTreasury/blob/master/deployment.json
+
+# Treasury
+"0xEf77cc176c748d291EfB6CdC982c5744fC7211c8":
+  networks:
+    - 1
+
+# Stables reserve
+"0x278374fFb10B7D16E7633444c13e6E565EA57c28":
+  networks:
+    - 1