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 send( &self, gateway_api: SafeUrl, invoice: Bolt11Invoice, ) -> Result<OperationId, SendPaymentError>

pub async fn send_internal( &self, gateway_api: SafeUrl, invoice: Bolt11Invoice, payment_fee_limit: PaymentFee, expiration_delta_limit: u64, partial_amount: Option<Amount>, ) -> Result<OperationId, SendPaymentError>

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

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

pub async fn receive( &self, gateway_api: SafeUrl, invoice_amount: Amount, ) -> ReceiveResult

pub async fn receive_internal( &self, gateway_api: SafeUrl, invoice_amount: Amount, expiry_time: u32, description: Bolt11InvoiceDescription, payment_fee_limit: PaymentFee, ) -> Result<(Bolt11Invoice, OperationId), FetchInvoiceError>

pub async fn create_contract_and_fetch_invoice( &self, recipient_static_pk: PublicKey, gateway_api: SafeUrl, invoice_amount: Amount, ) -> Result<(IncomingContract, [u8; 32], Bolt11Invoice), FetchInvoiceError>

pub async fn create_contract_and_fetch_invoice_internal( &self, recipient_static_pk: PublicKey, gateway_api: SafeUrl, invoice_amount: Amount, expiry_time: u32, description: Bolt11InvoiceDescription, payment_fee_limit: PaymentFee, ) -> Result<(IncomingContract, [u8; 32], Bolt11Invoice), FetchInvoiceError>

pub async fn await_incoming_contract(&self, contract: IncomingContract) -> bool

pub async fn receive_external_contract( &self, contract: IncomingContract, ) -> Option<OperationId>

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

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

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, _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 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_cli_command<'life0, 'life1, 'async_trait>( &'life0 self, _args: &'life1 [OsString], ) -> Pin<Box<dyn Future<Output = Result<Value, Error>> + Send + 'async_trait>>

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

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.