dao-treasury 0.0.38__cp312-cp312-win32.whl → 0.0.40__cp312-cp312-win32.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/streams/llamapay.py

@@ -22,7 +22,7 @@ from eth_typing import BlockNumber, ChecksumAddress, HexAddress, HexStr
 from tqdm.asyncio import tqdm_asyncio
 
 import y
-from y.time import UnixTimestamp
+from y.time import NoBlockFound, UnixTimestamp
 from y.utils.events import decode_logs, get_logs_asap
 
 from dao_treasury import constants
@@ -338,7 +338,19 @@ class LlamaPayProcessor:
         check_at = date_obj + timedelta(days=1) - timedelta(seconds=1)
         if check_at > now(tz=_UTC):
             await sleep((check_at - now(tz=_UTC)).total_seconds())
-        block = await get_block_at_timestamp(check_at, sync=False)
+
+        while True:
+            try:
+                block = await get_block_at_timestamp(check_at, sync=False)
+            except NoBlockFound:
+                sleep_time = (check_at - now(tz=_UTC)).total_seconds()
+                logger.debug(
+                    "no block found for %s, sleeping %ss", check_at, sleep_time
+                )
+                await sleep(sleep_time)
+            else:
+                break
+
         price_fut = create_task(get_price(stream_token, block, sync=False))
         start_timestamp = await _get_start_timestamp(stream_id, block)
         if start_timestamp == 0:

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.38.dist-info → dao_treasury-0.0.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dao_treasury
-Version: 0.0.38
+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.38.dist-info → dao_treasury-0.0.40.dist-info}/RECORD

@@ -1,20 +1,20 @@
-bf2b4fe1f86ad2ea158b__mypyc.cp312-win32.pyd,sha256=KAPqC8WQVJp1u0e-rwZggVDKTYv2KWmVlONTRDE5hKQ,453632
-dao_treasury/ENVIRONMENT_VARIABLES.py,sha256=ci7djcsXc9uRi6_vBQv-avGQrrIacyftXmcwKuitWWU,203
-dao_treasury/__init__.py,sha256=U8BsakN_w15wVE_7MjVbHD9LBal48LfJ6a1Icf5oHdY,1052
-dao_treasury/_docker.cp312-win32.pyd,sha256=uyd8S-zDZCL6Zhq6hbSbf1hvH9AunWRETzoylqhpCT4,9216
-dao_treasury/_docker.py,sha256=wY26wCrQ8p-L0KfMJftyzI_YAszHjnBWLw94eh0LxxY,5607
-dao_treasury/_nicknames.cp312-win32.pyd,sha256=N7niuVwTNnVUAg2TNO4h1Uo_U7Wm5NEO-EdQ-RGw2Mo,9216
-dao_treasury/_nicknames.py,sha256=NpbQ4NtmZF_A_vqTGSal2KzKzkH5t7_wbI8EtMBqEr4,497
-dao_treasury/_wallet.cp312-win32.pyd,sha256=kGVVXLtuehXVIK74ZNLmkEphDZFipD14wy1N8z5Stsw,9216
+bf2b4fe1f86ad2ea158b__mypyc.cp312-win32.pyd,sha256=jq56Nfjm-AWJROeJ_7MGf_BBGy32Zp9PGQeiYOFliGM,458752
+dao_treasury/ENVIRONMENT_VARIABLES.py,sha256=LS_D4ALB3BO-vYKyh1tzRHi10QBE6f654Zy8pmJ_xPY,656
+dao_treasury/__init__.py,sha256=ai8iALE_Zv43O9cH1jkNJ39bzhr60kBDX6L7C4Nj9FA,1539
+dao_treasury/_docker.cp312-win32.pyd,sha256=VDF1FecpiCuy_CCisWD7PFL83zaUaKqTOfjGaZeYHOk,9216
+dao_treasury/_docker.py,sha256=UFMN-TIBUQBheMIhIhSMhaq7UFgt6ubUcfzwPNap_6o,6098
+dao_treasury/_nicknames.cp312-win32.pyd,sha256=yr5f-JoHqBJzO91RdCYvjDHx_YNcgBOR0JzLVbCIjxw,9216
+dao_treasury/_nicknames.py,sha256=n8c-JZhORYymCMv6jsC96IthAzAhpslyEn-KCk_YiSM,1049
+dao_treasury/_wallet.cp312-win32.pyd,sha256=5sxfFUE8qQwAWQ3nTGlnbcWmMJOuvTNniP5ZypcKGa0,9216
 dao_treasury/_wallet.py,sha256=nHBAKFJstdKuYbvpskGVx2KU80YrZHGHsEh5V3TwIHs,10712
-dao_treasury/constants.cp312-win32.pyd,sha256=bgn2lPBXh2yHJq_mDBUJXocoiJjqX0Me9JG2g7aIH9I,9216
-dao_treasury/constants.py,sha256=VNzlrwC8HB8LdKNmoIfncUACKHfXZxp2GtBBrH_lZKE,522
-dao_treasury/db.py,sha256=aZhY33XFHv5vwTQecolpaYXB_0SBPWvYGvZWlme_yH4,48703
+dao_treasury/constants.cp312-win32.pyd,sha256=KqPWSgYpbtnDOIO4h2w-7Ehd7DgQbE30bKjl_R28YOE,9216
+dao_treasury/constants.py,sha256=PYKWO-TiUrROAawAsIdyuPvRwUMJSWWpgPQdoqoZYcQ,1254
+dao_treasury/db.py,sha256=kqjYsJDibWj73NL6pc4XOA4Me_HgymexcgbmXk3l3mU,49421
 dao_treasury/docker-compose.yaml,sha256=s0Nq-u--kIyknC-rlmJW2ycdKPjwJ_HetG7jBBJD95A,1350
 dao_treasury/main.py,sha256=yVQGwDgO4XKcxV6tQQPxEcLcZPSEEK1yJS8Djfq3Esc,8294
 dao_treasury/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dao_treasury/treasury.py,sha256=64_z0lsjOngGFASCVQNUM-QfbC5YqhKMgOdtLh758co,6678
-dao_treasury/types.cp312-win32.pyd,sha256=3gpyqnzaiYruH5gRJWUR4PDxREUMxb3pv78G9KxuZaE,9216
+dao_treasury/treasury.py,sha256=wh4wESLbYSHjcfpa-sW5TIqa5pSC9Y_7Id8tzLzJLaw,7414
+dao_treasury/types.cp312-win32.pyd,sha256=pftciHkerOuFZRkA-jdVtjL7Bm9W16qHHkd-PsHrzME,9216
 dao_treasury/types.py,sha256=KFz4WKPp4t_RBwIT6YGwOcgbzw8tdHIOcXTFsUA0pJA,3818
 dao_treasury/.grafana/provisioning/dashboards/dashboards.yaml,sha256=PwGrxPA5snT37bmpCuP9WE9T7weACm39N9lEsudr7f0,1337
 dao_treasury/.grafana/provisioning/dashboards/streams/LlamaPay.json,sha256=Q0QTL1UIYQCsqj8GQuZMt81Ick-FMhYphbBo8XV1TQs,7248
@@ -25,27 +25,27 @@ dao_treasury/.grafana/provisioning/dashboards/treasury/Cashflow.json,sha256=TDDh
 dao_treasury/.grafana/provisioning/dashboards/treasury/Operating Cashflow.json,sha256=_W5Zt-J0YTVGAKPbM5kbMnv0EC3K_eZgJbqLgzkanS4,14844
 dao_treasury/.grafana/provisioning/dashboards/treasury/Treasury.json,sha256=6y7Fp-2g1iRanRBtWKKN13sXjaKxBvqld7416ZJu4YI,72196
 dao_treasury/.grafana/provisioning/datasources/datasources.yaml,sha256=gLmJsOkEXNzWRDibShfHFySWeuExW-dSB_U0OSfH868,344
-dao_treasury/sorting/__init__.cp312-win32.pyd,sha256=tW9vHkGhsiNMl4Z3H2UcNWNU2bCoox5sIr5PVSMZDMY,9216
+dao_treasury/sorting/__init__.cp312-win32.pyd,sha256=HYB7SWuTsxwLS4nBiKmkT4nxRk5SnbVhJ1QIRY7476g,9216
 dao_treasury/sorting/__init__.py,sha256=_uxM_FE1paM8oDAhDdHSyhDwnrlxCYX_lGn2DOqCaHU,10666
-dao_treasury/sorting/_matchers.cp312-win32.pyd,sha256=NjMVV_vfrsZvPpZAM03zlxSwyHEd2r1wJ6n-D2SiXcM,9216
+dao_treasury/sorting/_matchers.cp312-win32.pyd,sha256=LQuDoi74N2IRS0V8ogWAVINOc5oCfp07R7LchBdbNDk,9216
 dao_treasury/sorting/_matchers.py,sha256=ACi6aXZCKW5OTiztsID7CXCGJounj5c6ivhOCg2436M,14392
-dao_treasury/sorting/_rules.cp312-win32.pyd,sha256=fqVgUZiOCpLsxXjqlFGwjx2oQU8EaAckKnAvcGr-mFk,9216
+dao_treasury/sorting/_rules.cp312-win32.pyd,sha256=9dbUNGdl_gE20OB9q4QfPXR6mPBlFGNoT9gdOStzCSY,9216
 dao_treasury/sorting/_rules.py,sha256=DxhdUgpS0q0LWeLl9W1Bjn5LZz9z4OLA03vQllPMH9k,9229
-dao_treasury/sorting/factory.cp312-win32.pyd,sha256=j5xHY4KyHRm0dnObPOHzoxT0rAI7cFXNcsfmf5j7Qt4,9216
+dao_treasury/sorting/factory.cp312-win32.pyd,sha256=6zZandQFRZR3Y3Xllc_ZQ-S12i9afIZ4nhkHXeqOZIo,9216
 dao_treasury/sorting/factory.py,sha256=zlJ18xlMTxv8ACV6_MimCVIDsw3K5AZcyvKaNYY7R14,10484
-dao_treasury/sorting/rule.cp312-win32.pyd,sha256=lmM7UaFADOeiXJYQ6kwB8fcY6WnRVVm6qCAcFy8IERA,9216
+dao_treasury/sorting/rule.cp312-win32.pyd,sha256=ovQbcREGnFwWETpRA13WAexqfD0Uipx1-K1gbu4AKFo,9216
 dao_treasury/sorting/rule.py,sha256=TsSlaU4UlYr4QWJBdUY7EOAfC_SK6_VA3wEFOFNUUrU,11837
-dao_treasury/sorting/rules/__init__.cp312-win32.pyd,sha256=cvxL8pvvol6SbOSkpvP5cJ2HaT29RG2OSUkJN6Fr57U,9216
+dao_treasury/sorting/rules/__init__.cp312-win32.pyd,sha256=hMQkDTI2JGUqw-OPw0jf_sdfpVNXWUEBjwkQuPnzM_M,9216
 dao_treasury/sorting/rules/__init__.py,sha256=hcLfejOEwD8RaM2RE-38Ej6_WkvL9BVGvIIGY848E6E,49
-dao_treasury/sorting/rules/ignore/__init__.cp312-win32.pyd,sha256=qSoiyujR5xHTv-eysTP0hAlq_gmJ8tUXEAkHQHHVci4,9216
+dao_treasury/sorting/rules/ignore/__init__.cp312-win32.pyd,sha256=AXyGABSobSZNqDEKwSMfn-SlQxOylWS3_LTYdnPJI18,9216
 dao_treasury/sorting/rules/ignore/__init__.py,sha256=16THKoGdj6qfkkytuCFVG_R1M6KSErMI4AVE1p0ukS4,58
-dao_treasury/sorting/rules/ignore/llamapay.cp312-win32.pyd,sha256=OCXPGDzc8Nz2KO7jlOsEI6EanRnVEGlmRgVRTnV0TOQ,9216
+dao_treasury/sorting/rules/ignore/llamapay.cp312-win32.pyd,sha256=hxG-2cqq4fUgLgA_I7OAmPja4XEXXxTZ-qP4o0XKCsU,9216
 dao_treasury/sorting/rules/ignore/llamapay.py,sha256=aYyAJRlmv419IeaqkcV5o3ffx0UVfteU0lTl80j0BGo,783
-dao_treasury/streams/__init__.cp312-win32.pyd,sha256=efC_rlGV2yhoo1Is7KpU_FCk1Gdg3ma1u-ie34pYQOk,9216
+dao_treasury/streams/__init__.cp312-win32.pyd,sha256=92tCx7opMWtn05eAc4Czlcj6y0nD75osLTMORIScNGE,9216
 dao_treasury/streams/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dao_treasury/streams/llamapay.cp312-win32.pyd,sha256=YxTHzk3fb2ZNi38xGel0WeUMAUBdkrj9GUcbcPCre3s,9216
-dao_treasury/streams/llamapay.py,sha256=HXG3Qg8R5l1FTVgmSnpOBRoDt2VchjOI-dU9rrC_mjQ,13150
-dao_treasury-0.0.38.dist-info/METADATA,sha256=sVoxE4qc-onQKKkTAXPNVcvdVagVs0TV33CE70oZAjU,7149
-dao_treasury-0.0.38.dist-info/WHEEL,sha256=LwxTQZ0gyDP_uaeNCLm-ZIktY9hv6x0e22Q-hgFd-po,97
-dao_treasury-0.0.38.dist-info/top_level.txt,sha256=Gw-ri_26lZA_3hwhnOX48mffUbmBGr8NhtoQ0XoMeF8,41
-dao_treasury-0.0.38.dist-info/RECORD,,
+dao_treasury/streams/llamapay.cp312-win32.pyd,sha256=WQBr4b9Um4H1KoQbcU3AMMeTQnSkKcsdN0zqslMByzs,9216
+dao_treasury/streams/llamapay.py,sha256=rO1Mh2ndTziR6pnRkKHnQ22a_Yx9PM_-BG7I4dspEZ8,13535
+dao_treasury-0.0.40.dist-info/METADATA,sha256=ddAluiZEhhLSx4l1pqSbdF3Cno-MwzeDCLABd1rnEJ4,7149
+dao_treasury-0.0.40.dist-info/WHEEL,sha256=LwxTQZ0gyDP_uaeNCLm-ZIktY9hv6x0e22Q-hgFd-po,97
+dao_treasury-0.0.40.dist-info/top_level.txt,sha256=Gw-ri_26lZA_3hwhnOX48mffUbmBGr8NhtoQ0XoMeF8,41
+dao_treasury-0.0.40.dist-info/RECORD,,