diff --git a/core/Cargo.lock b/core/Cargo.lock index 13a6a90a..82c05b6c 100644 --- a/core/Cargo.lock +++ b/core/Cargo.lock @@ -12,6 +12,31 @@ dependencies = [ "generic-array", ] +[[package]] +name = "aes" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b169f7a6d4742236a0a00c541b845991d0ac43e546831af1249753ab4c3aa3a0" +dependencies = [ + "cfg-if", + "cipher", + "cpufeatures", +] + +[[package]] +name = "aes-gcm" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "831010a0f742e1209b3bcea8fab6a8e149051ba6099432c8cb2cc117dec3ead1" +dependencies = [ + "aead", + "aes", + "cipher", + "ctr", + "ghash", + "subtle", +] + [[package]] name = "aho-corasick" version = "1.1.4" @@ -51,6 +76,7 @@ dependencies = [ "bs58", "chacha20poly1305", "chrono", + "data-encoding", "ed25519-dalek", "futures-util", "hex", @@ -60,21 +86,26 @@ dependencies = [ "hyper-util", "hyper-ws-listener", "nostr-sdk", + "qrcode", "rand 0.8.5", + "regex", "reqwest", "serde", "serde_json", "serde_yaml", + "sha2", "thiserror 1.0.69", "tokio", "tokio-test", "tokio-tungstenite 0.20.1", "toml", + "totp-rs", "tower", "tower-http", "tracing", "tracing-subscriber", "uuid", + "zeroize", ] [[package]] @@ -127,10 +158,13 @@ dependencies = [ name = "archipelago-security" version = "0.1.0" dependencies = [ + "aes-gcm", "anyhow", "chrono", "log", + "rand 0.8.5", "serde", + "tempfile", "thiserror 1.0.69", "tokio", "tracing", @@ -215,6 +249,12 @@ version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8" +[[package]] +name = "base32" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "022dfe9eb35f19ebbcb51e0b40a5ab759f46ad60cadf7297e0bd085afb50e076" + [[package]] name = "base64" version = "0.21.7" @@ -344,12 +384,24 @@ version = "3.19.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5dd9dc738b7a8311c7ade152424974d8115f2cdad61e8dab8dac9f2362298510" +[[package]] +name = "bytemuck" +version = "1.25.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8efb64bd706a16a1bdde310ae86b351e4d21550d98d056f22f8a7f7a2183fec" + [[package]] name = "byteorder" version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" +[[package]] +name = "byteorder-lite" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f1fe948ff07f4bd06c30984e69f5b4899c516a3ef74f34df92a2df2ab535495" + [[package]] name = "bytes" version = "1.11.0" @@ -436,6 +488,12 @@ version = "0.9.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c2459377285ad874054d797f3ccebf984978aa39129f6eafde5cdc8315b612f8" +[[package]] +name = "constant_time_eq" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c74b8349d32d297c9134b8c88677813a227df8f779daa29bfc29c183fe3dca6" + [[package]] name = "core-foundation" version = "0.9.4" @@ -472,6 +530,15 @@ dependencies = [ "typenum", ] +[[package]] +name = "ctr" +version = "0.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0369ee1ad671834580515889b80f2ea915f23b8be8d0daa4bbaf2ac5c7590835" +dependencies = [ + "cipher", +] + [[package]] name = "curve25519-dalek" version = "4.1.3" @@ -778,6 +845,16 @@ dependencies = [ "wasip2", ] +[[package]] +name = "ghash" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0d8a4362ccb29cb0b265253fb0a2728f592895ee6854fd9bc13f2ffda266ff1" +dependencies = [ + "opaque-debug", + "polyval", +] + [[package]] name = "gloo-timers" version = "0.3.0" @@ -1167,6 +1244,18 @@ dependencies = [ "icu_properties", ] +[[package]] +name = "image" +version = "0.25.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6506c6c10786659413faa717ceebcb8f70731c0a60cbae39795fdf114519c1a" +dependencies = [ + "bytemuck", + "byteorder-lite", + "moxcms", + "num-traits", +] + [[package]] name = "indexmap" version = "2.13.0" @@ -1311,6 +1400,16 @@ dependencies = [ "windows-sys 0.61.2", ] +[[package]] +name = "moxcms" +version = "0.7.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac9557c559cd6fc9867e122e20d2cbefc9ca29d80d027a8e39310920ed2f0a97" +dependencies = [ + "num-traits", + "pxfm", +] + [[package]] name = "native-tls" version = "0.2.14" @@ -1574,6 +1673,18 @@ dependencies = [ "universal-hash", ] +[[package]] +name = "polyval" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d1fe60d06143b2430aa532c94cfe9e29783047f06c0d7fd359a9a51b729fa25" +dependencies = [ + "cfg-if", + "cpufeatures", + "opaque-debug", + "universal-hash", +] + [[package]] name = "potential_utf" version = "0.1.4" @@ -1601,6 +1712,21 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "pxfm" +version = "0.1.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5a041e753da8b807c9255f28de81879c78c876392ff2469cde94799b2896b9d" + +[[package]] +name = "qrcode" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d68782463e408eb1e668cf6152704bd856c78c5b6417adaee3203d8f4c1fc9ec" +dependencies = [ + "image", +] + [[package]] name = "quote" version = "1.0.44" @@ -2458,6 +2584,22 @@ version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "5d99f8c9a7727884afe522e9bd5edbfc91a3312b36a77b5fb8926e4c31a41801" +[[package]] +name = "totp-rs" +version = "5.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f124352108f58ef88299e909f6e9470f1cdc8d2a1397963901b4a6366206bf72" +dependencies = [ + "base32", + "constant_time_eq", + "hmac", + "rand 0.9.2", + "sha1", + "sha2", + "url", + "urlencoding", +] + [[package]] name = "tower" version = "0.5.3" @@ -2657,6 +2799,12 @@ dependencies = [ "serde_derive", ] +[[package]] +name = "urlencoding" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "daf8dba3b7eb870caf1ddeed7bc9d2a049f3cfdfae7cb521b087cc33ae4c49da" + [[package]] name = "utf-8" version = "0.7.6" @@ -3210,6 +3358,20 @@ name = "zeroize" version = "1.8.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b97154e67e32c85465826e8bcc1c59429aaaf107c1e4a9e53c8d8ccd5eff88d0" +dependencies = [ + "zeroize_derive", +] + +[[package]] +name = "zeroize_derive" +version = "1.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85a5b4158499876c763cb03bc4e49185d3cccbabb15b33c627f7884f43db852e" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] [[package]] name = "zerotrie" diff --git a/core/archipelago/src/api/rpc/package.rs b/core/archipelago/src/api/rpc/package.rs index e9f98f87..43666229 100644 --- a/core/archipelago/src/api/rpc/package.rs +++ b/core/archipelago/src/api/rpc/package.rs @@ -43,6 +43,25 @@ impl RpcHandler { return self.install_penpot_stack().await; } + // Dependency check: electrs requires a Bitcoin node + if package_id == "mempool-electrs" || package_id == "electrs" { + let btc_check = tokio::process::Command::new("sudo") + .args(["podman", "ps", "--format", "{{.Names}}"]) + .output() + .await + .context("Failed to check running containers")?; + let running = String::from_utf8_lossy(&btc_check.stdout); + let has_bitcoin = running.lines().any(|l| { + let name = l.trim(); + name == "bitcoin-knots" || name == "bitcoin-core" || name == "bitcoin" + }); + if !has_bitcoin { + return Err(anyhow::anyhow!( + "Electrs requires a running Bitcoin node (Bitcoin Knots or Bitcoin Core). Please install and start Bitcoin Knots first." + )); + } + } + // Check if container already exists let check_output = tokio::process::Command::new("sudo") .args(["podman", "ps", "-a", "--format", "{{.Names}}", "--filter", &format!("name=^{}$", package_id)]) @@ -84,11 +103,14 @@ impl RpcHandler { debug!("Using local image: {}", docker_image); } + // Normalize container name: "electrs" alias -> "mempool-electrs" + let container_name = if package_id == "electrs" { "mempool-electrs" } else { package_id }; + // Create and start container with security constraints let mut run_args = vec![ "podman", "run", "-d", // Detached - "--name", package_id, + "--name", container_name, "--restart=unless-stopped", // Auto-restart policy ]; @@ -105,7 +127,7 @@ impl RpcHandler { let needs_archy_net = matches!( package_id, "bitcoin-knots" | "bitcoin" | "bitcoin-core" - | "mempool" | "mempool-web" | "mempool-api" | "mempool-electrs" | "mysql-mempool" | "archy-mempool-db" | "archy-mempool-web" + | "mempool" | "mempool-web" | "mempool-api" | "mempool-electrs" | "electrs" | "mysql-mempool" | "archy-mempool-db" | "archy-mempool-web" | "btcpay-server" | "btcpayserver" | "archy-btcpay-db" ); @@ -168,6 +190,27 @@ impl RpcHandler { } } + // Pre-install: Create bitcoin.conf for Bitcoin nodes with RPC + txindex + if matches!(package_id, "bitcoin" | "bitcoin-core" | "bitcoin-knots") { + let bitcoin_dir = "/var/lib/archipelago/bitcoin"; + let conf_path = format!("{}/bitcoin.conf", bitcoin_dir); + let bitcoin_conf = "\ +server=1\n\ +txindex=1\n\ +rpcuser=archipelago\n\ +rpcpassword=archipelago123\n\ +rpcbind=0.0.0.0\n\ +rpcallowip=0.0.0.0/0\n\ +rpcport=8332\n\ +listen=1\n\ +printtoconsole=1\n"; + let _ = tokio::process::Command::new("sudo") + .args(["sh", "-c", &format!("echo '{}' > {}", bitcoin_conf, conf_path)]) + .output() + .await; + info!("Created bitcoin.conf at {} with RPC + txindex enabled", conf_path); + } + // Add port mappings (skip if host network mode like Tailscale) if !is_tailscale { for port in &ports { @@ -244,6 +287,32 @@ impl RpcHandler { }); } + // Post-install: Start electrs-ui container for electrs + if matches!(package_id, "mempool-electrs" | "electrs") { + tokio::spawn(async move { + // Build and start electrs-ui with host networking so it can reach backend on 127.0.0.1:5678 + let ui_dir = "/opt/archipelago/docker/electrs-ui"; + let _ = tokio::process::Command::new("sudo") + .args(["podman", "build", "-t", "localhost/electrs-ui", ui_dir]) + .output() + .await; + // Remove old UI container if it exists + let _ = tokio::process::Command::new("sudo") + .args(["podman", "rm", "-f", "electrs-ui"]) + .output() + .await; + let _ = tokio::process::Command::new("sudo") + .args([ + "podman", "run", "-d", "--name", "electrs-ui", + "--restart=unless-stopped", "--network=host", + "localhost/electrs-ui", + ]) + .output() + .await; + info!("Electrs UI container started on port 50002"); + }); + } + Ok(serde_json::json!({ "success": true, "package_id": package_id, @@ -793,6 +862,25 @@ const TRUSTED_REGISTRIES: &[&str] = &[ ]; /// Validate Docker image against trusted registry allowlist. +/// Detect which Bitcoin container is running on archy-net for DNS resolution. +/// Returns the container name to use as the RPC host (e.g., "bitcoin-knots"). +fn detect_bitcoin_container_name() -> String { + // Synchronous check — called from get_app_config which is sync + let output = std::process::Command::new("sudo") + .args(["podman", "ps", "--format", "{{.Names}}"]) + .output(); + if let Ok(out) = output { + let names = String::from_utf8_lossy(&out.stdout); + for candidate in &["bitcoin-knots", "bitcoin-core", "bitcoin"] { + if names.lines().any(|l| l.trim() == *candidate) { + return candidate.to_string(); + } + } + } + // Default to bitcoin-knots (most common) + "bitcoin-knots".to_string() +} + fn is_valid_docker_image(image: &str) -> bool { if image.is_empty() || image.len() > 256 { return false; @@ -938,24 +1026,28 @@ fn get_app_config( None, None, ), - "mempool-electrs" => ( - vec!["50001:50001".to_string()], - vec!["/var/lib/archipelago/mempool-electrs:/data".to_string()], - vec![], - None, - Some(vec![ - "--daemon-rpc-addr".to_string(), - format!("{}:8332", host_ip), - "--cookie".to_string(), - "archipelago:archipelago123".to_string(), - "--jsonrpc-import".to_string(), - "--electrum-rpc-addr".to_string(), - "0.0.0.0:50001".to_string(), - "--db-dir".to_string(), - "/data".to_string(), - "--lightmode".to_string(), - ]), - ), + "mempool-electrs" | "electrs" => { + // Detect which bitcoin container is running for archy-net DNS resolution + let bitcoin_host = detect_bitcoin_container_name(); + ( + vec!["50001:50001".to_string()], + vec!["/var/lib/archipelago/mempool-electrs:/data".to_string()], + vec![], + None, + Some(vec![ + "--daemon-rpc-addr".to_string(), + format!("{}:8332", bitcoin_host), + "--cookie".to_string(), + "archipelago:archipelago123".to_string(), + "--jsonrpc-import".to_string(), + "--electrum-rpc-addr".to_string(), + "0.0.0.0:50001".to_string(), + "--db-dir".to_string(), + "/data".to_string(), + "--lightmode".to_string(), + ]), + ) + }, "mysql-mempool" => ( vec![], vec!["/var/lib/archipelago/mysql-mempool:/var/lib/mysql".to_string()], diff --git a/core/archipelago/src/electrs_status.rs b/core/archipelago/src/electrs_status.rs index f5b83395..ca258993 100644 --- a/core/archipelago/src/electrs_status.rs +++ b/core/archipelago/src/electrs_status.rs @@ -9,6 +9,9 @@ use std::time::Duration; const ELECTRS_HOST: &str = "127.0.0.1"; const ELECTRS_PORT: u16 = 50001; const BITCOIN_RPC_URL: &str = "http://127.0.0.1:8332/"; +const ELECTRS_DATA_DIR: &str = "/var/lib/archipelago/mempool-electrs"; +// Approximate final index size in bytes for mainnet with --lightmode (~35GB) +const ESTIMATED_FULL_INDEX_BYTES: f64 = 35_000_000_000.0; /// Build Bitcoin RPC Basic auth header from env vars. /// Falls back to cookie auth file if env vars are not set. @@ -27,6 +30,35 @@ pub struct ElectrsSyncStatus { pub progress_pct: f64, pub status: String, pub error: Option, + /// Index data size in human-readable format (e.g. "11.2 GB") + pub index_size: Option, +} + +/// Get the total size of a directory in bytes. +fn dir_size_bytes(path: &str) -> u64 { + let mut total: u64 = 0; + if let Ok(entries) = std::fs::read_dir(path) { + for entry in entries.flatten() { + let path = entry.path(); + if path.is_dir() { + total += dir_size_bytes(&path.to_string_lossy()); + } else if let Ok(meta) = entry.metadata() { + total += meta.len(); + } + } + } + total +} + +/// Format bytes as human-readable string. +fn format_bytes(bytes: u64) -> String { + if bytes >= 1_000_000_000 { + format!("{:.1} GB", bytes as f64 / 1_000_000_000.0) + } else if bytes >= 1_000_000 { + format!("{:.1} MB", bytes as f64 / 1_000_000.0) + } else { + format!("{} KB", bytes / 1_000) + } } /// Fetch electrs indexed height via Electrum protocol (TCP JSON-RPC). @@ -100,6 +132,14 @@ async fn bitcoin_network_height() -> Result { /// Get electrs sync status. Runs blocking electrs call in spawn_blocking. pub async fn get_electrs_sync_status() -> ElectrsSyncStatus { + // Get index data size (non-blocking, fast filesystem stat) + let data_bytes = dir_size_bytes(ELECTRS_DATA_DIR); + let index_size = if data_bytes > 0 { + Some(format_bytes(data_bytes)) + } else { + None + }; + let network_height = match bitcoin_network_height().await { Ok(h) => h, Err(e) => { @@ -109,6 +149,7 @@ pub async fn get_electrs_sync_status() -> ElectrsSyncStatus { progress_pct: 0.0, status: "error".to_string(), error: Some(format!("Bitcoin RPC: {}", e)), + index_size, }; } }; @@ -119,19 +160,36 @@ pub async fn get_electrs_sync_status() -> ElectrsSyncStatus { // Electrs doesn't listen on 50001 until indexing completes (can take hours) let err_msg = e.to_string(); let (status, error) = if err_msg.contains("connect") || err_msg.contains("Connection refused") { + // Estimate progress from data directory size + let est_pct = if data_bytes > 0 { + ((data_bytes as f64 / ESTIMATED_FULL_INDEX_BYTES) * 100.0).min(99.0) + } else { + 0.0 + }; + let size_str = index_size.clone().unwrap_or_else(|| "0 MB".to_string()); ( "indexing".to_string(), - Some("Electrs is building the index. Electrum RPC will be available when indexing completes (may take hours).".to_string()), + Some(format!( + "Building index ({} / ~35 GB estimated). Electrum RPC will be available when complete.", + size_str + )), ) } else { ("error".to_string(), Some(format!("Electrs: {}", e))) }; + // Use estimated progress when indexing + let progress_pct = if status == "indexing" && data_bytes > 0 { + ((data_bytes as f64 / ESTIMATED_FULL_INDEX_BYTES) * 100.0).min(99.0) + } else { + 0.0 + }; return ElectrsSyncStatus { indexed_height: 0, network_height, - progress_pct: 0.0, + progress_pct, status, error, + index_size, }; } Err(e) => { @@ -141,6 +199,7 @@ pub async fn get_electrs_sync_status() -> ElectrsSyncStatus { progress_pct: 0.0, status: "error".to_string(), error: Some(format!("Task: {}", e)), + index_size, }; } }; @@ -163,5 +222,6 @@ pub async fn get_electrs_sync_status() -> ElectrsSyncStatus { progress_pct, status: status.to_string(), error: None, + index_size, } } diff --git a/docker/electrs-ui/index.html b/docker/electrs-ui/index.html index 54a1a829..a5a2bd41 100644 --- a/docker/electrs-ui/index.html +++ b/docker/electrs-ui/index.html @@ -5,11 +5,10 @@ Electrs - Archipelago -
-
+
-
-
- +
+
+

Electrs

-

Bitcoin Electrum indexer for Mempool & Electrum clients

+

Bitcoin Electrum indexer for Mempool & Electrum clients

-
+
-

Status

+

Status

Checking...

@@ -47,42 +99,42 @@
-
- +
+

Index Sync

-

Checking sync status...

+

Checking sync status...

-
+
Block 0 0%
-
-
+
+
-
+
-

Indexed Height

+

Indexed Height

-

-

Network Height

+

Network Height

-

-

Electrum RPC

-

localhost:50001

+

Index Size

+

-

-

Progress

+

Progress

-

@@ -92,49 +144,54 @@