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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
//! User leaderboards and ranking system
//!
//! This module provides functionality for tracking and displaying user rankings
//! across various metrics including trading volume, profit/loss, and reputation.

use chrono::{DateTime, Utc};
use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use uuid::Uuid;

/// Time period for leaderboard rankings
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum LeaderboardPeriod {
    /// Daily rankings (last 24 hours)
    Daily,
    /// Weekly rankings (last 7 days)
    Weekly,
    /// Monthly rankings (last 30 days)
    Monthly,
    /// All-time rankings
    AllTime,
}

impl LeaderboardPeriod {
    /// Get the cutoff timestamp for this period
    pub fn cutoff_time(&self) -> DateTime<Utc> {
        let now = Utc::now();
        match self {
            Self::Daily => now - chrono::Duration::days(1),
            Self::Weekly => now - chrono::Duration::weeks(1),
            Self::Monthly => now - chrono::Duration::days(30),
            Self::AllTime => DateTime::<Utc>::from_timestamp(0, 0).unwrap(),
        }
    }
}

/// Category for leaderboard rankings
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum LeaderboardCategory {
    /// Trading volume rankings
    TradingVolume,
    /// Profit/Loss rankings
    ProfitLoss,
    /// Reputation score rankings
    Reputation,
    /// Number of trades rankings
    TradeCount,
    /// Win rate rankings (profitable trades / total trades)
    WinRate,
    /// Average trade size rankings
    AverageTradeSize,
    /// Liquidity provided rankings
    LiquidityProvided,
    /// Referral earnings rankings
    ReferralEarnings,
}

impl LeaderboardCategory {
    /// Get a human-readable name for the category
    pub fn name(&self) -> &'static str {
        match self {
            Self::TradingVolume => "Trading Volume",
            Self::ProfitLoss => "Profit/Loss",
            Self::Reputation => "Reputation",
            Self::TradeCount => "Trade Count",
            Self::WinRate => "Win Rate",
            Self::AverageTradeSize => "Average Trade Size",
            Self::LiquidityProvided => "Liquidity Provided",
            Self::ReferralEarnings => "Referral Earnings",
        }
    }
}

/// Achievement badge for user accomplishments
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Badge {
    /// Badge ID
    pub id: String,
    /// Badge name
    pub name: String,
    /// Badge description
    pub description: String,
    /// Badge tier (Bronze, Silver, Gold, etc.)
    pub tier: BadgeTier,
    /// When the badge was earned
    pub earned_at: DateTime<Utc>,
}

/// Badge tier levels
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
pub enum BadgeTier {
    /// Bronze tier
    Bronze,
    /// Silver tier
    Silver,
    /// Gold tier
    Gold,
    /// Platinum tier
    Platinum,
    /// Diamond tier
    Diamond,
    /// Legendary tier
    Legendary,
}

impl BadgeTier {
    /// Get the tier name
    pub fn name(&self) -> &'static str {
        match self {
            Self::Bronze => "Bronze",
            Self::Silver => "Silver",
            Self::Gold => "Gold",
            Self::Platinum => "Platinum",
            Self::Diamond => "Diamond",
            Self::Legendary => "Legendary",
        }
    }
}

/// User entry in a leaderboard
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LeaderboardEntry {
    /// Rank position (1-indexed)
    pub rank: u32,
    /// User ID
    pub user_id: Uuid,
    /// Username
    pub username: String,
    /// Metric value
    pub value: Decimal,
    /// Change in rank since last period (-1 = down, 0 = same, 1 = up)
    pub rank_change: i32,
    /// User's badges
    pub badges: Vec<Badge>,
    /// Last updated timestamp
    pub updated_at: DateTime<Utc>,
}

/// Leaderboard with user rankings
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Leaderboard {
    /// Leaderboard category
    pub category: LeaderboardCategory,
    /// Time period
    pub period: LeaderboardPeriod,
    /// Ranked entries
    pub entries: Vec<LeaderboardEntry>,
    /// Total number of participants
    pub total_participants: u32,
    /// Last updated timestamp
    pub updated_at: DateTime<Utc>,
}

impl Leaderboard {
    /// Create a new leaderboard
    pub fn new(category: LeaderboardCategory, period: LeaderboardPeriod) -> Self {
        Self {
            category,
            period,
            entries: Vec::new(),
            total_participants: 0,
            updated_at: Utc::now(),
        }
    }

    /// Get the top N entries
    pub fn top(&self, n: usize) -> &[LeaderboardEntry] {
        &self.entries[..self.entries.len().min(n)]
    }

    /// Find a user's rank
    pub fn find_user_rank(&self, user_id: Uuid) -> Option<u32> {
        self.entries
            .iter()
            .find(|e| e.user_id == user_id)
            .map(|e| e.rank)
    }

    /// Get percentile for a user (0.0 to 1.0)
    pub fn user_percentile(&self, user_id: Uuid) -> Option<f64> {
        self.find_user_rank(user_id).map(|rank| {
            if self.total_participants == 0 {
                0.0
            } else {
                1.0 - (rank as f64 / self.total_participants as f64)
            }
        })
    }
}

/// Leaderboard manager for updating and querying rankings
pub struct LeaderboardManager {
    /// Cached leaderboards by category and period
    leaderboards: HashMap<(LeaderboardCategory, LeaderboardPeriod), Leaderboard>,
    /// Previous rankings for tracking changes
    previous_rankings: HashMap<(LeaderboardCategory, LeaderboardPeriod, Uuid), u32>,
}

impl LeaderboardManager {
    /// Create a new leaderboard manager
    pub fn new() -> Self {
        Self {
            leaderboards: HashMap::new(),
            previous_rankings: HashMap::new(),
        }
    }

    /// Update a leaderboard with new data
    pub fn update_leaderboard(
        &mut self,
        category: LeaderboardCategory,
        period: LeaderboardPeriod,
        mut user_data: Vec<(Uuid, String, Decimal, Vec<Badge>)>,
    ) {
        // Store previous rankings
        if let Some(prev_leaderboard) = self.leaderboards.get(&(category, period)) {
            for entry in &prev_leaderboard.entries {
                self.previous_rankings
                    .insert((category, period, entry.user_id), entry.rank);
            }
        }

        // Sort by value descending
        user_data.sort_by(|a, b| b.2.cmp(&a.2));

        // Create ranked entries
        let entries: Vec<LeaderboardEntry> = user_data
            .into_iter()
            .enumerate()
            .map(|(idx, (user_id, username, value, badges))| {
                let rank = (idx + 1) as u32;
                let prev_rank = self
                    .previous_rankings
                    .get(&(category, period, user_id))
                    .copied();

                let rank_change = if let Some(prev) = prev_rank {
                    (prev as i32) - (rank as i32) // Positive = improved rank
                } else {
                    0
                };

                LeaderboardEntry {
                    rank,
                    user_id,
                    username,
                    value,
                    rank_change,
                    badges,
                    updated_at: Utc::now(),
                }
            })
            .collect();

        let total_participants = entries.len() as u32;

        let leaderboard = Leaderboard {
            category,
            period,
            entries,
            total_participants,
            updated_at: Utc::now(),
        };

        self.leaderboards.insert((category, period), leaderboard);
    }

    /// Get a leaderboard by category and period
    pub fn get_leaderboard(
        &self,
        category: LeaderboardCategory,
        period: LeaderboardPeriod,
    ) -> Option<&Leaderboard> {
        self.leaderboards.get(&(category, period))
    }

    /// Get all leaderboards for a period
    pub fn get_period_leaderboards(&self, period: LeaderboardPeriod) -> Vec<&Leaderboard> {
        self.leaderboards
            .iter()
            .filter(|((_, p), _)| *p == period)
            .map(|(_, lb)| lb)
            .collect()
    }

    /// Get user's ranking across all categories
    pub fn get_user_rankings(
        &self,
        user_id: Uuid,
        period: LeaderboardPeriod,
    ) -> HashMap<LeaderboardCategory, u32> {
        self.leaderboards
            .iter()
            .filter(|((_, p), _)| *p == period)
            .filter_map(|((cat, _), lb)| lb.find_user_rank(user_id).map(|rank| (*cat, rank)))
            .collect()
    }

    /// Check if a user should earn a badge
    pub fn check_badge_eligibility(
        &self,
        user_id: Uuid,
        category: LeaderboardCategory,
    ) -> Option<Badge> {
        // Check all-time leaderboard for badge eligibility
        if let Some(leaderboard) = self.get_leaderboard(category, LeaderboardPeriod::AllTime) {
            if let Some(rank) = leaderboard.find_user_rank(user_id) {
                return match rank {
                    1 => Some(Badge {
                        id: format!("{:?}_legendary", category),
                        name: format!("{} Champion", category.name()),
                        description: format!("Ranked #1 in {} all-time", category.name()),
                        tier: BadgeTier::Legendary,
                        earned_at: Utc::now(),
                    }),
                    2..=10 => Some(Badge {
                        id: format!("{:?}_diamond", category),
                        name: format!("{} Master", category.name()),
                        description: format!("Ranked top 10 in {} all-time", category.name()),
                        tier: BadgeTier::Diamond,
                        earned_at: Utc::now(),
                    }),
                    11..=50 => Some(Badge {
                        id: format!("{:?}_platinum", category),
                        name: format!("{} Expert", category.name()),
                        description: format!("Ranked top 50 in {} all-time", category.name()),
                        tier: BadgeTier::Platinum,
                        earned_at: Utc::now(),
                    }),
                    51..=100 => Some(Badge {
                        id: format!("{:?}_gold", category),
                        name: format!("{} Professional", category.name()),
                        description: format!("Ranked top 100 in {} all-time", category.name()),
                        tier: BadgeTier::Gold,
                        earned_at: Utc::now(),
                    }),
                    101..=500 => Some(Badge {
                        id: format!("{:?}_silver", category),
                        name: format!("{} Enthusiast", category.name()),
                        description: format!("Ranked top 500 in {} all-time", category.name()),
                        tier: BadgeTier::Silver,
                        earned_at: Utc::now(),
                    }),
                    _ => None,
                };
            }
        }
        None
    }
}

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

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

    #[test]
    fn test_leaderboard_creation() {
        let leaderboard =
            Leaderboard::new(LeaderboardCategory::TradingVolume, LeaderboardPeriod::Daily);

        assert_eq!(leaderboard.category, LeaderboardCategory::TradingVolume);
        assert_eq!(leaderboard.period, LeaderboardPeriod::Daily);
        assert_eq!(leaderboard.entries.len(), 0);
        assert_eq!(leaderboard.total_participants, 0);
    }

    #[test]
    fn test_leaderboard_manager_update() {
        let mut manager = LeaderboardManager::new();

        let user1 = Uuid::new_v4();
        let user2 = Uuid::new_v4();
        let user3 = Uuid::new_v4();

        let data = vec![
            (user1, "alice".to_string(), dec!(1000), vec![]),
            (user2, "bob".to_string(), dec!(2000), vec![]),
            (user3, "charlie".to_string(), dec!(1500), vec![]),
        ];

        manager.update_leaderboard(
            LeaderboardCategory::TradingVolume,
            LeaderboardPeriod::Daily,
            data,
        );

        let leaderboard = manager
            .get_leaderboard(LeaderboardCategory::TradingVolume, LeaderboardPeriod::Daily)
            .unwrap();

        assert_eq!(leaderboard.entries.len(), 3);
        assert_eq!(leaderboard.entries[0].rank, 1);
        assert_eq!(leaderboard.entries[0].user_id, user2); // bob has highest volume
        assert_eq!(leaderboard.entries[1].rank, 2);
        assert_eq!(leaderboard.entries[1].user_id, user3); // charlie is second
        assert_eq!(leaderboard.entries[2].rank, 3);
        assert_eq!(leaderboard.entries[2].user_id, user1); // alice is third
    }

    #[test]
    fn test_rank_changes() {
        let mut manager = LeaderboardManager::new();

        let user1 = Uuid::new_v4();
        let user2 = Uuid::new_v4();

        // First update
        manager.update_leaderboard(
            LeaderboardCategory::TradingVolume,
            LeaderboardPeriod::Daily,
            vec![
                (user1, "alice".to_string(), dec!(1000), vec![]),
                (user2, "bob".to_string(), dec!(500), vec![]),
            ],
        );

        // Second update - positions changed
        manager.update_leaderboard(
            LeaderboardCategory::TradingVolume,
            LeaderboardPeriod::Daily,
            vec![
                (user1, "alice".to_string(), dec!(500), vec![]),
                (user2, "bob".to_string(), dec!(1000), vec![]),
            ],
        );

        let leaderboard = manager
            .get_leaderboard(LeaderboardCategory::TradingVolume, LeaderboardPeriod::Daily)
            .unwrap();

        // bob moved from rank 2 to rank 1 (improved by 1)
        assert_eq!(leaderboard.entries[0].user_id, user2);
        assert_eq!(leaderboard.entries[0].rank_change, 1);

        // alice moved from rank 1 to rank 2 (declined by 1)
        assert_eq!(leaderboard.entries[1].user_id, user1);
        assert_eq!(leaderboard.entries[1].rank_change, -1);
    }

    #[test]
    fn test_find_user_rank() {
        let mut manager = LeaderboardManager::new();
        let user1 = Uuid::new_v4();
        let user2 = Uuid::new_v4();

        manager.update_leaderboard(
            LeaderboardCategory::Reputation,
            LeaderboardPeriod::AllTime,
            vec![
                (user1, "alice".to_string(), dec!(1000), vec![]),
                (user2, "bob".to_string(), dec!(500), vec![]),
            ],
        );

        let leaderboard = manager
            .get_leaderboard(LeaderboardCategory::Reputation, LeaderboardPeriod::AllTime)
            .unwrap();

        assert_eq!(leaderboard.find_user_rank(user1), Some(1));
        assert_eq!(leaderboard.find_user_rank(user2), Some(2));
    }

    #[test]
    fn test_user_percentile() {
        let mut manager = LeaderboardManager::new();
        let user1 = Uuid::new_v4();
        let user2 = Uuid::new_v4();
        let user3 = Uuid::new_v4();
        let user4 = Uuid::new_v4();

        manager.update_leaderboard(
            LeaderboardCategory::TradingVolume,
            LeaderboardPeriod::Monthly,
            vec![
                (user1, "alice".to_string(), dec!(1000), vec![]),
                (user2, "bob".to_string(), dec!(800), vec![]),
                (user3, "charlie".to_string(), dec!(600), vec![]),
                (user4, "dave".to_string(), dec!(400), vec![]),
            ],
        );

        let leaderboard = manager
            .get_leaderboard(
                LeaderboardCategory::TradingVolume,
                LeaderboardPeriod::Monthly,
            )
            .unwrap();

        // user1 is rank 1 out of 4 = 75th percentile (1 - 1/4)
        assert_eq!(leaderboard.user_percentile(user1), Some(0.75));

        // user4 is rank 4 out of 4 = 0th percentile (1 - 4/4)
        assert_eq!(leaderboard.user_percentile(user4), Some(0.0));
    }

    #[test]
    fn test_badge_eligibility() {
        let mut manager = LeaderboardManager::new();
        let user1 = Uuid::new_v4();
        let user2 = Uuid::new_v4();

        manager.update_leaderboard(
            LeaderboardCategory::ProfitLoss,
            LeaderboardPeriod::AllTime,
            vec![
                (user1, "alice".to_string(), dec!(10000), vec![]),
                (user2, "bob".to_string(), dec!(5000), vec![]),
            ],
        );

        let badge1 = manager.check_badge_eligibility(user1, LeaderboardCategory::ProfitLoss);
        assert!(badge1.is_some());
        let badge1 = badge1.unwrap();
        assert_eq!(badge1.tier, BadgeTier::Legendary);
        assert!(badge1.name.contains("Champion"));

        let badge2 = manager.check_badge_eligibility(user2, LeaderboardCategory::ProfitLoss);
        assert!(badge2.is_some());
        let badge2 = badge2.unwrap();
        assert_eq!(badge2.tier, BadgeTier::Diamond);
        assert!(badge2.name.contains("Master"));
    }

    #[test]
    fn test_top_n_entries() {
        let mut leaderboard =
            Leaderboard::new(LeaderboardCategory::TradeCount, LeaderboardPeriod::Weekly);

        for i in 0..10 {
            leaderboard.entries.push(LeaderboardEntry {
                rank: i + 1,
                user_id: Uuid::new_v4(),
                username: format!("user{}", i),
                value: dec!(100) - Decimal::from(i),
                rank_change: 0,
                badges: vec![],
                updated_at: Utc::now(),
            });
        }

        let top_3 = leaderboard.top(3);
        assert_eq!(top_3.len(), 3);
        assert_eq!(top_3[0].rank, 1);
        assert_eq!(top_3[1].rank, 2);
        assert_eq!(top_3[2].rank, 3);
    }

    #[test]
    fn test_category_names() {
        assert_eq!(LeaderboardCategory::TradingVolume.name(), "Trading Volume");
        assert_eq!(LeaderboardCategory::ProfitLoss.name(), "Profit/Loss");
        assert_eq!(LeaderboardCategory::Reputation.name(), "Reputation");
        assert_eq!(LeaderboardCategory::TradeCount.name(), "Trade Count");
    }

    #[test]
    fn test_badge_tiers() {
        assert!(BadgeTier::Legendary > BadgeTier::Diamond);
        assert!(BadgeTier::Diamond > BadgeTier::Platinum);
        assert!(BadgeTier::Platinum > BadgeTier::Gold);
        assert!(BadgeTier::Gold > BadgeTier::Silver);
        assert!(BadgeTier::Silver > BadgeTier::Bronze);
    }

    #[test]
    fn test_period_cutoff_times() {
        let now = Utc::now();
        let daily_cutoff = LeaderboardPeriod::Daily.cutoff_time();
        let weekly_cutoff = LeaderboardPeriod::Weekly.cutoff_time();
        let monthly_cutoff = LeaderboardPeriod::Monthly.cutoff_time();

        assert!(daily_cutoff < now);
        assert!(weekly_cutoff < daily_cutoff);
        assert!(monthly_cutoff < weekly_cutoff);
    }
}