solana_sdk/

rent_collector.rs

#![cfg(feature = "full")]

//! calculate and collect rent from Accounts
use {
    solana_account::{AccountSharedData, ReadableAccount, WritableAccount},
    solana_sdk::{
        clock::Epoch,
        epoch_schedule::EpochSchedule,
        genesis_config::GenesisConfig,
        incinerator,
        pubkey::Pubkey,
        rent::{Rent, RentDue},
    },
};

#[cfg_attr(feature = "frozen-abi", derive(AbiExample))]
#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
pub struct RentCollector {
    pub epoch: Epoch,
    pub epoch_schedule: EpochSchedule,
    pub slots_per_year: f64,
    pub rent: Rent,
}

impl Default for RentCollector {
    fn default() -> Self {
        Self {
            epoch: Epoch::default(),
            epoch_schedule: EpochSchedule::default(),
            // derive default value using GenesisConfig::default()
            slots_per_year: GenesisConfig::default().slots_per_year(),
            rent: Rent::default(),
        }
    }
}

/// When rent is collected from an exempt account, rent_epoch is set to this
/// value. The idea is to have a fixed, consistent value for rent_epoch for all accounts that do not collect rent.
/// This enables us to get rid of the field completely.
pub const RENT_EXEMPT_RENT_EPOCH: Epoch = Epoch::MAX;

/// when rent is collected for this account, this is the action to apply to the account
#[derive(Debug)]
enum RentResult {
    /// this account will never have rent collected from it
    Exempt,
    /// maybe we collect rent later, but not now
    NoRentCollectionNow,
    /// collect rent
    CollectRent {
        new_rent_epoch: Epoch,
        rent_due: u64, // lamports, could be 0
    },
}

impl RentCollector {
    pub fn new(
        epoch: Epoch,
        epoch_schedule: EpochSchedule,
        slots_per_year: f64,
        rent: Rent,
    ) -> Self {
        Self {
            epoch,
            epoch_schedule,
            slots_per_year,
            rent,
        }
    }

    pub fn clone_with_epoch(&self, epoch: Epoch) -> Self {
        Self {
            epoch,
            ..self.clone()
        }
    }

    /// true if it is easy to determine this account should consider having rent collected from it
    pub fn should_collect_rent(&self, address: &Pubkey, executable: bool) -> bool {
        !(executable // executable accounts must be rent-exempt balance
            || *address == incinerator::id())
    }

    /// given an account that 'should_collect_rent'
    /// returns (amount rent due, is_exempt_from_rent)
    pub fn get_rent_due(
        &self,
        lamports: u64,
        data_len: usize,
        account_rent_epoch: Epoch,
    ) -> RentDue {
        if self.rent.is_exempt(lamports, data_len) {
            RentDue::Exempt
        } else {
            let slots_elapsed: u64 = (account_rent_epoch..=self.epoch)
                .map(|epoch| {
                    self.epoch_schedule
                        .get_slots_in_epoch(epoch.saturating_add(1))
                })
                .sum();

            // avoid infinite rent in rust 1.45
            let years_elapsed = if self.slots_per_year != 0.0 {
                slots_elapsed as f64 / self.slots_per_year
            } else {
                0.0
            };

            // we know this account is not exempt
            let due = self.rent.due_amount(data_len, years_elapsed);
            RentDue::Paying(due)
        }
    }

    // Updates the account's lamports and status, and returns the amount of rent collected, if any.
    // This is NOT thread safe at some level. If we try to collect from the same account in
    // parallel, we may collect twice.
    #[must_use = "add to Bank::collected_rent"]
    pub fn collect_from_existing_account(
        &self,
        address: &Pubkey,
        account: &mut AccountSharedData,
    ) -> CollectedInfo {
        match self.calculate_rent_result(address, account) {
            RentResult::Exempt => {
                account.set_rent_epoch(RENT_EXEMPT_RENT_EPOCH);
                CollectedInfo::default()
            }
            RentResult::NoRentCollectionNow => CollectedInfo::default(),
            RentResult::CollectRent {
                new_rent_epoch,
                rent_due,
            } => match account.lamports().checked_sub(rent_due) {
                None | Some(0) => {
                    let account = std::mem::take(account);
                    CollectedInfo {
                        rent_amount: account.lamports(),
                        account_data_len_reclaimed: account.data().len() as u64,
                    }
                }
                Some(lamports) => {
                    account.set_lamports(lamports);
                    account.set_rent_epoch(new_rent_epoch);
                    CollectedInfo {
                        rent_amount: rent_due,
                        account_data_len_reclaimed: 0u64,
                    }
                }
            },
        }
    }

    /// determine what should happen to collect rent from this account
    #[must_use]
    fn calculate_rent_result(
        &self,
        address: &Pubkey,
        account: &impl ReadableAccount,
    ) -> RentResult {
        if account.rent_epoch() == RENT_EXEMPT_RENT_EPOCH || account.rent_epoch() > self.epoch {
            // potentially rent paying account (or known and already marked exempt)
            // Maybe collect rent later, leave account alone for now.
            return RentResult::NoRentCollectionNow;
        }
        if !self.should_collect_rent(address, account.executable()) {
            // easy to determine this account should not consider having rent collected from it
            return RentResult::Exempt;
        }
        match self.get_rent_due(
            account.lamports(),
            account.data().len(),
            account.rent_epoch(),
        ) {
            // account will not have rent collected ever
            RentDue::Exempt => RentResult::Exempt,
            // potentially rent paying account
            // Maybe collect rent later, leave account alone for now.
            RentDue::Paying(0) => RentResult::NoRentCollectionNow,
            // Rent is collected for next epoch.
            RentDue::Paying(rent_due) => RentResult::CollectRent {
                new_rent_epoch: self.epoch.saturating_add(1),
                rent_due,
            },
        }
    }
}

/// Information computed during rent collection
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
pub struct CollectedInfo {
    /// Amount of rent collected from account
    pub rent_amount: u64,
    /// Size of data reclaimed from account (happens when account's lamports go to zero)
    pub account_data_len_reclaimed: u64,
}

impl std::ops::Add for CollectedInfo {
    type Output = Self;
    fn add(self, other: Self) -> Self {
        Self {
            rent_amount: self.rent_amount.saturating_add(other.rent_amount),
            account_data_len_reclaimed: self
                .account_data_len_reclaimed
                .saturating_add(other.account_data_len_reclaimed),
        }
    }
}

impl std::ops::AddAssign for CollectedInfo {
    #![allow(clippy::arithmetic_side_effects)]
    fn add_assign(&mut self, other: Self) {
        *self = *self + other;
    }
}

#[cfg(test)]
mod tests {
    use {super::*, assert_matches::assert_matches, solana_account::Account, solana_sdk::sysvar};

    fn default_rent_collector_clone_with_epoch(epoch: Epoch) -> RentCollector {
        RentCollector::default().clone_with_epoch(epoch)
    }

    impl RentCollector {
        #[must_use = "add to Bank::collected_rent"]
        fn collect_from_created_account(
            &self,
            address: &Pubkey,
            account: &mut AccountSharedData,
        ) -> CollectedInfo {
            // initialize rent_epoch as created at this epoch
            account.set_rent_epoch(self.epoch);
            self.collect_from_existing_account(address, account)
        }
    }

    #[test]
    fn test_calculate_rent_result() {
        let mut rent_collector = RentCollector::default();

        let mut account = AccountSharedData::default();
        assert_matches!(
            rent_collector.calculate_rent_result(&Pubkey::default(), &account),
            RentResult::NoRentCollectionNow
        );
        {
            let mut account_clone = account.clone();
            assert_eq!(
                rent_collector
                    .collect_from_existing_account(&Pubkey::default(), &mut account_clone),
                CollectedInfo::default()
            );
            assert_eq!(account_clone, account);
        }

        account.set_executable(true);
        assert_matches!(
            rent_collector.calculate_rent_result(&Pubkey::default(), &account),
            RentResult::Exempt
        );
        {
            let mut account_clone = account.clone();
            let mut account_expected = account.clone();
            account_expected.set_rent_epoch(RENT_EXEMPT_RENT_EPOCH);
            assert_eq!(
                rent_collector
                    .collect_from_existing_account(&Pubkey::default(), &mut account_clone),
                CollectedInfo::default()
            );
            assert_eq!(account_clone, account_expected);
        }

        account.set_executable(false);
        assert_matches!(
            rent_collector.calculate_rent_result(&incinerator::id(), &account),
            RentResult::Exempt
        );
        {
            let mut account_clone = account.clone();
            let mut account_expected = account.clone();
            account_expected.set_rent_epoch(RENT_EXEMPT_RENT_EPOCH);
            assert_eq!(
                rent_collector
                    .collect_from_existing_account(&incinerator::id(), &mut account_clone),
                CollectedInfo::default()
            );
            assert_eq!(account_clone, account_expected);
        }

        // try a few combinations of rent collector rent epoch and collecting rent
        for (rent_epoch, rent_due_expected) in [(2, 2), (3, 5)] {
            rent_collector.epoch = rent_epoch;
            account.set_lamports(10);
            account.set_rent_epoch(1);
            let new_rent_epoch_expected = rent_collector.epoch + 1;
            assert!(
                matches!(
                    rent_collector.calculate_rent_result(&Pubkey::default(), &account),
                    RentResult::CollectRent{ new_rent_epoch, rent_due} if new_rent_epoch == new_rent_epoch_expected && rent_due == rent_due_expected,
                ),
                "{:?}",
                rent_collector.calculate_rent_result(&Pubkey::default(), &account)
            );

            {
                let mut account_clone = account.clone();
                assert_eq!(
                    rent_collector
                        .collect_from_existing_account(&Pubkey::default(), &mut account_clone),
                    CollectedInfo {
                        rent_amount: rent_due_expected,
                        account_data_len_reclaimed: 0
                    }
                );
                let mut account_expected = account.clone();
                account_expected.set_lamports(account.lamports() - rent_due_expected);
                account_expected.set_rent_epoch(new_rent_epoch_expected);
                assert_eq!(account_clone, account_expected);
            }
        }

        // enough lamports to make us exempt
        account.set_lamports(1_000_000);
        let result = rent_collector.calculate_rent_result(&Pubkey::default(), &account);
        assert!(matches!(result, RentResult::Exempt), "{result:?}",);
        {
            let mut account_clone = account.clone();
            let mut account_expected = account.clone();
            account_expected.set_rent_epoch(RENT_EXEMPT_RENT_EPOCH);
            assert_eq!(
                rent_collector
                    .collect_from_existing_account(&Pubkey::default(), &mut account_clone),
                CollectedInfo::default()
            );
            assert_eq!(account_clone, account_expected);
        }

        // enough lamports to make us exempt
        // but, our rent_epoch is set in the future, so we can't know if we are exempt yet or not.
        // We don't calculate rent amount vs data if the rent_epoch is already in the future.
        account.set_rent_epoch(1_000_000);
        assert_matches!(
            rent_collector.calculate_rent_result(&Pubkey::default(), &account),
            RentResult::NoRentCollectionNow
        );
        {
            let mut account_clone = account.clone();
            assert_eq!(
                rent_collector
                    .collect_from_existing_account(&Pubkey::default(), &mut account_clone),
                CollectedInfo::default()
            );
            assert_eq!(account_clone, account);
        }
    }

    #[test]
    fn test_collect_from_account_created_and_existing() {
        let old_lamports = 1000;
        let old_epoch = 1;
        let new_epoch = 2;

        let (mut created_account, mut existing_account) = {
            let account = AccountSharedData::from(Account {
                lamports: old_lamports,
                rent_epoch: old_epoch,
                ..Account::default()
            });

            (account.clone(), account)
        };

        let rent_collector = default_rent_collector_clone_with_epoch(new_epoch);

        // collect rent on a newly-created account
        let collected = rent_collector
            .collect_from_created_account(&solana_sdk::pubkey::new_rand(), &mut created_account);
        assert!(created_account.lamports() < old_lamports);
        assert_eq!(
            created_account.lamports() + collected.rent_amount,
            old_lamports
        );
        assert_ne!(created_account.rent_epoch(), old_epoch);
        assert_eq!(collected.account_data_len_reclaimed, 0);

        // collect rent on a already-existing account
        let collected = rent_collector
            .collect_from_existing_account(&solana_sdk::pubkey::new_rand(), &mut existing_account);
        assert!(existing_account.lamports() < old_lamports);
        assert_eq!(
            existing_account.lamports() + collected.rent_amount,
            old_lamports
        );
        assert_ne!(existing_account.rent_epoch(), old_epoch);
        assert_eq!(collected.account_data_len_reclaimed, 0);

        // newly created account should be collected for less rent; thus more remaining balance
        assert!(created_account.lamports() > existing_account.lamports());
        assert_eq!(created_account.rent_epoch(), existing_account.rent_epoch());
    }

    #[test]
    fn test_rent_exempt_temporal_escape() {
        for pass in 0..2 {
            let mut account = AccountSharedData::default();
            let epoch = 3;
            let huge_lamports = 123_456_789_012;
            let tiny_lamports = 789_012;
            let pubkey = solana_sdk::pubkey::new_rand();

            assert_eq!(account.rent_epoch(), 0);

            // create a tested rent collector
            let rent_collector = default_rent_collector_clone_with_epoch(epoch);

            if pass == 0 {
                account.set_lamports(huge_lamports);
                // first mark account as being collected while being rent-exempt
                let collected = rent_collector.collect_from_existing_account(&pubkey, &mut account);
                assert_eq!(account.lamports(), huge_lamports);
                assert_eq!(collected, CollectedInfo::default());
                continue;
            }

            // decrease the balance not to be rent-exempt
            // In a real validator, it is not legal to reduce an account's lamports such that the account becomes rent paying.
            // So, pass == 0 above tests the case of rent that is exempt. pass == 1 tests the case where we are rent paying.
            account.set_lamports(tiny_lamports);

            // ... and trigger another rent collection on the same epoch and check that rent is working
            let collected = rent_collector.collect_from_existing_account(&pubkey, &mut account);
            assert_eq!(account.lamports(), tiny_lamports - collected.rent_amount);
            assert_ne!(collected, CollectedInfo::default());
        }
    }

    #[test]
    fn test_rent_exempt_sysvar() {
        let tiny_lamports = 1;
        let mut account = AccountSharedData::default();
        account.set_owner(sysvar::id());
        account.set_lamports(tiny_lamports);

        let pubkey = solana_sdk::pubkey::new_rand();

        assert_eq!(account.rent_epoch(), 0);

        let epoch = 3;
        let rent_collector = default_rent_collector_clone_with_epoch(epoch);

        let collected = rent_collector.collect_from_existing_account(&pubkey, &mut account);
        assert_eq!(account.lamports(), 0);
        assert_eq!(collected.rent_amount, 1);
    }

    /// Ensure that when an account is "rent collected" away, its data len is returned.
    #[test]
    fn test_collect_cleans_up_account() {
        solana_logger::setup();
        let account_lamports = 1; // must be *below* rent amount
        let account_data_len = 567;
        let account_rent_epoch = 11;
        let mut account = AccountSharedData::from(Account {
            lamports: account_lamports, // <-- must be below rent-exempt amount
            data: vec![u8::default(); account_data_len],
            rent_epoch: account_rent_epoch,
            ..Account::default()
        });
        let rent_collector = default_rent_collector_clone_with_epoch(account_rent_epoch + 1);

        let collected =
            rent_collector.collect_from_existing_account(&Pubkey::new_unique(), &mut account);

        assert_eq!(collected.rent_amount, account_lamports);
        assert_eq!(
            collected.account_data_len_reclaimed,
            account_data_len as u64
        );
        assert_eq!(account, AccountSharedData::default());
    }
}