Enum PartnerFeePolicy 

#[non_exhaustive]
pub enum PartnerFeePolicy {
    Volume {
        volume_bps: u16,
        recipient: Address,
    },
    Surplus {
        surplus_bps: u16,
        max_volume_bps: u16,
        recipient: Address,
    },
    PriceImprovement {
        price_improvement_bps: u16,
        max_volume_bps: u16,
        recipient: Address,
    },
}

One typed partner-fee policy object.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Volume

Fee paid from traded volume.

Fields

volume_bps: u16

Fee paid in basis points of volume.

recipient: Address

Recipient of the partner fee.

Surplus

Fee paid from surplus, capped by volume.

Fields

surplus_bps: u16

Fee paid in basis points of surplus.

max_volume_bps: u16

Maximum fee paid in basis points of volume.

recipient: Address

Recipient of the partner fee.

PriceImprovement

Fee paid from price improvement, capped by volume.

Fields

price_improvement_bps: u16

Fee paid in basis points of price improvement.

max_volume_bps: u16

Maximum fee paid in basis points of volume.

recipient: Address

Recipient of the partner fee.

Implementations

impl PartnerFeePolicy

pub fn volume(volume_bps: u16, recipient: Address) -> Result<Self, AppDataError>

Creates a volume-based partner-fee policy after validating the supplied basis-point value and recipient against the published partner-fee bounds.

Errors

Returns AppDataError::InvalidPartnerFee when volume_bps falls outside the documented [1..=9999] range, or when recipient is the zero address.

pub fn surplus( surplus_bps: u16, max_volume_bps: u16, recipient: Address, ) -> Result<Self, AppDataError>

Creates a surplus-based partner-fee policy after validating the supplied basis-point values and recipient against the published partner-fee bounds.

Errors

Returns AppDataError::InvalidPartnerFee when surplus_bps falls outside [1..=9999], when max_volume_bps falls outside [1..=9999], or when recipient is the zero address.

pub fn price_improvement( price_improvement_bps: u16, max_volume_bps: u16, recipient: Address, ) -> Result<Self, AppDataError>

Creates a price-improvement-based partner-fee policy after validating the supplied basis-point values and recipient against the published partner-fee bounds.

Errors

Returns AppDataError::InvalidPartnerFee when price_improvement_bps falls outside [1..=9999], when max_volume_bps falls outside [1..=9999], or when recipient is the zero address.

pub const fn volume_bps(&self) -> Option<u16>

Returns the volume-basis-point fee when this policy uses the volume shape.

pub fn validate(&self) -> Result<(), AppDataError>

Validates this policy against the published partner-fee schema bounds.

The bounds the reviewed schema applies:

• volumeBps — integer in [1..=9999]
• surplusBps — integer in [1..=9999]
• priceImprovementBps — integer in [1..=9999]
• maxVolumeBps — integer in [1..=9999]
• recipient — non-zero 20-byte address

Errors

Returns AppDataError::InvalidPartnerFee on the first field that falls outside the documented bounds, or when recipient is the zero address.

Trait Implementations

impl Clone for PartnerFeePolicy

fn clone(&self) -> PartnerFeePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartnerFeePolicy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PartnerFeePolicy

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PartnerFeePolicy

impl From<PartnerFeePolicy> for PartnerFee

fn from(value: PartnerFeePolicy) -> Self

Converts to this type from the input type.

impl PartialEq for PartnerFeePolicy

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

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 PartnerFeePolicy