Struct ArkoorPackageBuilder

pub struct ArkoorPackageBuilder<'a, T: Clone> {
    pub arkoors: Vec<ArkoorBuilder<'a, T>>,
    /* private fields */
}

This type helps both the client and server with building multiple arkoor transactions in a synchronized way. It’s purely a functional type, initialized with the parameters that will make up the arkoor package: the input vtxos to be spent and the desired payment request with optional change.

The flow works as follows:

• sender uses the constructor to check the payment request for validity
• server uses the constructor to check the payment request for validity
• server uses ArkoorPackageBuilder::server_cosign to construct a vector of ArkoorCosignResponse to send back to the sender
• sender passes the responses into ArkoorPackageBuilder::build_vtxos to construct the signed resulting VTXOs and optional change VTXO

The package can handle multiple input VTXOs to fulfill a single payment request, automatically creating change outputs when necessary.

Fields

arkoors: Vec<ArkoorBuilder<'a, T>>

Each transition from one input VTXO to one or two output VTXOs

Implementations

impl<'a> ArkoorPackageBuilder<'a, VtxoRequest>

pub fn new( inputs: impl IntoIterator<Item = &'a Vtxo>, user_nonces: &'a [PublicNonce], vtxo_request: VtxoRequest, change_pubkey: Option<PublicKey>, ) -> Result<Self, ArkoorPackageError>

pub fn new_htlc_revocation( htlc_vtxos: &'a [Vtxo], user_nonces: &'a [PublicNonce], ) -> Result<Self, ArkoorPackageError>

pub fn from_arkoors( arkoors: Vec<ArkoorBuilder<'a, VtxoRequest>>, ) -> Result<Self, ArkoorPackageError>

pub fn inputs(&self) -> Vec<&'a Vtxo>

pub fn spending_tx(&self, input_id: VtxoId) -> Option<&Transaction>

pub fn build_vtxos<'b>( self, sigs: impl IntoIterator<Item = &'a ArkoorCosignResponse>, keypairs: impl IntoIterator<Item = &'a Keypair>, sec_nonces: impl IntoIterator<Item = SecretNonce>, ) -> Result<(Vec<Vtxo>, Option<Vtxo>), ArkoorPackageError>

pub fn new_vtxos(&self) -> Vec<Vec<Vtxo>>

pub fn server_cosign(&self, keypair: &Keypair) -> Vec<ArkoorCosignResponse>

Used by the Ark server to cosign the arkoor request.

pub fn verify_cosign_response<T: Borrow<ArkoorCosignResponse>>( &self, server_cosign: &[T], ) -> bool