Struct CreateOrderOptions

pub struct CreateOrderOptions {

    pub client_balance_sat: u64,
    pub lsp_node_id: Option<String>,
    pub coupon_code: String,
    pub source: Option<String>,
    pub discount_code: Option<String>,
    pub zero_conf: bool,
    pub zero_conf_payment: Option<bool>,
    pub zero_reserve: bool,
    pub client_node_id: Option<String>,
    pub timestamp: Option<String>,
    pub signature: Option<String>,
    pub refund_onchain_address: Option<String>,
    pub announce_channel: bool,
}

Fields

client_balance_sat: u64

Initial number of satoshis the client wants to provide on their channel side. The client pays this balance to the LSP. The LSP will push the balance to the LSP on channel creation. Defaults to 0.

lsp_node_id: Option<String>

Node id the client wants to receive the channel from. The id must come from the node list provided by get_info. If not provided, a random node will be chosen.

coupon_code: String

@deprecated Use source field instead.

source: Option<String>

What created this order. Example: ‘bitkit’, ‘widget’.

discount_code: Option<String>

User-entered discount code.

zero_conf: bool

If the channel opened should be a turbo aka. zeroConf channel.

zero_conf_payment: Option<bool>

If the on-chain payment should be accepted without any block confirmations.

zero_reserve: bool

Allow the peer to have zero channel reserve (dust limit).

client_node_id: Option<String>

Optional id of the node that the channel should be opened to. If supplied, performs a channel limit check on the node at order creation to prevent any surprises when the channel is actually getting opened. Node that should be woken up via a push notification as soon as the payment is confirmed. Ownership of the node must be proven with a signature.

timestamp: Option<String>

Timestamp that has been used to sign the open proof.

signature: Option<String>

Signature channelOpen-${ISO-timestamp} created by the private key of the node.

refund_onchain_address: Option<String>

User-entered refund on-chain address.

announce_channel: bool

Should the channel be public.

Trait Implementations

impl Clone for CreateOrderOptions

fn clone(&self) -> CreateOrderOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOrderOptions

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

Formats the value using the given formatter.

impl Default for CreateOrderOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateOrderOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateOrderOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.