Enum LightningCommands

pub enum LightningCommands {
    CreateInvoice {
        amount_msats: u64,
        expiry_secs: Option<u32>,
        description: Option<String>,
    },
    PayInvoice {
        invoice: Bolt11Invoice,
    },
    OpenChannel {
        pubkey: PublicKey,
        host: String,
        channel_size_sats: u64,
        push_amount_sats: Option<u64>,
    },
    CloseChannelsWithPeer {
        pubkey: PublicKey,
    },
    ListActiveChannels,
}

This API is intentionally kept very minimal, as its main purpose is to provide a simple and consistent way to establish liquidity between gateways in a test environment.

Variants

CreateInvoice

Create an invoice to receive lightning funds to the gateway.

Fields

amount_msats: u64

expiry_secs: Option<u32>

description: Option<String>

PayInvoice

Pay a lightning invoice as the gateway (i.e. no e-cash exchange).

Fields

invoice: Bolt11Invoice

OpenChannel

Open a channel with another lightning node.

Fields

pubkey: PublicKey

The public key of the node to open a channel with

host: String

channel_size_sats: u64

The amount to fund the channel with

push_amount_sats: Option<u64>

The amount to push to the other side of the channel

CloseChannelsWithPeer

Close all channels with a peer, claiming the funds to the lightning node’s on-chain wallet.

Fields

pubkey: PublicKey

ListActiveChannels

List active channels.

Implementations

impl LightningCommands

pub async fn handle( self, create_client: impl Fn() -> GatewayRpcClient + Send + Sync, ) -> Result<()>

Trait Implementations

impl FromArgMatches for LightningCommands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for LightningCommands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand