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/// Use to allow `process_output` to process RBF withdrawal outputs.
87pub fn is_rbf_withdrawal_enabled() -> bool {
88    is_env_var_set("FM_UNSAFE_ENABLE_RBF_WITHDRAWAL")
89}
90
91/// Use to disable automatic consensus version voting for testing and
92/// development environments
93pub fn is_automatic_consensus_version_voting_disabled() -> bool {
94    is_env_var_set(FM_WALLET_DISABLE_AUTOMATIC_CONSENSUS_VERSION_VOTING_ENV)
95}
96
97/// Get value of `FEDIMINT_BUILD_CODE_VERSION` at compile time
98#[macro_export]
99macro_rules! fedimint_build_code_version_env {
100    () => {
101        env!("FEDIMINT_BUILD_CODE_VERSION")
102    };
103}
104
105/// Env var for bitcoin RPC kind (obsolete, use FM_DEFAULT_* instead)
106pub const FM_BITCOIN_RPC_KIND_ENV: &str = "FM_BITCOIN_RPC_KIND";
107/// Env var for bitcoin URL (obsolete, use FM_DEFAULT_* instead)
108pub const FM_BITCOIN_RPC_URL_ENV: &str = "FM_BITCOIN_RPC_URL";
109/// Env var how often to poll bitcoin source
110pub const FM_BITCOIN_POLLING_INTERVAL_SECS_ENV: &str = "FM_BITCOIN_POLLING_INTERVAL_SECS";
111
112/// Env var for bitcoin RPC kind (default, used only as a default value for DKG
113/// config settings)
114pub const FM_DEFAULT_BITCOIN_RPC_KIND_ENV: &str = "FM_DEFAULT_BITCOIN_RPC_KIND";
115pub const FM_DEFAULT_BITCOIN_RPC_KIND_BAD_ENV: &str = "FM_DEFAULT_BITCOIND_RPC_KIND";
116/// Env var for bitcoin URL (default, used only as a default value for DKG
117/// config settings)
118pub const FM_DEFAULT_BITCOIN_RPC_URL_ENV: &str = "FM_DEFAULT_BITCOIN_RPC_URL";
119pub const FM_DEFAULT_BITCOIN_RPC_URL_BAD_ENV: &str = "FM_DEFAULT_BITCOIND_RPC_URL";
120
121/// Env var for bitcoin RPC kind (forced, takes priority over config settings)
122pub const FM_FORCE_BITCOIN_RPC_KIND_ENV: &str = "FM_FORCE_BITCOIN_RPC_KIND";
123pub const FM_FORCE_BITCOIN_RPC_KIND_BAD_ENV: &str = "FM_FORCE_BITCOIND_RPC_BAD_KIND";
124/// Env var for bitcoin URL (default, takes priority over config settings)
125pub const FM_FORCE_BITCOIN_RPC_URL_ENV: &str = "FM_FORCE_BITCOIN_RPC_URL";
126pub const FM_FORCE_BITCOIN_RPC_URL_BAD_ENV: &str = "FM_FORCE_BITCOIND_RPC_URL";
127
128/// Env var to override iroh connectivity, in the legacy iroh 0.35 `NodeTicket`
129/// format.
130///
131/// Comma separated key-value list
132/// (`<node_id>=<ticket>,<node_id>=<ticket>,...`). Only still read by pre-0.12
133/// binaries that link iroh 0.35; current binaries
134/// read [`FM_IROH_CONNECT_OVERRIDES_PLAIN_ENV`] instead. iroh 1.0 no longer
135/// ships the `NodeTicket` format, so the override format had to become version
136/// agnostic; rather than overload this var with two incompatible formats, the
137/// new format lives under its own name and both are emitted side by side.
138pub const FM_IROH_CONNECT_OVERRIDES_ENV: &str = "FM_IROH_CONNECT_OVERRIDES";
139
140/// Env var to override iroh connectivity, in the legacy iroh 0.35 `NodeTicket`
141/// format. Gateway counterpart of [`FM_IROH_CONNECT_OVERRIDES_ENV`].
142pub const FM_GW_IROH_CONNECT_OVERRIDES_ENV: &str = "FM_GW_IROH_CONNECT_OVERRIDES";
143
144/// Env var to override iroh connectivity, in the plain `<id>=<addr>` format.
145///
146/// Comma separated key-value list (`<node_id>=<socket_addr>,...`). The value is
147/// a single direct address; the consumer rebuilds the iroh node/endpoint
148/// address from the id and address, so the format works on both iroh 0.35 and
149/// iroh 1.0. Current binaries read this; pre-0.12 binaries read the legacy
150/// [`FM_IROH_CONNECT_OVERRIDES_ENV`] instead.
151pub const FM_IROH_CONNECT_OVERRIDES_PLAIN_ENV: &str = "FM_IROH_CONNECT_OVERRIDES_PLAIN";
152
153/// Env var to override iroh connectivity, in the plain `<id>=<addr>` format.
154/// Gateway counterpart of [`FM_IROH_CONNECT_OVERRIDES_PLAIN_ENV`].
155pub const FM_GW_IROH_CONNECT_OVERRIDES_PLAIN_ENV: &str = "FM_GW_IROH_CONNECT_OVERRIDES_PLAIN";
156
157/// Env var to override iroh DNS server
158pub const FM_IROH_DNS_ENV: &str = "FM_IROH_DNS";
159
160/// Env var to override iroh relays server
161pub const FM_IROH_RELAY_ENV: &str = "FM_IROH_RELAY";
162
163/// Env var to disable Iroh's use of DHT
164pub const FM_IROH_DHT_ENABLE_ENV: &str = "FM_IROH_DHT_ENABLE";
165
166/// Env var to disable default n0 discovery
167pub const FM_IROH_N0_DISCOVERY_ENABLE_ENV: &str = "FM_IROH_N0_DISCOVERY_ENABLE";
168
169/// Env var to disable default pkarr resolver
170pub const FM_IROH_PKARR_RESOLVER_ENABLE_ENV: &str = "FM_IROH_PKARR_RESOLVER_ENABLE";
171
172/// Env var to disable default pkarr publisher
173pub const FM_IROH_PKARR_PUBLISHER_ENABLE_ENV: &str = "FM_IROH_PKARR_PUBLISHER_ENABLE";
174
175/// Env var to disable Iroh's use of relays
176pub const FM_IROH_RELAYS_ENABLE_ENV: &str = "FM_IROH_RELAYS_ENABLE";
177
178/// Env var to disable all pkarr publishing (enabled by default)
179pub const FM_PKARR_ENABLE_ENV: &str = "FM_PKARR_ENABLE";
180
181/// Env var to enable pkarr DHT publishing (disabled by default)
182pub const FM_PKARR_DHT_ENABLE_ENV: &str = "FM_PKARR_DHT_ENABLE";
183
184/// Env var to disable pkarr relay publishing (enabled by default)
185pub const FM_PKARR_RELAYS_ENABLE_ENV: &str = "FM_PKARR_RELAYS_ENABLE";
186
187/// Env var to override tcp api connectivity
188///
189/// Comma separated key-value list (`peer_id=url,peer_id=url`)
190pub const FM_WS_API_CONNECT_OVERRIDES_ENV: &str = "FM_WS_API_CONNECT_OVERRIDES";
191
192pub const FM_IROH_API_SECRET_KEY_OVERRIDE_ENV: &str = "FM_IROH_API_SECRET_KEY_OVERRIDE";
193pub const FM_IROH_P2P_SECRET_KEY_OVERRIDE_ENV: &str = "FM_IROH_P2P_SECRET_KEY_OVERRIDE";
194
195/// List of json api endpoint sources to use as a source of
196/// fee rate estimation.
197///
198/// `;`-separated list of urls with part after `#`
199/// ("fragment") specifying jq filter to extract sats/vB fee rate.
200/// Eg. `https://mempool.space/api/v1/fees/recommended#.halfHourFee`
201///
202/// Note that `#` is a standalone separator and *not* parsed as a part of the
203/// Url. Which means there's no need to escape it.
204pub const FM_WALLET_FEERATE_SOURCES_ENV: &str = "FM_WALLET_FEERATE_SOURCES";
205
206/// `devimint` will set when code is running inside `devimint`
207pub const FM_IN_DEVIMINT_ENV: &str = "FM_IN_DEVIMINT";
208
209/// Configuration for the bitcoin RPC
210#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize, Encodable, Decodable)]
211pub struct BitcoinRpcConfig {
212    pub kind: String,
213    pub url: SafeUrl,
214}
215
216impl BitcoinRpcConfig {
217    pub fn get_defaults_from_env_vars() -> anyhow::Result<Self> {
218        Ok(Self {
219        kind: env::var(FM_FORCE_BITCOIN_RPC_KIND_ENV)
220            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_KIND_ENV))
221            .or_else(|_| env::var(FM_BITCOIN_RPC_KIND_ENV).inspect(|_v| {
222                warn!(target: LOG_CORE, "{FM_BITCOIN_RPC_KIND_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_KIND_ENV} instead");
223            }))
224            .or_else(|_| env::var(FM_FORCE_BITCOIN_RPC_KIND_BAD_ENV).inspect(|_v| {
225                warn!(target: LOG_CORE, "{FM_FORCE_BITCOIN_RPC_KIND_BAD_ENV} is obsolete, use {FM_FORCE_BITCOIN_RPC_KIND_ENV} instead");
226            }))
227            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_KIND_BAD_ENV).inspect(|_v| {
228                warn!(target: LOG_CORE, "{FM_DEFAULT_BITCOIN_RPC_KIND_BAD_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_KIND_ENV} instead");
229            }))
230            .with_context(|| {
231                anyhow::anyhow!("failure looking up env var for Bitcoin RPC kind")
232            })?,
233        url: env::var(FM_FORCE_BITCOIN_RPC_URL_ENV)
234            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_URL_ENV))
235            .or_else(|_| env::var(FM_BITCOIN_RPC_URL_ENV).inspect(|_v| {
236                warn!(target: LOG_CORE, "{FM_BITCOIN_RPC_URL_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_URL_ENV} instead");
237            }))
238            .or_else(|_| env::var(FM_FORCE_BITCOIN_RPC_URL_BAD_ENV).inspect(|_v| {
239                warn!(target: LOG_CORE, "{FM_FORCE_BITCOIN_RPC_URL_BAD_ENV} is obsolete, use {FM_FORCE_BITCOIN_RPC_URL_ENV} instead");
240            }))
241            .or_else(|_| env::var(FM_DEFAULT_BITCOIN_RPC_URL_BAD_ENV).inspect(|_v| {
242                warn!(target: LOG_CORE, "{FM_DEFAULT_BITCOIN_RPC_URL_BAD_ENV} is obsolete, use {FM_DEFAULT_BITCOIN_RPC_URL_ENV} instead");
243            }))
244            .with_context(|| {
245                anyhow::anyhow!("failure looking up env var for Bitcoin RPC URL")
246            })?
247            .parse()
248            .with_context(|| {
249                anyhow::anyhow!("failure parsing Bitcoin RPC URL")
250            })?,
251    })
252    }
253}
254
255pub fn parse_kv_list_from_env<K, V>(env: &str) -> anyhow::Result<BTreeMap<K, V>>
256where
257    K: FromStr + cmp::Ord,
258    <K as FromStr>::Err: std::error::Error,
259    V: FromStr,
260    <V as FromStr>::Err: std::error::Error,
261{
262    let mut map = BTreeMap::new();
263    let Ok(env_value) = std::env::var(env) else {
264        return Ok(BTreeMap::new());
265    };
266    for kv in env_value.split(',') {
267        let kv = kv.trim();
268
269        if kv.is_empty() {
270            continue;
271        }
272
273        if let Some((k, v)) = kv.split_once('=') {
274            let Some(k) = K::from_str(k)
275                .inspect_err(|err| {
276                    warn!(
277                        target: LOG_CORE,
278                        err = %err.fmt_compact(),
279                        "Error parsing value"
280                    );
281                })
282                .ok()
283            else {
284                continue;
285            };
286            let Some(v) = V::from_str(v)
287                .inspect_err(|err| {
288                    warn!(
289                        target: LOG_CORE,
290                        err = %err.fmt_compact(),
291                        "Error parsing value"
292                    );
293                })
294                .ok()
295            else {
296                continue;
297            };
298
299            map.insert(k, v);
300        }
301    }
302
303    Ok(map)
304}
fedimint_core/envs.rs

fedimint_core/
envs.rs
