fix: cli: check_hold_invoice showing settled invoice as unpaid

the cli command `check_hold_invoice` incorrectly assumes that
`lnworker.is_accepted_mpp(payment_hash)` is true for settled invoices,
however it is not as the received mpp entries will be removed from
the `lnworker.received_mpp_htlcs` shortly after adding the preimage to
lnworker (after the htlcs got removed from the channel).

Also renames `amount_sat` in the `check_hold_invoice` response to
`amount_sat_received` to make it more obvious that this is the currently
received amount instead of the amount the invoice of `payment_hash` has
been created with.

Author: f321x

electrum/commands.py

@@ -1427,6 +1427,8 @@ async def settle_hold_invoice(self, preimage: str, wallet: Abstract_Wallet = Non
         assert payment_hash in wallet.lnworker.dont_settle_htlcs, f"Invoice {payment_hash=} not a hold invoice?"
         assert wallet.lnworker.is_accepted_mpp(bfh(payment_hash)), \
             f"MPP incomplete, cannot settle hold invoice {payment_hash} yet"
+        info: Optional['PaymentInfo'] = wallet.lnworker.get_payment_info(bfh(payment_hash))
+        assert (wallet.lnworker.get_payment_mpp_amount_msat(bfh(payment_hash)) or 0) >= (info.amount_msat or 0)
         del wallet.lnworker.dont_settle_htlcs[payment_hash]
         wallet.lnworker.save_preimage(bfh(payment_hash), bfh(preimage))
         util.trigger_callback('wallet_updated', wallet)
@@ -1474,17 +1476,20 @@ async def check_hold_invoice(self, payment_hash: str, wallet: Abstract_Wallet =
         status = "unknown"
         if info is None:
             pass
-        elif not is_accepted_mpp:
+        elif not is_accepted_mpp and not wallet.lnworker.get_preimage_hex(payment_hash):
+            # is_accepted_mpp is False for settled payments
             status = "unpaid"
         elif is_accepted_mpp and payment_hash in wallet.lnworker.dont_settle_htlcs:
             status = "paid"
-        elif (payment_hash in wallet.lnworker._preimages
-                and payment_hash not in wallet.lnworker.dont_settle_htlcs
-                and is_accepted_mpp):
+        elif wallet.lnworker.get_preimage_hex(payment_hash) is not None \
+                and payment_hash not in wallet.lnworker.dont_settle_htlcs:
             status = "settled"
+            plist = wallet.lnworker.get_payments(status='settled')[bfh(payment_hash)]
+            _dir, amount_msat, _fee, _ts = wallet.lnworker.get_payment_value(info, plist)
+            amount_sat = amount_msat // 1000
         result = {
             "status": status,
-            "amount_sat": amount_sat
+            "amount_sat_received": amount_sat
         }
         return result
 

tests/test_commands.py

@@ -495,7 +495,7 @@ async def test_hold_invoice_commands(self, mock_save_db):
                 mock.patch.object(wallet.lnworker, 'get_payment_mpp_amount_msat', return_value=10_000 * 1000):
             status: dict = await cmds.check_hold_invoice(payment_hash=payment_hash, wallet=wallet)
             assert status['status'] == 'paid'
-            assert status['amount_sat'] == 10000
+            assert status['amount_sat_received'] == 10000
 
             settle_result = await cmds.settle_hold_invoice(
                 preimage=preimage.hex(),
@@ -504,6 +504,14 @@ async def test_hold_invoice_commands(self, mock_save_db):
         assert settle_result['settled'] == payment_hash
         assert wallet.lnworker._preimages[payment_hash] == preimage.hex()
         assert payment_hash not in wallet.lnworker.dont_settle_htlcs
+        with (mock.patch.object(
+            wallet.lnworker,
+            'get_payment_value',
+            return_value=(None, 10000*1000, None, None),
+        )):
+            settled_status: dict = await cmds.check_hold_invoice(payment_hash=payment_hash, wallet=wallet)
+            assert settled_status['status'] == 'settled'
+            assert settled_status['amount_sat_received'] == 10000
 
         with self.assertRaises(AssertionError):
             # cancelling a settled invoice should raise