Struct web3::types::Recovery

pub struct Recovery {
    pub message: RecoveryMessage,
    pub v: u64,
    pub r: H256,
    pub s: H256,
}

Data for recovering the public address of signed data.

Note that the signature data is in 'Electrum' notation and may have chain replay protection applied. That means that v is expected to be 27, 28, or 35 + chain_id * 2 or 36 + chain_id * 2.

Fields

message: RecoveryMessage

The message to recover

v: u64

V value.

r: H256

R value.

s: H256

S value.

Implementations

impl Recovery

pub fn new<M>(message: M, v: u64, r: H256, s: H256) -> Recovery where
    M: Into<RecoveryMessage>, 

Creates new recovery data from its parts.

pub fn from_raw_signature<M, B>(
    message: M,
    raw_signature: B
) -> Result<Recovery, ParseSignatureError> where
    M: Into<RecoveryMessage>,
    B: AsRef<[u8]>, 

Creates new recovery data from a raw signature.

This parses a raw signature which is expected to be 65 bytes long where the first 32 bytes is the r value, the second 32 bytes the s value and the final byte is the v value in 'Electrum' notation.

pub fn recovery_id(&self) -> Option<i32>

Retrieve the Recovery Id ("Standard V")

Returns None if v value is invalid (equivalent of returning 4 in some implementaions).

pub fn as_signature(&self) -> Option<([u8; 64], i32)>

Retrieves the recovery id & compact signature in it's raw form.

Trait Implementations

impl Clone for Recovery

fn clone(&self) -> Recovery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Recovery

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

Formats the value using the given formatter.

impl<'a> From<&'a SignedData> for Recovery

fn from(signed: &'a SignedData) -> Self

Performs the conversion.

impl<'a> From<&'a SignedTransaction> for Recovery

fn from(tx: &'a SignedTransaction) -> Self

Performs the conversion.

impl PartialEq<Recovery> for Recovery

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

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

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

This method tests for !=.

impl StructuralPartialEq for Recovery