Finish transaction signing task with TX rebroadcast code

This commit is contained in:
Luke Parker 2024-09-06 04:15:02 -04:00
parent a353f9e2da
commit 100c80be9f
6 changed files with 109 additions and 23 deletions

View file

@ -278,9 +278,7 @@ impl<D: Db, M: Clone + PreprocessMachine> SigningProtocol<D, M> {
}
/// 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();
pub(crate) fn cleanup(txn: &mut impl DbTxn, id: [u8; 32]) {
Attempted::del(txn, id);
}
}

View file

@ -8,7 +8,7 @@ use frost::{Participant, sign::PreprocessMachine};
use serai_validator_sets_primitives::Session;
use serai_db::Db;
use serai_db::{DbTxn, Db};
use messages::sign::{ProcessorMessage, CoordinatorMessage};
mod individual;
@ -19,7 +19,12 @@ pub enum Response<M: PreprocessMachine> {
/// Messages to send to the coordinator.
Messages(Vec<ProcessorMessage>),
/// A produced signature.
Signature(M::Signature),
Signature {
/// The ID of the protocol this is for.
id: [u8; 32],
/// The signature.
signature: M::Signature,
},
}
/// A manager of attempts for a variety of signing protocols.
@ -55,13 +60,13 @@ impl<D: Db, M: Clone + PreprocessMachine> AttemptManager<D, 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 accordingly.
pub fn retire(&mut self, id: [u8; 32]) {
pub fn retire(&mut self, txn: &mut impl DbTxn, id: [u8; 32]) {
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);
SigningProtocol::<D, M>::cleanup(txn, id);
}
/// Handle a message for a signing protocol.
@ -90,7 +95,7 @@ impl<D: Db, M: Clone + PreprocessMachine> AttemptManager<D, M> {
return Response::Messages(vec![]);
};
match protocol.shares(id.attempt, shares) {
Ok(signature) => Response::Signature(signature),
Ok(signature) => Response::Signature { id: id.id, signature },
Err(messages) => Response::Messages(messages),
}
}

View file

@ -23,7 +23,7 @@ pub trait SignableTransaction: 'static + Sized + Send + Sync + Clone {
/// The ciphersuite used to sign this transaction.
type Ciphersuite: Ciphersuite;
/// The preprocess machine for the signing protocol for this transaction.
type PreprocessMachine: Clone + PreprocessMachine<Signature: Send>;
type PreprocessMachine: Clone + PreprocessMachine<Signature: Send + Transaction>;
/// Read a `SignableTransaction`.
fn read(reader: &mut impl io::Read) -> io::Result<Self>;

View file

@ -19,15 +19,15 @@ pub trait TransactionPublisher<S: SignableTransaction>: 'static + Send + Sync {
///
/// This MUST be an ephemeral error. Retrying publication MUST eventually resolve without manual
/// intervention/changing the arguments.
///
/// The transaction already being present in the mempool/on-chain SHOULD NOT be considered an
/// error.
type EphemeralError: Debug;
/// Publish a transaction.
///
/// This will be called multiple times, with the same transaction, until the transaction is
/// confirmed on-chain.
///
/// The transaction already being present in the mempool/on-chain MUST NOT be considered an
/// error.
async fn publish(
&self,
tx: <S::PreprocessMachine as PreprocessMachine>::Signature,

View file

@ -1 +1,11 @@
use serai_validator_sets_primitives::Session;
use serai_db::{Get, DbTxn, create_db};
create_db! {
TransactionSigner {
ActiveSigningProtocols: (session: Session) -> Vec<[u8; 32]>,
SerializedSignableTransactions: (id: [u8; 32]) -> Vec<u8>,
SerializedTransactions: (id: [u8; 32]) -> Vec<u8>,
}
}

View file

@ -1,11 +1,13 @@
use frost::dkg::ThresholdKeys;
use std::{collections::HashSet, time::{Duration, Instant}};
use frost::{dkg::ThresholdKeys, sign::PreprocessMachine};
use serai_validator_sets_primitives::Session;
use serai_db::{DbTxn, Db};
use primitives::task::ContinuallyRan;
use scheduler::{SignableTransaction, TransactionsToSign};
use scheduler::{Transaction, SignableTransaction, TransactionsToSign};
use scanner::{ScannerFeed, Scheduler};
use frost_attempt_manager::*;
@ -19,6 +21,13 @@ use crate::{
};
mod db;
use db::*;
type TransactionFor<S, Sch> = <
<
<Sch as Scheduler<S>
>::SignableTransaction as SignableTransaction>::PreprocessMachine as PreprocessMachine
>::Signature;
// Fetches transactions to sign and signs them.
pub(crate) struct TransactionTask<
@ -28,11 +37,16 @@ pub(crate) struct TransactionTask<
P: TransactionPublisher<Sch::SignableTransaction>,
> {
db: D,
publisher: P,
session: Session,
keys: Vec<ThresholdKeys<<Sch::SignableTransaction as SignableTransaction>::Ciphersuite>>,
active_signing_protocols: HashSet<[u8; 32]>,
attempt_manager:
AttemptManager<D, <Sch::SignableTransaction as SignableTransaction>::PreprocessMachine>,
publisher: P,
last_publication: Instant,
}
impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::SignableTransaction>>
@ -40,16 +54,35 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::Sign
{
pub(crate) fn new(
db: D,
publisher: P,
session: Session,
keys: Vec<ThresholdKeys<<Sch::SignableTransaction as SignableTransaction>::Ciphersuite>>,
publisher: P,
) -> Self {
let attempt_manager = AttemptManager::new(
let mut active_signing_protocols = HashSet::new();
let mut attempt_manager = AttemptManager::new(
db.clone(),
session,
keys.first().expect("creating a transaction signer with 0 keys").params().i(),
);
Self { db, session, keys, attempt_manager, publisher }
// Re-register all active signing protocols
for tx in ActiveSigningProtocols::get(&db, session).unwrap_or(vec![]) {
active_signing_protocols.insert(tx);
let signable_transaction_buf = SerializedSignableTransactions::get(&db, tx).unwrap();
let mut signable_transaction_buf = signable_transaction_buf.as_slice();
let signable_transaction = <Sch as Scheduler<S>>::SignableTransaction::read(&mut signable_transaction_buf).unwrap();
assert!(signable_transaction_buf.is_empty());
assert_eq!(signable_transaction.id(), tx);
let mut machines = Vec::with_capacity(keys.len());
for keys in &keys {
machines.push(signable_transaction.clone().sign(keys.clone()));
}
attempt_manager.register(tx, machines);
}
Self { db, publisher, session, keys, active_signing_protocols, attempt_manager, last_publication: Instant::now() }
}
}
@ -71,6 +104,15 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::Sign
};
iterated = true;
// Save this to the database as a transaction to sign
self.active_signing_protocols.insert(tx.id());
ActiveSigningProtocols::set(&mut txn, self.session, &self.active_signing_protocols.iter().copied().collect());
{
let mut buf = Vec::with_capacity(256);
tx.write(&mut buf).unwrap();
SerializedSignableTransactions::set(&mut txn, tx.id(), &buf);
}
let mut machines = Vec::with_capacity(self.keys.len());
for keys in &self.keys {
machines.push(tx.clone().sign(keys.clone()));
@ -78,6 +120,7 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::Sign
for msg in self.attempt_manager.register(tx.id(), machines) {
TransactionSignerToCoordinatorMessages::send(&mut txn, self.session, &msg);
}
txn.commit();
}
@ -89,7 +132,17 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::Sign
};
iterated = true;
self.attempt_manager.retire(id);
// Remove this as an active signing protocol
self.active_signing_protocols.remove(&id);
ActiveSigningProtocols::set(&mut txn, self.session, &self.active_signing_protocols.iter().copied().collect());
// Clean up the database
SerializedSignableTransactions::del(&mut txn, id);
SerializedTransactions::del(&mut txn, id);
// We retire with a txn so we either successfully flag this Eventuality as completed, and
// won't re-register it (making this retire safe), or we don't flag it, meaning we will
// re-register it, yet that's safe as we have yet to retire it
self.attempt_manager.retire(&mut txn, id);
// TODO: Stop rebroadcasting this transaction
txn.commit();
}
@ -109,10 +162,15 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::Sign
TransactionSignerToCoordinatorMessages::send(&mut txn, self.session, &msg);
}
}
Response::Signature(signed_tx) => {
// TODO: Save this TX to the DB
Response::Signature { id, signature: signed_tx } => {
// Save this transaction to the database
{
let mut buf = Vec::with_capacity(256);
signed_tx.write(&mut buf).unwrap();
SerializedTransactions::set(&mut txn, id, &buf);
}
// TODO: Attempt publication every minute
// TODO: On boot, reload all TXs to rebroadcast
self
.publisher
.publish(signed_tx)
@ -124,6 +182,21 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>, P: TransactionPublisher<Sch::Sign
txn.commit();
}
// If it's been five minutes since the last publication, republish the transactions for all
// active signing protocols
if Instant::now().duration_since(self.last_publication) > Duration::from_secs(5 * 60) {
for tx in &self.active_signing_protocols {
let Some(tx_buf) = SerializedTransactions::get(&self.db, *tx) else { continue };
let mut tx_buf = tx_buf.as_slice();
let tx = TransactionFor::<S, Sch>::read(&mut tx_buf).unwrap();
assert!(tx_buf.is_empty());
self.publisher.publish(tx).await.map_err(|e| format!("couldn't re-broadcast transactions: {e:?}"))?;
}
self.last_publication = Instant::now();
}
Ok(iterated)
}
}