Struct FakeLightningTest

pub struct FakeLightningTest {
    pub gateway_node_pub_key: PublicKey,
    gateway_node_sec_key: SecretKey,
    amount_sent: AtomicU64,
}

Fields

gateway_node_pub_key: PublicKey

gateway_node_sec_key: SecretKey

amount_sent: AtomicU64

Implementations

impl FakeLightningTest

pub fn new() -> Self

impl FakeLightningTest

pub fn invoice( &self, amount: Amount, expiry_time: Option<u64>, ) -> Result<Bolt11Invoice>

pub fn unpayable_invoice( &self, amount: Amount, expiry_time: Option<u64>, ) -> Bolt11Invoice

Creates an invoice that is not payable

• Mocks use hard-coded invoice description to fail the payment
• Real fixtures won’t be able to route to randomly generated node pubkey

pub fn listening_address(&self) -> String

Trait Implementations

impl Debug for FakeLightningTest

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

Formats the value using the given formatter.

impl Default for FakeLightningTest

fn default() -> Self

Returns the “default value” for a type.

impl ILnRpcClient for FakeLightningTest

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

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

Get the public key and alias of the lightning node

fn routehints<'life0, 'async_trait>( &'life0 self, _num_route_hints: usize, ) -> Pin<Box<dyn Future<Output = Result<GetRouteHintsResponse, LightningRpcError>> + Send + 'async_trait>>

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

Get route hints to the lightning node

fn pay<'life0, 'async_trait>( &'life0 self, invoice: Bolt11Invoice, _max_delay: u64, _max_fee: Amount, ) -> Pin<Box<dyn Future<Output = Result<PayInvoiceResponse, LightningRpcError>> + Send + 'async_trait>>

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

Attempt to pay an invoice using the lightning node

fn supports_private_payments(&self) -> bool

Returns true if the lightning backend supports payments without full invoices. If this returns true, then ILnRpcClient::pay_private has to be implemented.

fn pay_private<'life0, 'async_trait>( &'life0 self, invoice: PrunedInvoice, _max_delay: u64, _max_fee: Amount, ) -> Pin<Box<dyn Future<Output = Result<PayInvoiceResponse, LightningRpcError>> + Send + 'async_trait>>

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

Attempt to pay an invoice using the lightning node using a PrunedInvoice, increasing the user’s privacy by not sending the invoice description to the gateway.

fn route_htlcs<'a, 'life0, 'async_trait>( self: Box<Self>, task_group: &'life0 TaskGroup, ) -> Pin<Box<dyn Future<Output = Result<(RouteHtlcStream<'a>, Arc<dyn ILnRpcClient>), LightningRpcError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Consumes the current client and returns a stream of intercepted HTLCs and a new client. complete_htlc must be called for all successfully intercepted HTLCs sent to the returned stream.

fn complete_htlc<'life0, 'async_trait>( &'life0 self, _htlc: InterceptPaymentResponse, ) -> Pin<Box<dyn Future<Output = Result<(), LightningRpcError>> + Send + 'async_trait>>

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

Complete an HTLC that was intercepted by the gateway. Must be called for all successfully intercepted HTLCs sent to the stream returned by route_htlcs.

fn create_invoice<'life0, 'async_trait>( &'life0 self, create_invoice_request: CreateInvoiceRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateInvoiceResponse, LightningRpcError>> + Send + 'async_trait>>

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

Requests the lightning node to create an invoice. Payment hash of CreateInvoiceRequest determines if the invoice is intended to be an ecash payment or a direct payment to this lightning node.

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

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

Get a funding address belonging to the gateway’s lightning node wallet.

fn withdraw_onchain<'life0, 'async_trait>( &'life0 self, _payload: WithdrawOnchainPayload, ) -> Pin<Box<dyn Future<Output = Result<WithdrawOnchainResponse, LightningRpcError>> + Send + 'async_trait>>

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

Execute an onchain transaction using the lightning node’s wallet.

fn open_channel<'life0, 'async_trait>( &'life0 self, _payload: OpenChannelPayload, ) -> Pin<Box<dyn Future<Output = Result<OpenChannelResponse, LightningRpcError>> + Send + 'async_trait>>

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

Open a channel with a peer lightning node from the gateway’s lightning node.

fn close_channels_with_peer<'life0, 'async_trait>( &'life0 self, _payload: CloseChannelsWithPeerPayload, ) -> Pin<Box<dyn Future<Output = Result<CloseChannelsWithPeerResponse, LightningRpcError>> + Send + 'async_trait>>

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

Close all channels with a peer lightning node from the gateway’s lightning node.

fn list_active_channels<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ChannelInfo>, LightningRpcError>> + Send + 'async_trait>>

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

List the lightning node’s active channels with peers.

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

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

Returns a summary of the lightning node’s balance, including the onchain wallet, outbound liquidity, and inbound liquidity.