dao-treasury 0.0.39__tar.gz → 0.0.41__tar.gz

{dao_treasury-0.0.39 → dao_treasury-0.0.41}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dao_treasury
-Version: 0.0.39
+Version: 0.0.41
 Summary: Produce comprehensive financial reports for your on-chain org
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers

dao_treasury-0.0.41/dao_treasury/ENVIRONMENT_VARIABLES.py

@@ -0,0 +1,20 @@
+"""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
+
+
+_factory = EnvVarFactory("DAO_TREASURY")
+
+SQL_DEBUG: Final = _factory.create_env("SQL_DEBUG", bool, default=False, verbose=False)

{dao_treasury-0.0.39 → dao_treasury-0.0.41}/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-0.0.39 → dao_treasury-0.0.41}/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-0.0.41/dao_treasury/_nicknames.py

@@ -0,0 +1,32 @@
+"""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
+
+from dao_treasury import constants
+from dao_treasury.db import Address, _set_address_nicknames_for_tokens
+
+
+set_nickname: Final = Address.set_nickname
+
+
+def setup_address_nicknames_in_db() -> None:
+    with db_session:
+        set_nickname(constants.ZERO_ADDRESS, "Zero Address")
+        for address in constants.DISPERSE_APP:
+            set_nickname(address, "Disperse.app")
+        _set_address_nicknames_for_tokens()

dao_treasury-0.0.41/dao_treasury/constants.py

@@ -0,0 +1,34 @@
+"""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 = (
+    "0xD152f549545093347A162Dce210e7293f1452150",
+    "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-0.0.39 → dao_treasury-0.0.41}/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-0.0.41/dao_treasury/sorting/rules/ignore/__init__.py

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

{dao_treasury-0.0.39 → dao_treasury-0.0.41}/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 → dao_treasury-0.0.41}/dao_treasury.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dao-treasury
-Version: 0.0.39
+Version: 0.0.41
 Summary: Produce comprehensive financial reports for your on-chain org
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers

{dao_treasury-0.0.39 → dao_treasury-0.0.41}/dao_treasury.egg-info/SOURCES.txt

@@ -37,6 +37,5 @@ dao_treasury/sorting/rule.py
 dao_treasury/sorting/rules/__init__.py
 dao_treasury/sorting/rules/ignore/__init__.py
 dao_treasury/sorting/rules/ignore/llamapay.py
-dao_treasury/sorting/rules/ignore/shitcoins.py
 dao_treasury/streams/__init__.py
 dao_treasury/streams/llamapay.py

dao_treasury-0.0.41/dao_treasury.egg-info/requires.txt

@@ -0,0 +1 @@
+eth-portfolio-temp<0.1,>=0.0.38.dev0

{dao_treasury-0.0.39 → dao_treasury-0.0.41}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dao-treasury"
-version = "0.0.39"
+version = "0.0.41"
 description = "Produce comprehensive financial reports for your on-chain org"
 authors = ["BobTheBuidler <bobthebuidlerdefi@gmail.com>"]
 license = "MIT"
@@ -11,7 +11,7 @@ dao-treasury = "dao_treasury.main:main"
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
-eth-portfolio-temp = ">=0.0.34.dev0,<0.1"
+eth-portfolio-temp = ">=0.0.38.dev0,<0.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^6.2.5"
@@ -29,7 +29,7 @@ myst-parser = "*"
 requires = [
     "setuptools", 
     "wheel", 
-    "mypy[mypyc]==1.16.1", 
+    "mypy[mypyc]==1.17.0", 
     "tomli>=2.0.0; python_version < '3.11'", 
     "types-tqdm", 
     "types-PyYAML",

dao_treasury-0.0.39/dao_treasury/ENVIRONMENT_VARIABLES.py

@@ -1,8 +0,0 @@
-from typing import Final
-
-from typed_envs import EnvVarFactory
-
-
-_factory = EnvVarFactory("DAO_TREASURY")
-
-SQL_DEBUG: Final = _factory.create_env("SQL_DEBUG", bool, default=False, verbose=False)

dao_treasury-0.0.39/dao_treasury/_nicknames.py

@@ -1,17 +0,0 @@
-from typing import Final
-
-from pony.orm import db_session
-
-from dao_treasury import constants
-from dao_treasury.db import Address, _set_address_nicknames_for_tokens
-
-
-set_nickname: Final = Address.set_nickname
-
-
-def setup_address_nicknames_in_db() -> None:
-    with db_session:
-        set_nickname(constants.ZERO_ADDRESS, "Zero Address")
-        for address in constants.DISPERSE_APP:
-            set_nickname(address, "Disperse.app")
-        _set_address_nicknames_for_tokens()

dao_treasury-0.0.39/dao_treasury/constants.py

@@ -1,15 +0,0 @@
-from typing import Final
-
-import y.constants
-
-
-CHAINID: Final = y.constants.CHAINID
-
-ZERO_ADDRESS: Final = "0x0000000000000000000000000000000000000000"
-
-# TODO: move disperse.app stuff from yearn-treasury to dao-treasury and then write a docs file
-DISPERSE_APP: Final = (
-    "0xD152f549545093347A162Dce210e7293f1452150",
-    "0xd15fE25eD0Dba12fE05e7029C88b10C25e8880E3",
-)
-"""If your treasury sends funds to disperse.app, we create additional txs in the db so each individual send can be accounted for."""

dao_treasury-0.0.39/dao_treasury/sorting/rules/ignore/__init__.py

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

dao_treasury-0.0.39/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/dao_treasury.egg-info/requires.txt

@@ -1 +0,0 @@
-eth-portfolio-temp<0.1,>=0.0.34.dev0