Merge pull request #248 from favourawaku/feat/policy-expired-event

Feat/policy expired event

Author: jhayniffy

contracts/niffyinsure/src/lib.rs

@@ -472,6 +472,48 @@ impl NiffyInsure {
         storage::get_active_policy_count(&env, &holder)
     }
 
+    /// If set, the `end_ledger` for which a [`policy::PolicyExpired`] event was already recorded
+    /// (one row per policy). Indexers may use this with `get_policy` for idempotency checks.
+    /// Name is shortened to satisfy the 32-char Soroban export limit.
+    pub fn get_pol_exp_evt_end_ledger(
+        env: Env,
+        holder: Address,
+        policy_id: u32,
+    ) -> Option<u32> {
+        storage::get_policy_expired_event_end_ledger(&env, &holder, policy_id)
+    }
+
+    /// Keeper hook: when `ledger_sequence >= policy.end_ledger`, emit [`policy::PolicyExpired`]
+    /// once per policy term (see `policy` module docs for notification delay). Reverts if the
+    /// policy does not exist or is not yet expired.
+    pub fn process_expired(
+        env: Env,
+        holder: Address,
+        policy_id: u32,
+    ) -> Result<(), policy::PolicyError> {
+        policy::process_expired(&env, holder, policy_id)
+    }
+
+    /// Renew before `end_ledger` (renewal window). If already expired, emits [`policy::PolicyExpired`]
+    /// when due and returns [`types::RenewPolicyOutcome::Lapsed`] in **`Ok`** (see type docs).
+    pub fn renew_policy(
+        env: Env,
+        holder: Address,
+        policy_id: u32,
+        age_band: types::AgeBand,
+        coverage_type: types::CoverageType,
+        safety_score: u32,
+    ) -> Result<types::RenewPolicyOutcome, policy::PolicyError> {
+        policy::renew_policy(
+            &env,
+            holder,
+            policy_id,
+            age_band,
+            coverage_type,
+            safety_score,
+        )
+    }
+
     pub fn terminate_policy(
         env: Env,
         holder: Address,

contracts/niffyinsure/src/policy.rs

@@ -39,6 +39,18 @@ pub enum PolicyError {
     NotFound = 111,
     /// Policy is already active.
     AlreadyActive = 112,
+    /// Keeper `process_expired`: policy is not yet at `end_ledger`.
+    NotYetExpired = 113,
+    /// `renew_policy` called before the renewal window opens.
+    NotInRenewalWindow = 114,
+    /// `renew_policy`: policy is inactive (terminated or deactivated).
+    PolicyInactive = 115,
+    /// `renew_policy`: an open claim exists for this policy.
+    OpenClaimBlocksRenewal = 116,
+    /// `renew_policy`: strike count blocks renewal (see `STRIKE_DEACTIVATION_THRESHOLD`).
+    TooManyStrikesForRenewal = 117,
+    /// Reserved / legacy: expired renewals now return [`crate::types::RenewPolicyOutcome::Lapsed`] `Ok`.
+    Expired = 118,
 }
 
 #[contracttype]
@@ -80,7 +92,6 @@ pub struct BeneficiaryUpdated {
 /// Event emitted by `renew_policy`.
 #[contractevent]
 #[derive(Clone, Debug)]
-#[allow(dead_code)]
 pub struct PolicyRenewed {
     #[topic]
     pub holder: Address,
@@ -90,6 +101,26 @@ pub struct PolicyRenewed {
     pub new_end_ledger: u32,
 }
 
+/// Emitted at most once per `(holder, policy_id, end_ledger)` term when expiry is detected.
+///
+/// **Timing:** `reported_at_ledger` is the ledger of the transaction that observes expiry.
+/// It may be **strictly greater** than `expiry_ledger` if no call ran exactly at expiry
+/// (keeper delay is normal). Indexers and notification services should **deduplicate on
+/// `policy_id`** (and holder) and must not assume the event fires on the expiry ledger itself.
+///
+/// **`renew_policy` on an expired policy:** the call returns [`crate::types::RenewPolicyOutcome::Lapsed`]
+/// in **`Ok`** (not `Err`) so this event and idempotency storage are not rolled back.
+#[contractevent(topics = ["niffyinsure", "policy_expired"])]
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct PolicyExpired {
+    #[topic]
+    pub holder: Address,
+    #[topic]
+    pub policy_id: u32,
+    pub expiry_ledger: u32,
+    pub reported_at_ledger: u32,
+}
+
 pub fn generate_premium(
     env: &Env,
     region: RegionTier,
@@ -507,3 +538,143 @@ pub fn renew_policy(
 
     Ok(policy)
 }
+
+/// Emit [`PolicyExpired`] if `now >= end_ledger` and we have not yet recorded an event for this term.
+pub fn publish_policy_expired_if_due(env: &Env, policy: &Policy, now: u32) {
+    if !ledger::is_expired(now, policy.end_ledger) {
+        return;
+    }
+    if storage::get_policy_expired_event_end_ledger(env, &policy.holder, policy.policy_id)
+        == Some(policy.end_ledger)
+    {
+        return;
+    }
+    PolicyExpired {
+        holder: policy.holder.clone(),
+        policy_id: policy.policy_id,
+        expiry_ledger: policy.end_ledger,
+        reported_at_ledger: now,
+    }
+    .publish(env);
+    storage::set_policy_expired_event_end_ledger(
+        env,
+        &policy.holder,
+        policy.policy_id,
+        policy.end_ledger,
+    );
+    storage::bump_instance(env);
+}
+
+/// Keeper entrypoint: observe expiry for indexers / notification pipelines.
+///
+/// Reverts with [`PolicyError::NotYetExpired`] if `now < end_ledger`. If expiry was already
+/// notified for this policy term, succeeds without emitting a duplicate event.
+pub fn process_expired(env: &Env, holder: Address, policy_id: u32) -> Result<(), PolicyError> {
+    storage::bump_instance(env);
+    let policy = storage::get_policy(env, &holder, policy_id).ok_or(PolicyError::NotFound)?;
+    let now = env.ledger().sequence();
+    if !ledger::is_expired(now, policy.end_ledger) {
+        return Err(PolicyError::NotYetExpired);
+    }
+    publish_policy_expired_if_due(env, &policy, now);
+    Ok(())
+}
+
+/// Extend policy duration after premium payment (renewal window only).
+///
+/// If the policy is already expired, records [`PolicyExpired`] if not yet recorded for this
+/// term, then returns [`crate::types::RenewPolicyOutcome::Lapsed`] in **`Ok`** so storage and
+/// events persist (an `Err` would roll back the contract invocation).
+#[allow(clippy::too_many_arguments)]
+pub fn renew_policy(
+    env: &Env,
+    holder: Address,
+    policy_id: u32,
+    age_band: AgeBand,
+    coverage_type: CoverageType,
+    safety_score: u32,
+) -> Result<crate::types::RenewPolicyOutcome, PolicyError> {
+    storage::assert_bind_not_paused(env);
+    holder.require_auth();
+
+    let mut policy = storage::get_policy(env, &holder, policy_id).ok_or(PolicyError::NotFound)?;
+    let now = env.ledger().sequence();
+
+    if ledger::is_expired(now, policy.end_ledger) {
+        publish_policy_expired_if_due(env, &policy, now);
+        return Ok(crate::types::RenewPolicyOutcome::Lapsed);
+    }
+
+    if !policy.is_active {
+        return Err(PolicyError::PolicyInactive);
+    }
+
+    if storage::has_open_claim(env, &holder, policy_id) {
+        return Err(PolicyError::OpenClaimBlocksRenewal);
+    }
+
+    if policy.strike_count >= STRIKE_DEACTIVATION_THRESHOLD {
+        return Err(PolicyError::TooManyStrikesForRenewal);
+    }
+
+    if !ledger::is_in_renewal_window(
+        now,
+        policy.end_ledger,
+        ledger::RENEWAL_WINDOW_LEDGERS,
+    ) {
+        return Err(PolicyError::NotInRenewalWindow);
+    }
+
+    if safety_score > 100 {
+        return Err(PolicyError::InvalidRiskScore);
+    }
+
+    if !storage::is_allowed_asset(env, &policy.asset) {
+        return Err(PolicyError::AssetNotAllowed);
+    }
+
+    let input = RiskInput {
+        region: policy.region.clone(),
+        age_band: age_band.clone(),
+        coverage: coverage_type,
+        safety_score,
+    };
+
+    let quote =
+        crate::calculator::compute_quote(env, &input, policy.coverage, false, QUOTE_TTL_LEDGERS)
+            .map_err(|e| match e {
+                Error::CalculatorPaused => PolicyError::ContractPaused,
+                Error::CalculatorCallFailed | Error::CalculatorNotSet => PolicyError::PremiumOverflow,
+                _ => PolicyError::PremiumOverflow,
+            })?;
+
+    let premium_amount = quote.total_premium;
+    if premium_amount <= 0 {
+        return Err(PolicyError::InvalidPremium);
+    }
+
+    token::collect_premium(env, &holder, &policy.asset, premium_amount);
+
+    let new_end = policy
+        .end_ledger
+        .checked_add(ledger::POLICY_DURATION_LEDGERS)
+        .ok_or(PolicyError::LedgerOverflow)?;
+
+    policy.premium = premium_amount;
+    policy.end_ledger = new_end;
+
+    validate::check_policy(&policy).map_err(|_| PolicyError::PolicyValidation)?;
+
+    storage::set_policy(env, &holder, policy_id, &policy);
+
+    PolicyRenewed {
+        version: POLICY_EVENT_VERSION,
+        holder: holder.clone(),
+        policy_id,
+        premium: premium_amount,
+        new_end_ledger: new_end,
+    }
+    .publish(env);
+
+    Ok(crate::types::RenewPolicyOutcome::Renewed(policy))
+}

contracts/niffyinsure/src/storage.rs

@@ -590,3 +590,29 @@ pub fn set_rolling_claim_state(
         .persistent()
         .extend_ttl(&key, PERSISTENT_TTL_THRESHOLD, PERSISTENT_TTL_EXTEND_TO);
 }
+
+// ── Policy expiry notification (instance) ─────────────────────────────────────
+
+/// Last `end_ledger` for which `PolicyExpired` was emitted for this policy term.
+pub fn get_policy_expired_event_end_ledger(
+    env: &Env,
+    holder: &Address,
+    policy_id: u32,
+) -> Option<u32> {
+    env.storage().instance().get(&DataKey::PolicyExpiredEventEndLedger(
+        holder.clone(),
+        policy_id,
+    ))
+}
+
+pub fn set_policy_expired_event_end_ledger(
+    env: &Env,
+    holder: &Address,
+    policy_id: u32,
+    end_ledger: u32,
+) {
+    env.storage().instance().set(
+        &DataKey::PolicyExpiredEventEndLedger(holder.clone(), policy_id),
+        &end_ledger,
+    );
+}

contracts/niffyinsure/src/types.rs

@@ -346,6 +346,19 @@ pub struct Policy {
     pub strike_count: u32,
 }
 
+/// Return value of [`crate::policy::renew_policy`].
+///
+/// When the policy is already at or past `end_ledger`, the call **succeeds** with [`Lapsed`](Self::Lapsed)
+/// so that [`crate::policy::PolicyExpired`] and idempotency storage are committed (a failed `Result::Err`
+/// invocation would roll those writes back).
+#[contracttype]
+#[derive(Clone)]
+pub enum RenewPolicyOutcome {
+    Renewed(Policy),
+    /// Ledger is at or after `end_ledger`; expiry notice recorded if due; no premium taken.
+    Lapsed,
+}
+
 /// On-chain claim record.
 ///
 /// `filed_at` is the ledger sequence at which the claim was filed.