Feat: Unix sockets for Electrum RPC

mempool · Sep 30, 2023 · 4339a51 · 4339a51
1 parent 09a11b1
commit 4339a51
Show file tree

Hide file tree

Showing 8 changed files with 264 additions and 61 deletions.
diff --git a/electrs-start-liquid b/electrs-start-liquid
@@ -20,6 +20,7 @@ do
 		-- \
 		--network liquid \
 		--http-socket-file "${HOME}/socket/esplora-liquid-mainnet" \
+		--rpc-socket-file "${HOME}/socket/electrum-liquid-mainnet" \
 		--precache-scripts "${HOME}/electrs/contrib/popular-scripts.txt" \
 		--asset-db-path "${HOME}/asset_registry_db" \
 		--daemon-dir "${HOME}" \

diff --git a/electrs-start-liquidtestnet b/electrs-start-liquidtestnet
@@ -20,6 +20,7 @@ do
 		-- \
 		--network liquidtestnet \
 		--http-socket-file "${HOME}/socket/esplora-liquid-testnet" \
+		--rpc-socket-file "${HOME}/socket/electrum-liquid-testnet" \
 		--precache-scripts "${HOME}/electrs/contrib/popular-scripts.txt" \
 		--asset-db-path "${HOME}/asset_registry_testnet_db" \
 		--daemon-dir "${HOME}" \

diff --git a/electrs-start-mainnet b/electrs-start-mainnet
@@ -30,6 +30,7 @@ do
 		--bin electrs \
 		-- \
 		--http-socket-file "${HOME}/socket/esplora-bitcoin-mainnet" \
+		--rpc-socket-file "${HOME}/socket/electrum-bitcoin-mainnet" \
 		--precache-scripts "${HOME}/electrs/contrib/popular-scripts.txt" \
 		--daemon-dir "${HOME}" \
 		--db-dir "/electrs" \

diff --git a/electrs-start-signet b/electrs-start-signet
@@ -31,6 +31,7 @@ do
 		-- \
 		--network signet \
 		--http-socket-file "${HOME}/socket/esplora-bitcoin-signet" \
+		--rpc-socket-file "${HOME}/socket/electrum-bitcoin-signet" \
 		--precache-scripts "${HOME}/electrs/contrib/popular-scripts.txt" \
 		--daemon-dir "${HOME}" \
 		--db-dir "/electrs" \

diff --git a/electrs-start-testnet b/electrs-start-testnet
@@ -31,6 +31,7 @@ do
 		-- \
 		--network testnet \
 		--http-socket-file "${HOME}/socket/esplora-bitcoin-testnet" \
+		--rpc-socket-file "${HOME}/socket/electrum-bitcoin-testnet" \
 		--precache-scripts "${HOME}/electrs/contrib/popular-scripts.txt" \
 		--daemon-dir "${HOME}" \
 		--db-dir "/electrs" \

diff --git a/src/config.rs b/src/config.rs
@@ -41,6 +41,7 @@ pub struct Config {
     pub electrum_rpc_addr: SocketAddr,
     pub http_addr: SocketAddr,
     pub http_socket_file: Option<PathBuf>,
+    pub rpc_socket_file: Option<PathBuf>,
     pub monitoring_addr: SocketAddr,
     pub jsonrpc_import: bool,
     pub light_mode: bool,
@@ -243,6 +244,14 @@ impl Config {
                     .takes_value(true),
             );
 
+        #[cfg(unix)]
+        let args = args.arg(
+                Arg::with_name("rpc_socket_file")
+                    .long("rpc-socket-file")
+                    .help("Electrum RPC 'unix socket file' to listen on (default disabled, enabling this ignores the electrum_rpc_addr arg)")
+                    .takes_value(true),
+            );
+
         #[cfg(feature = "liquid")]
         let args = args
             .arg(
@@ -384,6 +393,7 @@ impl Config {
         );
 
         let http_socket_file: Option<PathBuf> = m.value_of("http_socket_file").map(PathBuf::from);
+        let rpc_socket_file: Option<PathBuf> = m.value_of("rpc_socket_file").map(PathBuf::from);
         let monitoring_addr: SocketAddr = str_to_socketaddr(
             m.value_of("monitoring_addr")
                 .unwrap_or(&format!("127.0.0.1:{}", default_monitoring_port)),
@@ -452,6 +462,7 @@ impl Config {
             electrum_banner,
             http_addr,
             http_socket_file,
+            rpc_socket_file,
             monitoring_addr,
             mempool_backlog_stats_ttl: value_t_or_exit!(m, "mempool_backlog_stats_ttl", u64),
             mempool_recent_txs_size: value_t_or_exit!(m, "mempool_recent_txs_size", usize),