feat: (PRO-262) Implement usage limit feature with Redis support (#215)

* feat: (PRO-262) Implement usage limit feature with Redis support

- Removed `redis-test` dependency from Cargo files.
- Updated Docker configuration to use a custom Redis configuration file.
- Introduced `UsageLimitConfig` to manage per-wallet transaction limits.
- Added `UsageTracker` for enforcing usage limits based on transactions.
- Implemented `UsageStore` trait with Redis and in-memory implementations for tracking usage.
- Enhanced RPC methods to check usage limits before processing transactions.
- Added tests for usage limit functionality and configuration parsing.
- Updated configuration validation to include usage limit settings.

- Config validation
- Better fallback handling
* Update coverage badge [skip ci]

---------

Co-authored-by: github-actions <github-actions@github.com>

Author: dev-jodee

.github/badges/coverage.json

@@ -1 +1 @@
-{"schemaVersion": 1, "label": "coverage", "message": "86.3%", "color": "green"}
+{"schemaVersion": 1, "label": "coverage", "message": "85.8%", "color": "green"}

Cargo.lock

@@ -2,11 +2,11 @@ FROM rust:1.80 as builder
 
 WORKDIR /usr/src/app
 COPY . .
-RUN cargo build --release --bin kora-rpc
+RUN cargo build --release --bin kora
 
 FROM debian:bookworm-slim
 RUN apt-get update && apt-get install -y ca-certificates && rm -rf /var/lib/apt/lists/*
-COPY --from=builder /usr/src/app/target/release/kora-rpc /usr/local/bin/
+COPY --from=builder /usr/src/app/target/release/kora /usr/local/bin/
 
 EXPOSE 8080
-CMD ["kora-rpc"]
+CMD ["kora"]

Dockerfile

@@ -85,4 +85,3 @@ tempfile = "3.2"
 tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }
 mockito = "1.2.0"
 serial_test = "3.2.0"
-redis-test = "0.12.0"

crates/lib/Cargo.toml

@@ -22,8 +22,8 @@ use {crate::cache::CacheUtil, crate::state::get_config};
 
 #[cfg(test)]
 use {
-    crate::config::SplTokenConfig, crate::tests::config_mock::mock_state::get_config,
-    crate::tests::redis_cache_mock::MockCacheUtil as CacheUtil,
+    crate::config::SplTokenConfig, crate::tests::cache_mock::MockCacheUtil as CacheUtil,
+    crate::tests::config_mock::mock_state::get_config,
 };
 
 /*

crates/lib/src/admin/token_util.rs

@@ -10,6 +10,7 @@ use crate::{
         DEFAULT_CACHE_ACCOUNT_TTL, DEFAULT_CACHE_DEFAULT_TTL,
         DEFAULT_FEE_PAYER_BALANCE_METRICS_EXPIRY_SECONDS, DEFAULT_MAX_TIMESTAMP_AGE,
         DEFAULT_METRICS_ENDPOINT, DEFAULT_METRICS_PORT, DEFAULT_METRICS_SCRAPE_INTERVAL,
+        DEFAULT_USAGE_LIMIT_FALLBACK_IF_UNAVAILABLE, DEFAULT_USAGE_LIMIT_MAX_TRANSACTIONS,
     },
     error::KoraError,
     fee::price::{PriceConfig, PriceModel},
@@ -349,6 +350,8 @@ pub struct KoraConfig {
     pub payment_address: Option<String>,
     #[serde(default)]
     pub cache: CacheConfig,
+    #[serde(default)]
+    pub usage_limit: UsageLimitConfig,
 }
 
 impl Default for KoraConfig {
@@ -359,6 +362,30 @@ impl Default for KoraConfig {
             auth: AuthConfig::default(),
             payment_address: None,
             cache: CacheConfig::default(),
+            usage_limit: UsageLimitConfig::default(),
+        }
+    }
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct UsageLimitConfig {
+    /// Enable per-wallet usage limiting
+    pub enabled: bool,
+    /// Cache URL for shared usage limiting across multiple Kora instances
+    pub cache_url: Option<String>,
+    /// Default maximum transactions per wallet (0 = unlimited)
+    pub max_transactions: u64,
+    /// Fallback behavior when cache is unavailable
+    pub fallback_if_unavailable: bool,
+}
+
+impl Default for UsageLimitConfig {
+    fn default() -> Self {
+        Self {
+            enabled: false,
+            cache_url: None,
+            max_transactions: DEFAULT_USAGE_LIMIT_MAX_TRANSACTIONS,
+            fallback_if_unavailable: DEFAULT_USAGE_LIMIT_FALLBACK_IF_UNAVAILABLE,
         }
     }
 }
@@ -671,4 +698,41 @@ mod tests {
         assert_eq!(config.kora.cache.default_ttl, 300);
         assert_eq!(config.kora.cache.account_ttl, 60);
     }
+
+    #[test]
+    fn test_usage_limit_config_parsing() {
+        let config = ConfigBuilder::new()
+            .with_usage_limit_config(true, Some("redis://localhost:6379"), 10, false)
+            .build_config()
+            .unwrap();
+
+        assert!(config.kora.usage_limit.enabled);
+        assert_eq!(config.kora.usage_limit.cache_url, Some("redis://localhost:6379".to_string()));
+        assert_eq!(config.kora.usage_limit.max_transactions, 10);
+        assert!(!config.kora.usage_limit.fallback_if_unavailable);
+    }
+
+    #[test]
+    fn test_usage_limit_config_default() {
+        let config = ConfigBuilder::new().build_config().unwrap();
+
+        assert!(!config.kora.usage_limit.enabled);
+        assert_eq!(config.kora.usage_limit.cache_url, None);
+        assert_eq!(config.kora.usage_limit.max_transactions, DEFAULT_USAGE_LIMIT_MAX_TRANSACTIONS);
+        assert_eq!(
+            config.kora.usage_limit.fallback_if_unavailable,
+            DEFAULT_USAGE_LIMIT_FALLBACK_IF_UNAVAILABLE
+        );
+    }
+
+    #[test]
+    fn test_usage_limit_config_unlimited() {
+        let config = ConfigBuilder::new()
+            .with_usage_limit_config(true, None, 0, true)
+            .build_config()
+            .unwrap();
+
+        assert!(config.kora.usage_limit.enabled);
+        assert_eq!(config.kora.usage_limit.max_transactions, 0); // 0 = unlimited
+    }
 }

crates/lib/src/config.rs

@@ -25,6 +25,9 @@ pub const DEFAULT_CACHE_DEFAULT_TTL: u64 = 300; // 5 minutes
 pub const DEFAULT_CACHE_ACCOUNT_TTL: u64 = 60; // 1 minute for account data
 pub const DEFAULT_FEE_PAYER_BALANCE_METRICS_EXPIRY_SECONDS: u64 = 30; // 30 seconds
 
+pub const DEFAULT_USAGE_LIMIT_MAX_TRANSACTIONS: u64 = 0; // 0 = unlimited
+pub const DEFAULT_USAGE_LIMIT_FALLBACK_IF_UNAVAILABLE: bool = false;
+
 // Account Indexes within instructions
 // Instruction indexes for the instructions that we support to parse from the transaction
 pub mod instruction_indexes {

crates/lib/src/constant.rs

@@ -58,6 +58,9 @@ pub enum KoraError {
 
     #[error("Rate limit exceeded")]
     RateLimitExceeded,
+
+    #[error("Usage limit exceeded: {0}")]
+    UsageLimitExceeded(String),
 }
 
 impl From<ClientError> for KoraError {

crates/lib/src/error.rs

@@ -21,9 +21,7 @@ use solana_message::Message;
 use {crate::cache::CacheUtil, crate::state::get_config};
 
 #[cfg(test)]
-use crate::tests::{
-    config_mock::mock_state::get_config, redis_cache_mock::MockCacheUtil as CacheUtil,
-};
+use crate::tests::{cache_mock::MockCacheUtil as CacheUtil, config_mock::mock_state::get_config};
 use solana_client::nonblocking::rpc_client::RpcClient;
 use solana_message::VersionedMessage;
 use solana_program::program_pack::Pack;

crates/lib/src/fee/fee.rs

@@ -17,6 +17,7 @@ pub mod signer;
 pub mod state;
 pub mod token;
 pub mod transaction;
+pub mod usage_limit;
 pub mod validator;
 pub use cache::CacheUtil;
 pub use config::Config;