mirror of
https://github.com/sigp/lighthouse.git
synced 2026-04-17 21:08:32 +00:00
Move PublicKey to store uncompressed bytes.
This is an optimisation that allows for faster hashing of a public key, however it adds a penalty to SSZ encoding because we need to go decompressed -> PublicKey -> compressed. The spec presently uses compressed bytes to store public keys, however I'm hoping it will change.
This commit is contained in:
@@ -10,39 +10,58 @@ use ssz::{
|
||||
use std::default;
|
||||
use std::hash::{Hash, Hasher};
|
||||
|
||||
/// A single BLS signature.
|
||||
/// A single BLS public key.
|
||||
///
|
||||
/// This struct stores an uncompressed public key as a byte vec. The reason we store bytes instead
|
||||
/// of the `RawPublicKey` struct is because it allows for building a hashmap of `PublicKey` much
|
||||
/// faster.
|
||||
///
|
||||
/// Storing as uncompressed bytes costs ~0.02% more time when adding a `PublicKey` to an
|
||||
/// `AggregateKey`, however it saves ~0.5ms each time you need to add a pubkey to a hashmap.
|
||||
///
|
||||
/// This struct is a wrapper upon a base type and provides helper functions (e.g., SSZ
|
||||
/// serialization).
|
||||
#[derive(Debug, Clone, Eq)]
|
||||
pub struct PublicKey(RawPublicKey);
|
||||
pub struct PublicKey {
|
||||
bytes: Vec<u8>,
|
||||
}
|
||||
|
||||
impl PublicKey {
|
||||
pub fn from_secret_key(secret_key: &SecretKey) -> Self {
|
||||
PublicKey(RawPublicKey::from_secret_key(secret_key.as_raw()))
|
||||
let mut raw_key = RawPublicKey::from_secret_key(secret_key.as_raw());
|
||||
let uncompressed_bytes = raw_key.as_uncompressed_bytes();
|
||||
Self {
|
||||
bytes: uncompressed_bytes,
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns the underlying signature.
|
||||
pub fn as_raw(&self) -> &RawPublicKey {
|
||||
&self.0
|
||||
pub fn as_raw(&self) -> RawPublicKey {
|
||||
RawPublicKey::from_uncompressed_bytes(&self.bytes).expect("PublicKey in invalid state")
|
||||
}
|
||||
|
||||
/// Converts compressed bytes to PublicKey
|
||||
pub fn from_bytes(bytes: &[u8]) -> Result<Self, DecodeError> {
|
||||
let pubkey = RawPublicKey::from_bytes(&bytes).map_err(|_| DecodeError::Invalid)?;
|
||||
Ok(PublicKey(pubkey))
|
||||
let mut pubkey = RawPublicKey::from_bytes(&bytes).map_err(|_| DecodeError::Invalid)?;
|
||||
Ok(Self {
|
||||
bytes: pubkey.as_uncompressed_bytes(),
|
||||
})
|
||||
}
|
||||
|
||||
/// Returns the PublicKey as (x, y) bytes
|
||||
pub fn as_uncompressed_bytes(&self) -> Vec<u8> {
|
||||
RawPublicKey::as_uncompressed_bytes(&mut self.0.clone())
|
||||
self.bytes.clone()
|
||||
}
|
||||
|
||||
/// Converts (x, y) bytes to PublicKey
|
||||
pub fn from_uncompressed_bytes(bytes: &[u8]) -> Result<Self, DecodeError> {
|
||||
let pubkey =
|
||||
// Do a conversion to check the bytes are valid.
|
||||
let _pubkey =
|
||||
RawPublicKey::from_uncompressed_bytes(&bytes).map_err(|_| DecodeError::Invalid)?;
|
||||
Ok(PublicKey(pubkey))
|
||||
|
||||
Ok(Self {
|
||||
bytes: bytes.to_vec(),
|
||||
})
|
||||
}
|
||||
|
||||
/// Returns the last 6 bytes of the SSZ encoding of the public key, as a hex string.
|
||||
@@ -64,15 +83,22 @@ impl default::Default for PublicKey {
|
||||
|
||||
impl Encodable for PublicKey {
|
||||
fn ssz_append(&self, s: &mut SszStream) {
|
||||
s.append_vec(&self.0.as_bytes());
|
||||
s.append_vec(&self.as_raw().as_bytes());
|
||||
}
|
||||
}
|
||||
|
||||
impl Decodable for PublicKey {
|
||||
fn ssz_decode(bytes: &[u8], i: usize) -> Result<(Self, usize), DecodeError> {
|
||||
let (sig_bytes, i) = decode_ssz_list(bytes, i)?;
|
||||
let raw_sig = RawPublicKey::from_bytes(&sig_bytes).map_err(|_| DecodeError::TooShort)?;
|
||||
Ok((PublicKey(raw_sig), i))
|
||||
let mut raw_sig =
|
||||
RawPublicKey::from_bytes(&sig_bytes).map_err(|_| DecodeError::TooShort)?;
|
||||
|
||||
Ok((
|
||||
Self {
|
||||
bytes: raw_sig.as_uncompressed_bytes(),
|
||||
},
|
||||
i,
|
||||
))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -99,7 +125,7 @@ impl<'de> Deserialize<'de> for PublicKey {
|
||||
|
||||
impl TreeHash for PublicKey {
|
||||
fn hash_tree_root(&self) -> Vec<u8> {
|
||||
hash(&self.0.as_bytes())
|
||||
hash(&self.as_raw().as_bytes())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -117,7 +143,7 @@ impl Hash for PublicKey {
|
||||
///
|
||||
/// Use `ssz::Encode` to obtain the bytes required for consensus hashing.
|
||||
fn hash<H: Hasher>(&self, state: &mut H) {
|
||||
self.as_uncompressed_bytes().hash(state)
|
||||
self.bytes.hash(state)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user