diff --git a/.gitignore b/.gitignore index e63e218a3bf..efd7916b050 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,6 @@ perf.data* *.tar.gz /bin genesis.ssz -/clippy.toml /.cargo # IntelliJ diff --git a/Makefile b/Makefile index 79fe7ea4964..b9f93942f6f 100644 --- a/Makefile +++ b/Makefile @@ -249,6 +249,7 @@ lint: -D clippy::fn_to_numeric_cast_any \ -D clippy::manual_let_else \ -D clippy::large_stack_frames \ + -D clippy::disallowed_methods \ -D warnings \ -A clippy::derive_partial_eq_without_eq \ -A clippy::upper-case-acronyms \ diff --git a/clippy.toml b/clippy.toml new file mode 100644 index 00000000000..dabcbe8bf52 --- /dev/null +++ b/clippy.toml @@ -0,0 +1,7 @@ +# Disallow preliminary slashing checks, +disallowed-methods = [ + { path = "slashing_protection::slashing_database::SlashingDatabase::preliminary_check_block_proposal", reason = "not safe for slashing checks", replacement = "slashing_protection::slashing_database::SlashingDatabase::check_and_insert_block_proposal" }, + { path = "slashing_protection::slashing_database::SlashingDatabase::preliminary_check_block_signing_root", reason = "not safe for slashing checks", replacement = "slashing_protection::slashing_database::SlashingDatabase::check_and_insert_block_signing_root" }, + { path = "slashing_protection::slashing_database::SlashingDatabase::preliminary_check_attestation", reason = "not safe for slashing checks", replacement = "slashing_protection::slashing_database::SlashingDatabase::check_and_insert_attestation" }, + { path = "slashing_protection::slashing_database::SlashingDatabase::preliminary_check_attestation_signing_root", reason = "not safe for slashing checks", replacement = "slashing_protection::slashing_database::SlashingDatabase::check_and_insert_attestation_signing_root" }, +] diff --git a/validator_client/slashing_protection/src/slashing_database.rs b/validator_client/slashing_protection/src/slashing_database.rs index 9cecdaa8a59..7d8947a5847 100644 --- a/validator_client/slashing_protection/src/slashing_database.rs +++ b/validator_client/slashing_protection/src/slashing_database.rs @@ -599,6 +599,40 @@ impl SlashingDatabase { Ok(safe) } + /// Check whether a block would be safe to sign if we were to sign it now. + /// + /// The database is not modified, and therefore multiple threads reading the database might get + /// the same result. Therefore: + /// + /// DO NOT USE THIS FUNCTION TO DECIDE IF A BLOCK IS SAFE TO SIGN! + pub fn preliminary_check_block_proposal( + &self, + validator_pubkey: &PublicKeyBytes, + block_header: &BeaconBlockHeader, + domain: Hash256, + ) -> Result { + #[allow(clippy::disallowed_methods)] + self.preliminary_check_block_signing_root( + validator_pubkey, + block_header.slot, + block_header.signing_root(domain).into(), + ) + } + + /// As for `preliminary_check_block_proposal` but without requiring the whole `BeaconBlockHeader`. + /// + /// DO NOT USE THIS FUNCTION TO DECIDE IF A BLOCK IS SAFE TO SIGN! + pub fn preliminary_check_block_signing_root( + &self, + validator_pubkey: &PublicKeyBytes, + slot: Slot, + signing_root: SigningRoot, + ) -> Result { + let mut conn = self.conn_pool.get()?; + let txn = conn.transaction_with_behavior(TransactionBehavior::Exclusive)?; + self.check_block_proposal(&txn, validator_pubkey, slot, signing_root) + } + /// Check an attestation for slash safety, and if it is safe, record it in the database. /// /// The checking and inserting happen atomically and exclusively. We enforce exclusivity @@ -670,6 +704,49 @@ impl SlashingDatabase { Ok(safe) } + /// Check whether an attestation would be safe to sign if we were to sign it now. + /// + /// The database is not modified, and therefore multiple threads reading the database might get + /// the same result. Therefore: + /// + /// DO NOT USE THIS FUNCTION TO DECIDE IF AN ATTESTATION IS SAFE TO SIGN! + pub fn preliminary_check_attestation( + &self, + validator_pubkey: &PublicKeyBytes, + attestation: &AttestationData, + domain: Hash256, + ) -> Result { + let attestation_signing_root = attestation.signing_root(domain).into(); + #[allow(clippy::disallowed_methods)] + self.preliminary_check_attestation_signing_root( + validator_pubkey, + attestation.source.epoch, + attestation.target.epoch, + attestation_signing_root, + ) + } + + /// As for `preliminary_check_attestation` but without requiring the whole `AttestationData`. + /// + /// DO NOT USE THIS FUNCTION TO DECIDE IF AN ATTESTATION IS SAFE TO SIGN! + pub fn preliminary_check_attestation_signing_root( + &self, + validator_pubkey: &PublicKeyBytes, + att_source_epoch: Epoch, + att_target_epoch: Epoch, + att_signing_root: SigningRoot, + ) -> Result { + let mut conn = self.conn_pool.get()?; + let txn = conn.transaction_with_behavior(TransactionBehavior::Exclusive)?; + self.check_attestation( + &txn, + validator_pubkey, + att_source_epoch, + att_target_epoch, + att_signing_root, + ) + } + /// Import slashing protection from another client in the interchange format. /// /// This function will atomically import the entire interchange, failing if *any*