Struct sapio::template::Template

pub struct Template {
    pub ctv: Hash,
    pub ctv_index: u32,
    pub max: Amount,
    pub min_feerate_sats_vbyte: Option<Amount>,
    pub metadata_map_s2s: TemplateMetadata,
    pub tx: Transaction,
    pub outputs: Vec<Output>,
}

Template holds the data needed to construct a Transaction for CTV Purposes, along with relevant metadata

Fields

ctv: Hash

the precomputed template hash for this Template

ctv_index: u32

the index used for the template hash. (TODO: currently always 0, although future version may support other indexes)

max: Amount

the amount being sent to this Template (TODO: currently computed via tx.total_amount())

min_feerate_sats_vbyte: Option<Amount>

the amount being sent to this Template (TODO: currently computed via tx.total_amount())

metadata_map_s2s: TemplateMetadata

any metadata fields attached to this template

tx: Transaction

The actual transaction this template will create

outputs: Vec<Output>

sapio specific information about all the outputs in the tx.

Implementations

impl Template

pub fn hash(&self) -> Hash

Get the cached template hash of this Template

pub fn total_amount(&self) -> Amount

recompute the total amount spent in this template. This is the total amount required to be sent to this template for this transaction to succeed.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Template

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Builder> for Template

fn from(t: Builder) -> Template

Performs the conversion.

impl JsonSchema for Template

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Template

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.