Skip to content

Commit

Permalink
Document ReceivePaymentRequest fields
Browse files Browse the repository at this point in the history
  • Loading branch information
roeierez committed Aug 28, 2023
1 parent adddad4 commit dd78645
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions libs/sdk-core/src/models.rs
Original file line number Diff line number Diff line change
Expand Up @@ -666,12 +666,21 @@ pub struct ReverseSwapFeesRequest {
/// Represents a receive payment request.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ReceivePaymentRequest {
/// The amount in satoshis for this payment request
pub amount_sats: u64,
/// The description for this payment request.
pub description: String,
/// Optional preimage for this payment request.
/// If specified, it will be used instead of generating a new one.
pub preimage: Option<Vec<u8>>,
/// If set and valid, these fess options are used when a new channels is needed.
/// Otherwise the default fee options will be used.
pub opening_fee_params: Option<OpeningFeeParams>,
/// If set to true, then the bolt11 invoice returned includes the description hash.
pub use_description_hash: Option<bool>,
/// if specified, set the time the invoice is valid for, in seconds.
pub expiry: Option<u64>,
/// if specified, sets the min_final_cltv_expiry for the invoice
pub cltv: Option<u32>,
}

Expand Down

0 comments on commit dd78645

Please sign in to comment.