Skip to content

Commit

Permalink
Stop validators from equivocating on reboot
Browse files Browse the repository at this point in the history
Part of #345.

The lack of full DB persistence does mean enough nodes rebooting at the same
time may cause a halt. This will prevent slashes.
  • Loading branch information
kayabaNerve committed Mar 8, 2024
1 parent 6c8a0bf commit e266bc2
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 5 deletions.
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion coordinator/tributary/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ impl<D: Db, T: TransactionTrait, P: P2p> Tributary<D, T, P> {
TendermintNetwork { genesis, signer, validators, blockchain, to_rebroadcast, p2p };

let TendermintHandle { synced_block, synced_block_result, messages, machine } =
TendermintMachine::new(network.clone(), block_number, start_time, proposal).await;
TendermintMachine::new(db.clone(), network.clone(), block_number, start_time, proposal).await;
tokio::spawn(machine.run());

Some(Self {
Expand Down
2 changes: 2 additions & 0 deletions coordinator/tributary/src/tendermint/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,8 @@ fn assert_target_block_time() {

#[async_trait]
impl<D: Db, T: TransactionTrait, P: P2p> Network for TendermintNetwork<D, T, P> {
type Db = D;

type ValidatorId = [u8; 32];
type SignatureScheme = Arc<Validators>;
type Weights = Arc<Validators>;
Expand Down
2 changes: 2 additions & 0 deletions coordinator/tributary/tendermint/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@ futures-util = { version = "0.3", default-features = false, features = ["std", "
futures-channel = { version = "0.3", default-features = false, features = ["std", "sink"] }
tokio = { version = "1", default-features = false, features = ["time"] }

serai-db = { path = "../../../common/db", version = "0.1", default-features = false }

[dev-dependencies]
tokio = { version = "1", features = ["sync", "rt-multi-thread", "macros"] }
38 changes: 34 additions & 4 deletions coordinator/tributary/tendermint/src/block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ use std::{
collections::{HashSet, HashMap},
};

use parity_scale_codec::Encode;
use serai_db::{Get, DbTxn, Db};

use crate::{
time::CanonicalInstant,
ext::{RoundNumber, BlockNumber, Block, Network},
Expand All @@ -12,6 +15,8 @@ use crate::{
};

pub(crate) struct BlockData<N: Network> {
db: N::Db,

pub(crate) number: BlockNumber,
pub(crate) validator_id: Option<N::ValidatorId>,
pub(crate) proposal: Option<N::Block>,
Expand All @@ -32,12 +37,15 @@ pub(crate) struct BlockData<N: Network> {

impl<N: Network> BlockData<N> {
pub(crate) fn new(
db: N::Db,
weights: Arc<N::Weights>,
number: BlockNumber,
validator_id: Option<N::ValidatorId>,
proposal: Option<N::Block>,
) -> BlockData<N> {
BlockData {
db,

number,
validator_id,
proposal,
Expand Down Expand Up @@ -128,12 +136,34 @@ impl<N: Network> BlockData<N> {
// 27, 33, 41, 46, 60, 64
self.round_mut().step = data.step();

// Only return a message to if we're actually a current validator
self.validator_id.map(|validator_id| Message {
// Only return a message to if we're actually a current validator and haven't prior posted a
// message
let round_number = self.round().number;
let step = data.step();
let res = self.validator_id.map(|validator_id| Message {
sender: validator_id,
block: self.number,
round: self.round().number,
round: round_number,
data,
})
});

if res.is_some() {
let mut txn = self.db.txn();
let key = [
b"tendermint-machine_already_sent_message".as_ref(),
&self.number.0.to_le_bytes(),
&round_number.0.to_le_bytes(),
&step.encode(),
]
.concat();
// If we've already sent a message, return
if txn.get(&key).is_some() {
None?;
}
txn.put(&key, []);
txn.commit();
}

res
}
}
3 changes: 3 additions & 0 deletions coordinator/tributary/tendermint/src/ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,9 @@ pub trait Block: Send + Sync + Clone + PartialEq + Eq + Debug + Encode + Decode
/// Trait representing the distributed system Tendermint is providing consensus over.
#[async_trait]
pub trait Network: Sized + Send + Sync {
/// The database used to back this.
type Db: serai_db::Db;

// Type used to identify validators.
type ValidatorId: ValidatorId;
/// Signature scheme used by validators.
Expand Down
7 changes: 7 additions & 0 deletions coordinator/tributary/tendermint/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ pub enum SlashEvent {

/// A machine executing the Tendermint protocol.
pub struct TendermintMachine<N: Network> {
db: N::Db,

network: N,
signer: <N::SignatureScheme as SignatureScheme>::Signer,
validators: N::SignatureScheme,
Expand Down Expand Up @@ -322,6 +324,7 @@ impl<N: Network + 'static> TendermintMachine<N> {

// Create the new block
self.block = BlockData::new(
self.db.clone(),
self.weights.clone(),
BlockNumber(self.block.number.0 + 1),
self.signer.validator_id().await,
Expand Down Expand Up @@ -370,6 +373,7 @@ impl<N: Network + 'static> TendermintMachine<N> {
/// the machine itself. The machine should have `run` called from an asynchronous task.
#[allow(clippy::new_ret_no_self)]
pub async fn new(
db: N::Db,
network: N,
last_block: BlockNumber,
last_time: u64,
Expand Down Expand Up @@ -409,6 +413,8 @@ impl<N: Network + 'static> TendermintMachine<N> {
let validator_id = signer.validator_id().await;
// 01-10
let mut machine = TendermintMachine {
db: db.clone(),

network,
signer,
validators,
Expand All @@ -420,6 +426,7 @@ impl<N: Network + 'static> TendermintMachine<N> {
synced_block_result_send,

block: BlockData::new(
db,
weights,
BlockNumber(last_block.0 + 1),
validator_id,
Expand Down
5 changes: 5 additions & 0 deletions coordinator/tributary/tendermint/tests/ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ use parity_scale_codec::{Encode, Decode};
use futures_util::sink::SinkExt;
use tokio::{sync::RwLock, time::sleep};

use serai_db::MemDb;

use tendermint_machine::{
ext::*, SignedMessageFor, SyncedBlockSender, SyncedBlockResultReceiver, MessageSender,
SlashEvent, TendermintMachine, TendermintHandle,
Expand Down Expand Up @@ -111,6 +113,8 @@ struct TestNetwork(

#[async_trait]
impl Network for TestNetwork {
type Db = MemDb;

type ValidatorId = TestValidatorId;
type SignatureScheme = TestSignatureScheme;
type Weights = TestWeights;
Expand Down Expand Up @@ -170,6 +174,7 @@ impl TestNetwork {
let i = u16::try_from(i).unwrap();
let TendermintHandle { messages, synced_block, synced_block_result, machine } =
TendermintMachine::new(
MemDb::new(),
TestNetwork(i, arc.clone()),
BlockNumber(1),
start_time,
Expand Down

0 comments on commit e266bc2

Please sign in to comment.