pub enum LockTime {
Blocks(Height),
Time(Time),
}
Expand description
A relative lock time value, representing either a block height or time (512 second intervals).
Used for sequence numbers (nSequence
in Bitcoin Core and crate::TxIn::sequence
in this library) and also for the argument to opcode ’OP_CHECKSEQUENCEVERIFY`.
§Note on ordering
Locktimes may be height- or time-based, and these metrics are incommensurate; there is no total
ordering on locktimes. We therefore have implemented PartialOrd
but not Ord
. We also
implement [ordered::ArbitraryOrd
] if the “ordered” feature is enabled.
§Relevant BIPs
Variants§
Implementations§
§impl LockTime
impl LockTime
pub const ZERO: LockTime = _
pub const ZERO: LockTime = _
A relative locktime of 0 is always valid, and is assumed valid for inputs that are not yet confirmed.
pub const SIZE: usize = 4usize
pub const SIZE: usize = 4usize
The number of bytes that the locktime contributes to the size of a transaction.
pub fn from_consensus(n: u32) -> Result<LockTime, DisabledLockTimeError>
pub fn from_consensus(n: u32) -> Result<LockTime, DisabledLockTimeError>
Constructs a LockTime
from an nSequence value or the argument to OP_CHECKSEQUENCEVERIFY.
This method will not round-trip with Self::to_consensus_u32
, because relative
locktimes only use some bits of the underlying u32
value and discard the rest. If
you want to preserve the full value, you should use the Sequence
type instead.
§Examples
// `from_consensus` roundtrips with `to_consensus_u32` for small values.
let n_lock_time: u32 = 7000;
let lock_time = LockTime::from_consensus(n_lock_time).unwrap();
assert_eq!(lock_time.to_consensus_u32(), n_lock_time);
pub fn to_consensus_u32(&self) -> u32
pub fn to_consensus_u32(&self) -> u32
Returns the u32
value used to encode this locktime in an nSequence field or
argument to OP_CHECKSEQUENCEVERIFY
.
§Warning
Locktimes are not ordered by the natural ordering on u32
. If you want to
compare locktimes, use Self::is_implied_by
or similar methods.
pub fn from_sequence(n: Sequence) -> Result<LockTime, DisabledLockTimeError>
pub fn from_sequence(n: Sequence) -> Result<LockTime, DisabledLockTimeError>
Constructs a LockTime
from the sequence number of a Bitcoin input.
This method will not round-trip with Self::to_sequence
. See the
docs for Self::from_consensus
for more information.
pub fn to_sequence(&self) -> Sequence
pub fn to_sequence(&self) -> Sequence
Encodes the locktime as a sequence number.
pub const fn from_height(n: u16) -> LockTime
pub const fn from_height(n: u16) -> LockTime
Constructs a LockTime
from n
, expecting n
to be a 16-bit count of blocks.
pub const fn from_512_second_intervals(intervals: u16) -> LockTime
pub const fn from_512_second_intervals(intervals: u16) -> LockTime
Constructs a LockTime
from n
, expecting n
to be a count of 512-second intervals.
This function is a little awkward to use, and users may wish to instead use
Self::from_seconds_floor
or Self::from_seconds_ceil
.
pub const fn from_seconds_floor(
seconds: u32
) -> Result<LockTime, TimeOverflowError>
pub const fn from_seconds_floor( seconds: u32 ) -> Result<LockTime, TimeOverflowError>
pub const fn from_seconds_ceil(
seconds: u32
) -> Result<LockTime, TimeOverflowError>
pub const fn from_seconds_ceil( seconds: u32 ) -> Result<LockTime, TimeOverflowError>
pub const fn is_same_unit(&self, other: LockTime) -> bool
pub const fn is_same_unit(&self, other: LockTime) -> bool
Returns true if both lock times use the same unit i.e., both height based or both time based.
pub const fn is_block_height(&self) -> bool
pub const fn is_block_height(&self) -> bool
Returns true if this lock time value is in units of block height.
pub const fn is_block_time(&self) -> bool
pub const fn is_block_time(&self) -> bool
Returns true if this lock time value is in units of time.
pub fn is_satisfied_by(&self, h: Height, t: Time) -> bool
pub fn is_satisfied_by(&self, h: Height, t: Time) -> bool
Returns true if this [relative::LockTime
] is satisfied by either height or time.
§Examples
// 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.
assert!(lock.is_satisfied_by(current_height(), current_time()));
pub fn is_implied_by(&self, other: LockTime) -> bool
pub fn is_implied_by(&self, other: LockTime) -> bool
Returns true if satisfaction of other
lock time implies satisfaction of this
[relative::LockTime
].
A lock time can only be satisfied by n blocks being mined or n seconds passing. If you have two lock times (same unit) then the larger lock time being satisfied implies (in a mathematical sense) the smaller one being satisfied.
This function is useful when checking sequence values against a lock, first one checks the
sequence represents a relative lock time by converting to LockTime
then use this function
to see if satisfaction of the newly created lock time would imply satisfaction of self
.
Can also be used to remove the smaller value of two OP_CHECKSEQUENCEVERIFY
operations
within one branch of the script.
§Examples
let satisfied = match test_sequence.to_relative_lock_time() {
None => false, // Handle non-lock-time case.
Some(test_lock) => lock.is_implied_by(test_lock),
};
assert!(satisfied);
pub fn is_implied_by_sequence(&self, other: Sequence) -> bool
pub fn is_implied_by_sequence(&self, other: Sequence) -> bool
Returns true if satisfaction of the sequence number implies satisfaction of this lock time.
When deciding whether an instance of <n> CHECKSEQUENCEVERIFY
will pass, this
method can be used by parsing n
as a LockTime
and calling this method
with the sequence number of the input which spends the script.
pub fn is_satisfied_by_height(
&self,
height: Height
) -> Result<bool, IncompatibleHeightError>
pub fn is_satisfied_by_height( &self, height: Height ) -> Result<bool, IncompatibleHeightError>
Returns true if this [relative::LockTime
] is satisfied by Height
.
§Errors
Returns an error if this lock is not lock-by-height.
§Examples
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"));
pub fn is_satisfied_by_time(
&self,
time: Time
) -> Result<bool, IncompatibleTimeError>
pub fn is_satisfied_by_time( &self, time: Time ) -> Result<bool, IncompatibleTimeError>
Returns true if this [relative::LockTime
] is satisfied by Time
.
§Errors
Returns an error if this lock is not lock-by-time.
§Examples
let intervals: u16 = 70; // approx 10 hours;
let lock = Sequence::from_512_second_intervals(intervals).to_relative_lock_time().expect("valid time");
assert!(lock.is_satisfied_by_time(Time::from_512_second_intervals(intervals + 10)).expect("a time"));
Trait Implementations§
§impl<'de> Deserialize<'de> for LockTime
impl<'de> Deserialize<'de> for LockTime
§fn deserialize<__D>(
__deserializer: __D
) -> Result<LockTime, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<LockTime, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl PartialOrd for LockTime
impl PartialOrd for LockTime
§fn partial_cmp(&self, other: &LockTime) -> Option<Ordering>
fn partial_cmp(&self, other: &LockTime) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl<Pk> Satisfier<Pk> for LockTimewhere
Pk: MiniscriptKey + ToPublicKey,
impl<Pk> Satisfier<Pk> for LockTimewhere
Pk: MiniscriptKey + ToPublicKey,
§fn check_older(&self, n: LockTime) -> bool
fn check_older(&self, n: LockTime) -> bool
§fn lookup_ecdsa_sig(&self, _: &Pk) -> Option<Signature>
fn lookup_ecdsa_sig(&self, _: &Pk) -> Option<Signature>
§fn lookup_tap_key_spend_sig(&self) -> Option<Signature>
fn lookup_tap_key_spend_sig(&self) -> Option<Signature>
§fn lookup_tap_leaf_script_sig(
&self,
_: &Pk,
_: &TapLeafHash
) -> Option<Signature>
fn lookup_tap_leaf_script_sig( &self, _: &Pk, _: &TapLeafHash ) -> Option<Signature>
§fn lookup_tap_control_block_map(
&self
) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>
fn lookup_tap_control_block_map( &self ) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>
§fn lookup_raw_pkh_pk(&self, _: &Hash) -> Option<PublicKey>
fn lookup_raw_pkh_pk(&self, _: &Hash) -> Option<PublicKey>
Pkh
, lookup corresponding bitcoin::PublicKey
§fn lookup_raw_pkh_x_only_pk(&self, _: &Hash) -> Option<XOnlyPublicKey>
fn lookup_raw_pkh_x_only_pk(&self, _: &Hash) -> Option<XOnlyPublicKey>
Pkh
, lookup corresponding bitcoin::secp256k1::XOnlyPublicKey
§fn lookup_raw_pkh_ecdsa_sig(&self, _: &Hash) -> Option<(PublicKey, Signature)>
fn lookup_raw_pkh_ecdsa_sig(&self, _: &Hash) -> Option<(PublicKey, Signature)>
§fn lookup_raw_pkh_tap_leaf_script_sig(
&self,
_: &(Hash, TapLeafHash)
) -> Option<(XOnlyPublicKey, Signature)>
fn lookup_raw_pkh_tap_leaf_script_sig( &self, _: &(Hash, TapLeafHash) ) -> Option<(XOnlyPublicKey, Signature)>
§fn lookup_sha256(&self, _: &<Pk as MiniscriptKey>::Sha256) -> Option<[u8; 32]>
fn lookup_sha256(&self, _: &<Pk as MiniscriptKey>::Sha256) -> Option<[u8; 32]>
§fn lookup_hash256(&self, _: &<Pk as MiniscriptKey>::Hash256) -> Option<[u8; 32]>
fn lookup_hash256(&self, _: &<Pk as MiniscriptKey>::Hash256) -> Option<[u8; 32]>
§fn lookup_ripemd160(
&self,
_: &<Pk as MiniscriptKey>::Ripemd160
) -> Option<[u8; 32]>
fn lookup_ripemd160( &self, _: &<Pk as MiniscriptKey>::Ripemd160 ) -> Option<[u8; 32]>
§fn lookup_hash160(&self, _: &<Pk as MiniscriptKey>::Hash160) -> Option<[u8; 32]>
fn lookup_hash160(&self, _: &<Pk as MiniscriptKey>::Hash160) -> Option<[u8; 32]>
§fn check_after(&self, _: LockTime) -> bool
fn check_after(&self, _: LockTime) -> bool
§impl Serialize for LockTime
impl Serialize for LockTime
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
§impl TryFrom<Sequence> for LockTime
impl TryFrom<Sequence> for LockTime
§type Error = DisabledLockTimeError
type Error = DisabledLockTimeError
impl Copy for LockTime
impl Eq for LockTime
impl StructuralPartialEq for LockTime
Auto Trait Implementations§
impl Freeze for LockTime
impl RefUnwindSafe for LockTime
impl Send for LockTime
impl Sync for LockTime
impl Unpin for LockTime
impl UnwindSafe for LockTime
Blanket Implementations§
§impl<T, Pk> AssetProvider<Pk> for Twhere
T: Satisfier<Pk>,
Pk: MiniscriptKey + ToPublicKey,
impl<T, Pk> AssetProvider<Pk> for Twhere
T: Satisfier<Pk>,
Pk: MiniscriptKey + ToPublicKey,
§fn provider_lookup_ecdsa_sig(&self, pk: &Pk) -> bool
fn provider_lookup_ecdsa_sig(&self, pk: &Pk) -> bool
§fn provider_lookup_tap_key_spend_sig(&self, _: &Pk) -> Option<usize>
fn provider_lookup_tap_key_spend_sig(&self, _: &Pk) -> Option<usize>
§fn provider_lookup_tap_leaf_script_sig(
&self,
pk: &Pk,
leaf_hash: &TapLeafHash
) -> Option<usize>
fn provider_lookup_tap_leaf_script_sig( &self, pk: &Pk, leaf_hash: &TapLeafHash ) -> Option<usize>
§fn provider_lookup_tap_control_block_map(
&self
) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>
fn provider_lookup_tap_control_block_map( &self ) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>
§fn provider_lookup_raw_pkh_pk(&self, hash: &Hash) -> Option<PublicKey>
fn provider_lookup_raw_pkh_pk(&self, hash: &Hash) -> Option<PublicKey>
Pkh
, lookup corresponding bitcoin::PublicKey
§fn provider_lookup_raw_pkh_x_only_pk(
&self,
hash: &Hash
) -> Option<XOnlyPublicKey>
fn provider_lookup_raw_pkh_x_only_pk( &self, hash: &Hash ) -> Option<XOnlyPublicKey>
Pkh
, lookup corresponding bitcoin::secp256k1::XOnlyPublicKey