# 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 .scp_envelope import SCPEnvelope
from .uint32 import Uint32
__all__ = ["LedgerSCPMessages"]
[docs]
class LedgerSCPMessages:
"""
XDR Source Code::
struct LedgerSCPMessages
{
uint32 ledgerSeq;
SCPEnvelope messages<>;
};
"""
def __init__(
self,
ledger_seq: Uint32,
messages: list[SCPEnvelope],
) -> None:
_expect_max_length = 4294967295
if messages and len(messages) > _expect_max_length:
raise ValueError(
f"The maximum length of `messages` should be {_expect_max_length}, but got {len(messages)}."
)
self.ledger_seq = ledger_seq
self.messages = messages
def pack(self, packer: Packer) -> None:
self.ledger_seq.pack(packer)
packer.pack_uint(len(self.messages))
for messages_item in self.messages:
messages_item.pack(packer)
@classmethod
def unpack(
cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH
) -> LedgerSCPMessages:
if depth_limit <= 0:
raise ValueError("Maximum decoding depth reached")
ledger_seq = Uint32.unpack(unpacker, depth_limit - 1)
length = unpacker.unpack_uint()
_remaining = len(unpacker.get_buffer()) - unpacker.get_position()
if _remaining < length:
raise ValueError(
f"messages length {length} exceeds remaining input length {_remaining}"
)
messages = []
for _ in range(length):
messages.append(SCPEnvelope.unpack(unpacker, depth_limit - 1))
return cls(
ledger_seq=ledger_seq,
messages=messages,
)
def to_xdr_bytes(self) -> bytes:
packer = Packer()
self.pack(packer)
return packer.get_buffer()
@classmethod
def from_xdr_bytes(cls, xdr: bytes) -> LedgerSCPMessages:
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) -> LedgerSCPMessages:
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) -> LedgerSCPMessages:
return cls.from_json_dict(json.loads(json_str))
def to_json_dict(self) -> dict:
return {
"ledger_seq": self.ledger_seq.to_json_dict(),
"messages": [item.to_json_dict() for item in self.messages],
}
@classmethod
def from_json_dict(cls, json_dict: dict) -> LedgerSCPMessages:
ledger_seq = Uint32.from_json_dict(json_dict["ledger_seq"])
messages = [SCPEnvelope.from_json_dict(item) for item in json_dict["messages"]]
return cls(
ledger_seq=ledger_seq,
messages=messages,
)
def __hash__(self):
return hash(
(
self.ledger_seq,
self.messages,
)
)
def __eq__(self, other: object):
if not isinstance(other, self.__class__):
return NotImplemented
return self.ledger_seq == other.ledger_seq and self.messages == other.messages
def __repr__(self):
out = [
f"ledger_seq={self.ledger_seq}",
f"messages={self.messages}",
]
return f"<LedgerSCPMessages [{', '.join(out)}]>"