Struct lfest::prelude::Config

pub struct Config<M>
where
    M: Currency,
{ /* private fields */ }

Define the Exchange configuration

Implementations

impl<M> Config<M>

where M: Currency,

pub fn contract_specification( &self ) -> &ContractSpecification<M::PairedCurrency>

The contract specification.

impl<M> Config<M>

where M: Currency,

pub fn starting_balance(&self) -> M

The starting balance of account (denoted in margin currency). The concrete Currency here defines the futures type. If QuoteCurrency is used as the margin currency, then its a linear futures contract. If BaseCurrency is used as the margin currency, then its an inverse futures contract.

pub fn max_num_open_orders(&self) -> usize

The maximum number of open orders the user can have at any given time

pub fn initial_leverage(&self) -> Leverage

The leverage initially set by the user.

impl<M> Config<M>

where M: Currency,

pub fn new( starting_balance: M, max_num_open_orders: usize, initial_leverage: Leverage, contract_specification: ContractSpecification<M::PairedCurrency> ) -> Result<Self>

Create a new Config.

Arguments:

fee_maker: The maker fee as fraction, e.g 6bp -> 0.0006 fee_taker: The taker fee as fraction starting_balance: Initial Wallet Balance, denoted in QUOTE if using linear futures, denoted in BASE for inverse futures max_num_open_orders: The maximum number of open ordes a user can have at any time. initial_leverage: The initial desired leverage of positions. contract_specification: More details on the actual contract traded.

Returns:

Either a valid Config or an Error

Trait Implementations

impl<M> Clone for Config<M>

where M: Currency + Clone, M::PairedCurrency: Clone,

fn clone(&self) -> Config<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Config<M>

where M: Currency + Debug, M::PairedCurrency: Debug,

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

Formats the value using the given formatter.