nautilus-model 0.55.0

Domain model for the Nautilus trading engine
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
109
110
111
112
113
114

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

//! Python bindings for size estimation.

use pyo3::prelude::*;

use crate::defi::pool_analysis::size_estimator::SizeForImpactResult;

#[pymethods]
#[pyo3_stub_gen::derive::gen_stub_pymethods]
impl SizeForImpactResult {
    #[getter]
    #[pyo3(name = "target_impact_bps")]
    fn py_target_impact_bps(&self) -> u32 {
        self.target_impact_bps
    }

    #[getter]
    #[pyo3(name = "size")]
    fn py_size(&self) -> String {
        self.size.to_string()
    }

    #[getter]
    #[pyo3(name = "actual_impact_bps")]
    fn py_actual_impact_bps(&self) -> u32 {
        self.actual_impact_bps
    }

    #[getter]
    #[pyo3(name = "zero_for_one")]
    fn py_zero_for_one(&self) -> bool {
        self.zero_for_one
    }

    #[getter]
    #[pyo3(name = "iterations")]
    fn py_iterations(&self) -> u32 {
        self.iterations
    }

    #[getter]
    #[pyo3(name = "converged")]
    fn py_converged(&self) -> bool {
        self.converged
    }

    #[getter]
    #[pyo3(name = "expansion_count")]
    fn py_expansion_count(&self) -> u32 {
        self.expansion_count
    }

    #[getter]
    #[pyo3(name = "initial_high")]
    fn py_initial_high(&self) -> String {
        self.initial_high.to_string()
    }

    #[getter]
    #[pyo3(name = "final_low")]
    fn py_final_low(&self) -> String {
        self.final_low.to_string()
    }

    #[getter]
    #[pyo3(name = "final_high")]
    fn py_final_high(&self) -> String {
        self.final_high.to_string()
    }

    /// Check if the result is within the specified tolerance.
    #[pyo3(name = "within_tolerance")]
    fn py_within_tolerance(&self, tolerance_bps: u32) -> bool {
        self.within_tolerance(tolerance_bps)
    }

    /// Get the convergence quality as a percentage.
    ///
    /// # Returns
    /// Accuracy percentage (100.0 = perfect match, lower = less accurate)
    #[pyo3(name = "accuracy_percent")]
    fn py_accuracy_percent(&self) -> f64 {
        self.accuracy_percent()
    }

    fn __str__(&self) -> String {
        format!(
            "SizeForImpactResult(target={}bps, actual={}bps, size={}, converged={}, iterations={})",
            self.target_impact_bps,
            self.actual_impact_bps,
            self.size,
            self.converged,
            self.iterations,
        )
    }

    fn __repr__(&self) -> String {
        format!("{self:?}")
    }
}