Struct FaucetConfig

pub struct FaucetConfig {

    pub port: u16,
    pub host_ip: Ipv4Addr,
    pub amount: u64,
    pub num_coins: usize,
    pub request_buffer_size: usize,
    pub max_request_per_second: u64,
    pub wallet_client_timeout_secs: u64,
    pub write_ahead_log: PathBuf,
    pub wal_retry_interval: u64,
    pub max_request_queue_length: u64,
    pub batch_request_size: u64,
    pub ttl_expiration: u64,
    pub batch_enabled: bool,
    pub authenticated: bool,
    pub max_requests_per_ip: u64,
    pub replenish_quota_interval_ms: u64,
    pub reset_time_interval_secs: u64,
    pub rate_limiter_cleanup_interval_secs: u64,
}

Fields

port: u16

host_ip: Ipv4Addr

amount: u64

num_coins: usize

request_buffer_size: usize

max_request_per_second: u64

wallet_client_timeout_secs: u64

write_ahead_log: PathBuf

wal_retry_interval: u64

max_request_queue_length: u64

batch_request_size: u64

ttl_expiration: u64

batch_enabled: bool

authenticated: bool

Testnet faucet requires authentication via the Web UI at https://faucet.sui.io This flag is used to indicate that authentication mode is enabled.

max_requests_per_ip: u64

Maximum number of requests per IP address. This is used for the authenticated mode.

replenish_quota_interval_ms: u64

This is the amount of time to wait before adding one more quota to the rate limiter. Basically, it ensures that we’re not allowing too many requests all at once. This is very specific to governor and tower-governor crates. This is used primarily for authenticated mode. A small value will allow more requests to be processed in a short period of time.

reset_time_interval_secs: u64

The amount of seconds to wait before resetting the request count for the IP addresses recorded by the rate limit layer. Default is 12 hours. This is used for authenticated mode.

rate_limiter_cleanup_interval_secs: u64

Interval time to run the task to clear the banned IP addresses by the rate limiter. This is used for authenticated mode.

Trait Implementations

impl Args for FaucetConfig

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.

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

Append to [Command] so it can update self.

impl Clone for FaucetConfig

fn clone(&self) -> FaucetConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for FaucetConfig

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 Default for FaucetConfig

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for FaucetConfig

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 FaucetConfig

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.