Struct themelio_structs::TransactionBuilder

pub struct TransactionBuilder { /* private fields */ }

A helper struct for creating transactions.

Implementations

impl TransactionBuilder

pub fn new() -> Self

Creates a new TransactionBuilder.

pub fn kind(self, kind: TxKind) -> Self

Sets the kind.

pub fn input(self, coin_id: CoinID, coin_data: CoinData) -> Self

Adds an input. A CoinData must be provided.

pub fn output(self, data: CoinData) -> Self

Adds an output.

pub fn covenant(self, script: Vec<u8>) -> Self

Adds a covenant script.

pub fn fee(self, fee: CoinValue) -> Self

Adds a fee.

pub fn auto_base_fee(
    self,
    fee_multiplier: u128,
    max_sig_count: usize,
    max_sig_size: usize,
    cov_to_weight: impl Fn(&[u8]) -> u128
) -> Self

“Automatically” adds the base fee. An upper-bound for the number of signatures and the size of each signature is required.

pub fn change(self, denom: Denom, change_addr: Address) -> Self

Balance the transaction on the given denomination. Sends any excess to a change output.

pub fn build(self) -> Result<Transaction, TransactionBuildError>

Attempts to generate the transaction.

pub fn data(self, data: Vec<u8>) -> Self

Sets the associated data.

Trait Implementations

impl Debug for TransactionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransactionBuilder

fn default() -> Self

Returns the “default value” for a type.