fedimint_testing/
federation.rs

1use std::collections::BTreeMap;
2use std::sync::Arc;
3use std::time::Duration;
4
5use fedimint_api_client::api::{DynGlobalApi, FederationApiExt};
6use fedimint_client::module_init::ClientModuleInitRegistry;
7use fedimint_client::{Client, ClientHandleArc, RootSecret};
8use fedimint_client_module::AdminCreds;
9use fedimint_client_module::secret::{PlainRootSecretStrategy, RootSecretStrategy};
10use fedimint_connectors::ConnectorRegistry;
11use fedimint_core::PeerId;
12use fedimint_core::config::{ClientConfig, FederationId};
13use fedimint_core::core::ModuleKind;
14use fedimint_core::db::Database;
15use fedimint_core::db::mem_impl::MemDatabase;
16use fedimint_core::endpoint_constants::SESSION_COUNT_ENDPOINT;
17use fedimint_core::invite_code::InviteCode;
18use fedimint_core::module::{ApiAuth, ApiRequestErased};
19use fedimint_core::net::peers::IP2PConnections;
20use fedimint_core::rustls::install_crypto_provider;
21use fedimint_core::task::{TaskGroup, block_in_place, sleep_in_test};
22use fedimint_gateway_common::ConnectFedPayload;
23use fedimint_gateway_server::{Gateway, IAdminGateway};
24use fedimint_logging::LOG_TEST;
25use fedimint_rocksdb::RocksDb;
26use fedimint_server::config::ServerConfig;
27use fedimint_server::core::ServerModuleInitRegistry;
28use fedimint_server::net::api::ApiSecrets;
29use fedimint_server::net::p2p::{ReconnectP2PConnections, p2p_status_channels};
30use fedimint_server::net::p2p_connector::{IP2PConnector, TlsTcpConnector};
31use fedimint_server::{ConnectionLimits, consensus};
32use fedimint_server_core::bitcoin_rpc::DynServerBitcoinRpc;
33use fedimint_testing_core::config::local_config_gen_params;
34use tracing::info;
35
36/// Test fixture for a running fedimint federation
37#[derive(Clone)]
38pub struct FederationTest {
39    configs: BTreeMap<PeerId, ServerConfig>,
40    server_init: ServerModuleInitRegistry,
41    client_init: ClientModuleInitRegistry,
42    _task: TaskGroup,
43    num_peers: u16,
44    num_offline: u16,
45    connectors: ConnectorRegistry,
46}
47
48impl FederationTest {
49    /// Create two clients, useful for send/receive tests
50    pub async fn two_clients(&self) -> (ClientHandleArc, ClientHandleArc) {
51        (self.new_client().await, self.new_client().await)
52    }
53
54    /// Create a client connected to this fed
55    pub async fn new_client(&self) -> ClientHandleArc {
56        let client_config = self.configs[&PeerId::from(0)]
57            .consensus
58            .to_client_config(&self.server_init)
59            .unwrap();
60
61        self.new_client_with(client_config, MemDatabase::new().into(), None)
62            .await
63    }
64
65    /// Create a client connected to this fed but using RocksDB instead of MemDB
66    pub async fn new_client_rocksdb(&self) -> ClientHandleArc {
67        let client_config = self.configs[&PeerId::from(0)]
68            .consensus
69            .to_client_config(&self.server_init)
70            .unwrap();
71
72        self.new_client_with(
73            client_config,
74            RocksDb::build(tempfile::tempdir().expect("Couldn't create temp dir"))
75                .open()
76                .await
77                .expect("Couldn't open DB")
78                .into(),
79            None,
80        )
81        .await
82    }
83
84    /// Create a new admin api for the given PeerId
85    pub async fn new_admin_api(&self, peer_id: PeerId) -> anyhow::Result<DynGlobalApi> {
86        let config = self.configs.get(&peer_id).expect("peer to have config");
87
88        DynGlobalApi::new_admin(
89            ConnectorRegistry::build_from_testing_env()?.bind().await?,
90            peer_id,
91            config.consensus.api_endpoints()[&peer_id].url.clone(),
92            None,
93        )
94    }
95
96    /// Create a new admin client connected to this fed
97    pub async fn new_admin_client(&self, peer_id: PeerId, auth: ApiAuth) -> ClientHandleArc {
98        let client_config = self.configs[&PeerId::from(0)]
99            .consensus
100            .to_client_config(&self.server_init)
101            .unwrap();
102
103        let admin_creds = AdminCreds { peer_id, auth };
104
105        self.new_client_with(client_config, MemDatabase::new().into(), Some(admin_creds))
106            .await
107    }
108
109    pub async fn new_client_with(
110        &self,
111        client_config: ClientConfig,
112        db: Database,
113        admin_creds: Option<AdminCreds>,
114    ) -> ClientHandleArc {
115        info!(target: LOG_TEST, "Setting new client with config");
116        let mut client_builder = Client::builder().await.expect("Failed to build client");
117        client_builder.with_module_inits(self.client_init.clone());
118        if let Some(admin_creds) = admin_creds {
119            client_builder.set_admin_creds(admin_creds);
120        }
121        let client_secret = Client::load_or_generate_client_secret(&db).await.unwrap();
122        client_builder
123            .preview_with_existing_config(self.connectors.clone(), client_config, None)
124            .await
125            .expect("Preview failed")
126            .join(
127                db,
128                RootSecret::StandardDoubleDerive(PlainRootSecretStrategy::to_root_secret(
129                    &client_secret,
130                )),
131            )
132            .await
133            .map(Arc::new)
134            .expect("Failed to build client")
135    }
136
137    /// Return first invite code for gateways
138    pub fn invite_code(&self) -> InviteCode {
139        self.configs[&PeerId::from(0)].get_invite_code(None)
140    }
141
142    ///  Return the federation id
143    pub fn id(&self) -> FederationId {
144        self.configs[&PeerId::from(0)]
145            .consensus
146            .to_client_config(&self.server_init)
147            .unwrap()
148            .global
149            .calculate_federation_id()
150    }
151
152    /// Connects a gateway to this `FederationTest`
153    pub async fn connect_gateway(&self, gw: &Gateway) {
154        gw.handle_connect_federation(ConnectFedPayload {
155            invite_code: self.invite_code().to_string(),
156            use_tor: Some(false),
157            recover: Some(false),
158        })
159        .await
160        .expect("Failed to connect federation");
161    }
162
163    /// Return all online PeerIds
164    pub fn online_peer_ids(&self) -> impl Iterator<Item = PeerId> + use<> {
165        // we can assume this ordering since peers are started in ascending order
166        (0..(self.num_peers - self.num_offline)).map(PeerId::from)
167    }
168
169    /// Returns true if the federation is running in a degraded state
170    pub fn is_degraded(&self) -> bool {
171        self.num_offline > 0
172    }
173}
174
175/// Builder struct for creating a `FederationTest`.
176#[derive(Clone, Debug)]
177pub struct FederationTestBuilder {
178    num_peers: u16,
179    num_offline: u16,
180    base_port: u16,
181    primary_module_kind: ModuleKind,
182    version_hash: String,
183    server_init: ServerModuleInitRegistry,
184    client_init: ClientModuleInitRegistry,
185    bitcoin_rpc_connection: DynServerBitcoinRpc,
186    enable_mint_fees: bool,
187}
188
189impl FederationTestBuilder {
190    pub fn new(
191        server_init: ServerModuleInitRegistry,
192        client_init: ClientModuleInitRegistry,
193        primary_module_kind: ModuleKind,
194        num_offline: u16,
195        bitcoin_rpc_connection: DynServerBitcoinRpc,
196    ) -> FederationTestBuilder {
197        let num_peers = 4;
198        Self {
199            num_peers,
200            num_offline,
201            base_port: block_in_place(|| fedimint_portalloc::port_alloc(num_peers * 3))
202                .expect("Failed to allocate a port range"),
203            primary_module_kind,
204            version_hash: "fedimint-testing-dummy-version-hash".to_owned(),
205            server_init,
206            client_init,
207            bitcoin_rpc_connection,
208            enable_mint_fees: true,
209        }
210    }
211
212    pub fn num_peers(mut self, num_peers: u16) -> FederationTestBuilder {
213        self.num_peers = num_peers;
214        self
215    }
216
217    pub fn num_offline(mut self, num_offline: u16) -> FederationTestBuilder {
218        self.num_offline = num_offline;
219        self
220    }
221
222    pub fn base_port(mut self, base_port: u16) -> FederationTestBuilder {
223        self.base_port = base_port;
224        self
225    }
226
227    pub fn primary_module_kind(mut self, primary_module_kind: ModuleKind) -> FederationTestBuilder {
228        self.primary_module_kind = primary_module_kind;
229        self
230    }
231
232    pub fn version_hash(mut self, version_hash: String) -> FederationTestBuilder {
233        self.version_hash = version_hash;
234        self
235    }
236
237    pub fn disable_mint_fees(mut self) -> FederationTestBuilder {
238        self.enable_mint_fees = false;
239        self
240    }
241
242    #[allow(clippy::too_many_lines)]
243    pub async fn build(self) -> FederationTest {
244        install_crypto_provider().await;
245        let num_offline = self.num_offline;
246        assert!(
247            self.num_peers > 3 * self.num_offline,
248            "too many peers offline ({num_offline}) to reach consensus"
249        );
250        let peers = (0..self.num_peers).map(PeerId::from).collect::<Vec<_>>();
251        let params = local_config_gen_params(
252            &peers,
253            self.base_port,
254            self.enable_mint_fees,
255            &self.server_init,
256        )
257        .expect("Generates local config");
258
259        let configs =
260            ServerConfig::trusted_dealer_gen(&params, &self.server_init, &self.version_hash);
261
262        let task_group = TaskGroup::new();
263        for (peer_id, cfg) in configs.clone() {
264            let peer_port = self.base_port + u16::from(peer_id) * 3;
265
266            let p2p_bind = format!("127.0.0.1:{peer_port}").parse().unwrap();
267            let api_bind = format!("127.0.0.1:{}", peer_port + 1).parse().unwrap();
268            let ui_bind = format!("127.0.0.1:{}", peer_port + 2).parse().unwrap();
269
270            if u16::from(peer_id) >= self.num_peers - self.num_offline {
271                continue;
272            }
273
274            let instances = cfg.consensus.iter_module_instances();
275            let decoders = self.server_init.available_decoders(instances).unwrap();
276            let db = Database::new(MemDatabase::new(), decoders);
277            let module_init_registry = self.server_init.clone();
278            let subgroup = task_group.make_subgroup();
279            let checkpoint_dir = tempfile::Builder::new().tempdir().unwrap().keep();
280            let code_version_str = env!("CARGO_PKG_VERSION");
281
282            let connector = TlsTcpConnector::new(
283                cfg.tls_config(),
284                p2p_bind,
285                cfg.local.p2p_endpoints.clone(),
286                cfg.local.identity,
287            )
288            .await
289            .into_dyn();
290
291            let (p2p_status_senders, p2p_status_receivers) = p2p_status_channels(connector.peers());
292
293            let connections = ReconnectP2PConnections::new(
294                cfg.local.identity,
295                connector,
296                &task_group,
297                p2p_status_senders,
298            )
299            .into_dyn();
300
301            let bitcoin_rpc_connection = self.bitcoin_rpc_connection.clone();
302
303            task_group.spawn("fedimintd", move |_| async move {
304                Box::pin(consensus::run(
305                    ConnectorRegistry::build_from_testing_env()
306                        .unwrap()
307                        .bind()
308                        .await
309                        .unwrap(),
310                    connections,
311                    p2p_status_receivers,
312                    api_bind,
313                    None,
314                    vec![],
315                    cfg.clone(),
316                    db.clone(),
317                    module_init_registry,
318                    &subgroup,
319                    ApiSecrets::default(),
320                    checkpoint_dir,
321                    code_version_str.to_string(),
322                    bitcoin_rpc_connection,
323                    ui_bind,
324                    Box::new(|_| axum::Router::new()),
325                    1,
326                    ConnectionLimits {
327                        max_connections: 1000,
328                        max_requests_per_connection: 100,
329                    },
330                ))
331                .await
332                .expect("Could not initialise consensus");
333            });
334        }
335
336        for (peer_id, config) in configs.clone() {
337            if u16::from(peer_id) >= self.num_peers - self.num_offline {
338                continue;
339            }
340
341            let connectors = ConnectorRegistry::build_from_testing_env()
342                .unwrap()
343                .bind()
344                .await
345                .unwrap();
346            let api = DynGlobalApi::new_admin(
347                connectors,
348                peer_id,
349                config.consensus.api_endpoints()[&peer_id].url.clone(),
350                None,
351            )
352            .unwrap();
353
354            while let Err(e) = api
355                .request_admin_no_auth::<u64>(SESSION_COUNT_ENDPOINT, ApiRequestErased::default())
356                .await
357            {
358                sleep_in_test(
359                    format!("Waiting for api of peer {peer_id} to come online: {e}"),
360                    Duration::from_millis(500),
361                )
362                .await;
363            }
364        }
365
366        FederationTest {
367            configs,
368            server_init: self.server_init,
369            client_init: self.client_init,
370            _task: task_group,
371            num_peers: self.num_peers,
372            num_offline: self.num_offline,
373            connectors: ConnectorRegistry::build_from_testing_env()
374                .expect("Failed to initialize endpoints for testing (env)")
375                .bind()
376                .await
377                .expect("Failed to initialize endpoints for testing"),
378        }
379    }
380}
fedimint_testing/federation.rs

fedimint_testing/
federation.rs
