docs: add docs for TychoEncoder, StrategyEncoder and SwapEncoder traits

This commit is contained in:
royvardhan
2025-02-20 23:23:18 +05:30
parent 30a7d5bbe4
commit 4b20a1164b
3 changed files with 53 additions and 9 deletions

View File

@@ -2,14 +2,36 @@ use tycho_core::Bytes;
use crate::encoding::{errors::EncodingError, models::Solution, swap_encoder::SwapEncoder};
/// Encodes a solution using a specific strategy.
/// A trait that defines how to encode a `Solution` for execution.
pub trait StrategyEncoder {
/// `encode_strategy` takes a `Solution`, which contains all the necessary information about
/// the swaps to be performed, and encodes it into a format that can be executed by the router
/// or executor contracts.
///
/// # Arguments
/// * `solution` - The `Solution` to encode, containing swap details, amounts, and execution
/// path
///
/// # Returns
/// * `Result<(Vec<u8>, Bytes, Option<String>), EncodingError>` - A tuple containing:
/// - The encoded data as bytes
/// - The address of the contract to call (router or executor)
/// - Optionally, the function selector to use when calling the contract
fn encode_strategy(
&self,
to_encode: Solution,
solution: Solution,
) -> Result<(Vec<u8>, Bytes, Option<String>), EncodingError>;
/// Retrieves the swap encoder for a specific protocol system.
///
/// # Arguments
/// * `protocol_system` - The identifier of the protocol system (e.g., "uniswap_v2")
///
/// # Returns
/// * `Option<&Box<dyn SwapEncoder>>` - The swap encoder for the protocol if available
#[allow(clippy::borrowed_box)]
fn get_swap_encoder(&self, protocol_system: &str) -> Option<&Box<dyn SwapEncoder>>;
/// Creates a cloned instance of the strategy encoder.
fn clone_box(&self) -> Box<dyn StrategyEncoder>;
}