# This is an automatically generated file.
# DO NOT EDIT or your changes may be overwritten
from __future__ import annotations
import base64
import json
from typing import List
from xdrlib3 import Packer, Unpacker
from .base import DEFAULT_XDR_MAX_DEPTH
from .constants import *
from .memo import Memo
from .muxed_account import MuxedAccount
from .operation import Operation
from .preconditions import Preconditions
from .sequence_number import SequenceNumber
from .transaction_ext import TransactionExt
from .uint32 import Uint32
__all__ = ["Transaction"]
[docs]
class Transaction:
"""
XDR Source Code::
struct Transaction
{
// account used to run the transaction
MuxedAccount sourceAccount;
// the fee the sourceAccount will pay
uint32 fee;
// sequence number to consume in the account
SequenceNumber seqNum;
// validity conditions
Preconditions cond;
Memo memo;
Operation operations<MAX_OPS_PER_TX>;
union switch (int v)
{
case 0:
void;
case 1:
SorobanTransactionData sorobanData;
}
ext;
};
"""
def __init__(
self,
source_account: MuxedAccount,
fee: Uint32,
seq_num: SequenceNumber,
cond: Preconditions,
memo: Memo,
operations: List[Operation],
ext: TransactionExt,
) -> None:
_expect_max_length = MAX_OPS_PER_TX
if operations and len(operations) > _expect_max_length:
raise ValueError(
f"The maximum length of `operations` should be {_expect_max_length}, but got {len(operations)}."
)
self.source_account = source_account
self.fee = fee
self.seq_num = seq_num
self.cond = cond
self.memo = memo
self.operations = operations
self.ext = ext
def pack(self, packer: Packer) -> None:
self.source_account.pack(packer)
self.fee.pack(packer)
self.seq_num.pack(packer)
self.cond.pack(packer)
self.memo.pack(packer)
packer.pack_uint(len(self.operations))
for operations_item in self.operations:
operations_item.pack(packer)
self.ext.pack(packer)
@classmethod
def unpack(
cls, unpacker: Unpacker, depth_limit: int = DEFAULT_XDR_MAX_DEPTH
) -> Transaction:
if depth_limit <= 0:
raise ValueError("Maximum decoding depth reached")
source_account = MuxedAccount.unpack(unpacker, depth_limit - 1)
fee = Uint32.unpack(unpacker, depth_limit - 1)
seq_num = SequenceNumber.unpack(unpacker, depth_limit - 1)
cond = Preconditions.unpack(unpacker, depth_limit - 1)
memo = Memo.unpack(unpacker, depth_limit - 1)
length = unpacker.unpack_uint()
_remaining = len(unpacker.get_buffer()) - unpacker.get_position()
if _remaining < length:
raise ValueError(
f"operations length {length} exceeds remaining input length {_remaining}"
)
operations = []
for _ in range(length):
operations.append(Operation.unpack(unpacker, depth_limit - 1))
ext = TransactionExt.unpack(unpacker, depth_limit - 1)
return cls(
source_account=source_account,
fee=fee,
seq_num=seq_num,
cond=cond,
memo=memo,
operations=operations,
ext=ext,
)
def to_xdr_bytes(self) -> bytes:
packer = Packer()
self.pack(packer)
return packer.get_buffer()
@classmethod
def from_xdr_bytes(cls, xdr: bytes) -> Transaction:
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) -> Transaction:
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) -> Transaction:
return cls.from_json_dict(json.loads(json_str))
def to_json_dict(self) -> dict:
return {
"source_account": self.source_account.to_json_dict(),
"fee": self.fee.to_json_dict(),
"seq_num": self.seq_num.to_json_dict(),
"cond": self.cond.to_json_dict(),
"memo": self.memo.to_json_dict(),
"operations": [item.to_json_dict() for item in self.operations],
"ext": self.ext.to_json_dict(),
}
@classmethod
def from_json_dict(cls, json_dict: dict) -> Transaction:
source_account = MuxedAccount.from_json_dict(json_dict["source_account"])
fee = Uint32.from_json_dict(json_dict["fee"])
seq_num = SequenceNumber.from_json_dict(json_dict["seq_num"])
cond = Preconditions.from_json_dict(json_dict["cond"])
memo = Memo.from_json_dict(json_dict["memo"])
operations = [
Operation.from_json_dict(item) for item in json_dict["operations"]
]
ext = TransactionExt.from_json_dict(json_dict["ext"])
return cls(
source_account=source_account,
fee=fee,
seq_num=seq_num,
cond=cond,
memo=memo,
operations=operations,
ext=ext,
)
def __hash__(self):
return hash(
(
self.source_account,
self.fee,
self.seq_num,
self.cond,
self.memo,
self.operations,
self.ext,
)
)
def __eq__(self, other: object):
if not isinstance(other, self.__class__):
return NotImplemented
return (
self.source_account == other.source_account
and self.fee == other.fee
and self.seq_num == other.seq_num
and self.cond == other.cond
and self.memo == other.memo
and self.operations == other.operations
and self.ext == other.ext
)
def __repr__(self):
out = [
f"source_account={self.source_account}",
f"fee={self.fee}",
f"seq_num={self.seq_num}",
f"cond={self.cond}",
f"memo={self.memo}",
f"operations={self.operations}",
f"ext={self.ext}",
]
return f"<Transaction [{', '.join(out)}]>"