Struct Gateway

pub struct Gateway {
    pub(crate) federation_manager: Arc<RwLock<FederationManager>>,
    pub(crate) lightning_builder: Arc<dyn LightningBuilder + Sync + Send>,
    pub(crate) gateway_config: Arc<RwLock<Option<GatewayConfiguration>>>,
    pub(crate) state: Arc<RwLock<GatewayState>>,
    pub(crate) client_builder: GatewayClientBuilder,
    pub(crate) gateway_db: Database,
    pub(crate) gateway_id: PublicKey,
    pub(crate) versioned_api: SafeUrl,
    pub(crate) listen: SocketAddr,
    pub(crate) lightning_module_mode: LightningModuleMode,
}

Fields

federation_manager: Arc<RwLock<FederationManager>>

lightning_builder: Arc<dyn LightningBuilder + Sync + Send>

gateway_config: Arc<RwLock<Option<GatewayConfiguration>>>

state: Arc<RwLock<GatewayState>>

client_builder: GatewayClientBuilder

gateway_db: Database

gateway_id: PublicKey

versioned_api: SafeUrl

listen: SocketAddr

lightning_module_mode: LightningModuleMode

Implementations

impl Gateway

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

Creates a new gateway but with a custom module registry provided inside client_builder. Currently only used for testing.

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

Default function for creating a gateway with the Mint, Wallet, and Gateway modules.

pub fn gateway_id(&self) -> PublicKey

pub fn versioned_api(&self) -> &SafeUrl

pub async fn clone_gateway_config(&self) -> Option<GatewayConfiguration>

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

Reads and serializes structures from the Gateway’s database for the purpose for serializing to JSON for inspection.

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

Main entrypoint into the gateway that starts the client registration timer, loads the federation clients from the persisted config, begins listening for intercepted payments, and starts the webserver to service requests.

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

Returns information about the Gateway back to the client when requested via the webserver.

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

If the Gateway is connected to the Lightning node, returns the ClientConfig for each federation that the Gateway is connected to.

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

Returns the balance of the requested federation that the Gateway is connected to.

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

Returns a Bitcoin deposit on-chain address for pegging in Bitcoin for a specific connected federation.

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

Returns a Bitcoin TXID from a peg-out transaction for a specific connected federation.

pub async fn handle_connect_federation( &self, payload: ConnectFedPayload, ) -> Result<FederationInfo, AdminGatewayError>

Handles a connection request to join a new federation. The gateway will download the federation’s client configuration, construct a new client, registers, the gateway with the federation, and persists the necessary config to reconstruct the client when restarting the gateway.

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

Handle a request to have the Gateway leave a federation. The Gateway will request the federation to remove the registration record and the gateway will remove the configuration needed to construct the federation client.

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

Handles a request for the gateway to backup a connected federation’s ecash.

pub async fn handle_mnemonic_msg( &self, ) -> Result<MnemonicResponse, AdminGatewayError>

Handles an authenticated request for the gateway’s mnemonic. This also returns a vector of federations that are not using the mnemonic backup strategy.

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

Handle a request to change a connected federation’s configuration or gateway metadata. If num_route_hints is changed, the Gateway will re-register with all connected federations. If per_federation_routing_fees is changed, the Gateway will only re-register with the specified federation.

pub async fn handle_get_ln_onchain_address_msg( &self, ) -> Result<Address, AdminGatewayError>

Generates an onchain address to fund the gateway’s lightning node.

pub async fn handle_open_channel_msg( &self, payload: OpenChannelPayload, ) -> Result<Txid, AdminGatewayError>

Instructs the Gateway’s Lightning node to open a channel to a peer specified by pubkey.

pub async fn handle_close_channels_with_peer_msg( &self, payload: CloseChannelsWithPeerPayload, ) -> Result<CloseChannelsWithPeerResponse, AdminGatewayError>

Instructs the Gateway’s Lightning node to close all channels with a peer specified by pubkey.

pub async fn handle_list_active_channels_msg( &self, ) -> Result<Vec<ChannelInfo>, AdminGatewayError>

Returns a list of Lightning network channels from the Gateway’s Lightning node.

pub async fn handle_withdraw_onchain_msg( &self, payload: WithdrawOnchainPayload, ) -> Result<Txid, AdminGatewayError>

Withdraws funds from the gateway’s lightning node on-chain wallet.

pub async fn handle_get_balances_msg( &self, ) -> Result<GatewayBalances, AdminGatewayError>

Returns the ecash, lightning, and onchain balances for the gateway and the gateway’s lightning node.

pub async fn handle_spend_ecash_msg( &self, payload: SpendEcashPayload, ) -> Result<SpendEcashResponse, AdminGatewayError>

pub async fn handle_receive_ecash_msg( &self, payload: ReceiveEcashPayload, ) -> Result<ReceiveEcashResponse, PublicGatewayError>

Handles a request to receive ecash into the gateway.

pub async fn handle_shutdown_msg( &self, task_group: TaskGroup, ) -> Result<(), AdminGatewayError>

Instructs the gateway to shutdown, but only after all incoming payments have been handlded.

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

Retrieves a ClientHandleArc from the Gateway’s in memory structures that keep track of available clients, given a federation_id.

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 unannounce_from_all_federations(&self)

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

impl Gateway

pub async fn routing_info_v2( &self, federation_id: &FederationId, ) -> Result<Option<RoutingInfo>, PublicGatewayError>

Returns payment information that LNv2 clients can use to instruct this Gateway to pay an invoice or receive a payment.

pub async fn create_invoice_via_lnrpc_v2( &self, payment_hash: Hash, amount: Amount, description: Bolt11InvoiceDescription, expiry_time: u32, ) -> Result<Bolt11Invoice, LightningRpcError>

Retrieves a BOLT11 invoice from the connected Lightning node with a specific payment_hash.

pub async fn get_registered_incoming_contract_and_client_v2( &self, payment_image: PaymentImage, amount_msats: u64, ) -> Result<(IncomingContract, Arc<ClientHandle>), PublicGatewayError>

Retrieves the persisted CreateInvoicePayload from the database specified by the payment_hash and the ClientHandleArc specified by the payload’s federation_id.

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<(), Error>

Formats the value using the given formatter.