Merge pull request #12 from lightsparkdev/feat/cancelinvoice

Add a cancel_invoice function.

Author: jklein24

examples/example.py

@@ -222,6 +222,16 @@
 print(f"Simulated payment to the invoice done with ID = {payment.id}")
 print("")
 
+# Create and cancel an invoice
+invoice = client.create_invoice(
+    node_id=node_id,
+    amount_msats=42000,
+    memo="Cancelable Pizza!",
+)
+print(f"Invoice created from {node_name}: {invoice.id}")
+cancelled_invoice = client.cancel_invoice(invoice_id=invoice.id)
+print(f"Cancelled invoice {cancelled_invoice.id}")
+
 # Pay invoice sample
 #
 test_invoice = client.create_test_mode_invoice(

lightspark/__init__.py

@@ -17,6 +17,8 @@
 from lightspark.objects.Balances import Balances
 from lightspark.objects.BitcoinNetwork import BitcoinNetwork
 from lightspark.objects.BlockchainBalance import BlockchainBalance
+from lightspark.objects.CancelInvoiceInput import CancelInvoiceInput
+from lightspark.objects.CancelInvoiceOutput import CancelInvoiceOutput
 from lightspark.objects.Channel import Channel
 from lightspark.objects.ChannelClosingTransaction import ChannelClosingTransaction
 from lightspark.objects.ChannelFees import ChannelFees

lightspark/lightspark_client.py

@@ -58,6 +58,7 @@
 )
 from lightspark.requests.requester import Requester
 from lightspark.scripts.bitcoin_fee_estimate import BITCOIN_FEE_ESTIMATE_QUERY
+from lightspark.scripts.cancel_invoice import CANCEL_INVOICE_MUTATION
 from lightspark.scripts.claim_uma_invitation import (
     CLAIM_UMA_INVITATION_MUTATION,
     CLAIM_UMA_INVITATION_WITH_INCENTIVES_MUTATION,
@@ -210,6 +211,26 @@ def create_lnurl_invoice(
             self._requester, json["create_lnurl_invoice"]["invoice"]
         )
 
+    def cancel_invoice(
+        self,
+        invoice_id: str,
+    ) -> Invoice:
+        """Cancels an existing unpaid invoice and returns that invoice. Cancelled invoices cannot be paid.
+
+        Args:
+            invoice_id (str): The ID of the invoice to cancel.
+
+        Returns:
+            Invoice: An `Invoice` object representing the cancelled invoice.
+        """
+        logger.info("Canceling an invoice with id %s.", invoice_id)
+        json = self._requester.execute_graphql(
+            CANCEL_INVOICE_MUTATION,
+            {"invoice_id": invoice_id},
+        )
+
+        return Invoice_from_json(self._requester, json["cancel_invoice"]["invoice"])
+
     def create_node_wallet_address(
         self,
         node_id: str,

lightspark/objects/CancelInvoiceInput.py

@@ -0,0 +1,20 @@
+# Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
+
+from dataclasses import dataclass
+from typing import Any, Mapping
+
+
+@dataclass
+class CancelInvoiceInput:
+    invoice_id: str
+
+    def to_json(self) -> Mapping[str, Any]:
+        return {
+            "cancel_invoice_input_invoice_id": self.invoice_id,
+        }
+
+
+def from_json(obj: Mapping[str, Any]) -> CancelInvoiceInput:
+    return CancelInvoiceInput(
+        invoice_id=obj["cancel_invoice_input_invoice_id"],
+    )

lightspark/objects/CancelInvoiceOutput.py

@@ -0,0 +1,35 @@
+# Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
+
+from dataclasses import dataclass
+from typing import Any, Mapping
+
+from lightspark.requests.requester import Requester
+
+
+@dataclass
+class CancelInvoiceOutput:
+    requester: Requester
+
+    invoice_id: str
+
+    def to_json(self) -> Mapping[str, Any]:
+        return {
+            "cancel_invoice_output_invoice": {"id": self.invoice_id},
+        }
+
+
+FRAGMENT = """
+fragment CancelInvoiceOutputFragment on CancelInvoiceOutput {
+    __typename
+    cancel_invoice_output_invoice: invoice {
+        id
+    }
+}
+"""
+
+
+def from_json(requester: Requester, obj: Mapping[str, Any]) -> CancelInvoiceOutput:
+    return CancelInvoiceOutput(
+        requester=requester,
+        invoice_id=obj["cancel_invoice_output_invoice"]["id"],
+    )

lightspark/scripts/cancel_invoice.py

@@ -0,0 +1,19 @@
+# Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
+
+from lightspark.objects.Invoice import FRAGMENT as InvoiceFragment
+
+CANCEL_INVOICE_MUTATION = f"""
+mutation CancelInvoice(
+    $invoice_id: ID!
+) {{
+    cancel_invoice(input: {{
+        invoice_id: $invoice_id
+    }}) {{
+        invoice {{
+            ...InvoiceFragment
+        }}
+    }}
+}}
+
+{InvoiceFragment}
+"""