dao-treasury 0.0.39__cp312-cp312-musllinux_1_2_i686.whl → 0.0.40__cp312-cp312-musllinux_1_2_i686.whl

dao_treasury/ENVIRONMENT_VARIABLES.py

@@ -1,3 +1,15 @@
+"""Environment variable configuration for DAO Treasury.
+
+Defines and loads environment variables (with types and defaults) used for
+system configuration, such as SQL debugging. Uses :mod:`typed_envs` for convenience and safety.
+
+Key Responsibilities:
+    - Define and load environment variables for the system.
+    - Provide type-safe access to configuration options.
+
+This is the single source of truth for environment-based settings.
+"""
+
 from typing import Final
 
 from typed_envs import EnvVarFactory

dao_treasury/__init__.py

@@ -1,3 +1,17 @@
+"""DAO Treasury package initializer.
+
+Exposes the main public API for the library, including the Treasury class,
+wallet management, sorting rules, and database models. Sets up address
+nicknames and enables SQL debugging if configured.
+
+Key Responsibilities:
+    - Import and expose core classes and functions.
+    - Initialize address nicknames in the database.
+    - Configure SQL debugging for development.
+
+This is the main import point for users and integrations.
+"""
+
 from dao_treasury import ENVIRONMENT_VARIABLES as ENVS
 from dao_treasury._nicknames import setup_address_nicknames_in_db
 from dao_treasury._wallet import TreasuryWallet

dao_treasury/_docker.py

@@ -1,4 +1,17 @@
-"""This module contains utilities for managing dao-treasury's docker containers"""
+"""Docker orchestration utilities for DAO Treasury.
+
+Provides functions to build, start, and stop Docker Compose services
+required for analytics dashboards (Grafana, renderer). Integrates with
+eth-portfolio's Docker setup and ensures all containers are managed
+consistently for local analytics.
+
+Key Responsibilities:
+    - Build and manage Grafana and renderer containers.
+    - Integrate with eth-portfolio Docker services.
+    - Provide decorators/utilities for container lifecycle management.
+
+This is the main entry for all Docker-based orchestration.
+"""
 
 import logging
 from importlib import resources

dao_treasury/_nicknames.py

@@ -1,3 +1,18 @@
+"""Address nickname setup utilities.
+
+This module provides functions to assign human-readable nicknames to
+important on-chain addresses (e.g., Zero Address, Disperse.app, tokens).
+It is used at package initialization to ensure all analytics and dashboards
+display professional, consistent labels.
+
+Key Responsibilities:
+    - Set nicknames for core addresses in the database.
+    - Integrate with constants and token metadata.
+    - Support professional, readable analytics outputs.
+
+This is called automatically on package import.
+"""
+
 from typing import Final
 
 from pony.orm import db_session

dao_treasury/constants.py

@@ -1,11 +1,29 @@
+"""Core constants for DAO Treasury.
+
+All constants are marked with `Final`, ensuring immutability and allowing
+mypyc to compile them as extremely fast C-level constants for maximum
+performance. Defines chain IDs, zero address, and key contract addresses
+(e.g., Disperse.app) used throughout the system for transaction processing,
+nickname assignment, and analytics.
+
+Key Responsibilities:
+    - Provide canonical addresses and chain IDs.
+    - Support nickname setup and transaction categorization.
+    - Guarantee fast, immutable constants at runtime.
+
+This is the single source of truth for system-wide constants.
+"""
+
 from typing import Final
 
 import y.constants
 
 
 CHAINID: Final = y.constants.CHAINID
+# TODO: add docstring
 
 ZERO_ADDRESS: Final = "0x0000000000000000000000000000000000000000"
+# TODO: add docstring
 
 # TODO: move disperse.app stuff from yearn-treasury to dao-treasury and then write a docs file
 DISPERSE_APP: Final = (
@@ -13,3 +31,4 @@ DISPERSE_APP: Final = (
     "0xd15fE25eD0Dba12fE05e7029C88b10C25e8880E3",
 )
 """If your treasury sends funds to disperse.app, we create additional txs in the db so each individual send can be accounted for."""
+# TODO: all crosslink to disperse.py once ready

dao_treasury/db.py

@@ -3,6 +3,7 @@
 Database models and utilities for DAO treasury reporting.
 
 This module defines Pony ORM entities for:
+
 - Blockchain networks (:class:`Chain`)
 - On-chain addresses (:class:`Address`)
 - ERC-20 tokens and native coin placeholder (:class:`Token`)
@@ -25,6 +26,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Dict, Final, Tuple, Union, final
 from datetime import date, datetime, time, timezone
 
+import eth_portfolio
 from a_sync import AsyncThreadPoolExecutor
 from brownie import chain
 from brownie.convert.datatypes import HexString
@@ -1383,3 +1385,24 @@ def _validate_integrity_error(
         )
         else None
     )
+
+
+def _drop_shitcoin_txs() -> None:
+    """
+    Purge any shitcoin txs from the db.
+
+    These should not be frequent, and only occur if a user populated the db before a shitcoin was added to the SHITCOINS mapping.
+    """
+    shitcoins = eth_portfolio.SHITCOINS[CHAINID]
+    with db_session:
+        shitcoin_txs = select(
+            tx for tx in TreasuryTx if tx.token.address.address in shitcoins
+        )
+        if count := shitcoin_txs.count():
+            logger.info(f"Purging {count} shitcoin txs from the database...")
+            for tx in shitcoin_txs:
+                tx.delete()
+            logger.info("Shitcoin tx purge complete.")
+
+
+_drop_shitcoin_txs()

dao_treasury/sorting/rules/ignore/__init__.py

@@ -1,2 +1 @@
 from dao_treasury.sorting.rules.ignore.llamapay import *
-from dao_treasury.sorting.rules.ignore.shitcoins import *

dao_treasury/treasury.py

@@ -1,3 +1,20 @@
+"""Treasury orchestration and analytics interface.
+
+This module defines the Treasury class, which aggregates DAO wallets, sets up
+sorting rules, and manages transaction ingestion and streaming analytics.
+It coordinates the end-to-end flow from wallet configuration to database
+population and dashboard analytics.
+
+Key Responsibilities:
+    - Aggregate and manage DAO-controlled wallets.
+    - Ingest and process on-chain transactions.
+    - Apply sorting/categorization rules.
+    - Integrate with streaming protocols (e.g., LlamaPay).
+    - Populate the database for analytics and dashboards.
+
+This is the main entry point for orchestrating DAO treasury analytics.
+"""
+
 from asyncio import create_task, gather
 from logging import getLogger
 from pathlib import Path
@@ -59,20 +76,22 @@ class Treasury(a_sync.ASyncGenericBase):  # type: ignore [misc]
             TypeError: If any item in `wallets` is not a str or TreasuryWallet.
 
         Examples:
-            Create a synchronous Treasury:
-            >>> treasury = Treasury(
-            ...     wallets=["0xAbc123...", TreasuryWallet("0xDef456...", start_block=1000)],
-            ...     sort_rules=Path("/path/to/rules"),
-            ...     start_block=500,
-            ...     label="DAO Treasury",
-            ...     asynchronous=False
-            ... )
-
-            Create an asynchronous Treasury:
-            >>> treasury_async = Treasury(
-            ...     wallets=["0xAbc123..."],
-            ...     asynchronous=True
-            ... )
+            .. code-block:: python
+
+                # Create a synchronous Treasury
+                treasury = Treasury(
+                    wallets=["0xAbc123...", TreasuryWallet("0xDef456...", start_block=1000)],
+                    sort_rules=Path("/path/to/rules"),
+                    start_block=500,
+                    label="DAO Treasury",
+                    asynchronous=False
+                )
+
+                # Create an asynchronous Treasury
+                treasury_async = Treasury(
+                    wallets=["0xAbc123..."],
+                    asynchronous=True
+                )
         """
         global TREASURY
         if TREASURY is not None:

{dao_treasury-0.0.39.dist-info → dao_treasury-0.0.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dao_treasury
-Version: 0.0.39
+Version: 0.0.40
 Summary: Produce comprehensive financial reports for your on-chain org
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -14,7 +14,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10,<3.13
 Description-Content-Type: text/markdown
-Requires-Dist: eth-portfolio-temp<0.1,>=0.0.34.dev0
+Requires-Dist: eth-portfolio-temp<0.1,>=0.0.35.dev0
 Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type

{dao_treasury-0.0.39.dist-info → dao_treasury-0.0.40.dist-info}/RECORD

@@ -1,20 +1,20 @@
-8a0ad9a1a4146730a0f6__mypyc.cpython-312-i386-linux-musl.so,sha256=sNVRYN_uVp7XcRdNBgRoPUgg4LJsVYxflJ6wPFuLdKo,1647352
-dao_treasury/ENVIRONMENT_VARIABLES.py,sha256=yKvgOMUyU7-fF_-1zSMXML7ah7-r2f0oHrOV0p10LPc,195
-dao_treasury/__init__.py,sha256=ZQ0ZROQzSyJdYuQS1Z_VD0c7CiV8BWZcLTX66wO4slc,1004
-dao_treasury/_docker.cpython-312-i386-linux-musl.so,sha256=nbAH0SJCYXs4vgF-wp5rLvS3xUPMAdKXys77PhspvLU,16708
-dao_treasury/_docker.py,sha256=7MnPA5xhRCM8Kqiogk87ltUVn8i_hpkNgO_hFC-7sPw,5430
-dao_treasury/_nicknames.cpython-312-i386-linux-musl.so,sha256=rW9eE6GPO9gEj6Rc0gs9cL38IGkFlMWkXo9mnV9Zw28,16716
-dao_treasury/_nicknames.py,sha256=deSpcDMtC_78C07tW0fZ_NzHIfHXsoHBVXfb_Dvlzsw,480
-dao_treasury/_wallet.cpython-312-i386-linux-musl.so,sha256=ScXmoPpWIXQofuxADW5-1iBdHxT_CxEQckH_dRIRqa4,16708
+bf2b4fe1f86ad2ea158b__mypyc.cpython-312-i386-linux-musl.so,sha256=3v6bz-rwl3RyxAuWQcvm-5Bwo8Ha85YuRv_o70RDAwI,1630524
+dao_treasury/ENVIRONMENT_VARIABLES.py,sha256=LEczR1MSWTY00sLHnFs3j_Jm8WZNJCxjwEzrvjbwl2E,636
+dao_treasury/__init__.py,sha256=W4syl9-cNhHOdD25ye9U7aBJTLE_R-uP49FXC_6CUOE,1477
+dao_treasury/_docker.cpython-312-i386-linux-musl.so,sha256=ozlr3PDmG2rjhNWOKQeaQ_UL7XtHJn9DhcNFSfpwZFE,16708
+dao_treasury/_docker.py,sha256=b3exLlhtaC9S3osrLQsL8SIOLKUtSoop2uue0cSP9WM,5908
+dao_treasury/_nicknames.cpython-312-i386-linux-musl.so,sha256=GvrGVuN8PA-HWV1_KYjEPXeX3KiKh3t20-6sKpyUbxw,16716
+dao_treasury/_nicknames.py,sha256=bvz0b8C31tFQ0pGtpSJW86OwjUF_qMBal4VXVT5UyLo,1017
+dao_treasury/_wallet.cpython-312-i386-linux-musl.so,sha256=PTEl-KbIltkUq0N8paKW_LGveE9ihxfd91vDMjiAgow,16708
 dao_treasury/_wallet.py,sha256=epV8LVuwHlOzc9UkA66js7HfEiZBOSAGJMtWbDTzmjU,10462
-dao_treasury/constants.cpython-312-i386-linux-musl.so,sha256=kWu_EWR4t3sNqNbFNW8084g-go04Txfa8oFS1HnI1Pc,16716
-dao_treasury/constants.py,sha256=IFg_CyVnfPhPjKyFX1Ix4QaB8ghbOI5QZGSy2TNsUSA,507
-dao_treasury/db.py,sha256=Qc95xWNIR_Wk7jutJnBe2eMntxRrdd2_pj68hqVK8kA,47318
+dao_treasury/constants.cpython-312-i386-linux-musl.so,sha256=129zODj8o7HJWBiuueXA7Ith9K55bYfDny1uM8FD0NY,16716
+dao_treasury/constants.py,sha256=MM4X4TK2RD1JaTNMg7zdo6QjKZTTvep6g7TgckE7M-8,1220
+dao_treasury/db.py,sha256=PfXCm8v4sLWdj3lenLJBA_076in300qKUSN9xdBEOCE,48013
 dao_treasury/docker-compose.yaml,sha256=E6KE-IjWDisAM19PPDi4ApR6Eu7jmMTM6J9DhtgJvR4,1309
 dao_treasury/main.py,sha256=31EA10Fpaj9y-cRJPnNnvCBI38UM0848xlzn7A0BzC4,8047
 dao_treasury/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dao_treasury/treasury.py,sha256=7xLVQPqnDd3cexbYuF1opTjCiHgkPqHFOanRom8wiLE,6506
-dao_treasury/types.cpython-312-i386-linux-musl.so,sha256=BPyNYfEYJtwS5bxPQ4Vgp9lSB81hKMne7FNHZTCrzqg,16700
+dao_treasury/treasury.py,sha256=taTvwTH_Zdu2M61TrUCENcIUjxdQO3vryrZ2iVb6suM,7223
+dao_treasury/types.cpython-312-i386-linux-musl.so,sha256=rqTkHgzl8J9nob3oIvYBHGc1ElvN4aexOFaDX4oXe5E,16700
 dao_treasury/types.py,sha256=dJDx0hYfDDL3slcUzRnCgrzFFsgCzoqg8uaTtLaT4kk,3685
 dao_treasury/.grafana/provisioning/dashboards/dashboards.yaml,sha256=tr6FBJeAAPX76db8E3qBBVWnq2-yrWDXDGuclMDg6dw,1277
 dao_treasury/.grafana/provisioning/dashboards/streams/LlamaPay.json,sha256=9OzlVtq0wRBDw3MhoaYLrT_hd7w_V3c_B7bYNmX4TJo,7023
@@ -25,29 +25,27 @@ dao_treasury/.grafana/provisioning/dashboards/treasury/Cashflow.json,sha256=DOpO
 dao_treasury/.grafana/provisioning/dashboards/treasury/Operating Cashflow.json,sha256=tKtUeBp9p-g21MOaFMPItUoXF_coHMM000yNipNB_RU,14352
 dao_treasury/.grafana/provisioning/dashboards/treasury/Treasury.json,sha256=p9bupL06-CKqkqCOb6KkgP1LCa6P1VMkq3yhkyqMAzI,70178
 dao_treasury/.grafana/provisioning/datasources/datasources.yaml,sha256=mjQs8or651NgD_bZnKBm8vSghzjw_g3enL01YPt0dik,327
-dao_treasury/sorting/__init__.cpython-312-i386-linux-musl.so,sha256=mbOENWFhdPkRlMgDIvU7UYD2iGRMLbWx-5LeWs8_PWA,16708
+dao_treasury/sorting/__init__.cpython-312-i386-linux-musl.so,sha256=Xil7Y1Hg4C95jot13FNXm8Y-BiVTbdpOC_hkBbbuYN4,16708
 dao_treasury/sorting/__init__.py,sha256=vKj3NPB7EWbX7_fSUWKXk-NsyPasOkFhJvJVGclBOAE,10371
-dao_treasury/sorting/_matchers.cpython-312-i386-linux-musl.so,sha256=Qm7i7BD8es9Mj8KNjFGbZqV5cv07Yg7p39aKFkSYtiM,16732
+dao_treasury/sorting/_matchers.cpython-312-i386-linux-musl.so,sha256=SMm4wU1zQUHltnEzuKmL-lsIAL503y3PHZdi5KaETw8,16732
 dao_treasury/sorting/_matchers.py,sha256=u0GfPYiODr_NtzbfyLxEKDuXmWRiaeuZulDj9FPDOH8,14005
-dao_treasury/sorting/_rules.cpython-312-i386-linux-musl.so,sha256=RHLpOY3TV73W8xI9ig6_Un2XgGe0mp5WX6YbBGaHlSw,16716
+dao_treasury/sorting/_rules.cpython-312-i386-linux-musl.so,sha256=HwNWoOF49gVDzVq6SC8OXyji4EPUaNLZBijpxj-5Kh8,16716
 dao_treasury/sorting/_rules.py,sha256=vWkqJVA8yCHKRv9sw872Jq6G0zpM-v_J1jCz-Mgleec,8994
-dao_treasury/sorting/factory.cpython-312-i386-linux-musl.so,sha256=4ejQ9SSR3xD2HVpZMGfnAZPrAkykAZXDKpzSO5mbXNY,16724
+dao_treasury/sorting/factory.cpython-312-i386-linux-musl.so,sha256=4Sva3foG3MNwOSSQEHUUMyKXMy7D9SVD_tJuVFqHT4Y,16724
 dao_treasury/sorting/factory.py,sha256=pFD6luc0bKxOTT1hlAp3ZwJw6R0wN8pjIZrqMZwhsko,10185
-dao_treasury/sorting/rule.cpython-312-i386-linux-musl.so,sha256=-5jgd62cUmoAJ1zAYXOU4HuuyOTFiwABSADBIlkmg9I,16708
+dao_treasury/sorting/rule.cpython-312-i386-linux-musl.so,sha256=7Gqjt2BfttiZfB05aphYZt44mKuT7c5FgU2j-_t7eTo,16708
 dao_treasury/sorting/rule.py,sha256=-4dokQbRJ2GPJLEwtpgGG0aXAM1pW4jI17aezo--Z5g,11491
-dao_treasury/sorting/rules/__init__.cpython-312-i386-linux-musl.so,sha256=qcLw-P1nQUo-UULXBdQRULZ0xEfVg9vsxkXS0Pe926M,16716
+dao_treasury/sorting/rules/__init__.cpython-312-i386-linux-musl.so,sha256=_EGbIcGKlhQPlhIvoj-tXBPtWmVXS3Oq-V5CqMpzNQI,16716
 dao_treasury/sorting/rules/__init__.py,sha256=ofzIsW0P74kuKr6DlScZIF8p7hBh6guRpe1uOq6oLLA,48
-dao_treasury/sorting/rules/ignore/__init__.cpython-312-i386-linux-musl.so,sha256=UBroPZoEPt_xUj90DuxCQqh_TAN6JFElB91LwV92st0,16728
-dao_treasury/sorting/rules/ignore/__init__.py,sha256=JFmwn1bIX5UYDnCH0UU4UTFUFSFaqL-VBG9SYtJGYtI,115
-dao_treasury/sorting/rules/ignore/llamapay.cpython-312-i386-linux-musl.so,sha256=efLJmyE99kSmldL8BDh9kpgxNeMmA7Pf0rGTIF1hZnU,16752
+dao_treasury/sorting/rules/ignore/__init__.cpython-312-i386-linux-musl.so,sha256=B_aYUsGFjfUaHoGJeqIegII_EdRf9jgwbHDB5fEjfGY,16728
+dao_treasury/sorting/rules/ignore/__init__.py,sha256=dJ4oKSLe7fal1Ct7XtMCfVJAtvZXcyIomf8HF3gWUhQ,57
+dao_treasury/sorting/rules/ignore/llamapay.cpython-312-i386-linux-musl.so,sha256=-sRrJjys5v6JdwLuSE5MfP_Q_xzsiHsRyqrgMt9vfmM,16752
 dao_treasury/sorting/rules/ignore/llamapay.py,sha256=NgiVt9MRtI-f4mw9U5_gqttdPqDa3vt_z5XWJP_UYWs,763
-dao_treasury/sorting/rules/ignore/shitcoins.cpython-312-i386-linux-musl.so,sha256=PDFEZ6JMN5gpGN2lFpwR4nEMnAowZhAxng2X3d4OSCM,16756
-dao_treasury/sorting/rules/ignore/shitcoins.py,sha256=XVozrgrHlBESih3-xqXksaktjf3AJzWseowd4_yXDdI,767
-dao_treasury/streams/__init__.cpython-312-i386-linux-musl.so,sha256=AK2R2YdsIwz6WP2Y1UP4zdX80ZXr-Vw_tq0CRcdaOVw,16708
+dao_treasury/streams/__init__.cpython-312-i386-linux-musl.so,sha256=_Zh19YbU_l_Dxvne32JkA55wZACaRwE_SCIZQvW4XHM,16708
 dao_treasury/streams/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dao_treasury/streams/llamapay.cpython-312-i386-linux-musl.so,sha256=h3Z_WzxbSQbWK6UVW27vaopl2KOeCtGWYZaFehbWNJ0,16724
+dao_treasury/streams/llamapay.cpython-312-i386-linux-musl.so,sha256=yD5M-4fg9HPVVh86o3yrWmEVxp83zDW57I3E4w_Z5pk,16724
 dao_treasury/streams/llamapay.py,sha256=yn37gwVfqGFF9fOhHuj9_t7KlHGyrdekF2TUmVDyg64,13147
-dao_treasury-0.0.39.dist-info/METADATA,sha256=gWkd23w5wkfZ5E-FrrWcWfnew1DJcvRNFKGcZDM7SAE,7030
-dao_treasury-0.0.39.dist-info/WHEEL,sha256=Vuwis_LWaa45QUuJ2qqSgABfO0elv3qQohyjTF3DnPc,110
-dao_treasury-0.0.39.dist-info/top_level.txt,sha256=OJ9btLujcmz6HPYrhPuxnkTZ5Fl9uw584qBW96ZpkV4,41
-dao_treasury-0.0.39.dist-info/RECORD,,
+dao_treasury-0.0.40.dist-info/METADATA,sha256=z8Mi7J93Bxoxtqx8ETYSlxZfQgdoeHdNrkbRBjBJ9YM,7030
+dao_treasury-0.0.40.dist-info/WHEEL,sha256=Vuwis_LWaa45QUuJ2qqSgABfO0elv3qQohyjTF3DnPc,110
+dao_treasury-0.0.40.dist-info/top_level.txt,sha256=Gw-ri_26lZA_3hwhnOX48mffUbmBGr8NhtoQ0XoMeF8,41
+dao_treasury-0.0.40.dist-info/RECORD,,

dao_treasury-0.0.40.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+bf2b4fe1f86ad2ea158b__mypyc
+dao_treasury

dao_treasury/sorting/rules/ignore/shitcoins.py

@@ -1,24 +0,0 @@
-"""This module is used to ignore any transactions that involve shitcoins in the :obj:`~eth_portfolio.SHITCOINS` mapping."""
-
-from typing import Final
-
-import eth_portfolio
-
-from dao_treasury import TreasuryTx
-from dao_treasury.constants import CHAINID
-from dao_treasury.sorting.factory import ignore
-
-
-SHITCOINS: Final = eth_portfolio.SHITCOINS[CHAINID]
-
-
-@ignore("Shitcoin")
-def is_shitcoin(tx: TreasuryTx) -> bool:
-    """
-    This category is for any token transfers involving any shitcoin which was added
-    to your database before the shitcoin was added to :obj:`eth_portfolio.SHITCOINS`.
-
-    Since the tx would now be excluded from the db entirely if you did a clean pull,
-    we can safely ignore it.
-    """
-    return tx.token.address.address in SHITCOINS

dao_treasury-0.0.39.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-8a0ad9a1a4146730a0f6__mypyc
-dao_treasury