devimint/
envs.rs

1// gatewayd.rs
2
3// Env variable to TODO
4pub const FM_GATEWAY_DATA_DIR_ENV: &str = "FM_GATEWAY_DATA_DIR";
5
6// Env variable to TODO
7pub const FM_GATEWAY_LISTEN_ADDR_ENV: &str = "FM_GATEWAY_LISTEN_ADDR";
8
9// Env variable to TODO
10pub const FM_GATEWAY_API_ADDR_ENV: &str = "FM_GATEWAY_API_ADDR";
11
12// federation.rs
13
14// Env variable to set client's data directory
15pub const FM_DATA_DIR_ENV: &str = "FM_DATA_DIR";
16
17// Env variable to set the working directory of the client containing the config
18// and db
19pub const FM_CLIENT_DIR_ENV: &str = "FM_CLIENT_DIR";
20
21// cli.rs
22
23// Env variable to set the testing directory of the client
24pub const FM_TEST_DIR_ENV: &str = "FM_TEST_DIR";
25
26// Env variable to set the size of the federation
27pub const FM_FED_SIZE_ENV: &str = "FM_FED_SIZE";
28
29// Env variable to set the number of federations to allocate for the test/run
30pub const FM_NUM_FEDS_ENV: &str = "FM_NUM_FEDS";
31
32// Env variable to create a link to the test dir under this path
33pub const FM_LINK_TEST_DIR_ENV: &str = "FM_LINK_TEST_DIR";
34
35// Env variable to run a degraded federation with FM_OFFLINE_NODES shutdown
36pub const FM_OFFLINE_NODES_ENV: &str = "FM_OFFLINE_NODES";
37
38// Fix base port for federation (fedimintds) port range
39pub const FM_FEDERATIONS_BASE_PORT_ENV: &str = "FM_FEDERATIONS_BASE_PORT";
40
41// Fix base port for gateway (gatewayd) port range
42pub const FM_GATEWAY_BASE_PORT_ENV: &str = "FM_GATEWAY_BASE_PORT";
43
44// Env variable to set a federation's invite code
45pub const FM_INVITE_CODE_ENV: &str = "FM_INVITE_CODE";
46
47// Env variable to stop in a pre-dkg stage of devimint
48pub const FM_PRE_DKG_ENV: &str = "FM_PRE_DKG";
49
50// util.rs
51
52// Env variable to override gatewayd binary set:
53pub const FM_GATEWAYD_BASE_EXECUTABLE_ENV: &str = "FM_GATEWAYD_BASE_EXECUTABLE";
54
55// Env variable to override override fedimintd binary set:
56pub const FM_FEDIMINTD_BASE_EXECUTABLE_ENV: &str = "FM_FEDIMINTD_BASE_EXECUTABLE";
57
58// Env variable to override fedimint-cli binary set:
59pub const FM_FEDIMINT_CLI_BASE_EXECUTABLE_ENV: &str = "FM_FEDIMINT_CLI_BASE_EXECUTABLE";
60
61// Env variable to override fedimint-cli default command
62// (like "$FM_FEDIMINT_CLI_BASE_EXECUTABLE --data-dir /tmp/xxx ....")
63// set:
64pub const FM_MINT_CLIENT_ENV: &str = "FM_MINT_CLIENT";
65
66// Env variable to override gateway-cli binary set:
67pub const FM_GATEWAY_CLI_BASE_EXECUTABLE_ENV: &str = "FM_GATEWAY_CLI_BASE_EXECUTABLE";
68
69// Env variable to override fedimint-load-test-tool binary set:
70pub const FM_LOAD_TEST_TOOL_BASE_EXECUTABLE_ENV: &str = "FM_LOAD_TEST_TOOL_BASE_EXECUTABLE";
71
72// Env variable to override lncli binary set:
73pub const FM_LNCLI_BASE_EXECUTABLE_ENV: &str = "FM_LNCLI_BASE_EXECUTABLE";
74
75// Env variable to override lncli default command set:
76pub const FM_LNCLI_ENV: &str = "FM_LNCLI";
77
78// Env variable to override bitcoin-cli binary set:
79pub const FM_BITCOIN_CLI_BASE_EXECUTABLE_ENV: &str = "FM_BITCOIN_CLI_BASE_EXECUTABLE";
80
81// Env variable to override bitcoin-cli default command set:
82pub const FM_BTC_CLIENT_ENV: &str = "FM_BTC_CLIENT";
83
84// Env variable to override bitcoind binary set:
85pub const FM_BITCOIND_BASE_EXECUTABLE_ENV: &str = "FM_BITCOIND_BASE_EXECUTABLE";
86
87// Env variable to override lnd binary set:
88pub const FM_LND_BASE_EXECUTABLE_ENV: &str = "FM_LND_BASE_EXECUTABLE";
89
90// Env variable to override esplora binary set:
91pub const FM_ESPLORA_BASE_EXECUTABLE_ENV: &str = "FM_ESPLORA_BASE_EXECUTABLE";
92
93// Env variable to override esplora binary set:
94pub const FM_RECOVERYTOOL_BASE_EXECUTABLE_ENV: &str = "FM_RECOVERYTOOL_BASE_EXECUTABLE";
95
96// Env variable to override esplora binary set:
97pub const FM_DEVIMINT_FAUCET_BASE_EXECUTABLE_ENV: &str = "FM_DEVIMINT_FAUCET_BASE_EXECUTABLE";
98
99// Env variable to override esplora binary set:
100pub const FM_FEDIMINT_DBTOOL_BASE_EXECUTABLE_ENV: &str = "FM_FEDIMINT_DBTOOL_BASE_EXECUTABLE";
101
102// Env variable to set the logs directory
103pub const FM_LOGS_DIR_ENV: &str = "FM_LOGS_DIR";
104
105// Env variable to TODO
106pub const FM_BACKWARDS_COMPATIBILITY_TEST_ENV: &str = "FM_BACKWARDS_COMPATIBILITY_TEST";
107
108// Env variable to define command for the Gateway LND client
109pub const FM_GWCLI_LND_ENV: &str = "FM_GWCLI_LND";
110
111// Env variable to define command for the Gateway LDK client
112pub const FM_GWCLI_LDK_ENV: &str = "FM_GWCLI_LDK";
113
114/// Make `devimint` print stderr of called commands directly on its own stderr
115pub const FM_DEVIMINT_CMD_INHERIT_STDERR_ENV: &str = "FM_DEVIMINT_CMD_INHERIT_STDERR";
116
117/// Force devimint to run a test with a deprecated configuration
118pub const FM_DEVIMINT_RUN_DEPRECATED_TESTS_ENV: &str = "FM_DEVIMINT_RUN_DEPRECATED_TESTS";
119
120/// Devimint's "data dir" (think `/usr/devimint/`).
121///
122/// "Static" because we use "data dir" for the directory `devimint` puts all the
123/// runtime state in, which is typically a per-invocation temporary directory.
124///
125/// Can be set during `cargo build` to force the default one, then available in
126/// Rust code during building, and also checked at runtime to allow
127/// overwriting.
128pub const FM_DEVIMINT_STATIC_DATA_DIR_ENV: &str = "FM_DEVIMINT_STATIC_DATA_DIR";
129
130/// Override LDK's Lightning port
131pub const FM_PORT_LDK_ENV: &str = "FM_PORT_LDK";
132
133// recurringd.rs
134
135// Env variable for recurringd bind address
136pub const FM_RECURRING_BIND_ADDRESS_ENV: &str = "FM_RECURRING_BIND_ADDRESS";
137
138// Env variable for recurringd API address
139pub const FM_RECURRING_API_ADDRESS_ENV: &str = "FM_RECURRING_API_ADDRESS";
140
141// Env variable for recurringd data directory
142pub const FM_RECURRING_DATA_DIR_ENV: &str = "FM_RECURRING_DATA_DIR";
143
144// Env variable for recurringd API bearer token
145pub const FM_RECURRING_API_BEARER_TOKEN_ENV: &str = "FM_RECURRING_API_BEARER_TOKEN";
146
147// Env variable to override recurringd binary set:
148pub const FM_RECURRINGD_BASE_EXECUTABLE_ENV: &str = "FM_RECURRINGD_BASE_EXECUTABLE";
149
150// Env variable to override the iroh listen addr for the gateway
151pub const FM_GATEWAY_IROH_LISTEN_ADDR_ENV: &str = "FM_GATEWAY_IROH_LISTEN_ADDR";
152
153// Env variable to set the metrics listen addr for the gateway
154pub const FM_GATEWAY_METRICS_LISTEN_ADDR_ENV: &str = "FM_GATEWAY_METRICS_LISTEN_ADDR";
devimint/envs.rs

devimint/
envs.rs
