Cleanup DB handling a bit in key-gen/attempt-manager

This commit is contained in:
Luke Parker
2024-08-19 00:41:18 -04:00
parent 1e8a9ec5bd
commit 2f3bd7a02a
6 changed files with 77 additions and 27 deletions

View File

@@ -9,11 +9,19 @@ use frost::{
use serai_validator_sets_primitives::Session;
use serai_db::{Get, DbTxn, Db, create_db};
use messages::sign::{SignId, ProcessorMessage};
create_db!(
FrostAttemptManager {
Attempted: (id: [u8; 32]) -> u32,
}
);
/// An instance of a signing protocol with re-attempts handled internally.
#[allow(clippy::type_complexity)]
pub(crate) struct SigningProtocol<M: Clone + PreprocessMachine> {
pub(crate) struct SigningProtocol<D: Db, M: Clone + PreprocessMachine> {
db: D,
// The session this signing protocol is being conducted by.
session: Session,
// The `i` of our first, or starting, set of key shares we will be signing with.
@@ -34,12 +42,19 @@ pub(crate) struct SigningProtocol<M: Clone + PreprocessMachine> {
>,
}
impl<M: Clone + PreprocessMachine> SigningProtocol<M> {
impl<D: Db, M: Clone + PreprocessMachine> SigningProtocol<D, M> {
/// Create a new signing protocol.
pub(crate) fn new(session: Session, start_i: Participant, id: [u8; 32], root: Vec<M>) -> Self {
pub(crate) fn new(
db: D,
session: Session,
start_i: Participant,
id: [u8; 32],
root: Vec<M>,
) -> Self {
log::info!("starting signing protocol {}", hex::encode(id));
Self {
db,
session,
start_i,
id,
@@ -70,7 +85,15 @@ impl<M: Clone + PreprocessMachine> SigningProtocol<M> {
We also won't send the share we were supposed to, unfortunately, yet caching/reloading the
preprocess has enough safety issues it isn't worth the headache.
*/
// TODO
{
let mut txn = self.db.txn();
let prior_attempted = Attempted::get(&txn, self.id);
if Some(attempt) <= prior_attempted {
return vec![];
}
Attempted::set(&mut txn, self.id, &attempt);
txn.commit();
}
log::debug!("attemting a new instance of signing protocol {}", hex::encode(self.id));
@@ -248,4 +271,11 @@ impl<M: Clone + PreprocessMachine> SigningProtocol<M> {
Ok(signature)
}
/// Cleanup the database entries for a specified signing protocol.
pub(crate) fn cleanup(db: &mut D, id: [u8; 32]) {
let mut txn = db.txn();
Attempted::del(&mut txn, id);
txn.commit();
}
}

View File

@@ -8,6 +8,7 @@ use frost::{Participant, sign::PreprocessMachine};
use serai_validator_sets_primitives::Session;
use serai_db::Db;
use messages::sign::{ProcessorMessage, CoordinatorMessage};
mod individual;
@@ -22,21 +23,28 @@ pub enum Response<M: PreprocessMachine> {
}
/// A manager of attempts for a variety of signing protocols.
pub struct AttemptManager<M: Clone + PreprocessMachine> {
pub struct AttemptManager<D: Db, M: Clone + PreprocessMachine> {
db: D,
session: Session,
start_i: Participant,
active: HashMap<[u8; 32], SigningProtocol<M>>,
active: HashMap<[u8; 32], SigningProtocol<D, M>>,
}
impl<M: Clone + PreprocessMachine> AttemptManager<M> {
impl<D: Db, M: Clone + PreprocessMachine> AttemptManager<D, M> {
/// Create a new attempt manager.
pub fn new(session: Session, start_i: Participant) -> Self {
AttemptManager { session, start_i, active: HashMap::new() }
pub fn new(db: D, session: Session, start_i: Participant) -> Self {
AttemptManager { db, session, start_i, active: HashMap::new() }
}
/// Register a signing protocol to attempt.
pub fn register(&mut self, id: [u8; 32], machines: Vec<M>) {
self.active.insert(id, SigningProtocol::new(self.session, self.start_i, id, machines));
///
/// This ID must be unique across all sessions, attempt managers, protocols, etc.
pub fn register(&mut self, id: [u8; 32], machines: Vec<M>) -> Vec<ProcessorMessage> {
let mut protocol =
SigningProtocol::new(self.db.clone(), self.session, self.start_i, id, machines);
let messages = protocol.attempt(0);
self.active.insert(id, protocol);
messages
}
/// Retire a signing protocol.
@@ -45,10 +53,13 @@ impl<M: Clone + PreprocessMachine> AttemptManager<M> {
/// This does not stop the protocol from being re-registered and further worked on (with
/// undefined behavior) then. The higher-level context must never call `register` again with this
/// ID.
// TODO: Also have the DB for this SigningProtocol cleaned up here.
pub fn retire(&mut self, id: [u8; 32]) {
log::info!("retiring signing protocol {}", hex::encode(id));
self.active.remove(&id);
if self.active.remove(&id).is_none() {
log::info!("retiring protocol {}, which we didn't register/already retired", hex::encode(id));
} else {
log::info!("retired signing protocol {}", hex::encode(id));
}
SigningProtocol::<D, M>::cleanup(&mut self.db, id);
}
/// Handle a message for a signing protocol.