dao-treasury 0.0.39__cp311-cp311-macosx_11_0_arm64.whl → 0.0.69__cp311-cp311-macosx_11_0_arm64.whl

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`)
@@ -17,27 +18,41 @@ and creating SQL views for reporting.
 
 import typing
 from asyncio import Semaphore
+from collections import OrderedDict
 from decimal import Decimal, InvalidOperation
 from functools import lru_cache
 from logging import getLogger
 from os import path
 from pathlib import Path
-from typing import TYPE_CHECKING, Dict, Final, Tuple, Union, final
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Coroutine,
+    Dict,
+    Final,
+    Literal,
+    Tuple,
+    Union,
+    final,
+    overload,
+)
 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
 from brownie.exceptions import EventLookupError
 from brownie.network.event import EventDict, _EventItem
 from brownie.network.transaction import TransactionReceipt
-from eth_typing import ChecksumAddress, HexAddress, HexStr
 from eth_portfolio.structs import (
     InternalTransfer,
     LedgerEntry,
     TokenTransfer,
     Transaction,
 )
+from eth_retry import auto_retry
+from eth_typing import ChecksumAddress, HexAddress, HexStr
 from pony.orm import (
     Database,
     InterfaceError,
@@ -61,6 +76,9 @@ from dao_treasury.constants import CHAINID
 from dao_treasury.types import TxGroupDbid, TxGroupName
 
 
+EventItem = _EventItem[_EventItem[OrderedDict[str, Any]]]
+
+
 SQLITE_DIR = Path(path.expanduser("~")) / ".dao-treasury"
 """Path to the directory in the user's home where the DAO treasury SQLite database is stored."""
 
@@ -69,6 +87,7 @@ SQLITE_DIR.mkdir(parents=True, exist_ok=True)
 
 _INSERT_THREAD = AsyncThreadPoolExecutor(1)
 _SORT_THREAD = AsyncThreadPoolExecutor(1)
+_EVENTS_THREADS = AsyncThreadPoolExecutor(16)
 _SORT_SEMAPHORE = Semaphore(50)
 
 _UTC = timezone.utc
@@ -235,6 +254,10 @@ class Address(DbEntity):
     def contract(self) -> Contract:
         return Contract(self.address)
 
+    @property
+    def contract_coro(self) -> Coroutine[Any, Any, Contract]:
+        return Contract.coroutine(self.address)
+
     @staticmethod
     @lru_cache(maxsize=None)
     def get_dbid(address: HexAddress) -> int:
@@ -405,6 +428,10 @@ class Token(DbEntity):
     def contract(self) -> Contract:
         return Contract(self.address.address)
 
+    @property
+    def contract_coro(self) -> Coroutine[Any, Any, Contract]:
+        return Contract.coroutine(self.address.address)
+
     @property
     def scale(self) -> int:
         """Base for division according to `decimals`, e.g., `10**decimals`.
@@ -719,6 +746,10 @@ class TreasuryTx(DbEntity):
         """Human-readable label for the sender address."""
         return self.from_address.nickname or self.from_address.address  # type: ignore [union-attr]
 
+    @property
+    def token_address(self) -> ChecksumAddress:
+        return self.token.address.address
+
     @property
     def symbol(self) -> str:
         """Ticker symbol for the transferred token."""
@@ -729,7 +760,23 @@ class TreasuryTx(DbEntity):
         """Decoded event logs for this transaction."""
         return self._transaction.events
 
-    def get_events(self, event_name: str) -> _EventItem:
+    async def events_async(self) -> EventDict:
+        """Asynchronously fetch decoded event logs for this transaction."""
+        tx = self._transaction
+        events = tx._events
+        if events is None:
+            events = await _EVENTS_THREADS.run(getattr, tx, "events")
+        return events
+
+    @overload
+    def get_events(
+        self, event_name: str, sync: Literal[False]
+    ) -> Coroutine[Any, Any, EventItem]: ...
+    @overload
+    def get_events(self, event_name: str, sync: bool = True) -> EventItem: ...
+    def get_events(self, event_name: str, sync: bool = True) -> EventItem:
+        if not sync:
+            return _EVENTS_THREADS.run(self.get_events, event_name)
         try:
             return self.events[event_name]
         except EventLookupError:
@@ -746,6 +793,7 @@ class TreasuryTx(DbEntity):
         return get_transaction(self.hash)
 
     @staticmethod
+    @auto_retry
     async def insert(entry: LedgerEntry) -> None:
         """Asynchronously insert and sort a ledger entry.
 
@@ -1383,3 +1431,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/docker-compose.yaml

@@ -5,7 +5,7 @@ networks:
 
 services:
   grafana:
-    image: grafana/grafana:10.2.0
+    image: grafana/grafana:12.2.1
     ports:
       - 127.0.0.1:${DAO_TREASURY_GRAFANA_PORT:-3004}:3000
     environment:

dao_treasury/main.py

@@ -97,6 +97,12 @@ parser.add_argument(
     help="The time interval between datapoints. default: 1d",
     default="1d",
 )
+parser.add_argument(
+    "--concurrency",
+    type=int,
+    help="The max number of historical blocks to export concurrently. default: 30",
+    default=30,
+)
 parser.add_argument(
     "--daemon",
     action="store_true",

dao_treasury/sorting/rule.py

@@ -130,8 +130,6 @@ class _SortRule:
     func: Optional[SortFunction] = None
     """Custom matching function that takes a `TreasuryTx` and returns a bool or an awaitable that returns a bool."""
 
-    # __instances__: ClassVar[List[Self]] = []
-
     def __post_init__(self) -> None:
         """Validate inputs, checksum addresses, and register the rule.
 
@@ -235,7 +233,7 @@ class _InboundSortRule(_SortRule):
         return (
             tx.to_address is not None
             and TreasuryWallet.check_membership(tx.to_address.address, tx.block)
-            and await super().match(tx)
+            and await super(_InboundSortRule, self).match(tx)
         )
 
 
@@ -250,7 +248,7 @@ class _OutboundSortRule(_SortRule):
     async def match(self, tx: "TreasuryTx") -> bool:
         return TreasuryWallet.check_membership(
             tx.from_address.address, tx.block
-        ) and await super().match(tx)
+        ) and await super(_OutboundSortRule, self).match(tx)
 
 
 @mypyc_attr(native_class=False)
@@ -267,7 +265,7 @@ class RevenueSortRule(_InboundSortRule):
     def __post_init__(self) -> None:
         """Prepends `self.txgroup` with 'Revenue:'."""
         object.__setattr__(self, "txgroup", f"Revenue:{self.txgroup}")
-        super().__post_init__()
+        super(RevenueSortRule, self).__post_init__()
 
 
 @mypyc_attr(native_class=False)
@@ -280,7 +278,7 @@ class CostOfRevenueSortRule(_OutboundSortRule):
     def __post_init__(self) -> None:
         """Prepends `self.txgroup` with 'Cost of Revenue:'."""
         object.__setattr__(self, "txgroup", f"Cost of Revenue:{self.txgroup}")
-        super().__post_init__()
+        super(CostOfRevenueSortRule, self).__post_init__()
 
 
 @mypyc_attr(native_class=False)
@@ -293,7 +291,7 @@ class ExpenseSortRule(_OutboundSortRule):
     def __post_init__(self) -> None:
         """Prepends `self.txgroup` with 'Expenses:'."""
         object.__setattr__(self, "txgroup", f"Expenses:{self.txgroup}")
-        super().__post_init__()
+        super(ExpenseSortRule, self).__post_init__()
 
 
 @mypyc_attr(native_class=False)
@@ -306,7 +304,7 @@ class OtherIncomeSortRule(_InboundSortRule):
     def __post_init__(self) -> None:
         """Prepends `self.txgroup` with 'Other Income:'."""
         object.__setattr__(self, "txgroup", f"Other Income:{self.txgroup}")
-        super().__post_init__()
+        super(OtherIncomeSortRule, self).__post_init__()
 
 
 @mypyc_attr(native_class=False)
@@ -319,7 +317,7 @@ class OtherExpenseSortRule(_OutboundSortRule):
     def __post_init__(self) -> None:
         """Prepends `self.txgroup` with 'Other Expenses:'."""
         object.__setattr__(self, "txgroup", f"Other Expenses:{self.txgroup}")
-        super().__post_init__()
+        super(OtherExpenseSortRule, self).__post_init__()
 
 
 @mypyc_attr(native_class=False)
@@ -332,7 +330,7 @@ class IgnoreSortRule(_SortRule):
     def __post_init__(self) -> None:
         """Prepends `self.txgroup` with 'Ignore:'."""
         object.__setattr__(self, "txgroup", f"Ignore:{self.txgroup}")
-        super().__post_init__()
+        super(IgnoreSortRule, self).__post_init__()
 
 
 TRule = TypeVar(

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.69.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dao_treasury
-Version: 0.0.39
+Version: 0.0.69
 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.2.17
 Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
@@ -41,7 +41,7 @@ DAO Treasury is a comprehensive financial reporting and treasury management solu
 - First, you will need to bring your own archive node. This can be one you run yourself, or one from one of the common providers (Tenderly, Alchemy, QuickNode, etc.). Your archive node must have tracing enabled (free-tier Alchemy nodes do not support this option).
 - You must configure a [brownie network](https://eth-brownie.readthedocs.io/en/stable/network-management.html) to use your RPC.
 - You will need an auth token for [Etherscan](https://etherscan.io/)'s API. Follow their [guide](https://docs.etherscan.io/etherscan-v2/getting-an-api-key) to get your key, and set env var `ETHERSCAN_TOKEN` with its value.
-- You'll also need [Docker](https://www.docker.com/get-started/) installed on your system. If on MacOS, you will need to leave Docker Desktop open while Yearn Treasury is running.
+- You'll also need [Docker](https://www.docker.com/get-started/) installed on your system. If on MacOS, you will need to leave Docker Desktop open while DAO Treasury is running.
 
 ## Installation
 
@@ -66,6 +66,7 @@ poetry run dao-treasury run --wallet 0x123 --network mainnet --interval 12h
 **CLI Options:**
 - `--network`: The id of the brownie network the exporter will connect to (default: mainnet)
 - `--interval`: The time interval between each data snapshot (default: 12h)
+- `--concurrency`: The max number of historical blocks to export concurrently. (default: 30)
 - `--daemon`: Run the export process in the background (default: False) (NOTE: currently unsupported)
 - `--grafana-port`: Set the port for the Grafana dashboard where you can view data (default: 3004)
 - `--renderer-port`: Set the port for the report rendering service (default: 8091)

dao_treasury-0.0.69.dist-info/RECORD

@@ -0,0 +1,54 @@
+dao_treasury__mypyc.cpython-311-darwin.so,sha256=tgKESU_EqBQPbzqm927sFzEwdOljqDsWKQaO0PwZZdE,1231256
+dao_treasury-0.0.69.dist-info/RECORD,,
+dao_treasury-0.0.69.dist-info/WHEEL,sha256=sunMa2yiYbrNLGeMVDqEA0ayyJbHlex7SCn1TZrEq60,136
+dao_treasury-0.0.69.dist-info/top_level.txt,sha256=CV8aYytuSYplDhLVY4n0GphckdysXCd1lHmbqfsPxNk,33
+dao_treasury-0.0.69.dist-info/METADATA,sha256=nvHMuGdpOK5wplMI1rk4FRymCtKZJP7VPpLe_YTX2j4,7111
+dao_treasury/_nicknames.cpython-311-darwin.so,sha256=wn0Rsr7S7s7g5l4U4Qw9ZhjFvdnK9pQ4jOphdqLHB8A,50656
+dao_treasury/_wallet.py,sha256=epV8LVuwHlOzc9UkA66js7HfEiZBOSAGJMtWbDTzmjU,10462
+dao_treasury/db.py,sha256=WEM89soGJ-qI0KVk2XdmcUDtOGe-IUiw5cKQu7EKsvQ,49280
+dao_treasury/docker-compose.yaml,sha256=SsfbKO8XiKxu0ckhFVRF8YA3dMWOnGhwvpJg_8YDXB0,1309
+dao_treasury/ENVIRONMENT_VARIABLES.py,sha256=LEczR1MSWTY00sLHnFs3j_Jm8WZNJCxjwEzrvjbwl2E,636
+dao_treasury/_wallet.cpython-311-darwin.so,sha256=jMGr-z5z-bDZKkmb1_dblLJof_7J26zbnoqvwVkrQao,50640
+dao_treasury/constants.py,sha256=BGWVeN4KqpxWDGLG-DjPmdXmyVEb2C9KpMig9RaGJws,1444
+dao_treasury/types.cpython-311-darwin.so,sha256=3S_Eks83q_RPR9iuuyxb_7BXHiv0MPnu2Nac5cfDH34,50616
+dao_treasury/__init__.py,sha256=W4syl9-cNhHOdD25ye9U7aBJTLE_R-uP49FXC_6CUOE,1477
+dao_treasury/_nicknames.py,sha256=bvz0b8C31tFQ0pGtpSJW86OwjUF_qMBal4VXVT5UyLo,1017
+dao_treasury/types.py,sha256=dJDx0hYfDDL3slcUzRnCgrzFFsgCzoqg8uaTtLaT4kk,3685
+dao_treasury/_docker.cpython-311-darwin.so,sha256=Nsmh3H1WOwadCayx8xjAUqAL8CKA8WH5bhp8UhYMBws,50640
+dao_treasury/_docker.py,sha256=9_XTuBClqNK6qQjSsVk_fdBWPgfSj8EuDIcE9-whBB4,5924
+dao_treasury/constants.cpython-311-darwin.so,sha256=stenUadN9jDlGVzDO0rMmNtyJI84WjQZTKyNzigtZWk,50656
+dao_treasury/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dao_treasury/treasury.py,sha256=taTvwTH_Zdu2M61TrUCENcIUjxdQO3vryrZ2iVb6suM,7223
+dao_treasury/main.py,sha256=uMY5XP_GpxO6Qd9VA1YMLzMOd-O4VnxbGJ2Pdqh0Zo0,8205
+dao_treasury/.grafana/provisioning/datasources/datasources.yaml,sha256=mjQs8or651NgD_bZnKBm8vSghzjw_g3enL01YPt0dik,327
+dao_treasury/.grafana/provisioning/dashboards/dashboards.yaml,sha256=7WQaeajNf9hNnPJA9SZgvPot9m7TbzyN21BIbB8MaHM,191
+dao_treasury/.grafana/provisioning/dashboards/breakdowns/Revenue.json,sha256=sPwG6ERjiJVPyivYS2iPCtFDdxUAWpyz4e3NGcT0tcE,18620
+dao_treasury/.grafana/provisioning/dashboards/breakdowns/Expenses.json,sha256=fMBSldgUmZm3dDHb6D7ShQ7R2eCH4CWbhZCRhz21cOw,19413
+dao_treasury/.grafana/provisioning/dashboards/streams/LlamaPay.json,sha256=Ct8FRa0c_FQEBTKaGpC0y2cBhYM_YYU_v0uOUBJAqQU,7504
+dao_treasury/.grafana/provisioning/dashboards/transactions/Treasury Transactions.json,sha256=4R4L3jHegSTewWGRDayGscDZqVv5Laf6K77jK0TYeyY,14700
+dao_treasury/.grafana/provisioning/dashboards/treasury/Cashflow (Including Unsorted).json,sha256=rUzNnSnR33YyJDLwzPL8iPn34CYaYVsL2V4vEZwvQf0,27346
+dao_treasury/.grafana/provisioning/dashboards/treasury/Historical Treasury Balances.json,sha256=jTSvRNQu9QAjL7v2lJWbkDa_p8vnFecTQsbqIPJ2d3o,104559
+dao_treasury/.grafana/provisioning/dashboards/treasury/Current Treasury Assets.json,sha256=mysaX1aoB9pB5OTrp2vlrGLRfAxsDCUOMsnL9rbxOc0,25951
+dao_treasury/.grafana/provisioning/dashboards/treasury/Operating Cashflow.json,sha256=7xRABZ9m1iFXDVeLX-4x6ByyGnE7GQQrSGUPk2pRvww,15471
+dao_treasury/.grafana/provisioning/dashboards/treasury/Cashflow.json,sha256=f7hl5DyxhrebpXqGsq2FJhrNIvpInD9VwoH0N6jqIFY,19637
+dao_treasury/.grafana/provisioning/dashboards/summary/Monthly.json,sha256=Xa0GyAOK_3fDn5u89_6yzzd-SKo_LEotH8t4GnXsUTg,7050
+dao_treasury/streams/llamapay.py,sha256=yn37gwVfqGFF9fOhHuj9_t7KlHGyrdekF2TUmVDyg64,13147
+dao_treasury/streams/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dao_treasury/streams/__init__.cpython-311-darwin.so,sha256=6DTXfF4MSFV-wAhuJ5PtUuxX9Cp0qlfkwGTaRyDX2bs,50640
+dao_treasury/streams/llamapay.cpython-311-darwin.so,sha256=FQwbRPH5cfQOK03LxIs3mYVpKEHBbKZOUyJp0m7T56A,50656
+dao_treasury/sorting/_rules.py,sha256=vWkqJVA8yCHKRv9sw872Jq6G0zpM-v_J1jCz-Mgleec,8994
+dao_treasury/sorting/factory.cpython-311-darwin.so,sha256=v6azWlfbKwZ1K7Wf6WVb5QxutBavYXbq7s8dYgq0prA,50656
+dao_treasury/sorting/__init__.py,sha256=vKj3NPB7EWbX7_fSUWKXk-NsyPasOkFhJvJVGclBOAE,10371
+dao_treasury/sorting/rule.cpython-311-darwin.so,sha256=RszywPLFR4mFlR2tZldXzl_cbNblXwFxvaJQvOn54o0,50632
+dao_treasury/sorting/_matchers.cpython-311-darwin.so,sha256=6dRGQYncNfw4p8iM6wBhV58HLZQdpH83DXo1A-UkN8A,50656
+dao_treasury/sorting/factory.py,sha256=pFD6luc0bKxOTT1hlAp3ZwJw6R0wN8pjIZrqMZwhsko,10185
+dao_treasury/sorting/rule.py,sha256=WtGGN5mOd6S2Bhk7v5lsBWSSzVGKON7V10ImrUN79Y4,11628
+dao_treasury/sorting/__init__.cpython-311-darwin.so,sha256=PeM_dR4dGzGNf1t2WN2tM6sfIkuck8ew2qwEo-_7fUM,50640
+dao_treasury/sorting/_rules.cpython-311-darwin.so,sha256=AlFokMRSmhC3Fnvk8_4YSF5P3U4hH1NTjuq_AI-Iok0,50640
+dao_treasury/sorting/_matchers.py,sha256=u0GfPYiODr_NtzbfyLxEKDuXmWRiaeuZulDj9FPDOH8,14005
+dao_treasury/sorting/rules/__init__.py,sha256=ofzIsW0P74kuKr6DlScZIF8p7hBh6guRpe1uOq6oLLA,48
+dao_treasury/sorting/rules/__init__.cpython-311-darwin.so,sha256=4-UEcFYqlvKOsI5bTLXtNsNqhUCGf-1mXOEzQ6PsuLc,50640
+dao_treasury/sorting/rules/ignore/llamapay.py,sha256=NgiVt9MRtI-f4mw9U5_gqttdPqDa3vt_z5XWJP_UYWs,763
+dao_treasury/sorting/rules/ignore/__init__.py,sha256=dJ4oKSLe7fal1Ct7XtMCfVJAtvZXcyIomf8HF3gWUhQ,57
+dao_treasury/sorting/rules/ignore/__init__.cpython-311-darwin.so,sha256=4IWkbG2lsUa8O4eLxCCc2-9_1V5MzB3C_sHslOQlpYI,50656
+dao_treasury/sorting/rules/ignore/llamapay.cpython-311-darwin.so,sha256=ltGqmT6Cmb7j3NUgoQkXijQaB8XwQb7xNYcMqMlskK8,50672

dao_treasury-0.0.69.dist-info/top_level.txt

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