Struct coins_bip32::prelude::RecoveryId

source ·
pub struct RecoveryId(/* private fields */);
Expand description

Recovery IDs, a.k.a. “recid”.

This is an integer value 0, 1, 2, or 3 included along with a signature which is used during the recovery process to select the correct public key from the signature.

It consists of two bits of information:

  • low bit (0/1): was the y-coordinate of the affine point resulting from the fixed-base multiplication 𝑘×𝑮 odd? This part of the algorithm functions similar to point decompression.
  • hi bit (3/4): did the affine x-coordinate of 𝑘×𝑮 overflow the order of the scalar field, requiring a reduction when computing r?

Implementations§

source§

impl RecoveryId

source

pub const MAX: u8 = 3u8

Maximum supported value for the recovery ID (inclusive).

source

pub const fn new(is_y_odd: bool, is_x_reduced: bool) -> RecoveryId

Create a new RecoveryId from the following 1-bit arguments:

  • is_y_odd: is the affine y-coordinate of 𝑘×𝑮 odd?
  • is_x_reduced: did the affine x-coordinate of 𝑘×𝑮 overflow the curve order?
source

pub const fn is_x_reduced(self) -> bool

Did the affine x-coordinate of 𝑘×𝑮 overflow the curve order?

source

pub const fn is_y_odd(self) -> bool

Is the affine y-coordinate of 𝑘×𝑮 odd?

source

pub const fn from_byte(byte: u8) -> Option<RecoveryId>

Convert a u8 into a RecoveryId.

source

pub const fn to_byte(self) -> u8

Convert this RecoveryId into a u8.

source§

impl RecoveryId

source

pub fn trial_recovery_from_msg<C>( verifying_key: &VerifyingKey<C>, msg: &[u8], signature: &Signature<C>, ) -> Result<RecoveryId, Error>

Given a public key, message, and signature, use trial recovery to determine if a suitable recovery ID exists, or return an error otherwise.

source

pub fn trial_recovery_from_digest<C, D>( verifying_key: &VerifyingKey<C>, digest: D, signature: &Signature<C>, ) -> Result<RecoveryId, Error>

Given a public key, message digest, and signature, use trial recovery to determine if a suitable recovery ID exists, or return an error otherwise.

source

pub fn trial_recovery_from_prehash<C>( verifying_key: &VerifyingKey<C>, prehash: &[u8], signature: &Signature<C>, ) -> Result<RecoveryId, Error>

Given a public key, message digest, and signature, use trial recovery to determine if a suitable recovery ID exists, or return an error otherwise.

Trait Implementations§

source§

impl Clone for RecoveryId

source§

fn clone(&self) -> RecoveryId

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
source§

impl Debug for RecoveryId

source§

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

Formats the value using the given formatter. Read more
source§

impl Ord for RecoveryId

source§

fn cmp(&self, other: &RecoveryId) -> 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
source§

impl PartialEq for RecoveryId

source§

fn eq(&self, other: &RecoveryId) -> 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.
source§

impl PartialOrd for RecoveryId

source§

fn partial_cmp(&self, other: &RecoveryId) -> 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
source§

impl TryFrom<u8> for RecoveryId

§

type Error = Error

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

fn try_from(byte: u8) -> Result<RecoveryId, Error>

Performs the conversion.
source§

impl Copy for RecoveryId

source§

impl Eq for RecoveryId

source§

impl StructuralPartialEq for RecoveryId

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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

§

type Output = T

Should always be Self
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, 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.