feat: add checks to make sure indexes are set

Author: ali-behjati

runtime/src/bank/pyth_accumulator.rs

@@ -139,6 +139,10 @@ pub fn update_v1(
     let v1_messages = if use_message_buffers {
         let mut measure = Measure::start("update_v1_load_program_accounts");
 
+        assert!(
+            bank.account_indexes_include_key(&*MESSAGE_BUFFER_PID),
+            "MessageBuffer program account index missing"
+        );
         message_buffer_accounts = bank
             .get_filtered_indexed_accounts(
                 &IndexKey::ProgramId(*MESSAGE_BUFFER_PID),
@@ -384,6 +388,11 @@ fn post_accumulator_attestation(
 pub fn update_v2(bank: &Bank) -> std::result::Result<(), AccumulatorUpdateErrorV1> {
     let mut measure = Measure::start("update_v2_load_program_accounts");
 
+    assert!(
+        bank.account_indexes_include_key(&*ORACLE_PID),
+        "Oracle program account index missing"
+    );
+
     let accounts = bank
         .get_filtered_indexed_accounts(
             &IndexKey::ProgramId(*ORACLE_PID),

runtime/src/bank/pyth_accumulator_tests.rs

@@ -1,5 +1,10 @@
 use {
+    super::pyth_accumulator::MESSAGE_BUFFER_PID,
     crate::{
+        accounts_db::AccountShrinkThreshold,
+        accounts_index::{
+            AccountIndex, AccountSecondaryIndexes, AccountSecondaryIndexesIncludeExclude,
+        },
         bank::{
             pyth_accumulator::{get_accumulator_keys, ACCUMULATOR_RING_SIZE, ORACLE_PID},
             Bank,
@@ -25,6 +30,7 @@ use {
         epoch_schedule::EpochSchedule,
         feature::{self, Feature},
         feature_set,
+        genesis_config::GenesisConfig,
         hash::hashv,
         pubkey::Pubkey,
         signature::keypair_from_seed,
@@ -33,6 +39,21 @@ use {
     std::{io::Read, mem::size_of, sync::Arc},
 };
 
+fn create_new_bank_for_tests_with_index(genesis_config: &GenesisConfig) -> Bank {
+    Bank::new_with_config_for_tests(
+        genesis_config,
+        AccountSecondaryIndexes {
+            keys: Some(AccountSecondaryIndexesIncludeExclude {
+                exclude: false,
+                keys: [*ORACLE_PID, *MESSAGE_BUFFER_PID].into_iter().collect(),
+            }),
+            indexes: [AccountIndex::ProgramId].into_iter().collect(),
+        },
+        false,
+        AccountShrinkThreshold::default(),
+    )
+}
+
 // Create Message Account Bytes
 //
 // NOTE: This was serialized by hand, but should be replaced with the pythnet-sdk
@@ -107,7 +128,7 @@ fn test_update_accumulator_sysvar() {
     // due to slot 0 having special handling.
     let slots_in_epoch = 32;
     genesis_config.epoch_schedule = EpochSchedule::new(slots_in_epoch);
-    let mut bank = Bank::new_for_tests(&genesis_config);
+    let mut bank = create_new_bank_for_tests_with_index(&genesis_config);
     bank = new_from_parent(&Arc::new(bank));
     bank = new_from_parent(&Arc::new(bank));
 
@@ -392,7 +413,7 @@ fn test_update_accumulator_end_of_block() {
     // due to slot 0 having special handling.
     let slots_in_epoch = 32;
     genesis_config.epoch_schedule = EpochSchedule::new(slots_in_epoch);
-    let mut bank = Bank::new_for_tests(&genesis_config);
+    let mut bank = create_new_bank_for_tests_with_index(&genesis_config);
     bank = new_from_parent(&Arc::new(bank));
     bank = new_from_parent(&Arc::new(bank));
 
@@ -683,7 +704,7 @@ fn test_accumulator_v2(generate_buffers: [bool; 4]) {
     // due to slot 0 having special handling.
     let slots_in_epoch = 32;
     genesis_config.epoch_schedule = EpochSchedule::new(slots_in_epoch);
-    let mut bank = Bank::new_for_tests(&genesis_config);
+    let mut bank = create_new_bank_for_tests_with_index(&genesis_config);
 
     let generate_price = |seeds, generate_buffers: bool| {
         let (price_feed_key, _bump) = Pubkey::find_program_address(&[seeds], &ORACLE_PID);

validator/src/main.rs

@@ -52,6 +52,7 @@ use {
             AccountIndex, AccountSecondaryIndexes, AccountSecondaryIndexesIncludeExclude,
             AccountsIndexConfig, IndexLimitMb,
         },
+        bank::pyth_accumulator::{MESSAGE_BUFFER_PID, ORACLE_PID},
         hardened_unpack::MAX_GENESIS_ARCHIVE_UNPACKED_SIZE,
         runtime_config::RuntimeConfig,
         snapshot_config::SnapshotConfig,
@@ -3176,6 +3177,10 @@ fn process_account_indexes(matches: &ArgMatches) -> AccountSecondaryIndexes {
         })
         .collect();
 
+    assert(account_indexes.contains(&AccountIndex::ProgramId),
+        "The indexing should be enabled for program-id accounts. Add the following flag:\n\
+        --account-index program-id\n");
+
     let account_indexes_include_keys: HashSet<Pubkey> =
         values_t!(matches, "account_index_include_key", Pubkey)
             .unwrap_or_default()
@@ -3193,6 +3198,23 @@ fn process_account_indexes(matches: &ArgMatches) -> AccountSecondaryIndexes {
     let exclude_keys = !account_indexes_exclude_keys.is_empty();
     let include_keys = !account_indexes_include_keys.is_empty();
 
+    if include_keys {
+        if !account_indexes_include_keys.contains(&*ORACLE_PID) || !account_indexes_include_keys.contains(&*MESSAGE_BUFFER_PID) {
+            panic!(
+                "The oracle program id and message buffer program id must be included in the account index. Add the following flags\n\
+                --account-index-include-key {}\n\
+                --account-index-include-key {}\n",
+                &*ORACLE_PID, &*MESSAGE_BUFFER_PID
+            );
+        }
+    }
+
+    if exclude_keys {
+        if account_indexes_exclude_keys.contains(&*ORACLE_PID) || account_indexes_exclude_keys.contains(&*MESSAGE_BUFFER_PID) {
+            panic!("The oracle program id and message buffer program id must *not* be excluded from the account index.");
+        }
+    }
+
     let keys = if !account_indexes.is_empty() && (exclude_keys || include_keys) {
         let account_indexes_keys = AccountSecondaryIndexesIncludeExclude {
             exclude: exclude_keys,