Struct MedianTimePast 

pub struct MedianTimePast(/* private fields */);

The median timestamp of 11 consecutive blocks, representing “the timestamp” of the final block for locktime-checking purposes.

Time-based locktimes are not measured against the timestamps in individual block headers, since these are not monotone and may be subject to miner manipulation. Instead, locktimes use the “median-time-past” (MTP) of the most recent 11 blocks, a quantity which is required by consensus to be monotone and which is difficult for any individual miner to manipulate.

Implementations

impl MedianTimePast

pub const MIN: MedianTimePast

The minimum MTP allowable in a locktime (Tue Nov 05 1985 00:53:20 GMT+0000).

pub const MAX: MedianTimePast

The maximum MTP allowable in a locktime (Sun Feb 07 2106 06:28:15 GMT+0000).

pub fn new( timestamps: [BlockTime; 11], ) -> Result<MedianTimePast, ConversionError>

Constructs an MedianTimePast by computing the median-time-past from the last 11 block timestamps.

Because block timestamps are not monotonic, this function internally sorts them; it is therefore not important what order they appear in the array; use whatever is most convenient.

Errors

If the median block timestamp is not in the allowable range of MTPs in a locktime: [500_000_000, 2^32 - 1]. Because there is a consensus rule that MTP be monotonically increasing, and the MTP of the first 11 blocks exceeds 500_000_000 for every real-life chain, this error typically cannot be hit in practice.

pub fn from_hex(s: &str) -> Result<MedianTimePast, ParseTimeError>

Constructs a new MedianTimePast from a big-endian hex-encoded u32.

The input string may or may not contain a typical hex prefix e.g., 0x.

Errors

If the input string is not a valid hex representation of a block time.

pub const fn from_u32(n: u32) -> Result<MedianTimePast, ConversionError>

Constructs a new MTP directly from a u32 value.

This function, with MedianTimePast::to_u32, is used to obtain a raw MTP value. It is not used to convert to or from a block timestamp, which is not a MTP.

Errors

If n is not in the allowable range of MTPs in a locktime: [500_000_000, 2^32 - 1].

Examples

use bitcoin_units::locktime::absolute;

let t: u32 = 1653195600; // May 22nd, 5am UTC.
let time = absolute::MedianTimePast::from_u32(t)?;
assert_eq!(time.to_u32(), t);

pub const fn to_u32(self) -> u32

Converts this MedianTimePast to a raw u32 value.

Examples

use bitcoin_units::locktime::absolute;

assert_eq!(absolute::MedianTimePast::MIN.to_u32(), 500_000_000);

pub fn is_satisfied_by(self, time: MedianTimePast) -> bool

Returns true if a transaction with this locktime can be included in the next block.

self is the value of the LockTime and if time is the median time past of the block at the chain tip then a transaction with this lock can be broadcast for inclusion in the next block.

Trait Implementations

impl<'a> Arbitrary<'a> for MedianTimePast

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<MedianTimePast, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Binary for MedianTimePast

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Clone for MedianTimePast

fn clone(&self) -> MedianTimePast

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MedianTimePast

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for MedianTimePast

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<MedianTimePast> for BlockMtp

fn from(h: MedianTimePast) -> BlockMtp

Converts a [locktime::absolute::MedianTimePast] to a BlockMtp.

An absolute locktime MTP has a minimum value of absolute::LOCK_TIME_THRESHOLD, while BlockMtp may take the full range of u32.

impl From<MedianTimePast> for LockTime

fn from(t: MedianTimePast) -> LockTime

Converts to this type from the input type.

impl FromStr for MedianTimePast

type Err = ParseTimeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<MedianTimePast, <MedianTimePast as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for MedianTimePast

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for MedianTimePast

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Octal for MedianTimePast

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Ord for MedianTimePast

fn cmp(&self, other: &MedianTimePast) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MedianTimePast

fn eq(&self, other: &MedianTimePast) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MedianTimePast

fn partial_cmp(&self, other: &MedianTimePast) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for MedianTimePast

type Error = ParseTimeError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<MedianTimePast, <MedianTimePast as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<BlockMtp> for MedianTimePast

fn try_from( h: BlockMtp, ) -> Result<MedianTimePast, <MedianTimePast as TryFrom<BlockMtp>>::Error>

Converts a BlockHeight to a [locktime::absolute::Height].

An absolute locktime MTP has a minimum value of absolute::LOCK_TIME_THRESHOLD, while BlockMtp may take the full range of u32.

type Error = ConversionError

The type returned in the event of a conversion error.

impl TryFrom<Box<str>> for MedianTimePast

type Error = ParseTimeError

The type returned in the event of a conversion error.

fn try_from( s: Box<str>, ) -> Result<MedianTimePast, <MedianTimePast as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<String> for MedianTimePast

type Error = ParseTimeError

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<MedianTimePast, <MedianTimePast as TryFrom<String>>::Error>

Performs the conversion.

impl UpperHex for MedianTimePast

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for MedianTimePast

impl Eq for MedianTimePast

impl StructuralPartialEq for MedianTimePast