devimint/
envs.rs

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