make esplora url configurable (#490)

zupzup · web-flow · commit 6cb15a5338fa · 2025-04-30T10:00:32.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# 0.3.8
+
+* Add `esplora_base_url` as config parameter to be able to use a custom esplora based block explorer
+* Add `node_ids` filter to `list` notifications endpoint
+* Fixed an issue where events weren't propagated if no one was subscribed to the push notifications
+* Run payment checks on startup
+
 # 0.3.7
 
 * Fix request recourse to accept validation - does not require a request to accept anymore
diff --git a/crates/bcr-ebill-api/Cargo.toml b/crates/bcr-ebill-api/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcr-ebill-api"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 
 [lib]
diff --git a/crates/bcr-ebill-api/src/external/bitcoin.rs b/crates/bcr-ebill-api/src/external/bitcoin.rs
@@ -79,21 +79,21 @@ impl BitcoinClient {
     pub fn request_url(&self, path: &str) -> String {
         match get_config().bitcoin_network() {
             Network::Bitcoin => {
-                format!("https://blockstream.info/api{path}")
+                format!("{}/api{path}", get_config().esplora_base_url)
             }
             _ => {
-                format!("https://blockstream.info/testnet/api{path}")
+                format!("{}/testnet/api{path}", get_config().esplora_base_url)
             }
         }
     }
 
     pub fn link_url(&self, path: &str) -> String {
         match get_config().bitcoin_network() {
             Network::Bitcoin => {
-                format!("https://blockstream.info{path}")
+                format!("{}{path}", get_config().esplora_base_url)
             }
             _ => {
-                format!("https://blockstream.info/testnet{path}")
+                format!("{}/testnet{path}", get_config().esplora_base_url)
             }
         }
     }
diff --git a/crates/bcr-ebill-api/src/lib.rs b/crates/bcr-ebill-api/src/lib.rs
@@ -23,6 +23,7 @@ pub use persistence::notification::NotificationFilter;
 #[derive(Debug, Clone)]
 pub struct Config {
     pub bitcoin_network: String,
+    pub esplora_base_url: String,
     pub nostr_relay: String,
     pub surreal_db_connection: String,
     pub data_dir: String,
diff --git a/crates/bcr-ebill-api/src/tests/mod.rs b/crates/bcr-ebill-api/src/tests/mod.rs
@@ -315,6 +315,7 @@ pub mod tests {
             None => {
                 crate::init(crate::Config {
                     bitcoin_network: "mainnet".to_string(),
+                    esplora_base_url: "https://blockstream.info".to_string(),
                     nostr_relay: "ws://localhost:8080".to_string(),
                     surreal_db_connection: "ws://localhost:8800".to_string(),
                     data_dir: ".".to_string(),
diff --git a/crates/bcr-ebill-core/Cargo.toml b/crates/bcr-ebill-core/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcr-ebill-core"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 
 [lib]
diff --git a/crates/bcr-ebill-persistence/Cargo.toml b/crates/bcr-ebill-persistence/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcr-ebill-persistence"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 
 [lib]
diff --git a/crates/bcr-ebill-transport/Cargo.toml b/crates/bcr-ebill-transport/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcr-ebill-transport"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 
 [lib]
diff --git a/crates/bcr-ebill-wasm/Cargo.toml b/crates/bcr-ebill-wasm/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcr-ebill-wasm"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 
 [lib]
diff --git a/crates/bcr-ebill-wasm/main.js b/crates/bcr-ebill-wasm/main.js
@@ -31,6 +31,7 @@ async function start() {
   let config = {
     log_level: "debug",
     bitcoin_network: "testnet",
+    esplora_base_url: "https://blockstream.info",
     nostr_relay: "wss://bitcr-cloud-run-05-550030097098.europe-west1.run.app",
     job_runner_initial_delay_seconds: 1,
     job_runner_check_interval_seconds: 600,
diff --git a/crates/bcr-ebill-wasm/src/lib.rs b/crates/bcr-ebill-wasm/src/lib.rs
@@ -27,6 +27,7 @@ mod job;
 pub struct Config {
     pub log_level: Option<String>,
     pub bitcoin_network: String,
+    pub esplora_base_url: String,
     pub nostr_relay: String,
     pub job_runner_initial_delay_seconds: u32,
     pub job_runner_check_interval_seconds: u32,
@@ -60,6 +61,7 @@ pub async fn initialize_api(
     console_log::init_with_level(log_level).expect("can initialize logging");
     let api_config = ApiConfig {
         bitcoin_network: config.bitcoin_network,
+        esplora_base_url: config.esplora_base_url,
         nostr_relay: config.nostr_relay,
         surreal_db_connection: SURREAL_DB_CON_INDXDB_DATA.to_owned(),
         data_dir: "./".to_owned(), // unused in wasm
@@ -89,9 +91,10 @@ pub async fn initialize_api(
     // start jobs
     wasm_bindgen_futures::spawn_local(async move {
         TimeoutFuture::new(config.job_runner_initial_delay_seconds * 1000).await;
+        run_jobs(); // initial run
         IntervalStream::new(config.job_runner_check_interval_seconds * 1000)
             .for_each(|_| {
-                run_jobs();
+                run_jobs(); // regular run
                 ready(())
             })
             .await;
diff --git a/crates/bcr-ebill-web/Cargo.toml b/crates/bcr-ebill-web/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bcr-ebill-web"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 
 [dependencies]
diff --git a/crates/bcr-ebill-web/src/config.rs b/crates/bcr-ebill-web/src/config.rs
@@ -30,6 +30,8 @@ pub struct Config {
     pub frontend_url_path: String,
     #[arg(default_value_t = false, long, env = "LAUNCH_FRONTEND_AT_STARTUP")]
     pub launch_frontend_at_startup: bool,
+    #[arg(default_value_t = String::from("https://blockstream.info"), long, env = "ESPLORA_BASE_URL")]
+    pub esplora_base_url: String,
 }
 
 impl Config {
diff --git a/crates/bcr-ebill-web/src/main.rs b/crates/bcr-ebill-web/src/main.rs
@@ -31,6 +31,7 @@ async fn main() -> Result<()> {
     // Initialize the API
     let api_config = bcr_ebill_api::Config {
         bitcoin_network: conf.bitcoin_network.clone(),
+        esplora_base_url: conf.esplora_base_url.clone(),
         nostr_relay: conf.nostr_relay.clone(),
         surreal_db_connection: conf.surreal_db_connection.clone(),
         data_dir: conf.data_dir.clone(),
diff --git a/docs/wasm_configuration.md b/docs/wasm_configuration.md
@@ -6,6 +6,7 @@ The application can be configured using the `Config` struct.
 pub struct Config {
     pub bitcoin_network: String,
     pub nostr_relay: String,
+    pub esplora_base_url: String,
     pub surreal_db_connection: String,
     pub data_dir: String,
     pub job_runner_initial_delay_seconds: u32,
@@ -16,6 +17,7 @@ pub struct Config {
 It contains the following options:
 
 * `bitcoin_network` - bitcoin network to use, possible values: `mainnet`, `regtest` and `testnet`
+* `esplora_base_url` - bitcoin explorer base url for payment checks
 * `nostr_relay` - nostr relay endpoint
 * `surreal_db_connection` - the surreal DB connection
 * `data_dir` - the data directory root - not used on the Web
@@ -27,6 +29,7 @@ It contains the following options:
 ```javascript
     let config = {
         bitcoin_network: "testnet",
+        esplora_base_url: "https://blockstream.info",
         nostr_relay: "wss://bitcr-cloud-run-05-550030097098.europe-west1.run.app",
         surreal_db_connection: "indxdb://default",
         data_dir: ".",
diff --git a/docs/web_configuration.md b/docs/web_configuration.md
@@ -17,6 +17,7 @@ The following options are available:
 * `FRONTEND_URL_PATH` - default path to serve the frontend from (default: /)
 * `FRONTEND_SERVE_FOLDER` - folder where the static frontend is served from (default: ./frontend)
 * `LAUNCH_FRONTEND_AT_STARTUP` - open the frontend in a browser on startup (default: false)
+* `ESPLORA_BASE_URL` - The base url of the esplora URL for payment checks (default: https://blockstream.info)
 
 ## Example
 

Original file line number	Diff line number	Diff line change
`@@ -79,21 +79,21 @@ impl BitcoinClient {`
`79`	`79`	`pub fn request_url(&self, path: &str) -> String {`
`80`	`80`	`match get_config().bitcoin_network() {`
`81`	`81`	`Network::Bitcoin => {`
`82`		`- format!("https://blockstream.info/api{path}")`
	`82`	`+ format!("{}/api{path}", get_config().esplora_base_url)`
`83`	`83`	`}`
`84`	`84`	`_ => {`
`85`		`- format!("https://blockstream.info/testnet/api{path}")`
	`85`	`+ format!("{}/testnet/api{path}", get_config().esplora_base_url)`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`pub fn link_url(&self, path: &str) -> String {`
`91`	`91`	`match get_config().bitcoin_network() {`
`92`	`92`	`Network::Bitcoin => {`
`93`		`- format!("https://blockstream.info{path}")`
	`93`	`+ format!("{}{path}", get_config().esplora_base_url)`
`94`	`94`	`}`
`95`	`95`	`_ => {`
`96`		`- format!("https://blockstream.info/testnet{path}")`
	`96`	`+ format!("{}/testnet{path}", get_config().esplora_base_url)`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`	`}`