Struct UnsignedVtxoTree

pub struct UnsignedVtxoTree {
    pub spec: VtxoTreeSpec,
    pub utxo: OutPoint,
    pub cosign_agg_pks: Vec<XOnlyPublicKey>,
    pub txs: Vec<Transaction>,
    pub internal_sighashes: Vec<TapSighash>,
    /* private fields */
}

A VTXO tree ready to be signed.

This type contains various cached values required to sign the tree.

Fields

spec: VtxoTreeSpec

utxo: OutPoint

cosign_agg_pks: Vec<XOnlyPublicKey>

Aggregate pubkeys for the inputs to all nodes, leaves to root.

txs: Vec<Transaction>

Transactions for all nodes, leaves to root.

internal_sighashes: Vec<TapSighash>

Sighashes for the only input of the tx for all internal nodes, leaves to root.

Implementations

impl UnsignedVtxoTree

pub fn new(spec: VtxoTreeSpec, utxo: OutPoint) -> UnsignedVtxoTree

pub fn nb_leaves(&self) -> usize

pub fn nb_cosigned_leaves(&self) -> usize

The number of leaves that have a cosign pubkey

pub fn nb_nodes(&self) -> usize

pub fn nb_internal_nodes(&self) -> usize

pub fn cosign_branch( &self, cosign_agg_nonces: &[AggregatedNonce], leaf_idx: usize, cosign_key: &Keypair, cosign_sec_nonces: Vec<SecretNonce>, ) -> Result<Vec<PartialSignature>, IncorrectSigningKeyError>

Generate partial musig signatures for the nodes in the tree branch of the given vtxo request.

Note that the signatures are indexed by their place in the tree and thus do not necessarily match up with the indices in the secret nonces vector.

Aggregate nonces expected for all nodes, ordered from leaves to root. Secret nonces expected for branch, ordered from leaf to root.

Returns None if the vtxo request is not part of the tree. Returned signatures over the branch from leaf to root.

pub fn cosign_tree( &self, cosign_agg_nonces: &[AggregatedNonce], keypair: &Keypair, cosign_sec_nonces: Vec<SecretNonce>, ) -> Vec<PartialSignature>

Generate partial musig signatures for all internal nodes in the tree.

Nonces expected for all internal nodes, ordered from leaves to root.

Returns None if the vtxo request is not part of the tree.

pub fn verify_branch_cosign_partial_sigs( &self, cosign_agg_nonces: &[AggregatedNonce], request: &VtxoLeafSpec, cosign_pub_nonces: &[PublicNonce], cosign_part_sigs: &[PartialSignature], ) -> Result<(), String>

Verify the partial cosign signatures from one of the leaves.

Nonces and partial signatures expected for all internal nodes, ordered from leaves to root.

pub fn verify_global_cosign_partial_sigs( &self, pk: PublicKey, agg_nonces: &[AggregatedNonce], pub_nonces: &[PublicNonce], part_sigs: &[PartialSignature], ) -> Result<(), CosignSignatureError>

Verify the partial cosign signatures for all nodes.

Nonces and partial signatures expected for all internal nodes, ordered from leaves to root.

pub fn combine_partial_signatures( &self, cosign_agg_nonces: &[AggregatedNonce], branch_part_sigs: &HashMap<PublicKey, Vec<PartialSignature>>, global_signer_part_sigs: &[impl AsRef<[PartialSignature]>], ) -> Result<Vec<Signature>, CosignSignatureError>

Combine all partial cosign signatures.

Nonces expected for all internal nodes, ordered from leaves to root.

Branch signatures expected for internal nodes in branch ordered from leaf to root.

Server signatures expected for all internal nodes ordered from leaves to root, in the same order as global_cosign_pubkeys.

pub fn verify_cosign_sigs( &self, signatures: &[Signature], ) -> Result<(), XOnlyPublicKey>

Verify the signatures of all the internal node txs.

Signatures expected for all internal nodes, ordered from leaves to root.

pub fn into_signed_tree(self, signatures: Vec<Signature>) -> SignedVtxoTreeSpec

Convert into a SignedVtxoTreeSpec by providing the signatures.

Signatures expected for all internal nodes, ordered from leaves to root.

Trait Implementations

impl Clone for UnsignedVtxoTree

fn clone(&self) -> UnsignedVtxoTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnsignedVtxoTree

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

Formats the value using the given formatter.