devimint/
envs.rs

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