Struct bdk_chain::bitcoin::Sequence

pub struct Sequence(pub u32);
Expand description

Bitcoin transaction input sequence number.

The sequence field is used for:

  • Indicating whether absolute lock-time (specified in lock_time field of Transaction) is enabled.
  • Indicating and encoding BIP-68 relative lock-times.
  • Indicating whether a transaction opts-in to BIP-125 replace-by-fee.

Note that transactions spending an output with OP_CHECKLOCKTIMEVERIFYMUST NOT use Sequence::MAX for the corresponding input. BIP-65

Tuple Fields§

§0: u32

Implementations§

§

impl Sequence

pub const MAX: Sequence = _

The maximum allowable sequence number.

This sequence number disables absolute lock time and replace-by-fee.

pub const ZERO: Sequence = _

Zero value sequence.

This sequence number enables replace-by-fee and absolute lock time.

pub const ENABLE_LOCKTIME_NO_RBF: Sequence = Sequence::MIN_NO_RBF

The sequence number that enables absolute lock time but disables replace-by-fee and relative lock time.

pub const ENABLE_RBF_NO_LOCKTIME: Sequence = _

The sequence number that enables replace-by-fee and absolute lock time but disables relative lock time.

pub fn enables_absolute_lock_time(&self) -> bool

Returns true if the sequence number enables absolute lock-time (Transaction::lock_time).

pub fn is_final(&self) -> bool

Returns true if the sequence number indicates that the transaction is finalized.

Instead of this method please consider using !enables_absolute_lock_time because it is equivalent and improves readability for those not steeped in Bitcoin folklore.

§Historical note

The term ‘final’ is an archaic Bitcoin term, it may have come about because the sequence number in the original Bitcoin code was intended to be incremented in order to replace a transaction, so once the sequence number got to u64::MAX it could no longer be increased, hence it was ‘final’.

Some other references to the term:

  • CTxIn::SEQUENCE_FINAL in the Bitcoin Core code.
  • BIP-112: “BIP 68 prevents a non-final transaction from being selected for inclusion in a block until the corresponding input has reached the specified age”

pub fn is_rbf(&self) -> bool

Returns true if the transaction opted-in to BIP125 replace-by-fee.

Replace by fee is signaled by the sequence being less than 0xfffffffe which is checked by this method. Note, this is the highest “non-final” value (see Sequence::is_final).

pub fn is_relative_lock_time(&self) -> bool

Returns true if the sequence has a relative lock-time.

pub fn is_height_locked(&self) -> bool

Returns true if the sequence number encodes a block based relative lock-time.

pub fn is_time_locked(&self) -> bool

Returns true if the sequence number encodes a time interval based relative lock-time.

pub fn from_hex(s: &str) -> Result<Sequence, PrefixedHexError>

Creates a Sequence from an prefixed hex string.

pub fn from_unprefixed_hex(s: &str) -> Result<Sequence, UnprefixedHexError>

Creates a Sequence from an unprefixed hex string.

pub fn from_height(height: u16) -> Sequence

Creates a relative lock-time using block height.

pub fn from_512_second_intervals(intervals: u16) -> Sequence

Creates a relative lock-time using time intervals where each interval is equivalent to 512 seconds.

Encoding finer granularity of time for relative lock-times is not supported in Bitcoin

pub fn from_seconds_floor(seconds: u32) -> Result<Sequence, TimeOverflowError>

Creates a relative lock-time from seconds, converting the seconds into 512 second interval with floor division.

Will return an error if the input cannot be encoded in 16 bits.

pub fn from_seconds_ceil(seconds: u32) -> Result<Sequence, TimeOverflowError>

Creates a relative lock-time from seconds, converting the seconds into 512 second interval with ceiling division.

Will return an error if the input cannot be encoded in 16 bits.

pub fn from_consensus(n: u32) -> Sequence

Creates a sequence from a u32 value.

pub fn to_consensus_u32(self) -> u32

Returns the inner 32bit integer value of Sequence.

pub fn to_relative_lock_time(&self) -> Option<LockTime>

Creates a relative::LockTime from this Sequence number.

Trait Implementations§

§

impl Clone for Sequence

§

fn clone(&self) -> Sequence

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Sequence

§

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

Formats the value using the given formatter. Read more
§

impl Decodable for Sequence

§

fn consensus_decode<R>(r: &mut R) -> Result<Sequence, Error>
where R: Read + ?Sized,

Decode an object with a well-defined format. Read more
§

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + ?Sized,

Decode Self from a size-limited reader. Read more
§

impl Default for Sequence

§

fn default() -> Sequence

The default value of sequence is 0xffffffff.

§

impl<'de> Deserialize<'de> for Sequence

§

fn deserialize<__D>( __deserializer: __D ) -> Result<Sequence, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for Sequence

§

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

Formats the value using the given formatter. Read more
§

impl Encodable for Sequence

§

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>
where W: Write + ?Sized,

Encodes an object with a well-defined format. Read more
§

impl From<LockTime> for Sequence

§

fn from(lt: LockTime) -> Sequence

Converts to this type from the input type.
§

impl From<RelLockTime> for Sequence

§

fn from(lock_time: RelLockTime) -> Sequence

Converts to this type from the input type.
§

impl From<Sequence> for u32

§

fn from(sequence: Sequence) -> u32

Converts to this type from the input type.
§

impl FromStr for Sequence

§

type Err = ParseIntError

The associated error which can be returned from parsing.
§

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

Parses a string s to return a value of this type. Read more
§

impl Hash for Sequence

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl LowerHex for Sequence

§

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

Formats the value using the given formatter. Read more
§

impl Ord for Sequence

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for Sequence

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialOrd for Sequence

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl<Pk> Satisfier<Pk> for Sequence
where Pk: MiniscriptKey + ToPublicKey,

§

fn check_older(&self, n: LockTime) -> bool

Assert whether an relative locktime is satisfied Read more
§

fn lookup_ecdsa_sig(&self, _: &Pk) -> Option<Signature>

Given a public key, look up an ECDSA signature with that key
§

fn lookup_tap_key_spend_sig(&self) -> Option<Signature>

Lookup the tap key spend sig
§

fn lookup_tap_leaf_script_sig( &self, _: &Pk, _: &TapLeafHash ) -> Option<Signature>

Given a public key and a associated leaf hash, look up an schnorr signature with that key
§

fn lookup_tap_control_block_map( &self ) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>

Obtain a reference to the control block for a ver and script
§

fn lookup_raw_pkh_pk(&self, _: &Hash) -> Option<PublicKey>

Given a raw Pkh, lookup corresponding bitcoin::PublicKey
§

fn lookup_raw_pkh_x_only_pk(&self, _: &Hash) -> Option<XOnlyPublicKey>

Given a raw Pkh, lookup corresponding bitcoin::secp256k1::XOnlyPublicKey
§

fn lookup_raw_pkh_ecdsa_sig(&self, _: &Hash) -> Option<(PublicKey, Signature)>

Given a keyhash, look up the EC signature and the associated key Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.
§

fn lookup_raw_pkh_tap_leaf_script_sig( &self, _: &(Hash, TapLeafHash) ) -> Option<(XOnlyPublicKey, Signature)>

Given a keyhash, look up the schnorr signature and the associated key Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.
§

fn lookup_sha256(&self, _: &<Pk as MiniscriptKey>::Sha256) -> Option<[u8; 32]>

Given a SHA256 hash, look up its preimage
§

fn lookup_hash256(&self, _: &<Pk as MiniscriptKey>::Hash256) -> Option<[u8; 32]>

Given a HASH256 hash, look up its preimage
§

fn lookup_ripemd160( &self, _: &<Pk as MiniscriptKey>::Ripemd160 ) -> Option<[u8; 32]>

Given a RIPEMD160 hash, look up its preimage
§

fn lookup_hash160(&self, _: &<Pk as MiniscriptKey>::Hash160) -> Option<[u8; 32]>

Given a HASH160 hash, look up its preimage
§

fn check_after(&self, _: LockTime) -> bool

Assert whether a absolute locktime is satisfied Read more
§

impl Serialize for Sequence

§

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl TryFrom<&str> for Sequence

§

type Error = ParseIntError

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

impl TryFrom<Box<str>> for Sequence

§

type Error = ParseIntError

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

impl TryFrom<Sequence> for LockTime

§

type Error = DisabledLockTimeError

The type returned in the event of a conversion error.
§

fn try_from(seq: Sequence) -> Result<LockTime, DisabledLockTimeError>

Performs the conversion.
§

impl TryFrom<Sequence> for RelLockTime

§

type Error = RelLockTimeError

The type returned in the event of a conversion error.
§

fn try_from(seq: Sequence) -> Result<RelLockTime, RelLockTimeError>

Performs the conversion.
§

impl TryFrom<String> for Sequence

§

type Error = ParseIntError

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

impl UpperHex for Sequence

§

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

Formats the value using the given formatter. Read more
§

impl Copy for Sequence

§

impl Eq for Sequence

§

impl StructuralPartialEq for Sequence

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T, Pk> AssetProvider<Pk> for T
where T: Satisfier<Pk>, Pk: MiniscriptKey + ToPublicKey,

§

fn provider_lookup_ecdsa_sig(&self, pk: &Pk) -> bool

Given a public key, look up an ECDSA signature with that key, return whether we found it
§

fn provider_lookup_tap_key_spend_sig(&self, _: &Pk) -> Option<usize>

Lookup the tap key spend sig and return its size
§

fn provider_lookup_tap_leaf_script_sig( &self, pk: &Pk, leaf_hash: &TapLeafHash ) -> Option<usize>

Given a public key and a associated leaf hash, look up a schnorr signature with that key and return its size
§

fn provider_lookup_tap_control_block_map( &self ) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>

Obtain a reference to the control block for a ver and script
§

fn provider_lookup_raw_pkh_pk(&self, hash: &Hash) -> Option<PublicKey>

Given a raw Pkh, lookup corresponding bitcoin::PublicKey
§

fn provider_lookup_raw_pkh_x_only_pk( &self, hash: &Hash ) -> Option<XOnlyPublicKey>

Given a raw Pkh, lookup corresponding bitcoin::secp256k1::XOnlyPublicKey
§

fn provider_lookup_raw_pkh_ecdsa_sig(&self, hash: &Hash) -> Option<PublicKey>

Given a keyhash, look up the EC signature and the associated key. Returns the key if a signature is found. Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.
§

fn provider_lookup_raw_pkh_tap_leaf_script_sig( &self, hash: &(Hash, TapLeafHash) ) -> Option<(XOnlyPublicKey, usize)>

Given a keyhash, look up the schnorr signature and the associated key. Returns the key and sig len if a signature is found. Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.
§

fn provider_lookup_sha256(&self, hash: &<Pk as MiniscriptKey>::Sha256) -> bool

Given a SHA256 hash, look up its preimage, return whether we found it
§

fn provider_lookup_hash256(&self, hash: &<Pk as MiniscriptKey>::Hash256) -> bool

Given a HASH256 hash, look up its preimage, return whether we found it
§

fn provider_lookup_ripemd160( &self, hash: &<Pk as MiniscriptKey>::Ripemd160 ) -> bool

Given a RIPEMD160 hash, look up its preimage, return whether we found it
§

fn provider_lookup_hash160(&self, hash: &<Pk as MiniscriptKey>::Hash160) -> bool

Given a HASH160 hash, look up its preimage, return whether we found it
§

fn check_older(&self, s: LockTime) -> bool

Assert whether a relative locktime is satisfied
§

fn check_after(&self, l: LockTime) -> bool

Assert whether an absolute locktime is satisfied
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,