The strategy works as follows: - Manage approvals needed - Compute min amount (if check amount is any): - if slippage is defined, apply slippage on the expected amount and take the min value between that and the check amount - if not, it's just the check amount - Iterate through the swaps - call the corresponding swap encoder to encode the swap - add swap header (tokens indexes and split) - ple encode the swaps - Add extra inputs (amounts, token addresses, min amount, (un)wrap, number of tokens and receiver) Misc: - Move executor address and selector encoding inside the SwapEncoder - Add default executor_selector to SwapEncoder - Pass router address inside the SplitSwapStrategyEncoder - Move Permit2 inside the SplitSwapStrategyEncoder. It is a responsibility and a specificity of the strategy to need permit2 approvals --- don't change below this line --- ENG-4081 Took 1 hour 21 minutes
335 lines
11 KiB
Rust
335 lines
11 KiB
Rust
use std::str::FromStr;
|
|
|
|
use alloy_primitives::{Address, Bytes as AlloyBytes};
|
|
use alloy_sol_types::SolValue;
|
|
|
|
use crate::encoding::{
|
|
errors::EncodingError,
|
|
evm::{
|
|
approvals::protocol_approvals_manager::ProtocolApprovalsManager, utils::bytes_to_address,
|
|
},
|
|
models::{EncodingContext, Swap},
|
|
swap_encoder::SwapEncoder,
|
|
};
|
|
|
|
pub struct UniswapV2SwapEncoder {
|
|
executor_address: String,
|
|
}
|
|
|
|
impl UniswapV2SwapEncoder {
|
|
fn get_zero_to_one(sell_token_address: Address, buy_token_address: Address) -> bool {
|
|
sell_token_address < buy_token_address
|
|
}
|
|
}
|
|
|
|
impl SwapEncoder for UniswapV2SwapEncoder {
|
|
fn new(executor_address: String) -> Self {
|
|
Self { executor_address }
|
|
}
|
|
|
|
fn encode_swap(
|
|
&self,
|
|
swap: Swap,
|
|
encoding_context: EncodingContext,
|
|
) -> Result<Vec<u8>, EncodingError> {
|
|
let token_in_address = bytes_to_address(&swap.token_in)?;
|
|
let token_out_address = bytes_to_address(&swap.token_out)?;
|
|
|
|
let zero_to_one = Self::get_zero_to_one(token_in_address, token_out_address);
|
|
let component_id = Address::from_str(&swap.component.id)
|
|
.map_err(|_| EncodingError::FatalError("Invalid USV2 component id".to_string()))?;
|
|
|
|
// Token in address is always needed to perform a manual transfer from the router,
|
|
// since no optimizations are performed that send from one pool to the next
|
|
let args = (
|
|
Address::from_str(self.executor_address())
|
|
.map_err(|_| EncodingError::FatalError("Invalid executor address".to_string()))?,
|
|
self.executor_selector(),
|
|
token_in_address,
|
|
component_id,
|
|
bytes_to_address(&encoding_context.receiver)?,
|
|
zero_to_one,
|
|
encoding_context.exact_out,
|
|
);
|
|
|
|
Ok(args.abi_encode_packed())
|
|
}
|
|
|
|
fn executor_address(&self) -> &str {
|
|
&self.executor_address
|
|
}
|
|
}
|
|
|
|
pub struct UniswapV3SwapEncoder {
|
|
executor_address: String,
|
|
}
|
|
|
|
impl UniswapV3SwapEncoder {
|
|
fn get_zero_to_one(sell_token_address: Address, buy_token_address: Address) -> bool {
|
|
sell_token_address < buy_token_address
|
|
}
|
|
}
|
|
|
|
impl SwapEncoder for UniswapV3SwapEncoder {
|
|
fn new(executor_address: String) -> Self {
|
|
Self { executor_address }
|
|
}
|
|
|
|
fn encode_swap(
|
|
&self,
|
|
swap: Swap,
|
|
encoding_context: EncodingContext,
|
|
) -> Result<Vec<u8>, EncodingError> {
|
|
let token_in_address = bytes_to_address(&swap.token_in)?;
|
|
let token_out_address = bytes_to_address(&swap.token_out)?;
|
|
|
|
let zero_to_one = Self::get_zero_to_one(token_in_address, token_out_address);
|
|
let component_id = Address::from_str(&swap.component.id)
|
|
.map_err(|_| EncodingError::FatalError("Invalid USV3 component id".to_string()))?;
|
|
let mut pool_fee_bytes = swap
|
|
.component
|
|
.static_attributes
|
|
.get("pool_fee")
|
|
.ok_or_else(|| {
|
|
EncodingError::FatalError(
|
|
"Pool fee not found in Uniswap v3 static attributes".to_string(),
|
|
)
|
|
})?
|
|
.as_ref()
|
|
.to_vec();
|
|
|
|
// Reverse to get be bytes, since this is encoded as le bytes
|
|
pool_fee_bytes.reverse();
|
|
|
|
let pool_fee_u24: [u8; 3] = pool_fee_bytes[pool_fee_bytes.len() - 3..]
|
|
.try_into()
|
|
.map_err(|_| {
|
|
EncodingError::FatalError(
|
|
"Pool fee static attribute must be at least 3 bytes".to_string(),
|
|
)
|
|
})?;
|
|
|
|
let args = (
|
|
Address::from_str(self.executor_address())
|
|
.map_err(|_| EncodingError::FatalError("Invalid executor address".to_string()))?,
|
|
self.executor_selector(),
|
|
token_in_address,
|
|
token_out_address,
|
|
pool_fee_u24,
|
|
bytes_to_address(&encoding_context.receiver)?,
|
|
component_id,
|
|
zero_to_one,
|
|
encoding_context.exact_out,
|
|
);
|
|
|
|
Ok(args.abi_encode_packed())
|
|
}
|
|
|
|
fn executor_address(&self) -> &str {
|
|
&self.executor_address
|
|
}
|
|
}
|
|
|
|
pub struct BalancerV2SwapEncoder {
|
|
executor_address: String,
|
|
vault_address: String,
|
|
}
|
|
|
|
impl SwapEncoder for BalancerV2SwapEncoder {
|
|
fn new(executor_address: String) -> Self {
|
|
Self {
|
|
executor_address,
|
|
vault_address: "0xba12222222228d8ba445958a75a0704d566bf2c8".to_string(),
|
|
}
|
|
}
|
|
fn encode_swap(
|
|
&self,
|
|
swap: Swap,
|
|
encoding_context: EncodingContext,
|
|
) -> Result<Vec<u8>, EncodingError> {
|
|
let token_approvals_manager = ProtocolApprovalsManager::new()?;
|
|
let token = bytes_to_address(&swap.token_in)?;
|
|
let router_address = bytes_to_address(&encoding_context.router_address)?;
|
|
let approval_needed = token_approvals_manager.approval_needed(
|
|
token,
|
|
router_address,
|
|
Address::from_str(&self.vault_address)
|
|
.map_err(|_| EncodingError::FatalError("Invalid vault address".to_string()))?,
|
|
)?;
|
|
|
|
let component_id = AlloyBytes::from_str(&swap.component.id)
|
|
.map_err(|_| EncodingError::FatalError("Invalid component ID".to_string()))?;
|
|
|
|
let args = (
|
|
Address::from_str(self.executor_address())
|
|
.map_err(|_| EncodingError::FatalError("Invalid executor address".to_string()))?,
|
|
self.executor_selector(),
|
|
bytes_to_address(&swap.token_in)?,
|
|
bytes_to_address(&swap.token_out)?,
|
|
component_id,
|
|
bytes_to_address(&encoding_context.receiver)?,
|
|
encoding_context.exact_out,
|
|
approval_needed,
|
|
);
|
|
Ok(args.abi_encode_packed())
|
|
}
|
|
|
|
fn executor_address(&self) -> &str {
|
|
&self.executor_address
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::collections::HashMap;
|
|
|
|
use alloy::hex::encode;
|
|
use tycho_core::{dto::ProtocolComponent, Bytes};
|
|
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_encode_uniswap_v2() {
|
|
let usv2_pool = ProtocolComponent {
|
|
id: String::from("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640"),
|
|
..Default::default()
|
|
};
|
|
let swap = Swap {
|
|
component: usv2_pool,
|
|
token_in: Bytes::from("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"),
|
|
token_out: Bytes::from("0x6b175474e89094c44da98b954eedeac495271d0f"),
|
|
split: 0f64,
|
|
};
|
|
let encoding_context = EncodingContext {
|
|
receiver: Bytes::from("0x0000000000000000000000000000000000000001"),
|
|
exact_out: false,
|
|
router_address: Bytes::zero(20),
|
|
};
|
|
let encoder =
|
|
UniswapV2SwapEncoder::new(String::from("0x543778987b293C7E8Cf0722BB2e935ba6f4068D4"));
|
|
let encoded_swap = encoder
|
|
.encode_swap(swap, encoding_context)
|
|
.unwrap();
|
|
let hex_swap = encode(&encoded_swap);
|
|
assert_eq!(
|
|
hex_swap,
|
|
String::from(concat!(
|
|
// executor address
|
|
"543778987b293c7e8cf0722bb2e935ba6f4068d4",
|
|
// executor selector
|
|
"bd0625ab",
|
|
// in token
|
|
"c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
|
|
// component id
|
|
"88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
|
|
// receiver
|
|
"0000000000000000000000000000000000000001",
|
|
// zero for one
|
|
"00",
|
|
// exact out
|
|
"00",
|
|
))
|
|
);
|
|
}
|
|
#[test]
|
|
fn test_encode_uniswap_v3() {
|
|
let encoded_pool_fee: [u8; 4] = 500u32.to_le_bytes();
|
|
let mut static_attributes: HashMap<String, Bytes> = HashMap::new();
|
|
static_attributes.insert("pool_fee".into(), Bytes::from(encoded_pool_fee[..3].to_vec()));
|
|
|
|
let usv3_pool = ProtocolComponent {
|
|
id: String::from("0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640"),
|
|
static_attributes,
|
|
..Default::default()
|
|
};
|
|
let swap = Swap {
|
|
component: usv3_pool,
|
|
token_in: Bytes::from("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"),
|
|
token_out: Bytes::from("0x6b175474e89094c44da98b954eedeac495271d0f"),
|
|
split: 0f64,
|
|
};
|
|
let encoding_context = EncodingContext {
|
|
receiver: Bytes::from("0x0000000000000000000000000000000000000001"),
|
|
exact_out: false,
|
|
router_address: Bytes::zero(20),
|
|
};
|
|
let encoder =
|
|
UniswapV3SwapEncoder::new(String::from("0x543778987b293C7E8Cf0722BB2e935ba6f4068D4"));
|
|
let encoded_swap = encoder
|
|
.encode_swap(swap, encoding_context)
|
|
.unwrap();
|
|
let hex_swap = encode(&encoded_swap);
|
|
assert_eq!(
|
|
hex_swap,
|
|
String::from(concat!(
|
|
// executor address
|
|
"543778987b293c7e8cf0722bb2e935ba6f4068d4",
|
|
// executor selector
|
|
"bd0625ab",
|
|
// in token
|
|
"c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
|
|
// out token
|
|
"6b175474e89094c44da98b954eedeac495271d0f",
|
|
// fee
|
|
"0001f4",
|
|
// receiver
|
|
"0000000000000000000000000000000000000001",
|
|
// pool id
|
|
"88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
|
|
// zero for one
|
|
"00",
|
|
// exact out
|
|
"00",
|
|
))
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_encode_balancer_v2() {
|
|
let balancer_pool = ProtocolComponent {
|
|
id: String::from("0x5c6ee304399dbdb9c8ef030ab642b10820db8f56000200000000000000000014"),
|
|
protocol_system: String::from("vm:balancer_v2"),
|
|
..Default::default()
|
|
};
|
|
let swap = Swap {
|
|
component: balancer_pool,
|
|
token_in: Bytes::from("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"), // WETH
|
|
token_out: Bytes::from("0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174"), // BAL
|
|
split: 0f64,
|
|
};
|
|
let encoding_context = EncodingContext {
|
|
receiver: Bytes::from("0x0000000000000000000000000000000000000001"),
|
|
exact_out: false,
|
|
router_address: Bytes::zero(20),
|
|
};
|
|
let encoder =
|
|
BalancerV2SwapEncoder::new(String::from("0x543778987b293C7E8Cf0722BB2e935ba6f4068D4"));
|
|
let encoded_swap = encoder
|
|
.encode_swap(swap, encoding_context)
|
|
.unwrap();
|
|
let hex_swap = encode(&encoded_swap);
|
|
|
|
assert_eq!(
|
|
hex_swap,
|
|
String::from(concat!(
|
|
// executor address
|
|
"543778987b293c7e8cf0722bb2e935ba6f4068d4",
|
|
// executor selector
|
|
"bd0625ab",
|
|
// token in
|
|
"c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
|
|
// token out
|
|
"2791bca1f2de4661ed88a30c99a7a9449aa84174",
|
|
// pool id
|
|
"5c6ee304399dbdb9c8ef030ab642b10820db8f56000200000000000000000014",
|
|
// receiver
|
|
"0000000000000000000000000000000000000001",
|
|
// exact out
|
|
"00",
|
|
// approval needed
|
|
"01"
|
|
))
|
|
);
|
|
}
|
|
}
|