Skip to content

Commit 697286c

Browse files
committed
refactor(bdk): display CreateTxError::FeeRateTooLow in sat/vb
Also modify a unit test `test_bump_fee_low_fee_rate` to additionally assert the expected error message
1 parent d928fd3 commit 697286c

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

crates/bdk/src/wallet/error.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,10 @@ where
168168
CreateTxError::FeeRateTooLow { required } => {
169169
write!(
170170
f,
171-
"Fee rate too low: required {} sat/kwu",
172-
required.to_sat_per_kwu()
171+
// Note: alternate fmt as sat/vb (ceil) available in bitcoin-0.31
172+
//"Fee rate too low: required {required:#}"
173+
"Fee rate too low: required {} sat/vb",
174+
crate::floating_rate!(required)
173175
)
174176
}
175177
CreateTxError::NoUtxosSelected => {

crates/bdk/src/wallet/mod.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2560,6 +2560,17 @@ fn create_signers<E: IntoWalletDescriptor>(
25602560
Ok((signers, change_signers))
25612561
}
25622562

2563+
/// Transforms a [`FeeRate`] to `f64` with unit of sat/vb.
2564+
#[macro_export]
2565+
#[doc(hidden)]
2566+
macro_rules! floating_rate {
2567+
($rate:expr) => {{
2568+
use $crate::bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR;
2569+
// sat_kwu / 250.0 -> sat_vb
2570+
$rate.to_sat_per_kwu() as f64 / ((1000 / WITNESS_SCALE_FACTOR) as f64)
2571+
}};
2572+
}
2573+
25632574
#[macro_export]
25642575
#[doc(hidden)]
25652576
/// Macro for getting a wallet for use in a doctest

crates/bdk/tests/wallet.rs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1494,7 +1494,6 @@ fn test_bump_fee_confirmed_tx() {
14941494
}
14951495

14961496
#[test]
1497-
#[should_panic(expected = "FeeRateTooLow")]
14981497
fn test_bump_fee_low_fee_rate() {
14991498
let (mut wallet, _) = get_funded_wallet(get_test_wpkh());
15001499
let addr = wallet.get_address(New);
@@ -1503,6 +1502,7 @@ fn test_bump_fee_low_fee_rate() {
15031502
.add_recipient(addr.script_pubkey(), 25_000)
15041503
.enable_rbf();
15051504
let psbt = builder.finish().unwrap();
1505+
let feerate = psbt.fee_rate().unwrap();
15061506

15071507
let tx = psbt.extract_tx();
15081508
let txid = tx.txid();
@@ -1512,8 +1512,18 @@ fn test_bump_fee_low_fee_rate() {
15121512
.unwrap();
15131513

15141514
let mut builder = wallet.build_fee_bump(txid).unwrap();
1515-
builder.fee_rate(FeeRate::from_sat_per_vb_unchecked(1));
1516-
builder.finish().unwrap();
1515+
builder.fee_rate(FeeRate::BROADCAST_MIN);
1516+
let res = builder.finish();
1517+
assert_matches!(
1518+
res,
1519+
Err(CreateTxError::FeeRateTooLow { .. }),
1520+
"expected FeeRateTooLow error"
1521+
);
1522+
1523+
let required = feerate.to_sat_per_kwu() + 250; // +1 sat/vb
1524+
let sat_vb = required as f64 / 250.0;
1525+
let expect = format!("Fee rate too low: required {} sat/vb", sat_vb);
1526+
assert_eq!(res.unwrap_err().to_string(), expect);
15171527
}
15181528

15191529
#[test]

0 commit comments

Comments
 (0)