Struct nostr_sdk::bitcoin::Sequence

pub struct Sequence(pub u32);

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 transcation 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 const fn max_value() -> Sequence

The maximum allowable sequence number.

This is provided for consistency with Rust 1.41.1, newer code should use Sequence::MAX.

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 sequene number encodes a time interval based relative lock-time.

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, Error>

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, Error>

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.

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

Performs copy-assignment from source.

impl Debug for Sequence

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

Formats the value using the given formatter.

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.

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

Decode Self from a size-limited reader.

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.

impl Display for Sequence

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

Formats the value using the given formatter.

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.

impl From<Sequence> for u32

fn from(sequence: Sequence) -> u32

Converts to this type from the input type.

impl FromHexStr for Sequence

type Error = ParseIntError

An error occurred while parsing the hex string.

fn from_hex_str_no_prefix<S>( s: S ) -> Result<Sequence, <Sequence as FromHexStr>::Error>where S: AsRef<str> + Into<String>,

Parses provided string as hex without requiring 0x prefix.

fn from_hex_str<S>(s: S) -> Result<Self, FromHexError<Self::Error>>where S: AsRef<str> + Into<String>,

Parses provided string as hex requiring 0x prefix.

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.

impl Hash for Sequence

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 Sequence

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

Formats the value using the given formatter.

impl Ord for Sequence

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Sequence> for Sequence

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

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

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<Sequence> for Sequence

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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.

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, Global>> for Sequence

type Error = ParseIntError

The type returned in the event of a conversion error.

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

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.

impl Copy for Sequence

impl Eq for Sequence

impl StructuralEq for Sequence

impl StructuralPartialEq for Sequence