Skip to content

Preserve insertion order of manually selected utxos if TxOrdering::Untouched #262

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.

Sign up for GitHub

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 2 commits into
base: master
Choose a base branch
from
Open

Preserve insertion order of manually selected utxos if TxOrdering::Untouched #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2424ddc
fix(tx_builder): preserve insertion order with TxOrdering::Untouched
nymius Jun 10, 2025
dde0b3e
doc(tx_builder): add info about manually selected UTxOs priority
nymius Jun 9, 2025
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
93 changes: 42 additions & 51 deletions wallet/src/wallet/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1511,7 +1511,7 @@ impl Wallet {

let (required_utxos, optional_utxos) = {
// NOTE: manual selection overrides unspendable
let mut required: Vec<WeightedUtxo> = params.utxos.values().cloned().collect();
let mut required: Vec<WeightedUtxo> = params.utxos.clone();
let optional = self.filter_utxos(&params, current_height.to_consensus_u32());

// if drain_wallet is true, all UTxOs are required
Expand Down Expand Up @@ -1740,52 +1740,45 @@ impl Wallet {
})
.map(|(prev_tx, prev_txout, chain_position)| {
match txout_index.index_of_spk(prev_txout.script_pubkey.clone()) {
Some(&(keychain, derivation_index)) => (
txin.previous_output,
WeightedUtxo {
satisfaction_weight: self
.public_descriptor(keychain)
.max_weight_to_satisfy()
.unwrap(),
utxo: Utxo::Local(LocalOutput {
outpoint: txin.previous_output,
txout: prev_txout.clone(),
keychain,
is_spent: true,
derivation_index,
chain_position,
}),
},
),
Some(&(keychain, derivation_index)) => WeightedUtxo {
satisfaction_weight: self
.public_descriptor(keychain)
.max_weight_to_satisfy()
.unwrap(),
utxo: Utxo::Local(LocalOutput {
outpoint: txin.previous_output,
txout: prev_txout.clone(),
keychain,
is_spent: true,
derivation_index,
chain_position,
}),
},
None => {
let satisfaction_weight = Weight::from_wu_usize(
serialize(&txin.script_sig).len() * 4
+ serialize(&txin.witness).len(),
);

(
txin.previous_output,
WeightedUtxo {
utxo: Utxo::Foreign {
outpoint: txin.previous_output,
sequence: txin.sequence,
psbt_input: Box::new(psbt::Input {
witness_utxo: prev_txout
.script_pubkey
.witness_version()
.map(|_| prev_txout.clone()),
non_witness_utxo: Some(prev_tx.as_ref().clone()),
..Default::default()
}),
},
satisfaction_weight,
WeightedUtxo {
utxo: Utxo::Foreign {
outpoint: txin.previous_output,
sequence: txin.sequence,
psbt_input: Box::new(psbt::Input {
witness_utxo: prev_txout
.script_pubkey
.witness_version()
.map(|_| prev_txout.clone()),
non_witness_utxo: Some(prev_tx.as_ref().clone()),
..Default::default()
}),
},
)
satisfaction_weight,
}
}
}
})
})
.collect::<Result<HashMap<OutPoint, WeightedUtxo>, BuildFeeBumpError>>()?;
.collect::<Result<Vec<WeightedUtxo>, BuildFeeBumpError>>()?;

if tx.output.len() > 1 {
let mut change_index = None;
Expand Down Expand Up @@ -2099,6 +2092,11 @@ impl Wallet {
vec![]
// only process optional UTxOs if manually_selected_only is false
} else {
let manually_selected_outpoints = params
.utxos
.iter()
.map(|wutxo| wutxo.utxo.outpoint())
.collect::<HashSet<OutPoint>>();
self.indexed_graph
.graph()
// get all unspent UTxOs from wallet
Expand All @@ -2117,8 +2115,9 @@ impl Wallet {
.then(|| new_local_utxo(k, i, full_txo))
})
// only process UTxOs not selected manually, they will be considered later in the
// chain NOTE: this avoid UTxOs in both required and optional list
.filter(|may_spend| !params.utxos.contains_key(&may_spend.outpoint))
// chain
// NOTE: this avoid UTxOs in both required and optional list
.filter(|may_spend| !manually_selected_outpoints.contains(&may_spend.outpoint))
// only add to optional UTxOs those which satisfy the change policy if we reuse
// change
.filter(|local_output| {
Expand Down Expand Up @@ -2745,18 +2744,10 @@ mod test {
let txid = two_output_tx.compute_txid();
insert_tx(&mut wallet, two_output_tx);

let mut params = TxParams::default();
let output = wallet.get_utxo(OutPoint { txid, vout: 0 }).unwrap();
params.utxos.insert(
output.outpoint,
WeightedUtxo {
satisfaction_weight: wallet
.public_descriptor(output.keychain)
.max_weight_to_satisfy()
.unwrap(),
utxo: Utxo::Local(output),
},
);
let outpoint = OutPoint { txid, vout: 0 };
let mut builder = wallet.build_tx();
builder.add_utxo(outpoint).expect("should add local utxo");
let params = builder.params.clone();
// enforce selection of first output in transaction
let received = wallet.filter_utxos(&params, wallet.latest_checkpoint().block_id().height);
// notice expected doesn't include the first output from two_output_tx as it should be
Expand Down
Loading
Loading