Remove affirmation_overrides config

Signed-off-by: Jacinta Ferrant <[email protected]>

Author: jferrant

stacks-node/src/run_loop/neon.rs

@@ -1028,19 +1028,9 @@ impl RunLoop {
         let liveness_thread = self.spawn_chain_liveness_thread(globals.clone());
 
         // Wait for all pending sortitions to process
-        let mut burnchain_db = burnchain_config
+        let burnchain_db = burnchain_config
             .open_burnchain_db(true)
             .expect("FATAL: failed to open burnchain DB");
-        if !self.config.burnchain.affirmation_overrides.is_empty() {
-            let tx = burnchain_db
-                .tx_begin()
-                .expect("FATAL: failed to begin burnchain DB tx");
-            for (reward_cycle, affirmation) in self.config.burnchain.affirmation_overrides.iter() {
-                tx.set_override_affirmation_map(*reward_cycle, affirmation.clone()).unwrap_or_else(|_| panic!("FATAL: failed to set affirmation override ({affirmation}) for reward cycle {reward_cycle}"));
-            }
-            tx.commit()
-                .expect("FATAL: failed to commit burnchain DB tx");
-        }
         let burnchain_db_tip = burnchain_db
             .get_canonical_chain_tip()
             .expect("FATAL: failed to query burnchain DB");

stackslib/src/config/mod.rs

@@ -36,9 +36,8 @@ use stacks_common::util::get_epoch_time_ms;
 use stacks_common::util::hash::hex_bytes;
 use stacks_common::util::secp256k1::{Secp256k1PrivateKey, Secp256k1PublicKey};
 
-use crate::burnchains::affirmation::AffirmationMap;
 use crate::burnchains::bitcoin::BitcoinNetworkType;
-use crate::burnchains::{Burnchain, MagicBytes, PoxConstants, BLOCKSTACK_MAGIC_MAINNET};
+use crate::burnchains::{Burnchain, MagicBytes, BLOCKSTACK_MAGIC_MAINNET};
 use crate::chainstate::nakamoto::signer_set::NakamotoSigners;
 use crate::chainstate::stacks::boot::MINERS_NAME;
 use crate::chainstate::stacks::index::marf::MARFOpenOpts;
@@ -49,8 +48,7 @@ use crate::config::chain_data::MinerStats;
 use crate::core::mempool::{MemPoolWalkSettings, MemPoolWalkStrategy, MemPoolWalkTxTypes};
 use crate::core::{
     MemPoolDB, StacksEpoch, StacksEpochExtension, StacksEpochId,
-    BITCOIN_TESTNET_FIRST_BLOCK_HEIGHT, BITCOIN_TESTNET_STACKS_25_BURN_HEIGHT,
-    BITCOIN_TESTNET_STACKS_25_REORGED_HEIGHT, CHAIN_ID_MAINNET, CHAIN_ID_TESTNET,
+    CHAIN_ID_MAINNET, CHAIN_ID_TESTNET,
     PEER_VERSION_MAINNET, PEER_VERSION_TESTNET, STACKS_EPOCHS_REGTEST, STACKS_EPOCHS_TESTNET,
 };
 use crate::cost_estimates::fee_medians::WeightedMedianFeeRateEstimator;
@@ -229,7 +227,7 @@ impl ConfigFile {
     }
 
     pub fn xenon() -> ConfigFile {
-        let mut burnchain = BurnchainConfigFile {
+        let burnchain = BurnchainConfigFile {
             mode: Some("xenon".to_string()),
             rpc_port: Some(18332),
             peer_port: Some(18333),
@@ -238,8 +236,6 @@ impl ConfigFile {
             ..BurnchainConfigFile::default()
         };
 
-        burnchain.add_affirmation_overrides_xenon();
-
         let node = NodeConfigFile {
             bootstrap_node: Some("029266faff4c8e0ca4f934f34996a96af481df94a89b0c9bd515f3536a95682ddc@seed.testnet.hiro.so:30444".to_string()),
             miner: Some(false),
@@ -1587,25 +1583,6 @@ pub struct BurnchainConfig {
     /// @default: `None`
     /// @deprecated: This setting is ignored in Epoch 3.0+.
     pub ast_precheck_size_height: Option<u64>,
-    /// Overrides for the burnchain block affirmation map for specific reward cycles.
-    /// Allows manually setting the miner affirmation ('p'resent/'n'ot-present/'a'bsent)
-    /// map for a given cycle, bypassing the map normally derived from sortition results.
-    ///
-    /// Special defaults are added when [`BurnchainConfig::mode`] is "xenon", but
-    /// config entries take precedence. At startup, these overrides are written to
-    /// the `BurnchainDB` (`overrides` table).
-    /// ---
-    /// @default: Empty map
-    /// @deprecated: This setting is ignored in Epoch 3.0+. Only used in the neon chain mode.
-    /// @notes:
-    ///   - Primarily used for testing or recovering from network issues.
-    ///   - Configured as a list `[[burnchain.affirmation_overrides]]` in TOML, each with
-    ///     `reward_cycle` (integer) and `affirmation` (string of 'p'/'n'/'a', length `reward_cycle - 1`).
-    /// @toml_example: |
-    ///   [[burnchain.affirmation_overrides]]
-    ///   reward_cycle = 413
-    ///   affirmation = "pna..." # Must be 412 chars long
-    pub affirmation_overrides: HashMap<u64, AffirmationMap>,
     /// Fault injection setting for testing. Introduces an artificial delay (in
     /// milliseconds) before processing each burnchain block download. Simulates a
     /// slow burnchain connection.
@@ -1672,7 +1649,6 @@ impl BurnchainConfig {
             sunset_end: None,
             wallet_name: "".to_string(),
             ast_precheck_size_height: None,
-            affirmation_overrides: HashMap::new(),
             fault_injection_burnchain_block_delay: 0,
             max_unspent_utxos: Some(1024),
         }
@@ -1773,76 +1749,11 @@ pub struct BurnchainConfigFile {
     pub sunset_end: Option<u32>,
     pub wallet_name: Option<String>,
     pub ast_precheck_size_height: Option<u64>,
-    pub affirmation_overrides: Option<Vec<AffirmationOverride>>,
     pub fault_injection_burnchain_block_delay: Option<u64>,
     pub max_unspent_utxos: Option<u64>,
 }
 
 impl BurnchainConfigFile {
-    /// Add affirmation overrides required to sync Xenon Testnet node.
-    ///
-    /// The Xenon Testnet Stacks 2.4 activation height occurred before the finalized SIP-024 updates and release of the stacks-node versioned 2.4.0.0.0.
-    /// This caused the Stacks Xenon testnet to undergo a deep reorg when 2.4.0.0.0 was finalized. This deep reorg meant that 3 reward cycles were
-    /// invalidated, which requires overrides in the affirmation map to continue correct operation. Those overrides are required for cycles 413, 414, and 415.
-    #[allow(clippy::indexing_slicing)] // bad affirmation map override should panic
-    pub fn add_affirmation_overrides_xenon(&mut self) {
-        let mut default_overrides = vec![
-        AffirmationOverride {
-            reward_cycle: 413,
-            affirmation: "nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnpppppnnnnnnnnnnnnnnnnnnnnnnnpppppppppppppppnnnnnnnnnnnnnnnnnnnnnnnppppppppppnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnppppppppnnnnnnnnnnnnnnnnnnnnnnnppnppnnnnnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnnnppppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnnpppppppnnnnnnnnnnnnnnnnnnnnnnnnnnpnnnnnnnnnnnnnnnnnnnnnnnnnpppnppppppppppppppnnppppnpa".to_string()
-        },
-        AffirmationOverride {
-            reward_cycle: 414,
-            affirmation: "nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnpppppnnnnnnnnnnnnnnnnnnnnnnnpppppppppppppppnnnnnnnnnnnnnnnnnnnnnnnppppppppppnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnppppppppnnnnnnnnnnnnnnnnnnnnnnnppnppnnnnnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnnnppppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnnpppppppnnnnnnnnnnnnnnnnnnnnnnnnnnpnnnnnnnnnnnnnnnnnnnnnnnnnpppnppppppppppppppnnppppnpaa".to_string()
-        },
-        AffirmationOverride {
-            reward_cycle: 415,
-            affirmation: "nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnpppppnnnnnnnnnnnnnnnnnnnnnnnpppppppppppppppnnnnnnnnnnnnnnnnnnnnnnnppppppppppnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnppppppppnnnnnnnnnnnnnnnnnnnnnnnppnppnnnnnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnnnppppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnnpppppppnnnnnnnnnnnnnnnnnnnnnnnnnnpnnnnnnnnnnnnnnnnnnnnnnnnnpppnppppppppppppppnnppppnpaaa".to_string()
-        }];
-
-        // Now compute the 2.5 overrides.
-        let affirmations_pre_2_5 = "nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnpppppnnnnnnnnnnnnnnnnnnnnnnnpppppppppppppppnnnnnnnnnnnnnnnnnnnnnnnppppppppppnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnppppppppnnnnnnnnnnnnnnnnnnnnnnnppnppnnnnnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnnnppppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnnpppppppnnnnnnnnnnnnnnnnnnnnnnnnnnpnnnnnnnnnnnnnnnnnnnnnnnnnpppnppppppppppppppnnppppnpaaaapppppppnnnnnnnnnnnnnnnnnnnnnnnpnppnppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnpnpppppppppnppnnnnnnnnnnnnnnnnnnnnnnnnnppnppppppppp";
-        let xenon_pox_consts = PoxConstants::testnet_default();
-        let last_present_cycle = xenon_pox_consts
-            .block_height_to_reward_cycle(
-                BITCOIN_TESTNET_FIRST_BLOCK_HEIGHT,
-                BITCOIN_TESTNET_STACKS_25_BURN_HEIGHT,
-            )
-            .unwrap();
-        assert_eq!(
-            u64::try_from(affirmations_pre_2_5.len()).unwrap(),
-            last_present_cycle - 1
-        );
-        let last_override = xenon_pox_consts
-            .block_height_to_reward_cycle(
-                BITCOIN_TESTNET_FIRST_BLOCK_HEIGHT,
-                BITCOIN_TESTNET_STACKS_25_REORGED_HEIGHT,
-            )
-            .unwrap();
-        let override_values = ["a", "n"];
-
-        for (override_index, reward_cycle) in (last_present_cycle + 1..=last_override).enumerate() {
-            assert!(override_values.len() > override_index);
-            let overrides = override_values[..(override_index + 1)].join("");
-            let affirmation = format!("{affirmations_pre_2_5}{overrides}");
-            default_overrides.push(AffirmationOverride {
-                reward_cycle,
-                affirmation,
-            });
-        }
-
-        if let Some(affirmation_overrides) = self.affirmation_overrides.as_mut() {
-            for affirmation in default_overrides {
-                // insert at front, so that the hashmap uses the configured overrides
-                //  instead of the defaults (the configured overrides will write over the
-                //  the defaults because they come later in the list).
-                affirmation_overrides.insert(0, affirmation);
-            }
-        } else {
-            self.affirmation_overrides = Some(default_overrides);
-        };
-    }
-
     fn into_config_default(
         mut self,
         default_burnchain_config: BurnchainConfig,
@@ -1851,7 +1762,6 @@ impl BurnchainConfigFile {
             if self.magic_bytes.is_none() {
                 self.magic_bytes = ConfigFile::xenon().burnchain.unwrap().magic_bytes;
             }
-            self.add_affirmation_overrides_xenon();
         }
 
         let mode = self.mode.unwrap_or(default_burnchain_config.mode);
@@ -1870,25 +1780,6 @@ impl BurnchainConfigFile {
             }
         }
 
-        let mut affirmation_overrides = HashMap::new();
-        if let Some(aos) = self.affirmation_overrides {
-            for ao in aos {
-                let Some(affirmation_map) = AffirmationMap::decode(&ao.affirmation) else {
-                    return Err(format!(
-                        "Invalid affirmation override for reward cycle {}: {}",
-                        ao.reward_cycle, ao.affirmation
-                    ));
-                };
-                if u64::try_from(affirmation_map.len()).unwrap() != ao.reward_cycle - 1 {
-                    return Err(format!(
-                        "Invalid affirmation override for reward cycle {}. Map len = {}, but expected {}.",
-                        ao.reward_cycle, affirmation_map.len(), ao.reward_cycle - 1,
-                    ));
-                }
-                affirmation_overrides.insert(ao.reward_cycle, affirmation_map);
-            }
-        }
-
         let mut config = BurnchainConfig {
             chain: self.chain.unwrap_or(default_burnchain_config.chain),
             chain_id: match self.chain_id {
@@ -1993,7 +1884,6 @@ impl BurnchainConfigFile {
             pox_prepare_length: self
                 .pox_prepare_length
                 .or(default_burnchain_config.pox_prepare_length),
-            affirmation_overrides,
             fault_injection_burnchain_block_delay: self
                 .fault_injection_burnchain_block_delay
                 .unwrap_or(default_burnchain_config.fault_injection_burnchain_block_delay),
@@ -4844,104 +4734,6 @@ mod tests {
         );
     }
 
-    #[test]
-    fn should_load_affirmation_map() {
-        let affirmation_string = "nnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnpppppnnnnnnnnnnnnnnnnnnnnnnnpppppppppppppppnnnnnnnnnnnnnnnnnnnnnnnppppppppppnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnppppppppnnnnnnnnnnnnnnnnnnnnnnnppnppnnnnnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnnnppppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnnpppppppnnnnnnnnnnnnnnnnnnnnnnnnnnpnnnnnnnnnnnnnnnnnnnnnnnnnpppnppppppppppppppnnppppnpa";
-        let affirmation =
-            AffirmationMap::decode(affirmation_string).expect("Failed to decode affirmation map");
-        let config = Config::from_config_file(
-            ConfigFile::from_str(&format!(
-                r#"
-                    [[burnchain.affirmation_overrides]]
-                    reward_cycle = 413
-                    affirmation = "{affirmation_string}"
-                "#
-            ))
-            .expect("Expected to be able to parse config file from string"),
-            false,
-        )
-        .expect("Expected to be able to parse affirmation map from file");
-
-        assert_eq!(config.burnchain.affirmation_overrides.len(), 1);
-        assert_eq!(config.burnchain.affirmation_overrides.get(&0), None);
-        assert_eq!(
-            config.burnchain.affirmation_overrides.get(&413),
-            Some(&affirmation)
-        );
-    }
-
-    #[test]
-    fn should_fail_to_load_invalid_affirmation_map() {
-        let bad_affirmation_string = "bad_map";
-        let file = ConfigFile::from_str(&format!(
-            r#"
-                    [[burnchain.affirmation_overrides]]
-                    reward_cycle = 1
-                    affirmation = "{bad_affirmation_string}"
-                "#
-        ))
-        .expect("Expected to be able to parse config file from string");
-
-        assert!(Config::from_config_file(file, false).is_err());
-    }
-
-    #[test]
-    fn should_load_empty_affirmation_map() {
-        let config = Config::from_config_file(
-            ConfigFile::from_str(r#""#)
-                .expect("Expected to be able to parse config file from string"),
-            false,
-        )
-        .expect("Expected to be able to parse affirmation map from file");
-
-        assert!(config.burnchain.affirmation_overrides.is_empty());
-    }
-
-    #[test]
-    fn should_include_xenon_default_affirmation_overrides() {
-        let config = Config::from_config_file(
-            ConfigFile::from_str(
-                r#"
-                [burnchain]
-                chain = "bitcoin"
-                mode = "xenon"
-                "#,
-            )
-            .expect("Expected to be able to parse config file from string"),
-            false,
-        )
-        .expect("Expected to be able to parse affirmation map from file");
-        // Should default add xenon affirmation overrides
-        assert_eq!(config.burnchain.affirmation_overrides.len(), 5);
-    }
-
-    #[test]
-    fn should_override_xenon_default_affirmation_overrides() {
-        let affirmation_string = "aaapnnnnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnpppppnnnnnnnnnnnnnnnnnnnnnnnpppppppppppppppnnnnnnnnnnnnnnnnnnnnnnnppppppppppnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnppppppppnnnnnnnnnnnnnnnnnnnnnnnppnppnnnnnnnnnnnnnnnnnnnnnnnppppnnnnnnnnnnnnnnnnnnnnnnnnnppppppnnnnnnnnnnnnnnnnnnnnnnnnnppnnnnnnnnnnnnnnnnnnnnnnnnnpppppppnnnnnnnnnnnnnnnnnnnnnnnnnnpnnnnnnnnnnnnnnnnnnnnnnnnnpppnppppppppppppppnnppppnpa";
-        let affirmation =
-            AffirmationMap::decode(affirmation_string).expect("Failed to decode affirmation map");
-
-        let config = Config::from_config_file(
-            ConfigFile::from_str(&format!(
-                r#"
-                [burnchain]
-                chain = "bitcoin"
-                mode = "xenon"
-
-                [[burnchain.affirmation_overrides]]
-                reward_cycle = 413
-                affirmation = "{affirmation_string}"
-                "#,
-            ))
-            .expect("Expected to be able to parse config file from string"),
-            false,
-        )
-        .expect("Expected to be able to parse affirmation map from file");
-        // Should default add xenon affirmation overrides, but overwrite with the configured one above
-        assert_eq!(config.burnchain.affirmation_overrides.len(), 5);
-        assert_eq!(config.burnchain.affirmation_overrides[&413], affirmation);
-    }
-
     #[test]
     fn test_into_config_default_chain_id() {
         // Helper function to create BurnchainConfigFile with mode and optional chain_id