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

clarify the meaning of Height & Time based locktime.

This commit is contained in:
Divyansh Gupta 2024-06-19 20:14:04 +05:30
parent 700085d8b2
commit 16e4d22693
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -129,6 +129,12 @@ impl LockTime {
/// Constructs a `LockTime` from `n`, expecting `n` to be a valid block height.
///
/// # Note
///
/// If the current block height is `h` and the locktime is set to `h`,
/// the transaction can be included in block `h+1` or later.
/// It is possible to broadcast the transaction at block height `h`.
///
/// See [`LOCK_TIME_THRESHOLD`] for definition of a valid height value.
///
/// # Examples
@ -146,6 +152,15 @@ impl LockTime {
/// Constructs a `LockTime` from `n`, expecting `n` to be a valid block time.
///
/// # Note
///
/// If the locktime is set to a timestamp `T`,
/// the transaction can be included in a block only if the median time past (MTP) of the
/// last 11 blocks is greater than `T`.
/// It is possible to broadcast the transaction once the MTP is greater than `T`.[see BIP-113]
///
/// [BIP-113 Median time-past as endpoint for lock-time calculations](https://github.com/bitcoin/bips/blob/master/bip-0113.mediawiki)
///
/// See [`LOCK_TIME_THRESHOLD`] for definition of a valid time value.
///
/// # Examples