eth-portfolio 1.1.0__py3-none-any.whl

eth_portfolio/protocols/lending/unit.py

@@ -0,0 +1,47 @@
+from typing import Optional
+
+from y import Contract, Network, get_price
+from y._decorators import stuck_coro_debugger
+from y.datatypes import Address, Block
+
+from eth_portfolio._decimal import Decimal
+from eth_portfolio.protocols.lending._base import LendingProtocolWithLockedCollateral
+from eth_portfolio.typing import Balance, TokenBalances
+
+# NOTE: This only works for YFI collateral, must extend before using for other collaterals
+yfi = "0x0bc529c00C6401aEF6D220BE8C6Ea1667F6Ad93e"
+usdp = "0x1456688345527bE1f37E9e627DA0837D6f08C925"
+
+
+class UnitXyz(LendingProtocolWithLockedCollateral):
+    networks = [Network.Mainnet]
+
+    def __init__(self) -> None:
+        self.unitVault = Contract("0xb1cff81b9305166ff1efc49a129ad2afcd7bcf19")
+        self.start_block = 11315910
+
+    @stuck_coro_debugger
+    async def _balances(self, address: Address, block: Optional[Block] = None) -> TokenBalances:
+        balances: TokenBalances = TokenBalances(block=block)
+        if block and block < self.start_block:
+            return balances
+        bal: int = await self.unitVault.collaterals.coroutine(yfi, address, block_identifier=block)
+        if bal:
+            bal = Decimal(bal) / 10**18
+            balances[yfi] = Balance(
+                bal, bal * await get_price(yfi, block, sync=False), token=yfi, block=block
+            )
+        return balances
+
+    @stuck_coro_debugger
+    async def _debt(self, address: Address, block: Optional[Block] = None) -> TokenBalances:
+        balances: TokenBalances = TokenBalances(block=block)
+        if block and block < self.start_block:
+            return balances
+        # NOTE: This only works for YFI based debt, must extend before using for other collaterals
+        if debt := await self.unitVault.getTotalDebt.coroutine(
+            yfi, address, block_identifier=block
+        ):
+            debt = Decimal(debt) / 10**18
+            balances[usdp] = Balance(debt, debt, token=usdp, block=block)
+        return balances

eth_portfolio/protocols/liquity.py

@@ -0,0 +1,16 @@
+from eth_portfolio.protocols._base import SingleTokenStakingPoolABC
+from y import ERC20, Network
+
+
+class LqtyStakingPool(SingleTokenStakingPoolABC):
+    networks = [Network.Mainnet]
+    contract_address = "0x4f9Fbb3f1E99B56e0Fe2892e623Ed36A76Fc605d"
+    balance_method_name = "stakes"
+    token = ERC20("0x6DEA81C8171D0bA574754EF6F8b412F2Ed88c54D")  # LQTY
+
+
+class LiquityStabilityPool(SingleTokenStakingPoolABC):
+    networks = [Network.Mainnet]
+    contract_address = "0x66017D22b0f8556afDd19FC67041899Eb65a21bb"
+    balance_method_name = "getCompoundedLUSDDeposit"
+    token = ERC20("0x5f98805A4E8be255a32880FDeC7F6728C6568bA0")  # LUSD

eth_portfolio/structs/__init__.py

@@ -0,0 +1,43 @@
+"""
+This module provides the primary union type and specific ledger entry types used in the `eth_portfolio` package.
+
+The `__all__` list defines the public API for this module, which includes the main union type `LedgerEntry` and its specific types: `Transaction`, `InternalTransfer`, `TokenTransfer`, and `TransactionRLP`.
+
+Examples:
+    Importing the main union type and specific ledger entry types:
+
+    >>> from eth_portfolio.structs import LedgerEntry, Transaction, InternalTransfer, TokenTransfer, TransactionRLP
+
+    Using the `LedgerEntry` union type to annotate a variable that can hold any ledger entry type:
+
+    >>> entry: LedgerEntry = Transaction(...)
+    >>> entry = InternalTransfer(...)
+    >>> entry = TokenTransfer(...)
+    >>> entry = TransactionRLP(...)
+
+See Also:
+    - :class:`~eth_portfolio.structs.structs.LedgerEntry`
+    - :class:`~eth_portfolio.structs.structs.Transaction`
+    - :class:`~eth_portfolio.structs.structs.InternalTransfer`
+    - :class:`~eth_portfolio.structs.structs.TokenTransfer`
+    - :class:`~eth_portfolio.structs.structs.TransactionRLP`
+"""
+
+from eth_portfolio.structs.structs import (
+    InternalTransfer,
+    LedgerEntry,
+    TokenTransfer,
+    Transaction,
+    TransactionRLP,
+)
+
+__all__ = [
+    # main union type
+    "LedgerEntry",
+    # LedgerEntry types
+    "Transaction",
+    "InternalTransfer",
+    "TokenTransfer",
+    # TODO figure out how to get rid of this
+    "TransactionRLP",
+]

eth_portfolio/structs/modified.py

@@ -0,0 +1,69 @@
+from typing import Union
+
+from evmspec.structs.trace import call, create, reward, suicide
+
+
+class CallTrace(
+    call.Trace,
+    frozen=True,
+    kw_only=True,
+    array_like=True,
+    forbid_unknown_fields=True,
+    omit_defaults=True,
+    repr_omit_defaults=True,
+):  # type: ignore [call-arg]
+    """
+    It works just like a :class:`evmspec.trace.call.Trace` but it encodes to a tuple instead of a dict to save space since keys are known.
+    """
+
+
+class CreateTrace(
+    create.Trace,
+    frozen=True,
+    kw_only=True,
+    array_like=True,
+    forbid_unknown_fields=True,
+    omit_defaults=True,
+    repr_omit_defaults=True,
+):  # type: ignore [call-arg]
+    """
+    It works just like a :class:`evmspec.trace.create.Trace` but it encodes to a tuple instead of a dict to save space since keys are known.
+    """
+
+
+class RewardTrace(
+    reward.Trace,
+    frozen=True,
+    kw_only=True,
+    array_like=True,
+    forbid_unknown_fields=True,
+    omit_defaults=True,
+    repr_omit_defaults=True,
+):  # type: ignore [call-arg]
+    """
+    It works just like a :class:`evmspec.trace.reward.Trace` but it encodes to a tuple instead of a dict to save space since keys are known.
+    """
+
+
+class SuicideTrace(
+    suicide.Trace,
+    frozen=True,
+    kw_only=True,
+    array_like=True,
+    forbid_unknown_fields=True,
+    omit_defaults=True,
+    repr_omit_defaults=True,
+):  # type: ignore [call-arg]
+    """
+    It works just like a :class:`evmspec.trace.suicide.Trace` but it encodes to a tuple instead of a dict to save space since keys are known.
+    """
+
+
+_modified_trace_type_map = {
+    call.Trace: CallTrace,
+    create.Trace: CreateTrace,
+    reward.Trace: RewardTrace,
+    suicide.Trace: SuicideTrace,
+}
+
+ModifiedTrace = Union[CallTrace, CreateTrace, RewardTrace, SuicideTrace]