Skip to main content

ScriptNum

Struct ScriptNum 

Source
pub struct ScriptNum;
Expand description

Bitcoin Script number utilities.

Provides conversion between stack byte arrays and BigNumber values, following Bitcoin’s sign-magnitude little-endian encoding.

Implementations§

Source§

impl ScriptNum

Source

pub fn from_bytes(bytes: &[u8], require_minimal: bool) -> Result<BigNumber>

Converts stack bytes to a BigNumber.

§Arguments
  • bytes - The stack element bytes
  • require_minimal - If true, rejects non-minimally encoded numbers
§Returns

The decoded BigNumber value, or an error if encoding is invalid

Source

pub fn to_bytes(value: &BigNumber) -> Vec<u8>

Converts a BigNumber to stack bytes (minimal encoding).

§Arguments
  • value - The BigNumber to encode
§Returns

The minimally-encoded byte array

Source

pub fn is_minimally_encoded(bytes: &[u8]) -> bool

Checks if bytes are minimally encoded as a script number.

A number is minimally encoded if:

  • It’s empty (zero), or
  • The last byte is non-zero after removing the sign bit, or
  • The second-to-last byte has its high bit set (justifying the extra byte)
Source

pub fn cast_to_bool(bytes: &[u8]) -> bool

Casts a byte array to a boolean value.

Returns false for:

  • Empty array
  • Array of all zeros
  • Negative zero [0x80] or [0x00, ..., 0x80]

Returns true otherwise.

Source

pub fn minimally_encode(bytes: &[u8]) -> Vec<u8>

Minimally encodes bytes in-place.

Removes unnecessary trailing zeros while preserving the sign.

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
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
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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

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.
Source§

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

Source§

fn vzip(self) -> V