chore(doc): Add comments and derive attributes

src/addresses.rs

@@ -175,7 +175,7 @@ lazy_static! {
 }
 
 lazy_static! {
-    /// The `MAINNET_ADDRESSES` struct holds the Uniswap contract addresses for the Goerli Testnet.
+    /// The `GOERLI_ADDRESSES` struct holds the Uniswap contract addresses for the Goerli Testnet.
     pub static ref GOERLI_ADDRESSES: ChainAddresses = {
         ChainAddresses {
             v1_mixed_route_quoter_address: Some(address!(

src/chains.rs

@@ -1,7 +1,7 @@
-#[derive(Debug, Clone, Copy)]
 /// Represents the unique identifier for different blockchain networks supported by the Uniswap SDK.
 ///
 /// Each variant corresponds to a specific blockchain network, identified by its unique chain ID.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum ChainId {
     /// The Ethereum Mainnet.
     MAINNET = 1,

src/constants.rs

@@ -2,8 +2,8 @@ use crate::prelude::*;
 use alloy_primitives::U256;
 use num_bigint::Sign;
 
-#[derive(Clone, Copy, Debug, PartialEq)]
 /// Represents the various type of trades.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum TradeType {
     /// Indicates that the trade is based on an exact input amount.
     ExactInput,
@@ -12,9 +12,8 @@ pub enum TradeType {
     ExactOutput,
 }
 
-#[derive(Clone, Debug, PartialEq, Copy)]
-
 /// Represents three various way to rounds
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum Rounding {
     /// Rounds down to the nearest whole number.
     RoundDown,

src/entities/base_currency.rs

@@ -2,10 +2,9 @@ use std::ops::Deref;
 
 use alloy_primitives::ChainId;
 
-#[derive(Clone, PartialEq, Debug)]
-
 /// `CurrencyLike` is a generic struct representing a currency with a specific chain ID,
 /// decimals, symbol, name, and additional metadata.
+#[derive(Clone, PartialEq, Debug)]
 pub struct CurrencyLike<M> {
     /// The chain ID on which this currency resides
     pub chain_id: ChainId,

src/entities/currency.rs

@@ -1,8 +1,7 @@
 use crate::prelude::*;
 
-#[derive(Clone, PartialEq, Debug)]
-
 /// This enum represnets the two type of currencies i.e native and Token
+#[derive(Clone, PartialEq, Debug)]
 pub enum Currency {
     /// Represents a native currency.
     NativeCurrency(Ether),

src/entities/fractions/fraction.rs

@@ -2,7 +2,7 @@
 use crate::prelude::*;
 use std::ops::{Add, Deref, Mul, Sub};
 
-/// struct to represent a fraction
+/// Struct representing a fraction with metadata
 #[derive(Clone, Debug)]
 pub struct FractionLike<M> {
     numerator: BigInt,
@@ -82,7 +82,7 @@ pub trait FractionBase<M>: Sized {
     /// Accessor method for retrieving metadata
     fn meta(&self) -> M;
 
-    /// Accessor method for retrieving metadata
+    /// Accessor method for retrieving the numerator
     fn numerator(&self) -> BigInt;
 
     /// Accessor method for retrieving the denominator
@@ -102,7 +102,7 @@ pub trait FractionBase<M>: Sized {
         )
     }
 
-    /// Returns the inverted [`fraction`]
+    /// Returns the inverted fraction
     fn invert(&self) -> Self {
         Self::new(self.denominator(), self.numerator(), self.meta())
     }

src/entities/token.rs

@@ -3,9 +3,8 @@ use crate::prelude::*;
 /// Represents an ERC20 token with a unique address and some metadata.
 pub type Token = CurrencyLike<TokenMeta>;
 
-#[derive(Clone, PartialEq, Debug)]
-
 /// Represents the metadata for an ERC20 token, including its address and optional fees.
+#[derive(Clone, PartialEq, Debug)]
 pub struct TokenMeta {
     /// The address of the token.
     pub address: Address,
@@ -45,7 +44,7 @@ impl CurrencyTrait for Token {
 }
 
 impl Token {
-    /// Creates a new `Token` with the given parameters.
+    /// Creates a new [`Token`] with the given parameters.
     ///
     /// # Arguments
     ///
@@ -59,7 +58,7 @@ impl Token {
     ///
     /// # Returns
     ///
-    /// A new `Token` instance.
+    /// A new [`Token`] instance.
     ///
     /// # Panics
     ///

src/error.rs

@@ -42,7 +42,7 @@ mod tests {
         assert_eq!(error.to_string(), "Addresses are equal");
     }
 
-    /// Test that `Error::MaxUint` displays the correct error messagit push ge.
+    /// Test that `Error::MaxUint` displays the correct error messagit.
     #[test]
     fn test_max_uint_error() {
         let error = Error::MaxUint;

src/utils/mod.rs

@@ -1,9 +1,5 @@
-/// Module that contains various methods to comput price
 pub mod compute_price_impact;
-
-/// Module that contains various methods to sort
 pub mod sorted_insert;
-/// Module that contains various methods to compute square root
 pub mod sqrt;
 #[cfg(feature = "validate_parse_address")]
 pub mod validate_and_parse_address;