docs: Address comments, make clippy happy
This commit is contained in:
@@ -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>>,
|
||||
}
|
||||
|
||||
@@ -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(),
|
||||
)
|
||||
})?;
|
||||
|
||||
|
||||
@@ -12,7 +12,6 @@ use crate::encoding::{
|
||||
swap_encoder::SwapEncoder,
|
||||
};
|
||||
|
||||
|
||||
/// Encodes a swap on a Uniswap V2 pool through the given executor address.
|
||||
///
|
||||
/// # Fields
|
||||
@@ -151,7 +150,7 @@ impl SwapEncoder for UniswapV3SwapEncoder {
|
||||
}
|
||||
}
|
||||
|
||||
/// Encodes a swap on a Balancer pool through the given executor address.
|
||||
/// Encodes a swap on a Balancer V2 pool through the given executor address.
|
||||
///
|
||||
/// # Fields
|
||||
/// * `executor_address` - The address of the executor contract that will perform the swap.
|
||||
|
||||
@@ -16,7 +16,7 @@ use crate::encoding::{
|
||||
///
|
||||
/// # Fields
|
||||
/// * `strategy_registry`: S, the strategy registry to use to select the best strategy to encode a
|
||||
/// solution, based on its supported strategies and the solution attributes.
|
||||
/// solution, based on its supported strategies and the solution attributes.
|
||||
/// * `router_address`: Bytes, the address of the router to use to execute the swaps.
|
||||
pub struct EVMTychoEncoder<S: StrategyEncoderRegistry> {
|
||||
strategy_registry: S,
|
||||
|
||||
Reference in New Issue
Block a user