Struct VtxoTreeSpec

pub struct VtxoTreeSpec {
    pub vtxos: Vec<SignedVtxoRequest>,
    pub expiry_height: BlockHeight,
    pub server_pubkey: PublicKey,
    pub exit_delta: BlockDelta,
    pub global_cosign_pubkeys: Vec<PublicKey>,
}

All the information that uniquely specifies a VTXO tree before it has been signed.

Fields

vtxos: Vec<SignedVtxoRequest>

expiry_height: BlockHeight

server_pubkey: PublicKey

exit_delta: BlockDelta

global_cosign_pubkeys: Vec<PublicKey>

Implementations

impl VtxoTreeSpec

pub fn new( vtxos: Vec<SignedVtxoRequest>, server_pubkey: PublicKey, expiry_height: BlockHeight, exit_delta: BlockDelta, global_cosign_pubkeys: Vec<PublicKey>, ) -> VtxoTreeSpec

pub fn nb_leaves(&self) -> usize

pub fn nb_nodes(&self) -> usize

pub fn iter_vtxos(&self) -> impl Iterator<Item = &SignedVtxoRequest>

pub fn leaf_idx_of(&self, vtxo_request: &SignedVtxoRequest) -> Option<usize>

Get the leaf index of the given vtxo request.

pub fn total_required_value(&self) -> Amount

Calculate the total value needed in the tree.

This accounts for

• all vtxos getting their value

pub fn cosign_taproot(&self, agg_pk: XOnlyPublicKey) -> TaprootSpendInfo

Calculate the cosign taproot at a given node.

pub fn funding_tx_cosign_pubkey(&self) -> XOnlyPublicKey

The cosign pubkey used on the vtxo output of the tx funding the tree

In Ark rounds this will be the round tx scriptPubkey.

pub fn funding_tx_script_pubkey(&self) -> ScriptBuf

The scriptPubkey used on the vtxo output of the tx funding the tree

In Ark rounds this will be the round tx scriptPubkey.

pub fn funding_tx_txout(&self) -> TxOut

The output of the tx funding the tree

In Ark rounds this will be the round tx scriptPubkey.

pub fn cosign_agg_pks( &self, ) -> impl Iterator<Item = XOnlyPublicKey> + DoubleEndedIterator + ExactSizeIterator + '_

Calculate all the aggregate cosign pubkeys by aggregating the leaf and server pubkeys.

Pubkeys expected and returned ordered from leaves to root.

pub fn unsigned_transactions(&self, utxo: OutPoint) -> Vec<Transaction>

Return unsigned transactions for all nodes from leaves to root.

pub fn signed_transactions( &self, utxo: OutPoint, signatures: &[Signature], ) -> Vec<Transaction>

Return all signed transactions for all nodes from leaves to root.

pub fn calculate_cosign_agg_nonces( &self, leaf_cosign_nonces: &HashMap<PublicKey, Vec<PublicNonce>>, global_signer_cosign_nonces: &[impl AsRef<[PublicNonce]>], ) -> Result<Vec<AggregatedNonce>, String>

Calculate all the aggregate cosign nonces by aggregating the leaf and server nonces.

Nonces expected and returned ordered from leaves to root.

pub fn into_unsigned_tree(self, utxo: OutPoint) -> UnsignedVtxoTree

Convert this spec into an unsigned tree by providing the root outpoint and the nodes’ aggregate nonces.

Nonces expected ordered from leaves to root.

Trait Implementations

impl Clone for VtxoTreeSpec

fn clone(&self) -> VtxoTreeSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VtxoTreeSpec

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

Formats the value using the given formatter.

impl PartialEq for VtxoTreeSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ProtocolEncoding for VtxoTreeSpec

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 Eq for VtxoTreeSpec

impl StructuralPartialEq for VtxoTreeSpec