Models

Assets

Bases: BaseDict

Contains all tokens and quantities.

Source code in src/charli3_dendrite/dataclasses/models.py

class Assets(BaseDict):
    """Contains all tokens and quantities."""

    root: dict[str, int]

    def unit(self, index: int = 0) -> str:
        """Units of asset at `index`."""
        return list(self.keys())[index]

    def quantity(self, index: int = 0) -> int:
        """Quantity of the asset at `index`."""
        return list(self.values())[index]

    @model_validator(mode="before")
    def _digest_assets(cls, values: dict) -> dict:
        if hasattr(values, "root"):
            root = values.root
        elif "values" in values and isinstance(values["values"], list):
            root = {v.unit: v.quantity for v in values["values"]}
        elif isinstance(values, list) and isinstance(values[0], dict):
            if not all(len(v) == 1 for v in values):
                raise ValueError(
                    "For a list of dictionaries, each dictionary must be of length 1.",
                )
            root = {k: v for d in values for k, v in d.items()}
        else:
            root = dict(values.items())
        return dict(
            sorted(root.items(), key=lambda x: "" if x[0] == "lovelace" else x[0]),
        )

    def __add__(a: "Assets", b: "Assets") -> "Assets":
        """Add two assets."""
        intersection = set(a.keys()) | set(b.keys())

        result = {key: a[key] + b[key] for key in intersection}

        return Assets(**result)

    def __sub__(a: "Assets", b: "Assets") -> "Assets":
        """Subtract two assets."""
        intersection = set(a.keys()) | set(b.keys())

        result = {key: a[key] - b[key] for key in intersection}

        return Assets(**result)

__add__(a: Assets, b: Assets) -> Assets

Add two assets.

Source code in src/charli3_dendrite/dataclasses/models.py

def __add__(a: "Assets", b: "Assets") -> "Assets":
    """Add two assets."""
    intersection = set(a.keys()) | set(b.keys())

    result = {key: a[key] + b[key] for key in intersection}

    return Assets(**result)

__sub__(a: Assets, b: Assets) -> Assets

Subtract two assets.

Source code in src/charli3_dendrite/dataclasses/models.py

def __sub__(a: "Assets", b: "Assets") -> "Assets":
    """Subtract two assets."""
    intersection = set(a.keys()) | set(b.keys())

    result = {key: a[key] - b[key] for key in intersection}

    return Assets(**result)

quantity(index: int = 0) -> int

Quantity of the asset at index.

Source code in src/charli3_dendrite/dataclasses/models.py

def quantity(self, index: int = 0) -> int:
    """Quantity of the asset at `index`."""
    return list(self.values())[index]

unit(index: int = 0) -> str

Units of asset at index.

Source code in src/charli3_dendrite/dataclasses/models.py

def unit(self, index: int = 0) -> str:
    """Units of asset at `index`."""
    return list(self.keys())[index]

BaseDict

Bases: BaseList

Utility class for dict models.

Source code in src/charli3_dendrite/dataclasses/models.py

class BaseDict(BaseList):
    """Utility class for dict models."""

    def items(self):  # noqa: ANN201
        """Return iterable of key-value pairs."""
        return self.root.items()

    def keys(self):  # noqa: ANN201
        """Return iterable of keys."""
        return self.root.keys()

    def values(self):  # noqa: ANN201
        """Return iterable of values."""
        return self.root.values()

    def __getitem__(self, item: str):  # noqa: ANN204
        """Get item by key."""
        return self.root.get(item, 0)

__getitem__(item: str)

Get item by key.

Source code in src/charli3_dendrite/dataclasses/models.py

def __getitem__(self, item: str):  # noqa: ANN204
    """Get item by key."""
    return self.root.get(item, 0)

items()

Return iterable of key-value pairs.

Source code in src/charli3_dendrite/dataclasses/models.py

def items(self):  # noqa: ANN201
    """Return iterable of key-value pairs."""
    return self.root.items()

keys()

Return iterable of keys.

Source code in src/charli3_dendrite/dataclasses/models.py

def keys(self):  # noqa: ANN201
    """Return iterable of keys."""
    return self.root.keys()

values()

Return iterable of values.

Source code in src/charli3_dendrite/dataclasses/models.py

def values(self):  # noqa: ANN201
    """Return iterable of values."""
    return self.root.values()

BaseList

Bases: RootModel

Utility class for list models.

Source code in src/charli3_dendrite/dataclasses/models.py

class BaseList(RootModel):
    """Utility class for list models."""

    def __hash__(self) -> int:
        return hash(self.model_dump_json())

    def __iter__(self):  # noqa
        return iter(self.root)

    def __getitem__(self, item):  # noqa
        return self.root[item]

    def __len__(self):  # noqa
        return len(self.root)

PoolSelector

Bases: DendriteBaseModel

Pool selection information for dbsync.

Source code in src/charli3_dendrite/dataclasses/models.py

class PoolSelector(DendriteBaseModel):
    """Pool selection information for dbsync."""

    addresses: list[str]
    assets: list[str] | None = None

PoolSelectorType

Bases: Enum

How to identify a pool.

DEX pools are generally identified by one of two mechanism: 1. An address 2. Presence of one or more NFTs (asset policy, with or without asset name)

Source code in src/charli3_dendrite/dataclasses/models.py

class PoolSelectorType(Enum):
    """How to identify a pool.

    DEX pools are generally identified by one of two mechanism:
    1. An address
    2. Presence of one or more NFTs (asset policy, with or without asset name)
    """

    address = "addresses"
    asset = "assets"

TokenSummary

Bases: DendriteBaseModel

Summary of token information.

Source code in src/charli3_dendrite/dataclasses/models.py

class TokenSummary(DendriteBaseModel):
    """Summary of token information."""

    ticker: str
    name: str
    policy_id: str
    policy_name: str
    decimals: int
    price_numerator: int = 0
    price_denominator: int = 0