Enum tendermint::public_key::PublicKey

#[non_exhaustive]pub enum PublicKey {
    Ed25519(Ed25519),
    Secp256k1(Secp256k1),
}

Public keys allowed in Tendermint protocols

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ed25519(Ed25519)

Ed25519 keys

Secp256k1(Secp256k1)

This is supported on crate feature secp256k1 only.

Secp256k1 keys

Implementations

impl PublicKey

pub fn from_raw_secp256k1(bytes: &[u8]) -> Option<PublicKey>

This is supported on crate feature secp256k1 only.

From raw secp256k1 public key bytes

pub fn from_raw_ed25519(bytes: &[u8]) -> Option<PublicKey>

From raw Ed25519 public key bytes

pub fn ed25519(self) -> Option<Ed25519>

Get Ed25519 public key

pub fn secp256k1(self) -> Option<Secp256k1>

This is supported on crate feature secp256k1 only.

Get Secp256k1 public key

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

Verify the given Signature using this public key

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

View this key as a byte slice

pub fn to_vec(self) -> Vec<u8>

Get a vector containing the byte serialization of this key

pub fn to_bech32(self, hrp: &str) -> String

Serialize this key as Bech32 with the given human readable prefix

pub fn to_hex(self) -> String

Serialize this key as hexadecimal

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PublicKey

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

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

Deserialize this value from the given Serde deserializer.

impl Eq for PublicKey

impl From<EncodedPoint<Secp256k1>> for PublicKey

fn from(pk: Secp256k1) -> PublicKey

Performs the conversion.

impl From<PublicKey> for PublicKey

fn from(pk: Ed25519) -> PublicKey

Performs the conversion.

impl From<PublicKey> for Id

fn from(pub_key: PublicKey) -> Id

Performs the conversion.

impl Ord for PublicKey

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PublicKey> for PublicKey

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

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

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

This method tests for !=.

impl PartialOrd<PublicKey> for PublicKey

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Protobuf<PublicKey> for PublicKey

pub fn encode<B>(&self, buf: &mut B) -> Result<(), Error<Kind>> where
    B: BufMut, 

Encode into a buffer in Protobuf format.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), Error<Kind>> where
    B: BufMut, 

Encode with a length-delimiter to a buffer in Protobuf format.

pub fn decode<B>(buf: B) -> Result<Self, Error<Kind>> where
    B: Buf, 

Constructor that attempts to decode an instance from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, Error<Kind>> where
    B: Buf, 

Constructor that attempts to decode a length-delimited instance from the buffer.

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub fn encode_vec(&self) -> Result<Vec<u8, Global>, Error<Kind>>

Encodes into a Protobuf-encoded Vec<u8>.

pub fn decode_vec(v: &[u8]) -> Result<Self, Error<Kind>>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

pub fn encode_length_delimited_vec(
    &self
) -> Result<Vec<u8, Global>, Error<Kind>>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

pub fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error<Kind>>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for PublicKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for PublicKey

impl StructuralPartialEq for PublicKey

impl TryFrom<PublicKey> for PublicKey

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.