Source code for stellar_sdk.xdr.claimable_balance_entry

# This is an automatically generated file.
# DO NOT EDIT or your changes may be overwritten
from __future__ import annotations

import base64
import json

from xdrlib3 import Packer, Unpacker

from .asset import Asset
from .base import DEFAULT_XDR_MAX_DEPTH
from .claimable_balance_entry_ext import ClaimableBalanceEntryExt
from .claimable_balance_id import ClaimableBalanceID
from .claimant import Claimant
from .int64 import Int64

__all__ = ["ClaimableBalanceEntry"]




class ClaimableBalanceEntry:
    """
    XDR Source Code::

        struct ClaimableBalanceEntry
        {
            // Unique identifier for this ClaimableBalanceEntry
            ClaimableBalanceID balanceID;

            // List of claimants with associated predicate
            Claimant claimants<10>;

            // Any asset including native
            Asset asset;

            // Amount of asset
            int64 amount;

            // reserved for future use
            union switch (int v)
            {
            case 0:
                void;
            case 1:
                ClaimableBalanceEntryExtensionV1 v1;
            }
            ext;
        };
    """

    def __init__(
        self,
        balance_id: ClaimableBalanceID,
        claimants: list[Claimant],
        asset: Asset,
        amount: Int64,
        ext: ClaimableBalanceEntryExt,
    ) -> None:
        _expect_max_length = 10
        if claimants and len(claimants) > _expect_max_length:
            raise ValueError(
                f"The maximum length of `claimants` should be {_expect_max_length}, but got {len(claimants)}."
            )
        self.balance_id = balance_id
        self.claimants = claimants
        self.asset = asset
        self.amount = amount
        self.ext = ext

    def pack(self, packer: Packer) -> None:
        self.balance_id.pack(packer)
        packer.pack_uint(len(self.claimants))
        for claimants_item in self.claimants:
            claimants_item.pack(packer)
        self.asset.pack(packer)
        self.amount.pack(packer)
        self.ext.pack(packer)

    @classmethod
    def unpack(
        cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH
    ) -> ClaimableBalanceEntry:
        if depth_limit <= 0:
            raise ValueError("Maximum decoding depth reached")
        balance_id = ClaimableBalanceID.unpack(unpacker, depth_limit - 1)
        length = unpacker.unpack_uint()
        _remaining = len(unpacker.get_buffer()) - unpacker.get_position()
        if _remaining < length:
            raise ValueError(
                f"claimants length {length} exceeds remaining input length {_remaining}"
            )
        claimants = []
        for _ in range(length):
            claimants.append(Claimant.unpack(unpacker, depth_limit - 1))
        asset = Asset.unpack(unpacker, depth_limit - 1)
        amount = Int64.unpack(unpacker, depth_limit - 1)
        ext = ClaimableBalanceEntryExt.unpack(unpacker, depth_limit - 1)
        return cls(
            balance_id=balance_id,
            claimants=claimants,
            asset=asset,
            amount=amount,
            ext=ext,
        )

    def to_xdr_bytes(self) -> bytes:
        packer = Packer()
        self.pack(packer)
        return packer.get_buffer()

    @classmethod
    def from_xdr_bytes(cls, xdr: bytes) -> ClaimableBalanceEntry:
        unpacker = Unpacker(xdr)
        result = cls.unpack(unpacker)
        remaining = len(xdr) - unpacker.get_position()
        if remaining != 0:
            raise ValueError(f"Unexpected trailing {remaining} bytes in XDR data")
        return result

    def to_xdr(self) -> str:
        xdr_bytes = self.to_xdr_bytes()
        return base64.b64encode(xdr_bytes).decode()

    @classmethod
    def from_xdr(cls, xdr: str) -> ClaimableBalanceEntry:
        xdr_bytes = base64.b64decode(xdr.encode())
        return cls.from_xdr_bytes(xdr_bytes)

    def to_json(self) -> str:
        return json.dumps(self.to_json_dict())

    @classmethod
    def from_json(cls, json_str: str) -> ClaimableBalanceEntry:
        return cls.from_json_dict(json.loads(json_str))

    def to_json_dict(self) -> dict:
        return {
            "balance_id": self.balance_id.to_json_dict(),
            "claimants": [item.to_json_dict() for item in self.claimants],
            "asset": self.asset.to_json_dict(),
            "amount": self.amount.to_json_dict(),
            "ext": self.ext.to_json_dict(),
        }

    @classmethod
    def from_json_dict(cls, json_dict: dict) -> ClaimableBalanceEntry:
        balance_id = ClaimableBalanceID.from_json_dict(json_dict["balance_id"])
        claimants = [Claimant.from_json_dict(item) for item in json_dict["claimants"]]
        asset = Asset.from_json_dict(json_dict["asset"])
        amount = Int64.from_json_dict(json_dict["amount"])
        ext = ClaimableBalanceEntryExt.from_json_dict(json_dict["ext"])
        return cls(
            balance_id=balance_id,
            claimants=claimants,
            asset=asset,
            amount=amount,
            ext=ext,
        )

    def __hash__(self):
        return hash(
            (
                self.balance_id,
                self.claimants,
                self.asset,
                self.amount,
                self.ext,
            )
        )

    def __eq__(self, other: object):
        if not isinstance(other, self.__class__):
            return NotImplemented
        return (
            self.balance_id == other.balance_id
            and self.claimants == other.claimants
            and self.asset == other.asset
            and self.amount == other.amount
            and self.ext == other.ext
        )

    def __repr__(self):
        out = [
            f"balance_id={self.balance_id}",
            f"claimants={self.claimants}",
            f"asset={self.asset}",
            f"amount={self.amount}",
            f"ext={self.ext}",
        ]
        return f"<ClaimableBalanceEntry [{', '.join(out)}]>"