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

Specify required_height in variable name when comparing to other height

This commit is contained in:
Shing Him Ng 2024-07-12 22:23:56 -05:00
parent 2fcd65ad97
commit e2b0fd33be
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
bitcoin/src/blockdata/locktime/relative.rs
View File

@ -168,11 +168,11 @@ impl LockTime {
/// # use bitcoin::Sequence; /// # use bitcoin::Sequence;
/// # use bitcoin::locktime::relative::{LockTime, Height, Time}; /// # use bitcoin::locktime::relative::{LockTime, Height, Time};
/// ///
/// # let height = 100; // 100 blocks. /// # let required_height = 100; // 100 blocks.
/// # let intervals = 70; // Approx 10 hours. /// # let intervals = 70; // Approx 10 hours.
/// # let current_height = || Height::from(height + 10); /// # let current_height = || Height::from(required_height + 10);
/// # let current_time = || Time::from_512_second_intervals(intervals + 10); /// # let current_time = || Time::from_512_second_intervals(intervals + 10);
/// # let lock = Sequence::from_height(height).to_relative_lock_time().expect("valid height"); /// # let lock = Sequence::from_height(required_height).to_relative_lock_time().expect("valid height");
/// ///
/// // Users that have chain data can get the current height and time to check against a lock. /// // Users that have chain data can get the current height and time to check against a lock.
/// let height_and_time = (current_time(), current_height()); // tuple order does not matter. /// let height_and_time = (current_time(), current_height()); // tuple order does not matter.
@ -208,9 +208,9 @@ impl LockTime {
/// # use bitcoin::Sequence; /// # use bitcoin::Sequence;
/// # use bitcoin::locktime::relative::{LockTime, Height, Time}; /// # use bitcoin::locktime::relative::{LockTime, Height, Time};
/// ///
/// # let height = 100; // 100 blocks. /// # let required_height = 100; // 100 blocks.
/// # let lock = Sequence::from_height(height).to_relative_lock_time().expect("valid height"); /// # let lock = Sequence::from_height(required_height).to_relative_lock_time().expect("valid height");
/// # let test_sequence = Sequence::from_height(height + 10); /// # let test_sequence = Sequence::from_height(required_height + 10);
/// ///
/// let satisfied = match test_sequence.to_relative_lock_time() { /// let satisfied = match test_sequence.to_relative_lock_time() {
/// None => false, // Handle non-lock-time case. /// None => false, // Handle non-lock-time case.
@ -256,9 +256,9 @@ impl LockTime {
/// # use bitcoin::Sequence; /// # use bitcoin::Sequence;
/// # use bitcoin::locktime::relative::{LockTime, Height, Time}; /// # use bitcoin::locktime::relative::{LockTime, Height, Time};
/// ///
/// let height: u16 = 100; /// let required_height: u16 = 100;
/// let lock = Sequence::from_height(height).to_relative_lock_time().expect("valid height"); /// let lock = Sequence::from_height(required_height).to_relative_lock_time().expect("valid height");
/// assert!(lock.is_satisfied_by_height(Height::from(height+1)).expect("a height")); /// assert!(lock.is_satisfied_by_height(Height::from(required_height + 1)).expect("a height"));
/// ``` /// ```
#[inline] #[inline]
#[cfg_attr(all(test, mutate), mutate)] #[cfg_attr(all(test, mutate), mutate)]
@ -266,7 +266,7 @@ impl LockTime {
use LockTime::*; use LockTime::*;
match *self { match *self {
Blocks(ref h) => Ok(h.value() <= height.value()), Blocks(ref required_height) => Ok(required_height.value() <= height.value()),
Time(time) => Err(IncompatibleHeightError { height, time }), Time(time) => Err(IncompatibleHeightError { height, time }),
} }
} }