Project import generated by Copybara.

GitOrigin-RevId: db199612a3e3f3a769e99c89e4fa15754a1518ca

Author: Lightspark Eng

Pipfile.lock

@@ -15,3 +15,12 @@ Open the file `example.py` and make sure to update the variables at the top of t
 pipenv install
 pipenv run python -m examples.example
 ```
+
+There are also a few examples of webservers for demonstrating webhooks and LNURLs. These can similarly be run through Flask:
+
+```python
+pipenv install -d
+pipenv run flask --app examples.flask_lnurl_server run
+```
+
+Note that Flask requires Python >= 3.8, so these examples will not work if running Python 3.7.

README.md

@@ -68,13 +68,14 @@ core.workflow(
     ),
     destination = git.github_destination(
         url = "https://github.com/lightsparkdev/go-sdk.git",
-        push = "main",
+        # TODO: Move this back to main when we're ready to release.
+        push = "rc/remote-signing",
     ),
     # Switch to ITERATIVE mode to import each commit separately.
     mode = "SQUASH",
 
     origin_files = glob(
-	    ["go-sdk/**", "copy.bara.sky"],
+	    ["go-sdk/**"],
     ),
 
     authoring = authoring.pass_thru("Lightspark Eng <engineering@lightspark.com>"),

copy.bara.sky

@@ -0,0 +1,123 @@
+import json
+import os
+from dataclasses import dataclass
+from typing import Any
+from uuid import UUID
+
+from flask import Flask, abort, request
+from flask.typing import ResponseReturnValue
+
+from lightspark.lightspark_client import LightsparkSyncClient
+
+app = Flask(__name__)
+
+#################################################################
+## MODIFY THOSE VARIABLES BEFORE RUNNING THE EXAMPLE
+#################################################################
+##
+## We defined those variables as environment variables, but if you are just
+## running the example locally, feel free to just set the values in Python.
+##
+## First, initialize your client ID and client secret. Those are available
+## in your account at https://app.lightspark.com/api_config
+##
+## export LIGHTSPARK_API_TOKEN_CLIENT_ID=<client_id>
+## export LIGHTSPARK_API_TOKEN_CLIENT_SECRET=<client_secret>
+API_TOKEN_CLIENT_ID = os.environ.get("LIGHTSPARK_API_TOKEN_CLIENT_ID")
+API_TOKEN_CLIENT_SECRET = os.environ.get("LIGHTSPARK_API_TOKEN_CLIENT_SECRET")
+##
+## This example also assumes you already know your node UUID. Generally, an LNURL API would serve
+## many different usernames while maintaining some internal mapping from username to node UUID. For
+## simplicity, this example works with a single username and node UUID.
+##
+## export LIGHTSPARK_LNURL_NODE_UUID=0187c4d6-704b-f96b-0000-a2e8145bc1f9
+LNURL_NODE_UUID = os.environ.get("LIGHTSPARK_LNURL_NODE_UUID")
+LNURL_USERNAME = os.environ.get("LIGHTSPARK_LNURL_USERNAME", "ls_test")
+##
+## To run the webserver, run this command from the root of the SDK folder:
+## $ pipenv run flask --app examples.flask_lnurl_server run
+##
+## By default the server will run on port 5000. You can make a request to the API through
+## curl to make sure the server is working properly (replace ls_test with the username you have
+## configured):
+##
+## $ curl http://127.0.0.1:7120/.well-known/lnurlp/ls_test
+#################################################################
+
+assert API_TOKEN_CLIENT_ID
+assert API_TOKEN_CLIENT_SECRET
+assert LNURL_NODE_UUID
+assert LNURL_USERNAME
+
+
+@dataclass
+class User:
+    uuid: UUID
+    username: str
+    node_uuid: str
+
+
+LS_TEST_USER = User(
+    # Static UUID so that callback URLs are always the same.
+    UUID("4b41ae03-01b8-4974-8d26-26a35d28851b"),
+    LNURL_USERNAME,
+    f"LightsparkNode:{LNURL_NODE_UUID}",
+)
+
+
+def _generate_callback_for_user(user: User) -> str:
+    return f"{request.url_root}api/lnurl/payreq/{user.uuid}"
+
+
+def _generate_metadata_for_user(user: User) -> str:
+    return json.dumps(
+        [
+            ["text/plain", f"Pay to domain.org user {user.username}"],
+            ["text/identifier", f"{user.username}@domain.org"],
+        ]
+    )
+
+
+@app.route("/.well-known/lnurlp/<username>")
+def well_known_lnurlp_username(username: str) -> ResponseReturnValue:
+    if username != LS_TEST_USER.username:
+        abort(404, description=f"User not found: {username}")
+
+    user = LS_TEST_USER
+    callback = _generate_callback_for_user(user)
+    metadata = _generate_metadata_for_user(user)
+
+    return {
+        "callback": callback,
+        "maxSendable": 10_000_000,
+        "minSendable": 1_000,
+        "metadata": metadata,
+        "tag": "payRequest",
+    }
+
+
+@app.route("/api/lnurl/payreq/<uuid>")
+def lnurl_payreq(uuid: str) -> ResponseReturnValue:
+    if uuid != str(LS_TEST_USER.uuid):
+        abort(404, description=f"User not found: {uuid}")
+
+    user = LS_TEST_USER
+    amount_msats = int(request.args["amount"])
+
+    ls_client = LightsparkSyncClient(
+        api_token_client_id=API_TOKEN_CLIENT_ID,
+        api_token_client_secret=API_TOKEN_CLIENT_SECRET,
+    )
+
+    invoice = ls_client.create_lnurl_invoice(
+        user.node_uuid,
+        amount_msats,
+        _generate_metadata_for_user(user),
+    )
+
+    return {"pr": invoice.data.encoded_payment_request, "routes": []}
+
+
+@app.errorhandler(404)
+def error_not_found(e: Any) -> ResponseReturnValue:
+    return {"status": "ERROR", "reason": e.description}, 404

examples/flask_lnurl_server.py

@@ -3,7 +3,7 @@
 
 Install Flask (pip install flask) and then run this like:
 
-  flask --app flask_webhook_server run --port 5001
+  pipenv run flask --app examples.flask_webhook_server run --port 5001
 """
 
 import lightspark

examples/flask_webhook_server.py

@@ -24,10 +24,12 @@
 from lightspark.objects.ChannelToTransactionsConnection import (
     ChannelToTransactionsConnection,
 )
+from lightspark.objects.Connection import Connection
 from lightspark.objects.CreateApiTokenInput import CreateApiTokenInput
 from lightspark.objects.CreateApiTokenOutput import CreateApiTokenOutput
 from lightspark.objects.CreateInvoiceInput import CreateInvoiceInput
 from lightspark.objects.CreateInvoiceOutput import CreateInvoiceOutput
+from lightspark.objects.CreateLnurlInvoiceInput import CreateLnurlInvoiceInput
 from lightspark.objects.CreateNodeWalletAddressInput import CreateNodeWalletAddressInput
 from lightspark.objects.CreateNodeWalletAddressOutput import (
     CreateNodeWalletAddressOutput,
@@ -36,6 +38,9 @@
 from lightspark.objects.CreateTestModeInvoiceOutput import CreateTestModeInvoiceOutput
 from lightspark.objects.CreateTestModePaymentInput import CreateTestModePaymentInput
 from lightspark.objects.CreateTestModePaymentoutput import CreateTestModePaymentoutput
+from lightspark.objects.CryptoSanctionsScreeningProvider import (
+    CryptoSanctionsScreeningProvider,
+)
 from lightspark.objects.CurrencyAmount import CurrencyAmount
 from lightspark.objects.CurrencyUnit import CurrencyUnit
 from lightspark.objects.DeleteApiTokenInput import DeleteApiTokenInput
@@ -66,6 +71,7 @@
 from lightspark.objects.LightningFeeEstimateOutput import LightningFeeEstimateOutput
 from lightspark.objects.LightningTransaction import LightningTransaction
 from lightspark.objects.LightsparkNode import LightsparkNode
+from lightspark.objects.LightsparkNodeOwner import LightsparkNodeOwner
 from lightspark.objects.LightsparkNodePurpose import LightsparkNodePurpose
 from lightspark.objects.LightsparkNodeStatus import LightsparkNodeStatus
 from lightspark.objects.LightsparkNodeToChannelsConnection import (
@@ -96,10 +102,13 @@
 from lightspark.objects.RequestWithdrawalInput import RequestWithdrawalInput
 from lightspark.objects.RequestWithdrawalOutput import RequestWithdrawalOutput
 from lightspark.objects.RichText import RichText
+from lightspark.objects.RiskRating import RiskRating
 from lightspark.objects.RoutingTransaction import RoutingTransaction
 from lightspark.objects.RoutingTransactionFailureReason import (
     RoutingTransactionFailureReason,
 )
+from lightspark.objects.ScreenBitcoinAddressesInput import ScreenBitcoinAddressesInput
+from lightspark.objects.ScreenBitcoinAddressesOutput import ScreenBitcoinAddressesOutput
 from lightspark.objects.Secret import Secret
 from lightspark.objects.SendPaymentInput import SendPaymentInput
 from lightspark.objects.SendPaymentOutput import SendPaymentOutput
@@ -108,6 +117,13 @@
 from lightspark.objects.TransactionStatus import TransactionStatus
 from lightspark.objects.TransactionType import TransactionType
 from lightspark.objects.Wallet import Wallet
+from lightspark.objects.WalletStatus import WalletStatus
+from lightspark.objects.WalletToPaymentRequestsConnection import (
+    WalletToPaymentRequestsConnection,
+)
+from lightspark.objects.WalletToTransactionsConnection import (
+    WalletToTransactionsConnection,
+)
 from lightspark.objects.WebhookEventType import WebhookEventType
 from lightspark.objects.Withdrawal import Withdrawal
 from lightspark.objects.WithdrawalMode import WithdrawalMode

lightspark/__init__.py

@@ -1,5 +1,6 @@
 # Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
 
+from hashlib import sha256
 import logging
 from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
@@ -161,6 +162,59 @@ def create_invoice(
 
         return Invoice_from_json(self._requester, json["create_invoice"]["invoice"])
 
+    def create_lnurl_invoice(
+        self,
+        node_id: str,
+        amount_msats: int,
+        metadata: str,
+    ) -> Invoice:
+        """Generates a Lightning Invoice (follows the Bolt 11 specification) to request a payment
+        from another Lightning Node. This should only be used for generating invoices for LNURLs,
+        with `create_invoice` preferred in the general case.
+
+        Args:
+            node_id (str): The ID of the node from which to create the invoice.
+            amount_sats (int): The amount for which the invoice should be created, in millisatoshis.
+            will be added.
+            metadata (str): The LNURL metadata payload field in the initial payreq response. This
+            will be hashed and present in the h-tag (SHA256 purpose of payment) of the resulting
+            Bolt 11 invoice.
+
+        Returns:
+            Invoice: An `Invoice` object representing the generated invoice.
+        """
+        logger.info("Creating an invoice for node %s.", node_id)
+        json = self._requester.execute_graphql(
+            f"""
+mutation CreateLnurlInvoice(
+    $node_id: ID!
+    $amount_msats: Long!
+    $metadata_hash: String!
+) {{
+    create_lnurl_invoice(input: {{
+        node_id: $node_id
+        amount_msats: $amount_msats
+        metadata_hash: $metadata_hash
+    }}) {{
+        invoice {{
+            ...InvoiceFragment
+        }}
+    }}
+}}
+
+{InvoiceFragment}
+""",
+            {
+                "amount_msats": amount_msats,
+                "node_id": node_id,
+                "metadata_hash": sha256(metadata.encode("utf-8")).hexdigest(),
+            },
+        )
+
+        return Invoice_from_json(
+            self._requester, json["create_lnurl_invoice"]["invoice"]
+        )
+
     def create_node_wallet_address(
         self,
         node_id: str,