Liquidity.Party/tycho-execution
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Address comments, make clippy happy

Browse Source
This commit is contained in:
TAMARA LIPOWSKI
2025-02-05 15:44:27 -05:00
parent 52cce5f5c6
commit 44e8e0bb96
6 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/encoding/evm/strategy_encoder/strategy_encoder_registry.rs
View File

@@ -12,12 +12,11 @@ use crate::encoding::{
strategy_encoder::{StrategyEncoder, StrategyEncoderRegistry},
};
/// Contains all supported strategies to encode a solution.
///
/// # Fields
/// * `strategies` - A hashmap containing the name of the strategy as a key and the strategy
/// encoder as a value.
/// * `strategies` - A hashmap containing the name of the strategy as a key and the strategy encoder
/// as a value.
pub struct EVMStrategyEncoderRegistry {
strategies: HashMap<String, Box<dyn StrategyEncoder>>,
}

9
src/encoding/evm/strategy_encoder/strategy_encoders.rs
View File

@@ -59,7 +59,8 @@ pub trait EVMStrategyEncoder: StrategyEncoder {
/// # Fields
///
/// * `swap_encoder_registry`: SwapEncoderRegistry, containing all possible swap encoders
/// * `permit2`: Permit2, the object containing necessary information for managing permit2 operations
/// * `permit2`: Permit2, the object containing necessary information for managing permit2
/// operations
/// * `selector`: String, the selector for the swap function in the router contract
pub struct SplitSwapStrategyEncoder {
swap_encoder_registry: SwapEncoderRegistry,
@@ -219,8 +220,8 @@ impl StrategyEncoder for SplitSwapStrategyEncoder {
}
}
/// This strategy encoder is used for solutions that are sent directly to the pool.
/// Only one solution with one swap is supported.
/// This strategy encoder is used for solutions that are sent directly to the executor, bypassing
/// the router. Only one solution with one swap is supported.
///
/// # Fields
///
@@ -243,7 +244,7 @@ impl StrategyEncoder for ExecutorStrategyEncoder {
) -> Result<(Vec<u8>, Bytes), EncodingError> {
let router_address = solution.router_address.ok_or_else(|| {
EncodingError::InvalidInput(
"Router address is required for straight to pool solutions".to_string(),
"Router address is required for straight-to-executor solutions".to_string(),
)
})?;