Source code for stellar_sdk.xdr.hash

# 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, Opaque

__all__ = ["Hash"]


[docs] class Hash: """ XDR Source Code:: typedef opaque Hash[32]; """ def __init__(self, hash: bytes) -> None: _expect_length = 32 if hash and len(hash) != _expect_length: raise ValueError( f"The length of `hash` should be {_expect_length}, but got {len(hash)}." ) self.hash = hash def pack(self, packer: Packer) -> None: Opaque(self.hash, 32, True).pack(packer) @classmethod def unpack( cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH ) -> Hash: if depth_limit <= 0: raise ValueError("Maximum decoding depth reached") hash = Opaque.unpack(unpacker, 32, True) return cls(hash) def to_xdr_bytes(self) -> bytes: packer = Packer() self.pack(packer) return packer.get_buffer() @classmethod def from_xdr_bytes(cls, xdr: bytes) -> Hash: 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) -> Hash: 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) -> Hash: return cls.from_json_dict(json.loads(json_str)) def to_json_dict(self): return Opaque.to_json_dict(self.hash) @classmethod def from_json_dict(cls, json_value: str) -> Hash: return cls(Opaque.from_json_dict(json_value)) def __hash__(self): return hash((self.hash,)) def __eq__(self, other: object): if not isinstance(other, self.__class__): return NotImplemented return self.hash == other.hash def __repr__(self): return f"<Hash [hash={self.hash}]>"