Struct linera_client::client_options::ClientOptions

pub struct ClientOptions {

    pub wallet_state_path: Option<PathBuf>,
    pub storage_config: Option<String>,
    pub with_wallet: Option<String>,
    pub send_timeout: Duration,
    pub recv_timeout: Duration,
    pub max_pending_message_bundles: usize,
    pub wasm_runtime: Option<WasmRuntime>,
    pub max_loaded_chains: NonZeroUsize,
    pub max_concurrent_queries: Option<usize>,
    pub max_stream_queries: usize,
    pub cache_size: usize,
    pub command: ClientCommand,
    pub retry_delay: Duration,
    pub max_retries: u32,
    pub wait_for_outgoing_messages: bool,
    pub long_lived_services: bool,
    pub tokio_threads: Option<usize>,
    pub blanket_message_policy: BlanketMessagePolicy,
    pub restrict_chain_ids_to: Option<HashSet<ChainId>>,
    pub grace_period: f64,
    pub blob_download_timeout: Duration,
}

Fields

wallet_state_path: Option<PathBuf>

Sets the file storing the private state of user chains (an empty one will be created if missing)

storage_config: Option<String>

Storage configuration for the blockchain history.

with_wallet: Option<String>

Given an ASCII alphanumeric parameter X, read the wallet state and the wallet storage config from the environment variables LINERA_WALLET_{X} and LINERA_STORAGE_{X} instead of LINERA_WALLET and LINERA_STORAGE.

send_timeout: Duration

Timeout for sending queries (milliseconds)

recv_timeout: Duration

Timeout for receiving responses (milliseconds)

max_pending_message_bundles: usize

The maximum number of incoming message bundles to include in a block proposal.

wasm_runtime: Option<WasmRuntime>

The WebAssembly runtime to use.

max_loaded_chains: NonZeroUsize

The maximal number of chains loaded in memory at a given time.

max_concurrent_queries: Option<usize>

The maximal number of simultaneous queries to the database

max_stream_queries: usize

The maximal number of simultaneous stream queries to the database

cache_size: usize

The maximal number of entries in the storage cache.

command: ClientCommand

Subcommand.

retry_delay: Duration

Delay increment for retrying to connect to a validator.

max_retries: u32

Number of times to retry connecting to a validator.

wait_for_outgoing_messages: bool

Whether to wait until a quorum of validators has confirmed that all sent cross-chain messages have been delivered.

long_lived_services: bool

(EXPERIMENTAL) Whether application services can persist in some cases between queries.

tokio_threads: Option<usize>

The number of Tokio worker threads to use.

blanket_message_policy: BlanketMessagePolicy

The policy for handling incoming messages.

restrict_chain_ids_to: Option<HashSet<ChainId>>

A set of chains to restrict incoming messages from. By default, messages from all chains are accepted. To reject messages from all chains, specify an empty string.

grace_period: f64

An additional delay, after reaching a quorum, to wait for additional validator signatures, as a fraction of time taken to reach quorum.

blob_download_timeout: Duration

The delay when downloading a blob, after which we try a second validator, in milliseconds.

Implementations

impl ClientOptions

pub fn init() -> Result<Self, Error>

pub async fn run_with_storage<R: Runnable>( &self, job: R, ) -> Result<R::Output, Error>

pub fn storage_config(&self) -> Result<StorageConfigNamespace, Error>

pub async fn initialize_storage(&self) -> Result<(), Error>

impl ClientOptions

pub async fn wallet(&self) -> Result<WalletState<File<Wallet>>, Error>

pub fn create_wallet( &self, genesis_config: GenesisConfig, testing_prng_seed: Option<u64>, ) -> Result<WalletState<File<Wallet>>, Error>

Trait Implementations

impl Args for ClientOptions

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 Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ClientOptions

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 FromArgMatches for ClientOptions

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 ClientOptions

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.