Module envs

Expand description

Common environment variables

Structs§

FM_BITCOIND_COOKIE_FILE_ENV: Env var that can be set to point at the bitcoind’s cookie file to use for auth
FM_BITCOIN_RPC_KIND_ENV: Env var for bitcoin RPC kind (obsolete, use FM_DEFAULT_* instead)
FM_BITCOIN_RPC_URL_ENV: Env var for bitcoin URL (obsolete, use FM_DEFAULT_* instead)
FM_DEFAULT_BITCOIN_RPC_KIND_ENV: Env var for bitcoin RPC kind (default, used only as a default value for DKG config settings)
FM_DEFAULT_BITCOIN_RPC_URL_ENV: Env var for bitcoin URL (default, used only as a default value for DKG config settings)
FM_DEVIMINT_DISABLE_MODULE_LNV2_ENV: In certain devimint cases (e.g. upgrade tests), we’d like to test things without enabling lnv2. This should make deviming stop setting FM_ENABLE_MODULE_LNV2_ENV
FM_ENABLE_MODULE_LNV2_ENV
FM_FORCE_BITCOIN_RPC_KIND_ENV: Env var for bitcoin RPC kind (forced, takes priority over config settings)
FM_FORCE_BITCOIN_RPC_URL_ENV: Env var for bitcoin URL (default, takes priority over config settings)
FM_IN_DEVIMINT_ENV: devimint will set when code is running inside devimint
FM_USE_UNKNOWN_MODULE_ENV: In tests we want to routinely enable an extra unknown module to ensure all client code handles correct modules that client doesn’t know about.

is_env_var_set: Check if env variable is set and not equal 0 or false which are common ways to disable something.
is_rbf_withdrawal_enabled: Use to allow process_output to process RBF withdrawal outputs.
is_running_in_test_env: Use to detect if running in a test environment, either cargo test or devimint.