Struct Options 

pub struct Options {

    pub send_timeout: Duration,
    pub recv_timeout: Duration,
    pub max_pending_message_bundles: usize,
    pub max_block_limit_errors: u32,
    pub max_new_events_per_block: usize,
    pub staging_bundles_time_budget: Option<Duration>,
    pub prioritize_bundles_from: Option<HashSet<ChainId>>,
    pub ignore_bundles_from: Option<HashSet<ChainId>>,
    pub chain_worker_ttl: Duration,
    pub sender_chain_worker_ttl: Duration,
    pub cross_chain_batch_size_limit: usize,
    pub retry_delay: Duration,
    pub max_retries: u32,
    pub max_backoff: Duration,
    pub notification_circuit_breaker_initial_probe_interval: Duration,
    pub notification_circuit_breaker_max_probe_interval: Duration,
    pub wait_for_outgoing_messages: bool,
    pub allow_fast_blocks: bool,
    pub long_lived_services: bool,
    pub blanket_message_policy: BlanketMessagePolicy,
    pub restrict_chain_ids_to: Option<HashSet<ChainId>>,
    pub reject_message_bundles_without_application_ids: Option<HashSet<GenericApplicationId>>,
    pub reject_message_bundles_with_other_application_ids: Option<HashSet<GenericApplicationId>>,
    pub process_events_from_application_ids: Option<HashSet<GenericApplicationId>>,
    pub never_reject_application_ids: Option<HashSet<GenericApplicationId>>,
    pub timings: bool,
    pub timing_interval: u64,
    pub quorum_grace_period: f64,
    pub blob_download_hedge_delay: Duration,
    pub certificate_batch_download_hedge_delay: Duration,
    pub certificate_download_batch_size: u64,
    pub certificate_upload_batch_size: u64,
    pub sender_certificate_download_batch_size: usize,
    pub max_concurrent_batch_downloads: usize,
    pub max_joined_tasks: usize,
    pub max_event_stream_queries: usize,
    pub max_accepted_latency_ms: f64,
    pub cache_ttl_ms: u64,
    pub cache_max_size: usize,
    pub max_request_ttl_ms: u64,
    pub alpha: f64,
    pub alternative_peers_retry_delay_ms: u64,
    pub chain_listener_config: ChainListenerConfig,
}

Command-line options controlling the behavior of the chain client.

Fields

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.

max_block_limit_errors: u32

Maximum number of message bundles to discard from a block proposal due to block limit errors before discarding all remaining bundles.

Discarded bundles can be retried in the next block.

max_new_events_per_block: usize

The maximum number of new stream events to include in a block proposal.

staging_bundles_time_budget: Option<Duration>

Time budget for staging message bundles in milliseconds. When set, limits bundle execution by wall-clock time, in addition to the count limit from max_pending_message_bundles.

prioritize_bundles_from: Option<HashSet<ChainId>>

Comma-separated list of chain IDs whose incoming bundles should be processed first.

ignore_bundles_from: Option<HashSet<ChainId>>

Comma-separated list of chain IDs whose incoming bundles should be ignored.

chain_worker_ttl: Duration

The duration in milliseconds after which an idle chain worker will free its memory.

sender_chain_worker_ttl: Duration

The duration, in milliseconds, after which an idle sender chain worker will free its memory.

cross_chain_batch_size_limit: usize

Maximum number of cross-chain requests coalesced into a single batch by the per-chain driver. Bounds the worst-case write-lock hold time.

retry_delay: Duration

Delay increment for retrying to connect to a validator.

max_retries: u32

Number of times to retry connecting to a validator.

max_backoff: Duration

Maximum backoff delay for retrying to connect to a validator.

notification_circuit_breaker_initial_probe_interval: Duration

Initial probe interval (ms) for the notification circuit breaker. When a validator’s notification stream exhausts retries, the circuit breaker waits this long before probing again. Doubles on each failed probe.

notification_circuit_breaker_max_probe_interval: Duration

Maximum probe interval (ms) for the notification circuit breaker. The probe interval doubles on each failure but is capped at this value.

wait_for_outgoing_messages: bool

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

allow_fast_blocks: bool

Whether to allow creating blocks in the fast round. Fast blocks have lower latency but must be used carefully so that there are never any conflicting fast block proposals.

long_lived_services: bool

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

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 and events from. By default, messages and events from all chains are accepted. To reject all of them, specify an empty string. The admin chain’s event stream is always followed regardless of this setting.

reject_message_bundles_without_application_ids: Option<HashSet<GenericApplicationId>>

A set of application IDs. If specified, only bundles with at least one message from one of these applications will be accepted.

reject_message_bundles_with_other_application_ids: Option<HashSet<GenericApplicationId>>

A set of application IDs. If specified, only bundles where all messages are from one of these applications will be accepted.

process_events_from_application_ids: Option<HashSet<GenericApplicationId>>

A set of application IDs. If specified, only event streams created by applications from this set are processed and followed. The admin chain’s event stream is always followed.

never_reject_application_ids: Option<HashSet<GenericApplicationId>>

A set of application IDs whose messages must never be rejected. Bundles whose messages are all from one of these applications bypass the other rejection rules (except --restrict-chain-ids-to), and on execution failure they (and subsequent bundles from the same sender) are removed from the block for later retry instead of being rejected, with a warning logged. Bundles that contain any message from an application not on this list can be rejected.

timings: bool

Enable timing reports during operations

timing_interval: u64

Interval in seconds between timing reports (defaults to 5)

quorum_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_hedge_delay: Duration

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

certificate_batch_download_hedge_delay: Duration

The delay when downloading a batch of certificates, after which we try a second validator, in milliseconds.

certificate_download_batch_size: u64

Maximum number of certificates that we download at a time from one validator when synchronizing one of our chains.

certificate_upload_batch_size: u64

Maximum number of certificates read from local storage and uploaded to a validator at a time when synchronizing a chain.

sender_certificate_download_batch_size: usize

Maximum number of sender certificates we try to download and receive in one go when syncing sender chains.

max_concurrent_batch_downloads: usize

Maximum number of certificate batches downloaded concurrently during chain sync.

max_joined_tasks: usize

Maximum number of tasks that can are joined concurrently in the client.

max_event_stream_queries: usize

Maximum number of event stream IDs to include in a single PreviousEventBlocks request. Larger sets are split into multiple requests.

max_accepted_latency_ms: f64

Maximum expected latency in milliseconds for score normalization.

cache_ttl_ms: u64

Time-to-live for cached responses in milliseconds.

cache_max_size: usize

Maximum number of entries in the cache.

max_request_ttl_ms: u64

Maximum latency for an in-flight request before we stop deduplicating it (in milliseconds).

alpha: f64

Smoothing factor for Exponential Moving Averages (0 < alpha < 1). Higher values give more weight to recent observations. Typical values are between 0.01 and 0.5. A value of 0.1 means that 10% of the new observation is considered and 90% of the previous average is retained.

alternative_peers_retry_delay_ms: u64

Delay in milliseconds between starting requests to different peers. This helps to stagger requests and avoid overwhelming the network.

chain_listener_config: ChainListenerConfig

Configuration for the chain listener.

Trait Implementations

impl Args for Options

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 Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Options

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 Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

where Options: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Options

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 FromWasmAbi for Options

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl OptionFromWasmAbi for Options

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl Parser for Options

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.

impl RefFromWasmAbi for Options

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<Options>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl Tsify for Options

const DECL: &'static str = "/**\n * Command-line options controlling the behavior of the chain client.\n */\nexport interface Options extends ChainListenerConfig {\n /**\n * Timeout for sending queries (milliseconds)\n */\n sendTimeout?: { secs: number; nanos: number };\n /**\n * Timeout for receiving responses (milliseconds)\n */\n recvTimeout?: { secs: number; nanos: number };\n /**\n * The maximum number of incoming message bundles to include in a block proposal.\n */\n maxPendingMessageBundles?: number;\n /**\n * Maximum number of message bundles to discard from a block proposal due to block limit\n * errors before discarding all remaining bundles.\n *\n * Discarded bundles can be retried in the next block.\n */\n maxBlockLimitErrors?: number;\n /**\n * The maximum number of new stream events to include in a block proposal.\n */\n maxNewEventsPerBlock?: number;\n /**\n * Time budget for staging message bundles in milliseconds. When set, limits bundle\n * execution by wall-clock time, in addition to the count limit from\n * `max_pending_message_bundles`.\n */\n stagingBundlesTimeBudget?: { secs: number; nanos: number } | undefined;\n /**\n * Comma-separated list of chain IDs whose incoming bundles should be processed first.\n */\n prioritizeBundlesFrom?: ChainId[] | undefined;\n /**\n * Comma-separated list of chain IDs whose incoming bundles should be ignored.\n */\n ignoreBundlesFrom?: ChainId[] | undefined;\n /**\n * The duration in milliseconds after which an idle chain worker will free its memory.\n */\n chainWorkerTtl?: { secs: number; nanos: number };\n /**\n * The duration, in milliseconds, after which an idle sender chain worker will\n * free its memory.\n */\n senderChainWorkerTtl?: { secs: number; nanos: number };\n /**\n * Maximum number of cross-chain requests coalesced into a single batch by the\n * per-chain driver. Bounds the worst-case write-lock hold time.\n */\n crossChainBatchSizeLimit?: number;\n /**\n * Delay increment for retrying to connect to a validator.\n */\n retryDelay?: { secs: number; nanos: number };\n /**\n * Number of times to retry connecting to a validator.\n */\n maxRetries?: number;\n /**\n * Maximum backoff delay for retrying to connect to a validator.\n */\n maxBackoff?: { secs: number; nanos: number };\n /**\n * Initial probe interval (ms) for the notification circuit breaker. When a validator\\\'s\n * notification stream exhausts retries, the circuit breaker waits this long before\n * probing again. Doubles on each failed probe.\n */\n notificationCircuitBreakerInitialProbeInterval?: { secs: number; nanos: number };\n /**\n * Maximum probe interval (ms) for the notification circuit breaker. The probe interval\n * doubles on each failure but is capped at this value.\n */\n notificationCircuitBreakerMaxProbeInterval?: { secs: number; nanos: number };\n /**\n * Whether to wait until a quorum of validators has confirmed that all sent cross-chain\n * messages have been delivered.\n */\n waitForOutgoingMessages?: boolean;\n /**\n * Whether to allow creating blocks in the fast round. Fast blocks have lower latency but\n * must be used carefully so that there are never any conflicting fast block proposals.\n */\n allowFastBlocks?: boolean;\n /**\n * (EXPERIMENTAL) Whether application services can persist in some cases between queries.\n */\n longLivedServices?: boolean;\n /**\n * The policy for handling incoming messages.\n */\n blanketMessagePolicy?: BlanketMessagePolicy;\n /**\n * A set of chains to restrict incoming messages and events from. By default, messages and\n * events from all chains are accepted. To reject all of them, specify an empty string. The\n * admin chain\\\'s event stream is always followed regardless of this setting.\n */\n restrictChainIdsTo?: ChainId[] | undefined;\n /**\n * A set of application IDs. If specified, only bundles with at least one message from one of\n * these applications will be accepted.\n */\n rejectMessageBundlesWithoutApplicationIds?: GenericApplicationId[] | undefined;\n /**\n * A set of application IDs. If specified, only bundles where all messages are from one of\n * these applications will be accepted.\n */\n rejectMessageBundlesWithOtherApplicationIds?: GenericApplicationId[] | undefined;\n /**\n * A set of application IDs. If specified, only event streams created by applications from\n * this set are processed and followed. The admin chain\\\'s event stream is always followed.\n */\n processEventsFromApplicationIds?: GenericApplicationId[] | undefined;\n /**\n * A set of application IDs whose messages must never be rejected. Bundles whose messages\n * are all from one of these applications bypass the other rejection rules (except\n * `--restrict-chain-ids-to`), and on execution failure they (and subsequent bundles from\n * the same sender) are removed from the block for later retry instead of being rejected,\n * with a warning logged. Bundles that contain any message from an application not on this\n * list can be rejected.\n */\n neverRejectApplicationIds?: GenericApplicationId[] | undefined;\n /**\n * Enable timing reports during operations\n */\n timings?: boolean;\n /**\n * Interval in seconds between timing reports (defaults to 5)\n */\n timingInterval?: number;\n /**\n * An additional delay, after reaching a quorum, to wait for additional validator signatures,\n * as a fraction of time taken to reach quorum.\n */\n quorumGracePeriod?: number;\n /**\n * The delay when downloading a blob, after which we try a second validator, in milliseconds.\n */\n blobDownloadHedgeDelay?: { secs: number; nanos: number };\n /**\n * The delay when downloading a batch of certificates, after which we try a second validator,\n * in milliseconds.\n */\n certificateBatchDownloadHedgeDelay?: { secs: number; nanos: number };\n /**\n * Maximum number of certificates that we download at a time from one validator when\n * synchronizing one of our chains.\n */\n certificateDownloadBatchSize?: number;\n /**\n * Maximum number of certificates read from local storage and uploaded to a validator\n * at a time when synchronizing a chain.\n */\n certificateUploadBatchSize?: number;\n /**\n * Maximum number of sender certificates we try to download and receive in one go\n * when syncing sender chains.\n */\n senderCertificateDownloadBatchSize?: number;\n /**\n * Maximum number of certificate batches downloaded concurrently during chain sync.\n */\n maxConcurrentBatchDownloads?: number;\n /**\n * Maximum number of tasks that can are joined concurrently in the client.\n */\n maxJoinedTasks?: number;\n /**\n * Maximum number of event stream IDs to include in a single `PreviousEventBlocks`\n * request. Larger sets are split into multiple requests.\n */\n maxEventStreamQueries?: number;\n /**\n * Maximum expected latency in milliseconds for score normalization.\n */\n maxAcceptedLatencyMs?: number;\n /**\n * Time-to-live for cached responses in milliseconds.\n */\n cacheTtlMs?: number;\n /**\n * Maximum number of entries in the cache.\n */\n cacheMaxSize?: number;\n /**\n * Maximum latency for an in-flight request before we stop deduplicating it (in milliseconds).\n */\n maxRequestTtlMs?: number;\n /**\n * Smoothing factor for Exponential Moving Averages (0 < alpha < 1).\n * Higher values give more weight to recent observations.\n * Typical values are between 0.01 and 0.5.\n * A value of 0.1 means that 10% of the new observation is considered\n * and 90% of the previous average is retained.\n */\n alpha?: number;\n /**\n * Delay in milliseconds between starting requests to different peers.\n * This helps to stagger requests and avoid overwhelming the network.\n */\n alternativePeersRetryDelayMs?: number;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl VectorFromWasmAbi for Options

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl WasmDescribe for Options

fn describe()

impl WasmDescribeVector for Options

fn describe_vector()