Struct ConsensusApi

pub struct ConsensusApi {
    pub cfg: ServerConfig,
    pub db: Database,
    pub modules: ServerModuleRegistry,
    pub client_cfg: ClientConfig,
    pub force_api_secret: Option<String>,
    pub submission_sender: Sender<ConsensusItem>,
    pub shutdown_receiver: Receiver<Option<u64>>,
    pub shutdown_sender: Sender<Option<u64>>,
    pub connection_status_channels: Arc<RwLock<BTreeMap<PeerId, PeerConnectionStatus>>>,
    pub last_ci_by_peer: Arc<RwLock<BTreeMap<PeerId, u64>>>,
    pub supported_api_versions: SupportedApiVersionsSummary,
    pub code_version_str: String,
}

Fields

cfg: ServerConfig

Our server configuration

db: Database

Database for serving the API

modules: ServerModuleRegistry

Modules registered with the federation

client_cfg: ClientConfig

Cached client config

force_api_secret: Option<String>

submission_sender: Sender<ConsensusItem>

For sending API events to consensus such as transactions

shutdown_receiver: Receiver<Option<u64>>

shutdown_sender: Sender<Option<u64>>

connection_status_channels: Arc<RwLock<BTreeMap<PeerId, PeerConnectionStatus>>>

last_ci_by_peer: Arc<RwLock<BTreeMap<PeerId, u64>>>

supported_api_versions: SupportedApiVersionsSummary

code_version_str: String

Implementations

impl ConsensusApi

pub fn api_versions_summary(&self) -> &SupportedApiVersionsSummary

pub fn get_active_api_secret(&self) -> Option<String>

pub async fn submit_transaction( &self, transaction: Transaction, ) -> Result<TransactionId, TransactionError>

pub async fn await_transaction( &self, txid: TransactionId, ) -> (Vec<ModuleInstanceId>, DatabaseTransaction<'_, Committable>)

pub async fn await_output_outcome( &self, outpoint: OutPoint, ) -> Result<SerdeModuleEncoding<DynOutputOutcome>>

pub async fn session_count(&self) -> u64

pub async fn await_signed_session_outcome( &self, index: u64, ) -> SignedSessionOutcome

pub async fn session_status(&self, session_index: u64) -> SessionStatus

pub async fn get_federation_status(&self) -> ApiResult<FederationStatus>

fn shutdown(&self, index: Option<u64>)

async fn get_federation_audit( &self, _auth: &GuardianAuthToken, ) -> ApiResult<AuditSummary>

fn get_guardian_config_backup( &self, password: &str, _auth: &GuardianAuthToken, ) -> GuardianConfigBackup

Uses the in-memory config to write a config backup tar archive that guardians can download. Private keys are encrypted with the guardian password, so it should be safe to store anywhere, this also means the backup is useless without the password.

async fn handle_backup_request<'s, 'dbtx, 'a>( &'s self, dbtx: &'dbtx mut DatabaseTransaction<'a>, request: SignedBackupRequest, ) -> Result<(), ApiError>

async fn handle_recover_request( &self, dbtx: &mut DatabaseTransaction<'_>, id: PublicKey, ) -> Option<ClientBackupSnapshot>

async fn api_announcements(&self) -> BTreeMap<PeerId, SignedApiAnnouncement>

List API URL announcements from all peers we have received them from (at least ourselves)

fn fedimintd_version(&self) -> String

Returns the tagged fedimintd version currently running

async fn submit_api_announcement( &self, peer_id: PeerId, announcement: SignedApiAnnouncement, ) -> Result<(), ApiError>

Add an API URL announcement from a peer to our database to be returned by ConsensusApi::api_announcements.

async fn sign_api_announcement(&self, new_url: SafeUrl) -> SignedApiAnnouncement

Trait Implementations

impl Clone for ConsensusApi

fn clone(&self) -> ConsensusApi

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl HasApiContext<ConsensusApi> for ConsensusApi

fn context<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 ApiRequestErased, id: Option<ModuleInstanceId>, ) -> Pin<Box<dyn Future<Output = (&ConsensusApi, ApiEndpointContext<'_>)> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl HasApiContext<DynServerModule> for ConsensusApi

fn context<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 ApiRequestErased, id: Option<ModuleInstanceId>, ) -> Pin<Box<dyn Future<Output = (&DynServerModule, ApiEndpointContext<'_>)> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,