kora-lib 2.0.5

Core library for Kora gasless relayer
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
use std::{collections::HashSet, sync::Arc};

use deadpool_redis::Runtime;
use redis::AsyncCommands;
use solana_sdk::{pubkey::Pubkey, transaction::VersionedTransaction};
use tokio::sync::OnceCell;

use super::usage_store::{RedisUsageStore, UsageStore};
use crate::{error::KoraError, sanitize_error, state::get_signer_pool};

#[cfg(not(test))]
use crate::state::get_config;

#[cfg(test)]
use crate::tests::config_mock::mock_state::get_config;

const USAGE_CACHE_KEY: &str = "kora:usage_limit";

/// Global usage limiter instance
static USAGE_LIMITER: OnceCell<Option<UsageTracker>> = OnceCell::const_new();

pub struct UsageTracker {
    store: Arc<dyn UsageStore>,
    max_transactions: u64,
    kora_signers: HashSet<Pubkey>,
    fallback_if_unavailable: bool,
}

impl UsageTracker {
    pub fn new(
        store: Arc<dyn UsageStore>,
        max_transactions: u64,
        kora_signers: HashSet<Pubkey>,
        fallback_if_unavailable: bool,
    ) -> Self {
        Self { store, max_transactions, kora_signers, fallback_if_unavailable }
    }

    fn get_usage_key(&self, wallet: &Pubkey) -> String {
        format!("{USAGE_CACHE_KEY}:{wallet}")
    }

    /// Handle store errors according to fallback configuration
    fn handle_store_error(
        &self,
        error: KoraError,
        operation: &str,
        wallet: &Pubkey,
    ) -> Result<(), KoraError> {
        log::error!("Failed to {operation} for {wallet}: {error}");
        if self.fallback_if_unavailable {
            log::error!("Fallback enabled - allowing transaction due to store error");
            Ok(()) // Allow transaction when fallback is enabled
        } else {
            Err(KoraError::InternalServerError(format!(
                "Usage limit store unavailable and fallback disabled: {error}"
            )))
        }
    }

    async fn check_usage_limit(&self, wallet: &Pubkey) -> Result<(), KoraError> {
        // Skip check if unlimited (0)
        if self.max_transactions == 0 {
            return Ok(());
        }

        // Check current count first, then increment only if allowed
        let key = self.get_usage_key(wallet);

        // Handle store.get() errors using helper
        let current_count = match self.store.get(&key).await {
            Ok(count) => count,
            Err(e) => {
                return self.handle_store_error(e, "get usage count", wallet);
            }
        };

        if current_count >= self.max_transactions as u32 {
            return Err(KoraError::UsageLimitExceeded(format!(
                "Wallet {wallet} exceeded limit: {}/{}",
                current_count + 1,
                self.max_transactions
            )));
        }

        // Handle store.increment() errors using helper
        let new_count = match self.store.increment(&key).await {
            Ok(count) => count,
            Err(e) => {
                return self.handle_store_error(e, "increment usage count", wallet);
            }
        };

        log::debug!("Usage check passed for {wallet}: {new_count}/{}", self.max_transactions);

        Ok(())
    }

    fn get_usage_limiter() -> Result<Option<&'static UsageTracker>, KoraError> {
        match USAGE_LIMITER.get() {
            Some(limiter) => Ok(limiter.as_ref()),
            None => {
                Err(KoraError::InternalServerError("Usage limiter not initialized".to_string()))
            }
        }
    }

    /// Extract sender from transaction
    fn extract_transaction_sender(
        &self,
        transaction: &VersionedTransaction,
    ) -> Result<Option<Pubkey>, KoraError> {
        let account_keys = transaction.message.static_account_keys();

        if account_keys.is_empty() {
            return Err(KoraError::InvalidTransaction(
                "Transaction has no account keys".to_string(),
            ));
        }

        let signers = account_keys
            .iter()
            .take(transaction.message.header().num_required_signatures as usize)
            .collect::<Vec<_>>();

        for signer in &signers {
            if !self.kora_signers.contains(signer) {
                return Ok(Some(**signer));
            }
        }

        log::debug!(
            "No user signers found when extracting transaction sender for usage limit: {signers:?}",
        );

        Ok(None)
    }

    /// Initialize the global usage limiter
    pub async fn init_usage_limiter() -> Result<(), KoraError> {
        let config = get_config()?;

        if !config.kora.usage_limit.enabled {
            log::info!("Usage limiting disabled");
            USAGE_LIMITER.set(None).map_err(|_| {
                KoraError::InternalServerError("Usage limiter already initialized".to_string())
            })?;
            return Ok(());
        }

        let usage_limiter = if let Some(cache_url) = &config.kora.usage_limit.cache_url {
            let cfg = deadpool_redis::Config::from_url(cache_url);
            let pool = cfg.create_pool(Some(Runtime::Tokio1)).map_err(|e| {
                KoraError::InternalServerError(format!(
                    "Failed to create Redis pool: {}",
                    sanitize_error!(e)
                ))
            })?;

            // Test Redis connection
            let mut conn = pool.get().await.map_err(|e| {
                KoraError::InternalServerError(format!(
                    "Failed to connect to Redis: {}",
                    sanitize_error!(e)
                ))
            })?;

            // Simple connection test
            let _: Option<String> = conn.get("__usage_limiter_test__").await.map_err(|e| {
                KoraError::InternalServerError(format!(
                    "Redis connection test failed: {}",
                    sanitize_error!(e)
                ))
            })?;

            log::info!(
                "Usage limiter initialized with max {} transactions",
                config.kora.usage_limit.max_transactions
            );

            let kora_signers = get_signer_pool()?
                .get_signers_info()
                .iter()
                .filter_map(|info| info.public_key.parse().ok())
                .collect();

            let store = Arc::new(RedisUsageStore::new(pool));
            Some(UsageTracker::new(
                store,
                config.kora.usage_limit.max_transactions,
                kora_signers,
                config.kora.usage_limit.fallback_if_unavailable,
            ))
        } else {
            log::info!("Usage limiting enabled but no cache_url configured - disabled");
            None
        };

        USAGE_LIMITER.set(usage_limiter).map_err(|_| {
            KoraError::InternalServerError("Usage limiter already initialized".to_string())
        })?;

        Ok(())
    }

    /// Check usage limit for transaction sender
    pub async fn check_transaction_usage_limit(
        transaction: &VersionedTransaction,
    ) -> Result<(), KoraError> {
        let config = get_config()?;

        if let Some(limiter) = Self::get_usage_limiter()? {
            let sender = limiter.extract_transaction_sender(transaction)?;
            if let Some(sender) = sender {
                limiter.check_usage_limit(&sender).await?;
            }
            Ok(())
        } else if config.kora.usage_limit.enabled
            && !config.kora.usage_limit.fallback_if_unavailable
        {
            // Usage limiting enabled but limiter unavailable and fallback disabled
            Err(KoraError::InternalServerError(
                "Usage limiter unavailable and fallback disabled".to_string(),
            ))
        } else {
            // Usage limiting disabled or fallback allowed
            Ok(())
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        tests::{config_mock::ConfigMockBuilder, transaction_mock::create_mock_transaction},
        usage_limit::{usage_store::ErrorUsageStore, InMemoryUsageStore},
    };

    #[tokio::test]
    async fn test_get_usage_key_format() {
        let wallet = Pubkey::new_unique();
        let expected_key = format!("kora:usage_limit:{wallet}");

        assert_eq!(expected_key, format!("kora:usage_limit:{wallet}"));
    }

    #[tokio::test]
    async fn test_usage_limit_enforcement() {
        let store = Arc::new(InMemoryUsageStore::new());
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 2, kora_signers, true);

        let wallet = Pubkey::new_unique();

        // First transaction should succeed
        assert!(tracker.check_usage_limit(&wallet).await.is_ok());

        // Second transaction should succeed (at limit)
        assert!(tracker.check_usage_limit(&wallet).await.is_ok());

        // Third transaction should fail (over limit)
        let result = tracker.check_usage_limit(&wallet).await;
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("exceeded limit"));
    }

    #[tokio::test]
    async fn test_independent_wallet_limits() {
        let store = Arc::new(InMemoryUsageStore::new());
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 2, kora_signers, true);

        let wallet1 = Pubkey::new_unique();
        let wallet2 = Pubkey::new_unique();

        // Use up wallet1's limit
        assert!(tracker.check_usage_limit(&wallet1).await.is_ok());
        assert!(tracker.check_usage_limit(&wallet1).await.is_ok());
        assert!(tracker.check_usage_limit(&wallet1).await.is_err());

        // Wallet2 should still be able to make transactions
        assert!(tracker.check_usage_limit(&wallet2).await.is_ok());
        assert!(tracker.check_usage_limit(&wallet2).await.is_ok());
        assert!(tracker.check_usage_limit(&wallet2).await.is_err());
    }

    #[tokio::test]
    async fn test_unlimited_usage() {
        let store = Arc::new(InMemoryUsageStore::new());
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 0, kora_signers, true); // 0 = unlimited

        let wallet = Pubkey::new_unique();

        // Should allow many transactions when unlimited
        for _ in 0..10 {
            assert!(tracker.check_usage_limit(&wallet).await.is_ok());
        }
    }

    #[tokio::test]
    async fn test_usage_limiter_disabled_fallback() {
        // Test that when usage limiting is disabled, transactions are allowed
        let _m = ConfigMockBuilder::new().with_usage_limit_enabled(false).build_and_setup();

        // Initialize the usage limiter - it should set to None when disabled
        let _ = UsageTracker::init_usage_limiter().await;

        let result = UsageTracker::check_transaction_usage_limit(&create_mock_transaction()).await;
        match &result {
            Ok(_) => {}
            Err(e) => println!("Test failed with error: {e}"),
        }
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_usage_limiter_fallback_allowed() {
        let _m = ConfigMockBuilder::new()
            .with_usage_limit_enabled(true)
            .with_usage_limit_cache_url(None)
            .with_usage_limit_fallback(true)
            .build_and_setup();

        // Initialize with no cache_url - should set limiter to None
        let _ = UsageTracker::init_usage_limiter().await;

        let result = UsageTracker::check_transaction_usage_limit(&create_mock_transaction()).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_usage_limiter_fallback_denied() {
        let _m = ConfigMockBuilder::new()
            .with_usage_limit_enabled(true)
            .with_usage_limit_cache_url(None)
            .with_usage_limit_fallback(false)
            .build_and_setup();

        // Initialize with no cache_url - should set limiter to None
        let _ = UsageTracker::init_usage_limiter().await;

        let result = UsageTracker::check_transaction_usage_limit(&create_mock_transaction()).await;
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Usage limiter unavailable and fallback disabled"));
    }

    #[tokio::test]
    async fn test_usage_limit_store_get_error_fallback_enabled() {
        let store = Arc::new(ErrorUsageStore::new(true, false)); // get() will error
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 2, kora_signers, true); // fallback enabled

        let wallet = Pubkey::new_unique();

        // Should succeed because fallback is enabled
        let result = tracker.check_usage_limit(&wallet).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_usage_limit_store_get_error_fallback_disabled() {
        let store = Arc::new(ErrorUsageStore::new(true, false)); // get() will error
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 2, kora_signers, false); // fallback disabled

        let wallet = Pubkey::new_unique();

        // Should fail because fallback is disabled
        let result = tracker.check_usage_limit(&wallet).await;
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Usage limit store unavailable and fallback disabled"));
    }

    #[tokio::test]
    async fn test_usage_limit_store_increment_error_fallback_enabled() {
        let store = Arc::new(ErrorUsageStore::new(false, true)); // increment() will error
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 2, kora_signers, true); // fallback enabled

        let wallet = Pubkey::new_unique();

        // Should succeed because fallback is enabled (get() succeeds, increment() fails but fallback allows)
        let result = tracker.check_usage_limit(&wallet).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn test_usage_limit_store_increment_error_fallback_disabled() {
        let store = Arc::new(ErrorUsageStore::new(false, true)); // increment() will error
        let kora_signers = HashSet::new();
        let tracker = UsageTracker::new(store, 2, kora_signers, false); // fallback disabled

        let wallet = Pubkey::new_unique();

        // Should fail because fallback is disabled
        let result = tracker.check_usage_limit(&wallet).await;
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("Usage limit store unavailable and fallback disabled"));
    }
}