Struct LightningClientModule

pub struct LightningClientModule {
    pub federation_id: FederationId,
    pub cfg: LightningClientConfig,
    pub notifier: ModuleNotifier<LightningClientStateMachines>,
    pub client_ctx: ClientContext<Self>,
    pub module_api: DynModuleApi,
    pub keypair: KeyPair,
    pub admin_auth: Option<ApiAuth>,
    pub gateway_conn: Arc<dyn GatewayConnection + Send + Sync>,
}

Client side lightning module

Note that lightning gateways use a different version of client side module.

Fields

federation_id: FederationId

cfg: LightningClientConfig

notifier: ModuleNotifier<LightningClientStateMachines>

client_ctx: ClientContext<Self>

module_api: DynModuleApi

keypair: KeyPair

admin_auth: Option<ApiAuth>

gateway_conn: Arc<dyn GatewayConnection + Send + Sync>

Implementations

impl LightningClientModule

pub async fn update_gateway_map(&self) -> !

This method updates the mapping from lightning node public keys to gateway api endpoints maintained in the module database once a day. When paying an invoice this enables the client to select the gateway that has created the invoice, if possible, such that the payment does not go over lightning, reducing fees and latency.

Client integrators are expected to call this function in a spawned task.

pub(crate) async fn select_gateway( &self, invoice: Option<Bolt11Invoice>, ) -> Result<(SafeUrl, RoutingInfo), SelectGatewayError>

pub(crate) async fn routing_info( &self, gateway: &SafeUrl, ) -> Result<Option<RoutingInfo>, GatewayConnectionError>

pub async fn send( &self, invoice: Bolt11Invoice, gateway: Option<SafeUrl>, ) -> Result<OperationId, SendPaymentError>

Pay an invoice. For testing you can optionally specify a gateway to route with, otherwise a gateway will be selected automatically.

pub async fn send_custom( &self, invoice: Bolt11Invoice, payment_fee_limit: PaymentFee, expiration_delta_limit: u64, gateway: Option<SafeUrl>, custom_meta: Value, ) -> Result<OperationId, SendPaymentError>

Pay an invoice. For testing you can optionally specify a gateway to route with, otherwise a gateway will be selected automatically.

pub(crate) async fn get_next_operation_id( &self, invoice: &Bolt11Invoice, ) -> Result<OperationId, SendPaymentError>

pub async fn subscribe_send( &self, operation_id: OperationId, ) -> Result<UpdateStreamOrOutcome<SendState>>

Subscribe to all updates of the send operation.

pub async fn await_send( &self, operation_id: OperationId, ) -> Result<FinalSendState>

Await the final state of the send operation.

pub async fn receive( &self, amount: Amount, gateway: Option<SafeUrl>, ) -> ReceiveResult

Request an invoice. For testing you can optionally specify a gateway to generate the invoice, otherwise a gateway will be selected automatically.

pub async fn receive_custom( &self, amount: Amount, expiry_secs: u32, description: Bolt11InvoiceDescription, payment_fee_limit: PaymentFee, gateway: Option<SafeUrl>, custom_meta: Value, ) -> Result<(Bolt11Invoice, OperationId), ReceiveError>

Request an invoice. For testing you can optionally specify a gateway to generate the invoice, otherwise a gateway will be selected automatically.

pub(crate) async fn create_contract_and_fetch_invoice( &self, recipient_static_pk: PublicKey, amount: Amount, expiry_secs: u32, description: Bolt11InvoiceDescription, payment_fee_limit: PaymentFee, gateway: Option<SafeUrl>, ) -> Result<(SafeUrl, IncomingContract, Bolt11Invoice), ReceiveError>

Create an incoming contract locked to a public key derived from the recipient’s static module public key and fetches the corresponding invoice.

pub(crate) async fn receive_incoming_contract( &self, gateway: SafeUrl, contract: IncomingContract, invoice: Bolt11Invoice, custom_meta: Value, ) -> Option<OperationId>

pub(crate) fn recover_contract_keys( &self, contract: &IncomingContract, ) -> Option<(KeyPair, AggregateDecryptionKey)>

pub async fn subscribe_receive( &self, operation_id: OperationId, ) -> Result<UpdateStreamOrOutcome<ReceiveState>>

Subscribe to all updates of the receive operation.

pub async fn await_receive( &self, operation_id: OperationId, ) -> Result<FinalReceiveState>

Await the final state of the receive operation.

Trait Implementations

impl ClientModule for LightningClientModule

type Init = LightningClientInit

type Common = LightningModuleTypes

Common module types shared between client and server

type Backup = NoModuleBackup

Data stored in regular backups so that restoring doesn’t have to start from epoch 0

type ModuleStateMachineContext = LightningClientContext

Data and API clients available to state machine transitions of this module

type States = LightningClientStateMachines

All possible states this client can submit to the executor

fn context(&self) -> Self::ModuleStateMachineContext

fn input_fee( &self, amount: Amount, _input: &<Self::Common as ModuleCommon>::Input, ) -> Option<Amount>

Returns the fee the processing of this input requires.

fn output_fee( &self, output: &<Self::Common as ModuleCommon>::Output, ) -> Option<Amount>

Returns the fee the processing of this output requires.

fn handle_cli_command<'life0, 'life1, 'async_trait>( &'life0 self, args: &'life1 [OsString], ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

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

fn decoder() -> Decoder

fn kind() -> ModuleKind

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Initialize client.

fn handle_rpc<'life0, 'async_trait>( &'life0 self, _method: String, _request: Value, ) -> Pin<Box<dyn Future<Output = Pin<Box<dyn Stream<Item = Result<Value, Error>> + Send + 'life0>>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

fn supports_backup(&self) -> bool

fn backup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Backup, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

fn supports_being_primary(&self) -> bool

Does this module support being a primary module

fn create_final_inputs_and_outputs<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, _operation_id: OperationId, _input_amount: Amount, _output_amount: Amount, ) -> Pin<Box<dyn Future<Output = Result<(Vec<ClientInput<<Self::Common as ModuleCommon>::Input, Self::States>>, Vec<ClientOutput<<Self::Common as ModuleCommon>::Output, Self::States>>), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Creates all inputs and outputs necessary to balance the transaction. The function returns an error if and only if the client’s funds are not sufficient to create the inputs necessary to fully fund the transaction.

fn await_primary_module_output<'life0, 'async_trait>( &'life0 self, _operation_id: OperationId, _out_point: OutPoint, ) -> Pin<Box<dyn Future<Output = Result<Amount, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Waits for the funds from an output created by Self::create_final_inputs_and_outputs to become available. This function returning typically implies a change in the output of Self::get_balance.

fn get_balance<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, ) -> Pin<Box<dyn Future<Output = Amount> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Returns the balance held by this module and available for funding transactions.

fn subscribe_balance_changes<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Pin<Box<dyn Stream<Item = ()> + Send>>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Returns a stream that will output the updated module balance each time it changes.

fn leave<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _dbtx: &'life1 mut DatabaseTransaction<'life2>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: Sync + 'async_trait,

Leave the federation

impl Debug for LightningClientModule

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

Formats the value using the given formatter.