Struct SignedVtxoTreeSpec 

pub struct SignedVtxoTreeSpec {
    pub spec: VtxoTreeSpec,
    pub utxo: OutPoint,
    pub cosign_sigs: Vec<Signature>,
}

All the information needed to uniquely specify a fully signed VTXO tree.

Fields

spec: VtxoTreeSpec

utxo: OutPoint

cosign_sigs: Vec<Signature>

The signatures for the internal txs, from leaves to root.

Implementations

impl SignedVtxoTreeSpec

pub fn new( spec: VtxoTreeSpec, utxo: OutPoint, cosign_signatures: Vec<Signature>, ) -> SignedVtxoTreeSpec

Signatures expected for internal nodes ordered from leaves to root.

pub fn nb_leaves(&self) -> usize

pub fn exit_branch(&self, leaf_idx: usize) -> Vec<Transaction>

Construct the exit branch starting from the root ending in the leaf.

Panics if leaf_idx is out of range.

This call is quite inefficient and if you want to make repeated calls, it is advised to use CachedSignedVtxoTree::exit_branch instead.

pub fn all_final_txs(&self) -> Vec<Transaction>

Get all final txs in this tree, starting with the leaves, towards the root

pub fn into_cached_tree(self) -> CachedSignedVtxoTree

pub fn detect_hashlock_version( &self, ) -> Result<HashlockVersion, HashlockVersionDetectError>

Detect the hashlock version this tree was signed with.

We forgot to properly encode this, so it detects it by looking at the first signature and seeing which version it is valid for.

Falls back to v1 for empty trees, they shouldn’t exist.

pub fn with_detected_hashlock_version( self, ) -> Result<Self, HashlockVersionDetectError>

Return this tree with its hashlock version detected from the cosign signatures.

Use this before rebuilding transactions or VTXOs from a stored tree that may predate the v1 hashlock clauses; see Self::detect_hashlock_version.

Trait Implementations

impl Clone for SignedVtxoTreeSpec

fn clone(&self) -> SignedVtxoTreeSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignedVtxoTreeSpec

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

Formats the value using the given formatter.

impl PartialEq for SignedVtxoTreeSpec

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

Equality operator ==.

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

Inequality operator !=.

impl ProtocolEncoding for SignedVtxoTreeSpec

fn encode<W: Write + ?Sized>(&self, w: &mut W) -> Result<(), Error>

Encode the object into the writer.

fn decode<R: Read + ?Sized>(r: &mut R) -> Result<Self, ProtocolDecodingError>

Decode the object from the writer.

fn serialize(&self) -> Vec<u8>

Serialize the object into a byte vector.

fn deserialize(byte_slice: &[u8]) -> Result<Self, ProtocolDecodingError>

Deserialize object from the given byte slice.

fn serialize_hex(&self) -> String

Serialize the object to a lowercase hex string.

fn deserialize_hex(hex_str: &str) -> Result<Self, ProtocolDecodingError>

Deserialize object from hex slice.

impl StructuralPartialEq for SignedVtxoTreeSpec