Struct ln_gateway::Gateway

pub struct Gateway {
    pub state: Arc<RwLock<GatewayState>>,
    pub gateway_id: PublicKey,
    /* private fields */
}

Fields

state: Arc<RwLock<GatewayState>>

gateway_id: PublicKey

Implementations

impl Gateway

pub async fn new_with_custom_registry( lightning_builder: Arc<dyn LightningBuilder + Send + Sync>, client_builder: GatewayClientBuilder, listen: SocketAddr, api_addr: SafeUrl, cli_password: Option<String>, network: Option<Network>, fees: RoutingFees, num_route_hints: u32, gateway_db: Database, ) -> Result<Gateway>

pub async fn new_with_default_modules() -> Result<Gateway>

pub async fn new( lightning_builder: Arc<dyn LightningBuilder + Send + Sync>, gateway_parameters: GatewayParameters, gateway_db: Database, client_builder: GatewayClientBuilder, ) -> Result<Gateway>

pub async fn get_gateway_id(gateway_db: Database) -> PublicKey

pub async fn dump_database<'a>( dbtx: &mut DatabaseTransaction<'_>, prefix_names: Vec<String>, ) -> Box<dyn Iterator<Item = (String, Box<dyn Serialize + Send>)> + 'a>

pub async fn run(self, tg: &mut TaskGroup) -> Result<TaskShutdownToken>

pub async fn handle_htlc_stream( &self, stream: RouteHtlcStream<'_>, handle: TaskHandle, )

pub async fn handle_get_info(&self) -> Result<GatewayInfo>

pub async fn handle_get_federation_config( &self, federation_id: Option<FederationId>, ) -> Result<GatewayFedConfig>

pub async fn handle_balance_msg( &self, payload: BalancePayload, ) -> Result<Amount>

pub async fn handle_address_msg( &self, payload: DepositAddressPayload, ) -> Result<Address>

pub async fn handle_withdraw_msg( &self, payload: WithdrawPayload, ) -> Result<Txid>

pub async fn handle_leave_federation( &mut self, payload: LeaveFedPayload, ) -> Result<FederationInfo>

pub async fn handle_backup_msg(&self, __arg1: BackupPayload) -> Result<()>

pub async fn handle_restore_msg(&self, __arg1: RestorePayload) -> Result<()>

pub async fn handle_set_configuration_msg( &self, __arg1: SetConfigurationPayload, ) -> Result<()>

pub async fn remove_client_hack( &self, federation_id: FederationId, ) -> Result<Spanned<ClientHandleArc>>

pub async fn select_client( &self, federation_id: FederationId, ) -> Result<Spanned<ClientHandleArc>>

pub async fn get_lightning_context( &self, ) -> Result<LightningContext, LightningRpcError>

Checks the Gateway’s current state and returns the proper LightningContext if it is available. Sometimes the lightning node will not be connected and this will return an error.

pub async fn leave_all_federations(&self)

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

Trait Implementations

impl Clone for Gateway

fn clone(&self) -> Gateway

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Gateway

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

Formats the value using the given formatter.