yearn-treasury 0.0.20__cp311-cp311-macosx_11_0_arm64.whl → 0.0.49__cp311-cp311-macosx_11_0_arm64.whl

yearn_treasury/__init__.py

@@ -2,9 +2,11 @@ import warnings
 
 from yearn_treasury import budget
 from yearn_treasury._db import prepare_db
+from yearn_treasury._logging import setup_eth_portfolio_logging
 
 
 prepare_db()
+setup_eth_portfolio_logging()
 
 
 warnings.filterwarnings(

yearn_treasury/_db.py

@@ -1,3 +1,16 @@
+"""
+Database labeling utility for Yearn Treasury.
+
+This module provides a helper function to set up address nicknames
+in the database, mapping key Yearn Treasury addresses to human-readable
+labels. It is used during database preparation to ensure that wallet
+addresses are clearly labeled in analytics and reporting.
+
+When Yearn Treasury is imported, this module maps important addresses
+to descriptive nicknames within the DAO Treasury database entity system
+for improved data clarity and prettification of reports.
+"""
+
 # mypy: disable-error-code="arg-type"
 from dao_treasury.db import Address
 from y import Network
@@ -7,6 +20,14 @@ from yearn_treasury import constants
 
 
 def prepare_db() -> None:
+    """
+    Set up address nicknames in the Yearn Treasury database.
+
+    Maps key Yearn Treasury addresses to human-readable labels for improved
+    clarity in analytics and reporting. This function is typically called
+    during database preparation to ensure wallet addresses are labeled
+    within the DAO Treasury database entity system.
+    """
     chad = {Network.Mainnet: "y", Network.Fantom: "f"}[CHAINID]  # type: ignore [index]
 
     labels = {

yearn_treasury/_ens.py

@@ -1,3 +1,17 @@
+"""
+ENS resolver and event topic utilities for Yearn Treasury.
+
+This module defines the ENS resolver contract and event topic set
+used for dynamic vault discovery and event processing. It supports
+vault mapping and analytics by enabling on-chain lookups and event
+filtering for Yearn vaults.
+
+Key Responsibilities:
+    - Provide the ENS resolver contract for vault registry lookups.
+    - Construct event topic sets for AddressChanged events.
+    - Used by vault discovery, analytics, and reporting modules.
+"""
+
 from typing import Final
 
 from brownie import web3

yearn_treasury/_logging.py

@@ -0,0 +1,43 @@
+# mypy: disable-error-code="list-item"
+"""
+Error log suppression utilities for the Yearn Treasury exporter.
+
+This module suppresses noisy or irrelevant eth-portfolio error logs for specific
+token addresses that are known to be deprecated or otherwise unpricable.
+
+To suppress logs for additional tokens, add their addresses to the
+`suppress_logs_for[Network.<chain>]` mapping. The rest will be done
+automatically on package import.
+"""
+
+from typing import Dict, Final, List
+
+from cchecksum import to_checksum_address
+from eth_portfolio._utils import SUPPRESS_ERROR_LOGS
+from eth_typing import HexAddress
+from y import Network
+
+from yearn_treasury.constants import CHAINID
+
+
+suppress_logs_for: Final[Dict[Network, List[HexAddress]]] = {
+    Network.Mainnet: [
+        "0xBF7AA989192b020a8d3e1C65a558e123834325cA",  # unpriceable yvWBTC - This vault had a bug and does not have a pricePerShare
+        "0x5aFE3855358E112B5647B952709E6165e1c1eEEe",  # SAFE - This was not tradeable at the time of the first airdrops
+        "0x718AbE90777F5B778B52D553a5aBaa148DD0dc5D",  # yvCurve-alETH - The underlying curve pool had an issue and is unpriceable
+        "0x3819f64f282bf135d62168C1e513280dAF905e06",  # HDRN
+        "0x5fAa989Af96Af85384b8a938c2EdE4A7378D9875",  # GAL
+    ],
+}
+
+
+def setup_eth_portfolio_logging() -> None:
+    """
+    Suppress eth-portfolio error logs for specific tokens on the current chain.
+
+    Appends token addresses from the suppress_logs_for mapping (for the current
+    CHAINID) to the SUPPRESS_ERROR_LOGS list, preventing error logs for these
+    tokens from being emitted during analytics and reporting.
+    """
+    for token in suppress_logs_for.get(CHAINID, []):  # type: ignore [call-overload]
+        SUPPRESS_ERROR_LOGS.append(to_checksum_address(token))

yearn_treasury/address_labels.yaml

@@ -24,6 +24,16 @@
   YFI Buyer Contract:
     - "0x0000000000884A0E1fB44F9E24Fa3BDB19514fAE"
     - "0x0000000000051666BBfBB42925C3eE5d50cF6B10"
+  Multichain Fantom Bridge:
+    - "0xC564EE9f21Ed8A2d8E7e76c085740d5e4c5FaFbE"
+  yLockers Multisig:
+    - "0x4444AAAACDBa5580282365e25b16309Bd770ce4a"
+  yRoboTreasury Treasury Contract:
+    - "0xEf77cc176c748d291EfB6CdC982c5744fC7211c8"
+  yRoboTreasury Stables Reserve:
+    - "0x278374fFb10B7D16E7633444c13e6E565EA57c28"
+  yearn.fi Dutch Auctions:
+    - "0x861fE45742f70054917B65bE18904662bD0dBd30"
 250:
   Yearn Strategist Multisig:
     - "0x72a34AbafAB09b15E7191822A679f28E067C4a16"

yearn_treasury/budget/__init__.py

@@ -1,6 +1,6 @@
 from yearn_treasury.budget._request import BudgetRequest
-from yearn_treasury.budget._requests import approved_requests, rejected_requests, requests
+from yearn_treasury.budget._requests import approved_requests, budget_requests, rejected_requests
 
 # TODO test
 
-__all__ = ["BudgetRequest", "requests", "approved_requests", "rejected_requests"]
+__all__ = ["BudgetRequest", "budget_requests", "approved_requests", "rejected_requests"]

yearn_treasury/budget/_request.py

@@ -1,3 +1,11 @@
+"""
+Budget request data model for Yearn Treasury.
+
+This module defines the BudgetRequest dataclass, which models a single
+budget request and its state. It provides methods for checking approval,
+rejection, streaming, vesting, and payment status.
+"""
+
 from dataclasses import dataclass
 from logging import getLogger
 from typing import Final, Optional, Set, final

yearn_treasury/budget/_requests.py

@@ -1,10 +1,22 @@
+"""
+Budget request ingestion and filtering for Yearn Treasury.
+
+This module fetches budget requests from GitHub, parses them into
+BudgetRequest objects, and provides lists of approved and rejected
+requests.
+"""
+
 import os
-from requests import get
-from typing import Final, List
+import time
+import requests
+from typing import Any, Dict, Final, List
 
 from yearn_treasury.budget._request import BudgetRequest
 
 
+API_URL: Final = "https://api.github.com/repos/yearn/budget/issues"
+"""URL to fetch issues from the repo."""
+
 # Optionally use a GitHub personal access token for higher API rate limits.
 # TODO move this to envs file and document
 _TOKEN: Final = os.environ.get("GITHUB_TOKEN")
@@ -12,22 +24,16 @@ _HEADERS: Final = {"Authorization": f"token {_TOKEN}"} if _TOKEN else {}
 
 
 def fetch_brs() -> List[BudgetRequest]:
-    # URL to fetch issues from the repo
-    api_url = "https://api.github.com/repos/yearn/budget/issues"
     # Use parameters to fetch issues in all states, up to 100 per page.
-    params = {"state": "all", "per_page": 100, "page": 1}
+    current_page = 1
+    params = {"state": "all", "per_page": 100, "page": current_page}
 
     brs = []
     retries = 0
     while True:
-        response = get(api_url, headers=_HEADERS, params=params)  # type: ignore [arg-type]
-        if response.status_code != 200:
-            if retries < 5:
-                retries += 1
-                continue
-            raise ConnectionError(f"Failed to fetch issues: {response.status_code} {response.text}")
+        response = _make_get_request(params=params)
 
-        data: List[dict] = response.json()
+        data: List[dict] = response.json()  # type: ignore [type-arg]
         if not data:  # If the current page is empty, we are done.
             break
 
@@ -38,7 +44,7 @@ def fetch_brs() -> List[BudgetRequest]:
 
             # TODO labels table in db (also dataclass) with the descriptions included
             # Extract the label names (tags) from the "labels" key.
-            label_objs: List[dict] = item.get("labels", [])
+            label_objs: List[dict] = item.get("labels", [])  # type: ignore [type-arg]
             labels = {label.get("name") for label in label_objs}
 
             if "budget request" not in labels:
@@ -59,11 +65,32 @@ def fetch_brs() -> List[BudgetRequest]:
             brs.append(br)
 
         # Move on to the next page.
-        params["page"] += 1  # type: ignore [operator]
+        current_page += 1
+        params["page"] = current_page
 
     return brs
 
 
-requests = fetch_brs()
-approved_requests = [r for r in requests if r.is_approved()]
-rejected_requests = [r for r in requests if r.is_rejected()]
+def _make_get_request(params: Dict[str, Any]) -> Any:
+    retries = 0
+    while True:
+        try:
+            response = requests.get(API_URL, headers=_HEADERS, params=params)
+            response.raise_for_status()
+            return response
+        except requests.HTTPError as e:
+            if "rate limit exceeded" in str(e):
+                print("Github API rate limited...")
+            elif retries < 5:
+                print(e)
+            else:
+                raise ConnectionError(
+                    f"Failed to fetch issues: {response.status_code} {response.text}"
+                ) from e
+            retries += 1
+            time.sleep(5 * (retries + 1))
+
+
+budget_requests: Final = fetch_brs()
+approved_requests: Final = [r for r in budget_requests if r.is_approved()]
+rejected_requests: Final = [r for r in budget_requests if r.is_rejected()]

yearn_treasury/constants.py

@@ -30,6 +30,10 @@ YCHAD_MULTISIGS: Final = {
     Network.Base: "0xbfAABa9F56A39B814281D68d2Ad949e88D06b02E",
 }
 
+YSWAP_MULTISIGS: Final = {
+    Network.Mainnet: "0x7d2aB9CA511EBD6F03971Fb417d3492aA82513f0",
+}
+
 
 if CHAINID not in TREASURY_MULTISIGS or CHAINID not in YCHAD_MULTISIGS:
     raise RuntimeError(f"{Network(CHAINID)} is not supported")
@@ -39,6 +43,8 @@ TREASURY_MULTISIG: Final = convert.to_address(TREASURY_MULTISIGS[CHAINID])  # ty
 
 YCHAD_MULTISIG: Final = convert.to_address(YCHAD_MULTISIGS[CHAINID])  # type: ignore [index]
 
+__yswap_multisig = YSWAP_MULTISIGS.get(CHAINID)  # type: ignore [call-overload]
+YSWAP_MULTISIG: Final = convert.to_address(__yswap_multisig) if __yswap_multisig else None
 
 _TREASURY_WALLETS: Final = {
     Network.Mainnet: {
@@ -46,7 +52,7 @@ _TREASURY_WALLETS: Final = {
         YCHAD_MULTISIG,
         "0xb99a40fcE04cb740EB79fC04976CA15aF69AaaaE",  # Yearn Treasury V1
         "0x5f0845101857d2A91627478e302357860b1598a1",  # Yearn KP3R Wallet
-        "0x7d2aB9CA511EBD6F03971Fb417d3492aA82513f0",  # ySwap Multisig
+        YSWAP_MULTISIG,
         "0x2C01B4AD51a67E2d8F02208F54dF9aC4c0B778B6",  # yMechs Multisig
         "0xE376e8e8E3B0793CD61C6F1283bA18548b726C2e",  # Fee Reimbursement Stash
         "0xC001d00d425Fa92C4F840baA8f1e0c27c4297a0B",  # New token dumping wallet
@@ -59,6 +65,16 @@ TREASURY_WALLETS: Final = {
 }
 
 
+YFI: Final = {
+    Network.Mainnet: "0x0bc529c00C6401aEF6D220BE8C6Ea1667F6Ad93e",
+    Network.Fantom: "0x29b0Da86e484E1C0029B56e817912d778aC0EC69",
+    Network.Arbitrum: "0x82e3A8F066a6989666b031d916c43672085b1582",
+    Network.Polygon: "0xDA537104D6A5edd53c6fBba9A898708E465260b6",
+}.get(
+    CHAINID, None
+)  # type: ignore [call-overload]
+
+
 class Args:
     wallets: Final[Path] = _YEARN_TREASURY_ROOT_DIR / "wallets.yaml"
     # TODO: update dashboard def to use this label (we will need to migrate the provisioning files to yearn-treasury but we need to do this anyway for yearn-specific additions)
@@ -71,3 +87,6 @@ class Args:
 
     nicknames: Final[Path] = _YEARN_TREASURY_ROOT_DIR / "address_labels.yaml"
     """The path where yearn-treasury's address nicknames are defined."""
+
+    custom_bucket: Final[list[str]] = [f"{YFI}:Other long term assets"]
+    """Custom bucket mapping for token addresses, tells DAO Treasury to categorize YFI as 'Other long term assets'."""

yearn_treasury/main.py

@@ -2,9 +2,9 @@
 Command-line interface for the Yearn Treasury exporter.
 
 This module provides the `yearn-treasury` CLI, which connects to a Brownie network
-based on the `--network` option (or the `BROWNIE_NETWORK_ID` environment variable),
-periodically snapshots treasury balances via :func:`export_balances`, and
-pushes metrics to Victoria Metrics.
+(based on the `--network` option or the `BROWNIE_NETWORK_ID` environment variable),
+periodically snapshots treasury metrics, and pushes them to Victoria Metrics.
+It also launches Yearn Treasury's Grafana dashboard and an optional renderer for visual reports.
 
 Example:
     Run export every 12 hours on mainnet:
@@ -12,15 +12,24 @@ Example:
     .. code-block:: bash
 
         yearn-treasury run --network mainnet --interval 12h
+
+CLI Options:
+    --network         Brownie network identifier (default: mainnet)
+    --interval        Time interval between datapoints (default: 12h)
+    --concurrency     Max number of historical blocks to export concurrently (default: 30)
+    --daemon          Run as a background daemon (currently unsupported)
+    --grafana-port    Port for the Grafana dashboard (default: 3004)
+    --victoria-port   Port for the Victoria metrics endpoint (default: 8430)
+    --start-renderer  Start the Grafana renderer container for dashboard image export
+    --renderer-port   Port for the renderer service (default: 8080)
 """
 
 import asyncio
 import os
 from argparse import ArgumentParser
-from pathlib import Path
 from typing import Final, final
 
-from eth_portfolio_scripts.balances import export_balances
+from yearn_treasury import yteams
 
 
 parser = ArgumentParser(description="Treasury CLI")
@@ -39,6 +48,12 @@ run_parser.add_argument(
     help="The time interval between datapoints. Default: 12h",
     default="12h",
 )
+run_parser.add_argument(
+    "--concurrency",
+    type=int,
+    help="The max number of historical blocks to export concurrently. default: 30",
+    default=30,
+)
 run_parser.add_argument(
     "--daemon",
     action="store_true",
@@ -77,24 +92,21 @@ BROWNIE_NETWORK = os.environ["BROWNIE_NETWORK_ID"]
 # TODO: run forever arg
 def main() -> None:
     """
-    Connect to the configured Brownie network and start the export loop.
+    Connect to the configured Brownie network, clean up the database, and start the export loop.
 
     This function is registered as a console script entrypoint under
-    ``yearn-treasury`` and delegates execution to Brownie's script runner.
-
-    Steps:
+    ``yearn-treasury``. It performs the following steps:
         1. Reads the ``BROWNIE_NETWORK_ID`` environment variable (populated from
            the ``--network`` option or existing env var).
-        2. Connects to that Brownie network.
-        3. Patches the global SHITCOINS mapping with local tokens.
-        4. Constructs a frozen Args subclass to pass CLI parameters to
-           :func:`export_balances`.
-        5. Exports ports for external services into environment variables.
-        6. Runs :func:`eth_portfolio_scripts.balances.export_balances` under asyncio.
-
-    Raises:
-        RuntimeError: If the Brownie network cannot be determined.
+        2. Connects to the specified Brownie network.
+        3. Merges local SHITCOINS into eth_portfolio's config to skip tokens we don't care about.
+        4. Drops any shitcoin transactions that might be in the database.
+        5. Constructs an immutable Args subclass to pass CLI parameters to
+           :func:`dao_treasury.main.export`.
+        6. Exports ports for external services into environment variables.
+        7. Runs both the DAO Treasury export and Yearn team revenue/expenses calculation concurrently under asyncio.
     """
+    import dao_treasury.db
     import eth_portfolio
 
     from . import constants, rules, shitcoins
@@ -102,10 +114,16 @@ def main() -> None:
     # Merge local SHITCOINS into eth_portfolio's config to skip tokens we don't care about
     eth_portfolio.SHITCOINS[constants.CHAINID].update(shitcoins.SHITCOINS)  # type: ignore [index]
 
+    # Drop any shitcoin txs that might be in the db
+    dao_treasury.db._drop_shitcoin_txs()
+
     @final
     class Args(constants.Args):
         """
-        Immutable container of CLI arguments for :func:`~export_balances`.
+        Immutable container of CLI arguments for export and dashboard/renderer configuration.
+
+        Inherits from DAO Treasury's :class:`constants.Args` and is used to pass runtime
+        parameters to the DAO Treasury export and related services.
         """
 
         network: Final[str] = args.network
@@ -114,6 +132,9 @@ def main() -> None:
         interval: Final[str] = args.interval
         """Time interval between snapshots."""
 
+        concurrency: Final[int] = args.concurrency
+        """The max number of historical blocks to export concurrently."""
+
         grafana_port: Final[int] = args.grafana_port
         """Grafana port."""
 
@@ -136,7 +157,20 @@ def main() -> None:
     os.environ["DAO_TREASURY_RENDERER_PORT"] = str(Args.renderer_port)
     os.environ["VICTORIA_PORT"] = str(Args.victoria_port)
 
+    async def yearn_wrapper():
+        """
+        Run the DAO Treasury export and Yearn team revenue/expenses calculation concurrently.
+
+        This coroutine gathers:
+            - The main DAO Treasury export process (dao_treasury.main.export)
+            - The Yearn teams' revenue and expenses calculation (yteams.calculate_teams_revenue_expenses)
+        """
+        return await asyncio.gather(
+            dao_treasury.main.export(Args),
+            yteams.calculate_teams_revenue_expenses(),
+        )
+
     # Start the balance export routine
-    asyncio.get_event_loop().run_until_complete(dao_treasury.main.export(Args))
+    asyncio.get_event_loop().run_until_complete(yearn_wrapper())
 
     rules  # I just put this here so the import isn't flagged as unused

yearn_treasury/rules/__init__.py

@@ -1,6 +1,20 @@
+import os
+
+__ALRU_ENV_NAME = "ASYNC_LRU_ALLOW_SYNC"
+__ALRU_ENV_VAL = os.environ.get(__ALRU_ENV_NAME)
+os.environ[__ALRU_ENV_NAME] = "1"
+
 from yearn_treasury.rules.cost_of_revenue import *
 from yearn_treasury.rules.expense import *
 from yearn_treasury.rules.ignore import *
 from yearn_treasury.rules.other_expense import *
 from yearn_treasury.rules.other_income import *
 from yearn_treasury.rules.revenue import *
+
+if __ALRU_ENV_VAL is None:
+    os.environ.pop(__ALRU_ENV_NAME)
+else:
+    os.environ[__ALRU_ENV_NAME] = __ALRU_ENV_VAL
+
+del __ALRU_ENV_NAME
+del __ALRU_ENV_VAL

yearn_treasury/rules/cost_of_revenue/gas.py

@@ -1,3 +1,11 @@
+"""
+Gas cost rules for Yearn Treasury.
+
+This module defines rules and matching logic for classifying gas-related
+transactions as cost of revenue. It includes logic for multisig
+reimbursements, strategist gas, returned gas, and more.
+"""
+
 # mypy: disable-error-code="call-overload"
 from typing import Final, Set
 
@@ -27,7 +35,7 @@ gas("Other Gas").match(
 
 _STRATEGIST_GAS_HASHES: Final[Set[HexStr]] = {}.get(CHAINID, set())
 
-_RETURNED_GAS_HASHES: Final[Set[HexStr]] = {
+_RETURNED_GAS_HASHES: Final[Set[HexStr]] = {  # type: ignore [assignment]
     Network.Mainnet: {
         "0x86fee63ec8efb0e7320a6d48ac3890b1089b77a3d9ed74cade389f512471c299",
         "0xa77c4f7596968fef96565a0025cc6f9881622f62cc4c823232f9c9000ba5f981",

yearn_treasury/rules/expense/infrastructure.py

@@ -1,3 +1,10 @@
+"""
+Expense rules for infrastructure payments.
+
+This module defines matching logic for infrastructure-related expenses,
+including Tenderly, Wonderland Jobs, and generic infra payments.
+"""
+
 from typing import Final
 
 from dao_treasury import TreasuryTx, expense

yearn_treasury/rules/expense/people.py

@@ -39,3 +39,46 @@ def is_coordinape(tx: TreasuryTx) -> bool:
 def is_ygift_grant(tx: TreasuryTx) -> bool:
     """Yearn used to use yGift to send team grants but that ended up being too expensive."""
     return tx.to_nickname == "Contract: yGift" and tx.symbol == "yyDAI+yUSDC+yUSDT+yTUSD"
+
+
+# TODO: refactor all of this, there's gotta be a better way to handle yteams who have received both one-off and streamed pmnts
+@grants("yHAAS Trinity [BR#263]")
+def is_yhaas_trinity_ii(tx: TreasuryTx) -> bool:
+    """https://github.com/yearn/budget/issues/263"""
+    return (
+        tx.hash == "0xd35c30664f3241ea2ec3df1c70261086247025eb72c2bc919108dfef9b08a450"
+        and tx.to_address.address
+        in (
+            # team
+            "0x35a83D4C1305451E0448fbCa96cAb29A7cCD0811",
+            # stream
+            "0xEC83C8c3156e4f6b95B048066F3b308C93cb5848",
+        )
+    )
+
+
+@grants("G-Team [BR#267]")
+def is_gteam(tx: TreasuryTx) -> bool:
+    """https://github.com/yearn/budget/issues/267"""
+    return (
+        tx.hash == "0xd35c30664f3241ea2ec3df1c70261086247025eb72c2bc919108dfef9b08a450"
+        and tx.to_address == "0x63E02F93622541CfE41aFedCF96a114DB71Ba4EE"
+    )
+
+
+@grants("Rantom [BR#129]")
+def is_rantom(tx: TreasuryTx) -> bool:
+    """https://github.com/yearn/budget/issues/129"""
+    return tx.to_address == "0x254b42CaCf7290e72e2C84c0337E36E645784Ce1"
+
+
+@grants("Worms")
+def is_worms(tx: TreasuryTx) -> bool:
+    return tx.to_address == "0xB1d693B77232D88a3C9467eD5619FfE79E80BCCc"
+
+
+# NOTE: this needs to go at the bottom because there are some streams that will already be caught by above matchers
+@grants("Simple Vesting Escrow")
+def is_simple_vesting_escrow(tx: TreasuryTx) -> bool:
+    # TODO: amortize the streamed funds as a daily amount and sort more granularly based on BR
+    return tx.to_nickname == "Contract: Simple Vesting Escrow"

yearn_treasury/rules/expense/security.py

@@ -1,3 +1,11 @@
+"""
+Expense rules for security, audits, and bug bounties.
+
+This module defines matching logic for security-related expenses,
+including audits (yAcademy, ChainSec, StateMind, MixBytes, unspecified),
+bug bounties, and other security-related deliverables.
+"""
+
 from typing import Final
 
 from dao_treasury import TreasuryTx, expense
@@ -6,6 +14,7 @@ from y import Network
 
 security: Final = expense("Security")
 audits: Final = security("Audits")
+grants: Final = security("Grants")
 
 
 @audits("yAcademy", Network.Mainnet)
@@ -128,3 +137,11 @@ def is_warroom_help(tx: TreasuryTx) -> bool:
         tx.hash == "0xca61496c32806ba34f0deb331c32969eda11c947fdd6235173e6fa13d9a1c288"
         and tx.log_index == 152
     )
+
+
+@grants("ySecurity", Network.Mainnet)
+def is_ysecurity(tx: TreasuryTx) -> bool:
+    """
+    https://github.com/yearn/budget/issues/145
+    """
+    return tx.to_address == "0x4851C7C7163bdF04A22C9e12Ab77e184a5dB8F0E"