Struct SummaryArgs 

pub struct SummaryArgs {

    pub pair: String,
    pub venue: String,
    pub chain: String,
    pub peg: f64,
    pub min_levels: usize,
    pub min_depth: f64,
    pub peg_range: f64,
    pub min_bid_ask_ratio: f64,
    pub max_bid_ask_ratio: f64,
    pub format: SummaryFormat,
    pub every: Option<String>,
    pub duration: Option<String>,
    pub report: Option<PathBuf>,
    pub csv: Option<PathBuf>,
}

Arguments for scope market summary.

Default thresholds (min_levels, min_depth, peg_range) originated from the PUSD Hummingbot market-making config and are tunable for other markets.

Fields

pair: String

Base token symbol (e.g., USDC, PUSD). Quote is USDT.

venue: String

Market venue (e.g., binance, biconomy, mexc, okx, eth, solana). Use scope venues list to see all available venues.

chain: String

Chain for DEX venues (ethereum or solana). Ignored for CEX.

peg: f64

Peg target (e.g., 1.0 for USD stablecoins).

min_levels: usize

Minimum order book levels per side (default from PUSD Hummingbot config).

min_depth: f64

Minimum depth per side in quote terms, e.g. USDT (default from PUSD Hummingbot config).

peg_range: f64

Peg range for outlier filtering (orders outside peg ± range×5 excluded). E.g., 0.001 = ±0.5% around peg.

min_bid_ask_ratio: f64

Min bid/ask depth ratio (warn if ratio below this).

max_bid_ask_ratio: f64

Max bid/ask depth ratio (warn if ratio above this).

format: SummaryFormat

Output format.

every: Option<String>

Run repeatedly at this interval (e.g., 30s, 5m, 1h). Default when in repeat mode: 60s.

duration: Option<String>

Run for this total duration (e.g., 10m, 1h, 24h). Default when in repeat mode: 1h.

report: Option<PathBuf>

Save markdown report to file (one-shot mode) or final report (repeat mode).

csv: Option<PathBuf>

Append time-series CSV of peg/spread/depth to this path (repeat mode only).

Trait Implementations

impl Args for SummaryArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for SummaryArgs

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

Formats the value using the given formatter.

impl FromArgMatches for SummaryArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.