Struct BoardBuilder 

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

A request for the server to cosign an board vtxo.

An object of this type is created by the user, sent to the server who will cosign the request and return his partial signature (along with public nonce) back to the user so that the user can finish the request and create a Vtxo.

Currently you can only create VTXOs with VtxoPolicy::Pubkey.

Fields

user_pubkey: PublicKey

expiry_height: BlockHeight

server_pubkey: PublicKey

exit_delta: BlockDelta

Implementations

impl<S: BuilderState> BoardBuilder<S>

pub fn funding_script_pubkey(&self) -> ScriptBuf

The scriptPubkey to send the board funds to.

impl BoardBuilder<Preparing>

pub fn new( user_pubkey: PublicKey, expiry_height: BlockHeight, server_pubkey: PublicKey, exit_delta: BlockDelta, ) -> BoardBuilder<Preparing>

Create a new builder to construct a board vtxo.

See module-level documentation for an overview of the board flow.

pub fn set_funding_details( self, amount: Amount, utxo: OutPoint, ) -> BoardBuilder<CanGenerateNonces>

Set the UTXO where the board will be funded and the board amount.

impl BoardBuilder<CanGenerateNonces>

pub fn generate_user_nonces(self) -> BoardBuilder<CanFinish>

Generate user nonces.

impl<S: CanSign> BoardBuilder<S>

pub fn user_pub_nonce(&self) -> &PublicNonce

impl BoardBuilder<ServerCanCosign>

pub fn new_for_cosign( user_pubkey: PublicKey, expiry_height: BlockHeight, server_pubkey: PublicKey, exit_delta: BlockDelta, amount: Amount, utxo: OutPoint, user_pub_nonce: PublicNonce, ) -> BoardBuilder<ServerCanCosign>

This constructor is to be used by the server with the information provided by the user.

pub fn server_cosign(&self, key: &Keypair) -> BoardCosignResponse

This method is used by the server to cosign the board request.

Returns None if utxo or user_pub_nonce field is not provided.

impl BoardBuilder<CanFinish>

pub fn verify_cosign_response( &self, server_cosign: &BoardCosignResponse, ) -> bool

Validate the server’s partial signature.

pub fn build_vtxo( self, server_cosign: &BoardCosignResponse, user_key: &Keypair, ) -> Result<Vtxo, IncorrectSigningKeyError>

Finishes the board request and create a vtxo.

Trait Implementations

impl<S: Debug + BuilderState> Debug for BoardBuilder<S>

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

Formats the value using the given formatter.