fedimint_api_client/
lib.rs

1#![deny(clippy::pedantic)]
2#![allow(clippy::missing_errors_doc)]
3#![allow(clippy::missing_panics_doc)]
4#![allow(clippy::module_name_repetitions)]
5#![allow(clippy::must_use_candidate)]
6#![allow(clippy::return_self_not_must_use)]
7
8use anyhow::{Context as _, bail};
9use api::{DynGlobalApi, FederationApiExt as _};
10use fedimint_connectors::ConnectorRegistry;
11use fedimint_connectors::error::ServerError;
12use fedimint_core::config::{ClientConfig, FederationId};
13use fedimint_core::endpoint_constants::CLIENT_CONFIG_ENDPOINT;
14use fedimint_core::invite_code::InviteCode;
15use fedimint_core::module::ApiRequestErased;
16use fedimint_core::util::backoff_util;
17use fedimint_logging::LOG_CLIENT_NET;
18use query::FilterMap;
19use tracing::debug;
20
21pub mod api;
22pub mod metrics;
23/// Client query system
24pub mod query;
25
26/// Tries to download the [`ClientConfig`], attempts to retry ten times before
27/// giving up.
28pub async fn download_from_invite_code(
29    endpoints: &ConnectorRegistry,
30    invite: &InviteCode,
31) -> anyhow::Result<(ClientConfig, DynGlobalApi)> {
32    debug!(
33        target: LOG_CLIENT_NET,
34        %invite,
35        peers = ?invite.peers(),
36        "Downloading client config via invite code"
37    );
38
39    let federation_id = invite.federation_id();
40    let api_from_invite = DynGlobalApi::new(
41        endpoints.clone(),
42        invite.peers(),
43        invite.api_secret().as_deref(),
44    )?;
45    let api_secret = invite.api_secret();
46
47    fedimint_core::util::retry(
48        "Downloading client config",
49        backoff_util::aggressive_backoff(),
50        || {
51            try_download_client_config(
52                endpoints,
53                &api_from_invite,
54                federation_id,
55                api_secret.clone(),
56            )
57        },
58    )
59    .await
60    .context("Failed to download client config")
61}
62
63/// Tries to download the [`ClientConfig`] only once.
64pub async fn try_download_client_config(
65    endpoints: &ConnectorRegistry,
66    api_from_invite: &DynGlobalApi,
67    federation_id: FederationId,
68    api_secret: Option<String>,
69) -> anyhow::Result<(ClientConfig, DynGlobalApi)> {
70    debug!(target: LOG_CLIENT_NET, "Downloading client config from peer");
71    // TODO: use new download approach based on guardian PKs
72    let query_strategy = FilterMap::new(move |cfg: ClientConfig| {
73        if federation_id != cfg.global.calculate_federation_id() {
74            return Err(ServerError::ConditionFailed(anyhow::anyhow!(
75                "FederationId in invite code does not match client config"
76            )));
77        }
78
79        Ok(cfg.global.api_endpoints)
80    });
81
82    let api_endpoints = api_from_invite
83        .request_with_strategy(
84            query_strategy,
85            CLIENT_CONFIG_ENDPOINT.to_owned(),
86            ApiRequestErased::default(),
87        )
88        .await?;
89
90    // now we can build an api for all guardians and download the client config
91    let api_endpoints = api_endpoints
92        .into_iter()
93        .map(|(peer, url)| (peer, url.url))
94        .collect();
95
96    debug!(target: LOG_CLIENT_NET, "Verifying client config with all peers");
97
98    let api_full = DynGlobalApi::new(endpoints.clone(), api_endpoints, api_secret.as_deref())?;
99    let client_config = api_full
100        .request_current_consensus::<ClientConfig>(
101            CLIENT_CONFIG_ENDPOINT.to_owned(),
102            ApiRequestErased::default(),
103        )
104        .await?;
105
106    if client_config.calculate_federation_id() != federation_id {
107        bail!("Obtained client config has different federation id");
108    }
109
110    Ok((client_config, api_full))
111}
fedimint_api_client/lib.rs

fedimint_api_client/
lib.rs
