Enum smoldot_light::AddChainConfigJsonRpc

pub enum AddChainConfigJsonRpc {
    Disabled,
    Enabled {
        max_pending_requests: NonZero<u32>,
        max_subscriptions: u32,
    },
}

See AddChainConfig::json_rpc.

Variants

Disabled

No JSON-RPC endpoint is available for this chain. This saves up a lot of resources, but will cause all JSON-RPC requests targeting this chain to fail.

Enabled

The JSON-RPC endpoint is enabled. Normal operations.

Fields

max_pending_requests: NonZero<u32>

Maximum number of JSON-RPC requests that can be added to a queue if it is not ready to be processed immediately. Any additional request will be immediately rejected.

This parameter is necessary in order to prevent JSON-RPC clients from using up too much memory within the client. If the JSON-RPC client is entirely trusted, then passing u32::MAX is completely reasonable.

A typical value is 128.

max_subscriptions: u32

Maximum number of active subscriptions that can be started through JSON-RPC functions. Any request that causes the JSON-RPC server to generate notifications counts as a subscription. Any additional subscription over this limit will be immediately rejected.

This parameter is necessary in order to prevent JSON-RPC clients from using up too much memory within the client. If the JSON-RPC client is entirely trusted, then passing u32::MAX is completely reasonable.

While a typical reasonable value would be for example 64, existing UIs tend to start a lot of subscriptions, and a value such as 1024 is recommended.

Trait Implementations

impl Clone for AddChainConfigJsonRpc

fn clone(&self) -> AddChainConfigJsonRpc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddChainConfigJsonRpc

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

Formats the value using the given formatter.