Struct PoolFee

pub struct PoolFee {
    pub protocol_fee: Fee,
    pub swap_fee: Fee,
    pub burn_fee: Fee,
    pub extra_fees: Vec<Fee>,
}

Represents the fee structure for transactions within a pool.

Fields

• protocol_fee: The fee percentage charged by the protocol on each transaction to support operational and developmental needs.
• swap_fee: The fee percentage allocated to liquidity providers as a reward for supplying liquidity to the pool, incentivizing participation and ensuring pool health.
• burn_fee: A fee percentage that is burned on each transaction, helping manage the token economy by reducing supply over time, potentially increasing token value.
• extra_fees: A vector of custom fees allowing for extensible and adaptable fee structures to meet diverse and evolving needs. Validation ensures that the total of all fees does not exceed 100%, maintaining fairness and avoiding overcharging.

Fields

protocol_fee: Fee

Fee percentage charged on each transaction for the protocol’s benefit.

swap_fee: Fee

Fee percentage allocated to liquidity providers on each swap.

burn_fee: Fee

Fee percentage that is burned on each transaction. Burning a portion of the transaction fee helps in reducing the overall token supply.

extra_fees: Vec<Fee>

A list of custom, additional fees that can be defined for specific use cases or additional functionalities. This vector enables the flexibility to introduce new fees without altering the core fee structure. Total of all fees, including custom ones, is validated to not exceed 100%, ensuring a balanced and fair fee distribution.

Implementations

impl PoolFee

pub fn is_valid(&self) -> StdResult<()>

Validates the PoolFee structure to ensure the sum of all fees does not exceed 20%.

pub fn compute_and_apply_fees(&self, amount: Uint256) -> StdResult<Uint128>

Computes and applies all defined fees to a given amount. Returns the total amount of fees deducted.

Trait Implementations

impl Clone for PoolFee

fn clone(&self) -> PoolFee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolFee

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PoolFee

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PoolFee

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for PoolFee

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

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

const 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 Serialize for PoolFee

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PoolFee