Struct SignedTreeBuilder 

pub struct SignedTreeBuilder<S: BuilderState> {
    pub expiry_height: BlockHeight,
    pub server_pubkey: PublicKey,
    pub exit_delta: BlockDelta,
    pub cosign_pubkey: PublicKey,
    /* private fields */
}

A builder for a single party to construct a VTXO tree

For more information, see the module documentation.

Fields

expiry_height: BlockHeight

server_pubkey: PublicKey

exit_delta: BlockDelta

cosign_pubkey: PublicKey

The cosign pubkey used to cosign all nodes in the tree

Implementations

impl<T: BuilderState> SignedTreeBuilder<T>

pub fn total_required_value(&self) -> Amount

The total value required for the tree to be funded

pub fn funding_script_pubkey(&self) -> ScriptBuf

The scriptPubkey to send the board funds to

pub fn funding_txout(&self) -> TxOut

The TxOut to create in the funding tx

impl<T: CanSign> SignedTreeBuilder<T>

pub fn user_pub_nonces(&self) -> &[PublicNonce]

Get the user’s public nonces

impl SignedTreeBuilder<Preparing>

pub fn construct_tree_spec( vtxos: impl IntoIterator<Item = VtxoRequest>, cosign_pubkey: PublicKey, expiry_height: BlockHeight, server_pubkey: PublicKey, server_cosign_pubkey: PublicKey, exit_delta: BlockDelta, ) -> VtxoTreeSpec

Construct the spec to be used in SignedTreeBuilder

pub fn new( vtxos: impl IntoIterator<Item = VtxoRequest>, cosign_pubkey: PublicKey, expiry_height: BlockHeight, server_pubkey: PublicKey, server_cosign_pubkey: PublicKey, exit_delta: BlockDelta, ) -> SignedTreeBuilder<Preparing>

Create a new SignedTreeBuilder

pub fn set_utxo(self, utxo: OutPoint) -> SignedTreeBuilder<CanGenerateNonces>

Set the utxo from which the tree will be created

impl SignedTreeBuilder<CanGenerateNonces>

pub fn generate_user_nonces( self, cosign_key: &Keypair, ) -> SignedTreeBuilder<CanFinish>

Generate user nonces

impl SignedTreeBuilder<ServerCanCosign>

pub fn new_for_cosign( vtxos: impl IntoIterator<Item = VtxoRequest>, cosign_pubkey: PublicKey, expiry_height: BlockHeight, server_pubkey: PublicKey, server_cosign_pubkey: PublicKey, exit_delta: BlockDelta, utxo: OutPoint, user_pub_nonces: Vec<PublicNonce>, ) -> SignedTreeBuilder<ServerCanCosign>

Create a new SignedTreeBuilder for the server to cosign

pub fn server_cosign( &self, server_cosign_key: &Keypair, ) -> SignedTreeCosignResponse

The server cosigns the tree nodes

impl SignedTreeBuilder<CanFinish>

pub fn verify_cosign_response( &self, server_cosign: &SignedTreeCosignResponse, ) -> Result<(), CosignSignatureError>

Validate the server’s partial signatures

pub fn build_tree( self, server_cosign: &SignedTreeCosignResponse, cosign_key: &Keypair, ) -> Result<SignedVtxoTreeSpec, IncorrectSigningKeyError>