RouterType

Enum RouterType 

Source
pub enum RouterType {
    LimitOrder,
    V2,
    V3,
}
Expand description

Represents the different types of Odos routers.

Different chains support different combinations of these router types. Use the OdosChain trait methods to check router availability per chain.

§Event Schemas

Important: Router types emit fundamentally different events:

Router TypeEvents Emitted
V2Swap, SwapMulti
V3Swap, SwapMulti (with referral/slippage fields)
LimitOrderLimitOrderFilled, LimitOrderCancelled, etc.

When iterating over router types for event processing, use swap_routers() to get only routers that emit Swap/SwapMulti events, or order_routers() for limit order routers.

§Example

use odos_sdk::RouterType;

// When processing swap events, iterate only over swap routers
for router_type in RouterType::swap_routers() {
    // V2 and V3 both emit Swap/SwapMulti events
    assert!(router_type.emits_swap_events());
}

// LimitOrder routers require separate event handling
for router_type in RouterType::order_routers() {
    assert!(!router_type.emits_swap_events());
}

Variants§

§

LimitOrder

Limit Order V2 router for limit order functionality.

Available on all supported chains.

Note: This router emits LimitOrderFilled, LimitOrderCancelled, and other limit order-specific events. It does not emit Swap or SwapMulti events like V2/V3 routers. Use emits_swap_events() to check event compatibility, or swap_routers() to iterate only over routers that emit swap events.

§

V2

V2 router for swap functionality.

Available on all supported chains.

Emits Swap and SwapMulti events.

§

V3

V3 router for enhanced swap functionality.

Available on all supported chains (unified address via CREATE2).

Emits Swap and SwapMulti events (with additional referral/slippage fields compared to V2).

Implementations§

Source§

impl RouterType

Source

pub const fn all() -> [RouterType; 3]

Returns all possible router types.

Note: This includes both swap routers (V2, V3) and order routers (LimitOrder), which emit different event types. For event processing, consider using swap_routers() or order_routers() instead.

Source

pub const fn swap_routers() -> [RouterType; 2]

Returns router types that emit Swap and SwapMulti events.

Use this when iterating over routers for swap event processing. Both V2 and V3 routers emit these events (with slightly different schemas).

§Example
use odos_sdk::RouterType;

// Process only routers that emit swap events
for router_type in RouterType::swap_routers() {
    println!("Processing swap events for {:?}", router_type);
}
Source

pub const fn order_routers() -> [RouterType; 1]

Returns router types that emit limit order events (LimitOrderFilled, etc.).

Use this when iterating over routers for limit order event processing.

§Example
use odos_sdk::RouterType;

// Process only routers that emit limit order events
for router_type in RouterType::order_routers() {
    println!("Processing order events for {:?}", router_type);
}
Source

pub const fn emits_swap_events(&self) -> bool

Returns whether this router type emits Swap and SwapMulti events.

§Example
use odos_sdk::RouterType;

assert!(RouterType::V2.emits_swap_events());
assert!(RouterType::V3.emits_swap_events());
assert!(!RouterType::LimitOrder.emits_swap_events());
Source

pub const fn emits_order_events(&self) -> bool

Returns whether this router type emits limit order events.

§Example
use odos_sdk::RouterType;

assert!(RouterType::LimitOrder.emits_order_events());
assert!(!RouterType::V2.emits_order_events());
assert!(!RouterType::V3.emits_order_events());
Source

pub const fn as_str(&self) -> &'static str

Returns the router type as a string identifier.

Trait Implementations§

Source§

impl Clone for RouterType

Source§

fn clone(&self) -> RouterType

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 Debug for RouterType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RouterType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for RouterType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RouterType

Source§

fn eq(&self, other: &RouterType) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for RouterType

Source§

impl Eq for RouterType

Source§

impl StructuralPartialEq for RouterType

Auto Trait Implementations§

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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