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 instructs the gateway to run in "debug mode",
30/// which allows errors to return to clients without redacting private
31/// information.
32pub const FM_DEBUG_GATEWAY_ENV: &str = "FM_DEBUG_GATEWAY";
33
34/// Environment variable that instructs the gateway to skip waiting for the
35/// bitcoin node to sync to the chain.
36pub const FM_GATEWAY_SKIP_WAIT_FOR_SYNC_ENV: &str = "FM_GATEWAY_SKIP_WAIT_FOR_SYNC";
37
38/// Environment variable to select database backend (rocksdb or cursed-redb)
39pub const FM_DB_BACKEND_ENV: &str = "FM_DB_BACKEND";
40
41/// The username to use when connecting to a bitcoin node over RPC
42pub const FM_BITCOIND_USERNAME_ENV: &str = "FM_BITCOIND_USERNAME";
43
44/// The password to use when connecting to a bitcoin node over RPC
45pub const FM_BITCOIND_PASSWORD_ENV: &str = "FM_BITCOIND_PASSWORD";
46
47/// The URL to use when connecting to a bitcoin node over RPC.
48/// Should not include authentication parameters: (e.g `http://127.0.0.1:8332`)
49pub const FM_BITCOIND_URL_ENV: &str = "FM_BITCOIND_URL";
50
51/// The URL to use when connecting to an Esplora server for bitcoin blockchain
52/// data
53pub const FM_ESPLORA_URL_ENV: &str = "FM_ESPLORA_URL";
54
55/// Environment variable for customizing the default routing fees
56pub const FM_DEFAULT_ROUTING_FEES_ENV: &str = "FM_DEFAULT_ROUTING_FEES";
57
58/// Environment variable for customizing the default transaction fees
59pub const FM_DEFAULT_TRANSACTION_FEES_ENV: &str = "FM_DEFAULT_TRANSACTION_FEES";