Refactor implementation + docs (Argyle-Software#11)

README.md

@@ -38,6 +38,21 @@ assert!(keys.public.len() == PUBLICKEYBYTES);
 assert!(keys.expose_secret().len() == SECRETKEYBYTES);
 ```
 
+### Restoring a Keypair
+```rust
+use pqc_dilithium::*;
+use crate::params::{PUBLICKEYBYTES, SECRETKEYBYTES};
+use std::convert::TryInto;
+
+// Assuming you have public and secret key bytes
+let public_bytes: Vec<u8> = vec![0u8; PUBLICKEYBYTES]; // Example byte vectors
+let secret_bytes: Vec<u8> = vec![0u8; SECRETKEYBYTES];
+
+// Restore the keypair
+let restored_keypair = Keypair::new(public_bytes, secret_bytes);
+assert!(restored_keypair.is_ok());
+```
+
 ### Signing 
 ```rust
 let msg = "Hello".as_bytes();

src/api.rs

@@ -18,10 +18,38 @@ impl std::fmt::Debug for Keypair {
 
 pub enum SignError {
   Input,
+  ConversionFailed,
   Verify,
 }
 
 impl Keypair {
+  /// Constructs a new `Keypair` from public and secret key bytes.
+  ///
+  /// # Errors
+  /// Returns `SignError::ConversionFailed` if the byte vectors are not of the expected length.
+  ///
+  /// # Example
+  /// ```
+  /// # use pqc_dilithium::*;
+  /// # use crate::params::{PUBLICKEYBYTES, SECRETKEYBYTES};
+  /// let public = vec![0u8; PUBLICKEYBYTES];
+  /// let secret = vec![0u8; SECRETKEYBYTES];
+  /// let keypair = Keypair::new(public, secret);
+  /// assert!(keypair.is_ok());
+  /// ```
+  pub fn new(
+    pub_bytes: Vec<u8>,
+    sec_bytes: Vec<u8>,
+  ) -> Result<Self, SignError> {
+    let public = pub_bytes
+      .try_into()
+      .map_err(|_| SignError::ConversionFailed)?;
+    let secret = sec_bytes
+      .try_into()
+      .map_err(|_| SignError::ConversionFailed)?;
+    Ok(Self { public, secret })
+  }
+
   /// Explicitly expose secret key
   /// ```
   /// # use pqc_dilithium::*;
@@ -32,13 +60,6 @@ impl Keypair {
   pub fn expose_secret(&self) -> &[u8] {
     &self.secret
   }
-
-  pub fn restore(pub_bytes: Vec<u8>, sec_bytes: Vec<u8>) -> Self {
-    Self {
-      public: pub_bytes.try_into().unwrap(),
-      secret: sec_bytes.try_into().unwrap(),
-    }
-  }
 
   /// Generates a keypair for signing and verification
   ///