Source code for stellar_sdk.time_bounds

from . import xdr as stellar_xdr

__all__ = ["TimeBounds"]


[docs] class TimeBounds: """TimeBounds represents the time interval that a transaction is valid. The UNIX timestamp (in seconds), determined by ledger time, of a lower and upper bound of when this transaction will be valid. If a transaction is submitted too early or too late, it will fail to make it into the transaction set. *max_time* equal ``0`` means that it’s not set. See `Stellar's documentation on Transactions <https://developers.stellar.org/docs/glossary/transactions/#time-bounds>`__ for more information on how TimeBounds are used within transactions. :param min_time: the UNIX timestamp (in seconds) :param max_time: the UNIX timestamp (in seconds) :raises: :exc:`ValueError <stellar_sdk.exceptions.ValueError>`: if `max_time` less than `min_time`. """ def __init__(self, min_time: int, max_time: int) -> None: if min_time < 0: raise ValueError("min_time cannot be negative.") if max_time < 0: raise ValueError("max_time cannot be negative.") if 0 < max_time < min_time: raise ValueError("min_time cannot be greater than max_time.") self.min_time: int = min_time self.max_time: int = max_time
[docs] def to_xdr_object(self) -> stellar_xdr.TimeBounds: """Returns the xdr object for this TimeBounds object. :return: XDR TimeBounds object """ min_time = stellar_xdr.TimePoint(stellar_xdr.Uint64(self.min_time)) max_time = stellar_xdr.TimePoint(stellar_xdr.Uint64(self.max_time)) return stellar_xdr.TimeBounds(min_time, max_time)
[docs] @classmethod def from_xdr_object(cls, xdr_object: stellar_xdr.TimeBounds) -> "TimeBounds": """Create a :class:`TimeBounds` from an XDR TimeBounds object. :param xdr_object: The XDR TimeBounds object. :return: A new :class:`TimeBounds` object from the given XDR TimeBounds object. """ return cls( min_time=xdr_object.min_time.time_point.uint64, max_time=xdr_object.max_time.time_point.uint64, )
def __hash__(self): return hash((self.min_time, self.max_time)) def __eq__(self, other: object) -> bool: if not isinstance(other, self.__class__): return NotImplemented return self.min_time == other.min_time and self.max_time == other.max_time def __str__(self): return f"<TimeBounds [min_time={self.min_time}, max_time={self.max_time}]>"