Struct HopParams 

pub struct HopParams {
    pub enabled: bool,
    pub max_pool_size: u64,
    pub max_user_size: u64,
    pub retention_secs: u64,
    pub check_interval: u64,
    pub promotion_buffer_secs: u64,
    pub submit_rate_per_min: u32,
    pub submit_burst: u32,
    pub bandwidth_per_min_mib: u64,
    pub bandwidth_burst_mib: u64,
    pub disable_rate_limit: bool,
    pub data_dir: Option<PathBuf>,
}

HOP (Hand-Off Protocol) configuration parameters

Fields

enabled: bool

Enable HOP

max_pool_size: u64

HOP maximum data pool size in MiB. Must be at least 1.

max_user_size: u64

HOP maximum per-user pool size in MiB (hard cap, not scaled by active users). Must be at least 1.

retention_secs: u64

HOP data retention period in seconds (24h = 86400s). Must be at least 1.

check_interval: u64

HOP expiry cleanup interval in seconds. Must be at least 1 (a value of 0 would turn the maintenance loop into a CPU-burning busy loop).

promotion_buffer_secs: u64

Seconds before expiry at which to start promoting entries on-chain. Must be at least 1.

submit_rate_per_min: u32

Sustained per-account submit rate (requests per minute). Must be at least 1 when rate limiting is enabled — use --hop-disable-rate-limit to turn it off.

submit_burst: u32

Per-account submit burst size (requests). Must be at least 1.

bandwidth_per_min_mib: u64

Sustained per-account bandwidth (MiB per minute). Must be at least 1 when rate limiting is enabled — use --hop-disable-rate-limit to turn it off.

bandwidth_burst_mib: u64

Per-account bandwidth burst size (MiB). Must be at least 1.

disable_rate_limit: bool

Disable per-account submit rate limiting (intended for tests and dev nodes).

data_dir: Option<PathBuf>

Directory for HOP persistent data storage.

If not specified, defaults to <chain-data-dir>/hop.

Implementations

impl HopParams

pub fn rate_limit_config(&self) -> RateLimitConfig

Derive a RateLimitConfig from these CLI parameters.

pub fn build_pool( &self, database_path: Option<PathBuf>, ) -> Result<Arc<HopDataPool>, HopError>

Build a HOP data pool from these CLI parameters, resolving the data directory.

The resolved data directory is Self::data_dir if set, otherwise <database_path>/hop; if neither is available, returns HopError::MissingDataDir. Callers gate on whether HOP is enabled (e.g. via --enable-hop) before calling this.

Trait Implementations

impl Args for HopParams

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::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 Clone for HopParams

fn clone(&self) -> HopParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for HopParams

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for HopParams

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

Formats the value using the given formatter.

impl Default for HopParams

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for HopParams

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.

impl Parser for HopParams

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.