Struct RpcConfig

pub struct RpcConfig {
    pub listen_address: String,
    pub tcp_listen_address: Option<String>,
    pub ws_listen_address: Option<String>,
    pub max_request_body_size: usize,
    pub threads: Option<usize>,
    pub rpc_batch_limit: Option<usize>,
    pub modules: Vec<Module>,
    pub reject_ill_transactions: bool,
    pub enable_deprecated_rpc: bool,
    pub extra_well_known_lock_scripts: Vec<Script>,
    pub extra_well_known_type_scripts: Vec<Script>,
}

RPC config options.

Fields

listen_address: String

RPC server listen addresses.

tcp_listen_address: Option<String>

RPC TCP server listen addresses.

Only TCP and WS are supported to subscribe events via the Subscription RPC module.

ws_listen_address: Option<String>

RPC WS server listen addresses.

Only TCP and WS are supported to subscribe events via the Subscription RPC module.

max_request_body_size: usize

Max request body size in bytes.

threads: Option<usize>

Number of RPC worker threads.

rpc_batch_limit: Option<usize>

Number of RPC batch limit.

modules: Vec<Module>

Enabled RPC modules.

reject_ill_transactions: bool

Rejects txs with scripts that might trigger known bugs

enable_deprecated_rpc: bool

Whether enable deprecated RPC methods.

Deprecated RPC methods are disabled by default.

extra_well_known_lock_scripts: Vec<Script>

Customized extra well known lock scripts.

extra_well_known_type_scripts: Vec<Script>

Customized extra well known type scripts.

Implementations

impl Config

pub fn net_enable(&self) -> bool

Checks whether the Net module is enabled.

pub fn chain_enable(&self) -> bool

Checks whether the Chain module is enabled.

pub fn miner_enable(&self) -> bool

Checks whether the Miner module is enabled.

pub fn pool_enable(&self) -> bool

Checks whether the Pool module is enabled.

pub fn experiment_enable(&self) -> bool

Checks whether the Experiment module is enabled.

pub fn stats_enable(&self) -> bool

Checks whether the Stats module is enabled.

pub fn subscription_enable(&self) -> bool

Checks whether the Subscription module is enabled.

pub fn integration_test_enable(&self) -> bool

Checks whether the IntegrationTest module is enabled.

pub fn alert_enable(&self) -> bool

Checks whether the Alert module is enabled.

pub fn debug_enable(&self) -> bool

Checks whether the Debug module is enabled.

pub fn indexer_enable(&self) -> bool

Checks whether the Indexer module is enabled.

pub fn rich_indexer_enable(&self) -> bool

Checks whether the Rich Indexer module is enabled.

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<'de> Deserialize<'de> for Config

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

Tests for self and other values to be equal, and is used by ==.

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

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