eth-portfolio-temp 0.0.24.dev0__tar.gz → 0.0.26.dev0__tar.gz

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/.github/workflows/mypy.yaml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-        pyversion: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        pyversion: [ "3.9", "3.10", "3.11", "3.12" ]
 
     steps:
     - name: Checkout
@@ -30,15 +30,8 @@ jobs:
       with:
         python-version: ${{ matrix.pyversion }}
 
-    - name: Install Poetry
-      uses: snok/install-poetry@v1
-      
-    - name: Add Poetry to PATH on Windows
-      if: runner.os == 'Windows'
-      run: $env:Path += ";$env:USERPROFILE\.poetry\bin"
-
     - name: Install Dependencies
-      run: poetry install --no-interaction
+      run: pip install -r requirements.txt
 
     - name: Run MyPy
       run: make mypy

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eth_portfolio_temp
-Version: 0.0.24.dev0
+Version: 0.0.26.dev0
 Summary: eth-portfolio makes it easy to analyze your portfolio.
 Home-page: https://github.com/BobTheBuidler/eth-portfolio
 Author: BobTheBuidler

eth_portfolio_temp-0.0.26.dev0/docs/caching.rst

@@ -0,0 +1,93 @@
+Caching in eth-portfolio
+========================
+
+Overview
+--------
+
+eth-portfolio uses multiple caching strategies to maximize performance, minimize redundant RPC/database calls, and provide fast access to frequently used data. These strategies closely mirror those in ypricemagic, with some eth_portfolio-specific extensions and customizations. For a detailed overview of the canonical caching system, see ypricemagic's [caching documentation](https://bobthebuidler.github.io/ypricemagic/caching.html).
+
+Disk Caches
+-----------
+
+Local SQL Cache
+~~~~~~~~~~~~~~~
+
+- **Backend:** Pony ORM with SQLite (default, configurable via environment variables)
+- **Location:** ``~/.ypricemagic/ypricemagic.sqlite``
+- **Purpose:** Persistent storage for blockchain data, portfolio data, and cache metadata.
+- **What is cached:**
+  - Blockchain data: chains, blocks, addresses, contracts, tokens, prices
+  - Portfolio data: transactions, internal transfers, token transfers, etc.
+  - Cache metadata
+- **Implementation:** Entities defined in ``eth_portfolio/_db/entities.py``
+- **Integration:** If ypricemagic is installed, eth_portfolio will automatically extend and share the same persistent SQL database, unifying cached data and utility functions.
+
+Disk Function Result Cache
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- **Backend:** Custom ``cache_to_disk`` decorator (see ``eth_portfolio/_cache.py``)
+- **Location:** ``./cache/{chain.id}/...`` (per-chain)
+- **Purpose:** Disk-based function result caching for expensive or slow-to-compute results.
+- **Usage:** Decorate functions with ``@cache_to_disk`` to persist results to disk.
+- **Note:** While ypricemagic uses ``joblib.Memory`` for this purpose, eth_portfolio implements a functionally similar in-house solution.
+
+In-Memory LRU Caches
+--------------------
+
+Synchronous LRU Caches
+~~~~~~~~~~~~~~~~~~~~~~
+
+- **functools.lru_cache:** Used for pure in-memory caching of function results, especially for database reads (see ``db_session_cached`` in ``eth_portfolio/_db/utils.py``).
+- **functools.cached_property:** Used for property-level in-memory caching throughout the codebase.
+
+Asynchronous LRU Caches
+~~~~~~~~~~~~~~~~~~~~~~~
+
+- **async_lru.alru_cache:** Used extensively for async LRU caching of coroutine results (e.g., token metadata, block lookups, protocol-specific data). Some usages include TTLs (e.g., 1 hour, 5 minutes) for time-limited caching.
+
+What is LRU-cached
+~~~~~~~~~~~~~~~~~~
+
+- Token metadata (symbols, decimals, names, buckets)
+- Contract ABIs and deploy blocks
+- Block/timestamp lookups
+- Price data
+- Protocol-specific data
+- Results of expensive on-chain or DB queries
+
+Cache Control
+~~~~~~~~~~~~~
+
+- Some caches have TTLs (time-limited)
+- Some caches are per-chain (partitioned by chain ID)
+- Some caches are unlimited size
+- Caches are generally transparent to the user; cache control parameters (e.g., skip_cache) may exist at the function level
+
+Summary Table
+-------------
+
++-------------------+--------------------------+-----------------------------+-----------------------------+-------------+
+| Cache Type        | Library/Decorator        | Example Usage               | What is Cached              | Sync/Async  |
++===================+==========================+=============================+=============================+=============+
+| Local SQL         | Pony ORM (SQLite)        | _db/entities.py             | Blockchain, portfolio data  | Sync        |
++-------------------+--------------------------+-----------------------------+-----------------------------+-------------+
+| Disk Function     | cache_to_disk (custom)   | _cache.py                   | Function results            | Sync/Async  |
++-------------------+--------------------------+-----------------------------+-----------------------------+-------------+
+| LRU (in-memory)   | functools.lru_cache      | _db/utils.py                | DB reads                    | Sync        |
++-------------------+--------------------------+-----------------------------+-----------------------------+-------------+
+| LRU (in-memory)   | functools.cached_property| _utils.py, etc.             | Property values             | Sync        |
++-------------------+--------------------------+-----------------------------+-----------------------------+-------------+
+| LRU (in-memory)   | async_lru.alru_cache     | _utils.py, _ledgers/, etc.  | Async function results      | Async       |
++-------------------+--------------------------+-----------------------------+-----------------------------+-------------+
+
+References
+----------
+
+- Canonical ypricemagic caching docs: https://bobthebuidler.github.io/ypricemagic/caching.html
+- ``eth_portfolio/_cache.py``
+- ``eth_portfolio/_db/entities.py``
+- ``eth_portfolio/_db/utils.py``
+- ``eth_portfolio/_utils.py``
+- ``eth_portfolio/_ledgers/``
+- ``eth_portfolio/_loaders/``
+- ``eth_portfolio/protocols/``

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/docs/index.rst

@@ -11,6 +11,7 @@ Welcome to eth-portfolio's documentation!
    :caption: Contents:
 
    source/modules.rst
+   caching
    exporter
    new-protocols
 

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio/_db/entities.py

@@ -36,7 +36,7 @@ class AddressExtended(Address):
     """
     Extends the base Address entity to add relationships for sent/received transactions, internal transfers, and token transfers.
     """
-    
+
     if typing.TYPE_CHECKING:
         # if we execute this code we get `TypeError: 'type' object is not subscriptable`
         transactions_sent: Set["Transaction"]
@@ -75,7 +75,7 @@ class TokenExtended(Token, AddressExtended):
     """
     Extends both Token and AddressExtended to represent a token contract with address relationships.
     """
-    
+
     if typing.TYPE_CHECKING:
         # if we execute this code we get `TypeError: 'type' object is not subscriptable`
         transfers: Set["TokenTransfer"]

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio/protocols/dsr.py

@@ -1,5 +1,5 @@
 import asyncio
-from typing import Final, Optional
+from typing import ClassVar, Final, Optional, final
 
 import y
 from y.datatypes import Address, Block
@@ -19,23 +19,27 @@ dai: Final = y.dai
 Decimal: Final = _decimal.Decimal
 
 
+@final
 class MakerDSR(ProtocolABC):
-    networks = [Network.Mainnet]
+    networks: ClassVar = [Network.Mainnet]
 
     def __init__(self) -> None:
         dsr_manager = "0x373238337Bfe1146fb49989fc222523f83081dDb"
         pot = "0x197E90f9FAD81970bA7976f33CbD77088E5D7cf7"
-        self.dsr_manager = Contract(dsr_manager)
-        self.pot = Contract(pot)
-        self._start_block = max(contract_creation_block(dsr_manager), contract_creation_block(pot))
-        self._get_chi = self.pot.chi.coroutine
+        self.dsr_manager: Final = Contract(dsr_manager)
+        self.pot: Final = Contract(pot)
+        self._start_block: Final = max(
+            contract_creation_block(dsr_manager), contract_creation_block(pot)
+        )
+        self._get_chi: Final = self.pot.chi.coroutine
+        self._get_pie: Final = self.dsr_manager.pieOf.coroutine
 
     async def _balances(self, address: Address, block: Optional[Block] = None) -> TokenBalances:
         balances = TokenBalances(block=block)
         if block and block < self._start_block:
             return balances
         pie, exchange_rate = await gather(
-            self.dsr_manager.pieOf.coroutine(address, block_identifier=block),
+            self._get_pie(address, block_identifier=block),
             self._exchange_rate(block),
         )
         if pie:

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio_scripts/balances.py

@@ -1,14 +1,22 @@
+from argparse import Namespace
 from datetime import datetime, timezone
+from typing import Final
 
-from a_sync import create_task
-from a_sync.asyncio import sleep0 as yield_to_loop
+import a_sync
+import a_sync.asyncio
 
 from eth_portfolio_scripts import docker
 from eth_portfolio_scripts._utils import aiter_timestamps, parse_timedelta
 
 
+_UTC: Final = timezone.utc
+
+create_task: Final = a_sync.create_task
+yield_to_loop: Final = a_sync.asyncio.sleep0
+
+
 @docker.ensure_containers
-async def export_balances(args):
+async def export_balances(args: Namespace) -> None:
     import dank_mids
 
     from eth_portfolio_scripts._portfolio import ExportablePortfolio

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio_scripts/docker/docker_compose.py

@@ -1,17 +1,20 @@
 import logging
 from functools import wraps
+from importlib import resources
 from os import path
 from subprocess import CalledProcessError, check_output
-from typing import Callable, Iterable, Tuple, TypeVar
+from typing import Callable, Final, Iterable, List, Tuple, TypeVar
 
 from typing_extensions import ParamSpec
 
 from eth_portfolio_scripts.docker.check import check_system
 
 
-logger = logging.getLogger(__name__)
+logger: Final = logging.getLogger(__name__)
 
-compose_file = path.join(path.dirname(path.abspath(__file__)), "docker-compose.yaml")
+compose_file: Final = str(
+    resources.files("eth_portfolio_scripts").joinpath("docker/docker-compose.yaml")
+)
 
 
 def up(*services: str) -> None:
@@ -44,7 +47,7 @@ _T = TypeVar("_T")
 
 def ensure_containers(fn: Callable[_P, _T]) -> Callable[_P, _T]:
     @wraps(fn)
-    async def compose_wrap(*args: _P.args, **kwargs: _P.kwargs):
+    async def compose_wrap(*args: _P.args, **kwargs: _P.kwargs) -> _T:
         # register shutdown sequence
         # TODO: argument to leave them up
         # NOTE: do we need both this and the finally?
@@ -55,16 +58,16 @@ def ensure_containers(fn: Callable[_P, _T]) -> Callable[_P, _T]:
 
         try:
             # attempt to run `fn`
-            await fn(*args, **kwargs)
+            return await fn(*args, **kwargs)
         finally:
             # stop and remove containers
             # down()
-            ...
+            pass
 
     return compose_wrap
 
 
-def _exec_command(command: Iterable[str], *, compose_options: Tuple[str] = ()) -> None:
+def _exec_command(command: List[str], *, compose_options: Tuple[str, ...] = ()) -> None:
     check_system()
     try:
         check_output(["docker", "compose", *compose_options, "-f", compose_file, *command])

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio_temp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eth-portfolio-temp
-Version: 0.0.24.dev0
+Version: 0.0.26.dev0
 Summary: eth-portfolio makes it easy to analyze your portfolio.
 Home-page: https://github.com/BobTheBuidler/eth-portfolio
 Author: BobTheBuidler

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio_temp.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ setup.py
 .github/workflows/mypy.yaml
 .github/workflows/release.yaml
 docs/Makefile
+docs/caching.rst
 docs/conf.py
 docs/exporter.rst
 docs/index.rst

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/eth_portfolio_temp.egg-info/top_level.txt

@@ -1,3 +1,3 @@
-2960ac10e1a504a73b93__mypyc
+a84bea286168f88be129__mypyc
 eth_portfolio
 eth_portfolio_scripts

{eth_portfolio_temp-0.0.24.dev0 → eth_portfolio_temp-0.0.26.dev0}/setup.py

@@ -59,10 +59,11 @@ try:
             "eth_portfolio/_shitcoins.py",
             # "eth_portfolio/_submodules.py",
             "eth_portfolio/constants.py",
+            "eth_portfolio_scripts/docker",
             # "eth_portfolio_scripts/victoria/__init__.py",  # this one built fine with other files but wont alone
             # "eth_portfolio_scripts/_portfolio.py",
             # "eth_portfolio_scripts/_utils.py",
-            # "eth_portfolio_scripts/balances.py",
+            "eth_portfolio_scripts/balances.py",
             "--strict",
             "--pretty",
             "--install-types",