yearn-treasury 0.0.33__tar.gz → 0.0.34__tar.gz

{yearn_treasury-0.0.33/yearn_treasury.egg-info → yearn_treasury-0.0.34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yearn_treasury
-Version: 0.0.33
+Version: 0.0.34
 Summary: This WIP library runs the eth-portfolio and dao-treasury exporters for the Yearn Finance treasury.
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10,<3.13
 Description-Content-Type: text/markdown
-Requires-Dist: dao-treasury<0.1,>=0.0.50
+Requires-Dist: dao-treasury<0.1,>=0.0.51
 Requires-Dist: eth-brownie<1.23,>=1.21.0
 Dynamic: classifier
 Dynamic: description

{yearn_treasury-0.0.33 → yearn_treasury-0.0.34}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "yearn-treasury"
-version = "0.0.33"
+version = "0.0.34"
 description = "This WIP library runs the eth-portfolio and dao-treasury exporters for the Yearn Finance treasury."
 authors = ["Bob The Buidler <you@example.com>"]
 packages = [{ include = "yearn_treasury/*" }]
@@ -22,7 +22,7 @@ yearn-treasury = "yearn_treasury.main:main"
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
-dao-treasury = ">=0.0.50,<0.1"
+dao-treasury = ">=0.0.51,<0.1"
 eth-brownie = ">=1.21.0,<1.23"
 
 [tool.poetry.group.dev.dependencies]

{yearn_treasury-0.0.33 → yearn_treasury-0.0.34}/yearn_treasury/_db.py

@@ -20,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-0.0.33 → yearn_treasury-0.0.34}/yearn_treasury/_logging.py

@@ -1,6 +1,13 @@
 # mypy: disable-error-code="list-item"
 """
-This file contains logic for suppressing eth-portfolio error logs where desired.
+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
@@ -23,5 +30,12 @@ suppress_logs_for: Final[Dict[Network, List[HexAddress]]] = {
 
 
 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-0.0.33 → yearn_treasury-0.0.34}/yearn_treasury/shitcoins.py

@@ -9,14 +9,16 @@ 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 portfolio calculations, reports, and dashboards.
+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",
@@ -98,6 +100,8 @@ _SHITCOINS = {
         "0xa3Efa0929569c15c20f89B591931899Fb05B4663",  # GPT-5
         "0x0A953979fdCfD82B08C77dB29705327BeC39ff13",  # GROK4 AI
         "0xc83377b9eE3CEe4Cc03CCd58AfdE1FB12864aEE3",  # E AI
+        "0x927402ab67c0CDA3c187E9DFE34554AC581441f2",  # SAITABIT
+        "0x691539810DF6e879A377C24CfEE130BBE92708d8",  # NVIDIA AI
         # matt furry spam
         "0x73228b3D33cC71cB721Fc62950577bE63bd9c8C9",  # Maskman by Matt Furie
         "0x7c28e66436C93BB9F657dDF2BA0eeeCf61369b92",  # Bloodboy by Matt Furie
@@ -105,11 +109,22 @@ _SHITCOINS = {
         "0xBd6555eC87C8A9a2280dCD6df45b9b074fC93Df2",  # Bork by Matt Furie
         # test token
         "0x2F375Ce83EE85e505150d24E85A1742fd03cA593",  # TEST
-        # generally looks like shit (move to eth-portfolio)
-        "0xE8ED1fca5af1c7dd46A3D5bbDFf7e99749D9e0aa",  # Hachi
-        "0x00d0F0250364C431376cC64AADd3aa13c6A8998D",  # SMEGMA
     ),
 }
+"""
+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-0.0.33 → yearn_treasury-0.0.34/yearn_treasury.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yearn_treasury
-Version: 0.0.33
+Version: 0.0.34
 Summary: This WIP library runs the eth-portfolio and dao-treasury exporters for the Yearn Finance treasury.
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10,<3.13
 Description-Content-Type: text/markdown
-Requires-Dist: dao-treasury<0.1,>=0.0.50
+Requires-Dist: dao-treasury<0.1,>=0.0.51
 Requires-Dist: eth-brownie<1.23,>=1.21.0
 Dynamic: classifier
 Dynamic: description

{yearn_treasury-0.0.33 → yearn_treasury-0.0.34}/yearn_treasury.egg-info/requires.txt

@@ -1,2 +1,2 @@
-dao-treasury<0.1,>=0.0.50
+dao-treasury<0.1,>=0.0.51
 eth-brownie<1.23,>=1.21.0