fynd-core 0.55.0

Core solving logic for Fynd DEX router
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use serde::{Deserialize, Serialize};

/// Configuration for the PriceGuard external price validation.
///
/// Controls tolerance thresholds, fail-open behavior, and whether validation
/// is enabled at all. All fields have sensible defaults via [`Default`].
///
/// On the wire (JSON), every field is optional — omitted fields fall back to
/// these defaults. See `fynd-rpc-types` for the wire representation.
#[must_use]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PriceGuardConfig {
    /// Maximum allowed deviation when `amount_out < expected`, in basis points.
    /// Solutions where the user gets less than expected by more than this are rejected.
    /// Default: 300 (3%).
    lower_tolerance_bps: u32,

    /// Maximum allowed deviation when `amount_out >= expected`, in basis points.
    /// Solutions that exceed external expectations by more than this are rejected
    /// (may indicate a bug in our pricing).
    /// Default: 10_000 (100%).
    upper_tolerance_bps: u32,

    /// Controls behavior when all providers error for reasons unrelated to pricing
    /// (network issues, API down).
    /// `true`: reject solutions when no provider can return a price.
    /// `false` (default): let solutions pass through when no provider can be reached.
    fail_on_provider_error: bool,

    /// Controls behavior when every provider returns `PriceNotFound` for the
    /// requested token pair.
    /// `true`: reject solutions for unknown token pairs.
    /// `false` (default): let solutions pass through when no provider has a price.
    fail_on_token_price_not_found: bool,

    /// Whether the price guard is enabled.
    /// Default: `false`.
    enabled: bool,
}

impl Default for PriceGuardConfig {
    fn default() -> Self {
        Self {
            lower_tolerance_bps: 300,
            upper_tolerance_bps: 10_000,
            fail_on_provider_error: false,
            fail_on_token_price_not_found: false,
            enabled: false,
        }
    }
}

impl PriceGuardConfig {
    /// Maximum allowed negative deviation in basis points (user gets less than expected).
    pub fn lower_tolerance_bps(&self) -> u32 {
        self.lower_tolerance_bps
    }

    /// Maximum allowed positive deviation in basis points (output exceeds expectation).
    pub fn upper_tolerance_bps(&self) -> u32 {
        self.upper_tolerance_bps
    }

    /// Whether solutions are rejected when all providers are unreachable.
    pub fn fail_on_provider_error(&self) -> bool {
        self.fail_on_provider_error
    }

    /// Whether solutions are rejected when no provider has a price for the pair.
    pub fn fail_on_token_price_not_found(&self) -> bool {
        self.fail_on_token_price_not_found
    }

    /// Whether price-guard validation is enabled.
    pub fn enabled(&self) -> bool {
        self.enabled
    }

    /// Set the lower tolerance threshold in basis points.
    pub fn with_lower_tolerance_bps(mut self, bps: u32) -> Self {
        self.lower_tolerance_bps = bps;
        self
    }

    /// Set the upper tolerance threshold in basis points.
    pub fn with_upper_tolerance_bps(mut self, bps: u32) -> Self {
        self.upper_tolerance_bps = bps;
        self
    }

    /// Set whether solutions are rejected when all providers error.
    pub fn with_fail_on_provider_error(mut self, fail: bool) -> Self {
        self.fail_on_provider_error = fail;
        self
    }

    /// Set whether solutions are rejected when no provider has a price.
    pub fn with_fail_on_token_price_not_found(mut self, fail: bool) -> Self {
        self.fail_on_token_price_not_found = fail;
        self
    }

    /// Enable or disable price-guard validation.
    pub fn with_enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }
}