Struct alloy_primitives::Signature

pub struct Signature { /* private fields */ }

An Ethereum ECDSA signature.

Implementations

impl Signature

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

Available on crate feature rlp only.

Decode an RLP-encoded VRS signature.

impl Signature

pub fn new(r: U256, s: U256, v: Parity) -> Self

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

pub fn into_inner(self) -> Signature

👎Deprecated: use Signature::to_k256 instead

Available on crate feature k256 only.

Returns the inner ECDSA signature.

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

Available on crate feature k256 only.

Returns the inner ECDSA signature.

pub fn from_signature_and_parity<T: TryInto<Parity, Error = E>, E: Into<SignatureError>>( sig: Signature, parity: T, ) -> Result<Self, SignatureError>

Available on crate feature k256 only.

Instantiate from a signature and recovery id

pub fn from_scalars_and_parity<T: TryInto<Parity, Error = E>, E: Into<SignatureError>>( r: B256, s: B256, parity: T, ) -> Result<Self, SignatureError>

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.

pub const fn recid(&self) -> RecoveryId

Available on crate feature k256 only.

Returns the recovery ID.

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

Available on crate feature k256 only.

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>

Available on crate feature k256 only.

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>

Available on crate feature k256 only.

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>

Available on crate feature k256 only.

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

pub fn from_bytes_and_parity<T: TryInto<Parity, Error = E>, E: Into<SignatureError>>( bytes: &[u8], parity: T, ) -> Result<Self, SignatureError>

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

Panics

If the slice is not at least 64 bytes long.

pub fn from_rs_and_parity<T: TryInto<Parity, Error = E>, E: Into<SignatureError>>( r: U256, s: U256, parity: T, ) -> Result<Self, SignatureError>

Instantiate from v, r, s.

pub fn with_chain_id(self, chain_id: u64) -> Self

Modifies the recovery ID by applying EIP-155 to a v value.

pub fn with_parity_bool(self) -> Self

Modifies the recovery ID by dropping any [EIP-155] v value, converting to a simple parity bool.

pub const fn r(&self) -> U256

Returns the r component of this signature.

pub const fn s(&self) -> U256

Returns the s component of this signature.

pub const fn v(&self) -> Parity

Returns the recovery ID as a u8.

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 with_parity<T: Into<Parity>>(self, parity: T) -> Self

Sets the recovery ID by normalizing a v value.

pub fn rlp_rs_len(&self) -> usize

Available on crate feature rlp only.

Length of RLP RS field encoding

pub fn rlp_vrs_len(&self) -> usize

Available on crate feature rlp only.

Length of RLP V field encoding

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

Available on crate feature rlp only.

Write R and S to an RLP buffer in progress.

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

Available on crate feature rlp only.

Write the V to an RLP buffer without using EIP-155.

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

Available on crate feature rlp only.

Write the VRS to the output. The V will always be 27 or 28.

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

Available on crate feature rlp only.

fn decode(buf: &mut &[u8]) -> Result<Self, Error>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

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

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for Signature

Available on crate feature rlp only.

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

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

Available on crate feature k256 only.

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

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

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [u8]> for Signature

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

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.

type Error = SignatureError

The type returned in the event of a conversion error.

impl TryFrom<Signature> for Signature

Available on crate feature k256 only.

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