[CONTRACTS] update/rename mwixnet onion classes (#719)

* update/rename mwixnet onion classes

* fix serialize trait errors

libwallet/src/api_impl/owner.rs

@@ -30,8 +30,8 @@ use crate::util::{OnionV3Address, OnionV3AddressError};
 use crate::api_impl::owner_updater::StatusMessage;
 use crate::contract::types::{ContractNewArgsAPI, ContractRevokeArgsAPI, ContractSetupArgsAPI};
 use crate::grin_keychain::{BlindingFactor, Identifier, Keychain, SwitchCommitmentType};
-use crate::mwmixnet::onion::create_onion;
-use crate::mwmixnet::types::{
+use crate::mwixnet::onion::create_onion;
+use crate::mwixnet::types::{
 	add_excess, new_hop, random_secret, ComSignature, Hop, MixnetReqCreationParams, SwapReq,
 };
 
@@ -1604,7 +1604,7 @@ where
 }
 
 /// Create MXMixnet request
-pub fn create_mwmixnet_req<'a, T: ?Sized, C, K>(
+pub fn create_mwixnet_req<'a, T: ?Sized, C, K>(
 	w: &mut T,
 	keychain_mask: Option<&SecretKey>,
 	params: &MixnetReqCreationParams,

libwallet/src/error.rs

@@ -67,11 +67,11 @@ pub enum Error {
 
 	/// Comsig error
 	#[error("Comsig error: {0}")]
-	ComSig(#[from] crate::mwmixnet::onion::crypto::comsig::ComSigError),
+	ComSig(#[from] crate::mwixnet::onion::crypto::comsig::ComSigError),
 
-	/// MwMixnet Onion error
+	/// mwixnet Onion error
 	#[error("Onion error: {0}")]
-	Onion(#[from] crate::mwmixnet::onion::onion::OnionError),
+	Onion(#[from] crate::mwixnet::onion::onion::OnionError),
 
 	/// Callback implementation error conversion
 	#[error("Trait Implementation error")]

libwallet/src/lib.rs

@@ -52,7 +52,7 @@ mod slate;
 pub mod slate_versions;
 pub mod slatepack;
 
-pub mod mwmixnet;
+pub mod mwixnet;
 mod types;
 
 pub use crate::error::Error;

libwallet/src/mwixnet/onion/crypto/comsig.rs

@@ -33,10 +33,8 @@ pub struct ComSignature {
 /// Error types for Commitment Signatures
 #[derive(Error, Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
 pub enum ComSigError {
-	/// Invalid com sig
 	#[error("Commitment signature is invalid")]
 	InvalidSig,
-	/// SECP Error Wrapper
 	#[error("Secp256k1zkp error: {0:?}")]
 	Secp256k1zkp(secp256k1zkp::Error),
 }
@@ -48,7 +46,6 @@ impl From<secp256k1zkp::Error> for ComSigError {
 }
 
 impl ComSignature {
-	/// Create new Com signature from commit and keys
 	pub fn new(pub_nonce: &Commitment, s: &SecretKey, t: &SecretKey) -> ComSignature {
 		ComSignature {
 			pub_nonce: pub_nonce.to_owned(),
@@ -58,7 +55,6 @@ impl ComSignature {
 	}
 
 	#[allow(dead_code)]
-	/// Sign com signature with kernel values
 	pub fn sign(
 		amount: u64,
 		blind: &SecretKey,
@@ -92,7 +88,6 @@ impl ComSignature {
 	}
 
 	#[allow(non_snake_case)]
-	/// Verify a com sig
 	pub fn verify(&self, commit: &Commitment, msg: &Vec<u8>) -> Result<(), ComSigError> {
 		let secp = Secp256k1::with_caps(ContextFlag::Commit);
 

libwallet/src/mwixnet/onion/crypto/dalek.rs

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Dalek key wrapper for mwmixnet primitives
+//! Dalek key wrapper for mwixnet primitives
 
 use super::secp::SecretKey;
 
@@ -183,7 +183,7 @@ pub fn sign(sk: &SecretKey, message: &[u8]) -> Result<DalekSignature, DalekError
 #[cfg(test)]
 mod tests {
 	use super::*;
-	use crate::mwmixnet::onion::test_util::rand_keypair;
+	use crate::mwixnet::onion::test_util::rand_keypair;
 	use grin_core::ser::{self, ProtocolVersion};
 	use grin_util::ToHex;
 	use rand::Rng;

libwallet/src/mwixnet/onion/onion.rs

@@ -12,11 +12,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Onion defn for mwmixnet
+//! Onion defn for mwixnet
 
 use super::crypto::secp::{self, Commitment, RangeProof, SecretKey};
 use super::util::{read_optional, vec_to_array, write_optional};
 
+use std::convert::TryFrom;
+use std::fmt;
+use std::hash::{Hash, Hasher};
+use std::result::Result;
+
 use chacha20::cipher::{NewCipher, StreamCipher};
 use chacha20::{ChaCha20, Key, Nonce};
 use grin_core::core::FeeFields;
@@ -27,15 +32,11 @@ use hmac::{Hmac, Mac};
 use serde::ser::SerializeStruct;
 use serde::Deserialize;
 use sha2::Sha256;
-use std::convert::TryFrom;
-use std::fmt;
-use std::hash::{Hash, Hasher};
-use std::result::Result;
 use thiserror::Error;
 use x25519_dalek::{PublicKey as xPublicKey, SharedSecret, StaticSecret};
 
 type HmacSha256 = Hmac<Sha256>;
-/// Wrap u8 vec
+/// Raw bytes alias
 pub type RawBytes = Vec<u8>;
 
 const CURRENT_ONION_VERSION: u8 = 0;
@@ -75,24 +76,24 @@ impl Hash for Onion {
 /// A single, decrypted/peeled layer of an Onion.
 #[derive(Debug, Clone)]
 pub struct Payload {
-	/// next ephemeral pk
+	/// PK of next server
 	pub next_ephemeral_pk: xPublicKey,
-	/// excess
+	/// Excess calculation
 	pub excess: SecretKey,
-	/// fee
+	/// Fee
 	pub fee: FeeFields,
-	/// proof
+	/// Rangeproof
 	pub rangeproof: Option<RangeProof>,
 }
 
 impl Payload {
-	/// Deser a payload
+	/// Deserialize
 	pub fn deserialize(bytes: &Vec<u8>) -> Result<Payload, ser::Error> {
 		let payload: Payload = ser::deserialize_default(&mut &bytes[..])?;
 		Ok(payload)
 	}
 
-	/// Serialize a payload
+	/// Serialize
 	pub fn serialize(&self) -> Result<Vec<u8>, ser::Error> {
 		let mut vec = vec![];
 		ser::serialize_default(&mut vec, &self)?;
@@ -142,7 +143,7 @@ pub struct PeeledOnion {
 }
 
 impl Onion {
-	/// Serialize onion
+	/// Serialize to binary
 	pub fn serialize(&self) -> Result<Vec<u8>, ser::Error> {
 		let mut vec = vec![];
 		ser::serialize_default(&mut vec, &self)?;
@@ -189,7 +190,7 @@ impl Onion {
 	}
 }
 
-/// Create new stream cypher from shared secret
+/// Create a new stream cipher
 pub fn new_stream_cipher(shared_secret: &SharedSecret) -> Result<ChaCha20, OnionError> {
 	let mut mu_hmac = HmacSha256::new_from_slice(b"MWIXNET")?;
 	mu_hmac.update(shared_secret.as_bytes());
@@ -329,19 +330,19 @@ pub enum OnionError {
 	/// Invalid Key Length
 	#[error("Invalid key length for MAC initialization")]
 	InvalidKeyLength,
-	/// Serialization error
+	/// Serialization Error
 	#[error("Serialization error occurred: {0:?}")]
 	SerializationError(ser::Error),
-	/// Deserialization error
+	/// Deserialization Error
 	#[error("Deserialization error occurred: {0:?}")]
 	DeserializationError(ser::Error),
 	/// Error calculating blinding factor
 	#[error("Error calculating blinding factor: {0:?}")]
 	CalcBlindError(secp256k1zkp::Error),
-	/// Error calculating ephemeral key
+	/// Error calculating ephemeral pubkey
 	#[error("Error calculating ephemeral pubkey: {0:?}")]
 	CalcPubKeyError(secp256k1zkp::Error),
-	/// Error calculating commitment
+	/// Error calculating commit
 	#[error("Error calculating commitment: {0:?}")]
 	CalcCommitError(secp256k1zkp::Error),
 }
@@ -361,8 +362,8 @@ impl From<ser::Error> for OnionError {
 #[cfg(test)]
 pub mod tests {
 	use super::*;
-	use crate::mwmixnet::onion::crypto::secp::random_secret;
-	use crate::mwmixnet::onion::{new_hop, Hop};
+	use crate::mwixnet::onion::crypto::secp::random_secret;
+	use crate::mwixnet::onion::{new_hop, Hop};
 
 	use grin_core::core::FeeFields;
 
@@ -408,12 +409,12 @@ pub mod tests {
 			hops.push(hop);
 		}
 
-		let mut onion_packet = crate::mwmixnet::onion::create_onion(&commitment, &hops).unwrap();
+		let mut onion_packet = crate::mwixnet::onion::create_onion(&commitment, &hops).unwrap();
 
 		let mut payload = Payload {
 			next_ephemeral_pk: onion_packet.ephemeral_pubkey.clone(),
 			excess: random_secret(),
-			fee: FeeFields::from(fee_per_hop as u32),
+			fee: FeeFields::from(fee_per_hop),
 			rangeproof: None,
 		};
 		for i in 0..5 {
@@ -425,6 +426,6 @@ pub mod tests {
 		assert!(payload.rangeproof.is_some());
 		assert_eq!(payload.rangeproof.unwrap(), hops[4].rangeproof.unwrap());
 		assert_eq!(secp::commit(out_value, &final_blind).unwrap(), final_commit);
-		assert_eq!(payload.fee, FeeFields::from(fee_per_hop as u32));
+		assert_eq!(payload.fee, FeeFields::from(fee_per_hop));
 	}
 }

libwallet/src/mwixnet/onion/util.rs

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Util fns for mwmixnet
+//! Util fns for mwixnet
 //! TODO: possibly redundant, check or move elsewhere
 
 use grin_core::ser::{self, Readable, Reader, Writeable, Writer};
@@ -37,7 +37,7 @@ use std::convert::TryInto;
 /// # Example
 ///
 /// ```
-///	use grin_wallet_libwallet::mwmixnet::onion::util::write_optional;
+///	use grin_wallet_libwallet::mwixnet::onion::util::write_optional;
 /// let mut writer:Vec<u8> = vec![];
 /// let optional_value: Option<u32> = Some(10);
 /// //write_optional(&mut writer, &optional_value);
@@ -75,7 +75,7 @@ pub fn write_optional<O: Writeable, W: Writer>(
 /// # Example
 ///
 /// ```
-///	use grin_wallet_libwallet::mwmixnet::onion::util::read_optional;
+///	use grin_wallet_libwallet::mwixnet::onion::util::read_optional;
 /// use grin_core::ser::{BinReader, ProtocolVersion, DeserializationMode};
 /// let mut buf: &[u8] = &[1, 0, 0, 0, 10];
 /// let mut reader = BinReader::new(&mut buf, ProtocolVersion::local(), DeserializationMode::default());
@@ -106,7 +106,7 @@ pub fn read_optional<O: Readable, R: Reader>(reader: &mut R) -> Result<Option<O>
 /// # Example
 ///
 /// ```
-///	use grin_wallet_libwallet::mwmixnet::onion::util::vec_to_array;
+///	use grin_wallet_libwallet::mwixnet::onion::util::vec_to_array;
 /// let v = vec![0, 1, 2, 3, 4, 5];
 /// let a = vec_to_array::<4>(&v).unwrap();
 /// assert_eq!(a, [0, 1, 2, 3]);

libwallet/src/mwixnet/types.rs

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Types related to mwmixnet requests required by rest of lib crate apis
+//! Types related to mwixnet requests required by rest of lib crate apis
 //! Should rexport all needed types here
 
 pub use super::onion::crypto::comsig::{self, ComSignature};
@@ -32,7 +32,7 @@ pub struct SwapReq {
 	pub onion: Onion,
 }
 
-/// MWMixnetRequest Creation Params
+/// mwixnetRequest Creation Params
 
 pub struct MixnetReqCreationParams {
 	/// List of all the server keys

libwallet/src/types.rs

@@ -791,7 +791,7 @@ pub enum TxLogEntryType {
 	TxReceivedCancelled,
 	/// Sent transaction that was rolled back by user
 	TxSentCancelled,
-	/// Self spend, as per contracts and mwmixnet
+	/// Self spend, as per contracts and mwixnet
 	TxSelfSpend,
 	/// Self Spend Cancelled (has to happen before sent to chain, flag rather than delete)
 	TxSelfSpendCancelled,