Skip to content

Commit

Permalink
Drop amount_msats from InvoiceRequestFields
Browse files Browse the repository at this point in the history
An `InvoiceRequest` can overpay for an `Offer` which would be
reflected back to the recipient via the `amount_msats` field, but
its somewhat deceptive as the sender can *also* then further
overpay in the HTLC(s) themselves. The total overpayment is already
communicated in the `Event::ClaimablePayment` so we simply drop the
`InvoiceRequestFields` field here.

Fixes lightningdevkit#3002
  • Loading branch information
TheBlueMatt committed Apr 25, 2024
1 parent 98398fe commit 90c919c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 15 deletions.
3 changes: 0 additions & 3 deletions lightning/src/ln/offers_tests.rs
Expand Up @@ -412,7 +412,6 @@ fn creates_and_pays_for_offer_using_two_hop_blinded_path() {
offer_id: offer.id(),
invoice_request: InvoiceRequestFields {
payer_id: invoice_request.payer_id(),
amount_msats: None,
features: InvoiceRequestFeatures::empty(),
quantity: None,
payer_note_truncated: None,
Expand Down Expand Up @@ -565,7 +564,6 @@ fn creates_and_pays_for_offer_using_one_hop_blinded_path() {
offer_id: offer.id(),
invoice_request: InvoiceRequestFields {
payer_id: invoice_request.payer_id(),
amount_msats: None,
features: InvoiceRequestFeatures::empty(),
quantity: None,
payer_note_truncated: None,
Expand Down Expand Up @@ -687,7 +685,6 @@ fn pays_for_offer_without_blinded_paths() {
offer_id: offer.id(),
invoice_request: InvoiceRequestFields {
payer_id: invoice_request.payer_id(),
amount_msats: None,
features: InvoiceRequestFeatures::empty(),
quantity: None,
payer_note_truncated: None,
Expand Down
14 changes: 2 additions & 12 deletions lightning/src/offers/invoice_request.rs
Expand Up @@ -877,13 +877,12 @@ impl VerifiedInvoiceRequest {
let InvoiceRequestContents {
payer_id,
inner: InvoiceRequestContentsWithoutPayerId {
payer: _, offer: _, chain: _, amount_msats, features, quantity, payer_note
payer: _, offer: _, chain: _, amount_msats: _, features, quantity, payer_note
},
} = &self.inner.contents;

InvoiceRequestFields {
payer_id: *payer_id,
amount_msats: *amount_msats,
features: features.clone(),
quantity: *quantity,
payer_note_truncated: payer_note.clone()
Expand Down Expand Up @@ -1126,12 +1125,6 @@ pub struct InvoiceRequestFields {
/// A possibly transient pubkey used to sign the invoice request.
pub payer_id: PublicKey,

/// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
/// must be greater than or equal to [`Offer::amount`], converted if necessary.
///
/// [`chain`]: InvoiceRequest::chain
pub amount_msats: Option<u64>,

/// Features pertaining to requesting an invoice.
pub features: InvoiceRequestFeatures,

Expand All @@ -1150,7 +1143,6 @@ impl Writeable for InvoiceRequestFields {
fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
write_tlv_fields!(writer, {
(0, self.payer_id, required),
(2, self.amount_msats.map(|v| HighZeroBytesDroppedBigSize(v)), option),
(4, WithoutLength(&self.features), required),
(6, self.quantity.map(|v| HighZeroBytesDroppedBigSize(v)), option),
(8, self.payer_note_truncated.as_ref().map(|s| WithoutLength(&s.0)), option),
Expand All @@ -1163,15 +1155,14 @@ impl Readable for InvoiceRequestFields {
fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
_init_and_read_len_prefixed_tlv_fields!(reader, {
(0, payer_id, required),
(2, amount_msats, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
(4, features, (option, encoding: (InvoiceRequestFeatures, WithoutLength))),
(6, quantity, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
(8, payer_note_truncated, (option, encoding: (String, WithoutLength))),
});
let features = features.unwrap_or(InvoiceRequestFeatures::empty());

Ok(InvoiceRequestFields {
payer_id: payer_id.0.unwrap(), amount_msats, features, quantity,
payer_id: payer_id.0.unwrap(), features, quantity,
payer_note_truncated: payer_note_truncated.map(|s| UntrustedString(s)),
})
}
Expand Down Expand Up @@ -2277,7 +2268,6 @@ mod tests {
fields,
InvoiceRequestFields {
payer_id: payer_pubkey(),
amount_msats: Some(1001),
features: InvoiceRequestFeatures::empty(),
quantity: Some(1),
payer_note_truncated: Some(UntrustedString("0".repeat(PAYER_NOTE_LIMIT))),
Expand Down

0 comments on commit 90c919c

Please sign in to comment.