Struct safe_token_2022::extension::interest_bearing_mint::InterestBearingConfig

#[repr(C)]
pub struct InterestBearingConfig {
    pub rate_authority: OptionalNonZeroPubkey,
    pub initialization_timestamp: UnixTimestamp,
    pub pre_update_average_rate: BasisPoints,
    pub last_update_timestamp: UnixTimestamp,
    pub current_rate: BasisPoints,
}

Interest-bearing extension data for mints

Tokens accrue interest at an annual rate expressed by current_rate, compounded continuously, so APY will be higher than the published interest rate.

To support changing the rate, the config also maintains state for the previous rate.

Fields

rate_authority: OptionalNonZeroPubkey

Authority that can set the interest rate and authority

initialization_timestamp: UnixTimestamp

Timestamp of initialization, from which to base interest calculations

pre_update_average_rate: BasisPoints

Average rate from initialization until the last time it was updated

last_update_timestamp: UnixTimestamp

Timestamp of the last update, used to calculate the total amount accrued

current_rate: BasisPoints

Current rate, since the last update

Implementations

impl InterestBearingConfig

pub fn amount_to_ui_amount(
    &self,
    amount: u64,
    decimals: u8,
    unix_timestamp: i64
) -> Option<String>

Convert a raw amount to its UI representation using the given decimals field Excess zeroes or unneeded decimal point are trimmed.

pub fn try_ui_amount_into_amount(
    &self,
    ui_amount: &str,
    decimals: u8,
    unix_timestamp: i64
) -> Result<u64, ProgramError>

Try to convert a UI represenation of a token amount to its raw amount using the given decimals field

pub fn time_weighted_average_rate(&self, current_timestamp: i64) -> Option<i16>

The new average rate is the time-weighted average of the current rate and average rate, solving for r such that:

exp(r_1 * t_1) * exp(r_2 * t_2) = exp(r * (t_1 + t_2))

r_1 * t_1 + r_2 * t_2 = r * (t_1 + t_2)

r = (r_1 * t_1 + r_2 * t_2) / (t_1 + t_2)

Trait Implementations

impl Clone for InterestBearingConfig

fn clone(&self) -> InterestBearingConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InterestBearingConfig

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

Formats the value using the given formatter.

impl Default for InterestBearingConfig

fn default() -> InterestBearingConfig

Returns the “default value” for a type.

impl Extension for InterestBearingConfig

const TYPE: ExtensionType = ExtensionType::InterestBearingConfig

Associated extension type enum, checked at the start of TLV entries

impl PartialEq<InterestBearingConfig> for InterestBearingConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Zeroable for InterestBearingConfig

fn zeroed() -> Self

Calls zeroed.

impl Copy for InterestBearingConfig

impl Pod for InterestBearingConfig

impl StructuralPartialEq for InterestBearingConfig