From feeb1cb566191fd132c9b8d00111754a280bc0ec Mon Sep 17 00:00:00 2001
From: Parth <desaiparth08@gmail.com>
Date: Wed, 11 Dec 2019 02:41:08 +0530
Subject: [PATCH] distribute leftover lamports (#7396)

* distribute leftover lamports

* add test scenario

* fix naming
---
 runtime/src/bank.rs | 69 +++++++++++++++++++++++++++++++++++----------
 1 file changed, 54 insertions(+), 15 deletions(-)

diff --git a/runtime/src/bank.rs b/runtime/src/bank.rs
index c49e4abca..741ab5282 100644
--- a/runtime/src/bank.rs
+++ b/runtime/src/bank.rs
@@ -1259,8 +1259,9 @@ impl Bank {
         rent_to_be_distributed: u64,
     ) {
         let mut total_staked = 0;
+        let mut rent_distributed_in_initial_round = 0;
 
-        let node_stakes = vote_account_hashmap
+        let mut node_stakes = vote_account_hashmap
             .iter()
             .filter_map(|(_vote_pubkey, (staked, account))| {
                 total_staked += *staked;
@@ -1271,13 +1272,41 @@ impl Bank {
             })
             .collect::<Vec<(Pubkey, u64)>>();
 
-        node_stakes.iter().for_each(|(pubkey, staked)| {
-            let rent_to_be_paid =
-                (((staked * rent_to_be_distributed) as f64) / (total_staked as f64)) as u64;
-            let mut account = self.get_account(pubkey).unwrap_or_default();
-            account.lamports += rent_to_be_paid;
-            self.store_account(pubkey, &account);
-        });
+        // Sort first by stake and then by pubkey for determinism
+        node_stakes.sort_by(
+            |(pubkey1, staked1), (pubkey2, staked2)| match staked2.cmp(staked1) {
+                std::cmp::Ordering::Equal => pubkey2.cmp(pubkey1),
+                other => other,
+            },
+        );
+
+        let node_stakes_and_rent = node_stakes
+            .iter()
+            .map(|(pubkey, staked)| {
+                let rent_share =
+                    (((*staked * rent_to_be_distributed) as f64) / (total_staked as f64)) as u64;
+                rent_distributed_in_initial_round += rent_share;
+                (*pubkey, *staked, rent_share)
+            })
+            .collect::<Vec<(Pubkey, u64, u64)>>();
+
+        // Leftover lamports after fraction calculation, will be paid to validators starting from highest stake
+        // holder
+        let mut leftover_lamports = rent_to_be_distributed - rent_distributed_in_initial_round;
+
+        node_stakes_and_rent
+            .iter()
+            .for_each(|(pubkey, _staked, rent_share)| {
+                let rent_to_be_paid = if leftover_lamports > 0 {
+                    leftover_lamports -= 1;
+                    *rent_share + 1
+                } else {
+                    *rent_share
+                };
+                let mut account = self.get_account(pubkey).unwrap_or_default();
+                account.lamports += rent_to_be_paid;
+                self.store_account(pubkey, &account);
+            });
     }
 
     fn distribute_rent(&self) {
@@ -2173,7 +2202,7 @@ mod tests {
         let rent = Rent::free();
 
         let validator_1_pubkey = Pubkey::new_rand();
-        let validator_1_stake_lamports = 23;
+        let validator_1_stake_lamports = 20;
         let validator_1_staking_keypair = Keypair::new();
         let validator_1_voting_keypair = Keypair::new();
 
@@ -2206,7 +2235,7 @@ mod tests {
         );
 
         let validator_2_pubkey = Pubkey::new_rand();
-        let validator_2_stake_lamports = 22;
+        let validator_2_stake_lamports = 20;
         let validator_2_staking_keypair = Keypair::new();
         let validator_2_voting_keypair = Keypair::new();
 
@@ -2239,7 +2268,7 @@ mod tests {
         );
 
         let validator_3_pubkey = Pubkey::new_rand();
-        let validator_3_stake_lamports = 25;
+        let validator_3_stake_lamports = 30;
         let validator_3_staking_keypair = Keypair::new();
         let validator_3_voting_keypair = Keypair::new();
 
@@ -2321,28 +2350,38 @@ mod tests {
         let rent_to_be_distributed = total_rent_deducted - burned_portion;
 
         let bootstrap_leader_portion =
-            ((bootstrap_leader_stake_lamports * rent_to_be_distributed) as f64 / 100.0) as u64;
+            ((bootstrap_leader_stake_lamports * rent_to_be_distributed) as f64 / 100.0) as u64 + 1; // Leftover lamport
         assert_eq!(
             bank.get_balance(&bootstrap_leader_pubkey),
             bootstrap_leader_portion + bootstrap_leader_initial_balance
         );
 
-        let validator_1_portion =
+        // Since, validator 1 and validator 2 has equal smallest stake, it comes down to comparison
+        // between their pubkey.
+        let mut validator_1_portion =
             ((validator_1_stake_lamports * rent_to_be_distributed) as f64 / 100.0) as u64;
+        if validator_1_pubkey > validator_2_pubkey {
+            validator_1_portion += 1;
+        }
         assert_eq!(
             bank.get_balance(&validator_1_pubkey),
             validator_1_portion + 42
         );
 
-        let validator_2_portion =
+        // Since, validator 1 and validator 2 has equal smallest stake, it comes down to comparison
+        // between their pubkey.
+        let mut validator_2_portion =
             ((validator_2_stake_lamports * rent_to_be_distributed) as f64 / 100.0) as u64;
+        if validator_2_pubkey > validator_1_pubkey {
+            validator_2_portion += 1;
+        }
         assert_eq!(
             bank.get_balance(&validator_2_pubkey),
             validator_2_portion + 42
         );
 
         let validator_3_portion =
-            ((validator_3_stake_lamports * rent_to_be_distributed) as f64 / 100.0) as u64;
+            ((validator_3_stake_lamports * rent_to_be_distributed) as f64 / 100.0) as u64 + 1;
         assert_eq!(
             bank.get_balance(&validator_3_pubkey),
             validator_3_portion + 42