# 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 .base import DEFAULT_XDR_MAX_DEPTH
from .hash import Hash
from .uint32 import Uint32
__all__ = ["TTLEntry"]
[docs]
class TTLEntry:
"""
XDR Source Code::
struct TTLEntry {
// Hash of the LedgerKey that is associated with this TTLEntry
Hash keyHash;
uint32 liveUntilLedgerSeq;
};
"""
def __init__(
self,
key_hash: Hash,
live_until_ledger_seq: Uint32,
) -> None:
self.key_hash = key_hash
self.live_until_ledger_seq = live_until_ledger_seq
def pack(self, packer: Packer) -> None:
self.key_hash.pack(packer)
self.live_until_ledger_seq.pack(packer)
@classmethod
def unpack(
cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH
) -> TTLEntry:
if depth_limit <= 0:
raise ValueError("Maximum decoding depth reached")
key_hash = Hash.unpack(unpacker, depth_limit - 1)
live_until_ledger_seq = Uint32.unpack(unpacker, depth_limit - 1)
return cls(
key_hash=key_hash,
live_until_ledger_seq=live_until_ledger_seq,
)
def to_xdr_bytes(self) -> bytes:
packer = Packer()
self.pack(packer)
return packer.get_buffer()
@classmethod
def from_xdr_bytes(cls, xdr: bytes) -> TTLEntry:
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) -> TTLEntry:
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) -> TTLEntry:
return cls.from_json_dict(json.loads(json_str))
def to_json_dict(self) -> dict:
return {
"key_hash": self.key_hash.to_json_dict(),
"live_until_ledger_seq": self.live_until_ledger_seq.to_json_dict(),
}
@classmethod
def from_json_dict(cls, json_dict: dict) -> TTLEntry:
key_hash = Hash.from_json_dict(json_dict["key_hash"])
live_until_ledger_seq = Uint32.from_json_dict(
json_dict["live_until_ledger_seq"]
)
return cls(
key_hash=key_hash,
live_until_ledger_seq=live_until_ledger_seq,
)
def __hash__(self):
return hash(
(
self.key_hash,
self.live_until_ledger_seq,
)
)
def __eq__(self, other: object):
if not isinstance(other, self.__class__):
return NotImplemented
return (
self.key_hash == other.key_hash
and self.live_until_ledger_seq == other.live_until_ledger_seq
)
def __repr__(self):
out = [
f"key_hash={self.key_hash}",
f"live_until_ledger_seq={self.live_until_ledger_seq}",
]
return f"<TTLEntry [{', '.join(out)}]>"