kaccy-core 0.2.0

Core business logic for Kaccy Protocol - batching, fee optimization, and transaction management
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
//! Smart order routing for optimal trade execution across multiple venues

use rust_decimal::Decimal;
use rust_decimal_macros::dec;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use uuid::Uuid;

/// Trading venue (bonding curve, AMM, order book, etc.)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Venue {
    /// Bonding curve
    BondingCurve,
    /// AMM pool
    Amm,
    /// Order book
    OrderBook,
    /// External exchange
    External,
}

/// Quote from a venue
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VenueQuote {
    /// Venue
    pub venue: Venue,
    /// Token ID
    pub token_id: Uuid,
    /// Amount available
    pub available_amount: Decimal,
    /// Execution price
    pub price: Decimal,
    /// Expected slippage
    pub slippage: Decimal,
    /// Estimated gas/fees
    pub fees: Decimal,
    /// Liquidity depth
    pub depth: Decimal,
}

impl VenueQuote {
    /// Calculate effective price including fees
    pub fn effective_price(&self) -> Decimal {
        self.price * (dec!(1) + self.slippage) + self.fees
    }

    /// Calculate total cost for an amount
    pub fn total_cost(&self, amount: Decimal) -> Decimal {
        amount * self.effective_price()
    }
}

/// Execution route across venues
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Route {
    /// Splits across venues
    pub splits: Vec<RouteSplit>,
    /// Total amount
    pub total_amount: Decimal,
    /// Average execution price
    pub avg_price: Decimal,
    /// Total slippage
    pub total_slippage: Decimal,
    /// Total fees
    pub total_fees: Decimal,
}

/// Route split for a venue
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RouteSplit {
    /// Venue
    pub venue: Venue,
    /// Amount to execute on this venue
    pub amount: Decimal,
    /// Execution price
    pub price: Decimal,
    /// Percentage of total order
    pub percentage: Decimal,
}

/// Order routing optimizer
pub struct SmartRouter {
    /// Venue quotes cache
    venue_quotes: HashMap<(Uuid, Venue), VenueQuote>,
}

impl SmartRouter {
    /// Create a new smart router
    pub fn new() -> Self {
        Self {
            venue_quotes: HashMap::new(),
        }
    }

    /// Add a venue quote
    pub fn add_quote(&mut self, quote: VenueQuote) {
        self.venue_quotes
            .insert((quote.token_id, quote.venue), quote);
    }

    /// Find best single venue
    pub fn find_best_venue(&self, token_id: Uuid, amount: Decimal) -> Option<Venue> {
        let mut best_venue = None;
        let mut best_price = Decimal::MAX;

        for ((tid, venue), quote) in &self.venue_quotes {
            if *tid == token_id && quote.available_amount >= amount {
                let price = quote.effective_price();
                if price < best_price {
                    best_price = price;
                    best_venue = Some(*venue);
                }
            }
        }

        best_venue
    }

    /// Find optimal route (split across multiple venues)
    pub fn find_optimal_route(&self, token_id: Uuid, amount: Decimal) -> Option<Route> {
        let mut available_quotes: Vec<&VenueQuote> = self
            .venue_quotes
            .values()
            .filter(|q| q.token_id == token_id && q.available_amount > Decimal::ZERO)
            .collect();

        if available_quotes.is_empty() {
            return None;
        }

        // Sort by effective price (best first)
        available_quotes.sort_by(|a, b| {
            a.effective_price()
                .partial_cmp(&b.effective_price())
                .unwrap()
        });

        let mut splits = Vec::new();
        let mut remaining = amount;
        let mut total_cost = Decimal::ZERO;
        let mut total_fees = Decimal::ZERO;

        // Greedy algorithm: fill from best priced venue first
        for quote in available_quotes {
            if remaining.is_zero() {
                break;
            }

            let fill_amount = remaining.min(quote.available_amount);
            let cost = quote.total_cost(fill_amount);
            let percentage = fill_amount / amount;

            splits.push(RouteSplit {
                venue: quote.venue,
                amount: fill_amount,
                price: quote.price,
                percentage,
            });

            total_cost += cost;
            total_fees += quote.fees * fill_amount;
            remaining -= fill_amount;
        }

        if !remaining.is_zero() {
            return None; // Can't fill entire order
        }

        let avg_price = total_cost / amount;
        let initial_price = splits[0].price;
        let total_slippage = if initial_price.is_zero() {
            Decimal::ZERO
        } else {
            (avg_price - initial_price) / initial_price
        };

        Some(Route {
            splits,
            total_amount: amount,
            avg_price,
            total_slippage,
            total_fees,
        })
    }

    /// Get execution quality metrics
    pub fn get_execution_quality(
        &self,
        token_id: Uuid,
        amount: Decimal,
        executed_price: Decimal,
    ) -> ExecutionQuality {
        let best_venue = self.find_best_venue(token_id, amount);
        let optimal_route = self.find_optimal_route(token_id, amount);

        let benchmark_price = optimal_route
            .as_ref()
            .map(|r| r.avg_price)
            .unwrap_or(executed_price);

        let price_improvement = if benchmark_price > Decimal::ZERO {
            (benchmark_price - executed_price) / benchmark_price
        } else {
            Decimal::ZERO
        };

        ExecutionQuality {
            executed_price,
            benchmark_price,
            price_improvement,
            best_venue,
            used_routing: optimal_route.is_some(),
        }
    }
}

impl Default for SmartRouter {
    fn default() -> Self {
        Self::new()
    }
}

/// Execution quality metrics
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ExecutionQuality {
    /// Actual execution price
    pub executed_price: Decimal,
    /// Benchmark price (best available)
    pub benchmark_price: Decimal,
    /// Price improvement (positive = better than benchmark)
    pub price_improvement: Decimal,
    /// Best venue that was available
    pub best_venue: Option<Venue>,
    /// Whether routing was used
    pub used_routing: bool,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_venue_quote_effective_price() {
        let quote = VenueQuote {
            venue: Venue::Amm,
            token_id: Uuid::new_v4(),
            available_amount: dec!(1000),
            price: dec!(100),
            slippage: dec!(0.01), // 1%
            fees: dec!(0.5),
            depth: dec!(10000),
        };

        // 100 * (1 + 0.01) + 0.5 = 101.5
        assert_eq!(quote.effective_price(), dec!(101.5));
    }

    #[test]
    fn test_find_best_venue() {
        let mut router = SmartRouter::new();
        let token_id = Uuid::new_v4();

        router.add_quote(VenueQuote {
            venue: Venue::BondingCurve,
            token_id,
            available_amount: dec!(1000),
            price: dec!(105),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(5000),
        });

        router.add_quote(VenueQuote {
            venue: Venue::Amm,
            token_id,
            available_amount: dec!(1000),
            price: dec!(100),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(10000),
        });

        let best = router.find_best_venue(token_id, dec!(500));
        assert_eq!(best, Some(Venue::Amm)); // AMM has lower price
    }

    #[test]
    fn test_optimal_route_single_venue() {
        let mut router = SmartRouter::new();
        let token_id = Uuid::new_v4();

        router.add_quote(VenueQuote {
            venue: Venue::Amm,
            token_id,
            available_amount: dec!(1000),
            price: dec!(100),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(10000),
        });

        let route = router.find_optimal_route(token_id, dec!(500)).unwrap();

        assert_eq!(route.splits.len(), 1);
        assert_eq!(route.splits[0].venue, Venue::Amm);
        assert_eq!(route.splits[0].amount, dec!(500));
        assert_eq!(route.total_amount, dec!(500));
    }

    #[test]
    fn test_optimal_route_multi_venue() {
        let mut router = SmartRouter::new();
        let token_id = Uuid::new_v4();

        // AMM: cheaper but limited liquidity
        router.add_quote(VenueQuote {
            venue: Venue::Amm,
            token_id,
            available_amount: dec!(300),
            price: dec!(100),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(5000),
        });

        // Order book: more expensive but more liquidity
        router.add_quote(VenueQuote {
            venue: Venue::OrderBook,
            token_id,
            available_amount: dec!(1000),
            price: dec!(102),
            slippage: dec!(0.005),
            fees: dec!(0.3),
            depth: dec!(15000),
        });

        let route = router.find_optimal_route(token_id, dec!(500)).unwrap();

        assert_eq!(route.splits.len(), 2);
        // First 300 from AMM (cheaper)
        assert_eq!(route.splits[0].venue, Venue::Amm);
        assert_eq!(route.splits[0].amount, dec!(300));
        // Remaining 200 from OrderBook
        assert_eq!(route.splits[1].venue, Venue::OrderBook);
        assert_eq!(route.splits[1].amount, dec!(200));
        assert_eq!(route.total_amount, dec!(500));
    }

    #[test]
    fn test_route_insufficient_liquidity() {
        let mut router = SmartRouter::new();
        let token_id = Uuid::new_v4();

        router.add_quote(VenueQuote {
            venue: Venue::Amm,
            token_id,
            available_amount: dec!(100),
            price: dec!(100),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(1000),
        });

        let route = router.find_optimal_route(token_id, dec!(500));
        assert!(route.is_none()); // Not enough liquidity
    }

    #[test]
    fn test_execution_quality() {
        let mut router = SmartRouter::new();
        let token_id = Uuid::new_v4();

        router.add_quote(VenueQuote {
            venue: Venue::Amm,
            token_id,
            available_amount: dec!(1000),
            price: dec!(100),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(10000),
        });

        // Executed at better price than available
        let quality = router.get_execution_quality(token_id, dec!(500), dec!(99));

        assert_eq!(quality.executed_price, dec!(99));
        assert!(quality.price_improvement > Decimal::ZERO);
        assert_eq!(quality.best_venue, Some(Venue::Amm));
    }

    #[test]
    fn test_route_percentages() {
        let mut router = SmartRouter::new();
        let token_id = Uuid::new_v4();

        router.add_quote(VenueQuote {
            venue: Venue::Amm,
            token_id,
            available_amount: dec!(250),
            price: dec!(100),
            slippage: dec!(0.01),
            fees: dec!(0.5),
            depth: dec!(5000),
        });

        router.add_quote(VenueQuote {
            venue: Venue::OrderBook,
            token_id,
            available_amount: dec!(750),
            price: dec!(101),
            slippage: dec!(0.005),
            fees: dec!(0.3),
            depth: dec!(15000),
        });

        let route = router.find_optimal_route(token_id, dec!(1000)).unwrap();

        assert_eq!(route.splits[0].percentage, dec!(0.25)); // 250/1000
        assert_eq!(route.splits[1].percentage, dec!(0.75)); // 750/1000
    }
}