Skip to content

GeneratorSummary (Class)

A class containing a summary produced by transaction Generator.

This class contains the number of transactions, the aggregated fees, the aggregated UTXOs and the final transaction amount that includes both network and QoS (priority) fees.

See Also

create_transactions, Generator

fees property

fees: int

The total fees across all generated transactions in sompi.

RETURNS DESCRIPTION
int

The aggregate fee amount.

TYPE: int

final_amount property

final_amount: Optional[int]

The final transaction amount in sompi.

RETURNS DESCRIPTION
Optional[int]

int | None: The final amount, or None if not applicable.

final_transaction_id property

final_transaction_id: Optional[str]

The ID of the final transaction.

RETURNS DESCRIPTION
Optional[str]

str | None: The transaction ID, or None if not yet generated.

network_type property

network_type: str

The network type used for generation.

RETURNS DESCRIPTION
str

The network type string.

TYPE: str

transactions property

transactions: int

The number of transactions generated.

RETURNS DESCRIPTION
int

The transaction count.

TYPE: int

utxos property

utxos: int

The total number of UTXOs consumed.

RETURNS DESCRIPTION
int

The UTXO count.

TYPE: int

__eq__

__eq__(other: GeneratorSummary) -> bool