1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
//! Tendermint validators
use celestia_tendermint_proto::v0_37::types::SimpleValidator as RawSimpleValidator;
use celestia_tendermint_proto::Protobuf;
use serde::{Deserialize, Serialize};
use crate::{
account,
crypto::signature::Verifier,
crypto::Sha256,
hash::Hash,
merkle::{self, MerkleHash},
prelude::*,
public_key::deserialize_public_key,
vote, Error, PublicKey, Signature,
};
/// Validator set contains a vector of validators
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct Set {
validators: Vec<Info>,
proposer: Option<Info>,
total_voting_power: vote::Power,
}
impl Set {
/// Constructor
pub fn new(mut validators: Vec<Info>, proposer: Option<Info>) -> Set {
Self::sort_validators(&mut validators);
// Compute the total voting power
let total_voting_power = validators
.iter()
.map(|v| v.power.value())
.sum::<u64>()
.try_into()
.unwrap();
Set {
validators,
proposer,
total_voting_power,
}
}
/// Convenience constructor for cases where there is no proposer
pub fn without_proposer(validators: Vec<Info>) -> Set {
Self::new(validators, None)
}
/// Convenience constructor for cases where there is a proposer
pub fn with_proposer(
validators: Vec<Info>,
proposer_address: account::Id,
) -> Result<Self, Error> {
// Get the proposer.
let proposer = validators
.iter()
.find(|v| v.address == proposer_address)
.cloned()
.ok_or_else(|| Error::proposer_not_found(proposer_address))?;
// Create the validator set with the given proposer.
// This is required by IBC on-chain validation.
Ok(Self::new(validators, Some(proposer)))
}
/// Get Info of the underlying validators.
pub fn validators(&self) -> &Vec<Info> {
&self.validators
}
/// Get proposer
pub fn proposer(&self) -> &Option<Info> {
&self.proposer
}
/// Get total voting power
pub fn total_voting_power(&self) -> vote::Power {
self.total_voting_power
}
/// Sort the validators according to the current Tendermint requirements
/// (v. 0.34 -> first by validator power, descending, then by address, ascending)
fn sort_validators(vals: &mut [Info]) {
vals.sort_by_key(|v| (core::cmp::Reverse(v.power), v.address));
}
/// Returns the validator with the given Id if its in the Set.
pub fn validator(&self, val_id: account::Id) -> Option<Info> {
self.validators
.iter()
.find(|val| val.address == val_id)
.cloned()
}
/// Compute the hash of this validator set.
#[cfg(feature = "rust-crypto")]
pub fn hash(&self) -> Hash {
self.hash_with::<crate::crypto::default::Sha256>()
}
/// Hash this header with a SHA256 hasher provided by a crypto provider.
pub fn hash_with<H>(&self) -> Hash
where
H: MerkleHash + Sha256 + Default,
{
let validator_bytes: Vec<Vec<u8>> = self
.validators()
.iter()
.map(|validator| validator.hash_bytes())
.collect();
Hash::Sha256(merkle::simple_hash_from_byte_vectors::<H>(&validator_bytes))
}
}
/// Validator information
// Todo: Remove address and make it into a function that generates it on the fly from pub_key.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct Info {
/// Validator account address
pub address: account::Id,
/// Validator public key
pub pub_key: PublicKey,
/// Validator voting power
// Compatibility with genesis.json https://github.com/tendermint/tendermint/issues/5549
#[serde(alias = "voting_power", alias = "total_voting_power")]
pub power: vote::Power,
/// Validator name
pub name: Option<String>,
/// Validator proposer priority
#[serde(skip)]
pub proposer_priority: ProposerPriority,
}
impl Info {
/// Return the voting power of the validator.
pub fn power(&self) -> u64 {
self.power.value()
}
/// Verify the given signature against the given sign_bytes using the validators
/// public key.
pub fn verify_signature<V>(&self, sign_bytes: &[u8], signature: &Signature) -> Result<(), Error>
where
V: Verifier,
{
V::verify(self.pub_key, sign_bytes, signature)
.map_err(|_| Error::signature_invalid("Ed25519 signature verification failed".into()))
}
#[cfg(feature = "rust-crypto")]
/// Create a new validator.
pub fn new(pk: PublicKey, vp: vote::Power) -> Info {
Info {
address: account::Id::from(pk),
pub_key: pk,
power: vp,
name: None,
proposer_priority: ProposerPriority::default(),
}
}
}
/// SimpleValidator is the form of the validator used for computing the Merkle tree.
/// It does not include the address, as that is redundant with the pubkey,
/// nor the proposer priority, as that changes with every block even if the validator set didn't.
/// It contains only the pubkey and the voting power.
/// TODO: currently only works for Ed25519 pubkeys
#[derive(Clone, PartialEq, Eq)]
pub struct SimpleValidator {
/// Public key
pub pub_key: PublicKey,
/// Voting power
pub voting_power: vote::Power,
}
/// Info -> SimpleValidator
impl From<&Info> for SimpleValidator {
fn from(info: &Info) -> SimpleValidator {
SimpleValidator {
pub_key: info.pub_key,
voting_power: info.power,
}
}
}
impl Info {
/// Returns the bytes to be hashed into the Merkle tree -
/// the leaves of the tree.
pub fn hash_bytes(&self) -> Vec<u8> {
Protobuf::<RawSimpleValidator>::encode_vec(&SimpleValidator::from(self)).unwrap()
}
}
// Todo: Is there more knowledge/restrictions about proposerPriority?
/// Proposer priority
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Default)]
pub struct ProposerPriority(i64);
impl From<i64> for ProposerPriority {
fn from(value: i64) -> Self {
ProposerPriority(value)
}
}
impl From<ProposerPriority> for i64 {
fn from(priority: ProposerPriority) -> i64 {
priority.value()
}
}
impl ProposerPriority {
/// Get the current proposer priority
pub fn value(self) -> i64 {
self.0
}
}
/// A change to the validator set.
///
/// Used to inform Tendermint of changes to the validator set.
///
/// [ABCI documentation](https://docs.tendermint.com/master/spec/abci/abci.html#validatorupdate)
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct Update {
/// Validator public key
#[serde(deserialize_with = "deserialize_public_key")]
pub pub_key: PublicKey,
/// New voting power
#[serde(default)]
pub power: vote::Power,
}
// =============================================================================
// Protobuf conversions
// =============================================================================
tendermint_pb_modules! {
use pb::{
abci::ValidatorUpdate as RawValidatorUpdate,
types::{
SimpleValidator as RawSimpleValidator, Validator as RawValidator,
ValidatorSet as RawValidatorSet,
},
};
use super::{Info, Set, SimpleValidator, Update};
use crate::{prelude::*, Error};
impl Protobuf<RawValidatorSet> for Set {}
impl TryFrom<RawValidatorSet> for Set {
type Error = Error;
fn try_from(value: RawValidatorSet) -> Result<Self, Self::Error> {
let validators = value
.validators
.into_iter()
.map(TryInto::try_into)
.collect::<Result<Vec<_>, _>>()?;
let proposer = value.proposer.map(TryInto::try_into).transpose()?;
let validator_set = Self::new(validators, proposer);
Ok(validator_set)
}
}
impl From<Set> for RawValidatorSet {
fn from(value: Set) -> Self {
RawValidatorSet {
validators: value.validators.into_iter().map(Into::into).collect(),
proposer: value.proposer.map(Into::into),
total_voting_power: value.total_voting_power.into(),
}
}
}
impl TryFrom<RawValidator> for Info {
type Error = Error;
fn try_from(value: RawValidator) -> Result<Self, Self::Error> {
Ok(Info {
address: value.address.try_into()?,
pub_key: value
.pub_key
.ok_or_else(Error::missing_public_key)?
.try_into()?,
power: value.voting_power.try_into()?,
name: None,
proposer_priority: value.proposer_priority.into(),
})
}
}
impl From<Info> for RawValidator {
fn from(value: Info) -> Self {
RawValidator {
address: value.address.into(),
pub_key: Some(value.pub_key.into()),
voting_power: value.power.into(),
proposer_priority: value.proposer_priority.into(),
}
}
}
impl Protobuf<RawSimpleValidator> for SimpleValidator {}
impl TryFrom<RawSimpleValidator> for SimpleValidator {
type Error = Error;
fn try_from(value: RawSimpleValidator) -> Result<Self, Self::Error> {
Ok(SimpleValidator {
pub_key: value.pub_key
.ok_or_else(Error::missing_public_key)?
.try_into()?,
voting_power: value.voting_power.try_into()?,
})
}
}
impl From<SimpleValidator> for RawSimpleValidator {
fn from(value: SimpleValidator) -> Self {
RawSimpleValidator {
pub_key: Some(value.pub_key.into()),
voting_power: value.voting_power.into(),
}
}
}
impl Protobuf<RawValidatorUpdate> for Update {}
impl From<Update> for RawValidatorUpdate {
fn from(vu: Update) -> Self {
Self {
pub_key: Some(vu.pub_key.into()),
power: vu.power.into(),
}
}
}
impl TryFrom<RawValidatorUpdate> for Update {
type Error = Error;
fn try_from(vu: RawValidatorUpdate) -> Result<Self, Self::Error> {
Ok(Self {
pub_key: vu
.pub_key
.ok_or_else(Error::missing_public_key)?
.try_into()?,
power: vu.power.try_into()?,
})
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[cfg(feature = "rust-crypto")]
mod crypto {
use super::*;
// make a validator
fn make_validator(pk: Vec<u8>, vp: u64) -> Info {
let pk = PublicKey::from_raw_ed25519(&pk).unwrap();
Info::new(pk, vote::Power::try_from(vp).unwrap())
}
#[test]
fn test_validator_set() {
// test vector generated by Go code
// import (
// "fmt"
// "github.com/tendermint/tendermint/crypto/ed25519"
// "github.com/tendermint/tendermint/types"
// "strings"
// )
// func testValSet() {
// pk1 := ed25519.GenPrivKeyFromSecret([]byte{4, 211, 14, 157, 10, 0, 205, 9, 10, 116, 207,
// 161, 4, 211, 190, 37, 108, 88, 202, 168, 63, 135, 0, 141, 53, 55, 254, 57, 40, 184, 20,
// 242}) pk2 := ed25519.GenPrivKeyFromSecret([]byte{99, 231, 126, 151, 159, 236, 2,
// 229, 33, 44, 200, 248, 147, 176, 13, 127, 105, 76, 49, 83, 25, 101, 44, 57, 20, 215, 166,
// 188, 134, 94, 56, 165}) pk3 := ed25519.GenPrivKeyFromSecret([]byte{54, 253, 151,
// 16, 182, 114, 125, 12, 74, 101, 54, 253, 174, 153, 121, 74, 145, 180, 111, 16, 214, 48,
// 193, 109, 104, 134, 55, 162, 151, 16, 182, 114}) not_in_set :=
// ed25519.GenPrivKeyFromSecret([]byte{121, 74, 145, 180, 111, 16, 214, 48, 193, 109, 35,
// 68, 19, 27, 173, 69, 92, 204, 127, 218, 234, 81, 232, 75, 204, 199, 48, 163, 55, 132,
// 231, 147}) fmt.Println("pk1: ", strings.Join(strings.Split(fmt.Sprintf("%v",
// pk1.PubKey().Bytes()), " "), ", ")) fmt.Println("pk2:",
// strings.Join(strings.Split(fmt.Sprintf("%v", pk2.PubKey().Bytes()), " "), ", "))
// fmt.Println("pk3: ", strings.Join(strings.Split(fmt.Sprintf("%v", pk3.PubKey().Bytes()),
// " "), ", ")) fmt.Println("not_in_set: ",
// strings.Join(strings.Split(fmt.Sprintf("%v", not_in_set.PubKey().Bytes()), " "), ", "))
// v1 := types.NewValidator(pk1.PubKey(), 148151478422287875)
// v2 := types.NewValidator(pk2.PubKey(), 158095448483785107)
// v3 := types.NewValidator(pk3.PubKey(), 770561664770006272)
// set := types.NewValidatorSet([]*types.Validator{v1, v2, v3})
// fmt.Println("Hash:", strings.Join(strings.Split(fmt.Sprintf("%v", set.Hash()), " "), ",
// ")) }
let v1 = make_validator(
vec![
48, 163, 55, 132, 231, 147, 230, 163, 56, 158, 127, 218, 179, 139, 212, 103,
218, 89, 122, 126, 229, 88, 84, 48, 32, 0, 185, 174, 63, 72, 203, 52,
],
148_151_478_422_287_875,
);
let v2 = make_validator(
vec![
54, 253, 174, 153, 121, 74, 145, 180, 111, 16, 214, 48, 193, 109, 104, 134, 55,
162, 151, 16, 182, 114, 125, 135, 32, 195, 236, 248, 64, 112, 74, 101,
],
158_095_448_483_785_107,
);
let v3 = make_validator(
vec![
182, 205, 13, 86, 147, 27, 65, 49, 160, 118, 11, 180, 117, 35, 206, 35, 68, 19,
27, 173, 69, 92, 204, 224, 200, 51, 249, 81, 105, 128, 112, 244,
],
770_561_664_770_006_272,
);
let hash_expect = vec![
11, 64, 107, 4, 234, 81, 232, 75, 204, 199, 160, 114, 229, 97, 243, 95, 118, 213,
17, 22, 57, 84, 71, 122, 200, 169, 192, 252, 41, 148, 223, 180,
];
let val_set = Set::without_proposer(vec![v1.clone(), v2.clone(), v3.clone()]);
let hash = val_set.hash();
assert_eq!(hash_expect, hash.as_bytes().to_vec());
let not_in_set = make_validator(
vec![
110, 147, 87, 120, 27, 218, 66, 209, 81, 4, 169, 153, 64, 163, 137, 89, 168,
97, 219, 233, 42, 119, 24, 61, 47, 59, 76, 31, 182, 60, 13, 4,
],
10_000_000_000_000_000,
);
assert_eq!(val_set.validator(v1.address).unwrap(), v1);
assert_eq!(val_set.validator(v2.address).unwrap(), v2);
assert_eq!(val_set.validator(v3.address).unwrap(), v3);
assert_eq!(val_set.validator(not_in_set.address), None);
assert_eq!(
val_set.total_voting_power().value(),
148_151_478_422_287_875 + 158_095_448_483_785_107 + 770_561_664_770_006_272
);
}
}
#[test]
fn deserialize_validator_updates() {
const FMT1: &str = r#"{
"pub_key": {
"Sum": {
"type": "tendermint.crypto.PublicKey_Ed25519",
"value": {
"ed25519": "VqJCr3vjQdffcLIG6RMBl2MgXDFYNY6b3Joaa43gV3o="
}
}
},
"power": "573929"
}"#;
const FMT2: &str = r#"{
"pub_key": {
"type": "tendermint/PubKeyEd25519",
"value": "VqJCr3vjQdffcLIG6RMBl2MgXDFYNY6b3Joaa43gV3o="
},
"power": "573929"
}"#;
let update1 = serde_json::from_str::<Update>(FMT1).unwrap();
let update2 = serde_json::from_str::<Update>(FMT2).unwrap();
assert_eq!(u64::from(update1.power), 573929);
assert_eq!(update1, update2);
}
}