Enum SpotFeeAsset 

#[non_exhaustive]
pub enum SpotFeeAsset {
    Quote,
    Received,
}

Which asset the simulated venue charges a spot fill’s fee in.

The amount always comes from the venue’s FeeModelConfig, which prices a fee in quote. This rule says only which balance it is taken from, so it changes no cost, only which asset pays it:

Rule	Buy	Sell
Quote	quote, on top of the notional	quote, out of the proceeds
Received	base, out of the quantity received	quote, out of the proceeds

A fee in base is the quote fee divided by the fill price, to Decimal’s 28 digits. The fill reports it in base, with that quote fee as its AssetFees::fees_quote.

Venues differ, and so do accounts on one venue. Quote matches Coinbase spot’s default. Received matches Binance spot’s default, with BNB fee payment turned off. Pick the rule of the account a backtest stands in for. A CFD fill is cash-settled, so its fee is always in quote, whatever this says.

A buy’s fee in base

Under Received, a buy receives its quantity less the fee, and the engine nets a base fee from a spot position (see rustrade’s InstrumentState::update_from_trade), so the two stay equal. The holding is then not a round number: a buy of 1 with a 0.1 % fee holds 0.999. A live venue sells only whole multiples of its lot step, so when the instrument’s spec gives a quantity step, the engine rounds the position toward zero to it and leaves the remainder in the balance, where only the venue’s own dust conversion can clear it. This venue has no lot step: it fills whatever quantity it is sent, so a close of the rounded position leaves the same remainder here as live.

A flat fee on a tiny buy can exceed the quantity it receives. The excess is then taken from the base balance, and the order is refused if that cannot cover it, as a sell whose fee exceeds its proceeds takes the excess from quote. A fill at a price that is not positive cannot be converted, so it is charged in quote under either rule.

A fee charged in a third asset, such as BNB, is set apart from this rule, by FeeAssetConfig. Where it does not apply, this rule does.

#[non_exhaustive]: further rules may be added.

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.

Quote

The fee is in quote on both sides: on top of what a buy pays, and out of what a sell receives. Venue-neutral, and the base a fill moves is exactly its quantity.

Received

The fee is in the asset the fill receives: base out of a buy’s quantity, quote out of a sell’s proceeds.

Trait Implementations

impl Clone for SpotFeeAsset

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SpotFeeAsset

impl Debug for SpotFeeAsset

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

Formats the value using the given formatter.

impl Default for SpotFeeAsset

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpotFeeAsset

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SpotFeeAsset

impl Hash for SpotFeeAsset

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 SpotFeeAsset

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 SpotFeeAsset

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SpotFeeAsset

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 SpotFeeAsset

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 SpotFeeAsset