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

docs: document IWP function return limit and panic case 

Document the newly added saturation point for internal arithmetic.
This commit is contained in:
yancy 2025-06-19 13:27:40 -05:00
parent 8559a49e03
commit 3355400d67
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
bitcoin/src/blockdata/transaction.rs
View File

@ -1126,12 +1126,18 @@ impl InputWeightPrediction {
/// Computes the **signature weight** added to a transaction by an input with this weight prediction,
/// not counting the prevout (txid, index), sequence, potential witness flag bytes or the witness count varint.
///
/// This function's internal arithmetic saturates at u32::MAX, so the return value of this
/// function may be inaccurate for extremely large witness predictions.
#[deprecated(since = "TBD", note = "use `InputWeightPrediction::witness_weight()` instead")]
pub const fn weight(&self) -> Weight { Self::witness_weight(self) }
/// Computes the signature, prevout (txid, index), and sequence weights of this weight
/// prediction.
///
/// This function's internal arithmetic saturates at u32::MAX, so the return value of this
/// function may be inaccurate for extremely large witness predictions.
///
/// See also [`InputWeightPrediction::witness_weight`]
pub const fn total_weight(&self) -> Weight {
// `impl const Trait` is currently unavailable: rust/issues/67792
@ -1143,6 +1149,9 @@ impl InputWeightPrediction {
/// Computes the **signature weight** added to a transaction by an input with this weight prediction,
/// not counting the prevout (txid, index), sequence, potential witness flag bytes or the witness count varint.
///
/// This function's internal arithmetic saturates at u32::MAX, so the return value of this
/// function may be inaccurate for extremely large witness predictions.
///
/// See also [`InputWeightPrediction::total_weight`]
pub const fn witness_weight(&self) -> Weight {
let wu = self.script_size * 4 + self.witness_size;