Struct TransferFee

#[repr(C)]
pub struct TransferFee {
    pub epoch: PodU64,
    pub maximum_fee: PodU64,
    pub transfer_fee_basis_points: PodU16,
}

Transfer fee information

Fields

epoch: PodU64

First epoch where the transfer fee takes effect

maximum_fee: PodU64

Maximum fee assessed on transfers, expressed as an amount of tokens

transfer_fee_basis_points: PodU16

Amount of transfer collected as fees, expressed as basis points of the transfer amount, ie. increments of 0.01%

Implementations

impl TransferFee

pub fn calculate_fee(&self, pre_fee_amount: u64) -> Option<u64>

Calculate the transfer fee

pub fn calculate_post_fee_amount(&self, pre_fee_amount: u64) -> Option<u64>

Calculate the gross transfer amount after deducting fees

pub fn calculate_pre_fee_amount(&self, post_fee_amount: u64) -> Option<u64>

Calculate the transfer amount that will result in a specified net transfer amount.

The original transfer amount may not always be unique due to rounding. In this case, the smaller amount will be chosen. e.g. Both transfer amount 10, 11 with 10% fee rate results in net transfer amount of 9. In this case, 10 will be chosen. e.g. Fee rate is 100%. In this case, 0 will be chosen.

The original transfer amount may not always exist on large net transfer amounts due to overflow. In this case, None is returned. e.g. The net fee amount is u64::MAX with a positive fee rate.

pub fn calculate_inverse_fee(&self, post_fee_amount: u64) -> Option<u64>

Calculate the fee that would produce the given output

Note: this function is not an exact inverse operation of calculate_fee. Meaning, it is not the case that:

calculate_fee(x) == calculate_inverse_fee(x - calculate_fee(x))

Only the following relationship holds:

calculate_fee(x) >= calculate_inverse_fee(x - calculate_fee(x))

Trait Implementations

impl Clone for TransferFee

fn clone(&self) -> TransferFee

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferFee

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

Formats the value using the given formatter.

impl Default for TransferFee

fn default() -> TransferFee

Returns the “default value” for a type.

impl PartialEq for TransferFee

fn eq(&self, other: &TransferFee) -> 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 Zeroable for TransferFee

fn zeroed() -> Self

Calls zeroed.

impl Copy for TransferFee

impl Pod for TransferFee

impl StructuralPartialEq for TransferFee