V3Router

Struct V3Router 

Source
pub struct V3Router<N: Network = Ethereum, P: Provider<N> = RootProvider<N>> { /* private fields */ }
Expand description

The V3 SOR Router contract.

This router is generic over the network type, allowing it to work with both standard Ethereum networks and OP-stack networks (Optimism, Base, Fraxtal).

§Type Parameters

  • N: The network type (defaults to Ethereum). Use op_alloy_network::Optimism for OP-stack chains.
  • P: The provider type.

§Example

use odos_sdk::V3Router;
use alloy_network::Ethereum;
use alloy_provider::ProviderBuilder;

// Standard Ethereum usage
let provider = ProviderBuilder::new().connect_http("https://eth.llamarpc.com".parse()?);
let router: V3Router<Ethereum, _> = V3Router::new(address, provider);

// OP-stack usage (requires op-stack feature)
#[cfg(feature = "op-stack")]
{
    use odos_sdk::op_stack::Optimism;
    let op_provider = ProviderBuilder::new()
        .network::<Optimism>()
        .connect_http("https://mainnet.base.org".parse()?);
    let op_router: V3Router<Optimism, _> = V3Router::new(address, op_provider);
}

Implementations§

Source§

impl<N: Network, P: Provider<N>> V3Router<N, P>

Source

pub fn new(address: Address, provider: P) -> Self

Creates a new V3 router instance.

Source

pub async fn owner(&self) -> Result<Address, Error>

Returns the contract owner address.

Source

pub async fn liquidator_address(&self) -> Result<Address, Error>

Returns the liquidator address.

Source

pub fn build_swap_router_funds_call( &self, input_token_info: inputTokenInfo, output_token_info: outputTokenInfo, inputs: &SwapInputs, from: Address, ) -> CallBuilder<&P, PhantomData<swapRouterFundsCall>, N>

Builds a swap call using router funds.

Source

pub fn transfer_router_funds( &self, from: Address, token: Address, amount: U256, output_recipient: Address, ) -> CallBuilder<&P, PhantomData<transferRouterFundsCall>, N>

Transfers router funds to a recipient.

Source

pub fn transfer_router_funds_calldata( &self, from: Address, token: Address, amount: U256, output_recipient: Address, ) -> Vec<u8>

Returns the calldata for a transfer router funds call.

Trait Implementations§

Source§

impl<N: Clone + Network, P: Clone + Provider<N>> Clone for V3Router<N, P>

Source§

fn clone(&self) -> V3Router<N, P>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<N: Debug + Network, P: Debug + Provider<N>> Debug for V3Router<N, P>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<N, P> Freeze for V3Router<N, P>
where P: Freeze,

§

impl<N, P> RefUnwindSafe for V3Router<N, P>

§

impl<N, P> Send for V3Router<N, P>

§

impl<N, P> Sync for V3Router<N, P>

§

impl<N, P> Unpin for V3Router<N, P>
where P: Unpin, N: Unpin,

§

impl<N, P> UnwindSafe for V3Router<N, P>
where P: UnwindSafe, N: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more