Skip to content

Prefer Utxo::Local over Utxo::Foreign in OldestFirstCoinSelection #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 81 additions & 5 deletions wallet/src/wallet/coin_selection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -273,13 +273,14 @@ impl CoinSelectionAlgorithm for OldestFirstCoinSelection {
drain_script: &Script,
_: &mut R,
) -> Result<CoinSelectionResult, InsufficientFunds> {
// We put the "required UTXOs" first and make sure the optional UTXOs are sorted from
// We put the "required UTxOs" first and make sure the optional UTxOs are sorted from
// oldest to newest according to blocktime
// For utxo that doesn't exist in DB, they will have lowest priority to be selected
// For UTxOs that doesn't exist in DB (Utxo::Foreign), they will have lowest priority to be
// selected
let utxos = {
optional_utxos.sort_unstable_by_key(|wu| match &wu.utxo {
Utxo::Local(local) => Some(local.chain_position),
Utxo::Foreign { .. } => None,
Utxo::Local(local) => (false, Some(local.chain_position)),
Utxo::Foreign { .. } => (true, None),
});

required_utxos
Expand Down Expand Up @@ -726,10 +727,11 @@ fn calculate_cs_result(
mod test {
use assert_matches::assert_matches;
use bitcoin::hashes::Hash;
use bitcoin::OutPoint;
use bitcoin::{psbt, OutPoint, Sequence};
use chain::{ChainPosition, ConfirmationBlockTime};
use core::str::FromStr;
use rand::rngs::StdRng;
use std::boxed::Box;

use bitcoin::{Amount, BlockHash, ScriptBuf, TxIn, TxOut};

Expand Down Expand Up @@ -778,6 +780,30 @@ mod test {
)
}

fn foreign_utxo(value: Amount, index: u32) -> WeightedUtxo {
assert!(index < 10);
let outpoint = OutPoint::from_str(&format!(
"000000000000000000000000000000000000000000000000000000000000000{}:0",
index
))
.unwrap();
WeightedUtxo {
utxo: Utxo::Foreign {
outpoint,
sequence: Sequence(0xFFFFFFFD),
psbt_input: Box::new(psbt::Input {
witness_utxo: Some(TxOut {
value,
script_pubkey: ScriptBuf::new(),
}),
non_witness_utxo: None,
..Default::default()
}),
},
satisfaction_weight: Weight::from_wu_usize(P2WPKH_SATISFACTION_SIZE),
}
}

fn utxo(
value: Amount,
index: u32,
Expand Down Expand Up @@ -1051,6 +1077,56 @@ mod test {
assert_eq!(result.fee_amount, Amount::from_sat(204));
}

#[test]
fn test_oldest_first_coin_selection_uses_all_optional_with_foreign_utxo_locals_sorted_first() {
let utxos = get_oldest_first_test_utxos();
let mut all_utxos = vec![foreign_utxo(Amount::from_sat(120_000), 1)];
all_utxos.extend_from_slice(&utxos);
let drain_script = ScriptBuf::default();
let target_amount = Amount::from_sat(619_000) + FEE_AMOUNT;

let result = OldestFirstCoinSelection
.coin_select(
vec![],
all_utxos,
FeeRate::from_sat_per_vb_unchecked(1),
target_amount,
&drain_script,
&mut thread_rng(),
)
.unwrap();

assert_eq!(result.selected.len(), 4);
assert_eq!(result.selected_amount(), Amount::from_sat(620_000));
assert_eq!(result.fee_amount, Amount::from_sat(272));
assert!(matches!(result.selected[3], Utxo::Foreign { .. }));
}

#[test]
fn test_oldest_first_coin_selection_uses_only_all_optional_local_utxos_not_a_single_foreign() {
let utxos = get_oldest_first_test_utxos();
let mut all_utxos = vec![foreign_utxo(Amount::from_sat(120_000), 1)];
all_utxos.extend_from_slice(&utxos);
let drain_script = ScriptBuf::default();
let target_amount = Amount::from_sat(499_000) + FEE_AMOUNT;

let result = OldestFirstCoinSelection
.coin_select(
vec![],
all_utxos,
FeeRate::from_sat_per_vb_unchecked(1),
target_amount,
&drain_script,
&mut thread_rng(),
)
.unwrap();

assert_eq!(result.selected.len(), 3);
assert_eq!(result.selected_amount(), Amount::from_sat(500_000));
assert_eq!(result.fee_amount, Amount::from_sat(204));
assert!(matches!(result.selected[2], Utxo::Local(..)));
}

#[test]
fn test_oldest_first_coin_selection_use_only_necessary() {
let utxos = get_oldest_first_test_utxos();
Expand Down
Loading