Struct Endpoint 

pub struct Endpoint { /* private fields */ }

Complete API endpoint configuration combining host tier and API version

The Endpoint type provides an ergonomic way to configure both the API host tier (Public/Enterprise) and version (V2/V3) together.

Examples

Using convenience constructors (recommended)

use odos_sdk::{ClientConfig, Endpoint};

// Public API V2 (default, recommended for production)
let config = ClientConfig {
    endpoint: Endpoint::public_v2(),
    ..Default::default()
};

// Enterprise API V3 (latest features)
let config = ClientConfig {
    endpoint: Endpoint::enterprise_v3(),
    ..Default::default()
};

Using explicit construction

use odos_sdk::{Endpoint, ApiHost, ApiVersion};

let endpoint = Endpoint::new(ApiHost::Enterprise, ApiVersion::V2);
assert_eq!(endpoint.quote_url().as_str(), "https://enterprise-api.odos.xyz/sor/quote/v2");

Migration from old API

use odos_sdk::{ClientConfig, Endpoint};

// Old way (still works but deprecated)
// let config = ClientConfig {
//     endpoint: EndpointBase::Public,
//     endpoint_version: EndpointVersion::V2,
//     ..Default::default()
// };

// New way
let config = ClientConfig {
    endpoint: Endpoint::public_v2(),
    ..Default::default()
};

Implementations

impl Endpoint

pub const fn new(host: ApiHost, version: ApiVersion) -> Self

Create a new endpoint with specific host and version

Examples

use odos_sdk::{Endpoint, ApiHost, ApiVersion};

let endpoint = Endpoint::new(ApiHost::Public, ApiVersion::V2);

pub const fn public_v2() -> Self

Public API V2 endpoint (default, recommended for production)

This is the recommended configuration for most production use cases.

Examples

use odos_sdk::Endpoint;

let endpoint = Endpoint::public_v2();
assert_eq!(endpoint.quote_url().as_str(), "https://api.odos.xyz/sor/quote/v2");

pub const fn public_v3() -> Self

Public API V3 endpoint

Use for latest features and optimizations on the public API.

Examples

use odos_sdk::Endpoint;

let endpoint = Endpoint::public_v3();
assert_eq!(endpoint.quote_url().as_str(), "https://api.odos.xyz/sor/quote/v3");

pub const fn enterprise_v2() -> Self

Enterprise API V2 endpoint

Use for enterprise tier with V2 API. Requires an API key.

Examples

use odos_sdk::Endpoint;

let endpoint = Endpoint::enterprise_v2();
assert_eq!(endpoint.quote_url().as_str(), "https://enterprise-api.odos.xyz/sor/quote/v2");

pub const fn enterprise_v3() -> Self

Enterprise API V3 endpoint

Use for enterprise tier with latest V3 features. Requires an API key.

Examples

use odos_sdk::Endpoint;

let endpoint = Endpoint::enterprise_v3();
assert_eq!(endpoint.quote_url().as_str(), "https://enterprise-api.odos.xyz/sor/quote/v3");

pub fn quote_url(&self) -> Url

Get the quote URL for this endpoint

Constructs the full URL for the quote endpoint by combining the base URL with the appropriate version path.

Examples

use odos_sdk::Endpoint;

let endpoint = Endpoint::public_v2();
assert_eq!(endpoint.quote_url().as_str(), "https://api.odos.xyz/sor/quote/v2");

let endpoint = Endpoint::enterprise_v3();
assert_eq!(endpoint.quote_url().as_str(), "https://enterprise-api.odos.xyz/sor/quote/v3");

pub fn assemble_url(&self) -> Url

Get the assemble URL for this endpoint

The assemble endpoint is version-independent and constructs transaction data from a previously obtained quote path ID.

Examples

use odos_sdk::Endpoint;

let endpoint = Endpoint::public_v2();
assert_eq!(endpoint.assemble_url().as_str(), "https://api.odos.xyz/sor/assemble");

pub const fn host(&self) -> ApiHost

Get the API host tier

Examples

use odos_sdk::{Endpoint, ApiHost};

let endpoint = Endpoint::public_v2();
assert_eq!(endpoint.host(), ApiHost::Public);

pub const fn version(&self) -> ApiVersion

Get the API version

Examples

use odos_sdk::{Endpoint, ApiVersion};

let endpoint = Endpoint::public_v2();
assert_eq!(endpoint.version(), ApiVersion::V2);

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Self

Returns the default endpoint: Public API V2

This is the recommended configuration for most production use cases.

impl<'de> Deserialize<'de> for Endpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Endpoint

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Endpoint

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Endpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Endpoint

impl Eq for Endpoint

impl StructuralPartialEq for Endpoint