Struct fedimint_core::admin_client::WsAdminClient

pub struct WsAdminClient {
    pub url: SafeUrl,
    /* private fields */
}

For a guardian to communicate with their server

Fields

url: SafeUrl

Implementations

impl WsAdminClient

pub fn new(url: SafeUrl) -> Self

pub async fn set_password(&self, auth: ApiAuth) -> FederationResult<()>

Sets the password used to decrypt the configs and authenticate

Must be called first before any other calls to the API

pub async fn set_config_gen_connections( &self, info: ConfigGenConnectionsRequest, auth: ApiAuth ) -> FederationResult<()>

During config gen, sets the server connection containing our endpoints

Optionally sends our server info to the config gen leader using add_config_gen_peer

pub async fn add_config_gen_peer( &self, peer: PeerServerParams ) -> FederationResult<()>

During config gen, used for an API-to-API call that adds a peer’s server connection info to the leader.

Note this call will fail until the leader has their API running and has set_server_connections so clients should retry.

This call is not authenticated because it’s guardian-to-guardian

pub async fn get_config_gen_peers( &self ) -> FederationResult<Vec<PeerServerParams>>

During config gen, gets all the server connections we’ve received from peers using add_config_gen_peer

Could be called on the leader, so it’s not authenticated

pub async fn get_default_config_gen_params( &self, auth: ApiAuth ) -> FederationResult<ConfigGenParamsRequest>

Gets the default config gen params which can be configured by the leader, gives them a template to modify

pub async fn set_config_gen_params( &self, requested: ConfigGenParamsRequest, auth: ApiAuth ) -> FederationResult<()>

Leader sets the consensus params, everyone sets the local params

After calling this ConfigGenParams can be created for DKG

pub async fn consensus_config_gen_params( &self ) -> FederationResult<ConfigGenParamsResponse>

Returns the consensus config gen params, followers will delegate this call to the leader. Once this endpoint returns successfully we can run DKG.

pub async fn run_dkg(&self, auth: ApiAuth) -> FederationResult<()>

Runs DKG, can only be called once after configs have been generated in get_consensus_config_gen_params. If DKG fails this returns a 500 error and config gen must be restarted.

pub async fn get_verify_config_hash( &self, auth: ApiAuth ) -> FederationResult<BTreeMap<PeerId, Hash>>

After DKG, returns the hash of the consensus config tweaked with our id. We need to share this with all other peers to complete verification.

pub async fn start_consensus(&self, auth: ApiAuth) -> FederationResult<()>

Reads the configs from the disk, starts the consensus server, and shuts down the config gen API to start the Fedimint API

Clients may receive an error due to forced shutdown, should call the server_status to see if consensus has started.

pub async fn status(&self) -> FederationResult<StatusResponse>

Returns the status of the server

pub async fn audit(&self, auth: ApiAuth) -> FederationResult<AuditSummary>

Show an audit across all modules

pub async fn auth(&self, auth: ApiAuth) -> FederationResult<()>

Check auth credentials