chore: Improve docstrings

Took 23 minutes
This commit is contained in:
Diana Carvalho
2025-05-26 10:27:09 +01:00
parent c62af2f232
commit f5d9ab03da
4 changed files with 4 additions and 10 deletions

View File

@@ -29,8 +29,6 @@ use tycho_execution::encoding::{
/// "given_amount": "123...", /// "given_amount": "123...",
/// "checked_token": "0x...", /// "checked_token": "0x...",
/// "exact_out": false, /// "exact_out": false,
/// "slippage": 0.01,
/// "expected_amount": "123...",
/// "checked_amount": "123...", /// "checked_amount": "123...",
/// "swaps": [{ /// "swaps": [{
/// "component": { /// "component": {
@@ -59,8 +57,6 @@ pub struct Cli {
#[arg(short, long)] #[arg(short, long)]
router_address: Option<Bytes>, router_address: Option<Bytes>,
#[arg(short, long)] #[arg(short, long)]
swapper_pk: Option<String>,
#[arg(short, long)]
user_transfer_type: Option<UserTransferType>, user_transfer_type: Option<UserTransferType>,
} }
@@ -95,10 +91,6 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
if let Some(router_address) = cli.router_address { if let Some(router_address) = cli.router_address {
builder = builder.router_address(router_address); builder = builder.router_address(router_address);
} }
if let Some(swapper_pk) = cli.swapper_pk {
let pk = B256::from_str(&swapper_pk)?;
builder = builder.signer(PrivateKeySigner::from_bytes(&pk)?);
}
if let Some(user_transfer_type) = cli.user_transfer_type { if let Some(user_transfer_type) = cli.user_transfer_type {
builder = builder.user_transfer_type(user_transfer_type); builder = builder.user_transfer_type(user_transfer_type);
} }

View File

@@ -149,7 +149,7 @@ impl Permit2 {
))), ))),
} }
} }
/// Creates permit single and signature /// Creates permit single
pub fn get_permit( pub fn get_permit(
&self, &self,
spender: &Bytes, spender: &Bytes,

View File

@@ -65,6 +65,9 @@ impl TychoRouterEncoderBuilder {
self self
} }
/// Sets the `signer` for the encoder. This is used to sign permit2 objects. This is only needed
/// if you intend to get the full calldata for the transfer. We do not recommend using this
/// option, you should sign and create the function calldata entirely on your own.
pub fn signer(mut self, signer: PrivateKeySigner) -> Self { pub fn signer(mut self, signer: PrivateKeySigner) -> Self {
self.signer = Some(signer); self.signer = Some(signer);
self self

View File

@@ -271,7 +271,6 @@ impl TychoEncoder for TychoRouterEncoder {
/// ///
/// # Fields /// # Fields
/// * `swap_encoder_registry`: Registry of swap encoders /// * `swap_encoder_registry`: Registry of swap encoders
/// * `native_address`: Address of the chain's native token
#[derive(Clone)] #[derive(Clone)]
pub struct TychoExecutorEncoder { pub struct TychoExecutorEncoder {
swap_encoder_registry: SwapEncoderRegistry, swap_encoder_registry: SwapEncoderRegistry,