ln_gateway/
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 URL to connect to LND. Necessary for
24/// LND configuration.
25pub const FM_LND_RPC_ADDR_ENV: &str = "FM_LND_RPC_ADDR";
26
27/// Environment variable that specifies the location of LND's TLS certificate.
28/// Necessary for LND configuration.
29pub const FM_LND_TLS_CERT_ENV: &str = "FM_LND_TLS_CERT";
30
31/// Environment variable that specifies the location of LND's macaroon.
32/// Necessary for LND configuration.
33pub const FM_LND_MACAROON_ENV: &str = "FM_LND_MACAROON";
34
35/// Environment variable that specifies the URL of an Esplora server.
36/// Necessary for LDK configuration if using esplora as the backend.
37pub const FM_LDK_ESPLORA_SERVER_URL: &str = "FM_LDK_ESPLORA_SERVER_URL";
38
39/// Environment variable that specifies the bitcoind node.
40/// Necessary for LDK configuration if using bitcoind as the backend.
41pub const FM_LDK_BITCOIND_RPC_URL: &str = "FM_LDK_BITCOIND_RPC_URL";
42
43/// Environment variable that specifies the Bitcoin network that the LDK Node
44/// should use. Must match `FM_GATEWAY_NETWORK`. Necessary for LDK
45/// configuration.
46pub const FM_LDK_NETWORK: &str = "FM_LDK_NETWORK";
47
48/// Environment variable the specifies the port that the LDK Node should use.
49/// Necessary for LDK configuration.
50pub const FM_PORT_LDK: &str = "FM_PORT_LDK";
51
52/// Environment variable that specifies the mnemonic that the gateway should use
53/// for ecash and the LDK Node should use for onchain funds. If not set, a
54/// mnemonic will be generated. This environment variable can be used for
55/// recovering from an existing mnemonic.
56pub const FM_GATEWAY_MNEMONIC_ENV: &str = "FM_GATEWAY_MNEMONIC";
57
58/// Environment variable that specifies the "module mode" the gateway should run
59/// in. Options are "LNv1", "LNv2", or "All". It is not recommended to run "All"
60/// in production so that clients are not able to use the same gateway to create
61/// LNv1 and LNv2 invoices.
62pub const FM_GATEWAY_LIGHTNING_MODULE_MODE_ENV: &str = "FM_GATEWAY_LIGHTNING_MODULE_MODE";
63
64/// Environment variable that instructs the gateway to run in "debug mode",
65/// which allows errors to return to clients without redacting private
66/// information.
67pub const FM_DEBUG_GATEWAY_ENV: &str = "FM_DEBUG_GATEWAY";
68
69pub const FM_GATEWAY_SKIP_WAIT_FOR_SYNC_ENV: &str = "FM_GATEWAY_SKIP_WAIT_FOR_SYNC";
ln_gateway/envs.rs

ln_gateway/
envs.rs
