Merge pull request #283 from propeller-heads/rf1/dc/ENG-4759-request-quote-in-execution

feat: Implement IndicativelyPriced for BebopState

Author: dianacarvalho1

Cargo.lock

@@ -48,8 +48,8 @@ mini-moka = "0.10"
 lazy_static = "1.4.0"
 
 # Tycho dependencies
-tycho-common = "0.79.0"
-tycho-client = "0.79.0"
+tycho-common = "0.80.0"
+tycho-client = "0.80.0"
 
 # 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.109.0"
+tycho-execution = "0.112.0"
 
 [features]
 default = ["evm", "rfq"]

Cargo.toml

@@ -608,7 +608,7 @@ fn create_solution(
     sell_amount: BigUint,
     user_address: Bytes,
     expected_amount: BigUint,
-) -> Solution {
+) -> Solution<'static> {
     // Prepare data to encode. First we need to create a swap object
     let simple_swap = Swap::new(
         component,
@@ -618,6 +618,7 @@ fn create_solution(
         // the amount or the total remaining balance.
         0f64,
         None,
+        None,
     );
 
     // Compute a minimum amount out

examples/quickstart/main.rs

@@ -1,4 +1,3 @@
-#![allow(dead_code)] // TODO remove this
 use std::{
     collections::{HashMap, HashSet},
     str::FromStr,
@@ -14,7 +13,9 @@ use reqwest::Client;
 use tokio_tungstenite::{connect_async_with_config, tungstenite::Message};
 use tracing::{error, info, warn};
 use tycho_common::{
-    models::protocol::GetAmountOutParams, simulation::indicatively_priced::SignedQuote, Bytes,
+    models::{protocol::GetAmountOutParams, Chain},
+    simulation::indicatively_priced::SignedQuote,
+    Bytes,
 };
 
 use crate::{
@@ -26,11 +27,8 @@ use crate::{
     },
     tycho_client::feed::synchronizer::{ComponentWithState, Snapshot, StateSyncMessage},
     tycho_common::dto::{ProtocolComponent, ResponseProtocolState},
-    tycho_core::dto::Chain,
 };
 
-type BebopPriceMessage = HashMap<String, BebopPriceData>;
-
 fn pair_to_bebop_format(pair: &(String, String)) -> Result<String, RFQError> {
     // Checksum addresses to match websocket output
     let token0 = Address::from_str(&pair.0)
@@ -59,7 +57,7 @@ fn chain_to_bebop_url(chain: Chain) -> Result<String, RFQError> {
     Ok(url)
 }
 
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct BebopClient {
     chain: Chain,
     price_ws: String,
@@ -115,7 +113,7 @@ impl BebopClient {
             id: component_id.clone(),
             protocol_system: "rfq:bebop".to_string(),
             protocol_type_name: "bebop_pool".to_string(),
-            chain: self.chain,
+            chain: self.chain.into(),
             tokens,
             contract_ids: vec![], // empty for RFQ
             static_attributes: Default::default(),
@@ -512,7 +510,10 @@ mod tests {
                                     .protocol_type_name,
                                 "bebop_pool"
                             );
-                            assert_eq!(component_with_state.component.chain, Chain::Ethereum);
+                            assert_eq!(
+                                component_with_state.component.chain,
+                                Chain::Ethereum.into()
+                            );
 
                             let attributes = &component_with_state.state.attributes;
 

src/rfq/protocols/bebop/client.rs

@@ -1,29 +1,40 @@
 use std::{any::Any, collections::HashMap};
 
+use async_trait::async_trait;
 use num_bigint::BigUint;
 use num_traits::{FromPrimitive, Pow, ToPrimitive};
 use tycho_common::{
     dto::ProtocolStateDelta,
-    models::token::Token,
+    models::{protocol::GetAmountOutParams, token::Token},
     simulation::{
         errors::{SimulationError, TransitionError},
+        indicatively_priced::{IndicativelyPriced, SignedQuote},
         protocol_sim::{Balances, GetAmountOutResult, ProtocolSim},
     },
     Bytes,
 };
 
-use crate::rfq::protocols::bebop::models::BebopPriceData;
+use crate::rfq::{
+    client::RFQClient,
+    protocols::bebop::{client::BebopClient, models::BebopPriceData},
+};
 
 #[derive(Debug, Clone)]
 pub struct BebopState {
     pub base_token: Token,
     pub quote_token: Token,
     pub price_data: BebopPriceData,
+    pub client: BebopClient,
 }
 
 impl BebopState {
-    pub fn new(base_token: Token, quote_token: Token, price_data: BebopPriceData) -> Self {
-        BebopState { base_token, quote_token, price_data }
+    pub fn new(
+        base_token: Token,
+        quote_token: Token,
+        price_data: BebopPriceData,
+        client: BebopClient,
+    ) -> Self {
+        BebopState { base_token, quote_token, price_data, client }
     }
 }
 
@@ -209,11 +220,28 @@ impl ProtocolSim for BebopState {
             false
         }
     }
+
+    fn as_indicatively_priced(&self) -> Option<&dyn IndicativelyPriced> {
+        Some(self)
+    }
+}
+
+#[async_trait]
+impl IndicativelyPriced for BebopState {
+    async fn request_signed_quote(
+        &self,
+        params: GetAmountOutParams,
+    ) -> Result<SignedQuote, SimulationError> {
+        Ok(self
+            .client
+            .request_binding_quote(&params)
+            .await?)
+    }
 }
 
 #[cfg(test)]
 mod tests {
-    use std::str::FromStr;
+    use std::{collections::HashSet, str::FromStr};
 
     use tycho_common::models::Chain;
 
@@ -259,6 +287,18 @@ mod tests {
         )
     }
 
+    fn empty_bebop_client() -> BebopClient {
+        BebopClient::new(
+            Chain::Ethereum,
+            HashSet::new(),
+            0.0,
+            "".to_string(),
+            "".to_string(),
+            HashSet::new(),
+        )
+        .unwrap()
+    }
+
     fn create_test_bebop_state() -> BebopState {
         BebopState {
             base_token: wbtc(),
@@ -270,6 +310,7 @@ mod tests {
                 bids: vec![65000.0f32, 1.5f32, 64950.0f32, 2.0f32, 64900.0f32, 0.5f32],
                 asks: vec![65100.0f32, 1.0f32, 65150.0f32, 2.5f32, 65200.0f32, 1.5f32],
             },
+            client: empty_bebop_client(),
         }
     }
 
@@ -442,7 +483,7 @@ mod tests {
 
         let weth = weth();
         let usdc = usdc();
-        let state = BebopState::new(weth.clone(), usdc.clone(), price_data);
+        let state = BebopState::new(weth.clone(), usdc.clone(), price_data, empty_bebop_client());
 
         // swap 3 WETH -> USDC
         let amount_out_result = state

src/rfq/protocols/bebop/state.rs

@@ -1,12 +1,12 @@
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
 
 use tycho_client::feed::synchronizer::ComponentWithState;
 use tycho_common::{models::token::Token, Bytes};
 
 use super::{models::BebopPriceData, state::BebopState};
 use crate::{
     protocol::{errors::InvalidSnapshotError, models::TryFromWithBlock},
-    rfq::models::TimestampHeader,
+    rfq::{models::TimestampHeader, protocols::bebop::client::BebopClient},
 };
 
 impl TryFromWithBlock<ComponentWithState, TimestampHeader> for BebopState {
@@ -75,7 +75,22 @@ impl TryFromWithBlock<ComponentWithState, TimestampHeader> for BebopState {
                 .collect(),
         };
 
-        Ok(BebopState { base_token, quote_token, price_data })
+        let ws_user = "".to_string();
+        let ws_key = "".to_string();
+
+        let client = BebopClient::new(
+            snapshot.component.chain.into(),
+            HashSet::new(),
+            0.0,
+            ws_user,
+            ws_key,
+            HashSet::new(),
+        )
+        .map_err(|e| {
+            InvalidSnapshotError::MissingAttribute(format!("Couldn't create BebopClient: {e}"))
+        })?;
+
+        Ok(BebopState { base_token, quote_token, price_data, client })
     }
 }