add swap sim example

.gitignore

@@ -1,3 +1,4 @@
 /target
 /contracts/out
 /cache
+/note.md

README.md

@@ -5,11 +5,48 @@ Tests are still being written, assume bugs until tested. If you would like to he
 
 # cfmms-rs
 
+`cfmms-rs` is a vertically integrated library for interacting with CFMMs (constant function market makers) on Ethereum. Features include:
+- batch sync token pair data from Uniswap V2 and V3 through optimized smart contracts that minimize the number of RPC calls
+- calculate token pair spot prices and simulate token swaps
+- execute transactions 
 Sync pairs simulate swaps, and interact with constant function market makers on Ethereum.
 
 - [Crates.io](https://crates.io/crates/cfmms)
 - [Documentation in progress](https://docs.rs/cfmms/0.1.3/cfmms/)
 
+## Project Layout
+```./
+├── src/
+│   ├── batch_requests/
+        |── uniswap_v2/
+        |── uniswap_v3/
+│   ├── dex/
+        |── mod.rs
+        |── uniswap_v2.rs
+        |── uniswap_v3.rs
+│   ├── pool/
+        |── mod.rs
+        |── uniswap_v2.rs
+        |── uniswap_v3.rs
+│   ├── abi.rs
+│   ├── checkpoint.rs
+│   ├── errors.rs
+│   ├── lib.rs
+│   ├── sync.rs
+│   └── throttle.rs
+├── Cargo.lock
+├── Cargo.toml
+├── foundry.toml
+└── README.md
+```
+
+The core logic is contained in the following files:
+* batch_requests - handles batch pool requests to the Ethereum endpoint using solidity contracts in `contracts/`
+* dex - contains interfaces that handle dex invariants
+* pool - contains pool interfaces that handle pools based on dex invariants
+* abi - generates bindings for the UniswapV2 and UniswapV3 contracts
+* sync - syncs multiple pool states between all dexes
+
 
 ## Supported Dexes
 
@@ -18,8 +55,12 @@ Sync pairs simulate swaps, and interact with constant function market makers on
 | UniswapV2 variants  | ✅||
 | UniswapV3  | ✅||
 
+## Build, Run Tests, and Examples
+1. In order to build, clone the github repo:
+`git clone https://github.com/paradigmxyz/artemis
+cd artemis`
 
-## Running Examples
+2. Run tests with cargo `cargo test --all`
 
-To run any of the examples, first set a local environment variable called `ETHEREUM_MAINNET_ENDPOINT`. Then you can simply run `cargo run --example <example_name>`.
+3. To run any of the examples, first set a local environment variable called `ETHEREUM_MAINNET_ENDPOINT`. Then you can simply run `cargo run --example <example_name>`.
 

examples/calculate-price.rs

@@ -0,0 +1,53 @@
+use std::{error::Error, str::FromStr, sync::Arc};
+
+use ethers::{
+    prelude::abigen,
+    providers::{Http, Middleware, Provider},
+    types::H160,
+};
+
+use cfmms::abi::IUniswapV3Pool;
+use cfmms::pool::UniswapV3Pool;
+
+abigen!(
+    IQuoter,
+r#"[
+    function quoteExactInputSingle(address tokenIn, address tokenOut,uint24 fee, uint256 amountIn, uint160 sqrtPriceLimitX96) external returns (uint256 amountOut)
+]"#;);
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn Error>> {
+    // load rpc endpoint from local environment
+    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")?;
+
+    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint)?);
+
+    //Instantiate Pools and Quoter
+    let mut pool = UniswapV3Pool::new_from_address(
+        H160::from_str("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640")?, // univ3 usdc/weth pool
+        provider.clone(),
+    )
+    .await?;
+
+    pool.get_pool_data(provider.clone()).await?;
+
+    let block_pool = IUniswapV3Pool::new(
+        H160::from_str("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640")?,
+        provider.clone(),
+    );
+
+    let current_block = provider.get_block_number().await?;
+
+    let sqrt_price = block_pool.slot_0().block(current_block).call().await?.0;
+    pool.sqrt_price = sqrt_price;
+
+    let float_price_a = pool.calculate_price(pool.token_a);
+
+    let float_price_b = pool.calculate_price(pool.token_b);
+
+    println!("Current Block: {current_block}");
+    println!("Price A: {float_price_a}");
+    println!("Price B: {float_price_b}");
+
+    Ok(())
+}

examples/create-new-pool.rs

@@ -10,21 +10,20 @@ use cfmms::{dex::DexVariant, pool::Pool};
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     //Add rpc endpoint here:
-    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")
-        .expect("Could not get ETHEREUM_MAINNET_ENDPOINT");
-    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint).unwrap());
+    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")?;
+    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint)?);
 
     //UniswapV2 usdc weth pool on Eth mainnet
     let _uniswap_v2_usdc_weth_pool = Pool::new_from_address(
-        H160::from_str("0xB4e16d0168e52d35CaCD2c6185b44281Ec28C9Dc").unwrap(),
+        H160::from_str("0xB4e16d0168e52d35CaCD2c6185b44281Ec28C9Dc")?,
         DexVariant::UniswapV2,
         provider.clone(),
     )
     .await?;
 
     //UniswapV3 usdc weth pool on Eth mainnet
     let _uniswap_v3_usdc_weth_pool = Pool::new_from_address(
-        H160::from_str("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640").unwrap(),
+        H160::from_str("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640")?,
         DexVariant::UniswapV3,
         provider.clone(),
     )

examples/generate-mainnet-checkpoint.rs

@@ -13,14 +13,13 @@ use cfmms::{
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     //Add rpc endpoint here:
-    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")
-        .expect("Could not get ETHEREUM_MAINNET_ENDPOINT");
-    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint).unwrap());
+    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")?;
+    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint)?);
 
     let dexes = vec![
         //Add Sushiswap
         Dex::new(
-            H160::from_str("0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac").unwrap(),
+            H160::from_str("0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac")?,
             DexVariant::UniswapV2,
             10794229,
             Some(300),

examples/sim-swap.rs

@@ -0,0 +1,63 @@
+use std::{error::Error, str::FromStr, sync::Arc};
+
+use ethers::{
+    prelude::abigen,
+    providers::{Http, Middleware, Provider},
+    types::{H160, U256},
+};
+
+use cfmms::pool::UniswapV3Pool;
+
+abigen!(
+    IQuoter,
+r#"[
+    function quoteExactInputSingle(address tokenIn, address tokenOut,uint24 fee, uint256 amountIn, uint160 sqrtPriceLimitX96) external returns (uint256 amountOut)
+]"#;);
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn Error>> {
+    // load rpc endpoint from local environment
+    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")?;
+
+    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint)?);
+
+    //Instantiate Pools and Quoter
+    let pool = UniswapV3Pool::new_from_address(
+        H160::from_str("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640")?, // univ3 usdc/weth pool
+        provider.clone(),
+    )
+    .await?;
+
+    let quoter = IQuoter::new(
+        H160::from_str("0xb27308f9f90d607463bb33ea1bebb41c27ce5ab6")?,
+        provider.clone(),
+    );
+
+    let amount_in = U256::from_dec_str("1000000000000000000")?; // 1 WETH
+
+    let current_block = provider.get_block_number().await?;
+    let amount_out = pool
+        .simulate_swap(pool.token_b, amount_in, provider.clone())
+        .await?;
+
+    let expected_amount_out = quoter
+        .quote_exact_input_single(
+            pool.token_b,
+            pool.token_a,
+            pool.fee,
+            amount_in,
+            U256::zero(),
+        )
+        .block(current_block)
+        .call()
+        .await?;
+
+    assert_eq!(amount_out, expected_amount_out);
+
+    println!(
+        "Current block: {} Amount in: {} Amount out: {} Expected amount out: {}",
+        current_block, amount_in, amount_out, expected_amount_out
+    );
+
+    Ok(())
+}

examples/sync-pairs-with-ipc.rs

@@ -23,21 +23,21 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let dexes = vec![
         //UniswapV2
         Dex::new(
-            H160::from_str("0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f").unwrap(),
+            H160::from_str("0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f")?,
             DexVariant::UniswapV2,
             2638438,
             Some(300),
         ),
         //Add Sushiswap
         Dex::new(
-            H160::from_str("0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac").unwrap(),
+            H160::from_str("0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac")?,
             DexVariant::UniswapV2,
             10794229,
             Some(300),
         ),
         //Add UniswapV3
         Dex::new(
-            H160::from_str("0x1F98431c8aD98523631AE4a59f267346ea31F984").unwrap(),
+            H160::from_str("0x1F98431c8aD98523631AE4a59f267346ea31F984")?,
             DexVariant::UniswapV3,
             12369621,
             None,

examples/sync-pairs-with-throttle.rs

@@ -13,14 +13,13 @@ use cfmms::{
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     //Add rpc endpoint here:
-    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")
-        .expect("Could not get ETHEREUM_MAINNET_ENDPOINT");
-    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint).unwrap());
+    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")?;
+    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint)?);
 
     let dexes = vec![
         //Add UniswapV3
         Dex::new(
-            H160::from_str("0x1F98431c8aD98523631AE4a59f267346ea31F984").unwrap(),
+            H160::from_str("0x1F98431c8aD98523631AE4a59f267346ea31F984")?,
             DexVariant::UniswapV3,
             12369621,
             None,

examples/sync-pairs.rs

@@ -13,28 +13,27 @@ use cfmms::{
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     //Add rpc endpoint here:
-    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")
-        .expect("Could not get ETHEREUM_MAINNET_ENDPOINT");
-    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint).unwrap());
+    let rpc_endpoint = std::env::var("ETHEREUM_MAINNET_ENDPOINT")?;
+    let provider = Arc::new(Provider::<Http>::try_from(rpc_endpoint)?);
 
     let dexes = vec![
         //UniswapV2
         Dex::new(
-            H160::from_str("0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f").unwrap(),
+            H160::from_str("0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f")?,
             DexVariant::UniswapV2,
             2638438,
             Some(300),
         ),
         //Add Sushiswap
         Dex::new(
-            H160::from_str("0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac").unwrap(),
+            H160::from_str("0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac")?,
             DexVariant::UniswapV2,
             10794229,
             Some(300),
         ),
         //Add UniswapV3
         Dex::new(
-            H160::from_str("0x1F98431c8aD98523631AE4a59f267346ea31F984").unwrap(),
+            H160::from_str("0x1F98431c8aD98523631AE4a59f267346ea31F984")?,
             DexVariant::UniswapV3,
             12369621,
             None,

src/lib.rs

@@ -1,4 +1,4 @@
-mod abi;
+pub mod abi;
 pub mod checkpoint;
 pub mod dex;
 pub mod errors;