Skip to content

Commit e6519e3

Browse files
committed
Enhance the documentation for the fee_rate and fee_absolute methods.
Signed-off-by: Jon Marrs <jdmarrs@gmail.com>
1 parent 43fb0b2 commit e6519e3

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

crates/bdk/src/wallet/tx_builder.rs

+9-1
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,13 @@ impl<'a, D, Cs: Clone, Ctx> Clone for TxBuilder<'a, D, Cs, Ctx> {
181181
// methods supported by both contexts, for any CoinSelectionAlgorithm
182182
impl<'a, D, Cs: CoinSelectionAlgorithm, Ctx: TxBuilderContext> TxBuilder<'a, D, Cs, Ctx> {
183183
/// Set a custom fee rate
184+
/// The fee_rate method sets the mining fee paid by the transaction as a rate on its size.
185+
/// This means that the total fee paid is equal to this rate * size of the transaction in virtual Bytes (vB) or Weigth Unit (wu).
186+
/// This rate is internally expressed in satoshis-per-virtual-bytes (sats/vB) using FeeRate::from_sat_per_vb, but can also be set by:
187+
/// * sats/kvB (1000 sats/kvB == 1 sats/vB) using FeeRate::from_sat_per_kvb
188+
/// * btc/kvB (0.00001000 btc/kvB == 1 sats/vB) using FeeRate::from_btc_per_kvb
189+
/// * sats/kwu (250 sats/kwu == 1 sats/vB) using FeeRate::from_sat_per_kwu
190+
/// Default is 1 sat/vB (see min_relay_fee)
184191
pub fn fee_rate(&mut self, fee_rate: FeeRate) -> &mut Self {
185192
self.params.fee_policy = Some(FeePolicy::FeeRate(fee_rate));
186193
self
@@ -189,7 +196,8 @@ impl<'a, D, Cs: CoinSelectionAlgorithm, Ctx: TxBuilderContext> TxBuilder<'a, D,
189196
/// Set an absolute fee
190197
/// The fee_absolute method refers to the absolute transaction fee in satoshis (sats).
191198
/// If anyone sets both the fee_absolute method and the fee_rate method,
192-
/// the fee_absolute value will take precedence over the fee_rate.
199+
/// the FeePolicy enum will be set by whichever method was called last,
200+
/// as the FeeRate and FeeAmount are mutually exclusive.
193201
pub fn fee_absolute(&mut self, fee_amount: u64) -> &mut Self {
194202
self.params.fee_policy = Some(FeePolicy::FeeAmount(fee_amount));
195203
self

0 commit comments

Comments
 (0)