Struct zebra_rpc::config::Config

pub struct Config {
    pub listen_addr: Option<SocketAddr>,
    pub parallel_cpu_threads: usize,
    pub debug_force_finished_sync: bool,
}

RPC configuration section.

Fields

listen_addr: Option<SocketAddr>

IP address and port for the RPC server.

Note: The RPC server is disabled by default. To enable the RPC server, set a listen address in the config:

[rpc]
listen_addr = '127.0.0.1:8232'

The recommended ports for the RPC server are:

• Mainnet: 127.0.0.1:8232
• Testnet: 127.0.0.1:18232

Security

If you bind Zebra’s RPC port to a public IP address, anyone on the internet can send transactions via your node. They can also query your node’s state.

parallel_cpu_threads: usize

The number of threads used to process RPC requests and responses.

Zebra’s RPC server has a separate thread pool and a tokio executor for each thread. State queries are run concurrently using the shared thread pool controlled by the SyncSection.parallel_cpu_threads config.

If the number of threads is not configured or zero, Zebra uses the number of logical cores. If the number of logical cores can’t be detected, Zebra uses one thread.

Set to 1 to run all RPC queries on a single thread, and detect RPC port conflicts from multiple Zebra or zcashd instances.

For details, see the jsonrpc_http_server documentation.

Warning

The default config uses multiple threads, which disables RPC port conflict detection. This can allow multiple Zebra instances to share the same RPC port.

If some of those instances are outdated or failed, RPC queries can be slow or inconsistent.

debug_force_finished_sync: bool

Test-only option that makes Zebra say it is at the chain tip, no matter what the estimated height or local clock is.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config