fedimint_core/
envs.rs

1use std::collections::BTreeMap;
2use std::str::FromStr;
3use std::{cmp, env};
4
5use anyhow::Context;
6use fedimint_core::util::SafeUrl;
7use fedimint_derive::{Decodable, Encodable};
8use fedimint_logging::LOG_CORE;
9use jsonrpsee_core::Serialize;
10use serde::Deserialize;
11use tracing::warn;
12
13use crate::util::FmtCompact as _;
14
15/// In tests we want to routinely enable an extra unknown module to ensure
16/// all client code handles correct modules that client doesn't know about.
17pub const FM_USE_UNKNOWN_MODULE_ENV: &str = "FM_USE_UNKNOWN_MODULE";
18
19/// Disable automatic consensus version voting for testing and development
20/// environments
21pub const FM_WALLET_DISABLE_AUTOMATIC_CONSENSUS_VERSION_VOTING_ENV: &str =
22    "FM_WALLET_DISABLE_AUTOMATIC_CONSENSUS_VERSION_VOTING";
23
24pub const FM_ENABLE_MODULE_LNV1_ENV: &str = "FM_ENABLE_MODULE_LNV1";
25pub const FM_ENABLE_MODULE_LNV2_ENV: &str = "FM_ENABLE_MODULE_LNV2";
26pub const FM_ENABLE_MODULE_MINT_ENV: &str = "FM_ENABLE_MODULE_MINT";
27pub const FM_ENABLE_MODULE_MINTV2_ENV: &str = "FM_ENABLE_MODULE_MINTV2";
28pub const FM_ENABLE_MODULE_WALLET_ENV: &str = "FM_ENABLE_MODULE_WALLET";
29pub const FM_ENABLE_MODULE_WALLETV2_ENV: &str = "FM_ENABLE_MODULE_WALLETV2";
30
31/// Disable mint base fees for testing and development environments
32pub const FM_DISABLE_BASE_FEES_ENV: &str = "FM_DISABLE_BASE_FEES";
33
34/// Print sensitive secrets without redacting them. Use only for debugging.
35pub const FM_DEBUG_SHOW_SECRETS_ENV: &str = "FM_DEBUG_SHOW_SECRETS";
36
37/// Check if env variable is set and not equal `0` or `false` which are common
38/// ways to disable something.
39pub fn is_env_var_set(var: &str) -> bool {
40    let Some(val) = std::env::var_os(var) else {
41        return false;
42    };
43    match val.as_encoded_bytes() {
44        b"0" | b"false" => false,
45        b"1" | b"true" => true,
46        _ => {
47            warn!(
48                target: LOG_CORE,
49                %var,
50                val = %val.to_string_lossy(),
51                "Env var value invalid is invalid and ignored, assuming `true`"
52            );
53            true
54        }
55    }
56}
57
58/// Check if env variable is set and not equal `0` or `false` which are common
59/// ways to disable a setting. `None` if env var not set at all, which allows
60/// handling the default value.
61pub fn is_env_var_set_opt(var: &str) -> Option<bool> {
62    let val = std::env::var_os(var)?;
63    match val.as_encoded_bytes() {
64        b"0" | b"false" => Some(false),
65        b"1" | b"true" => Some(true),
66        _ => {
67            warn!(
68                target: LOG_CORE,
69                %var,
70                val = %val.to_string_lossy(),
71                "Env var value invalid is invalid and ignored"
72            );
73            None
74        }
75    }
76}
77
78/// Use to detect if running in a test environment, either `cargo test` or
79/// `devimint`.
80pub fn is_running_in_test_env() -> bool {
81    let unit_test = cfg!(test);
82
83    unit_test || is_env_var_set("NEXTEST") || is_env_var_set(FM_IN_DEVIMINT_ENV)
84}
85
86/// How long to wait before polling peers for their supported module consensus
87/// version again.
88///
89/// The first poll of a freshly started process races the peers' API servers
90/// binding and normally loses, so a round that failed to reach everyone is
91/// retried soon rather than after the full interval -- otherwise activation is
92/// dead for that interval after every restart. A peer that stays unreachable is
93/// then polled at the short interval indefinitely, which is a few requests per
94/// minute.
95pub fn next_poll_delay(reached_all_peers: bool) -> std::time::Duration {
96    if is_running_in_test_env() {
97        std::time::Duration::from_secs(5)
98    } else if reached_all_peers {
99        std::time::Duration::from_secs(600)
100    } else {
101        std::time::Duration::from_secs(30)
102    }
103}
104
105/// Use to disable automatic consensus version voting for testing and
106/// development environments
107pub fn is_automatic_consensus_version_voting_disabled() -> bool {
108    is_env_var_set(FM_WALLET_DISABLE_AUTOMATIC_CONSENSUS_VERSION_VOTING_ENV)
109}
110
111/// Get value of `FEDIMINT_BUILD_CODE_VERSION` at compile time
112#[macro_export]
113macro_rules! fedimint_build_code_version_env {
114    () => {
115        env!("FEDIMINT_BUILD_CODE_VERSION")
116    };
117}
118
119/// Env var for bitcoin RPC kind (obsolete, use FM_DEFAULT_* instead)
120pub const FM_BITCOIN_RPC_KIND_ENV: &str = "FM_BITCOIN_RPC_KIND";
121/// Env var for bitcoin URL (obsolete, use FM_DEFAULT_* instead)
122pub const FM_BITCOIN_RPC_URL_ENV: &str = "FM_BITCOIN_RPC_URL";
123/// Env var how often to poll bitcoin source
124pub const FM_BITCOIN_POLLING_INTERVAL_SECS_ENV: &str = "FM_BITCOIN_POLLING_INTERVAL_SECS";
125
126/// Env var for bitcoin RPC kind (default, used only as a default value for DKG
127/// config settings)
128pub const FM_DEFAULT_BITCOIN_RPC_KIND_ENV: &str = "FM_DEFAULT_BITCOIN_RPC_KIND";
129pub const FM_DEFAULT_BITCOIN_RPC_KIND_BAD_ENV: &str = "FM_DEFAULT_BITCOIND_RPC_KIND";
130/// Env var for bitcoin URL (default, used only as a default value for DKG
131/// config settings)
132pub const FM_DEFAULT_BITCOIN_RPC_URL_ENV: &str = "FM_DEFAULT_BITCOIN_RPC_URL";
133pub const FM_DEFAULT_BITCOIN_RPC_URL_BAD_ENV: &str = "FM_DEFAULT_BITCOIND_RPC_URL";
134
135/// Env var for bitcoin RPC kind (forced, takes priority over config settings)
136pub const FM_FORCE_BITCOIN_RPC_KIND_ENV: &str = "FM_FORCE_BITCOIN_RPC_KIND";
137pub const FM_FORCE_BITCOIN_RPC_KIND_BAD_ENV: &str = "FM_FORCE_BITCOIND_RPC_BAD_KIND";
138/// Env var for bitcoin URL (default, takes priority over config settings)
139pub const FM_FORCE_BITCOIN_RPC_URL_ENV: &str = "FM_FORCE_BITCOIN_RPC_URL";
140pub const FM_FORCE_BITCOIN_RPC_URL_BAD_ENV: &str = "FM_FORCE_BITCOIND_RPC_URL";
141
142/// Env var to override iroh connectivity
143///
144/// Comma separated key-value list (`<node_id>=<ticket>,<node_id>=<ticket>,...`)
145pub const FM_IROH_CONNECT_OVERRIDES_ENV: &str = "FM_IROH_CONNECT_OVERRIDES";
146
147/// Env var to override iroh connectivity
148///
149/// Comma separated key-value list (`<node_id>=<ticket>,<node_id>=<ticket>,...`)
150pub const FM_GW_IROH_CONNECT_OVERRIDES_ENV: &str = "FM_GW_IROH_CONNECT_OVERRIDES";
151
152/// Env var to override iroh DNS server
153pub const FM_IROH_DNS_ENV: &str = "FM_IROH_DNS";
154
155/// Env var to override iroh relays server
156pub const FM_IROH_RELAY_ENV: &str = "FM_IROH_RELAY";
157
158/// Env var to disable Iroh's use of DHT
159pub const FM_IROH_DHT_ENABLE_ENV: &str = "FM_IROH_DHT_ENABLE";
160
161/// Env var to disable default n0 discovery
162pub const FM_IROH_N0_DISCOVERY_ENABLE_ENV: &str = "FM_IROH_N0_DISCOVERY_ENABLE";
163
164/// Env var to disable default pkarr resolver
165pub const FM_IROH_PKARR_RESOLVER_ENABLE_ENV: &str = "FM_IROH_PKARR_RESOLVER_ENABLE";
166
167/// Env var to disable default pkarr publisher
168pub const FM_IROH_PKARR_PUBLISHER_ENABLE_ENV: &str = "FM_IROH_PKARR_PUBLISHER_ENABLE";
169
170/// Env var to disable Iroh's use of relays
171pub const FM_IROH_RELAYS_ENABLE_ENV: &str = "FM_IROH_RELAYS_ENABLE";
172
173/// Env var to disable all pkarr publishing (enabled by default)
174pub const FM_PKARR_ENABLE_ENV: &str = "FM_PKARR_ENABLE";
175
176/// Env var to enable pkarr DHT publishing (disabled by default)
177pub const FM_PKARR_DHT_ENABLE_ENV: &str = "FM_PKARR_DHT_ENABLE";
178
179/// Env var to disable pkarr relay publishing (enabled by default)
180pub const FM_PKARR_RELAYS_ENABLE_ENV: &str = "FM_PKARR_RELAYS_ENABLE";
181
182/// Env var to override tcp api connectivity
183///
184/// Comma separated key-value list (`peer_id=url,peer_id=url`)
185pub const FM_WS_API_CONNECT_OVERRIDES_ENV: &str = "FM_WS_API_CONNECT_OVERRIDES";
186
187pub const FM_IROH_API_SECRET_KEY_OVERRIDE_ENV: &str = "FM_IROH_API_SECRET_KEY_OVERRIDE";
188pub const FM_IROH_P2P_SECRET_KEY_OVERRIDE_ENV: &str = "FM_IROH_P2P_SECRET_KEY_OVERRIDE";
189
190/// List of json api endpoint sources to use as a source of
191/// fee rate estimation.
192///
193/// `;`-separated list of urls with part after `#`
194/// ("fragment") specifying jq filter to extract sats/vB fee rate.
195/// Eg. `https://mempool.space/api/v1/fees/recommended#.halfHourFee`
196///
197/// Note that `#` is a standalone separator and *not* parsed as a part of the
198/// Url. Which means there's no need to escape it.
199pub const FM_WALLET_FEERATE_SOURCES_ENV: &str = "FM_WALLET_FEERATE_SOURCES";
200
201/// `devimint` will set when code is running inside `devimint`
202pub const FM_IN_DEVIMINT_ENV: &str = "FM_IN_DEVIMINT";
203
204/// Configuration for the bitcoin RPC
205#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize, Encodable, Decodable)]
206pub struct BitcoinRpcConfig {
207    pub kind: String,
208    pub url: SafeUrl,
209}
210
211impl BitcoinRpcConfig {
212    pub fn get_defaults_from_env_vars() -> anyhow::Result<Self> {
213        Ok(Self {
214        kind: env::var(FM_FORCE_BITCOIN_RPC_KIND_ENV)
215            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_KIND_ENV))
216            .or_else(|_| env::var(FM_BITCOIN_RPC_KIND_ENV).inspect(|_v| {
217                warn!(target: LOG_CORE, "{FM_BITCOIN_RPC_KIND_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_KIND_ENV} instead");
218            }))
219            .or_else(|_| env::var(FM_FORCE_BITCOIN_RPC_KIND_BAD_ENV).inspect(|_v| {
220                warn!(target: LOG_CORE, "{FM_FORCE_BITCOIN_RPC_KIND_BAD_ENV} is obsolete, use {FM_FORCE_BITCOIN_RPC_KIND_ENV} instead");
221            }))
222            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_KIND_BAD_ENV).inspect(|_v| {
223                warn!(target: LOG_CORE, "{FM_DEFAULT_BITCOIN_RPC_KIND_BAD_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_KIND_ENV} instead");
224            }))
225            .with_context(|| {
226                anyhow::anyhow!("failure looking up env var for Bitcoin RPC kind")
227            })?,
228        url: env::var(FM_FORCE_BITCOIN_RPC_URL_ENV)
229            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_URL_ENV))
230            .or_else(|_| env::var(FM_BITCOIN_RPC_URL_ENV).inspect(|_v| {
231                warn!(target: LOG_CORE, "{FM_BITCOIN_RPC_URL_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_URL_ENV} instead");
232            }))
233            .or_else(|_| env::var(FM_FORCE_BITCOIN_RPC_URL_BAD_ENV).inspect(|_v| {
234                warn!(target: LOG_CORE, "{FM_FORCE_BITCOIN_RPC_URL_BAD_ENV} is obsolete, use {FM_FORCE_BITCOIN_RPC_URL_ENV} instead");
235            }))
236            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_URL_BAD_ENV).inspect(|_v| {
237                warn!(target: LOG_CORE, "{FM_DEFAULT_BITCOIN_RPC_URL_BAD_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_URL_ENV} instead");
238            }))
239            .with_context(|| {
240                anyhow::anyhow!("failure looking up env var for Bitcoin RPC URL")
241            })?
242            .parse()
243            .with_context(|| {
244                anyhow::anyhow!("failure parsing Bitcoin RPC URL")
245            })?,
246    })
247    }
248}
249
250pub fn parse_kv_list_from_env<K, V>(env: &str) -> anyhow::Result<BTreeMap<K, V>>
251where
252    K: FromStr + cmp::Ord,
253    <K as FromStr>::Err: std::error::Error,
254    V: FromStr,
255    <V as FromStr>::Err: std::error::Error,
256{
257    let mut map = BTreeMap::new();
258    let Ok(env_value) = std::env::var(env) else {
259        return Ok(BTreeMap::new());
260    };
261    for kv in env_value.split(',') {
262        let kv = kv.trim();
263
264        if kv.is_empty() {
265            continue;
266        }
267
268        if let Some((k, v)) = kv.split_once('=') {
269            let Some(k) = K::from_str(k)
270                .inspect_err(|err| {
271                    warn!(
272                        target: LOG_CORE,
273                        err = %err.fmt_compact(),
274                        "Error parsing value"
275                    );
276                })
277                .ok()
278            else {
279                continue;
280            };
281            let Some(v) = V::from_str(v)
282                .inspect_err(|err| {
283                    warn!(
284                        target: LOG_CORE,
285                        err = %err.fmt_compact(),
286                        "Error parsing value"
287                    );
288                })
289                .ok()
290            else {
291                continue;
292            };
293
294            map.insert(k, v);
295        }
296    }
297
298    Ok(map)
299}
fedimint_core/envs.rs

fedimint_core/
envs.rs
