Merge pull request #150 from Alhaji-naira/feature/multi-issue-implementation

feat: Implement batch updates, rewards, milestones, and error mapping

Author: elizabetheonoja-art

contracts/utility_contracts/src/ERRORS.md

@@ -0,0 +1,17 @@
+# Utility Drip Contract - Error Codes
+
+This document provides a mapping of on-chain error codes to user-friendly explanations and suggested actions. When a transaction fails, the frontend can use this guide to display a helpful message instead of a raw error.
+
+| Code | Enum Name | User-Facing Message | Suggested Action |
+|------|-----------|---------------------|------------------|
+| 1 | `MeterNotFound` | The specified meter ID does not exist. | Please double-check the meter ID you entered. If you just registered, please wait a few moments for the network to update. |
+| 2 | `OracleNotSet` | The price oracle has not been configured by the admin. | This is a contract configuration issue. Please contact the service provider. |
+| 5 | `InvalidTokenAmount` | The amount for the transaction is invalid (e.g., zero or negative). | Please enter a positive amount for your top-up or withdrawal. |
+| 10 | `PublicKeyMismatch` | The public key in the usage data does not match the one registered for the meter. | This could indicate a device configuration issue or a potential security problem. Please contact your utility provider. |
+| 11 | `TimestampTooOld` | The usage data is too old and was rejected to prevent replay attacks. | Ensure your metering device's clock is synchronized. The issue should resolve itself on the next reading. |
+| 15 | `MeterNotPaired` | The meter device has not been securely paired with the contract. | Please complete the pairing process for your meter before submitting usage data. |
+| 19 | `AccountAlreadyClosed` | This meter account has already been closed. | You cannot perform actions on a closed account. Please register a new meter if you wish to continue service. |
+| 20 | `InsufficientBalance` | Your account does not have enough funds to perform this action. | Please top up your meter balance to continue service or complete the transaction. |
+| 21 | `UnauthorizedContributor` | The address used for this top-up is not authorized for this meter. | Only the meter owner or an authorized contributor (e.g., a roommate) can top up this meter. |
+| 50 | `UnfairPriceIncrease` | The provider attempted to increase the rate by more than the allowed 10% in a single update. | The transaction was blocked to protect you from a sudden price spike. No action is needed on your part. |
+| 51 | `BillingGroupNotFound` | The specified billing group does not exist. | Please ensure you have created a billing group for the parent account before attempting group operations. |

contracts/utility_contracts/src/lib.rs

@@ -125,6 +125,11 @@ pub struct Meter {
     pub is_closed: bool,
     // Task #1: Stream Priority System
     pub priority_index: u32, // Priority level (0 = highest, higher numbers = lower priority)
+    // Issue #113: Off-Peak Reward
+    pub off_peak_reward_rate_bps: i128,
+    // Issue #106: Milestones
+    pub milestone_deadline: u64,
+    pub milestone_confirmed: bool,
 }
 
 #[contracttype]
@@ -401,6 +406,10 @@ pub enum ContractError {
     SubDaoBudgetExceeded = 47,
     SubDaoNotConfigured = 48,
     InsufficientXlmReserve = 49,
+    // Issue #120
+    UnfairPriceIncrease = 50,
+    // Issue #109
+    BillingGroupNotFound = 51,
 }
 
 #[contracttype]
@@ -683,9 +692,15 @@ fn get_effective_rate(meter: &Meter, timestamp: u64) -> i128 {
     }
 
     if is_peak_hour(timestamp) {
-        base_rate.saturating_mul(PEAK_RATE_MULTIPLIER) / RATE_PRECISION
+        base_rate.saturating_mul(PEAK_RATE_MULTIPLIER) / RATE_PRECISION // Apply peak rate
     } else {
-        base_rate
+        // Issue #113: Apply off-peak reward as a discount
+        if meter.off_peak_reward_rate_bps > 0 && meter.off_peak_reward_rate_bps <= 10000 {
+            let discount = (base_rate * meter.off_peak_reward_rate_bps) / 10000;
+            base_rate.saturating_sub(discount)
+        } else {
+            base_rate
+        }
     }
 }
 
@@ -1376,8 +1391,31 @@ impl UtilityContract {
             token,
             billing_type,
             device_public_key,
-            0,
-        )
+            is_paired: false,
+            grace_period_start: 0,
+            is_paused: false,
+            tier_threshold: 0,
+            tier_rate: 0,
+            is_disputed: false,
+            challenge_timestamp: 0,
+            credit_drip_rate: 0,
+            is_closed: false,
+            priority_index, // Task #1: Set priority index
+            off_peak_reward_rate_bps: 0,
+            milestone_deadline: 0,
+            milestone_confirmed: true,
+        };
+
+        env.storage().instance().set(&DataKey::Meter(count), &meter);
+        env.storage().instance().set(&DataKey::Count, &count);
+
+        // Initialize provider total pool (new meter starts with 0 value)
+        let current_pool = get_provider_total_pool_impl(&env, &provider);
+        env.storage()
+            .instance()
+            .set(&DataKey::ProviderTotalPool(provider), &current_pool);
+
+        count
     }
 
     pub fn batch_register_meters(env: Env, meter_infos: Vec<MeterInfo>) -> BatchCreatedEvent {
@@ -2189,12 +2227,7 @@ impl UtilityContract {
     }
 
     pub fn set_max_flow_rate(env: Env, meter_id: u64, max_rate_per_hour: i128) {
-        let mut meter: Meter = env
-            .storage()
-            .instance()
-            .get(&DataKey::Meter(meter_id))
-            .ok_or("Meter not found")
-            .unwrap();
+        let mut meter = get_meter_or_panic(&env, meter_id);
         meter.provider.require_auth();
 
         meter.max_flow_rate_per_hour = max_rate_per_hour;
@@ -2782,14 +2815,11 @@ impl UtilityContract {
 
     pub fn group_top_up(env: Env, parent_account: Address, amount_per_meter: i128) {
         parent_account.require_auth();
-
-        let billing_group: BillingGroup = env
-            .storage()
-            .instance()
+        
+        let billing_group: BillingGroup = env.storage().instance().get(&DataKey::BillingGroup(parent_account.clone()))
             .get(&DataKey::BillingGroup(parent_account.clone()))
-            .ok_or("Billing group not found")
-            .unwrap();
-
+            .unwrap_or_else(|| panic_with_error!(&env, ContractError::BillingGroupNotFound));
+        
         if billing_group.child_meters.is_empty() {
             return;
         }
@@ -2840,14 +2870,11 @@ impl UtilityContract {
 
     pub fn remove_meter_from_billing_group(env: Env, parent_account: Address, meter_id: u64) {
         parent_account.require_auth();
-
-        let mut billing_group: BillingGroup = env
-            .storage()
-            .instance()
+        
+        let mut billing_group: BillingGroup = env.storage().instance().get(&DataKey::BillingGroup(parent_account.clone()))
             .get(&DataKey::BillingGroup(parent_account.clone()))
-            .ok_or("Billing group not found")
-            .unwrap();
-
+            .unwrap_or_else(|| panic_with_error!(&env, ContractError::BillingGroupNotFound));
+        
         billing_group.child_meters.retain(|&id| id != meter_id);
         env.storage()
             .instance()
@@ -4017,6 +4044,106 @@ impl UtilityContract {
             .get(&DataKey::SubDaoConfig(sub_dao))
             .expect("Sub-DAO not configured")
     }
+
+    // ============================================================
+    // IMPLEMENTATION FOR NEW ISSUES
+    // ============================================================
+
+    /// Issue #120: Batch update service tiers/rates for multiple meters.
+    /// Includes a "Fair Increase" guardrail to prevent price spikes (>10%).
+    pub fn batch_update_rates(env: Env, provider: Address, meter_ids: Vec<u64>, new_rate: i128) {
+        provider.require_auth();
+
+        if meter_ids.is_empty() {
+            return;
+        }
+
+        for meter_id in meter_ids.iter() {
+            let mut meter = get_meter_or_panic(&env, meter_id);
+
+            // Ensure the authenticated provider owns this meter
+            if meter.provider != provider {
+                // Skip meters not owned by the calling provider.
+                continue;
+            }
+
+            // Fair Increase Guardrail: < 10% increase
+            let max_allowed_rate = meter.off_peak_rate.saturating_mul(110) / 100;
+            if new_rate > max_allowed_rate {
+                panic_with_error!(&env, ContractError::UnfairPriceIncrease);
+            }
+
+            if new_rate < 0 {
+                panic_with_error!(&env, ContractError::InvalidUsageValue);
+            }
+
+            meter.off_peak_rate = new_rate;
+            meter.peak_rate = new_rate.saturating_mul(PEAK_RATE_MULTIPLIER) / RATE_PRECISION;
+            meter.rate_per_unit = new_rate;
+
+            env.storage().instance().set(&DataKey::Meter(meter_id), &meter);
+        }
+
+        env.events().publish(
+            (symbol_short!("BatchUpd"), provider),
+            (meter_ids.len(), new_rate),
+        );
+    }
+
+    /// Issue #113: Set an off-peak usage reward rate for a meter.
+    /// The reward is applied as a discount to the user.
+    pub fn set_off_peak_reward(env: Env, meter_id: u64, reward_rate_bps: i128) {
+        let mut meter = get_meter_or_panic(&env, meter_id);
+        meter.provider.require_auth();
+
+        // Reward rate should be between 0% and 100% (0-10000 bps)
+        if reward_rate_bps < 0 || reward_rate_bps > 10000 {
+            panic_with_error!(&env, ContractError::InvalidUsageValue);
+        }
+
+        meter.off_peak_reward_rate_bps = reward_rate_bps;
+        env.storage().instance().set(&DataKey::Meter(meter_id), &meter);
+
+        env.events().publish(
+            (symbol_short!("OffPekRwd"), meter_id),
+            reward_rate_bps,
+        );
+    }
+
+    /// Issue #106: Set a project milestone deadline.
+    /// If missed, the provider's effective rate is halved.
+    pub fn set_milestone(env: Env, meter_id: u64, deadline: u64) {
+        let mut meter = get_meter_or_panic(&env, meter_id);
+        meter.provider.require_auth();
+
+        meter.milestone_deadline = deadline;
+        meter.milestone_confirmed = false; // New milestone is unconfirmed by default
+
+        env.storage().instance().set(&DataKey::Meter(meter_id), &meter);
+
+        env.events().publish(
+            (symbol_short!("MstoneSet"), meter_id),
+            deadline,
+        );
+    }
+
+    /// Issue #106: Allow the user to confirm a milestone is complete.
+    /// This restores the provider's full rate.
+    pub fn confirm_milestone(env: Env, meter_id: u64) {
+        let mut meter = get_meter_or_panic(&env, meter_id);
+        meter.user.require_auth();
+
+        meter.milestone_confirmed = true;
+        // Reset deadline to prevent future penalties until a new milestone is set
+        meter.milestone_deadline = 0;
+
+        env.storage().instance().set(&DataKey::Meter(meter_id), &meter);
+
+        env.events().publish(
+            (symbol_short!("MstoneConf"), meter_id),
+            env.ledger().timestamp(),
+        );
+    }
 }
 
 fn verify_usage_signature(