use super::{SecretKey, BLS_PUBLIC_KEY_BYTE_SIZE}; use milagro_bls::PublicKey as RawPublicKey; use serde::de::{Deserialize, Deserializer}; use serde::ser::{Serialize, Serializer}; use serde_hex::{encode as hex_encode, HexVisitor}; use ssz::{Decode, DecodeError, Encode}; use std::default; use std::fmt; use std::hash::{Hash, Hasher}; /// A single BLS signature. /// /// This struct is a wrapper upon a base type and provides helper functions (e.g., SSZ /// serialization). #[derive(Clone, Eq)] pub struct PublicKey(RawPublicKey); impl PublicKey { pub fn from_secret_key(secret_key: &SecretKey) -> Self { PublicKey(RawPublicKey::from_secret_key(secret_key.as_raw())) } pub fn from_raw(raw: RawPublicKey) -> Self { Self(raw) } /// Returns the underlying signature. pub fn as_raw(&self) -> &RawPublicKey { &self.0 } /// Returns the underlying point as compressed bytes. /// /// Identical to `self.as_uncompressed_bytes()`. pub fn as_bytes(&self) -> Vec { self.as_raw().as_bytes() } /// Converts compressed bytes to PublicKey pub fn from_bytes(bytes: &[u8]) -> Result { let pubkey = RawPublicKey::from_bytes(&bytes).map_err(|_| { DecodeError::BytesInvalid(format!("Invalid PublicKey bytes: {:?}", bytes).to_string()) })?; Ok(PublicKey(pubkey)) } /// Returns the PublicKey as (x, y) bytes pub fn as_uncompressed_bytes(&self) -> Vec { RawPublicKey::as_uncompressed_bytes(&mut self.0.clone()) } /// Converts (x, y) bytes to PublicKey pub fn from_uncompressed_bytes(bytes: &[u8]) -> Result { let pubkey = RawPublicKey::from_uncompressed_bytes(&bytes).map_err(|_| { DecodeError::BytesInvalid("Invalid PublicKey uncompressed bytes.".to_string()) })?; Ok(PublicKey(pubkey)) } /// Returns the last 6 bytes of the SSZ encoding of the public key, as a hex string. /// /// Useful for providing a short identifier to the user. pub fn concatenated_hex_id(&self) -> String { self.as_hex_string()[0..6].to_string() } /// Returns the point as a hex string of the SSZ encoding. /// /// Note: the string is prefixed with `0x`. pub fn as_hex_string(&self) -> String { hex_encode(self.as_ssz_bytes()) } } impl fmt::Display for PublicKey { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.concatenated_hex_id()) } } impl fmt::Debug for PublicKey { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.as_hex_string()) } } impl default::Default for PublicKey { fn default() -> Self { let secret_key = SecretKey::random(); PublicKey::from_secret_key(&secret_key) } } impl_ssz!(PublicKey, BLS_PUBLIC_KEY_BYTE_SIZE, "PublicKey"); impl_tree_hash!(PublicKey, U48); impl Serialize for PublicKey { fn serialize(&self, serializer: S) -> Result where S: Serializer, { serializer.serialize_str(&hex_encode(self.as_raw().as_bytes())) } } impl<'de> Deserialize<'de> for PublicKey { fn deserialize(deserializer: D) -> Result where D: Deserializer<'de>, { let bytes = deserializer.deserialize_str(HexVisitor)?; let pubkey = Self::from_ssz_bytes(&bytes[..]) .map_err(|e| serde::de::Error::custom(format!("invalid pubkey ({:?})", e)))?; Ok(pubkey) } } impl PartialEq for PublicKey { fn eq(&self, other: &PublicKey) -> bool { self.as_ssz_bytes() == other.as_ssz_bytes() } } impl Hash for PublicKey { /// Note: this is distinct from consensus serialization, it will produce a different hash. /// /// This method uses the uncompressed bytes, which are much faster to obtain than the /// compressed bytes required for consensus serialization. /// /// Use `ssz::Encode` to obtain the bytes required for consensus hashing. fn hash(&self, state: &mut H) { self.as_uncompressed_bytes().hash(state) } } #[cfg(test)] mod tests { use super::*; use ssz::ssz_encode; #[test] pub fn test_ssz_round_trip() { let sk = SecretKey::random(); let original = PublicKey::from_secret_key(&sk); let bytes = ssz_encode(&original); let decoded = PublicKey::from_ssz_bytes(&bytes).unwrap(); assert_eq!(original, decoded); } #[test] pub fn test_byte_size() { let sk = SecretKey::random(); let original = PublicKey::from_secret_key(&sk); let bytes = ssz_encode(&original); assert_eq!(bytes.len(), BLS_PUBLIC_KEY_BYTE_SIZE); } }