# 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 .auth_cert import AuthCert
from .base import DEFAULT_XDR_MAX_DEPTH, Integer, String
from .hash import Hash
from .node_id import NodeID
from .uint32 import Uint32
from .uint256 import Uint256
__all__ = ["Hello"]
[docs]
class Hello:
"""
XDR Source Code::
struct Hello
{
uint32 ledgerVersion;
uint32 overlayVersion;
uint32 overlayMinVersion;
Hash networkID;
string versionStr<100>;
int listeningPort;
NodeID peerID;
AuthCert cert;
uint256 nonce;
};
"""
def __init__(
self,
ledger_version: Uint32,
overlay_version: Uint32,
overlay_min_version: Uint32,
network_id: Hash,
version_str: bytes,
listening_port: int,
peer_id: NodeID,
cert: AuthCert,
nonce: Uint256,
) -> None:
_expect_max_length = 100
if version_str and len(version_str) > _expect_max_length:
raise ValueError(
f"The maximum length of `version_str` should be {_expect_max_length}, but got {len(version_str)}."
)
self.ledger_version = ledger_version
self.overlay_version = overlay_version
self.overlay_min_version = overlay_min_version
self.network_id = network_id
self.version_str = version_str
self.listening_port = listening_port
self.peer_id = peer_id
self.cert = cert
self.nonce = nonce
def pack(self, packer: Packer) -> None:
self.ledger_version.pack(packer)
self.overlay_version.pack(packer)
self.overlay_min_version.pack(packer)
self.network_id.pack(packer)
String(self.version_str, 100).pack(packer)
Integer(self.listening_port).pack(packer)
self.peer_id.pack(packer)
self.cert.pack(packer)
self.nonce.pack(packer)
@classmethod
def unpack(
cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH
) -> Hello:
if depth_limit <= 0:
raise ValueError("Maximum decoding depth reached")
ledger_version = Uint32.unpack(unpacker, depth_limit - 1)
overlay_version = Uint32.unpack(unpacker, depth_limit - 1)
overlay_min_version = Uint32.unpack(unpacker, depth_limit - 1)
network_id = Hash.unpack(unpacker, depth_limit - 1)
version_str = String.unpack(unpacker, 100)
listening_port = Integer.unpack(unpacker)
peer_id = NodeID.unpack(unpacker, depth_limit - 1)
cert = AuthCert.unpack(unpacker, depth_limit - 1)
nonce = Uint256.unpack(unpacker, depth_limit - 1)
return cls(
ledger_version=ledger_version,
overlay_version=overlay_version,
overlay_min_version=overlay_min_version,
network_id=network_id,
version_str=version_str,
listening_port=listening_port,
peer_id=peer_id,
cert=cert,
nonce=nonce,
)
def to_xdr_bytes(self) -> bytes:
packer = Packer()
self.pack(packer)
return packer.get_buffer()
@classmethod
def from_xdr_bytes(cls, xdr: bytes) -> Hello:
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) -> Hello:
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) -> Hello:
return cls.from_json_dict(json.loads(json_str))
def to_json_dict(self) -> dict:
return {
"ledger_version": self.ledger_version.to_json_dict(),
"overlay_version": self.overlay_version.to_json_dict(),
"overlay_min_version": self.overlay_min_version.to_json_dict(),
"network_id": self.network_id.to_json_dict(),
"version_str": String.to_json_dict(self.version_str),
"listening_port": Integer.to_json_dict(self.listening_port),
"peer_id": self.peer_id.to_json_dict(),
"cert": self.cert.to_json_dict(),
"nonce": self.nonce.to_json_dict(),
}
@classmethod
def from_json_dict(cls, json_dict: dict) -> Hello:
ledger_version = Uint32.from_json_dict(json_dict["ledger_version"])
overlay_version = Uint32.from_json_dict(json_dict["overlay_version"])
overlay_min_version = Uint32.from_json_dict(json_dict["overlay_min_version"])
network_id = Hash.from_json_dict(json_dict["network_id"])
version_str = String.from_json_dict(json_dict["version_str"])
listening_port = Integer.from_json_dict(json_dict["listening_port"])
peer_id = NodeID.from_json_dict(json_dict["peer_id"])
cert = AuthCert.from_json_dict(json_dict["cert"])
nonce = Uint256.from_json_dict(json_dict["nonce"])
return cls(
ledger_version=ledger_version,
overlay_version=overlay_version,
overlay_min_version=overlay_min_version,
network_id=network_id,
version_str=version_str,
listening_port=listening_port,
peer_id=peer_id,
cert=cert,
nonce=nonce,
)
def __hash__(self):
return hash(
(
self.ledger_version,
self.overlay_version,
self.overlay_min_version,
self.network_id,
self.version_str,
self.listening_port,
self.peer_id,
self.cert,
self.nonce,
)
)
def __eq__(self, other: object):
if not isinstance(other, self.__class__):
return NotImplemented
return (
self.ledger_version == other.ledger_version
and self.overlay_version == other.overlay_version
and self.overlay_min_version == other.overlay_min_version
and self.network_id == other.network_id
and self.version_str == other.version_str
and self.listening_port == other.listening_port
and self.peer_id == other.peer_id
and self.cert == other.cert
and self.nonce == other.nonce
)
def __repr__(self):
out = [
f"ledger_version={self.ledger_version}",
f"overlay_version={self.overlay_version}",
f"overlay_min_version={self.overlay_min_version}",
f"network_id={self.network_id}",
f"version_str={self.version_str}",
f"listening_port={self.listening_port}",
f"peer_id={self.peer_id}",
f"cert={self.cert}",
f"nonce={self.nonce}",
]
return f"<Hello [{', '.join(out)}]>"