Merge pull request #513 from input-output-hk/prc/spdd-216-fix

Fix SPDD for epoch 216/217

Author: sandtreader

common/src/messages.rs

@@ -1,5 +1,6 @@
 //! Definition of Acropolis messages
 
+use crate::address::StakeAddress;
 use crate::commands::chain_sync::ChainSyncCommand;
 use crate::commands::transactions::{TransactionsCommand, TransactionsCommandResponse};
 use crate::genesis_values::GenesisValues;
@@ -304,7 +305,8 @@ pub struct SPOStateMessage {
     pub spos: Vec<PoolRegistration>,
 
     /// SPOs in the above list which retired at the start of this epoch, by operator ID
-    pub retired_spos: Vec<PoolId>,
+    /// and the reward account to pay the deposit refund to
+    pub retired_spos: Vec<(PoolId, StakeAddress)>,
 }
 
 /// Cardano message enum

modules/accounts_state/src/state.rs

@@ -815,15 +815,12 @@ impl State {
 
         // Check for any SPOs that have retired this epoch and need deposit refunds
         self.pool_refunds = Vec::new();
-        for id in &spo_msg.retired_spos {
-            if let Some(retired_spo) = new_spos.get(id) {
-                debug!(
-                    "SPO {} has retired - refunding their deposit to {}",
-                    id, retired_spo.reward_account
-                );
-                self.pool_refunds.push((retired_spo.operator, retired_spo.reward_account.clone()));
-                // Store full StakeAddress
-            }
+        for (id, reward_account) in &spo_msg.retired_spos {
+            debug!(
+                "SPO {} has retired - refunding their deposit to {}",
+                id, reward_account
+            );
+            self.pool_refunds.push((*id, reward_account.clone()));
 
             // Schedule to retire - we need them to still be in place when we count
             // blocks for the previous epoch

modules/accounts_state/test-data/rewards.mainnet.219.csv

@@ -270,8 +270,9 @@ impl SPOState {
                                 CardanoMessage::SPOState(SPOStateMessage { retired_spos, .. }),
                             )) = message.as_ref()
                             {
-                                retired_pools_history
-                                    .handle_deregistrations(block_info, retired_spos);
+                                let pool_ids: Vec<PoolId> =
+                                    retired_spos.iter().map(|(spo, _sa)| *spo).collect();
+                                retired_pools_history.handle_deregistrations(block_info, &pool_ids);
                             }
 
                             // publish spo message

modules/accounts_state/test-data/rewards.mainnet.220.csv

@@ -273,26 +273,26 @@ impl State {
         debug!(epoch = self.epoch, "New epoch");
 
         // Flatten into vector of registrations, before retirement so retiring ones
-        // are still included
+        // are still included **
         let spos = self.spos.values().cloned().collect();
 
-        // Update any pending
+        // Now apply it fully to persistent state, including creating new ones
         for (operator, reg) in &self.pending_updates {
             self.spos.insert(*operator, reg.clone());
         }
         self.pending_updates.clear();
 
         // Deregister any pending
-        let mut retired_spos: Vec<PoolId> = Vec::new();
+        let mut retired_spos: Vec<(PoolId, StakeAddress)> = Vec::new();
         let deregistrations = self.pending_deregistrations.remove(&self.epoch);
         if let Some(deregistrations) = deregistrations {
             for dr in deregistrations {
                 debug!("Retiring SPO {}", dr);
                 match self.spos.remove(&dr) {
                     None => vld
                         .push_anyhow(anyhow!("Retirement requested for unregistered SPO {}", dr,)),
-                    Some(_de_reg) => {
-                        retired_spos.push(dr);
+                    Some(de_reg) => {
+                        retired_spos.push((dr, de_reg.reward_account.clone()));
                     }
                 };
             }
@@ -302,7 +302,7 @@ impl State {
             block.clone(),
             CardanoMessage::SPOState(SPOStateMessage {
                 epoch: block.epoch - 1,
-                spos,
+                spos, // Note - list captured at ** before creation and deletion
                 retired_spos,
             }),
         )))