Enum OffboardKind 

pub enum OffboardKind {
    OffboardWhole {
        input_vtxo_ids: Vec<VtxoId>,
    },
    SendOnchain {
        input_vtxo_ids: Vec<VtxoId>,
        arkoor_key_index: u32,
        change_key_index: u32,
    },
}

Which flavour of offboard this action drives.

OffboardWhole is reached from [Wallet::offboard] / Wallet::offboard_all / Wallet::offboard_vtxos: the inputs are forfeited directly to the offboard tx, fees come out of the gross amount.

SendOnchain is reached from Wallet::send_onchain: the user gives an amount and the wallet must first arkoor-split its vtxos into an exact-sized output (held by offboard_pubkey) plus change.

Variants

OffboardWhole

Forfeit the listed vtxos as-is to the offboard tx.

Fields

input_vtxo_ids: Vec<VtxoId>

SendOnchain

Run an arkoor first; offboard the resulting exact-sized vtxo.

Fields

input_vtxo_ids: Vec<VtxoId>

arkoor_key_index: u32

Holds the arkoor-output (offboard input) vtxo.

change_key_index: u32

Holds the arkoor change. Must differ from arkoor_key_index: the arkoor builder refuses a change output paying the destination.

Trait Implementations

impl Clone for OffboardKind

fn clone(&self) -> OffboardKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffboardKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OffboardKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OffboardKind

impl PartialEq for OffboardKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OffboardKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OffboardKind