Merge pull request #300 from propeller-heads/rfq/dc/ENG-4698-add-execution-quickstart

feat: Add execution to RFQ quickstart

Author: tamaralipows

Cargo.lock

@@ -48,8 +48,8 @@ mini-moka = "0.10"
 lazy_static = "1.4.0"
 
 # Tycho dependencies
-tycho-common = "0.81.0"
-tycho-client = "0.81.0"
+tycho-common = "0.81.5"
+tycho-client = "0.81.5"
 
 # EVM dependencies
 foundry-config = { git = "https://github.com/foundry-rs/foundry", rev = "5a552bb0de7126fa35170fd84532bbd3d40cd348", optional = true }
@@ -97,7 +97,7 @@ unicode-width = "0.1.13"
 tracing-appender = "0.2.3"
 
 # tycho execution for quickstart
-tycho-execution = "0.112.0"
+tycho-execution = "0.116.0"
 
 [features]
 default = ["evm", "rfq"]

Cargo.toml

@@ -12,7 +12,8 @@ export RPC_URL=<your-rpc-url>
 cargo run --release --example quickstart
 ```
 
-By default, the example will trade 10 USDC -> WETH on Ethereum Mainnet. Setting the chain will by default trade 10 USDC -> WETH on that chain.
+By default, the example will trade 10 USDC -> WETH on Ethereum Mainnet. Setting the chain will by default trade 10
+USDC -> WETH on that chain.
 If you want a different trade or chain, you can do:
 
 ```bash
@@ -22,11 +23,12 @@ cargo run --release --example quickstart -- --sell-token "0x833589fCD6eDb6E08f4c
 
 for 10 USDC -> WETH on Base.
 
-To be able to execute or simulate the best swap, you need to pass your private key. Assuming your private key is stored in your PK env var:
+To be able to execute or simulate the best swap, you need to pass your private key. Assuming your private key is stored
+in your PK env var:
 
 ```bash
 cargo run --release --example quickstart -- --swapper-pk $PK
 ```
 
-See [here](https://docs.propellerheads.xyz/tycho/for-solvers/tycho-quickstart) a complete guide on how to run the
+See [here](https://docs.propellerheads.xyz/tycho) a complete guide on how to run the
 Quickstart example.

examples/quickstart/Readme.md

@@ -32,7 +32,7 @@ use tycho_execution::encoding::{
     errors::EncodingError,
     evm::{approvals::permit2::PermitSingle, encoder_builders::TychoRouterEncoderBuilder},
     models,
-    models::{EncodedSolution, Solution, Swap, Transaction, UserTransferType},
+    models::{EncodedSolution, Solution, SwapBuilder, Transaction, UserTransferType},
 };
 use tycho_simulation::{
     evm::{
@@ -73,15 +73,15 @@ struct Cli {
     #[arg(long, default_value = FAKE_PK)]
     swapper_pk: String,
     #[arg(long, default_value = "ethereum")]
-    chain: String,
+    chain: Chain,
 }
 
 impl Cli {
     fn with_defaults(mut self) -> Self {
         // By default, we swap a small amount of USDC to WETH on whatever chain we choose
 
         if self.buy_token.is_none() {
-            self.buy_token = Some(match self.chain.as_str() {
+            self.buy_token = Some(match self.chain.to_string().as_str() {
                 "ethereum" => "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2".to_string(),
                 "base" => "0x4200000000000000000000000000000000000006".to_string(),
                 "unichain" => "0x4200000000000000000000000000000000000006".to_string(),
@@ -90,7 +90,7 @@ impl Cli {
         }
 
         if self.sell_token.is_none() {
-            self.sell_token = Some(match self.chain.as_str() {
+            self.sell_token = Some(match self.chain.to_string().as_str() {
                 "ethereum" => "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48".to_string(),
                 "base" => "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913".to_string(),
                 "unichain" => "0x078d782b760474a361dda0af3839290b0ef57ad6".to_string(),
@@ -111,8 +111,7 @@ async fn main() {
 
     let cli = Cli::parse().with_defaults();
 
-    let chain = Chain::from_str(&cli.chain)
-        .unwrap_or_else(|_| panic!("Unknown chain {chain}", chain = cli.chain));
+    let chain = cli.chain;
 
     let tycho_url = env::var("TYCHO_URL").unwrap_or_else(|_| {
         get_default_url(&chain)
@@ -236,10 +235,8 @@ async fn main() {
     )
     .expect("Failed to private key signer");
     let tx_signer = EthereumWallet::from(wallet.clone());
-    let named_chain =
-        NamedChain::from_str(&cli.chain.replace("ethereum", "mainnet")).expect("Invalid chain");
     let provider = ProviderBuilder::default()
-        .with_chain(named_chain)
+        .with_chain(NamedChain::try_from(chain.id()).expect("Invalid chain"))
         .wallet(tx_signer.clone())
         .connect(&env::var("RPC_URL").expect("RPC_URL env var not set"))
         .await
@@ -288,7 +285,7 @@ async fn main() {
                 .clone();
 
             let tx = encode_tycho_router_call(
-                named_chain.into(),
+                chain.id(),
                 encoded_solution.clone(),
                 &solution,
                 chain.native_token().address,
@@ -381,7 +378,7 @@ async fn main() {
                         wallet.address(),
                         Address::from_slice(&sell_token_address),
                         tx.clone(),
-                        named_chain as u64,
+                        chain.id(),
                     )
                     .await;
 
@@ -434,7 +431,7 @@ async fn main() {
                                     wallet.address(),
                                     &sell_token_address,
                                     tx.clone(),
-                                    named_chain as u64,
+                                    chain.id(),
                                 )
                                 .await
                                 {
@@ -478,7 +475,7 @@ async fn main() {
                         wallet.address(),
                         &sell_token_address,
                         tx,
-                        named_chain as u64,
+                        chain.id(),
                     )
                     .await
                     {
@@ -608,16 +605,8 @@ fn create_solution(
     expected_amount: BigUint,
 ) -> Solution<'static> {
     // Prepare data to encode. First we need to create a swap object
-    let simple_swap = Swap::new(
-        component,
-        sell_token.address.clone(),
-        buy_token.address.clone(),
-        // Split defines the fraction of the amount to be swapped. A value of 0 indicates 100% of
-        // the amount or the total remaining balance.
-        0f64,
-        None,
-        None,
-    );
+    let simple_swap =
+        SwapBuilder::new(component, sell_token.address.clone(), buy_token.address.clone()).build();
 
     // Compute a minimum amount out
     //

examples/quickstart/main.rs

@@ -10,33 +10,37 @@ This quickstart guide enables you to:
 You need to set up the WebSocket credentials of the desired RFQs to access live pricing data:
 
 ```bash
-export BEBOP_WS_USER=<your-bebop-ws-username>
-export BEBOP_WS_KEY=<your-bebop-ws-key>
+export BEBOP_USER=<your-bebop-ws-username>
+export BEBOP_KEY=<your-bebop-ws-key>
 cargo run --release --example rfq_quickstart
 ```
 
 By default, the example will request price levels for 10 USDC -> WETH on Ethereum Mainnet using RFQs.
 If we choose a different chain, by default, price levels for USDC -> WETH will be requested on that chain.
-If you want a different trade and chain, you can use the following command, replacing the values with the token and chain that you'd like:
+If you want a different trade and chain, you can use the following command, replacing the values with the token and
+chain that you'd like:
 
 ```bash
-export BEBOP_WS_USER=<your-bebop-ws-username>
-export BEBOP_WS_KEY=<your-bebop-ws-key>
+export BEBOP_USER=<your-bebop-ws-username>
+export BEBOP_KEY=<your-bebop-ws-key>
 cargo run --release --example rfq_quickstart -- --sell-token "0x50c5725949A6F0c72E6C4a641F24049A917DB0Cb" --buy-token "0x4200000000000000000000000000000000000006" --sell-amount 10 --chain "base"
 ```
 
 for 10 USDC -> WETH on Base.
 
 ## Important Notes
 
-- **Credentials**: Contact RFQ protocols directly to obtain WebSocket API credentials for accessing live market maker quotes
+- **Credentials**: Contact RFQ protocols directly to obtain WebSocket API credentials for accessing live market maker
+  quotes
 
 ## What you'll see
 
 The example will:
+
 1. Connect to the RFQ's WebSocket API using your credentials
 2. Stream live price quotes from market makers for your specified token pair
 3. Display the best available quotes with pricing information
 
+TODO: update this once docs are merged
 See [here](https://docs.propellerheads.xyz/tycho/for-solvers/tycho-quickstart) a complete guide on how to run the
 Quickstart example.