Source code for digital_world_sdk.operation.liquidity_pool_withdraw

import binascii
from decimal import Decimal
from typing import ClassVar

from .. import xdr as dw_xdr
from ..muxed_account import MuxedAccount
from ..utils import raise_if_not_valid_amount, raise_if_not_valid_hash
from .operation import Operation

__all__ = ["LiquidityPoolWithdraw"]




class LiquidityPoolWithdraw(Operation):
    """The :class:`LiquidityPoolWithdraw` object, which represents a LiquidityPoolWithdraw
    operation on the Digital World network.

    Creates a liquidity pool withdraw operation.

    Threshold: Medium

    See `Liquidity Pool Withdraw <https://docs.digitalworld.global/docs/learn/fundamentals/transactions/list-of-operations#liquidity-pool-withdraw>`_ for more information.

    :param liquidity_pool_id: The liquidity pool ID.
    :param amount: Amount of pool shares to withdraw.
    :param min_amount_a: Minimum amount of first asset to withdraw.
    :param min_amount_b: Minimum amount of second asset to withdraw.
    :param source: The source account for the operation. Defaults to the
        transaction's source account.
    """

    _XDR_OPERATION_TYPE: ClassVar[dw_xdr.OperationType] = (
        dw_xdr.OperationType.LIQUIDITY_POOL_WITHDRAW
    )

    def __init__(
        self,
        liquidity_pool_id: str,
        amount: str | Decimal,
        min_amount_a: str | Decimal,
        min_amount_b: str | Decimal,
        source: MuxedAccount | str | None = None,
    ):
        super().__init__(source)
        self.liquidity_pool_id: str = liquidity_pool_id
        self.amount: str = str(amount)
        self.min_amount_a: str = str(min_amount_a)
        self.min_amount_b: str = str(min_amount_b)
        raise_if_not_valid_amount(self.amount, "amount")
        raise_if_not_valid_amount(self.min_amount_a, "min_amount_a")
        raise_if_not_valid_amount(self.min_amount_b, "min_amount_b")
        raise_if_not_valid_hash(self.liquidity_pool_id, "liquidity_pool_id")

    def _to_operation_body(self) -> dw_xdr.OperationBody:
        liquidity_pool_id_bytes = binascii.unhexlify(self.liquidity_pool_id)
        liquidity_pool_id = dw_xdr.PoolID.from_xdr_bytes(liquidity_pool_id_bytes)
        amount = dw_xdr.Int64(Operation.to_xdr_amount(self.amount))
        min_amount_a = dw_xdr.Int64(Operation.to_xdr_amount(self.min_amount_a))
        min_amount_b = dw_xdr.Int64(Operation.to_xdr_amount(self.min_amount_b))
        liquidity_pool_withdraw_op = dw_xdr.LiquidityPoolWithdrawOp(
            liquidity_pool_id, amount, min_amount_a, min_amount_b
        )
        body = dw_xdr.OperationBody(
            type=self._XDR_OPERATION_TYPE,
            liquidity_pool_withdraw_op=liquidity_pool_withdraw_op,
        )
        return body



    @classmethod
    def from_xdr_object(
        cls, xdr_object: dw_xdr.Operation
    ) -> "LiquidityPoolWithdraw":
        """Creates a :class:`LiquidityPoolWithdraw` object from an XDR Operation object."""
        source = Operation.get_source_from_xdr_obj(xdr_object)
        assert xdr_object.body.liquidity_pool_withdraw_op is not None
        liquidity_pool_id_bytes = (
            xdr_object.body.liquidity_pool_withdraw_op.liquidity_pool_id.pool_id.hash
        )
        liquidity_pool_id = liquidity_pool_id_bytes.hex()
        amount = Operation.from_xdr_amount(
            xdr_object.body.liquidity_pool_withdraw_op.amount.int64
        )
        min_amount_a = Operation.from_xdr_amount(
            xdr_object.body.liquidity_pool_withdraw_op.min_amount_a.int64
        )
        min_amount_b = Operation.from_xdr_amount(
            xdr_object.body.liquidity_pool_withdraw_op.min_amount_b.int64
        )

        op = cls(
            source=source,
            liquidity_pool_id=liquidity_pool_id,
            amount=amount,
            min_amount_a=min_amount_a,
            min_amount_b=min_amount_b,
        )
        return op


    def __repr__(self):
        return (
            f"<LiquidityPoolWithdraw [liquidity_pool_id={self.liquidity_pool_id}, amount={self.amount}, "
            f"min_amount_a={self.min_amount_a}, min_amount_b={self.min_amount_b}, source={self.source}]>"
        )