Struct ed25519_consensus::VerificationKey

pub struct VerificationKey { /* private fields */ }

A valid Ed25519 verification key.

This is also called a public key by other implementations.

This type holds decompressed state used in signature verification; if the verification key may not be used immediately, it is probably better to use VerificationKeyBytes, which is a refinement type for [u8; 32].

Consensus properties

Ed25519 checks are described in §5.4.5 of the Zcash protocol specification and in [ZIP 215]. The verification criteria for an (encoded) verification key A_bytes are:

• A_bytes MUST be an encoding of a point A on the twisted Edwards form of Curve25519, and non-canonical encodings MUST be accepted;

Implementations

impl VerificationKey

pub fn to_bytes(&self) -> [u8; 32]

Returns the byte encoding of the verification key.

This is the same as .into(), but does not require type inference.

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

View the byte encoding of the verification key.

pub fn verify(&self, signature: &Signature, msg: &[u8]) -> Result<(), Error>

Verify a purported signature on the given msg.

Consensus properties

Ed25519 checks are described in §5.4.5 of the Zcash protocol specification and in ZIP215. The verification criteria for an (encoded) signature (R_bytes, s_bytes) with (encoded) verification key A_bytes are:

• A_bytes and R_bytes MUST be encodings of points A and R respectively on the twisted Edwards form of Curve25519, and non-canonical encodings MUST be accepted;

• s_bytes MUST represent an integer s less than l, the order of the prime-order subgroup of Curve25519;

• the verification equation [8][s]B = [8]R + [8][k]A MUST be satisfied;

• the alternate verification equation [s]B = R + [k]A, allowed by RFC 8032, MUST NOT be used.

Trait Implementations

impl AsRef<[u8]> for VerificationKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VerificationKey

fn clone(&self) -> VerificationKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VerificationKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a SigningKey> for VerificationKey

fn from(sk: &'a SigningKey) -> VerificationKey

Converts to this type from the input type.

impl From<VerificationKey> for [u8; 32]

fn from(vk: VerificationKey) -> [u8; 32]

Converts to this type from the input type.

impl From<VerificationKey> for VerificationKeyBytes

fn from(vk: VerificationKey) -> VerificationKeyBytes

Converts to this type from the input type.

impl Hash for VerificationKey

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 Ord for VerificationKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<VerificationKey> for VerificationKey

fn eq(&self, other: &VerificationKey) -> 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 PartialOrd<VerificationKey> for VerificationKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for VerificationKey

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 VerificationKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<VerificationKey, Error>

Performs the conversion.

impl TryFrom<[u8; 32]> for VerificationKey

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<VerificationKeyBytes> for VerificationKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: VerificationKeyBytes) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for VerificationKey

impl Eq for VerificationKey

impl StructuralEq for VerificationKey

impl StructuralPartialEq for VerificationKey