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
//! Validation utilities and helpers

use regex::Regex;
use rust_decimal::Decimal;
use std::sync::OnceLock;

/// Email validation regex
static EMAIL_REGEX: OnceLock<Regex> = OnceLock::new();

/// Username validation regex (alphanumeric, underscore, hyphen, 3-30 chars)
static USERNAME_REGEX: OnceLock<Regex> = OnceLock::new();

/// Token symbol validation regex (alphanumeric, starting with $, 2-10 chars)
static SYMBOL_REGEX: OnceLock<Regex> = OnceLock::new();

/// Bitcoin address validation regex (simplified)
static BTC_ADDRESS_REGEX: OnceLock<Regex> = OnceLock::new();

/// Validation result type
pub type ValidationResult = Result<(), ValidationError>;

/// Validation error
#[derive(Debug, Clone, thiserror::Error)]
#[error("{0}")]
pub struct ValidationError(pub String);

/// Validator trait for custom validation logic
pub trait Validator {
    /// Run validation and return the result.
    fn validate(&self) -> ValidationResult;
}

/// Email validator
pub struct EmailValidator;

impl EmailValidator {
    /// Validate email format
    pub fn validate(email: &str) -> ValidationResult {
        let regex = EMAIL_REGEX.get_or_init(|| {
            Regex::new(r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$").unwrap()
        });

        if email.is_empty() {
            return Err(ValidationError("Email is required".to_string()));
        }

        if email.len() > 255 {
            return Err(ValidationError("Email is too long".to_string()));
        }

        if !regex.is_match(email) {
            return Err(ValidationError("Invalid email format".to_string()));
        }

        Ok(())
    }
}

/// Username validator
pub struct UsernameValidator;

impl UsernameValidator {
    /// Validate username format
    pub fn validate(username: &str) -> ValidationResult {
        let regex = USERNAME_REGEX.get_or_init(|| Regex::new(r"^[a-zA-Z0-9_-]{3,30}$").unwrap());

        if username.is_empty() {
            return Err(ValidationError("Username is required".to_string()));
        }

        if !regex.is_match(username) {
            return Err(ValidationError(
                "Username must be 3-30 characters, alphanumeric, underscore or hyphen only"
                    .to_string(),
            ));
        }

        // Reserved usernames
        let reserved = &["admin", "system", "root", "kaccy", "api"];
        if reserved.contains(&username.to_lowercase().as_str()) {
            return Err(ValidationError("Username is reserved".to_string()));
        }

        Ok(())
    }
}

/// Token symbol validator
pub struct SymbolValidator;

impl SymbolValidator {
    /// Validate token symbol format
    pub fn validate(symbol: &str) -> ValidationResult {
        let regex = SYMBOL_REGEX.get_or_init(|| Regex::new(r"^\$[A-Z0-9]{1,9}$").unwrap());

        if symbol.is_empty() {
            return Err(ValidationError("Symbol is required".to_string()));
        }

        if !regex.is_match(symbol) {
            return Err(ValidationError(
                "Symbol must start with $ and contain 1-9 uppercase alphanumeric characters"
                    .to_string(),
            ));
        }

        // Reserved symbols
        let reserved = &["$BTC", "$ETH", "$USD", "$KACCY"];
        if reserved.contains(&symbol) {
            return Err(ValidationError("Symbol is reserved".to_string()));
        }

        Ok(())
    }
}

/// Bitcoin address validator
pub struct BtcAddressValidator;

impl BtcAddressValidator {
    /// Validate Bitcoin address format (basic validation)
    pub fn validate(address: &str) -> ValidationResult {
        // Basic length and format check for Bitcoin addresses
        // bc1: bech32 (26-90 chars)
        // 1: P2PKH (26-35 chars)
        // 3: P2SH (26-35 chars)
        let regex = BTC_ADDRESS_REGEX.get_or_init(|| {
            Regex::new(r"^(bc1[a-z0-9]{39,87}|[13][a-km-zA-HJ-NP-Z1-9]{25,34})$").unwrap()
        });

        if address.is_empty() {
            return Err(ValidationError("Bitcoin address is required".to_string()));
        }

        if address.len() < 26 || address.len() > 90 {
            return Err(ValidationError(
                "Bitcoin address length invalid".to_string(),
            ));
        }

        if !regex.is_match(address) {
            return Err(ValidationError(
                "Invalid Bitcoin address format".to_string(),
            ));
        }

        Ok(())
    }
}

/// String length validator
pub struct StringLengthValidator {
    min: usize,
    max: usize,
}

impl StringLengthValidator {
    /// Create a new string length validator with minimum and maximum length bounds.
    pub fn new(min: usize, max: usize) -> Self {
        Self { min, max }
    }

    /// Validate that `value` satisfies the configured length constraints.
    pub fn validate(&self, value: &str, field_name: &str) -> ValidationResult {
        let len = value.len();

        if len < self.min {
            return Err(ValidationError(format!(
                "{} must be at least {} characters",
                field_name, self.min
            )));
        }

        if len > self.max {
            return Err(ValidationError(format!(
                "{} must be at most {} characters",
                field_name, self.max
            )));
        }

        Ok(())
    }
}

/// Numeric range validator
pub struct NumericRangeValidator {
    min: Decimal,
    max: Decimal,
}

impl NumericRangeValidator {
    /// Create a new numeric range validator with inclusive min and max bounds.
    pub fn new(min: Decimal, max: Decimal) -> Self {
        Self { min, max }
    }

    /// Validate that `value` falls within the configured numeric range.
    pub fn validate(&self, value: Decimal, field_name: &str) -> ValidationResult {
        if value < self.min {
            return Err(ValidationError(format!(
                "{} must be at least {}",
                field_name, self.min
            )));
        }

        if value > self.max {
            return Err(ValidationError(format!(
                "{} must be at most {}",
                field_name, self.max
            )));
        }

        Ok(())
    }

    /// Validate that `value` is strictly positive and within the configured range.
    pub fn validate_positive(&self, value: Decimal, field_name: &str) -> ValidationResult {
        if value <= Decimal::ZERO {
            return Err(ValidationError(format!("{} must be positive", field_name)));
        }

        self.validate(value, field_name)
    }
}

/// URL validator
pub struct UrlValidator;

impl UrlValidator {
    /// Validate URL format
    pub fn validate(url: &str) -> ValidationResult {
        if url.is_empty() {
            return Err(ValidationError("URL is required".to_string()));
        }

        if !url.starts_with("http://") && !url.starts_with("https://") {
            return Err(ValidationError(
                "URL must start with http:// or https://".to_string(),
            ));
        }

        if url.len() > 2048 {
            return Err(ValidationError("URL is too long".to_string()));
        }

        Ok(())
    }

    /// Validate HTTPS URL
    pub fn validate_https(url: &str) -> ValidationResult {
        Self::validate(url)?;

        if !url.starts_with("https://") {
            return Err(ValidationError("URL must use HTTPS".to_string()));
        }

        Ok(())
    }
}

/// Collection validator
pub struct CollectionValidator;

impl CollectionValidator {
    /// Validate collection is not empty
    pub fn not_empty<T>(collection: &[T], field_name: &str) -> ValidationResult {
        if collection.is_empty() {
            return Err(ValidationError(format!("{} cannot be empty", field_name)));
        }
        Ok(())
    }

    /// Validate collection size
    pub fn size<T>(collection: &[T], min: usize, max: usize, field_name: &str) -> ValidationResult {
        let len = collection.len();

        if len < min {
            return Err(ValidationError(format!(
                "{} must contain at least {} items",
                field_name, min
            )));
        }

        if len > max {
            return Err(ValidationError(format!(
                "{} must contain at most {} items",
                field_name, max
            )));
        }

        Ok(())
    }
}

/// Aggregate multiple validation results
pub fn validate_all(validations: Vec<ValidationResult>) -> ValidationResult {
    let errors: Vec<String> = validations
        .into_iter()
        .filter_map(|r| r.err())
        .map(|e| e.0)
        .collect();

    if errors.is_empty() {
        Ok(())
    } else {
        Err(ValidationError(errors.join("; ")))
    }
}

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

    #[test]
    fn test_email_validation() {
        assert!(EmailValidator::validate("user@example.com").is_ok());
        assert!(EmailValidator::validate("test.user+tag@example.co.uk").is_ok());
        assert!(EmailValidator::validate("invalid@").is_err());
        assert!(EmailValidator::validate("@example.com").is_err());
        assert!(EmailValidator::validate("not-an-email").is_err());
        assert!(EmailValidator::validate("").is_err());
    }

    #[test]
    fn test_username_validation() {
        assert!(UsernameValidator::validate("validuser").is_ok());
        assert!(UsernameValidator::validate("user_123").is_ok());
        assert!(UsernameValidator::validate("user-name").is_ok());
        assert!(UsernameValidator::validate("ab").is_err()); // Too short
        assert!(UsernameValidator::validate("user@name").is_err()); // Invalid char
        assert!(UsernameValidator::validate("admin").is_err()); // Reserved
        assert!(UsernameValidator::validate("").is_err());
    }

    #[test]
    fn test_symbol_validation() {
        assert!(SymbolValidator::validate("$TEST").is_ok());
        assert!(SymbolValidator::validate("$ABC123").is_ok());
        assert!(SymbolValidator::validate("TEST").is_err()); // No $
        assert!(SymbolValidator::validate("$test").is_err()); // Lowercase
        assert!(SymbolValidator::validate("$TOOLONGNAME").is_err()); // Too long
        assert!(SymbolValidator::validate("$BTC").is_err()); // Reserved
        assert!(SymbolValidator::validate("").is_err());
    }

    #[test]
    fn test_btc_address_validation() {
        // Valid P2PKH address (starts with 1)
        assert!(BtcAddressValidator::validate("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa").is_ok());
        // Valid P2SH address (starts with 3)
        assert!(BtcAddressValidator::validate("3J98t1WpEZ73CNmYviecrnyiWrnqRhWNLy").is_ok());
        // Valid Bech32 address (starts with bc1)
        assert!(
            BtcAddressValidator::validate("bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq").is_ok()
        );
        // Invalid addresses
        assert!(BtcAddressValidator::validate("invalid").is_err());
        assert!(BtcAddressValidator::validate("").is_err());
        assert!(BtcAddressValidator::validate("bc1short").is_err());
    }

    #[test]
    fn test_string_length_validation() {
        let validator = StringLengthValidator::new(3, 10);
        assert!(validator.validate("test", "field").is_ok());
        assert!(validator.validate("ab", "field").is_err());
        assert!(validator.validate("toolongstring", "field").is_err());
    }

    #[test]
    fn test_numeric_range_validation() {
        let validator = NumericRangeValidator::new(dec!(0), dec!(100));
        assert!(validator.validate(dec!(50), "field").is_ok());
        assert!(validator.validate(dec!(-1), "field").is_err());
        assert!(validator.validate(dec!(101), "field").is_err());

        assert!(validator.validate_positive(dec!(10), "field").is_ok());
        assert!(validator.validate_positive(dec!(0), "field").is_err());
        assert!(validator.validate_positive(dec!(-5), "field").is_err());
    }

    #[test]
    fn test_url_validation() {
        assert!(UrlValidator::validate("https://example.com").is_ok());
        assert!(UrlValidator::validate("http://example.com/path").is_ok());
        assert!(UrlValidator::validate("example.com").is_err());
        assert!(UrlValidator::validate("ftp://example.com").is_err());
        assert!(UrlValidator::validate("").is_err());

        assert!(UrlValidator::validate_https("https://example.com").is_ok());
        assert!(UrlValidator::validate_https("http://example.com").is_err());
    }

    #[test]
    fn test_collection_validation() {
        let items = vec![1, 2, 3];
        assert!(CollectionValidator::not_empty(&items, "items").is_ok());
        assert!(CollectionValidator::size(&items, 1, 5, "items").is_ok());
        assert!(CollectionValidator::size(&items, 5, 10, "items").is_err());

        let empty: Vec<i32> = vec![];
        assert!(CollectionValidator::not_empty(&empty, "items").is_err());
    }

    #[test]
    fn test_validate_all() {
        let all_ok = vec![Ok(()), Ok(()), Ok(())];
        assert!(validate_all(all_ok).is_ok());

        let some_err = vec![
            Ok(()),
            Err(ValidationError("Error 1".to_string())),
            Err(ValidationError("Error 2".to_string())),
        ];
        let result = validate_all(some_err);
        assert!(result.is_err());
        let error_msg = result.unwrap_err().0;
        assert!(error_msg.contains("Error 1"));
        assert!(error_msg.contains("Error 2"));
    }
}