deprecate FairnessShuffler

aptos-labs · Jun 17, 2024 · 86b9d21 · 86b9d21
1 parent c2b3482
commit 86b9d21
Show file tree

Hide file tree

Showing 16 changed files with 23 additions and 43 deletions.
diff --git a/...uffler/fairness/conflict_key/entry_fun.rs → ...ecated_fairness/conflict_key/entry_fun.rs b/...uffler/fairness/conflict_key/entry_fun.rs → ...ecated_fairness/conflict_key/entry_fun.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::conflict_key::ConflictKey;
+use crate::transaction_shuffler::deprecated_fairness::conflict_key::ConflictKey;
 use aptos_types::transaction::{SignedTransaction, TransactionPayload};
 use move_core_types::{identifier::Identifier, language_storage::ModuleId};
 

diff --git a/...fairness/conflict_key/entry_fun_module.rs → ...fairness/conflict_key/entry_fun_module.rs b/...fairness/conflict_key/entry_fun_module.rs → ...fairness/conflict_key/entry_fun_module.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::conflict_key::ConflictKey;
+use crate::transaction_shuffler::deprecated_fairness::conflict_key::ConflictKey;
 use aptos_types::transaction::{SignedTransaction, TransactionPayload};
 use move_core_types::language_storage::ModuleId;
 

diff --git a/...ion_shuffler/fairness/conflict_key/mod.rs → ...r/deprecated_fairness/conflict_key/mod.rs b/...ion_shuffler/fairness/conflict_key/mod.rs → ...r/deprecated_fairness/conflict_key/mod.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::TxnIdx;
+use crate::transaction_shuffler::deprecated_fairness::TxnIdx;
 use std::{collections::HashMap, hash::Hash};
 
 pub(crate) mod entry_fun;

diff --git a/...ffler/fairness/conflict_key/test_utils.rs → ...cated_fairness/conflict_key/test_utils.rs b/...ffler/fairness/conflict_key/test_utils.rs → ...cated_fairness/conflict_key/test_utils.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::conflict_key::{
+use crate::transaction_shuffler::deprecated_fairness::conflict_key::{
     ConflictKey, ConflictKeyId, ConflictKeyRegistry,
 };
 use proptest::prelude::*;

diff --git a/...ffler/fairness/conflict_key/txn_sender.rs → ...cated_fairness/conflict_key/txn_sender.rs b/...ffler/fairness/conflict_key/txn_sender.rs → ...cated_fairness/conflict_key/txn_sender.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::conflict_key::ConflictKey;
+use crate::transaction_shuffler::deprecated_fairness::conflict_key::ConflictKey;
 use aptos_types::transaction::SignedTransaction;
 use move_core_types::account_address::AccountAddress;
 

diff --git a/...action_shuffler/fairness/conflict_zone.rs → ...fler/deprecated_fairness/conflict_zone.rs b/...action_shuffler/fairness/conflict_zone.rs → ...fler/deprecated_fairness/conflict_zone.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::{
+use crate::transaction_shuffler::deprecated_fairness::{
     conflict_key::{ConflictKeyId, ConflictKeyRegistry, MapByKeyId},
     TxnIdx,
 };

diff --git a/.../src/transaction_shuffler/fairness/mod.rs → ...ction_shuffler/deprecated_fairness/mod.rs b/.../src/transaction_shuffler/fairness/mod.rs → ...ction_shuffler/deprecated_fairness/mod.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::transaction_shuffler::{
-    fairness::{
+    deprecated_fairness::{
         conflict_key::{
             entry_fun::EntryFunKey, entry_fun_module::EntryFunModuleKey, txn_sender::TxnSenderKey,
             ConflictKeyRegistry,
@@ -178,7 +178,7 @@ impl<'a, const NUM_CONFLICT_ZONES: usize> FairnessShufflerImpl<'a, NUM_CONFLICT_
 
 #[cfg(test)]
 mod test_utils {
-    use crate::transaction_shuffler::fairness::FairnessShuffler;
+    use crate::transaction_shuffler::deprecated_fairness::FairnessShuffler;
     use proptest::prelude::*;
 
     impl FairnessShuffler {

diff --git a/...saction_shuffler/fairness/pending_zone.rs → ...ffler/deprecated_fairness/pending_zone.rs b/...saction_shuffler/fairness/pending_zone.rs → ...ffler/deprecated_fairness/pending_zone.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::{
+use crate::transaction_shuffler::deprecated_fairness::{
     conflict_key::{ConflictKeyId, ConflictKeyRegistry, MapByKeyId},
     TxnIdx,
 };

diff --git a/...on_shuffler/fairness/selection_tracker.rs → .../deprecated_fairness/selection_tracker.rs b/...on_shuffler/fairness/selection_tracker.rs → .../deprecated_fairness/selection_tracker.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::TxnIdx;
+use crate::transaction_shuffler::deprecated_fairness::TxnIdx;
 
 pub struct SelectionTracker {
     selected_markers: Vec<bool>,

diff --git a/...saction_shuffler/fairness/tests/manual.rs → ...ffler/deprecated_fairness/tests/manual.rs b/...saction_shuffler/fairness/tests/manual.rs → ...ffler/deprecated_fairness/tests/manual.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::{
+use crate::transaction_shuffler::deprecated_fairness::{
     conflict_key::ConflictKeyRegistry, FairnessShuffler, FairnessShufflerImpl,
 };
 

diff --git a/...ransaction_shuffler/fairness/tests/mod.rs → ...shuffler/deprecated_fairness/tests/mod.rs b/...ransaction_shuffler/fairness/tests/mod.rs → ...shuffler/deprecated_fairness/tests/mod.rs
diff --git a/...tion_shuffler/fairness/tests/proptests.rs → ...er/deprecated_fairness/tests/proptests.rs b/...tion_shuffler/fairness/tests/proptests.rs → ...er/deprecated_fairness/tests/proptests.rs
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::transaction_shuffler::fairness::{
+use crate::transaction_shuffler::deprecated_fairness::{
     conflict_key::{
         test_utils::{FakeEntryFunKey, FakeEntryFunModuleKey, FakeSenderKey, FakeTxn},
         ConflictKeyRegistry, MapByKeyId,

diff --git a/consensus/src/transaction_shuffler/mod.rs b/consensus/src/transaction_shuffler/mod.rs
@@ -2,17 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use aptos_logger::info;
-use aptos_types::{
-    on_chain_config::{
-        TransactionShufflerType,
-        TransactionShufflerType::{DeprecatedSenderAwareV1, NoShuffling, SenderAwareV2},
-    },
-    transaction::SignedTransaction,
-};
+use aptos_types::{on_chain_config::TransactionShufflerType, transaction::SignedTransaction};
 use sender_aware::SenderAwareShuffler;
 use std::sync::Arc;
 
-mod fairness;
+mod deprecated_fairness;
 mod sender_aware;
 
 /// Interface to shuffle transactions
@@ -32,6 +26,8 @@ impl TransactionShuffler for NoOpShuffler {
 pub fn create_transaction_shuffler(
     shuffler_type: TransactionShufflerType,
 ) -> Arc<dyn TransactionShuffler> {
+    use TransactionShufflerType::*;
+
     match shuffler_type {
         NoShuffling => {
             info!("Using no-op transaction shuffling");
@@ -48,7 +44,7 @@ pub fn create_transaction_shuffler(
             );
             Arc::new(SenderAwareShuffler::new(conflict_window_size as usize))
         },
-        TransactionShufflerType::Fairness {
+        DeprecatedFairness {
             sender_conflict_window_size,
             module_conflict_window_size,
             entry_fun_conflict_window_size,
@@ -59,7 +55,7 @@ pub fn create_transaction_shuffler(
                 module_conflict_window_size,
                 entry_fun_conflict_window_size
             );
-            Arc::new(fairness::FairnessShuffler {
+            Arc::new(deprecated_fairness::FairnessShuffler {
                 sender_conflict_window_size: sender_conflict_window_size as usize,
                 module_conflict_window_size: module_conflict_window_size as usize,
                 entry_fun_conflict_window_size: entry_fun_conflict_window_size as usize,

diff --git a/testsuite/forge-cli/src/main.rs b/testsuite/forge-cli/src/main.rs
@@ -2079,11 +2079,7 @@ fn realistic_network_tuned_for_throughput_test() -> ForgeConfig {
                 }
                 OnChainExecutionConfig::V4(config_v4) => {
                     config_v4.block_gas_limit_type = BlockGasLimitType::NoLimit;
-                    config_v4.transaction_shuffler_type = TransactionShufflerType::Fairness {
-                        sender_conflict_window_size: 256,
-                        module_conflict_window_size: 2,
-                        entry_fun_conflict_window_size: 3,
-                    };
+                    config_v4.transaction_shuffler_type = TransactionShufflerType::SenderAwareV2(256);
                 }
             }
             helm_values["chain"]["on_chain_execution_config"] =

diff --git a/testsuite/forge-cli/src/suites/dag.rs b/testsuite/forge-cli/src/suites/dag.rs
@@ -108,11 +108,7 @@ fn dag_realistic_env_max_load_test(
                 }
                 OnChainExecutionConfig::V4(config_v4) => {
                     config_v4.block_gas_limit_type = BlockGasLimitType::NoLimit;
-                    config_v4.transaction_shuffler_type = TransactionShufflerType::Fairness {
-                        sender_conflict_window_size: 256,
-                        module_conflict_window_size: 2,
-                        entry_fun_conflict_window_size: 3,
-                    };
+                    config_v4.transaction_shuffler_type = TransactionShufflerType::SenderAwareV2(32);
                 }
             }
             helm_values["chain"]["on_chain_execution_config"] =
@@ -211,11 +207,7 @@ fn dag_reconfig_enable_test() -> ForgeConfig {
                     }
                     OnChainExecutionConfig::V4(config_v4) => {
                         config_v4.block_gas_limit_type = BlockGasLimitType::NoLimit;
-                        config_v4.transaction_shuffler_type = TransactionShufflerType::Fairness {
-                            sender_conflict_window_size: 256,
-                            module_conflict_window_size: 2,
-                            entry_fun_conflict_window_size: 3,
-                        };
+                        config_v4.transaction_shuffler_type = TransactionShufflerType::SenderAwareV2(32);
                     }
             }
             helm_values["chain"]["on_chain_execution_config"] =

diff --git a/types/src/on_chain_config/execution_config.rs b/types/src/on_chain_config/execution_config.rs
@@ -70,11 +70,7 @@ impl OnChainExecutionConfig {
     /// Features that are ready for deployment can be enabled here.
     pub fn default_for_genesis() -> Self {
         OnChainExecutionConfig::V4(ExecutionConfigV4 {
-            transaction_shuffler_type: TransactionShufflerType::Fairness {
-                sender_conflict_window_size: 32,
-                module_conflict_window_size: 1,
-                entry_fun_conflict_window_size: 2,
-            },
+            transaction_shuffler_type: TransactionShufflerType::SenderAwareV2(32),
             block_gas_limit_type: BlockGasLimitType::default_for_genesis(),
             transaction_deduper_type: TransactionDeduperType::TxnHashAndAuthenticatorV1,
         })
@@ -152,7 +148,7 @@ pub enum TransactionShufflerType {
     NoShuffling,
     DeprecatedSenderAwareV1(u32),
     SenderAwareV2(u32),
-    Fairness {
+    DeprecatedFairness {
         sender_conflict_window_size: u32,
         module_conflict_window_size: u32,
         entry_fun_conflict_window_size: u32,