add: exhausted property to validator messages

Author: samparsky

primitives/src/validator.rs

@@ -165,6 +165,8 @@ pub struct ApproveState {
     pub state_root: String,
     pub signature: String,
     pub is_healthy: bool,
+    #[serde(default)]
+    pub exhausted: bool,
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
@@ -173,6 +175,8 @@ pub struct NewState {
     pub state_root: String,
     pub signature: String,
     pub balances: BalancesMap,
+    #[serde(default)]
+    pub exhausted: bool,
 }
 
 #[derive(Default, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]

validator_worker/src/follower.rs

@@ -3,7 +3,7 @@ use std::fmt;
 
 use primitives::adapter::{Adapter, AdapterErrorKind};
 use primitives::validator::{ApproveState, MessageTypes, NewState, RejectState};
-use primitives::BalancesMap;
+use primitives::{BalancesMap, BigNum};
 
 use crate::core::follower_rules::{get_health, is_valid_transition};
 use crate::heartbeat::{heartbeat, HeartbeatStatus};
@@ -140,12 +140,14 @@ async fn on_new_state<'a, A: Adapter + 'static>(
     let signature = iface.adapter.sign(&new_state.state_root)?;
     let health_threshold = u64::from(iface.config.health_threshold_promilles);
     let is_healthy = health >= health_threshold;
+    let exhausted = proposed_balances.clone().values().sum::<BigNum>() == iface.channel.deposit_amount;
 
     let propagation_result = iface
         .propagate(&[&MessageTypes::ApproveState(ApproveState {
             state_root: proposed_state_root,
             signature,
             is_healthy,
+            exhausted,
         })])
         .await;
 

validator_worker/src/leader.rs

@@ -4,6 +4,7 @@ use primitives::adapter::{Adapter, AdapterErrorKind};
 use primitives::{
     validator::{Accounting, MessageTypes, NewState},
     BalancesMap,
+    BigNum,
 };
 
 use crate::heartbeat::{heartbeat, HeartbeatStatus};
@@ -48,13 +49,16 @@ async fn on_new_accounting<A: Adapter + 'static>(
 
     let signature = iface.adapter.sign(&state_root)?;
 
+    let exhausted = new_accounting.balances.clone().values().sum::<BigNum>() == iface.channel.deposit_amount;
+
     let propagation_results = iface
         .propagate(&[&MessageTypes::NewState(NewState {
             state_root,
             signature,
             balances: new_accounting.balances.clone(),
+            exhausted
         })])
         .await;
 
     Ok(propagation_results)
-}
+}