Struct sapio::template::builder::Builder

pub struct Builder { /* fields omitted */ }

Builder can be used to interactively put together a transaction template before finalizing into a Template.

Implementations

impl Builder

pub fn new(ctx: Context) -> Builder

Creates a new transaction template with 1 input and no outputs.

pub fn ctx(&self) -> &Context

get a read-only reference to the builder’s context

pub fn spend_amount(self, amount: Amount) -> Result<Self, CompilationError>

reduce the amount availble in the builder’s context

pub fn add_fees(self, amount: Amount) -> Result<Self, CompilationError>

reduce the amount availble in the builder’s context, and add to the fees

pub fn add_output(
    self,
    amount: Amount,
    contract: &dyn Compilable,
    metadata: Option<OutputMeta>
) -> Result<Self, CompilationError>

Creates a new Output, forcing the compilation of the compilable object and defaulting metadata if not provided to blank.

pub fn add_amount(self, a: Amount) -> Self

adds available funds to the builder’s context object. TODO: Make guarantee there is some external input?

pub fn add_sequence(self) -> Self

Adds another output. Follow with a call to set_sequence(-1, …) to fill in the back.

pub fn set_sequence(
    self,
    ii: isize,
    s: AnyRelTimeLock
) -> Result<Self, CompilationError>

set_sequence adds a height or time based relative lock time to the template. If a lock time is already set, it will check if it is of the same kind. Differing kinds will throw an error. Otherwise, it will merge by taking the max of the argument.

Negative indexing allows us to work from the back element easily

pub fn set_lock_time(
    self,
    lt_in: AnyAbsTimeLock
) -> Result<Self, CompilationError>

set_lock_time adds a height or time based absolute lock time to the template. If a lock time is already set, it will check if it is of the same kind. Differing kinds will throw an error. Otherwise, it will merge by taking the max of the argument.

pub fn set_label(self, label: String) -> Self

overwrite any existing label with the provided string, or set a label if none provided thus far.

pub fn set_color(self, color: String) -> Self

overwrite any existing color with the provided string, or set a color if none provided thus far.

pub fn get_tx(&self) -> Transaction

Creates a transaction from a Builder. Generally, should not be called directly.

pub fn set_min_feerate(self, a: Amount) -> Self

Sets the feerate if not set, and then sets the value to the min of the existing value or the new value. For example, s.set_min_feerate(100.into()).set_min_feerate(1000.into()) results in feerate Some(100).

During compilation, templates should be checked to ensure that at least that feerate is paid.

pub fn estimate_tx_size(&self) -> u64

more efficient that get_tx() to estimate a tx size, not including witness

Trait Implementations

impl From<Builder> for Template

fn from(t: Builder) -> Template

Performs the conversion.

impl From<Builder> for TxTmplIt

fn from(t: Builder) -> Self

Performs the conversion.