Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
101 changes: 100 additions & 1 deletion workspace/apps/staking/contracts/src/flow_test/test.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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;
Expand Down Expand Up @@ -1994,3 +1996,100 @@ fn get_stakers_staker_exit_action_flow_test() {
let expected_stakers = array![].span();
assert!(stakers == expected_stakers);
}

/// FLow:
/// 4 Stakers stake.
/// Delegate STRK and BTC to staker 1
/// Delegate STRK to staker 2
/// Delegate BTC to staker 3
/// Advance K epochs
/// 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 staker_3 = system.new_staker(amount: stake_amount);
let staker_4 = system.new_staker(amount: stake_amount);
let staking_consensus = system.staking.consensus_dispatcher();

// Stakers stake.
system.stake(staker: staker_1, amount: stake_amount, pool_enabled: true, commission: 200);
system.stake(staker: staker_2, amount: stake_amount, pool_enabled: true, commission: 200);
system.stake(staker: staker_3, amount: stake_amount, pool_enabled: true, commission: 200);
system.stake(staker: staker_4, amount: stake_amount, pool_enabled: false, commission: 200);

// Setup pools.
let staker_1_strk_pool = system.staking.get_pool(staker: staker_1);
let staker_1_btc_pool = system
.set_open_for_delegation(
staker: staker_1, token_address: system.btc_token.contract_address(),
);
let staker_2_strk_pool = system.staking.get_pool(staker: staker_2);
let staker_3_btc_pool = system
.set_open_for_delegation(
staker: staker_3, token_address: system.btc_token.contract_address(),
);

// Create delegators and delegate.
let strk_delegator = system.new_delegator(amount: strk_delegation_amount * 2);
let btc_delegator = system
.new_btc_delegator(amount: btc_delegation_amount * 2, token: system.btc_token);
system
.delegate(
delegator: strk_delegator, pool: staker_1_strk_pool, amount: strk_delegation_amount,
);
system
.delegate_btc(
delegator: btc_delegator,
pool: staker_1_btc_pool,
amount: btc_delegation_amount,
token: system.btc_token,
);
system
.delegate(
delegator: strk_delegator, pool: staker_2_strk_pool, amount: strk_delegation_amount,
);
system
.delegate_btc(
delegator: btc_delegator,
pool: staker_3_btc_pool,
amount: btc_delegation_amount,
token: system.btc_token,
);

// Test get_stakers.
system.advance_k_epochs();
let stakers = staking_consensus.get_stakers(system.staking.get_current_epoch());
let total_strk_staking_power = stake_amount * 4 + strk_delegation_amount * 2;
let staker_with_strk_delegation_staking_power = mul_wide_and_div(
lhs: STRK_WEIGHT_FACTOR,
rhs: stake_amount + strk_delegation_amount,
div: total_strk_staking_power,
)
.unwrap();
let staker_without_strk_delegation_staking_power = mul_wide_and_div(
lhs: STRK_WEIGHT_FACTOR, rhs: stake_amount, div: total_strk_staking_power,
)
.unwrap();
let expected_stakers = array![
(
staker_1.staker.address,
staker_with_strk_delegation_staking_power + BTC_WEIGHT_FACTOR / 2,
Option::None,
),
(staker_2.staker.address, staker_with_strk_delegation_staking_power, Option::None),
(
staker_3.staker.address,
staker_without_strk_delegation_staking_power + BTC_WEIGHT_FACTOR / 2,
Option::None,
),
(staker_4.staker.address, staker_without_strk_delegation_staking_power, Option::None),
]
.span();
assert!(stakers == expected_stakers);
}