milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Revise doc comment 

Comment that the ceiling is computed instead of the floor.
This commit is contained in:
yancy 2024-09-17 00:02:02 -05:00
parent 7360c3ce9a
commit 8c29fe08f8
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
units/src/fee_rate.rs
View File

@ -86,6 +86,9 @@ impl FeeRate {
/// Checked weight multiplication. /// Checked weight multiplication.
/// ///
/// Computes the absolute fee amount for a given [`Weight`] at this fee rate. /// Computes the absolute fee amount for a given [`Weight`] at this fee rate.
/// When the resulting fee is a non-integer amount, the amount is rounded up,
/// ensuring that the transaction fee is enough instead of falling short if
/// rounded down.
/// ///
/// [`None`] is returned if an overflow occurred. /// [`None`] is returned if an overflow occurred.
pub fn checked_mul_by_weight(self, rhs: Weight) -> Option<Amount> { pub fn checked_mul_by_weight(self, rhs: Weight) -> Option<Amount> {