Enum VenuesCommands 

pub enum VenuesCommands {
    List(ListArgs),
    Schema(SchemaArgs),
    Update(UpdateArgs),
    Init(InitArgs),
    Validate(ValidateArgs),
}

Venue management subcommands.

List available exchange venues, view the YAML schema, initialise the user venues directory, or validate a custom descriptor file.

Examples

scope venues list
scope venues list --format json
scope venues schema
scope venues init
scope venues validate my-exchange.yaml

Variants

List(ListArgs)

List all available exchange venues and their capabilities.

Shows the catalog’s and your own CEX venues with their supported API capabilities (order_book, ticker, trades, ohlc), then the DEX venues.

Examples

scope venues list
scope venues list --format json

Schema(SchemaArgs)

Display the YAML schema for venue descriptors.

Prints the expected structure, field descriptions, and an annotated example you can copy to create your own venue descriptor.

Examples

scope venues schema
scope venues schema --format json

Update(UpdateArgs)

Fetch the venue catalog: new and fixed venues without a new scope.

Downloads the catalog index and every venue file, checks each against its SHA-256, and replaces ~/.scope-bca/venues/catalog/. Your own files in ~/.scope-bca/venues/ are not touched and still override a catalog venue with the same id.

Examples

scope venues update
scope venues update --url https://example.com/my-catalog

Init(InitArgs)

Copy the catalog’s venue files into your venues folder to customise.

Copies each catalog YAML file as it is to ~/.scope-bca/venues/, where your copy overrides the catalog’s. Fetches the catalog first if it is not there.

Examples

scope venues init
scope venues init --force

Validate(ValidateArgs)

Validate a venue descriptor YAML file.

Parses the file against the VenueDescriptor schema and reports any errors or warnings. Exits with code 0 on success, 1 on failure.

Examples

scope venues validate my-exchange.yaml
scope venues validate ~/.scope-bca/venues/custom.yaml

Trait Implementations

impl Debug for VenuesCommands

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

Formats the value using the given formatter.

impl FromArgMatches for VenuesCommands

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for VenuesCommands

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

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

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

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

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand