Struct Rent

#[repr(C)]
pub struct Rent {
    pub lamports_per_byte_year: u64,
    pub exemption_threshold: f64,
    pub burn_percent: u8,
}

Configuration of network rent.

Fields

lamports_per_byte_year: u64

Rental rate in lamports/byte-year.

exemption_threshold: f64

Amount of time (in years) a balance must include rent for the account to be rent exempt.

burn_percent: u8

The percentage of collected rent that is burned.

Valid values are in the range [0, 100]. The remaining percentage is distributed to validators.

Implementations

impl Rent

pub fn calculate_burn(&self, rent_collected: u64) -> (u64, u64)

Calculate how much rent to burn from the collected rent.

The first value returned is the amount burned. The second is the amount to distribute to validators.

pub fn minimum_balance(&self, data_len: usize) -> u64

Minimum balance due for rent-exemption of a given account data size.

pub fn is_exempt(&self, balance: u64, data_len: usize) -> bool

Whether a given balance and data length would be exempt.

pub fn due(&self, balance: u64, data_len: usize, years_elapsed: f64) -> RentDue

Rent due on account’s data length with balance.

pub fn due_amount(&self, data_len: usize, years_elapsed: f64) -> u64

Rent due for account that is known to be not exempt.

pub fn free() -> Self

Creates a Rent that charges no lamports.

This is used for testing.

pub fn with_slots_per_epoch(slots_per_epoch: u64) -> Self

Creates a Rent that is scaled based on the number of slots in an epoch.

This is used for testing.

Trait Implementations

impl Clone for Rent

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Rent

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Rent

fn eq(&self, other: &Rent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Rent