ark-core 0.9.0

Core types and utilities for Ark
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use crate::asset::AssetId;
use crate::server::Asset;
use crate::Error;
use bitcoin::Amount;
use bitcoin::OutPoint;
use bitcoin::ScriptBuf;

#[derive(Clone, Debug)]
pub struct VirtualTxOutPoint {
    pub outpoint: OutPoint,
    pub script_pubkey: ScriptBuf,
    pub expire_at: i64,
    pub amount: Amount,
    pub assets: Vec<Asset>,
}

/// Select VTXOs to be used as inputs in Ark transactions.
pub fn select_vtxos(
    mut virtual_tx_outpoints: Vec<VirtualTxOutPoint>,
    amount: Amount,
    dust: Amount,
    sort_by_expiration_time: bool,
) -> Result<Vec<VirtualTxOutPoint>, Error> {
    let mut selected = Vec::new();
    let mut not_selected = Vec::new();
    let mut selected_amount = Amount::ZERO;

    if sort_by_expiration_time {
        // Sort vtxos by expiration (older first)
        virtual_tx_outpoints.sort_by_key(|a| a.expire_at);
    }

    // Process VTXOs
    for virtual_tx_outpoint in virtual_tx_outpoints {
        if selected_amount >= amount {
            not_selected.push(virtual_tx_outpoint);
        } else {
            selected.push(virtual_tx_outpoint.clone());
            selected_amount += virtual_tx_outpoint.amount;
        }
    }

    if selected_amount < amount {
        return Err(Error::coin_select(format!(
            "insufficient funds: selected = {selected_amount}, needed = {amount}"
        )));
    }

    // Try to avoid generating dust.
    let change_amount = selected_amount - amount;
    if let Some(vtxo) = not_selected.first() {
        if change_amount < dust {
            selected.push(vtxo.clone());
        }
    }

    Ok(selected)
}

/// Select VTXOs that hold a specific asset, accumulating until `amount` is reached.
///
/// Returns the selected VTXOs and the asset change amount.
pub fn select_vtxos_for_asset(
    virtual_tx_outpoints: &[VirtualTxOutPoint],
    amount: u64,
    asset_id: AssetId,
) -> Result<(Vec<VirtualTxOutPoint>, u64), Error> {
    // Filter to only VTXOs containing this asset.
    let mut candidates: Vec<VirtualTxOutPoint> = virtual_tx_outpoints
        .iter()
        .filter(|v| v.assets.iter().any(|a| a.asset_id == asset_id))
        .cloned()
        .collect();

    // Sort by expiration (older first).
    candidates.sort_by_key(|a| a.expire_at);

    let mut selected = Vec::new();
    let mut selected_amount: u64 = 0;

    for vtxo in candidates {
        if selected_amount >= amount {
            break;
        }

        if let Some(asset) = vtxo
            .assets
            .iter()
            .find(|a| a.asset_id == asset_id && a.amount != 0)
        {
            selected_amount += asset.amount;
            selected.push(vtxo);
        }
    }

    let change = match selected_amount.checked_sub(amount) {
        Some(change) => change,
        None => {
            return Err(Error::coin_select(format!(
            "insufficient asset funds for {asset_id}: selected = {selected_amount}, needed = {amount}"
        )));
        }
    };

    Ok((selected, change))
}

// Tests for the coin selection function
#[cfg(test)]
mod tests {
    use super::*;

    fn vtxo(expire_at: i64, amount: Amount) -> VirtualTxOutPoint {
        VirtualTxOutPoint {
            outpoint: OutPoint::default(),
            script_pubkey: ScriptBuf::new(),
            expire_at,
            amount,
            assets: Vec::new(),
        }
    }

    #[test]
    fn test_basic_coin_selection() {
        let vtxos = vec![vtxo(123456789, Amount::from_sat(3000))];

        let result = select_vtxos(vtxos, Amount::from_sat(2500), Amount::from_sat(100), true);
        assert!(result.is_ok());

        let selected = result.unwrap();
        assert_eq!(selected.len(), 1);
    }

    #[test]
    fn test_insufficient_funds() {
        let vtxos = vec![vtxo(123456789, Amount::from_sat(100))];

        let result = select_vtxos(vtxos, Amount::from_sat(1000), Amount::from_sat(50), true);
        assert!(result.is_err());
    }
}