eth-portfolio 0.5.8__cp311-cp311-musllinux_1_2_x86_64.whl

eth_portfolio/__init__.py

@@ -0,0 +1,24 @@
+import warnings
+
+warnings.filterwarnings(
+    "ignore",
+    message="Changing decimals precision could have unintended side effects!",
+    category=UserWarning,
+)
+
+
+import a_sync._smart
+
+a_sync._smart.set_smart_task_factory()
+
+
+# make sure we init the extended db before we init ypm somewhere
+from eth_portfolio._db import utils
+from eth_portfolio._shitcoins import SHITCOINS
+from eth_portfolio.portfolio import Portfolio, portfolio
+
+__all__ = [
+    "Portfolio",
+    "portfolio",
+    "SHITCOINS",
+]

eth_portfolio/_argspec.py

@@ -0,0 +1,43 @@
+from collections.abc import Callable
+from inspect import getfullargspec
+from typing import Any
+
+# WIP:
+
+
+def get_args_type(sample: Callable) -> tuple[type, ...]:
+    argspec = getfullargspec(sample)
+    args = {
+        arg_name: argspec.annotations[arg_name] if arg_name in argspec.annotations else Any
+        for arg_name in argspec.args
+        if arg_name != "self"
+    }
+    return tuple(*args.values())
+
+
+def get_kwargs_type(sample: Callable) -> tuple[type, ...]:
+    argspec = getfullargspec(sample)
+    num_kwargs = len(argspec.args) - len(argspec.defaults or [])
+    kwarg_names = argspec.args[num_kwargs:]
+    kwargs = {
+        kwarg_name: argspec.annotations[kwarg_name] if kwarg_name in argspec.annotations else Any
+        for kwarg_name in kwarg_names
+    }
+    _kwarg_types: list[type[object]] = list(*kwargs.values())
+    if num_kwargs == 1:
+        return tuple[_kwarg_types[0]]  # type: ignore [valid-type,return-value]
+    elif num_kwargs == 2:
+        return tuple[_kwarg_types[0], _kwarg_types[1]]  # type: ignore [misc,return-value]
+    elif num_kwargs == 3:
+        return tuple[_kwarg_types[0], _kwarg_types[1], _kwarg_types[2]]  # type: ignore [misc,return-value]
+    else:
+        return Any  # type: ignore [misc,return-value]
+
+
+def get_return_type(sample: Callable) -> type:
+    argspec = getfullargspec(sample)
+    return argspec.annotations["return"] if "return" in argspec.annotations else Any
+
+
+def get_types(sample: Callable) -> tuple[type, type, type]:
+    return get_args_type(sample), get_kwargs_type(sample), get_return_type(sample)  # type: ignore [return-value]

eth_portfolio/_cache.py

@@ -0,0 +1,119 @@
+import functools
+import inspect
+from asyncio import AbstractEventLoop, PriorityQueue, Task, current_task, get_event_loop
+from collections.abc import Callable
+from concurrent.futures import Executor
+from hashlib import md5
+from logging import getLogger
+from os import makedirs
+from os.path import exists, join
+from pickle import dumps, load, loads
+from random import random
+from typing import Any, Final, NoReturn
+
+from a_sync import PruningThreadPoolExecutor
+from a_sync._typing import P, T
+from a_sync.asyncio import create_task
+from aiofiles import open as _aio_open
+from brownie import chain
+
+BASE_PATH: Final = f"./cache/{chain.id}/"
+_THREAD_NAME_PREFIX: Final = "eth-portfolio-cache-decorator"
+_EXISTS_EXECUTOR: Final = PruningThreadPoolExecutor(8, f"{_THREAD_NAME_PREFIX}-exists")
+
+
+def cache_to_disk(fn: Callable[P, T]) -> Callable[P, T]:
+    # sourcery skip: use-contextlib-suppress
+    name = fn.__name__
+    cache_path_for_fn = f"{BASE_PATH}{fn.__module__.replace('.', '/')}/{name}"
+    logger = getLogger(f"eth_portfolio.cache_to_disk.{name}")
+
+    def get_cache_file_path(args: tuple[Any, ...], kwargs: dict[str, Any]) -> str:
+        # Create a unique filename based on the function arguments
+        key = md5(dumps((args, sorted(kwargs.items())))).hexdigest()
+        return join(cache_path_for_fn, f"{key}.json")
+
+    write_executor = PruningThreadPoolExecutor(8, f"{_THREAD_NAME_PREFIX}-{fn.__qualname__}-write")
+
+    makedirs(cache_path_for_fn, exist_ok=True)
+
+    if inspect.iscoroutinefunction(fn):
+        read_executor = PruningThreadPoolExecutor(
+            8, f"{_THREAD_NAME_PREFIX}-{fn.__qualname__}-read"
+        )
+
+        queue: PriorityQueue = PriorityQueue()
+
+        async def cache_deco_worker_coro(func: Callable[..., Any]) -> NoReturn:
+            try:
+                while True:
+                    _, fut, cache_path, args, kwargs = await queue.get()
+                    try:
+                        async with _aio_open(cache_path, "rb", executor=read_executor) as f:
+                            fut.set_result(loads(await f.read()))
+                    except Exception as e:
+                        fut.set_exception(e)
+            except Exception as e:
+                logger.error("%s for %s is broken!!!", current_task(), func)
+                logger.exception(e)
+                raise
+
+        loop: AbstractEventLoop | None = None
+        workers: list[Task[NoReturn]] = []
+
+        @functools.wraps(fn)
+        async def disk_cache_wrap(*args: P.args, **kwargs: P.kwargs) -> T:
+            cache_path = get_cache_file_path(args, kwargs)
+            if await _EXISTS_EXECUTOR.run(exists, cache_path):
+                nonlocal loop
+                if loop is None:
+                    loop = get_event_loop()
+                fut = loop.create_future()
+                # we intentionally mix up the order to break up heavy load block ranges
+                queue.put_nowait((random(), fut, cache_path, args, kwargs))
+                if not workers:
+                    workers.extend(create_task(cache_deco_worker_coro(fn)) for _ in range(100))
+                try:
+                    return await fut
+                except EOFError:
+                    pass
+
+            async_result: T = await fn(*args, **kwargs)
+            try:
+                await __cache_write(cache_path, async_result, write_executor)
+            except OSError as e:
+                # I was having some weird issues in docker that I don't want to debug,
+                # so I'm going to assume you have another means to let you know you're
+                # out of disk space and will pass right on through here so my script
+                # can continue
+                if e.strerror != "No space left on device":
+                    raise
+            return async_result
+
+    else:
+
+        @functools.wraps(fn)
+        def disk_cache_wrap(*args: P.args, **kwargs: P.kwargs) -> T:
+            cache_path = get_cache_file_path(args, kwargs)
+            try:
+                with open(cache_path, "rb") as f:
+                    return load(f)
+            except (FileNotFoundError, EOFError):
+                pass
+
+            sync_result: T = fn(*args, **kwargs)  # type: ignore [assignment, return-value]
+            try:
+                create_task(
+                    coro=__cache_write(cache_path, sync_result, write_executor),
+                    skip_gc_until_done=True,
+                )
+            except RuntimeError:
+                pass
+            return sync_result
+
+    return disk_cache_wrap
+
+
+async def __cache_write(cache_path: str, result: Any, executor: Executor) -> None:
+    async with _aio_open(cache_path, "wb", executor=executor) as f:
+        await f.write(dumps(result))

eth_portfolio/_config.py

@@ -0,0 +1,4 @@
+import os
+from typing import Final
+
+REORG_BUFFER: Final = int(os.environ.get("REORG_BUFFER", 30))

eth_portfolio/_db/decorators.py

@@ -0,0 +1,147 @@
+from asyncio import iscoroutinefunction
+from asyncio import sleep as aio_sleep
+from collections.abc import Callable
+from functools import wraps
+from logging import DEBUG, getLogger
+from random import random
+from time import sleep as time_sleep
+from typing import Final, TypeVar
+
+from a_sync._typing import AnyFn
+from pony.orm import OperationalError, TransactionError
+from typing_extensions import ParamSpec
+
+P = ParamSpec("P")
+T = TypeVar("T")
+
+
+logger: Final = getLogger(__name__)
+__logger_is_enabled_for: Final = logger.isEnabledFor
+__logger_warning: Final = logger.warning
+__logger_log: Final = logger._log
+
+
+def break_locks(fn: AnyFn[P, T]) -> AnyFn[P, T]:
+    """
+    Decorator to handle database lock errors by retrying the function.
+
+    This decorator is designed to wrap functions that interact with a database
+    and may encounter `OperationalError` due to database locks. It will retry
+    the function indefinitely if a "database is locked" error occurs. After
+    5 attempts, a warning is logged, but the function will continue to retry
+    until it succeeds or a non-lock-related error occurs.
+
+    Args:
+        fn: The function to be wrapped, which may be a coroutine or a regular function.
+
+    Examples:
+        Basic usage with a regular function:
+
+        >>> @break_locks
+        ... def my_function():
+        ...     # Function logic that may encounter a database lock
+        ...     pass
+
+        Basic usage with an asynchronous function:
+
+        >>> @break_locks
+        ... async def my_async_function():
+        ...     # Async function logic that may encounter a database lock
+        ...     pass
+
+    See Also:
+        - :func:`pony.orm.db_session`: For managing database sessions.
+    """
+    if iscoroutinefunction(fn):
+
+        @wraps(fn)
+        async def break_locks_wrap(*args: P.args, **kwargs: P.kwargs) -> T:
+            debug_logs_enabled = None
+            tries = 0
+            while True:
+                try:
+                    return await fn(*args, **kwargs)
+                except OperationalError as e:
+                    if str(e) != "database is locked":
+                        raise e
+
+                    if debug_logs_enabled is None:
+                        debug_logs_enabled = __logger_is_enabled_for(DEBUG)
+
+                    if debug_logs_enabled is True:
+                        __logger_log(DEBUG, "%s.%s %s", (fn.__module__, fn.__name__, e))
+
+                    await aio_sleep(tries * random())
+                    tries += 1
+                    if tries > 5:
+                        __logger_warning("%s caught in err loop with %s", fn, e)
+
+    else:
+
+        @wraps(fn)
+        def break_locks_wrap(*args: P.args, **kwargs: P.kwargs) -> T:
+            debug_logs_enabled = None
+            tries = 0
+            while True:
+                try:
+                    return fn(*args, **kwargs)  # type: ignore [return-value]
+                except OperationalError as e:
+                    if str(e) != "database is locked":
+                        raise e
+
+                    if debug_logs_enabled is None:
+                        debug_logs_enabled = __logger_is_enabled_for(DEBUG)
+
+                    if debug_logs_enabled is True:
+                        __logger_log(DEBUG, "%s.%s %s", (fn.__module__, fn.__name__, e))
+
+                    time_sleep(tries * random())
+                    tries += 1
+                    if tries > 5:
+                        __logger_warning("%s caught in err loop with %s", fn, e)
+
+    return break_locks_wrap
+
+
+def requery_objs_on_diff_tx_err(fn: Callable[P, T]) -> Callable[P, T]:
+    """
+    Decorator to handle transaction errors by retrying the function.
+
+    This decorator is designed to wrap functions that may encounter
+    `TransactionError` due to mixing objects from different transactions.
+    It will retry the function until it succeeds or a non-transaction-related
+    error occurs.
+
+    Args:
+        fn: The function to be wrapped, which must not be a coroutine.
+
+    Raises:
+        TypeError: If the function is a coroutine.
+
+    Examples:
+        Basic usage with a function that may encounter transaction errors:
+
+        >>> @requery_objs_on_diff_tx_err
+        ... def my_function():
+        ...     # Function logic that may encounter a transaction error
+        ...     pass
+
+    See Also:
+        - :func:`pony.orm.db_session`: For managing database sessions.
+    """
+    if iscoroutinefunction(fn):
+        raise TypeError(f"{fn} must not be async")
+
+    @wraps(fn)
+    def requery_wrap(*args: P.args, **kwargs: P.kwargs) -> T:
+        while True:
+            try:
+                return fn(*args, **kwargs)
+            except TransactionError as e:
+                if str(e) != "An attempt to mix objects belonging to different transactions":
+                    raise e
+                # The error occurs if you committed new objs to the db and started a new transaction while still inside of a `db_session`,
+                # and then tried to use the newly committed objects in the next transaction. Now that the objects are in the db this will
+                # not reoccur. The next iteration will be successful.
+
+    return requery_wrap

eth_portfolio/_db/entities.py

@@ -0,0 +1,311 @@
+from functools import cached_property
+from typing import TYPE_CHECKING
+
+from evmspec.structs.transaction import AccessListEntry
+from hexbytes import HexBytes
+from msgspec import json
+from pony.orm import Optional, PrimaryKey, Required, Set, composite_key
+from y._db.entities import Address, Block, Contract, DbEntity, Token
+
+from eth_portfolio import structs
+from eth_portfolio._decimal import Decimal
+
+
+class BlockExtended(Block):
+    """
+    Extends the base Block entity to add relationships to transactions, internal transfers, and token transfers.
+    """
+
+    if TYPE_CHECKING:
+        # if we execute this code we get `TypeError: 'type' object is not subscriptable`
+        transactions: Set["Transaction"]
+        internal_transfers: Set["InternalTransfer"]
+        token_transfers: Set["TokenTransfer"]
+
+    transactions = Set("Transaction", lazy=True, reverse="block")
+    """All transactions included in this block."""
+
+    internal_transfers = Set("InternalTransfer", lazy=True, reverse="block")
+    """All internal transfers in this block."""
+
+    token_transfers = Set("TokenTransfer", lazy=True, reverse="block")
+    """All token transfers in this block."""
+
+
+class AddressExtended(Address):
+    """
+    Extends the base Address entity to add relationships for sent/received transactions, internal transfers, and token transfers.
+    """
+
+    if TYPE_CHECKING:
+        # if we execute this code we get `TypeError: 'type' object is not subscriptable`
+        transactions_sent: Set["Transaction"]
+        transactions_received: Set["Transaction"]
+        internal_transfers_sent: Set["InternalTransfer"]
+        internal_transfers_received: Set["InternalTransfer"]
+        token_transfers_sent: Set["TokenTransfer"]
+        token_transfers_received: Set["TokenTransfer"]
+
+    transactions_sent = Set("Transaction", lazy=True, reverse="from_address")
+    """Transactions sent from this address."""
+
+    transactions_received = Set("Transaction", lazy=True, reverse="to_address")
+    """Transactions received by this address."""
+
+    internal_transfers_sent = Set("InternalTransfer", lazy=True, reverse="from_address")
+    """Internal transfers sent from this address."""
+
+    internal_transfers_received = Set("InternalTransfer", lazy=True, reverse="to_address")
+    """Internal transfers received by this address."""
+
+    token_transfers_sent = Set("TokenTransfer", lazy=True, reverse="from_address")
+    """Token transfers sent from this address."""
+
+    token_transfers_received = Set("TokenTransfer", lazy=True, reverse="to_address")
+    """Token transfers received by this address."""
+
+
+class ContractExtended(Contract, AddressExtended):
+    """
+    Extends both Contract and AddressExtended to represent a contract with address relationships.
+    """
+
+
+class TokenExtended(Token, AddressExtended):
+    """
+    Extends both Token and AddressExtended to represent a token contract with address relationships.
+    """
+
+    if TYPE_CHECKING:
+        # if we execute this code we get `TypeError: 'type' object is not subscriptable`
+        transfers: Set["TokenTransfer"]
+
+    transfers = Set("TokenTransfer", lazy=True, reverse="token")
+    """All token transfers involving this token."""
+
+
+class Transaction(DbEntity):
+    """
+    Represents an Ethereum transaction, including all on-chain and decoded fields.
+    """
+
+    _id = PrimaryKey(int, auto=True)
+    """Auto-incrementing primary key for the transaction."""
+
+    block = Required(BlockExtended, lazy=True, reverse="transactions")
+    """The block containing this transaction."""
+
+    transaction_index = Required(int, lazy=True)
+    """The index of this transaction within the block."""
+
+    hash = Required(str, index=True, lazy=True)
+    """The transaction hash."""
+
+    from_address = Required(AddressExtended, index=True, lazy=True, reverse="transactions_sent")
+    """Sender address."""
+
+    to_address = Optional(AddressExtended, index=True, lazy=True, reverse="transactions_received")
+    """Recipient address (None for contract creation)."""
+
+    value = Required(Decimal, 38, 18, lazy=True)
+    price = Optional(Decimal, 38, 18, lazy=True)
+    value_usd = Optional(Decimal, 38, 18, lazy=True)
+    """USD value of the transaction (optional)."""
+
+    nonce = Required(int, lazy=True)
+    """Sender's transaction count at the time of this transaction."""
+
+    type = Optional(int, lazy=True)
+    """Transaction type (e.g., legacy, EIP-1559)."""
+
+    gas = Required(Decimal, 38, 1, lazy=True)
+    """Gas limit for the transaction."""
+
+    gas_price = Required(Decimal, 38, 1, lazy=True)
+    """Gas price (in wei)."""
+
+    max_fee_per_gas = Optional(Decimal, 38, 1, lazy=True)
+    """Max fee per gas (EIP-1559, optional)."""
+
+    max_priority_fee_per_gas = Optional(Decimal, 38, 1, lazy=True)
+    """Max priority fee per gas (EIP-1559, optional)."""
+
+    composite_key(block, transaction_index)
+
+    raw = Required(bytes, lazy=True)
+
+    @cached_property
+    def decoded(self) -> structs.Transaction:
+        return json.decode(self.raw, type=structs.Transaction)
+
+    @property
+    def input(self) -> HexBytes:
+        """The data payload sent with the transaction (for contract calls)."""
+        return self.decoded.input
+
+    @property
+    def r(self) -> HexBytes:
+        """ECDSA signature R value."""
+        return self.decoded.r
+
+    @property
+    def s(self) -> HexBytes:
+        """ECDSA signature S value."""
+        return self.decoded.s
+
+    @property
+    def v(self) -> int:
+        """ECDSA signature V value (replay protection)."""
+        return self.decoded.v
+
+    @property
+    def access_list(self) -> list[AccessListEntry]:
+        """EIP-2930 access list (if present)."""
+        return self.decoded.access_list
+
+    @property
+    def y_parity(self) -> int | None:
+        """EIP-1559 y-parity value (if present)."""
+        return self.decoded.y_parity
+
+
+class InternalTransfer(DbEntity):
+    """
+    Represents an internal transfer (call, delegatecall, etc.) within a transaction.
+    """
+
+    _id = PrimaryKey(int, auto=True)
+    """Auto-incrementing primary key for the internal transfer."""
+
+    # common
+    block = Required(BlockExtended, lazy=True, reverse="internal_transfers")
+    """The block containing this internal transfer."""
+
+    transaction_index = Required(int, lazy=True)
+    """The index of the transaction within the block."""
+
+    hash = Required(str, lazy=True)
+    """Transaction hash."""
+
+    from_address = Required(
+        AddressExtended, index=True, lazy=True, reverse="internal_transfers_sent"
+    )
+    """Sender address."""
+
+    to_address = Optional(
+        AddressExtended, index=True, lazy=True, reverse="internal_transfers_received"
+    )
+    """Recipient address (None for contract creation)."""
+
+    value = Required(Decimal, 38, 18, lazy=True)
+    price = Optional(Decimal, 38, 18, lazy=True)
+    value_usd = Optional(Decimal, 38, 18, lazy=True)
+    """USD value of the transfer (optional)."""
+
+    # unique
+    type = Required(str, lazy=True)
+    """Type of call (e.g., "call", "delegatecall", "staticcall")."""
+
+    call_type = Required(str, lazy=True)
+    """Call type (e.g., "call", "create")."""
+
+    trace_address = Required(str, lazy=True)
+    """Path of sub-calls to reach this transfer."""
+
+    gas = Required(Decimal, 38, 1, lazy=True)
+    """Gas provided for the call."""
+
+    gas_used = Optional(Decimal, 38, 1, lazy=True)
+    """Gas used by the call (optional)."""
+
+    composite_key(
+        block,
+        transaction_index,
+        hash,
+        from_address,
+        to_address,
+        value,
+        type,
+        call_type,
+        trace_address,
+        gas,
+        gas_used,
+    )
+
+    raw = Required(bytes, lazy=True)
+
+    @cached_property
+    def decoded(self) -> structs.InternalTransfer:
+        structs.InternalTransfer.__doc__
+        return json.decode(self.raw, type=structs.InternalTransfer)
+
+    @property
+    def code(self) -> HexBytes:
+        structs.InternalTransfer.code.__doc__
+        return self.decoded.code
+
+    @property
+    def input(self) -> HexBytes:
+        """The input data for the call."""
+        return self.decoded.input
+
+    @property
+    def output(self) -> HexBytes:
+        """The output data from the call."""
+        return self.decoded.output
+
+    @property
+    def subtraces(self) -> int:
+        """The number of sub-operations spawned by this internal transfer."""
+        return self.decoded.subtraces
+
+
+class TokenTransfer(DbEntity):
+    """
+    Represents an ERC20/ERC721 token transfer event within a transaction.
+    """
+
+    _id = PrimaryKey(int, auto=True)
+    """Auto-incrementing primary key for the token transfer."""
+
+    # common
+    block = Required(BlockExtended, lazy=True, reverse="token_transfers")
+    """The block containing this token transfer."""
+
+    transaction_index = Required(int, lazy=True)
+    """The index of the transaction within the block."""
+
+    hash = Required(str, lazy=True)
+    """Transaction hash."""
+
+    from_address = Required(AddressExtended, index=True, lazy=True, reverse="token_transfers_sent")
+    """Sender address."""
+
+    to_address = Required(
+        AddressExtended, index=True, lazy=True, reverse="token_transfers_received"
+    )
+    """Recipient address."""
+
+    value = Required(Decimal, 38, 18, lazy=True)
+    """Amount of tokens transferred."""
+
+    price = Optional(Decimal, 38, 18, lazy=True)
+    """Price of the token at the time of transfer (optional)."""
+
+    value_usd = Optional(Decimal, 38, 18, lazy=True)
+    """USD value of the transfer (optional)."""
+
+    # unique
+    log_index = Required(int, lazy=True)
+    """Log index of the transfer event within the transaction."""
+
+    token = Optional(TokenExtended, index=True, lazy=True, reverse="transfers")
+    """The token contract involved in this transfer."""
+
+    composite_key(block, transaction_index, log_index)
+
+    raw = Required(bytes, lazy=True)
+
+    @cached_property
+    def decoded(self) -> structs.TokenTransfer:
+        return json.decode(self.raw, type=structs.TokenTransfer)