chore: Rename selector to function signature

Took 8 minutes
2025-05-27 09:37:24 +01:00
parent 72f2734f2c
commit 73c1a2db6a
8 changed files with 48 additions and 52 deletions
--- a/src/encoding/evm/encoding_utils.rs
+++ b/src/encoding/evm/encoding_utils.rs
@@ -34,7 +34,7 @@ use crate::encoding::{
 /// - `splitSwapPermit2`
 ///
 /// The encoding includes handling of native asset wrapping/unwrapping, permit2 support,
-/// and proper input argument formatting based on the selector string.
+/// and proper input argument formatting based on the function signature string.
 ///
 /// # ⚠️ Important Responsibility Note
 ///
@@ -60,7 +60,7 @@ use crate::encoding::{
 /// funds.
 ///
 /// # Parameters
-/// - `encoded_solution`: The solution already encoded by Tycho, including selector and swap path.
+/// - `encoded_solution`: The solution already encoded by Tycho.
 /// - `solution`: The high-level solution including tokens, amounts, and receiver info.
 /// - `token_in_already_in_router`: Whether the input token is already present in the router.
 /// - `router_address`: The address of the Tycho Router contract.
@@ -71,8 +71,8 @@ use crate::encoding::{
 /// value, data), or an error if the inputs are invalid.
 ///
 /// # Errors
-/// - Returns `EncodingError::FatalError` if the selector is unsupported or required fields (e.g.,
-///   permit or signature) are missing.
+/// - Returns `EncodingError::FatalError` if the function signature is unsupported or required
+///   fields (e.g., permit or signature) are missing.
 pub fn encode_tycho_router_call(
    chain_id: u64,
    encoded_solution: EncodedSolution,
@@ -109,7 +109,7 @@ pub fn encode_tycho_router_call(
    };

    let method_calldata = if encoded_solution
-        .selector
+        .function_signature
        .contains("singleSwapPermit2")
    {
        (
@@ -128,7 +128,7 @@ pub fn encode_tycho_router_call(
        )
            .abi_encode()
    } else if encoded_solution
-        .selector
+        .function_signature
        .contains("singleSwap")
    {
        (
@@ -144,7 +144,7 @@ pub fn encode_tycho_router_call(
        )
            .abi_encode()
    } else if encoded_solution
-        .selector
+        .function_signature
        .contains("sequentialSwapPermit2")
    {
        (
@@ -163,7 +163,7 @@ pub fn encode_tycho_router_call(
        )
            .abi_encode()
    } else if encoded_solution
-        .selector
+        .function_signature
        .contains("sequentialSwap")
    {
        (
@@ -179,7 +179,7 @@ pub fn encode_tycho_router_call(
        )
            .abi_encode()
    } else if encoded_solution
-        .selector
+        .function_signature
        .contains("splitSwapPermit2")
    {
        (
@@ -199,7 +199,7 @@ pub fn encode_tycho_router_call(
        )
            .abi_encode()
    } else if encoded_solution
-        .selector
+        .function_signature
        .contains("splitSwap")
    {
        (
@@ -216,10 +216,11 @@ pub fn encode_tycho_router_call(
        )
            .abi_encode()
    } else {
-        Err(EncodingError::FatalError("Invalid selector for Tycho router".to_string()))?
+        Err(EncodingError::FatalError("Invalid function signature for Tycho router".to_string()))?
    };

-    let contract_interaction = utils::encode_input(&encoded_solution.selector, method_calldata);
+    let contract_interaction =
+        utils::encode_input(&encoded_solution.function_signature, method_calldata);
    let value = if solution.given_token == native_address {
        solution.given_amount.clone()
    } else {
--- a/src/encoding/evm/strategy_encoder/strategy_encoders.rs
+++ b/src/encoding/evm/strategy_encoder/strategy_encoders.rs
@@ -23,13 +23,13 @@ use crate::encoding::{
 ///
 /// # Fields
 /// * `swap_encoder_registry`: SwapEncoderRegistry, containing all possible swap encoders
-/// * `selector`: String, the selector for the swap function in the router contract
+/// * `function_signature`: String, the signature for the swap function in the router contract
 /// * `router_address`: Address of the router to be used to execute swaps
 /// * `transfer_optimization`: TransferOptimization, responsible for optimizing the token transfers
 #[derive(Clone)]
 pub struct SingleSwapStrategyEncoder {
    swap_encoder_registry: SwapEncoderRegistry,
-    selector: String,
+    function_signature: String,
    router_address: Bytes,
    transfer_optimization: TransferOptimization,
 }
@@ -41,14 +41,14 @@ impl SingleSwapStrategyEncoder {
        user_transfer_type: UserTransferType,
        router_address: Bytes,
    ) -> Result<Self, EncodingError> {
-        let selector = if user_transfer_type == UserTransferType::TransferFromPermit2 {
+        let function_signature = if user_transfer_type == UserTransferType::TransferFromPermit2 {
            "singleSwapPermit2(uint256,address,address,uint256,bool,bool,address,((address,uint160,uint48,uint48),address,uint256),bytes,bytes)"
        } else {
            "singleSwap(uint256,address,address,uint256,bool,bool,address,bool,bytes)"
        }.to_string();

        Ok(Self {
-            selector,
+            function_signature,
            swap_encoder_registry,
            router_address: router_address.clone(),
            transfer_optimization: TransferOptimization::new(
@@ -133,7 +133,7 @@ impl StrategyEncoder for SingleSwapStrategyEncoder {
            grouped_protocol_data,
        );
        Ok(EncodedSolution {
-            selector: self.selector.clone(),
+            function_signature: self.function_signature.clone(),
            interacting_with: self.router_address.clone(),
            swaps: swap_data,
            permit: None,
@@ -155,7 +155,7 @@ impl StrategyEncoder for SingleSwapStrategyEncoder {
 ///
 /// # Fields
 /// * `swap_encoder_registry`: SwapEncoderRegistry, containing all possible swap encoders
-/// * `selector`: String, the selector for the swap function in the router contract
+/// * `function_signature`: String, the signature for the swap function in the router contract
 /// * `native_address`: Address of the chain's native token
 /// * `wrapped_address`: Address of the chain's wrapped token
 /// * `router_address`: Address of the router to be used to execute swaps
@@ -165,7 +165,7 @@ impl StrategyEncoder for SingleSwapStrategyEncoder {
 #[derive(Clone)]
 pub struct SequentialSwapStrategyEncoder {
    swap_encoder_registry: SwapEncoderRegistry,
-    selector: String,
+    function_signature: String,
    router_address: Bytes,
    native_address: Bytes,
    wrapped_address: Bytes,
@@ -180,14 +180,14 @@ impl SequentialSwapStrategyEncoder {
        user_transfer_type: UserTransferType,
        router_address: Bytes,
    ) -> Result<Self, EncodingError> {
-        let selector = if user_transfer_type == UserTransferType::TransferFromPermit2 {
+        let function_signature = if user_transfer_type == UserTransferType::TransferFromPermit2 {
            "sequentialSwapPermit2(uint256,address,address,uint256,bool,bool,address,((address,uint160,uint48,uint48),address,uint256),bytes,bytes)"
        } else {
            "sequentialSwap(uint256,address,address,uint256,bool,bool,address,bool,bytes)"

        }.to_string();
        Ok(Self {
-            selector,
+            function_signature,
            swap_encoder_registry,
            router_address: router_address.clone(),
            native_address: chain.native_token()?,
@@ -288,7 +288,7 @@ impl StrategyEncoder for SequentialSwapStrategyEncoder {
        let encoded_swaps = ple_encode(swaps);
        Ok(EncodedSolution {
            interacting_with: self.router_address.clone(),
-            selector: self.selector.clone(),
+            function_signature: self.function_signature.clone(),
            swaps: encoded_swaps,
            permit: None,
            n_tokens: 0,
@@ -309,7 +309,7 @@ impl StrategyEncoder for SequentialSwapStrategyEncoder {
 ///
 /// # Fields
 /// * `swap_encoder_registry`: SwapEncoderRegistry, containing all possible swap encoders
-/// * `selector`: String, the selector for the swap function in the router contract
+/// * `function_signature`: String, the signature for the swap function in the router contract
 /// * `native_address`: Address of the chain's native token
 /// * `wrapped_address`: Address of the chain's wrapped token
 /// * `split_swap_validator`: SplitSwapValidator, responsible for checking validity of split swap
@@ -319,7 +319,7 @@ impl StrategyEncoder for SequentialSwapStrategyEncoder {
 #[derive(Clone)]
 pub struct SplitSwapStrategyEncoder {
    swap_encoder_registry: SwapEncoderRegistry,
-    selector: String,
+    function_signature: String,
    native_address: Bytes,
    wrapped_address: Bytes,
    split_swap_validator: SplitSwapValidator,
@@ -334,13 +334,13 @@ impl SplitSwapStrategyEncoder {
        user_transfer_type: UserTransferType,
        router_address: Bytes,
    ) -> Result<Self, EncodingError> {
-        let selector = if user_transfer_type == UserTransferType::TransferFromPermit2 {
+        let function_signature = if user_transfer_type == UserTransferType::TransferFromPermit2 {
           "splitSwapPermit2(uint256,address,address,uint256,bool,bool,uint256,address,((address,uint160,uint48,uint48),address,uint256),bytes,bytes)"
        } else {
                "splitSwap(uint256,address,address,uint256,bool,bool,uint256,address,bool,bytes)"
        }.to_string();
        Ok(Self {
-            selector,
+            function_signature,
            swap_encoder_registry,
            native_address: chain.native_token()?,
            wrapped_address: chain.wrapped_token()?,
@@ -489,7 +489,7 @@ impl StrategyEncoder for SplitSwapStrategyEncoder {
        };
        Ok(EncodedSolution {
            interacting_with: self.router_address.clone(),
-            selector: self.selector.clone(),
+            function_signature: self.function_signature.clone(),
            swaps: encoded_swaps,
            permit: None,
            n_tokens: tokens_len,
@@ -596,7 +596,7 @@ mod tests {
            let hex_calldata = encode(&encoded_solution.swaps);

            assert_eq!(hex_calldata, expected_swap);
-            assert_eq!(encoded_solution.selector, "singleSwapPermit2(uint256,address,address,uint256,bool,bool,address,((address,uint160,uint48,uint48),address,uint256),bytes,bytes)".to_string());
+            assert_eq!(encoded_solution.function_signature, "singleSwapPermit2(uint256,address,address,uint256,bool,bool,address,((address,uint160,uint48,uint48),address,uint256),bytes,bytes)".to_string());
            assert_eq!(encoded_solution.interacting_with, router_address());
        }

@@ -659,7 +659,7 @@ mod tests {

            assert_eq!(hex_calldata, expected_input);
            assert_eq!(
-                encoded_solution.selector,
+                encoded_solution.function_signature,
                "singleSwap(uint256,address,address,uint256,bool,bool,address,bool,bytes)"
                    .to_string()
            );
@@ -747,7 +747,7 @@ mod tests {

            assert_eq!(hex_calldata, expected);
            assert_eq!(
-                encoded_solution.selector,
+                encoded_solution.function_signature,
                "sequentialSwap(uint256,address,address,uint256,bool,bool,address,bool,bytes)"
                    .to_string()
            );
@@ -902,7 +902,7 @@ mod tests {
            .join("");
            assert_eq!(hex_calldata, expected_swaps);
            assert_eq!(
-                encoded_solution.selector,
+                encoded_solution.function_signature,
                "splitSwapPermit2(uint256,address,address,uint256,bool,bool,uint256,address,((address,uint160,uint48,uint48),address,uint256),bytes,bytes)"
                    .to_string()
            );
@@ -1050,7 +1050,7 @@ mod tests {

            assert_eq!(hex_calldata, expected_swaps);
            assert_eq!(
-                encoded_solution.selector,
+                encoded_solution.function_signature,
                "splitSwap(uint256,address,address,uint256,bool,bool,uint256,address,bool,bytes)"
                    .to_string()
            );
--- a/src/encoding/evm/swap_encoder/swap_encoders.rs
+++ b/src/encoding/evm/swap_encoder/swap_encoders.rs
@@ -19,7 +19,6 @@ use crate::encoding::{
 ///
 /// # Fields
 /// * `executor_address` - The address of the executor contract that will perform the swap.
-/// * `swap_selector` - The selector of the swap function in the executor contract.
 #[derive(Clone)]
 pub struct UniswapV2SwapEncoder {
    executor_address: String,
@@ -78,7 +77,6 @@ impl SwapEncoder for UniswapV2SwapEncoder {
 ///
 /// # Fields
 /// * `executor_address` - The address of the executor contract that will perform the swap.
-/// * `swap_selector` - The selector of the swap function in the executor contract.
 #[derive(Clone)]
 pub struct UniswapV3SwapEncoder {
    executor_address: String,
@@ -140,8 +138,6 @@ impl SwapEncoder for UniswapV3SwapEncoder {
 ///
 /// # Fields
 /// * `executor_address` - The address of the executor contract that will perform the swap.
-/// * `swap_selector` - The selector of the swap function in the executor contract.
-/// * `callback_selector` - The selector of the callback function in the executor contract.
 #[derive(Clone)]
 pub struct UniswapV4SwapEncoder {
    executor_address: String,
--- a/src/encoding/evm/tycho_encoders.rs
+++ b/src/encoding/evm/tycho_encoders.rs
@@ -337,7 +337,7 @@ impl TychoExecutorEncoder {
            swaps: grouped_protocol_data,
            interacting_with: executor_address,
            permit: None,
-            selector: "".to_string(),
+            function_signature: "".to_string(),
            n_tokens: 0,
        })
    }