renaming Signable trait and method names

deltadevsde · Jul 20, 2024 · 58a1e67 · 58a1e67
1 parent 2f223ac
commit 58a1e67
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/src/da/mod.rs b/src/da/mod.rs
@@ -1,6 +1,6 @@
 use crate::{
     error::{DAResult, DeimosResult, GeneralError},
-    utils::Signable,
+    utils::SignedContent,
     zk_snark::{Bls12Proof, VerifyingKey},
 };
 use async_trait::async_trait;
@@ -22,7 +22,7 @@ pub struct EpochJson {
     pub signature: Option<String>,
 }
 
-impl Signable for EpochJson {
+impl SignedContent for EpochJson {
     fn get_signature(&self) -> DeimosResult<Signature> {
         match &self.signature {
             Some(signature) => Signature::from_str(signature)
@@ -31,7 +31,7 @@ impl Signable for EpochJson {
         }
     }
 
-    fn get_content_to_sign(&self) -> DeimosResult<String> {
+    fn get_plaintext(&self) -> DeimosResult<String> {
         let mut copy = self.clone();
         copy.signature = None;
         serde_json::to_string(&copy).map_err(|e| GeneralError::EncodingError(e.to_string()).into())

diff --git a/src/utils.rs b/src/utils.rs
@@ -110,14 +110,14 @@ pub fn validate_epoch(
     Ok(proof)
 }
 
-pub trait Signable {
+pub trait SignedContent {
     fn get_signature(&self) -> DeimosResult<Signature>;
-    fn get_content_to_sign(&self) -> DeimosResult<String>;
+    fn get_plaintext(&self) -> DeimosResult<String>;
     fn get_public_key(&self) -> DeimosResult<String>;
 }
 
 // verifies the signature of a given signable item and returns the content of the item if the signature is valid
-pub fn verify_signature<T: Signable>(
+pub fn verify_signature<T: SignedContent>(
     item: &T,
     optional_public_key: Option<String>,
 ) -> DeimosResult<String> {
@@ -129,7 +129,7 @@ pub fn verify_signature<T: Signable>(
     let public_key = decode_public_key(&public_key_str)
         .map_err(|_| DeimosError::General(GeneralError::InvalidPublicKey))?;
 
-    let content = item.get_content_to_sign()?;
+    let content = item.get_plaintext()?;
     let signature = item.get_signature()?;
 
     match public_key.verify(content.as_bytes(), &signature) {

diff --git a/src/webserver.rs b/src/webserver.rs
@@ -3,7 +3,7 @@ use crate::{
     error::{DeimosResult, GeneralError},
     node_types::sequencer::Sequencer,
     storage::{ChainEntry, IncomingEntry},
-    utils::Signable,
+    utils::SignedContent,
 };
 use axum::{
     extract::State,
@@ -73,13 +73,13 @@ pub struct UserKeyResponse {
 )]
 struct ApiDoc;
 
-impl Signable for UpdateEntryJson {
+impl SignedContent for UpdateEntryJson {
     fn get_signature(&self) -> DeimosResult<Signature> {
         Signature::from_str(self.signed_incoming_entry.as_str())
             .map_err(|e| GeneralError::ParsingError(format!("signature: {}", e)).into())
     }
 
-    fn get_content_to_sign(&self) -> DeimosResult<String> {
+    fn get_plaintext(&self) -> DeimosResult<String> {
         serde_json::to_string(&self.incoming_entry)
             .map_err(|e| GeneralError::DecodingError(e.to_string()).into())
     }