Struct themelio_structs::Transaction

pub struct Transaction {
    pub kind: TxKind,
    pub inputs: Vec<CoinID>,
    pub outputs: Vec<CoinData>,
    pub fee: CoinValue,
    pub covenants: Vec<Vec<u8>>,
    pub data: Vec<u8>,
    pub sigs: Vec<Vec<u8>>,
}

Transaction represents an individual, serializable Themelio transaction.

Fields

kind: TxKind

inputs: Vec<CoinID>

outputs: Vec<CoinData>

fee: CoinValue

covenants: Vec<Vec<u8>>

data: Vec<u8>

sigs: Vec<Vec<u8>>

Implementations

impl Transaction

pub fn empty_test() -> Self

An empty transaction with kind Normal, no inputs, no fees, etc.

pub fn new(kind: TxKind) -> Self

Creates a new transaction with the given kind, no inputs, no outputs, no nothing.

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

Replaces the kind of the transaction

pub fn with_inputs(self, inputs: Vec<CoinID>) -> Self

Replaces the inputs of the transaction

pub fn add_input(self, input: CoinID) -> Self

Add an input

pub fn with_outputs(self, outputs: Vec<CoinData>) -> Self

Replaces the outputs of the transaction

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

Add an output

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

Replaces the fee of the transaction

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

Replaces the scripts of the transaction

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

Add a script to the transaction

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

Replaces the scripts of the transaction

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

Replaces the scripts of the transaction

pub fn is_well_formed(&self) -> bool

Checks whether or not the transaction is well formed, respecting coin size bounds and such. Does not fully validate the transaction.

pub fn hash_nosigs(&self) -> TxHash

hash_nosigs returns the hash of the transaction with a zeroed-out signature field. This is what signatures are computed against.

pub fn signed_ed25519(self, sk: Ed25519SK) -> Self

sign_ed25519 consumes the transaction, appends an ed25519 signature, and returns it.

pub fn total_outputs(&self) -> HashMap<Denom, CoinValue>

total_outputs returns a HashMap mapping each type of coin to its total value. Fees will be included in the Mel cointype.

pub fn covenants_as_map(&self) -> HashMap<Address, Vec<u8>>

scripts_as_map returns a HashMap mapping the hash of each script in the transaction to the script itself.

pub fn base_fee(
    &self,
    fee_multiplier: u128,
    ballast: u128,
    cov_to_weight: impl Fn(&[u8]) -> u128
) -> CoinValue

Returns the minimum fee of the transaction at a given fee multiplier, with a given “ballast”.

pub fn weight(&self, cov_to_weight: impl Fn(&[u8]) -> u128) -> u128

Returns the weight of the transaction, given a function that maps a covenant to its weight.

pub fn output_coinid(&self, index: u8) -> CoinID

Convenience function that constructs a CoinID that points to a certain output of this transaction. Panics if the index is out of bounds.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Transaction

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transaction

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

Deserialize this value from the given Serde deserializer.

impl Hash for Transaction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Transaction> for Transaction

fn eq(&self, other: &Transaction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Transaction

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

Serialize this value into the given Serde serializer.

impl Eq for Transaction

impl StructuralEq for Transaction

impl StructuralPartialEq for Transaction