Enum LSPS2ServiceEvent 

pub enum LSPS2ServiceEvent {
    GetInfo {
        request_id: RequestId,
        counterparty_node_id: PublicKey,
        token: Option<String>,
    },
    BuyRequest {
        request_id: RequestId,
        counterparty_node_id: PublicKey,
        opening_fee_params: OpeningFeeParams,
        payment_size_msat: Option<u64>,
    },
    OpenChannel {
        their_network_key: PublicKey,
        amt_to_forward_msat: u64,
        opening_fee_msat: u64,
        user_channel_id: u128,
        intercept_scid: u64,
    },
}

An event which an LSPS2 server should take some action in response to.

Variants

GetInfo

A request from a client for information about JIT Channel parameters.

You must calculate the parameters for this client and pass them to LSPS2ServiceHandler::opening_fee_params_generated.

If an unrecognized or stale token is provided you can use [LSPS2ServiceHandler::invalid_token_provided] to error the request.

Fields

request_id: RequestId

An identifier that must be passed to LSPS2ServiceHandler::opening_fee_params_generated.

counterparty_node_id: PublicKey

The node id of the client making the information request.

token: Option<String>

An optional token that can be used as an API key, coupon code, etc.

BuyRequest

A client has selected a opening fee parameter to use and would like to purchase a channel with an optional initial payment size.

If payment_size_msat is Option::Some then the payer is allowed to use MPP. If payment_size_msat is Option::None then the payer cannot use MPP.

You must generate an intercept scid and cltv_expiry_delta for them to use and call LSPS2ServiceHandler::invoice_parameters_generated.

Fields

request_id: RequestId

An identifier that must be passed into LSPS2ServiceHandler::invoice_parameters_generated.

counterparty_node_id: PublicKey

The client node id that is making this request.

opening_fee_params: OpeningFeeParams

The channel parameters they have selected.

payment_size_msat: Option<u64>

The size of the initial payment they would like to receive.

OpenChannel

You should open a channel using ChannelManager::create_channel.

Fields

their_network_key: PublicKey

The node to open channel with.

amt_to_forward_msat: u64

The amount to forward after fees.

opening_fee_msat: u64

The fee earned for opening the channel.

user_channel_id: u128

A user specified id used to track channel open.

intercept_scid: u64

The intercept short channel id to use in the route hint.

Trait Implementations

impl Clone for LSPS2ServiceEvent

fn clone(&self) -> LSPS2ServiceEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LSPS2ServiceEvent

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

Formats the value using the given formatter.

impl PartialEq for LSPS2ServiceEvent

fn eq(&self, other: &LSPS2ServiceEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for LSPS2ServiceEvent

impl StructuralPartialEq for LSPS2ServiceEvent