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