Enum HDPCliCommands

pub enum HDPCliCommands {
    Start,
    RunDatalake {
        aggregate_fn_id: AggregationFunction,
        aggregate_fn_ctx: Option<FunctionContext>,
        datalake: DataLakeCommands,
        rpc_url: Option<Url>,
        chain_id: Option<ChainId>,
        preprocessor_output_file: Option<PathBuf>,
        sound_run_cairo_file: Option<PathBuf>,
        output_file: Option<PathBuf>,
        cairo_pie_file: Option<PathBuf>,
    },
    RunModule {
        module_inputs: Vec<String>,
        program_hash: Option<String>,
        local_class_path: Option<PathBuf>,
        save_fetch_keys_file: Option<PathBuf>,
        rpc_url: Option<Url>,
        chain_id: Option<ChainId>,
        dry_run_cairo_file: Option<PathBuf>,
        preprocessor_output_file: Option<PathBuf>,
        sound_run_cairo_file: Option<PathBuf>,
        output_file: Option<PathBuf>,
        cairo_pie_file: Option<PathBuf>,
    },
    Run {
        request_file: PathBuf,
        rpc_url: Option<Url>,
        dry_run_cairo_file: Option<PathBuf>,
        preprocessor_output_file: PathBuf,
        sound_run_cairo_file: Option<PathBuf>,
        output_file: Option<PathBuf>,
        cairo_pie_file: Option<PathBuf>,
    },
}

Variants

Start

New to the HDP CLI? Start here!

RunDatalake

Run single datalake compute

Fields

aggregate_fn_id: AggregationFunction

The aggregate function id e.g. “sum”, “min”, “avg”

aggregate_fn_ctx: Option<FunctionContext>

Optional context for applying conditions on the aggregate function “count”. Format: “{operator}.{value}” (e.g., “eq.100” for equality, “gt.100” for greater-than). Supported operators are in the [Operator] enum.

datalake: DataLakeCommands

rpc_url: Option<Url>

The RPC URL to fetch the datalake

chain_id: Option<ChainId>

The chain id to fetch the datalake

preprocessor_output_file: Option<PathBuf>

Path to save output file after pre-processing.

This will trigger pre-processing step

sound_run_cairo_file: Option<PathBuf>

hdp cairo compiled program. main entry point

output_file: Option<PathBuf>

Path to save output file after process

This will trigger processing(=pie generation) step

cairo_pie_file: Option<PathBuf>

Path to save pie file

This will trigger processing(=pie generation) step

RunModule

Run single module with either class hash deployed on starknet or local class path

Fields

module_inputs: Vec<String>

Input field elements for the module contract. The input field elements should be separated by comma.

e.g. “0x1234,0xabcd”

program_hash: Option<String>

local_class_path: Option<PathBuf>

Local path of the contract class file. Make sure to have structure match with CasmContractClass

(Note: either class_hash or local_class_path should be provided)

save_fetch_keys_file: Option<PathBuf>

optionally can save keys for module task to file

rpc_url: Option<Url>

The RPC URL to fetch the data.

Can be overwritten by RPC_URL environment variable.

chain_id: Option<ChainId>

The chain id to fetch the data.

Can be overwritten by CHAIN_ID environment variable

dry_run_cairo_file: Option<PathBuf>

dry run contract bootloader program. only used for module task

preprocessor_output_file: Option<PathBuf>

Path to save output file after pre-processing.

This will trigger pre-processing step

sound_run_cairo_file: Option<PathBuf>

hdp cairo compiled program. main entry point

output_file: Option<PathBuf>

Path to save output file after process

This will trigger processing(=pie generation) step

cairo_pie_file: Option<PathBuf>

Path to save pie file

This will trigger processing(=pie generation) step

Run

Run batch of tasks base on request json file

Fields

request_file: PathBuf

Pass request as json file

rpc_url: Option<Url>

The RPC URL to fetch the data.

Can be overwritten by RPC_URL environment variable.

dry_run_cairo_file: Option<PathBuf>

dry run contract bootloader program. only used for module task

preprocessor_output_file: PathBuf

Path to save output file after pre-processing.

sound_run_cairo_file: Option<PathBuf>

hdp cairo compiled program. main entry point

output_file: Option<PathBuf>

Path to save output file after process

This will trigger processing(=pie generation) step

cairo_pie_file: Option<PathBuf>

Path to save pie file

This will trigger processing(=pie generation) step

Trait Implementations

impl Debug for HDPCliCommands

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

Formats the value using the given formatter.

impl FromArgMatches for HDPCliCommands

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 HDPCliCommands

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand