Struct RpcConfig 

pub struct RpcConfig {

    pub enable_indexing: Option<bool>,
    pub https_address: Option<SocketAddr>,
    pub tls: Option<RpcTlsConfig>,
    pub max_json_move_value_size: Option<usize>,
    pub max_json_move_value_response_size: Option<usize>,
    pub index_initialization: Option<RpcIndexInitConfig>,
    pub ledger_history: Option<LedgerHistoryConfig>,
    pub subscription_watermark_interval: Option<u32>,
    pub subscription_max_subscribers: Option<usize>,
    pub subscription_shards: Option<u32>,
    pub display: Option<DisplayConfig>,
    pub max_connection_age_secs: Option<u64>,
    pub max_connection_age_grace_secs: Option<u64>,
    pub grpc_timeout_ms: Option<u64>,
}

Fields

enable_indexing: Option<bool>

Enable indexing of transactions and objects

This enables indexing of transactions and objects which allows for a slightly richer rpc api. There are some APIs which will be disabled/enabled based on this config while others (eg GetTransaction) will still be enabled regardless of this config but may return slight less data (eg GetTransaction won’t return the checkpoint that includes the requested transaction).

Defaults to false, with indexing and APIs which require indexes being disabled

https_address: Option<SocketAddr>

Configure the address to listen on for https

Defaults to 0.0.0.0:9443 if not specified.

tls: Option<RpcTlsConfig>

TLS configuration to use for https.

If not provided then the node will not create an https service.

max_json_move_value_size: Option<usize>

Maxumum budget for rendering a Move value into JSON.

This sets the numbers of bytes that we are willing to spend on rendering field names and values when rendering a Move value into a JSON value.

Defaults to 1MiB if not specified.

max_json_move_value_response_size: Option<usize>

Aggregate budget for Move-value JSON rendering across a single response.

Endpoints that render many Move values in one response (e.g. GetCheckpoint with a read_mask that selects every event’s json field) share this budget across all per-item renders, so the response cannot multiply one request into hundreds of MiB of materialized prost_types::Value.

Defaults to 16 MiB if not specified.

index_initialization: Option<RpcIndexInitConfig>

Configuration for RPC index initialization and bulk loading

ledger_history: Option<LedgerHistoryConfig>

Tunables for the ledger-history list APIs (list_transactions, list_events, list_checkpoints). These scan the historical inverted indexes, unlike the live object-set listings (list_owned_objects, list_dynamic_fields), so they carry their own time and scan-cost bounds.

subscription_watermark_interval: Option<u32>

Number of consecutive checkpoints a filtered subscription may go without producing an item before the server emits a progress-only frame, so sparse subscribers always learn their resume point. Defaults to 25 (~5 seconds at mainnet checkpoint cadence).

subscription_max_subscribers: Option<usize>

Maximum number of concurrent RPC subscriptions. Defaults to 1024.

subscription_shards: Option<u32>

Number of parallel shard tasks that evaluate subscription filters and deliver updates. Each subscriber lives on one shard; per-checkpoint filter evaluation parallelizes across shards. Defaults to the host’s available parallelism.

display: Option<DisplayConfig>

Configuration for rendering Objects based on the Display standard

max_connection_age_secs: Option<u64>

Maximum age of an RPC connection, in seconds. When a connection reaches this age the server sends GOAWAY and stops accepting new streams on it; in-flight requests are allowed to complete within max-connection-age-grace-secs. Bounding connection lifetime is the server-side backstop that reclaims streams wedged behind HTTP/2 flow-control windows that a stalled peer never reopens.

Defaults to 4 hours. Set to 0 to disable (connections then live forever).

max_connection_age_grace_secs: Option<u64>

Grace period, in seconds, that in-flight requests are given to complete after a connection begins shutting down (its max-connection-age-secs expired, or the node is stopping). When the grace period expires the connection is closed even if streams are still open. Set to 0 to close immediately at shutdown.

Defaults to 10 minutes. Has no effect while max-connection-age-secs is disabled and the node is running.

grpc_timeout_ms: Option<u64>

Server-side timeout for gRPC requests, in milliseconds. Requests that carry a grpc-timeout header are bounded by the smaller of the two values. The timeout covers a unary request’s full execution and a streaming request’s time to first response; it does not bound the lifetime of an established stream.

Defaults to 60 seconds. Set to 0 to disable.

Implementations

impl RpcConfig

pub fn enable_indexing(&self) -> bool

pub fn https_address(&self) -> SocketAddr

pub fn tls_config(&self) -> Option<&RpcTlsConfig>

pub fn max_json_move_value_size(&self) -> usize

pub fn max_json_move_value_response_size(&self) -> usize

pub fn index_initialization_config(&self) -> Option<&RpcIndexInitConfig>

pub fn ledger_history(&self) -> &LedgerHistoryConfig

pub fn max_connection_age(&self) -> Option<Duration>

Maximum age of an RPC connection; None means unlimited.

pub fn max_connection_age_grace(&self) -> Duration

Grace period for in-flight requests once a connection begins shutting down; Duration::ZERO closes immediately.

pub fn grpc_timeout(&self) -> Option<Duration>

Server-side default deadline for gRPC requests; None means no server-imposed deadline (client grpc-timeout headers still apply).

pub fn validate(&self) -> Result<()>

Validate cross-field invariants. Call once at startup to fail fast on a misconfiguration rather than surfacing it per-request.

pub fn display(&self) -> &DisplayConfig

Trait Implementations

impl Clone for RpcConfig

fn clone(&self) -> RpcConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RpcConfig

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

Formats the value using the given formatter.

impl Default for RpcConfig

fn default() -> RpcConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RpcConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RpcConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.