use linera_base::{crypto::PublicKey, data_types::Round, identifiers::Owner};
use serde::{Deserialize, Serialize};
use std::{collections::BTreeMap, iter, time::Duration};
#[derive(PartialEq, Eq, Clone, Hash, Debug, Serialize, Deserialize)]
pub struct TimeoutConfig {
pub fast_round_duration: Option<Duration>,
pub base_timeout: Duration,
pub timeout_increment: Duration,
}
impl Default for TimeoutConfig {
fn default() -> Self {
Self {
fast_round_duration: None,
base_timeout: Duration::from_secs(10),
timeout_increment: Duration::from_secs(1),
}
}
}
#[derive(PartialEq, Eq, Clone, Hash, Debug, Default, Serialize, Deserialize)]
pub struct ChainOwnership {
pub super_owners: BTreeMap<Owner, PublicKey>,
pub owners: BTreeMap<Owner, (PublicKey, u64)>,
pub multi_leader_rounds: u32,
pub timeout_config: TimeoutConfig,
}
impl ChainOwnership {
pub fn single(public_key: PublicKey) -> Self {
ChainOwnership {
super_owners: iter::once((Owner::from(public_key), public_key)).collect(),
owners: BTreeMap::new(),
multi_leader_rounds: 2,
timeout_config: TimeoutConfig::default(),
}
}
pub fn multiple(
keys_and_weights: impl IntoIterator<Item = (PublicKey, u64)>,
multi_leader_rounds: u32,
timeout_config: TimeoutConfig,
) -> Self {
ChainOwnership {
super_owners: BTreeMap::new(),
owners: keys_and_weights
.into_iter()
.map(|(public_key, weight)| (Owner::from(public_key), (public_key, weight)))
.collect(),
multi_leader_rounds,
timeout_config,
}
}
pub fn with_regular_owner(mut self, public_key: PublicKey, weight: u64) -> Self {
self.owners
.insert(Owner::from(public_key), (public_key, weight));
self
}
pub fn is_active(&self) -> bool {
!self.super_owners.is_empty() || !self.owners.is_empty()
}
pub fn verify_owner(&self, owner: &Owner) -> Option<PublicKey> {
if let Some(public_key) = self.super_owners.get(owner) {
Some(*public_key)
} else {
self.owners.get(owner).map(|(public_key, _)| *public_key)
}
}
pub fn round_timeout(&self, round: Round) -> Option<Duration> {
let tc = &self.timeout_config;
match round {
Round::Fast => tc.fast_round_duration,
Round::MultiLeader(r) if r.saturating_add(1) == self.multi_leader_rounds => {
Some(tc.base_timeout)
}
Round::MultiLeader(_) => None,
Round::SingleLeader(r) => {
let increment = tc.timeout_increment.saturating_mul(r);
Some(tc.base_timeout.saturating_add(increment))
}
}
}
pub fn first_round(&self) -> Round {
if !self.super_owners.is_empty() {
Round::Fast
} else if self.multi_leader_rounds > 0 {
Round::MultiLeader(0)
} else {
Round::SingleLeader(0)
}
}
pub fn all_owners(&self) -> impl Iterator<Item = &Owner> {
self.super_owners.keys().chain(self.owners.keys())
}
pub fn next_round(&self, round: Round) -> Option<Round> {
let next_round = match round {
Round::Fast if self.multi_leader_rounds == 0 => Round::SingleLeader(0),
Round::Fast => Round::MultiLeader(0),
Round::MultiLeader(r) if r >= self.multi_leader_rounds.saturating_sub(1) => {
Round::SingleLeader(0)
}
Round::MultiLeader(r) => Round::MultiLeader(r.checked_add(1)?),
Round::SingleLeader(r) => Round::SingleLeader(r.checked_add(1)?),
};
Some(next_round)
}
pub fn previous_round(&self, round: Round) -> Option<Round> {
let previous_round = match round {
Round::Fast => return None,
Round::MultiLeader(r) => {
if let Some(prev_r) = r.checked_sub(1) {
Round::MultiLeader(prev_r)
} else if self.super_owners.is_empty() {
return None;
} else {
Round::Fast
}
}
Round::SingleLeader(r) => {
if let Some(prev_r) = r.checked_sub(1) {
Round::SingleLeader(prev_r)
} else if let Some(last_multi_r) = self.multi_leader_rounds.checked_sub(1) {
Round::MultiLeader(last_multi_r)
} else if self.super_owners.is_empty() {
return None;
} else {
Round::Fast
}
}
};
Some(previous_round)
}
}
#[cfg(test)]
mod tests {
use super::*;
use linera_base::crypto::KeyPair;
#[test]
fn test_ownership_round_timeouts() {
let super_pub_key = KeyPair::generate().public();
let super_owner = Owner::from(super_pub_key);
let pub_key = KeyPair::generate().public();
let owner = Owner::from(pub_key);
let ownership = ChainOwnership {
super_owners: BTreeMap::from_iter([(super_owner, super_pub_key)]),
owners: BTreeMap::from_iter([(owner, (pub_key, 100))]),
multi_leader_rounds: 10,
timeout_config: TimeoutConfig {
fast_round_duration: Some(Duration::from_secs(5)),
base_timeout: Duration::from_secs(10),
timeout_increment: Duration::from_secs(1),
},
};
assert_eq!(
ownership.round_timeout(Round::Fast),
Some(Duration::from_secs(5))
);
assert_eq!(ownership.round_timeout(Round::MultiLeader(8)), None);
assert_eq!(
ownership.round_timeout(Round::MultiLeader(9)),
Some(Duration::from_secs(10))
);
assert_eq!(
ownership.round_timeout(Round::SingleLeader(0)),
Some(Duration::from_secs(10))
);
assert_eq!(
ownership.round_timeout(Round::SingleLeader(1)),
Some(Duration::from_secs(11))
);
assert_eq!(
ownership.round_timeout(Round::SingleLeader(8)),
Some(Duration::from_secs(18))
);
}
}