Skip to content

Commit 8d2c784

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 a612129 commit 8d2c784

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
@@ -2388,6 +2388,17 @@ fn create_signers<E: IntoWalletDescriptor>(
23882388
Ok((signers, change_signers))
23892389
}
23902390

2391+
/// Transforms a [`FeeRate`] to `f64` with unit of sat/vb
2392+
#[macro_export]
2393+
#[doc(hidden)]
2394+
macro_rules! floating_rate {
2395+
($rate:expr) => {{
2396+
use $crate::bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR;
2397+
// sat_kwu / 250.0 -> sat_vb
2398+
$rate.to_sat_per_kwu() as f64 / ((1000 / WITNESS_SCALE_FACTOR) as f64)
2399+
}};
2400+
}
2401+
23912402
#[macro_export]
23922403
#[doc(hidden)]
23932404
/// 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
@@ -1480,7 +1480,6 @@ fn test_bump_fee_confirmed_tx() {
14801480
}
14811481

14821482
#[test]
1483-
#[should_panic(expected = "FeeRateTooLow")]
14841483
fn test_bump_fee_low_fee_rate() {
14851484
let (mut wallet, _) = get_funded_wallet(get_test_wpkh());
14861485
let addr = wallet.get_address(New);
@@ -1489,6 +1488,7 @@ fn test_bump_fee_low_fee_rate() {
14891488
.add_recipient(addr.script_pubkey(), 25_000)
14901489
.enable_rbf();
14911490
let psbt = builder.finish().unwrap();
1491+
let feerate = psbt.fee_rate().unwrap();
14921492

14931493
let tx = psbt.extract_tx();
14941494
let txid = tx.txid();
@@ -1498,8 +1498,18 @@ fn test_bump_fee_low_fee_rate() {
14981498
.unwrap();
14991499

15001500
let mut builder = wallet.build_fee_bump(txid).unwrap();
1501-
builder.fee_rate(FeeRate::from_sat_per_vb_unchecked(1));
1502-
builder.finish().unwrap();
1501+
builder.fee_rate(FeeRate::BROADCAST_MIN);
1502+
let res = builder.finish();
1503+
assert_matches!(
1504+
res,
1505+
Err(CreateTxError::FeeRateTooLow { .. }),
1506+
"expected FeeRateTooLow error"
1507+
);
1508+
1509+
let required = feerate.to_sat_per_kwu() + 250; // +1 sat/vb
1510+
let sat_vb = required as f64 / 250.0;
1511+
let expect = format!("Fee rate too low: required {sat_vb} sat/vb");
1512+
assert_eq!(res.unwrap_err().to_string(), expect);
15031513
}
15041514

15051515
#[test]

0 commit comments

Comments
 (0)