Struct sc_cli::RpcEndpoint

pub struct RpcEndpoint {

    pub listen_addr: SocketAddr,
    pub batch_config: RpcBatchRequestConfig,
    pub max_connections: u32,
    pub max_payload_in_mb: u32,
    pub max_payload_out_mb: u32,
    pub max_subscriptions_per_connection: u32,
    pub max_buffer_capacity_per_connection: u32,
    pub rate_limit: Option<NonZeroU32>,
    pub rate_limit_trust_proxy_headers: bool,
    pub rate_limit_whitelisted_ips: Vec<IpNetwork>,
    pub cors: Option<Vec<String>>,
    pub rpc_methods: RpcMethods,
    pub is_optional: bool,
    pub retry_random_port: bool,
}

Represent a single RPC endpoint with its configuration.

Fields

listen_addr: SocketAddr

Listen address.

batch_config: RpcBatchRequestConfig

Batch request configuration.

max_connections: u32

Maximum number of connections.

max_payload_in_mb: u32

Maximum inbound payload size in MB.

max_payload_out_mb: u32

Maximum outbound payload size in MB.

max_subscriptions_per_connection: u32

Maximum number of subscriptions per connection.

max_buffer_capacity_per_connection: u32

Maximum buffer capacity per connection.

rate_limit: Option<NonZeroU32>

Rate limit per minute.

rate_limit_trust_proxy_headers: bool

Whether to trust proxy headers for rate limiting.

rate_limit_whitelisted_ips: Vec<IpNetwork>

Whitelisted IPs for rate limiting.

cors: Option<Vec<String>>

CORS.

rpc_methods: RpcMethods

RPC methods to expose.

is_optional: bool

Whether it’s an optional listening address i.e, it’s ignored if it fails to bind. For example substrate tries to bind both ipv4 and ipv6 addresses but some platforms may not support ipv6.

retry_random_port: bool

Whether to retry with a random port if the provided port is already in use.

Implementations

impl RpcEndpoint

pub fn is_global(&self) -> bool

Returns whether the endpoint is globally exposed.

Trait Implementations

impl Clone for RpcEndpoint

fn clone(&self) -> RpcEndpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RpcEndpoint

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

Formats the value using the given formatter.

impl FromStr for RpcEndpoint

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Into<RpcEndpoint> for RpcEndpoint

fn into(self) -> RpcEndpoint

Converts this type into the (usually inferred) input type.