use ore_api::{ consts::*, error::OreError, loaders::*, state::{Bus, Config}, }; use solana_program::{ account_info::AccountInfo, clock::Clock, entrypoint::ProgramResult, program_error::ProgramError, program_pack::Pack, pubkey::Pubkey, sysvar::Sysvar, }; use spl_token::state::Mint; use crate::utils::AccountDeserialize; /// Reset sets up the Ore program for the next epoch. Its responsibilities include: /// 1. Reset bus account rewards counters. /// 2. Adjust the reward rate to stabilize inflation. /// 3. Top up the treasury token account to fund claims. /// /// Safety requirements: /// - Reset is a permissionless instruction and can be invoked by any signer. /// - Can only succeed if START_AT has passed. /// - Can only succeed if more tha 60 seconds or more have passed since the last successful reset. /// - The busses, mint, treasury, treasury token account, and token program must all be valid. /// /// Discussion: /// - It is important that `reset` can only be invoked once per 60 second period to ensure the supply growth rate /// stays within the guaranteed bounds of 0 ≤ R ≤ 2 ORE/min. /// - The reward rate is dynamically adjusted based on last epoch's theoretical reward rate to target an average /// supply growth rate of 1 ORE/min. /// - The "theoretical" reward rate refers to the amount that would have been paid out if rewards were not capped by /// the bus limits. It's necessary to use this value to ensure the reward rate update calculation accurately /// accounts for the difficulty of submitted hashes. pub fn process_reset<'a, 'info>( _program_id: &Pubkey, accounts: &'a [AccountInfo<'info>], _data: &[u8], ) -> ProgramResult { // Load accounts let [signer, bus_0_info, bus_1_info, bus_2_info, bus_3_info, bus_4_info, bus_5_info, bus_6_info, bus_7_info, config_info, mint_info, treasury_info, treasury_tokens_info, token_program] = accounts else { return Err(ProgramError::NotEnoughAccountKeys); }; load_signer(signer)?; load_bus(bus_0_info, 0, true)?; load_bus(bus_1_info, 1, true)?; load_bus(bus_2_info, 2, true)?; load_bus(bus_3_info, 3, true)?; load_bus(bus_4_info, 4, true)?; load_bus(bus_5_info, 5, true)?; load_bus(bus_6_info, 6, true)?; load_bus(bus_7_info, 7, true)?; load_config(config_info, true)?; load_mint(mint_info, MINT_ADDRESS, true)?; load_treasury(treasury_info, true)?; load_treasury_tokens(treasury_tokens_info, true)?; load_program(token_program, spl_token::id())?; let busses: [&AccountInfo; BUS_COUNT] = [ bus_0_info, bus_1_info, bus_2_info, bus_3_info, bus_4_info, bus_5_info, bus_6_info, bus_7_info, ]; // Validate enough time has passed since last reset let mut config_data = config_info.data.borrow_mut(); let config = Config::try_from_bytes_mut(&mut config_data)?; let clock = Clock::get().or(Err(ProgramError::InvalidAccountData))?; if config .last_reset_at .saturating_add(EPOCH_DURATION) .gt(&clock.unix_timestamp) { return Ok(()); } // Update reset timestamp config.last_reset_at = clock.unix_timestamp; // Reset bus accounts and calculate actual rewards mined since last reset let mut total_remaining_rewards = 0u64; let mut total_theoretical_rewards = 0u64; for i in 0..BUS_COUNT { let mut bus_data = busses[i].data.borrow_mut(); let bus = Bus::try_from_bytes_mut(&mut bus_data)?; total_remaining_rewards = total_remaining_rewards.saturating_add(bus.rewards); total_theoretical_rewards = total_theoretical_rewards.saturating_add(bus.theoretical_rewards); bus.rewards = BUS_EPOCH_REWARDS; bus.theoretical_rewards = 0; } let total_epoch_rewards = MAX_EPOCH_REWARDS.saturating_sub(total_remaining_rewards); // Update base reward rate for next epoch config.base_reward_rate = calculate_new_reward_rate(config.base_reward_rate, total_theoretical_rewards); // Max supply check let mint = Mint::unpack(&mint_info.data.borrow()).expect("Failed to parse mint"); if mint.supply.ge(&MAX_SUPPLY) { return Err(OreError::MaxSupply.into()); } // Fund treasury token account let amount = MAX_SUPPLY .saturating_sub(mint.supply) .min(total_epoch_rewards); solana_program::program::invoke_signed( &spl_token::instruction::mint_to( &spl_token::id(), mint_info.key, treasury_tokens_info.key, treasury_info.key, &[treasury_info.key], amount, )?, &[ token_program.clone(), mint_info.clone(), treasury_tokens_info.clone(), treasury_info.clone(), ], &[&[TREASURY, &[TREASURY_BUMP]]], )?; Ok(()) } /// This function calculates what the new reward rate should be based on how many total rewards /// were mined in the prior epoch. The math is largely identitical to function used by the Bitcoin /// network to update the difficulty between each epoch. /// /// new_rate = current_rate * (target_rewards / actual_rewards) /// /// The new rate is then smoothed by a constant factor to avoid large fluctuations. In Ore's case, /// the epochs are short (60 seconds) so a smoothing factor of 2 has been chosen. That is, the reward rate /// can at most double or halve from one epoch to the next. pub(crate) fn calculate_new_reward_rate(current_rate: u64, epoch_rewards: u64) -> u64 { // Avoid division by zero. Leave the reward rate unchanged, if detected. if epoch_rewards.eq(&0) { return current_rate; } // Calculate new reward rate. let new_rate = (current_rate as u128) .saturating_mul(TARGET_EPOCH_REWARDS as u128) .saturating_div(epoch_rewards as u128) as u64; // Smooth reward rate so it cannot change by more than a constant factor from one epoch to the next. let new_rate_min = current_rate.saturating_div(SMOOTHING_FACTOR); let new_rate_max = current_rate.saturating_mul(SMOOTHING_FACTOR); let new_rate_smoothed = new_rate.min(new_rate_max).max(new_rate_min); // Prevent reward rate from dropping below 1 or exceeding BUS_EPOCH_REWARDS and return. new_rate_smoothed.max(1).min(BUS_EPOCH_REWARDS) } #[cfg(test)] mod tests { use rand::{distributions::Uniform, Rng}; use crate::calculate_new_reward_rate; use ore_api::consts::{ BUS_EPOCH_REWARDS, MAX_EPOCH_REWARDS, SMOOTHING_FACTOR, TARGET_EPOCH_REWARDS, }; const FUZZ_SIZE: u64 = 10_000; #[test] fn test_calculate_new_reward_rate_target() { let current_rate = 1000; let new_rate = calculate_new_reward_rate(current_rate, TARGET_EPOCH_REWARDS); assert!(new_rate.eq(¤t_rate)); } #[test] fn test_calculate_new_reward_rate_div_by_zero() { let current_rate = 1000; let new_rate = calculate_new_reward_rate(current_rate, 0); assert!(new_rate.eq(¤t_rate)); } #[test] fn test_calculate_new_reward_rate_lower() { let current_rate = 1000; let new_rate = calculate_new_reward_rate( current_rate, TARGET_EPOCH_REWARDS.saturating_add(1_000_000_000), ); assert!(new_rate.lt(¤t_rate)); } #[test] fn test_calculate_new_reward_rate_lower_fuzz() { let mut rng = rand::thread_rng(); for _ in 0..FUZZ_SIZE { let current_rate: u64 = rng.sample(Uniform::new(1, BUS_EPOCH_REWARDS)); let actual_rewards: u64 = rng.sample(Uniform::new(TARGET_EPOCH_REWARDS, MAX_EPOCH_REWARDS)); let new_rate = calculate_new_reward_rate(current_rate, actual_rewards); assert!(new_rate.lt(¤t_rate)); } } #[test] fn test_calculate_new_reward_rate_higher() { let current_rate = 1000; let new_rate = calculate_new_reward_rate( current_rate, TARGET_EPOCH_REWARDS.saturating_sub(1_000_000_000), ); assert!(new_rate.gt(¤t_rate)); } #[test] fn test_calculate_new_reward_rate_higher_fuzz() { let mut rng = rand::thread_rng(); for _ in 0..FUZZ_SIZE { let current_rate: u64 = rng.sample(Uniform::new(1, BUS_EPOCH_REWARDS)); let actual_rewards: u64 = rng.sample(Uniform::new(1, TARGET_EPOCH_REWARDS)); let new_rate = calculate_new_reward_rate(current_rate, actual_rewards); assert!(new_rate.gt(¤t_rate)); } } #[test] fn test_calculate_new_reward_rate_max_smooth() { let current_rate = 1000; let new_rate = calculate_new_reward_rate(current_rate, 1); assert!(new_rate.eq(¤t_rate.saturating_mul(SMOOTHING_FACTOR))); } #[test] fn test_calculate_new_reward_rate_min_smooth() { let current_rate = 1000; let new_rate = calculate_new_reward_rate(current_rate, u64::MAX); assert!(new_rate.eq(¤t_rate.saturating_div(SMOOTHING_FACTOR))); } #[test] fn test_calculate_new_reward_rate_max_inputs() { let new_rate = calculate_new_reward_rate(BUS_EPOCH_REWARDS, MAX_EPOCH_REWARDS); assert!(new_rate.eq(&BUS_EPOCH_REWARDS.saturating_div(SMOOTHING_FACTOR))); } #[test] fn test_calculate_new_reward_rate_min_inputs() { let new_rate = calculate_new_reward_rate(1, 1); assert!(new_rate.eq(&1u64.saturating_mul(SMOOTHING_FACTOR))); } }