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 password. This is only applied if
13/// there is no password set, otherwise it is ignored.
14pub const FM_GATEWAY_PASSWORD_ENV: &str = "FM_GATEWAY_PASSWORD";
15
16/// Environment variable that specifies that Bitcoin network that the gateway
17/// should use. Must match the network of the Lightning node.
18pub const FM_GATEWAY_NETWORK_ENV: &str = "FM_GATEWAY_NETWORK";
19
20/// Environment variable that specifies the default routing fees the gateway
21/// takes for outgoing and incoming payments. Only applied to newly joined
22/// federations.
23pub const FM_DEFAULT_GATEWAY_FEES_ENV: &str = "FM_DEFAULT_GATEWAY_FEES";
24
25/// Environment variable that instructs the gateway how many route hints to
26/// include in LNv1 invoices.
27pub const FM_NUMBER_OF_ROUTE_HINTS_ENV: &str = "FM_NUMBER_OF_ROUTE_HINTS";
28
29/// Environment variable that specifies the URL to connect to LND. Necessary for
30/// LND configuration.
31pub const FM_LND_RPC_ADDR_ENV: &str = "FM_LND_RPC_ADDR";
32
33/// Environment variable that specifies the location of LND's TLS certificate.
34/// Necessary for LND configuration.
35pub const FM_LND_TLS_CERT_ENV: &str = "FM_LND_TLS_CERT";
36
37/// Environment variable that specifies the location of LND's macaroon.
38/// Necessary for LND configuration.
39pub const FM_LND_MACAROON_ENV: &str = "FM_LND_MACAROON";
40
41/// Environment variable that specifies the URL of an Esplora server. Necessary
42/// for LDK configuration.
43pub const FM_LDK_ESPLORA_SERVER_URL: &str = "FM_LDK_ESPLORA_SERVER_URL";
44
45/// Environment variable that specifies the Bitcoin network that the LDK Node
46/// should use. Must match `FM_GATEWAY_NETWORK`. Necessary for LDK
47/// configuration.
48pub const FM_LDK_NETWORK: &str = "FM_LDK_NETWORK";
49
50/// Environment variable the specifies the port that the LDK Node should use.
51/// Necessary for LDK configuration.
52pub const FM_PORT_LDK: &str = "FM_PORT_LDK";
53
54/// Environment variable that specifies the address that the Core Lightning
55/// extension should listen on. Will be removed in v0.6
56pub const FM_CLN_EXTENSION_LISTEN_ADDRESS_ENV: &str = "FM_CLN_EXTENSION_LISTEN_ADDRESS";
57
58/// Environment variable that specifies the URL that the gateway can use to
59/// connect to the Core Lightning extension. Will be removed in v0.6.
60pub const FM_GATEWAY_LIGHTNING_ADDR_ENV: &str = "FM_GATEWAY_LIGHTNING_ADDR";
61
62/// Environment variable that specifies the mnemonic that the gateway should use
63/// for ecash and the LDK Node should use for onchain funds. If not set, a
64/// mnemonic will be generated. This environment variable can be used for
65/// recovering from an existing mnemonic.
66pub const FM_GATEWAY_MNEMONIC_ENV: &str = "FM_GATEWAY_MNEMONIC";
67
68/// Environment variable that specifies the "module mode" the gateway should run
69/// in. Options are "LNv1", "LNv2", or "All". It is not recommended to run "All"
70/// in production so that clients are not able to use the same gateway to create
71/// LNv1 and LNv2 invoices.
72pub const FM_GATEWAY_LIGHTNING_MODULE_MODE_ENV: &str = "FM_GATEWAY_LIGHTNING_MODULE_MODE";
73
74/// Environment variable that instructs the gateway to run in "debug mode",
75/// which allows errors to return to clients without redacting private
76/// information.
77pub const FM_DEBUG_GATEWAY_ENV: &str = "FM_DEBUG_GATEWAY";
78
79pub const FM_GATEWAY_SKIP_WAIT_FOR_SYNC_ENV: &str = "FM_GATEWAY_SKIP_WAIT_FOR_SYNC";
ln_gateway/envs.rs

ln_gateway/
envs.rs
