Struct FederationManager

pub struct FederationManager {
    clients: BTreeMap<FederationId, Spanned<ClientHandleArc>>,
    index_to_federation: BTreeMap<u64, FederationId>,
    next_index: AtomicU64,
}

Fields

clients: BTreeMap<FederationId, Spanned<ClientHandleArc>>

Map of FederationId -> Client. Used for efficient retrieval of the client while handling incoming HTLCs.

index_to_federation: BTreeMap<u64, FederationId>

Map of federation indices to FederationId. Use for efficient retrieval of the client while handling incoming HTLCs. Can be removed after LNv1 removal.

next_index: AtomicU64

Tracker for federation index assignments. When connecting a new federation, this value is incremented and assigned to the federation as the federation_index

Implementations

impl FederationManager

pub fn new() -> Self

pub fn add_client(&mut self, index: u64, client: Spanned<ClientHandleArc>)

pub async fn leave_federation( &mut self, federation_id: FederationId, dbtx: &mut DatabaseTransaction<'_, NonCommittable>, ) -> AdminResult<FederationInfo>

async fn remove_client( &mut self, federation_id: FederationId, ) -> AdminResult<()>

pub async fn wait_for_incoming_payments(&self) -> AdminResult<()>

Waits for ongoing incoming LNv1 and LNv2 payments to complete before returning.

async fn unannounce_from_federation( &self, federation_id: FederationId, gateway_keypair: Keypair, ) -> AdminResult<()>

pub async fn unannounce_from_all_federations(&self, gateway_keypair: Keypair)

Iterates through all of the federations the gateway is registered with and requests to remove the registration record.

pub fn get_client_for_index( &self, short_channel_id: u64, ) -> Option<Spanned<ClientHandleArc>>

pub fn get_client_for_federation_id_prefix( &self, federation_id_prefix: FederationIdPrefix, ) -> Option<Spanned<ClientHandleArc>>

pub fn has_federation(&self, federation_id: FederationId) -> bool

pub fn client( &self, federation_id: &FederationId, ) -> Option<&Spanned<ClientHandleArc>>

pub async fn federation_info( &self, federation_id: FederationId, dbtx: &mut DatabaseTransaction<'_, NonCommittable>, ) -> Result<FederationInfo, FederationNotConnected>

pub async fn federation_name(&self, client: &ClientHandleArc) -> Option<String>

pub async fn federation_info_all_federations( &self, dbtx: DatabaseTransaction<'_, NonCommittable>, ) -> Vec<FederationInfo>

pub async fn get_federation_config( &self, federation_id: FederationId, ) -> AdminResult<JsonClientConfig>

pub async fn get_all_federation_configs( &self, ) -> BTreeMap<FederationId, JsonClientConfig>

pub fn set_next_index(&self, next_index: u64)

pub fn pop_next_index(&self) -> AdminResult<u64>

Trait Implementations

impl Debug for FederationManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.