add get_stakers btc and strk delegations flow

Author: arad-starkware

workspace/apps/staking/contracts/src/flow_test/flow_ideas.md

@@ -1,6 +1,5 @@
 # Flow Ideas
 ## `get_stakers`
-- Delegate STRK and/or BTC, get stakers.
 - Undelegate, get stakers.
 - Enable / disable tokens, get stakers.
 - Stake, get stakers, increase stake, get stakers.

workspace/apps/staking/contracts/src/flow_test/test.cairo

@@ -7,9 +7,10 @@ use staking::flow_test::utils::{
     SystemTrait, TokenHelperTrait, test_flow_local,
 };
 use staking::pool::pool::Pool;
+use staking::pool::pool::Pool::STRK_CONFIG;
 use staking::pool::utils::compute_rewards_rounded_down;
 use staking::staking::interface::{IStakingConsensusDispatcherTrait, IStakingDispatcherTrait};
-use staking::staking::utils::STRK_WEIGHT_FACTOR;
+use staking::staking::utils::{BTC_WEIGHT_FACTOR, STRK_WEIGHT_FACTOR};
 use staking::test_utils::constants::{
     BTC_18D_CONFIG, BTC_5D_CONFIG, BTC_8D_CONFIG, PUBLIC_KEY, STRK_BASE_VALUE,
     TEST_MIN_BTC_FOR_REWARDS,
@@ -21,6 +22,7 @@ use staking::test_utils::{
     custom_decimals_token, deploy_mock_erc20_decimals_contract,
 };
 use starkware_utils::math::abs::wide_abs_diff;
+use starkware_utils::math::utils::mul_wide_and_div;
 use starkware_utils::time::time::Time;
 use starkware_utils_testing::test_utils::cheat_caller_address_once;
 use crate::types::Amount;
@@ -1994,3 +1996,118 @@ fn get_stakers_staker_exit_action_flow_test() {
     let expected_stakers = array![].span();
     assert!(stakers == expected_stakers);
 }
+
+/// FLow:
+/// Staker 1 stake
+/// Staker 2 stake
+/// Advance K epochs
+/// Test get_stakers
+/// Delegate STRK to staker 1
+/// Test get_stakers
+/// Advance epoch
+/// Delegate BTC to staker 2
+/// Test get_stakers
+/// Advance epoch
+/// Test get_stakers
+/// Advance epoch
+/// Test get_stakers
+#[test]
+fn get_stakers_delegation_flow_test() {
+    let cfg: StakingInitConfig = Default::default();
+    let mut system = SystemConfigTrait::basic_stake_flow_cfg(:cfg).deploy();
+    let stake_amount = system.staking.get_min_stake();
+    let strk_delegation_amount = STRK_CONFIG.min_for_rewards;
+    let btc_delegation_amount = TEST_MIN_BTC_FOR_REWARDS;
+    let staker_1 = system.new_staker(amount: stake_amount);
+    let staker_2 = system.new_staker(amount: stake_amount);
+    let staking = system.staking.dispatcher();
+    let staking_consensus = system.staking.consensus_dispatcher();
+    system.stake(staker: staker_1, amount: stake_amount, pool_enabled: true, commission: 200);
+    let strk_pool = system.staking.get_pool(staker: staker_1);
+    system.stake(staker: staker_2, amount: stake_amount, pool_enabled: false, commission: 200);
+    system.set_commission(staker: staker_2, commission: 200);
+    let btc_pool = system
+        .set_open_for_delegation(
+            staker: staker_2, token_address: system.btc_token.contract_address(),
+        );
+    system.advance_k_epochs();
+
+    // Test get_stakers
+    let epoch_id = staking.get_current_epoch();
+    let stakers = staking_consensus.get_stakers(:epoch_id);
+    let expected_stakers = array![
+        (staker_1.staker.address, STRK_WEIGHT_FACTOR / 2, Option::None),
+        (staker_2.staker.address, STRK_WEIGHT_FACTOR / 2, Option::None),
+    ]
+        .span();
+    assert!(stakers == expected_stakers);
+
+    // Delegate STRK
+    let delegator = system.new_delegator(amount: strk_delegation_amount);
+    system.delegate(:delegator, pool: strk_pool, amount: strk_delegation_amount);
+
+    // Test get_stakers
+    let stakers = staking_consensus.get_stakers(:epoch_id);
+    assert!(stakers == expected_stakers);
+
+    // Test next epoch.
+    let stakers = staking_consensus.get_stakers(epoch_id: epoch_id + 1);
+    assert!(stakers == expected_stakers);
+
+    // Advance epoch and delegate BTC
+    system.advance_epoch();
+    let btc_delegator = system
+        .new_btc_delegator(amount: btc_delegation_amount, token: system.btc_token);
+    system
+        .delegate_btc(
+            delegator: btc_delegator,
+            pool: btc_pool,
+            amount: btc_delegation_amount,
+            token: system.btc_token,
+        );
+
+    // Test get_stakers
+    let epoch_id = staking.get_current_epoch();
+    let stakers = staking_consensus.get_stakers(:epoch_id);
+    assert!(stakers == expected_stakers);
+
+    // Test next epoch.
+    let stakers = staking_consensus.get_stakers(epoch_id: epoch_id + 1);
+    let staker_1_strk_staking_power = mul_wide_and_div(
+        lhs: STRK_WEIGHT_FACTOR,
+        rhs: stake_amount + strk_delegation_amount,
+        div: stake_amount * 2 + strk_delegation_amount,
+    )
+        .unwrap();
+    let staker_2_strk_staking_power = mul_wide_and_div(
+        lhs: STRK_WEIGHT_FACTOR, rhs: stake_amount, div: stake_amount * 2 + strk_delegation_amount,
+    )
+        .unwrap();
+    let expected_stakers = array![
+        (staker_1.staker.address, staker_1_strk_staking_power, Option::None),
+        (staker_2.staker.address, staker_2_strk_staking_power, Option::None),
+    ]
+        .span();
+    assert!(stakers == expected_stakers);
+
+    // Advance epoch and test get_stakers
+    system.advance_epoch();
+    let epoch_id = staking.get_current_epoch();
+    let stakers = staking_consensus.get_stakers(:epoch_id);
+    assert!(stakers == expected_stakers);
+
+    // Test next epoch.
+    let stakers = staking_consensus.get_stakers(epoch_id: epoch_id + 1);
+    let expected_stakers = array![
+        (staker_1.staker.address, staker_1_strk_staking_power, Option::None),
+        (staker_2.staker.address, staker_2_strk_staking_power + BTC_WEIGHT_FACTOR, Option::None),
+    ]
+        .span();
+    assert!(stakers == expected_stakers);
+
+    // Advance epoch and test get_stakers
+    system.advance_epoch();
+    let epoch_id = staking.get_current_epoch();
+    let stakers = staking_consensus.get_stakers(:epoch_id);
+    assert!(stakers == expected_stakers);
+}