# 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 .envelope_type import EnvelopeType
from .fee_bump_transaction_envelope import FeeBumpTransactionEnvelope
from .transaction_v0_envelope import TransactionV0Envelope
from .transaction_v1_envelope import TransactionV1Envelope
__all__ = ["TransactionEnvelope"]
[docs]
class TransactionEnvelope:
"""
XDR Source Code::
union TransactionEnvelope switch (EnvelopeType type)
{
case ENVELOPE_TYPE_TX_V0:
TransactionV0Envelope v0;
case ENVELOPE_TYPE_TX:
TransactionV1Envelope v1;
case ENVELOPE_TYPE_TX_FEE_BUMP:
FeeBumpTransactionEnvelope feeBump;
};
"""
def __init__(
self,
type: EnvelopeType,
v0: TransactionV0Envelope | None = None,
v1: TransactionV1Envelope | None = None,
fee_bump: FeeBumpTransactionEnvelope | None = None,
) -> None:
self.type = type
self.v0 = v0
self.v1 = v1
self.fee_bump = fee_bump
def pack(self, packer: Packer) -> None:
self.type.pack(packer)
if self.type == EnvelopeType.ENVELOPE_TYPE_TX_V0:
if self.v0 is None:
raise ValueError("v0 should not be None.")
self.v0.pack(packer)
return
if self.type == EnvelopeType.ENVELOPE_TYPE_TX:
if self.v1 is None:
raise ValueError("v1 should not be None.")
self.v1.pack(packer)
return
if self.type == EnvelopeType.ENVELOPE_TYPE_TX_FEE_BUMP:
if self.fee_bump is None:
raise ValueError("fee_bump should not be None.")
self.fee_bump.pack(packer)
return
raise ValueError("Invalid type.")
@classmethod
def unpack(
cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH
) -> TransactionEnvelope:
if depth_limit <= 0:
raise ValueError("Maximum decoding depth reached")
type = EnvelopeType.unpack(unpacker)
if type == EnvelopeType.ENVELOPE_TYPE_TX_V0:
v0 = TransactionV0Envelope.unpack(unpacker, depth_limit - 1)
return cls(type=type, v0=v0)
if type == EnvelopeType.ENVELOPE_TYPE_TX:
v1 = TransactionV1Envelope.unpack(unpacker, depth_limit - 1)
return cls(type=type, v1=v1)
if type == EnvelopeType.ENVELOPE_TYPE_TX_FEE_BUMP:
fee_bump = FeeBumpTransactionEnvelope.unpack(unpacker, depth_limit - 1)
return cls(type=type, fee_bump=fee_bump)
raise ValueError("Invalid type.")
def to_xdr_bytes(self) -> bytes:
packer = Packer()
self.pack(packer)
return packer.get_buffer()
@classmethod
def from_xdr_bytes(cls, xdr: bytes) -> TransactionEnvelope:
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) -> TransactionEnvelope:
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) -> TransactionEnvelope:
return cls.from_json_dict(json.loads(json_str))
def to_json_dict(self):
if self.type == EnvelopeType.ENVELOPE_TYPE_TX_V0:
assert self.v0 is not None
return {"tx_v0": self.v0.to_json_dict()}
if self.type == EnvelopeType.ENVELOPE_TYPE_TX:
assert self.v1 is not None
return {"tx": self.v1.to_json_dict()}
if self.type == EnvelopeType.ENVELOPE_TYPE_TX_FEE_BUMP:
assert self.fee_bump is not None
return {"tx_fee_bump": self.fee_bump.to_json_dict()}
raise ValueError(f"Unknown type in TransactionEnvelope: {self.type}")
@classmethod
def from_json_dict(cls, json_value: dict) -> TransactionEnvelope:
if len(json_value) != 1:
raise ValueError(
f"Expected a single-key object for TransactionEnvelope, got: {json_value}"
)
key = next(iter(json_value))
type = EnvelopeType.from_json_dict(key)
if key == "tx_v0":
v0 = TransactionV0Envelope.from_json_dict(json_value["tx_v0"])
return cls(type=type, v0=v0)
if key == "tx":
v1 = TransactionV1Envelope.from_json_dict(json_value["tx"])
return cls(type=type, v1=v1)
if key == "tx_fee_bump":
fee_bump = FeeBumpTransactionEnvelope.from_json_dict(
json_value["tx_fee_bump"]
)
return cls(type=type, fee_bump=fee_bump)
raise ValueError(f"Unknown key '{key}' for TransactionEnvelope")
def __hash__(self):
return hash(
(
self.type,
self.v0,
self.v1,
self.fee_bump,
)
)
def __eq__(self, other: object):
if not isinstance(other, self.__class__):
return NotImplemented
return (
self.type == other.type
and self.v0 == other.v0
and self.v1 == other.v1
and self.fee_bump == other.fee_bump
)
def __repr__(self):
out = []
out.append(f"type={self.type}")
if self.v0 is not None:
out.append(f"v0={self.v0}")
if self.v1 is not None:
out.append(f"v1={self.v1}")
if self.fee_bump is not None:
out.append(f"fee_bump={self.fee_bump}")
return f"<TransactionEnvelope [{', '.join(out)}]>"