Struct Signature

pub struct Signature { /* private fields */ }

An Ethereum ECDSA signature.

Implementations

impl Signature

pub fn decode_rlp_vrs( buf: &mut &[u8], decode_parity: impl FnOnce(&mut &[u8]) -> Result<bool>, ) -> Result<Self, Error>

Decode an RLP-encoded VRS signature. Accepts decode_parity closure which allows to customize parity decoding and possibly extract additional data from it (e.g chain_id for legacy signature).

impl Signature

pub const fn new(r: U256, s: U256, y_parity: bool) -> Self

Instantiate a new signature from r, s, and v values.

pub fn from_raw(bytes: &[u8]) -> Result<Self, SignatureError>

Parses a 65-byte long raw signature.

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 from_raw_array(bytes: &[u8; 65]) -> Result<Self, SignatureError>

Parses a 65-byte long raw signature.

See from_raw.

pub fn from_bytes_and_parity(bytes: &[u8], parity: bool) -> Self

Parses a signature from a byte slice, with a v value

Panics

If the slice is not at least 64 bytes long.

pub fn as_bytes(&self) -> [u8; 65]

Returns the byte-array representation of this signature.

The first 32 bytes are the r value, the second 32 bytes the s value and the final byte is the v value in ‘Electrum’ notation.

pub fn as_rsy(&self) -> [u8; 65]

Returns the byte-array representation of this signature as (r, s, y_parity).

The first 32 bytes are the r value, the second 32 bytes the s value, and the final byte is the y_parity value as-is (0 or 1).

See as_erc2098 for the compact ERC-2098 representation.

pub fn from_erc2098(bytes: &[u8]) -> Self

Decode the signature from the ERC-2098 compact representation.

The first 32 bytes are the r value, and the next 32 bytes are the s value with yParity in the top bit of the s value, as described in ERC-2098.

See https://eips.ethereum.org/EIPS/eip-2098

Panics

If the slice is not at least 64 bytes long.

pub fn as_erc2098(&self) -> [u8; 64]

Returns the ERC-2098 compact representation of this signature.

The first 32 bytes are the r value, and the next 32 bytes are the s value with yParity in the top bit of the s value, as described in ERC-2098.

See https://eips.ethereum.org/EIPS/eip-2098

pub fn with_parity(self, v: bool) -> Self

Sets the recovery ID by normalizing a v value.

pub fn to_k256(self) -> Result<Signature, Error>

Returns the inner ECDSA signature.

pub fn from_signature_and_parity(sig: Signature, v: bool) -> Self

Instantiate from a signature and recovery id

pub fn from_scalars_and_parity(r: B256, s: B256, parity: bool) -> Self

Creates a Signature from the serialized r and s scalar values, which comprise the ECDSA signature, alongside a v value, used to determine the recovery ID.

pub fn normalize_s(&self) -> Option<Self>

Normalizes the signature into “low S” form as described in BIP 0062: Dealing with Malleability.

If s is already normalized, returns None.

pub fn normalized_s(self) -> Self

Normalizes the signature into “low S” form as described in BIP 0062: Dealing with Malleability.

If s is already normalized, returns self.

pub fn recid(&self) -> RecoveryId

Returns the recovery ID.

pub fn recover_address_from_msg<T: AsRef<[u8]>>( &self, msg: T, ) -> Result<Address, SignatureError>

Recovers an Address from this signature and the given message by first prefixing and hashing the message according to EIP-191.

pub fn recover_address_from_prehash( &self, prehash: &B256, ) -> Result<Address, SignatureError>

Recovers an Address from this signature and the given prehashed message.

pub fn recover_from_msg<T: AsRef<[u8]>>( &self, msg: T, ) -> Result<VerifyingKey, SignatureError>

Recovers a VerifyingKey from this signature and the given message by first prefixing and hashing the message according to EIP-191.

pub fn recover_from_prehash( &self, prehash: &B256, ) -> Result<VerifyingKey, SignatureError>

Recovers a VerifyingKey from this signature and the given prehashed message.

pub fn r(&self) -> U256

Returns the r component of this signature.

pub fn s(&self) -> U256

Returns the s component of this signature.

pub fn v(&self) -> bool

Returns the recovery ID as a bool.

pub fn rlp_rs_len(&self) -> usize

Length of RLP RS field encoding

pub fn write_rlp_rs(&self, out: &mut dyn BufMut)

Write R and S to an RLP buffer in progress.

pub fn write_rlp_vrs(&self, out: &mut dyn BufMut, v: impl Encodable)

Write the VRS to the output.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signature

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Signature

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

Formats the value using the given formatter.

impl From<&Signature> for [u8; 65]

fn from(value: &Signature) -> [u8; 65]

Converts to this type from the input type.

impl From<&Signature> for Vec<u8>

fn from(value: &Signature) -> Self

Converts to this type from the input type.

impl From<(Signature<Secp256k1>, RecoveryId)> for Signature

fn from(value: (Signature, RecoveryId)) -> Self

Converts to this type from the input type.

impl From<Signature> for [u8; 65]

fn from(value: Signature) -> [u8; 65]

Converts to this type from the input type.

impl From<Signature> for Vec<u8>

fn from(value: Signature) -> Self

Converts to this type from the input type.

impl FromStr for Signature

type Err = SignatureError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Signature

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

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 PartialEq for Signature

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Signature

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Signature

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Parses a 65-byte long raw signature.

See from_raw.

type Error = SignatureError

The type returned in the event of a conversion error.

impl TryFrom<Signature> for Signature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Signature) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Signature

impl Eq for Signature

impl StructuralPartialEq for Signature