Add swap router (#29)

* Add swap router and modify trade minimum amount calculation

This commit introduces the swap router module that provides the functionality to generate call parameters for a trade. It also modifies the `minimum_amount_out` method in `trade.rs` by adding an optional `amount_out` argument. This allows us to either use a given amount or calculate the output amount based on the current trade. The changes to the function is also reflected in all relevant test cases. The package version is updated to 0.23.0.

* Refactor test cases to use a common test utility module

Refactored the test cases across various modules to use a newly introduced common test utility module. This change reduces code duplication and simplifies the tests. The common test utility module centralizes the definition of frequently used entities such as tokens and pools.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "uniswap-v3-sdk"
-version = "0.22.0"
+version = "0.23.0"
 edition = "2021"
 authors = ["Shuhui Luo <twitter.com/aureliano_law>"]
 description = "Uniswap V3 SDK for Rust"

README.md

@@ -7,7 +7,8 @@
 A Rust SDK for building applications on top of Uniswap V3. Migration from the
 TypeScript [Uniswap/v3-sdk](https://github.com/Uniswap/v3-sdk).
 
-WIP.
+It is feature-complete with unit tests matching the TypeScript SDK. But error handling is not as graceful as one may
+expect. The error handling is still a work in progress.
 
 ## Features
 
@@ -23,7 +24,7 @@ WIP.
 Add the following to your `Cargo.toml` file:
 
 ```toml
-uniswap-v3-sdk = { version = "0.20.0", features = ["extensions"] }
+uniswap-v3-sdk = { version = "0.23.0", features = ["extensions"] }
 ```
 
 ### Usage

src/abi.rs

@@ -228,4 +228,52 @@ sol! {
                 uint256 gasEstimate
             );
     }
+
+    interface ISwapRouter {
+        struct ExactInputSingleParams {
+            address tokenIn;
+            address tokenOut;
+            uint24 fee;
+            address recipient;
+            uint256 deadline;
+            uint256 amountIn;
+            uint256 amountOutMinimum;
+            uint160 sqrtPriceLimitX96;
+        }
+
+        function exactInputSingle(ExactInputSingleParams calldata params) external payable returns (uint256 amountOut);
+
+        struct ExactInputParams {
+            bytes path;
+            address recipient;
+            uint256 deadline;
+            uint256 amountIn;
+            uint256 amountOutMinimum;
+        }
+
+        function exactInput(ExactInputParams calldata params) external payable returns (uint256 amountOut);
+
+        struct ExactOutputSingleParams {
+            address tokenIn;
+            address tokenOut;
+            uint24 fee;
+            address recipient;
+            uint256 deadline;
+            uint256 amountOut;
+            uint256 amountInMaximum;
+            uint160 sqrtPriceLimitX96;
+        }
+
+        function exactOutputSingle(ExactOutputSingleParams calldata params) external payable returns (uint256 amountIn);
+
+        struct ExactOutputParams {
+            bytes path;
+            address recipient;
+            uint256 deadline;
+            uint256 amountOut;
+            uint256 amountInMaximum;
+        }
+
+        function exactOutput(ExactOutputParams calldata params) external payable returns (uint256 amountIn);
+    }
 }

src/entities/pool.rs

@@ -450,29 +450,10 @@ impl<P> PartialEq for Pool<P> {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use uniswap_sdk_core::token;
+    use crate::tests::*;
 
     const ONE_ETHER: U256 = U256::from_limbs([10u64.pow(18), 0, 0, 0]);
 
-    static USDC: Lazy<Token> = Lazy::new(|| {
-        token!(
-            1,
-            "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-            6,
-            "USDC",
-            "USD Coin"
-        )
-    });
-    static DAI: Lazy<Token> = Lazy::new(|| {
-        token!(
-            1,
-            "0x6B175474E89094C44Da98b954EedeAC495271d0F",
-            18,
-            "DAI",
-            "DAI Stablecoin"
-        )
-    });
-
     mod constructor {
         use super::*;
 

src/entities/position.rs

@@ -451,28 +451,10 @@ impl<P> PartialEq for Position<P> {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use crate::tests::*;
     use alloy_primitives::uint;
     use once_cell::sync::Lazy;
-    use uniswap_sdk_core::token;
 
-    static USDC: Lazy<Token> = Lazy::new(|| {
-        token!(
-            1,
-            "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-            6,
-            "USDC",
-            "USD Coin"
-        )
-    });
-    static DAI: Lazy<Token> = Lazy::new(|| {
-        token!(
-            1,
-            "0x6B175474E89094C44Da98b954EedeAC495271d0F",
-            18,
-            "DAI",
-            "DAI Stablecoin"
-        )
-    });
     static POOL_SQRT_RATIO_START: Lazy<U256> =
         Lazy::new(|| encode_sqrt_ratio_x96(BigInt::from(10).pow(8), BigInt::from(10).pow(20)));
     static POOL_TICK_CURRENT: Lazy<i32> =

src/entities/route.rs

@@ -105,53 +105,12 @@ impl<TInput: CurrencyTrait, TOutput: CurrencyTrait, P> Route<TInput, TOutput, P>
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::prelude::*;
+    use crate::{prelude::*, tests::*};
     use once_cell::sync::Lazy;
-    use uniswap_sdk_core::token;
-
-    static ETHER: Lazy<Ether> = Lazy::new(|| Ether::on_chain(1));
-    static TOKEN0: Lazy<Token> =
-        Lazy::new(|| token!(1, "0x0000000000000000000000000000000000000001", 18, "t0"));
-    static TOKEN1: Lazy<Token> =
-        Lazy::new(|| token!(1, "0x0000000000000000000000000000000000000002", 18, "t1"));
-    static TOKEN2: Lazy<Token> =
-        Lazy::new(|| token!(1, "0x0000000000000000000000000000000000000003", 18, "t2"));
-    static WETH: Lazy<Token> = Lazy::new(|| WETH9::new().get(1).unwrap().clone());
 
     mod path {
         use super::*;
 
-        static POOL_0_1: Lazy<Pool<NoTickDataProvider>> = Lazy::new(|| {
-            Pool::new(
-                TOKEN0.clone(),
-                TOKEN1.clone(),
-                FeeAmount::MEDIUM,
-                encode_sqrt_ratio_x96(1, 1),
-                0,
-            )
-            .unwrap()
-        });
-        static POOL_0_WETH: Lazy<Pool<NoTickDataProvider>> = Lazy::new(|| {
-            Pool::new(
-                TOKEN0.clone(),
-                WETH.clone(),
-                FeeAmount::MEDIUM,
-                encode_sqrt_ratio_x96(1, 1),
-                0,
-            )
-            .unwrap()
-        });
-        static POOL_1_WETH: Lazy<Pool<NoTickDataProvider>> = Lazy::new(|| {
-            Pool::new(
-                TOKEN1.clone(),
-                WETH.clone(),
-                FeeAmount::MEDIUM,
-                encode_sqrt_ratio_x96(1, 1),
-                0,
-            )
-            .unwrap()
-        });
-
         #[test]
         fn constructs_a_path_from_the_tokens() {
             let route = Route::new(vec![POOL_0_1.clone()], TOKEN0.clone(), TOKEN1.clone());