feat: Add evm feature gate

- Move all evm code inside evm directory
- StrategyEncoder:
  - Kept StrategyEncoder trait but created a new one: EVMStrategyEncoder to implement encode_protocol_header (that is evm specific).
  - All StrategyEncoders implement both traits now
  - Renamed DefaultStrategySelector -> EVMStrategySelector
- RouterEncoder:
  - Created a RouterEncoder trait and a EVMRouterEncoder that implements it
- Moved utils inside evm directory as well
- Renamed config.json -> executor_addresses.json and moved it to a higher config directory
- Make alloy optional and dependent on the evm feature gate

--- don't change below this line ---
ENG-4075 <#DTT#>

src/encoding/evm/approvals/mod.rs

@@ -0,0 +1,2 @@
+pub mod permit2;
+pub mod protocol_approvals_manager;

src/encoding/evm/approvals/permit2.rs

@@ -0,0 +1,42 @@
+use std::str::FromStr;
+
+use alloy_primitives::U256;
+use tycho_core::Bytes;
+
+use crate::encoding::user_approvals_manager::{Approval, UserApprovalsManager};
+
+#[allow(dead_code)]
+pub struct Permit2 {
+    pub address: Bytes,
+}
+
+#[allow(dead_code)]
+impl Permit2 {
+    pub fn new() -> Self {
+        Self {
+            address: Bytes::from_str("0x000000000022D473030F116dDEE9F6B43aC78BA3")
+                .expect("Permit2 address not valid"),
+        }
+    }
+    fn get_allowance_data(
+        &self,
+        _user: Bytes,
+        _router_address: Bytes,
+        _token: Bytes,
+    ) -> (U256, u64, U256) {
+        // get allowance data (if it exists) and the nonce
+        //  returns permitAmount, expiration, nonce
+        todo!()
+    }
+}
+impl UserApprovalsManager for Permit2 {
+    fn encode_approvals(&self, _approvals: Vec<Approval>) -> Vec<u8> {
+        // calls get_allowance_data to get nonce
+        // checks if we are not permitted already
+        // puts data into a permitSingle struct if there is only 1 PermitDetails, if there are
+        // several, use PermitBatch   adds the nonce and the expiration (uniswap recommends
+        // 30 days for expiration) signs data
+        // returns encoded data
+        todo!()
+    }
+}

src/encoding/evm/approvals/protocol_approvals_manager.rs

@@ -0,0 +1,49 @@
+use std::{env, sync::Arc};
+
+use alloy::{
+    providers::{ProviderBuilder, RootProvider},
+    transports::BoxTransport,
+};
+use alloy_primitives::Address;
+use dotenv::dotenv;
+
+#[allow(dead_code)]
+pub struct ProtocolApprovalsManager {
+    client: Arc<RootProvider<BoxTransport>>,
+}
+impl ProtocolApprovalsManager {
+    pub fn new() -> Self {
+        Self { client: get_client() }
+    }
+    pub async fn approval_needed(
+        &self,
+        _token: Address,
+        _spender_address: Address,
+        _router_address: Address,
+    ) -> bool {
+        todo!()
+        // should be something like
+        // let allowance = self
+        //     .client
+        //     .call(token, "allowance(address,address)(uint256)", (router_address,
+        // spender_address))     .await;
+        //
+        // allowance == U256::ZERO // If allowance is 0, approval is needed
+    }
+}
+
+pub fn get_client() -> Arc<RootProvider<BoxTransport>> {
+    dotenv().ok();
+    let eth_rpc_url = env::var("ETH_RPC_URL").expect("Missing ETH_RPC_URL in environment");
+    let runtime = tokio::runtime::Handle::try_current()
+        .is_err()
+        .then(|| tokio::runtime::Runtime::new().unwrap())
+        .unwrap();
+    let client = runtime.block_on(async {
+        ProviderBuilder::new()
+            .on_builtin(&eth_rpc_url)
+            .await
+            .unwrap()
+    });
+    Arc::new(client)
+}

src/encoding/evm/mod.rs

@@ -0,0 +1,5 @@
+pub mod approvals;
+mod router_encoder;
+mod strategy_encoder;
+mod swap_encoder;
+mod utils;

src/encoding/evm/router_encoder.rs

@@ -0,0 +1,81 @@
+use alloy_sol_types::SolValue;
+use anyhow::Error;
+use num_bigint::BigUint;
+
+use crate::encoding::{
+    evm::utils::{encode_input, ple_encode},
+    models::{NativeAction, Solution, Transaction, PROPELLER_ROUTER_ADDRESS},
+    router_encoder::RouterEncoder,
+    strategy_encoder::StrategySelector,
+    user_approvals_manager::{Approval, UserApprovalsManager},
+};
+
+#[allow(dead_code)]
+pub struct EVMRouterEncoder<S: StrategySelector, A: UserApprovalsManager> {
+    strategy_selector: S,
+    approvals_manager: A,
+}
+
+#[allow(dead_code)]
+impl<S: StrategySelector, A: UserApprovalsManager> EVMRouterEncoder<S, A> {
+    pub fn new(strategy_selector: S, approvals_manager: A) -> Self {
+        EVMRouterEncoder { strategy_selector, approvals_manager }
+    }
+}
+impl<S: StrategySelector, A: UserApprovalsManager> RouterEncoder<S, A> for EVMRouterEncoder<S, A> {
+    fn encode_router_calldata(&self, solutions: Vec<Solution>) -> Result<Transaction, Error> {
+        let _approvals_calldata = self.handle_approvals(&solutions)?; // TODO: where should we append this?
+        let mut calldata_list: Vec<Vec<u8>> = Vec::new();
+        let encode_for_batch_execute = solutions.len() > 1;
+        let mut value = BigUint::ZERO;
+        for solution in solutions.iter() {
+            let exact_out = solution.exact_out;
+            let straight_to_pool = solution.straight_to_pool;
+
+            let strategy = self
+                .strategy_selector
+                .select_strategy(solution);
+            let method_calldata = strategy.encode_strategy((*solution).clone())?;
+
+            let contract_interaction = if encode_for_batch_execute {
+                let args = (strategy.action_type(exact_out) as u16, method_calldata);
+                args.abi_encode()
+            } else if straight_to_pool {
+                method_calldata
+            } else {
+                encode_input(strategy.selector(exact_out), method_calldata)
+            };
+            calldata_list.push(contract_interaction);
+
+            if solution.native_action.clone().unwrap() == NativeAction::Wrap {
+                value += solution.given_amount.clone();
+            }
+        }
+        let data = if encode_for_batch_execute {
+            let args = (false, ple_encode(calldata_list));
+            encode_input("batchExecute(bytes)", args.abi_encode())
+        } else {
+            calldata_list[0].clone()
+        };
+
+        Ok(Transaction { data, value })
+    }
+
+    fn handle_approvals(&self, solutions: &[Solution]) -> Result<Vec<u8>, Error> {
+        let mut approvals = Vec::new();
+        for solution in solutions.iter() {
+            approvals.push(Approval {
+                token: solution.given_token.clone(),
+                spender: solution
+                    .router_address
+                    .clone()
+                    .unwrap_or(PROPELLER_ROUTER_ADDRESS.clone()),
+                amount: solution.given_amount.clone(),
+                owner: solution.sender.clone(),
+            });
+        }
+        Ok(self
+            .approvals_manager
+            .encode_approvals(approvals))
+    }
+}

src/encoding/evm/strategy_encoder/encoder.rs

@@ -0,0 +1,198 @@
+use std::{cmp::min, str::FromStr};
+
+use alloy_primitives::Address;
+use alloy_sol_types::SolValue;
+use anyhow::Error;
+use num_bigint::BigUint;
+use num_traits::Zero;
+
+use crate::encoding::{
+    evm::{
+        swap_encoder::SWAP_ENCODER_REGISTRY,
+        utils::{biguint_to_u256, ple_encode},
+    },
+    models::{ActionType, EncodingContext, NativeAction, Solution, PROPELLER_ROUTER_ADDRESS},
+    strategy_encoder::StrategyEncoder,
+};
+
+#[allow(dead_code)]
+pub trait EVMStrategyEncoder: StrategyEncoder {
+    fn encode_protocol_header(
+        &self,
+        protocol_data: Vec<u8>,
+        executor_address: Address,
+        // Token indices, split, and token inclusion are only used for split swaps
+        token_in: u16,
+        token_out: u16,
+        split: u16, // not sure what should be the type of this :/
+    ) -> Vec<u8> {
+        let args = (executor_address, token_in, token_out, split, protocol_data);
+        args.abi_encode()
+    }
+}
+
+pub struct SingleSwapStrategyEncoder {}
+impl EVMStrategyEncoder for SingleSwapStrategyEncoder {}
+
+impl StrategyEncoder for SingleSwapStrategyEncoder {
+    fn encode_strategy(&self, _solution: Solution) -> Result<Vec<u8>, Error> {
+        todo!()
+    }
+
+    fn action_type(&self, exact_out: bool) -> ActionType {
+        if exact_out {
+            ActionType::SingleExactOut
+        } else {
+            ActionType::SingleExactIn
+        }
+    }
+
+    fn selector(&self, exact_out: bool) -> &str {
+        if exact_out {
+            "singleExactOut(uint256, bytes)"
+        } else {
+            "singleExactIn(uint256, bytes)"
+        }
+    }
+}
+
+pub struct SequentialStrategyEncoder {}
+impl EVMStrategyEncoder for SequentialStrategyEncoder {}
+
+impl StrategyEncoder for SequentialStrategyEncoder {
+    fn encode_strategy(&self, solution: Solution) -> Result<Vec<u8>, Error> {
+        let check_amount = if solution.check_amount.is_some() {
+            let mut check_amount = solution.check_amount.clone().unwrap();
+            if solution.slippage.is_some() {
+                let one_hundred = BigUint::from(100u32);
+                let slippage_percent = BigUint::from((solution.slippage.unwrap() * 100.0) as u32);
+                let multiplier = &one_hundred - slippage_percent;
+                let expected_amount_with_slippage =
+                    (&solution.expected_amount * multiplier) / one_hundred;
+                check_amount = min(check_amount, expected_amount_with_slippage);
+            }
+            check_amount
+        } else {
+            BigUint::ZERO
+        };
+
+        let mut swaps = vec![];
+        for (index, swap) in solution.swaps.iter().enumerate() {
+            let is_last = index == solution.swaps.len() - 1;
+            let registry = SWAP_ENCODER_REGISTRY.read().unwrap();
+            let swap_encoder = registry
+                .get_encoder(&swap.component.protocol_system)
+                .expect("Swap encoder not found");
+            let router_address = if solution.router_address.is_some() {
+                solution.router_address.clone().unwrap()
+            } else {
+                PROPELLER_ROUTER_ADDRESS.clone()
+            };
+            let receiver = if is_last { solution.receiver.clone() } else { router_address.clone() };
+
+            let encoding_context = EncodingContext {
+                receiver,
+                exact_out: solution.exact_out,
+                address_for_approvals: router_address,
+            };
+            let protocol_data = swap_encoder.encode_swap(swap.clone(), encoding_context)?;
+            let executor_address = swap_encoder.executor_address();
+            let swap_data = self.encode_protocol_header(
+                protocol_data,
+                Address::from_str(executor_address).expect("Couldn't convert executor address"),
+                0,
+                0,
+                0,
+            );
+            swaps.push(swap_data);
+        }
+
+        let encoded_swaps = ple_encode(swaps);
+
+        let (mut unwrap, mut wrap) = (false, false);
+        if solution.native_action.is_some() {
+            match solution.native_action.unwrap() {
+                NativeAction::Wrap => wrap = true,
+                NativeAction::Unwrap => unwrap = true,
+            }
+        }
+        let method_calldata = (
+            wrap,
+            unwrap,
+            biguint_to_u256(&solution.given_amount),
+            !check_amount.is_zero(), /* if check_amount is zero, then we don't need to check */
+            biguint_to_u256(&check_amount),
+            encoded_swaps,
+        )
+            .abi_encode();
+        Ok(method_calldata)
+    }
+
+    fn action_type(&self, exact_out: bool) -> ActionType {
+        if exact_out {
+            ActionType::SequentialExactOut
+        } else {
+            ActionType::SequentialExactIn
+        }
+    }
+
+    fn selector(&self, exact_out: bool) -> &str {
+        if exact_out {
+            "sequentialExactOut(uint256, uint256, bytes[])"
+        } else {
+            "sequentialExactIn(uint256, uint256, bytes[])"
+        }
+    }
+}
+
+pub struct SplitSwapStrategyEncoder {}
+impl EVMStrategyEncoder for SplitSwapStrategyEncoder {}
+impl StrategyEncoder for SplitSwapStrategyEncoder {
+    fn encode_strategy(&self, _solution: Solution) -> Result<Vec<u8>, Error> {
+        todo!()
+    }
+    fn action_type(&self, _exact_out: bool) -> ActionType {
+        ActionType::SplitIn
+    }
+
+    fn selector(&self, _exact_out: bool) -> &str {
+        "splitExactIn(uint256, address, uint256, bytes[])"
+    }
+}
+
+/// This strategy encoder is used for solutions that are sent directly to the pool.
+/// Only 1 solution with 1 swap is supported.
+pub struct StraightToPoolStrategyEncoder {}
+impl EVMStrategyEncoder for StraightToPoolStrategyEncoder {}
+impl StrategyEncoder for StraightToPoolStrategyEncoder {
+    fn encode_strategy(&self, solution: Solution) -> Result<Vec<u8>, Error> {
+        if solution.router_address.is_none() {
+            return Err(anyhow::anyhow!(
+                "Router address is required for straight to pool solutions"
+            ));
+        }
+        let swap = solution.swaps.first().unwrap();
+        let registry = SWAP_ENCODER_REGISTRY.read().unwrap();
+        let swap_encoder = registry
+            .get_encoder(&swap.component.protocol_system)
+            .expect("Swap encoder not found");
+        let router_address = solution.router_address.unwrap();
+
+        let encoding_context = EncodingContext {
+            receiver: solution.receiver,
+            exact_out: solution.exact_out,
+            address_for_approvals: router_address,
+        };
+        let protocol_data = swap_encoder.encode_swap(swap.clone(), encoding_context)?;
+        // TODO: here we need to pass also the address of the executor to be used
+        Ok(protocol_data)
+    }
+
+    fn action_type(&self, _exact_out: bool) -> ActionType {
+        unimplemented!();
+    }
+
+    fn selector(&self, _exact_out: bool) -> &str {
+        unimplemented!();
+    }
+}

src/encoding/evm/strategy_encoder/mod.rs

@@ -0,0 +1,2 @@
+mod encoder;
+mod selector;

src/encoding/evm/strategy_encoder/selector.rs

@@ -0,0 +1,28 @@
+use crate::encoding::{
+    evm::strategy_encoder::encoder::{
+        SequentialStrategyEncoder, SingleSwapStrategyEncoder, SplitSwapStrategyEncoder,
+        StraightToPoolStrategyEncoder,
+    },
+    models::Solution,
+    strategy_encoder::{StrategyEncoder, StrategySelector},
+};
+
+pub struct EVMStrategySelector;
+
+impl StrategySelector for EVMStrategySelector {
+    fn select_strategy(&self, solution: &Solution) -> Box<dyn StrategyEncoder> {
+        if solution.straight_to_pool {
+            Box::new(StraightToPoolStrategyEncoder {})
+        } else if solution.swaps.len() == 1 {
+            Box::new(SingleSwapStrategyEncoder {})
+        } else if solution
+            .swaps
+            .iter()
+            .all(|s| s.split == 0.0)
+        {
+            Box::new(SequentialStrategyEncoder {})
+        } else {
+            Box::new(SplitSwapStrategyEncoder {})
+        }
+    }
+}

src/encoding/evm/swap_encoder/builder.rs

@@ -0,0 +1,26 @@
+use crate::encoding::{
+    evm::swap_encoder::encoders::{BalancerV2SwapEncoder, UniswapV2SwapEncoder},
+    swap_encoder::SwapEncoder,
+};
+
+pub struct SwapEncoderBuilder {
+    protocol_system: String,
+    executor_address: String,
+}
+
+impl SwapEncoderBuilder {
+    pub fn new(protocol_system: &str, executor_address: &str) -> Self {
+        SwapEncoderBuilder {
+            protocol_system: protocol_system.to_string(),
+            executor_address: executor_address.to_string(),
+        }
+    }
+
+    pub fn build(self) -> Result<Box<dyn SwapEncoder>, String> {
+        match self.protocol_system.as_str() {
+            "uniswap_v2" => Ok(Box::new(UniswapV2SwapEncoder::new(self.executor_address))),
+            "vm:balancer_v2" => Ok(Box::new(BalancerV2SwapEncoder::new(self.executor_address))),
+            _ => Err(format!("Unknown protocol system: {}", self.protocol_system)),
+        }
+    }
+}

src/encoding/evm/swap_encoder/encoders.rs

@@ -0,0 +1,87 @@
+use std::str::FromStr;
+
+use alloy_primitives::Address;
+use alloy_sol_types::SolValue;
+use anyhow::Error;
+
+use crate::encoding::{
+    evm::{
+        approvals::protocol_approvals_manager::ProtocolApprovalsManager, utils::bytes_to_address,
+    },
+    models::{EncodingContext, Swap},
+    swap_encoder::SwapEncoder,
+};
+
+pub struct UniswapV2SwapEncoder {
+    executor_address: String,
+}
+
+impl UniswapV2SwapEncoder {}
+impl SwapEncoder for UniswapV2SwapEncoder {
+    fn new(executor_address: String) -> Self {
+        Self { executor_address }
+    }
+    fn encode_swap(
+        &self,
+        _swap: Swap,
+        _encoding_context: EncodingContext,
+    ) -> Result<Vec<u8>, Error> {
+        todo!()
+    }
+
+    fn executor_address(&self) -> &str {
+        &self.executor_address
+    }
+}
+
+pub struct BalancerV2SwapEncoder {
+    executor_address: String,
+    vault_address: Address,
+}
+
+impl SwapEncoder for BalancerV2SwapEncoder {
+    fn new(executor_address: String) -> Self {
+        Self {
+            executor_address,
+            vault_address: Address::from_str("0xba12222222228d8ba445958a75a0704d566bf2c8")
+                .expect("Invalid string for balancer vault address"),
+        }
+    }
+    fn encode_swap(&self, swap: Swap, encoding_context: EncodingContext) -> Result<Vec<u8>, Error> {
+        let token_approvals_manager = ProtocolApprovalsManager::new();
+        let runtime = tokio::runtime::Handle::try_current()
+            .is_err()
+            .then(|| tokio::runtime::Runtime::new().unwrap())
+            .unwrap();
+        let token = bytes_to_address(&swap.token_in)?;
+        let router_address = bytes_to_address(&encoding_context.address_for_approvals)?;
+        let approval_needed = runtime.block_on(async {
+            token_approvals_manager
+                .approval_needed(token, self.vault_address, router_address)
+                .await
+        });
+        // should we return gas estimation here too?? if there is an approval needed, gas will be
+        // higher.
+        let args = (
+            bytes_to_address(&swap.token_in)?,
+            bytes_to_address(&swap.token_out)?,
+            swap.component.id,
+            bytes_to_address(&encoding_context.receiver)?,
+            encoding_context.exact_out,
+            approval_needed,
+        );
+        Ok(args.abi_encode())
+    }
+
+    fn executor_address(&self) -> &str {
+        &self.executor_address
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    #[tokio::test]
+    async fn test_encode_swap() {
+        // Dummy test to make CI pass. Please implement me.
+    }
+}

src/encoding/evm/swap_encoder/mod.rs

@@ -0,0 +1,18 @@
+mod builder;
+mod encoders;
+mod registry;
+
+use std::sync::RwLock;
+
+use lazy_static::lazy_static;
+use tycho_core::dto::Chain;
+
+use crate::encoding::evm::swap_encoder::registry::{Config, SwapEncoderRegistry};
+
+lazy_static! {
+    pub static ref SWAP_ENCODER_REGISTRY: RwLock<SwapEncoderRegistry> = {
+        let config = Config::from_file("src/encoding/config/executor_addresses.json")
+            .expect("Failed to load configuration file");
+        RwLock::new(SwapEncoderRegistry::new(config, Chain::Ethereum))
+    };
+}

src/encoding/evm/swap_encoder/registry.rs

@@ -0,0 +1,48 @@
+use std::{collections::HashMap, fs};
+
+use serde::Deserialize;
+use tycho_core::dto::Chain;
+
+use crate::encoding::{evm::swap_encoder::builder::SwapEncoderBuilder, swap_encoder::SwapEncoder};
+
+pub struct SwapEncoderRegistry {
+    encoders: HashMap<String, Box<dyn SwapEncoder>>,
+}
+
+impl SwapEncoderRegistry {
+    pub fn new(config: Config, blockchain: Chain) -> Self {
+        let mut encoders = HashMap::new();
+        let executors = config
+            .executors
+            .get(&blockchain)
+            .unwrap_or_else(|| panic!("No executors found for blockchain: {}", blockchain));
+        for (protocol, executor_address) in executors {
+            let builder = SwapEncoderBuilder::new(protocol, executor_address);
+            let encoder = builder.build().unwrap_or_else(|_| {
+                panic!("Failed to build swap encoder for protocol: {}", protocol)
+            });
+            encoders.insert(protocol.to_string(), encoder);
+        }
+
+        Self { encoders }
+    }
+
+    #[allow(clippy::borrowed_box)]
+    pub fn get_encoder(&self, protocol_system: &str) -> Option<&Box<dyn SwapEncoder>> {
+        self.encoders.get(protocol_system)
+    }
+}
+
+#[derive(Deserialize)]
+pub struct Config {
+    pub executors: HashMap<Chain, HashMap<String, String>>, /* Blockchain -> {Protocol ->
+                                                             * Executor address} mapping */
+}
+
+impl Config {
+    pub fn from_file(path: &str) -> Result<Self, anyhow::Error> {
+        let config_str = fs::read_to_string(path)?;
+        let config: Config = serde_json::from_str(&config_str)?;
+        Ok(config)
+    }
+}

src/encoding/evm/utils.rs

@@ -0,0 +1,54 @@
+use alloy_primitives::{Address, Keccak256, U256};
+use alloy_sol_types::SolValue;
+use anyhow::Error;
+use num_bigint::BigUint;
+use tycho_core::Bytes;
+
+/// Safely converts a `Bytes` object to an `Address` object.
+///
+/// Checks the length of the `Bytes` before attempting to convert, and returns a `SimulationError`
+/// if not 20 bytes long.
+pub fn bytes_to_address(address: &Bytes) -> Result<Address, Error> {
+    if address.len() == 20 {
+        Ok(Address::from_slice(address))
+    } else {
+        Err(anyhow::format_err!("Invalid ERC20 token address: {:?}", address))
+    }
+}
+pub fn biguint_to_u256(value: &BigUint) -> U256 {
+    let bytes = value.to_bytes_be();
+    U256::from_be_slice(&bytes)
+}
+
+pub fn ple_encode(action_data_array: Vec<Vec<u8>>) -> Vec<u8> {
+    let mut encoded_action_data: Vec<u8> = Vec::new();
+
+    for action_data in action_data_array {
+        let args = (encoded_action_data, action_data.len() as u16, action_data);
+        encoded_action_data = args.abi_encode();
+    }
+
+    encoded_action_data
+}
+
+#[allow(dead_code)]
+pub fn encode_input(selector: &str, mut encoded_args: Vec<u8>) -> Vec<u8> {
+    let mut hasher = Keccak256::new();
+    hasher.update(selector.as_bytes());
+    let selector_bytes = &hasher.finalize()[..4];
+    let mut call_data = selector_bytes.to_vec();
+    // Remove extra prefix if present (32 bytes for dynamic data)
+    // Alloy encoding is including a prefix for dynamic data indicating the offset or length
+    // but at this point we don't want that
+    if encoded_args.len() > 32 &&
+        encoded_args[..32] ==
+            [0u8; 31]
+                .into_iter()
+                .chain([32].to_vec())
+                .collect::<Vec<u8>>()
+    {
+        encoded_args = encoded_args[32..].to_vec();
+    }
+    call_data.extend(encoded_args);
+    call_data
+}