1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
use std::{collections::HashSet, fmt, str::FromStr};
use serde::{Deserialize, Serialize, Serializer};
use strum::{AsRefStr, EnumIter, IntoStaticStr, ParseError, VariantArray, VariantNames};
/// Describes the modules that should be installed.
///
/// # Example
///
/// Create a [`RpcModuleSelection`] from a selection.
///
/// ```
/// use reth_rpc_server_types::{RethRpcModule, RpcModuleSelection};
/// let config: RpcModuleSelection = vec![RethRpcModule::Eth].into();
/// ```
#[derive(Debug, Default, Clone, Eq, PartialEq)]
pub enum RpcModuleSelection {
/// Use _all_ available modules.
All,
/// The default modules `eth`, `net`, `web3`
#[default]
Standard,
/// Only use the configured modules.
Selection(HashSet<RethRpcModule>),
}
// === impl RpcModuleSelection ===
impl RpcModuleSelection {
/// The standard modules to instantiate by default `eth`, `net`, `web3`
pub const STANDARD_MODULES: [RethRpcModule; 3] =
[RethRpcModule::Eth, RethRpcModule::Net, RethRpcModule::Web3];
/// Returns a selection of [`RethRpcModule`] with all [`RethRpcModule::all_variants`].
pub fn all_modules() -> HashSet<RethRpcModule> {
RethRpcModule::modules().into_iter().collect()
}
/// Returns the [`RpcModuleSelection::STANDARD_MODULES`] as a selection.
pub fn standard_modules() -> HashSet<RethRpcModule> {
HashSet::from(Self::STANDARD_MODULES)
}
/// All modules that are available by default on IPC.
///
/// By default all modules are available on IPC.
pub fn default_ipc_modules() -> HashSet<RethRpcModule> {
Self::all_modules()
}
/// Creates a new _unique_ [`RpcModuleSelection::Selection`] from the given items.
///
/// # Note
///
/// This will dedupe the selection and remove duplicates while preserving the order.
///
/// # Example
///
/// Create a selection from the [`RethRpcModule`] string identifiers
///
/// ```
/// use reth_rpc_server_types::{RethRpcModule, RpcModuleSelection};
/// let selection = vec!["eth", "admin"];
/// let config = RpcModuleSelection::try_from_selection(selection).unwrap();
/// assert_eq!(config, RpcModuleSelection::from([RethRpcModule::Eth, RethRpcModule::Admin]));
/// ```
///
/// Create a unique selection from the [`RethRpcModule`] string identifiers
///
/// ```
/// use reth_rpc_server_types::{RethRpcModule, RpcModuleSelection};
/// let selection = vec!["eth", "admin", "eth", "admin"];
/// let config = RpcModuleSelection::try_from_selection(selection).unwrap();
/// assert_eq!(config, RpcModuleSelection::from([RethRpcModule::Eth, RethRpcModule::Admin]));
/// ```
pub fn try_from_selection<I, T>(selection: I) -> Result<Self, T::Error>
where
I: IntoIterator<Item = T>,
T: TryInto<RethRpcModule>,
{
selection.into_iter().map(TryInto::try_into).collect()
}
/// Returns the number of modules in the selection
pub fn len(&self) -> usize {
match self {
Self::All => RethRpcModule::variant_count(),
Self::Standard => Self::STANDARD_MODULES.len(),
Self::Selection(s) => s.len(),
}
}
/// Returns true if no selection is configured
pub fn is_empty(&self) -> bool {
match self {
Self::Selection(sel) => sel.is_empty(),
_ => false,
}
}
/// Returns an iterator over all configured [`RethRpcModule`]
pub fn iter_selection(&self) -> Box<dyn Iterator<Item = RethRpcModule> + '_> {
match self {
Self::All => Box::new(RethRpcModule::modules().into_iter()),
Self::Standard => Box::new(Self::STANDARD_MODULES.iter().copied()),
Self::Selection(s) => Box::new(s.iter().copied()),
}
}
/// Clones the set of configured [`RethRpcModule`].
pub fn to_selection(&self) -> HashSet<RethRpcModule> {
match self {
Self::All => Self::all_modules(),
Self::Standard => Self::standard_modules(),
Self::Selection(s) => s.clone(),
}
}
/// Converts the selection into a [`HashSet`].
pub fn into_selection(self) -> HashSet<RethRpcModule> {
match self {
Self::All => Self::all_modules(),
Self::Standard => Self::standard_modules(),
Self::Selection(s) => s,
}
}
/// Returns true if both selections are identical.
pub fn are_identical(http: Option<&Self>, ws: Option<&Self>) -> bool {
match (http, ws) {
// Shortcut for common case to avoid iterating later
(Some(Self::All), Some(other)) | (Some(other), Some(Self::All)) => {
other.len() == RethRpcModule::variant_count()
}
// If either side is disabled, then the other must be empty
(Some(some), None) | (None, Some(some)) => some.is_empty(),
(Some(http), Some(ws)) => http.to_selection() == ws.to_selection(),
(None, None) => true,
}
}
}
impl From<&HashSet<RethRpcModule>> for RpcModuleSelection {
fn from(s: &HashSet<RethRpcModule>) -> Self {
Self::from(s.clone())
}
}
impl From<HashSet<RethRpcModule>> for RpcModuleSelection {
fn from(s: HashSet<RethRpcModule>) -> Self {
Self::Selection(s)
}
}
impl From<&[RethRpcModule]> for RpcModuleSelection {
fn from(s: &[RethRpcModule]) -> Self {
Self::Selection(s.iter().copied().collect())
}
}
impl From<Vec<RethRpcModule>> for RpcModuleSelection {
fn from(s: Vec<RethRpcModule>) -> Self {
Self::Selection(s.into_iter().collect())
}
}
impl<const N: usize> From<[RethRpcModule; N]> for RpcModuleSelection {
fn from(s: [RethRpcModule; N]) -> Self {
Self::Selection(s.iter().copied().collect())
}
}
impl<'a> FromIterator<&'a RethRpcModule> for RpcModuleSelection {
fn from_iter<I>(iter: I) -> Self
where
I: IntoIterator<Item = &'a RethRpcModule>,
{
iter.into_iter().copied().collect()
}
}
impl FromIterator<RethRpcModule> for RpcModuleSelection {
fn from_iter<I>(iter: I) -> Self
where
I: IntoIterator<Item = RethRpcModule>,
{
Self::Selection(iter.into_iter().collect())
}
}
impl FromStr for RpcModuleSelection {
type Err = ParseError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
if s.is_empty() {
return Ok(Self::Selection(Default::default()))
}
let mut modules = s.split(',').map(str::trim).peekable();
let first = modules.peek().copied().ok_or(ParseError::VariantNotFound)?;
match first {
"all" | "All" => Ok(Self::All),
"none" | "None" => Ok(Self::Selection(Default::default())),
_ => Self::try_from_selection(modules),
}
}
}
impl fmt::Display for RpcModuleSelection {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"[{}]",
self.iter_selection().map(|s| s.to_string()).collect::<Vec<_>>().join(", ")
)
}
}
/// Represents RPC modules that are supported by reth
#[derive(
Debug,
Clone,
Copy,
Eq,
PartialEq,
Hash,
AsRefStr,
IntoStaticStr,
VariantNames,
VariantArray,
EnumIter,
Deserialize,
)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "kebab-case")]
pub enum RethRpcModule {
/// `admin_` module
Admin,
/// `debug_` module
Debug,
/// `eth_` module
Eth,
/// `net_` module
Net,
/// `trace_` module
Trace,
/// `txpool_` module
Txpool,
/// `web3_` module
Web3,
/// `rpc_` module
Rpc,
/// `reth_` module
Reth,
/// `ots_` module
Ots,
/// For single non-standard `eth_` namespace call `eth_callBundle`
///
/// This is separate from [`RethRpcModule::Eth`] because it is a non standardized call that
/// should be opt-in.
EthCallBundle,
}
// === impl RethRpcModule ===
impl RethRpcModule {
/// Returns the number of variants in the enum
pub const fn variant_count() -> usize {
<Self as VariantArray>::VARIANTS.len()
}
/// Returns all variant names of the enum
pub const fn all_variant_names() -> &'static [&'static str] {
<Self as VariantNames>::VARIANTS
}
/// Returns all variants of the enum
pub const fn all_variants() -> &'static [Self] {
<Self as VariantArray>::VARIANTS
}
/// Returns all variants of the enum
pub fn modules() -> impl IntoIterator<Item = Self> {
use strum::IntoEnumIterator;
Self::iter()
}
/// Returns the string representation of the module.
#[inline]
pub fn as_str(&self) -> &'static str {
self.into()
}
}
impl FromStr for RethRpcModule {
type Err = ParseError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(match s {
"admin" => Self::Admin,
"debug" => Self::Debug,
"eth" => Self::Eth,
"net" => Self::Net,
"trace" => Self::Trace,
"txpool" => Self::Txpool,
"web3" => Self::Web3,
"rpc" => Self::Rpc,
"reth" => Self::Reth,
"ots" => Self::Ots,
"eth-call-bundle" | "eth_callBundle" => Self::EthCallBundle,
_ => return Err(ParseError::VariantNotFound),
})
}
}
impl TryFrom<&str> for RethRpcModule {
type Error = ParseError;
fn try_from(s: &str) -> Result<Self, <Self as TryFrom<&str>>::Error> {
FromStr::from_str(s)
}
}
impl fmt::Display for RethRpcModule {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.pad(self.as_ref())
}
}
impl Serialize for RethRpcModule {
fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
s.serialize_str(self.as_ref())
}
}