Struct FeeAssetConfig 

pub struct FeeAssetConfig(/* private fields */);

A third asset the simulated venue charges spot fees in, at a discount, while the account holds enough of it: Binance’s “pay fees with BNB”.

What a fill pays

The fee is the FeeModelConfig’s fee in quote, less discount, converted to the fee asset at the venue’s price for it: the mid, else the last price, of a spot instrument on the venue pairing the fee asset with the fill’s quote asset, in either direction (BNB/USDT, or the reciprocal of USDT/BNB). Of several, the one first by name. It is taken from the fee asset’s free balance when the fill settles, apart from what the fill exchanges, and the fill reports it in the fee asset, as a live venue does. Nothing is reserved for it while an order rests, since a venue does not hold the fee asset for open orders.

The fee is not rounded to the fee asset’s precision, which this venue does not know, so it can differ from a live venue’s in its last decimals.

When it falls back

The fill is charged as without this setting, the undiscounted fee under the venue’s SpotFeeAsset rule, when any of these holds:

• the fee asset’s free balance is short of the fee: the whole fee falls back, none of it is split. A margin account does not lend the fee asset for a fee.
• the venue holds no positive price for the fee asset in the fill’s quote. A venue with no market feed holds none.
• the instrument is the fee asset’s own, its base or its quote (BNB/USDT, ETH/BNB). A live venue discounts those too; this one does not.
• the fill is cash-settled (a CFD), or its fee is zero or negative.

A fill’s fee asset says which happened. With an engine that prices the fee asset, PnL counts a fee charged in it; otherwise a backtest leaves it out, as a live run does.

new refuses a discount outside zero to one, and so does deserialising one. Serialised, the discount is a decimal string ("0.25").

Implementations

impl FeeAssetConfig

pub fn new( asset: AssetNameExchange, discount: Decimal, ) -> Result<Self, FeeAssetConfigError>

Fees charged in asset, at discount off the fee model’s fee: 0.25 for a quarter off.

Errors

Returns FeeAssetConfigError if discount is below zero or above one.

pub fn asset(&self) -> &AssetNameExchange

The asset fees are charged in.

pub fn discount(&self) -> Decimal

The fraction taken off the fee model’s fee: zero for none, one for no fee at all.

Trait Implementations

impl Clone for FeeAssetConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeeAssetConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FeeAssetConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FeeAssetConfig

impl Hash for FeeAssetConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FeeAssetConfig

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FeeAssetConfig

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FeeAssetConfig

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FeeAssetConfig

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 FeeAssetConfig