charli3_dendrite 0.2.0.dev116__py3-none-any.whl

charli3_dendrite/__init__.py

@@ -0,0 +1,18 @@
+# noqa
+from charli3_dendrite.dexs.amm.minswap import MinswapCPPState
+from charli3_dendrite.dexs.amm.minswap import MinswapDJEDiUSDStableState
+from charli3_dendrite.dexs.amm.minswap import MinswapDJEDUSDCStableState
+from charli3_dendrite.dexs.amm.minswap import MinswapDJEDUSDMStableState
+from charli3_dendrite.dexs.amm.minswap import MinswapV2CPPState
+from charli3_dendrite.dexs.amm.muesli import MuesliSwapCLPState
+from charli3_dendrite.dexs.amm.muesli import MuesliSwapCPPState
+from charli3_dendrite.dexs.amm.spectrum import SpectrumCPPState
+from charli3_dendrite.dexs.amm.sundae import SundaeSwapCPPState
+from charli3_dendrite.dexs.amm.sundae import SundaeSwapV3CPPState
+from charli3_dendrite.dexs.amm.vyfi import VyFiCPPState
+from charli3_dendrite.dexs.amm.wingriders import WingRidersCPPState
+from charli3_dendrite.dexs.amm.wingriders import WingRidersSSPState
+from charli3_dendrite.dexs.ob.axo import AxoOBMarketState
+from charli3_dendrite.dexs.ob.geniusyield import GeniusYieldOrderBook
+from charli3_dendrite.dexs.ob.geniusyield import GeniusYieldOrderState
+from charli3_dendrite.utility import Assets

charli3_dendrite/backend/__init__.py

@@ -0,0 +1,97 @@
+"""Backend Management Module for Charli3 Dendrite.
+
+This module provides a centralized system for managing the backend used throughout
+the Charli3 Dendrite application. It includes functions to get and set the global backend,
+as well as to set a default backend based on environment variables.
+
+The module uses a global variable to store the current backend instance, which
+can be accessed and modified using the provided functions. This approach allows
+for easy switching between different backend implementations and provides a
+convenient way to set up a default backend.
+
+Typical usage:
+    from charli3_dendrite.backends import get_backend, set_backend
+    from charli3_dendrite.backend.custom_backend import CustomBackend
+
+    # Get the current backend (initializes a default if not set)
+    backend = get_backend()
+
+    # Set a custom backend
+    set_backend(CustomBackend())
+
+Note: This module relies on environment variables for setting up the default backend.
+Ensure that the necessary environment variables are set before using this module.
+"""
+
+import os
+from typing import Optional
+
+from dotenv import load_dotenv
+
+from charli3_dendrite.backend.backend_base import AbstractBackend
+from charli3_dendrite.backend.dbsync import DbsyncBackend
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Global variable to store the current backend instance
+BACKEND: Optional[AbstractBackend] = None
+
+
+def get_backend() -> AbstractBackend:
+    """Retrieve the current backend instance.
+
+    If no backend has been set, this function attempts to set a default backend
+    based on environment variables. If no default can be set, it raises a ValueError.
+
+    Returns:
+        AbstractBackend: The current backend instance.
+
+    Raises:
+        ValueError: If no backend has been set and no default can be determined.
+    """
+    if BACKEND is None:
+        set_default_backend()
+    if BACKEND is None:
+        raise ValueError("Backend has not been set. Call set_backend() first.")
+    return BACKEND
+
+
+def set_backend(backend: AbstractBackend) -> None:
+    """Set the global backend instance.
+
+    Args:
+        backend (AbstractBackend): The backend instance to set as the global backend.
+    """
+    global BACKEND  # noqa: PLW0603
+    BACKEND = backend
+
+
+def set_default_backend() -> None:
+    """Attempt to set a default backend based on environment variables.
+
+    This function checks for the presence of specific environment variables
+    to determine which backend to use as the default. Currently, it only
+    checks for DBSync-related variables, but can be extended to support
+    other backend types in the future.
+    """
+    # Check for DBSync environment variables
+    dbsync_vars = [
+        "DBSYNC_USER",
+        "DBSYNC_PASS",
+        "DBSYNC_HOST",
+        "DBSYNC_PORT",
+        "DBSYNC_DB_NAME",
+    ]
+    if all(env_var in os.environ for env_var in dbsync_vars):
+        set_backend(DbsyncBackend())
+
+    """ TODO: Add checks for other backend types here as needed
+    For example:
+    elif all(env_var in os.environ for env_var in other_backend_vars):
+        set_backend(OtherBackend())
+    """
+
+
+# Optional: Initialize the backend when the module is imported
+set_default_backend()

charli3_dendrite/backend/backend_base.py

@@ -0,0 +1,186 @@
+"""Abstract base class for Cardano blockchain backend implementations."""
+
+from abc import ABC
+from abc import abstractmethod
+from datetime import datetime
+
+from pycardano import Address
+
+from charli3_dendrite.dataclasses.models import BlockList
+from charli3_dendrite.dataclasses.models import PoolStateList
+from charli3_dendrite.dataclasses.models import ScriptReference
+from charli3_dendrite.dataclasses.models import SwapTransactionList
+
+
+class AbstractBackend(ABC):
+    """Abstract base class for Cardano blockchain backend implementations.
+
+    This class defines the interface for interacting with various Cardano blockchain
+    data sources such as db-sync, Ogmios, or Kupo.
+    """
+
+    @abstractmethod
+    def get_pool_utxos(  # noqa: PLR0913
+        self,
+        assets: list[str] | None = None,
+        addresses: list[str] | None = None,
+        limit: int = 1000,
+        page: int = 0,
+        historical: bool = True,
+    ) -> PoolStateList:
+        """Get UTXOs for specific assets or addresses.
+
+        Args:
+            assets (Optional[List[str]]): List of asset IDs to filter by.
+            addresses (Optional[List[str]]): List of addresses to filter by.
+            limit (int): Maximum number of results to return.
+            page (int): Page number for pagination.
+            historical (bool): Whether to include historical data.
+
+        Returns:
+            PoolStateList: List of pool state objects.
+        """
+        pass
+
+    @abstractmethod
+    def get_pool_in_tx(
+        self,
+        tx_hash: str,
+        assets: list[str] | None = None,
+        addresses: list[str] | None = None,
+    ) -> PoolStateList:
+        """Get pool state for a specific transaction.
+
+        Args:
+            tx_hash (str): The transaction hash to query.
+            assets (Optional[List[str]]): List of asset IDs to filter by.
+            addresses (Optional[List[str]]): List of addresses to filter by.
+
+        Returns:
+            PoolStateList: List of pool state objects for the transaction.
+        """
+        pass
+
+    @abstractmethod
+    def last_block(self, last_n_blocks: int = 2) -> BlockList:
+        """Get information about the last n blocks.
+
+        Args:
+            last_n_blocks (int): Number of recent blocks to retrieve.
+
+        Returns:
+            BlockList: List of recent block information.
+        """
+        pass
+
+    @abstractmethod
+    def get_pool_utxos_in_block(self, block_no: int) -> PoolStateList:
+        """Get pool UTXOs for a specific block.
+
+        Args:
+            block_no (int): The block number to query.
+
+        Returns:
+            PoolStateList: List of pool state objects for the block.
+        """
+        pass
+
+    @abstractmethod
+    def get_script_from_address(self, address: Address) -> ScriptReference:
+        """Get script reference for a given address.
+
+        Args:
+            address (Address): The address to query.
+
+        Returns:
+            ScriptReference: Script reference for the address.
+        """
+        pass
+
+    @abstractmethod
+    def get_historical_order_utxos(
+        self,
+        stake_addresses: list[str],
+        after_time: datetime | int | None = None,
+        limit: int = 1000,
+        page: int = 0,
+    ) -> SwapTransactionList:
+        """Get historical order UTXOs for given stake addresses.
+
+        Args:
+            stake_addresses (List[str]): List of stake addresses to query.
+            after_time (Optional[Union[datetime, int]]): Filter results after this time.
+            limit (int): Maximum number of results to return.
+            page (int): Page number for pagination.
+
+        Returns:
+            SwapTransactionList: List of swap transaction objects.
+        """
+        pass
+
+    @abstractmethod
+    def get_order_utxos_by_block_or_tx(  # noqa: PLR0913
+        self,
+        stake_addresses: list[str],
+        out_tx_hash: list[str] | None = None,
+        in_tx_hash: list[str] | None = None,
+        block_no: int | None = None,
+        after_block: int | None = None,
+        limit: int = 1000,
+        page: int = 0,
+    ) -> SwapTransactionList:
+        """Get order UTXOs by block or transaction.
+
+        Args:
+            stake_addresses (List[str]): List of stake addresses to query.
+            out_tx_hash (Optional[List[str]]): List of transaction hashes to filter by.
+            in_tx_hash: list of input transaction hashes to filter by.
+            block_no (Optional[int]): Specific block number to query.
+            after_block (Optional[int]): Filter results after this block number.
+            limit (int): Maximum number of results to return.
+            page (int): Page number for pagination.
+
+        Returns:
+            SwapTransactionList: List of swap transaction objects.
+        """
+        pass
+
+    @abstractmethod
+    def get_cancel_utxos(  # noqa: PLR0913
+        self,
+        stake_addresses: list[str],
+        block_no: int | None = None,
+        after_time: datetime | int | None = None,
+        limit: int = 1000,
+        page: int = 0,
+    ) -> SwapTransactionList:
+        """Get cancelled order UTXOs.
+
+        Args:
+            stake_addresses (List[str]): List of stake addresses to query.
+            block_no (Optional[int]): Specific block number to query.
+            after_time (Optional[Union[datetime, int]]): Filter results after this time.
+            limit (int): Maximum number of results to return.
+            page (int): Page number for pagination.
+
+        Returns:
+            SwapTransactionList: List of swap transaction objects for cancelled orders.
+        """
+        pass
+
+    @abstractmethod
+    def get_datum_from_address(
+        self,
+        address: str,
+        asset: str | None = None,
+    ) -> str | None:
+        """Get datum from a given address.
+
+        Args:
+            address: The address to query.
+            asset: Assets required to be in the UTxO.
+
+        Returns:
+            The datum associated with the address, if any.
+        """
+        pass