fedimint_gateway_server/envs.rs
1/// Environment variable that specifies the directory of the gateway's database.
2pub const FM_GATEWAY_DATA_DIR_ENV: &str = "FM_GATEWAY_DATA_DIR";
3
4/// Environment variable that specifies the address the gateway's HTTP server
5/// should listen on.
6pub const FM_GATEWAY_LISTEN_ADDR_ENV: &str = "FM_GATEWAY_LISTEN_ADDR";
7
8/// Environment variable that specifies the URL that clients can use to make
9/// requests to the gateway.
10pub const FM_GATEWAY_API_ADDR_ENV: &str = "FM_GATEWAY_API_ADDR";
11
12/// Environment variable that specifies the bcrypt password hash.
13pub const FM_GATEWAY_BCRYPT_PASSWORD_HASH_ENV: &str = "FM_GATEWAY_BCRYPT_PASSWORD_HASH";
14
15/// Environment variable that specifies that Bitcoin network that the gateway
16/// should use. Must match the network of the Lightning node.
17pub const FM_GATEWAY_NETWORK_ENV: &str = "FM_GATEWAY_NETWORK";
18
19/// Environment variable that instructs the gateway how many route hints to
20/// include in LNv1 invoices.
21pub const FM_NUMBER_OF_ROUTE_HINTS_ENV: &str = "FM_NUMBER_OF_ROUTE_HINTS";
22
23/// Environment variable that specifies the mnemonic that the gateway should use
24/// for ecash and the LDK Node should use for onchain funds. If not set, a
25/// mnemonic will be generated. This environment variable can be used for
26/// recovering from an existing mnemonic.
27pub const FM_GATEWAY_MNEMONIC_ENV: &str = "FM_GATEWAY_MNEMONIC";
28
29/// Environment variable that specifies the "module mode" the gateway should run
30/// in. Options are "LNv1", "LNv2", or "All". It is not recommended to run "All"
31/// in production so that clients are not able to use the same gateway to create
32/// LNv1 and LNv2 invoices.
33pub const FM_GATEWAY_LIGHTNING_MODULE_MODE_ENV: &str = "FM_GATEWAY_LIGHTNING_MODULE_MODE";
34
35/// Environment variable that instructs the gateway to run in "debug mode",
36/// which allows errors to return to clients without redacting private
37/// information.
38pub const FM_DEBUG_GATEWAY_ENV: &str = "FM_DEBUG_GATEWAY";
39
40/// Environment variable that instructs the gateway to skip waiting for the
41/// bitcoin node to sync to the chain.
42pub const FM_GATEWAY_SKIP_WAIT_FOR_SYNC_ENV: &str = "FM_GATEWAY_SKIP_WAIT_FOR_SYNC";
43
44/// Environment variable that instructs the gateway to skip checking if the
45/// Bitcoin network is set to mainnet and the lightning module mode is set to
46/// `All`
47pub const FM_GATEWAY_OVERRIDE_LN_MODULE_CHECK_ENV: &str = "FM_GATEWAY_OVERRIDE_LN_MODULE_CHECK";