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

Fix absolute lock time examples and tests 

An absolute lock time of 100 is nonsensical because we are well past
block 100. This value was used because it makes sense for _relative_
locktimes but for absolute lock times it makes the examples and tests
slightly confusing.
This commit is contained in:
Tobin C. Harding 2023-02-15 13:58:50 +11:00
parent 7930a9ba5c
commit c3cc9e52ab
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
bitcoin/src/blockdata/locktime/absolute.rs
View File

@ -62,8 +62,8 @@ pub const LOCK_TIME_THRESHOLD: u32 = 500_000_000;
/// # Examples /// # Examples
/// ``` /// ```
/// # use bitcoin::absolute::{LockTime, LockTime::*}; /// # use bitcoin::absolute::{LockTime, LockTime::*};
/// # let n = LockTime::from_consensus(100); // n OP_CHECKLOCKTIMEVERIFY /// # let n = LockTime::from_consensus(741521); // n OP_CHECKLOCKTIMEVERIFY
/// # let lock_time = LockTime::from_consensus(100); // nLockTime /// # let lock_time = LockTime::from_consensus(741521); // nLockTime
/// // To compare absolute lock times there are various `is_satisfied_*` methods, you may also use: /// // To compare absolute lock times there are various `is_satisfied_*` methods, you may also use:
/// let is_satisfied = match (n, lock_time) { /// let is_satisfied = match (n, lock_time) {
/// (Blocks(n), Blocks(lock_time)) => n <= lock_time, /// (Blocks(n), Blocks(lock_time)) => n <= lock_time,
@ -226,8 +226,8 @@ impl LockTime {
/// ///
/// ```rust /// ```rust
/// # use bitcoin::absolute::{LockTime, LockTime::*}; /// # use bitcoin::absolute::{LockTime, LockTime::*};
/// let lock_time = LockTime::from_consensus(100); /// let lock_time = LockTime::from_consensus(741521);
/// let check = LockTime::from_consensus(100 + 1); /// let check = LockTime::from_consensus(741521 + 1);
/// assert!(lock_time.is_implied_by(check)); /// assert!(lock_time.is_implied_by(check));
/// ``` /// ```
#[inline] #[inline]
@ -255,8 +255,8 @@ impl LockTime {
/// ///
/// ```rust /// ```rust
/// # use bitcoin::absolute::{LockTime, LockTime::*}; /// # use bitcoin::absolute::{LockTime, LockTime::*};
/// # let n = LockTime::from_consensus(100); // n OP_CHECKLOCKTIMEVERIFY /// # let n = LockTime::from_consensus(741521); // n OP_CHECKLOCKTIMEVERIFY
/// # let lock_time = LockTime::from_consensus(100 + 1); // nLockTime /// # let lock_time = LockTime::from_consensus(741521 + 1); // nLockTime
/// ///
/// let is_satisfied = match (n, lock_time) { /// let is_satisfied = match (n, lock_time) {
/// (Blocks(n), Blocks(lock_time)) => n <= lock_time, /// (Blocks(n), Blocks(lock_time)) => n <= lock_time,
@ -764,12 +764,12 @@ mod tests {
#[test] #[test]
fn display_and_alternate() { fn display_and_alternate() {
let n = LockTime::from_consensus(100); let n = LockTime::from_consensus(741521);
let s = format!("{}", n); let s = format!("{}", n);
assert_eq!(&s, "100"); assert_eq!(&s, "741521");
let got = format!("{:#}", n); let got = format!("{:#}", n);
assert_eq!(got, "block-height 100"); assert_eq!(got, "block-height 741521");
} }
#[test] #[test]