Merge pull request #6 from lightsparkdev/feat/outgoingpaymentsforinvoice

Add a call to get outgoing payments for an invoice

Author: jklein24

examples/example.py

@@ -240,6 +240,14 @@
 print(f"Payment to the invoice done with ID = {payment.id}")
 print("")
 
+outgoing_payments = client.outgoing_payments_for_invoice(
+    encoded_invoice=test_invoice,  # replace test_invoice with real encoded invoice in non-test mode
+)
+print(f"Outgoing payments for invoice {test_invoice}:")
+for outgoing_payment in outgoing_payments:
+    print(f"    - {outgoing_payment.id}")
+print("")
+
 # Key Send sample
 #
 # payment = client.send_payment(

lightspark/lightspark_client.py

@@ -4,7 +4,7 @@
 from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
 from hashlib import sha256
-from typing import Any, Dict, Mapping, Optional, Tuple, Type, TypeVar
+from typing import Any, Dict, List, Mapping, Optional, Tuple, Type, TypeVar
 
 import jwt
 from cryptography.hazmat.primitives.asymmetric.ed448 import Ed448PrivateKey
@@ -46,6 +46,7 @@
 from lightspark.objects.PaymentRequestData import PaymentRequestData
 from lightspark.objects.Permission import Permission
 from lightspark.objects.RiskRating import RiskRating
+from lightspark.objects.TransactionStatus import TransactionStatus
 from lightspark.objects.WithdrawalMode import WithdrawalMode
 from lightspark.objects.WithdrawalRequest import WithdrawalRequest
 from lightspark.objects.WithdrawalRequest import (
@@ -74,6 +75,9 @@
 from lightspark.scripts.lightning_fee_estimate_for_node import (
     LIGHTNING_FEE_ESTIMATE_FOR_NODE_QUERY,
 )
+from lightspark.scripts.outgoing_payments_for_invoice import (
+    OUTGOING_PAYMENTS_FOR_INVOICE_QUERY,
+)
 from lightspark.scripts.pay_invoice import PAY_INVOICE_MUTATION
 from lightspark.scripts.pay_uma_invoice import PAY_UMA_INVOICE_MUTATION
 from lightspark.scripts.recover_node_signing_key import RECOVER_NODE_SIGNING_KEY_QUERY
@@ -621,3 +625,31 @@ def register_payment(
         return LightningTransaction_from_json(
             self._requester, json["register_payment"]["payment"]
         )
+
+    def outgoing_payments_for_invoice(
+        self,
+        encoded_invoice: str,
+        transaction_statuses: Optional[List[TransactionStatus]] = None,
+    ) -> List[OutgoingPayment]:
+        """
+        Fetches the outgoing payments (if any) which have been made for a given invoice.
+
+        Args:
+            encoded_invoice: The encoded invoice for which to fetch the outgoing payments.
+            transaction_statuses: The statuses of the transactions to fetch. If not specified, all transactions will be fetched.
+        """
+
+        variables: Dict[str, Any] = {"encoded_invoice": encoded_invoice}
+        if transaction_statuses is not None:
+            variables["transaction_statuses"] = transaction_statuses
+        json = self._requester.execute_graphql(
+            OUTGOING_PAYMENTS_FOR_INVOICE_QUERY, variables
+        )
+        if "outgoing_payments_for_invoice" not in json:
+            return []
+        if "payments" not in json["outgoing_payments_for_invoice"]:
+            return []
+        return [
+            OutgoingPayment_from_json(self._requester, payment)
+            for payment in json["outgoing_payments_for_invoice"]["payments"]
+        ]

lightspark/scripts/outgoing_payments_for_invoice.py

@@ -0,0 +1,21 @@
+# Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
+
+from lightspark.objects.OutgoingPayment import FRAGMENT as OutgoingPaymentFragment
+
+OUTGOING_PAYMENTS_FOR_INVOICE_QUERY = f"""
+query OutgoingPaymentsForInvoice(
+    $encoded_invoice: String!,
+    $transaction_statuses: [TransactionStatus!] = null
+) {{
+    outgoing_payments_for_invoice(input: {{
+        encoded_invoice: $encoded_invoice,
+        statuses: $transaction_statuses
+    }}) {{
+        payments {{
+            ...OutgoingPaymentFragment
+        }}
+    }}
+}}
+
+{OutgoingPaymentFragment}
+"""