feat: Add IndicativelyPriced trait

Add GetAmountOutParams to models

--- don't change below this line ---
ENG-4691

#time 6m

Author: dianacarvalho1

tycho-common/src/models/protocol.rs

@@ -1,13 +1,14 @@
 use std::collections::{hash_map::Entry, HashMap, HashSet};
 
 use chrono::NaiveDateTime;
+use num_bigint::BigUint;
 use serde::{Deserialize, Serialize};
 use tracing::warn;
 
 use crate::{
     models::{
-        blockchain::Transaction, Address, AttrStoreKey, Balance, Chain, ChangeType, ComponentId,
-        MergeError, StoreVal, TxHash,
+        blockchain::Transaction, token::Token, Address, AttrStoreKey, Balance, Chain, ChangeType,
+        ComponentId, MergeError, StoreVal, TxHash,
     },
     Bytes,
 };
@@ -316,6 +317,14 @@ impl ProtocolChangesWithTx {
     }
 }
 
+pub struct GetAmountOutParams {
+    pub amount_in: BigUint,
+    pub token_in: Token,
+    pub token_out: Token,
+    pub sender: Bytes,
+    pub receiver: Bytes,
+}
+
 #[cfg(test)]
 mod test {
     use rstest::rstest;

tycho-common/src/simulation/indicatively_priced.rs

@@ -0,0 +1,35 @@
+use std::collections::HashMap;
+
+use async_trait::async_trait;
+use num_bigint::BigUint;
+
+use crate::{
+    models::protocol::GetAmountOutParams,
+    simulation::{errors::SimulationError, protocol_sim::ProtocolSim},
+    Bytes,
+};
+
+pub struct SignedQuote {
+    pub base_token: Bytes,
+    pub quote_token: Bytes,
+    pub amount_in: BigUint,
+    pub amount_out: BigUint,
+    // each RFQ will need different attributes
+    pub quote_attributes: HashMap<String, Bytes>,
+}
+
+#[async_trait]
+pub trait IndicativelyPriced: ProtocolSim {
+    // this will be true when the price is only an estimation/indicative price
+    fn is_indicatively_priced() -> bool {
+        false
+    }
+
+    // if it is indicatively priced, then we need to request a signed quote for the final price
+    async fn request_signed_quote(
+        &self,
+        _params: GetAmountOutParams,
+    ) -> Result<SignedQuote, SimulationError> {
+        Err(SimulationError::FatalError("request_signed_quote not implemented".into()))
+    }
+}

tycho-common/src/simulation/mod.rs

@@ -1,2 +1,3 @@
 pub mod errors;
+pub mod indicatively_priced;
 pub mod protocol_sim;