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

Merge rust-bitcoin/rust-bitcoin#3026: Specify required_height in variable name when comparing to other height 

e2b0fd33be Specify required_height in variable name when comparing to other height (Shing Him Ng)

Pull request description:

  Update the variable names for `h`/`height` to `required_height` in instances where it was being used to create another height or used comparatively i.e. `required_height + 1` or `required_height < height`

  Resolves #2553

ACKs for top commit:
  Kixunil:
    ACK e2b0fd33be
  tcharding:
    ACK e2b0fd33be

Tree-SHA512: 05fa8df721148d9bbc6eaa2b14c2583d3415c3ab0d53b8fdf39d7b9e9a28463265e43abfc430dfc7f6d0b53cd17767f5cad83c2de73b8a153aeb6befeeac84bc
This commit is contained in:
merge-script 2024-07-14 14:17:15 +00:00
parent 2fcd65ad97 e2b0fd33be
commit 9844c68ba6
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
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::locktime::relative::{LockTime, Height, Time};
///
/// # let height = 100; // 100 blocks.
/// # let required_height = 100; // 100 blocks.
/// # 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 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.
/// let height_and_time = (current_time(), current_height()); // tuple order does not matter.
@ -208,9 +208,9 @@ impl LockTime {
/// # use bitcoin::Sequence;
/// # use bitcoin::locktime::relative::{LockTime, Height, Time};
///
/// # let height = 100; // 100 blocks.
/// # let lock = Sequence::from_height(height).to_relative_lock_time().expect("valid height");
/// # let test_sequence = Sequence::from_height(height + 10);
/// # let required_height = 100; // 100 blocks.
/// # let lock = Sequence::from_height(required_height).to_relative_lock_time().expect("valid height");
/// # let test_sequence = Sequence::from_height(required_height + 10);
///
/// let satisfied = match test_sequence.to_relative_lock_time() {
/// None => false, // Handle non-lock-time case.
@ -256,9 +256,9 @@ impl LockTime {
/// # use bitcoin::Sequence;
/// # use bitcoin::locktime::relative::{LockTime, Height, Time};
///
/// let height: u16 = 100;
/// let lock = Sequence::from_height(height).to_relative_lock_time().expect("valid height");
/// assert!(lock.is_satisfied_by_height(Height::from(height+1)).expect("a height"));
/// let required_height: u16 = 100;
/// let lock = Sequence::from_height(required_height).to_relative_lock_time().expect("valid height");
/// assert!(lock.is_satisfied_by_height(Height::from(required_height + 1)).expect("a height"));
/// ```
#[inline]
#[cfg_attr(all(test, mutate), mutate)]
@ -266,7 +266,7 @@ impl LockTime {
use LockTime::*;
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 }),
}
}