Project import generated by Copybara.

GitOrigin-RevId: 7d04721d3d8fc63ec1728bef64f3cfe5b4242c01

Author: Lightspark Eng

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+# v2.0.0
+- Add support for remote signing.
+
 # v1.4.4
 
 - Fix parsing of the pay_uma_invoice response

Pipfile

@@ -8,6 +8,7 @@ cryptography = "*"
 eciespy = "*"
 pyjwt = "*"
 requests = "*"
+lightspark-crypto-python = "*"
 
 [dev-packages]
 black = "*"

Pipfile.lock

@@ -0,0 +1,45 @@
+# Copyright ©, 2022-present, Lightspark Group, Inc. - All Rights Reserved
+"""Sample Lightspark Webhooks Flask App.
+
+Install Flask (pip install flask) and then run this like:
+
+  pipenv run flask --app examples.flask_remote_signin_server run --port 5001
+"""
+
+import os
+import lightspark
+from flask import Flask, request
+
+app = Flask(__name__)
+
+# Get this from the API Configuration page.
+webhook_secret = os.environ.get("RK_WEBHOOK_SECRET")
+
+api_token_client_id = os.environ.get("RK_API_CLIENT_ID")
+api_token_client_secret = os.environ.get("RK_API_CLIENT_SECRET")
+
+master_seed = os.environ.get("RK_MASTER_SEED_HEX")
+
+
+@app.route("/ping", methods=["GET"])
+def ping():
+    print("ping")
+    return "OK"
+
+
+@app.route("/lightspark-webhook", methods=["POST"])
+def webhook():
+    client = lightspark.LightsparkSyncClient(
+        api_token_client_id=api_token_client_id,
+        api_token_client_secret=api_token_client_secret,
+        base_url=os.environ.get("RK_API_ENDPOINT"),
+    )
+    validator = lightspark.PositiveValidator()
+    handler = lightspark.RemoteSigningWebhookEventHandler(
+        client=client, master_seed=bytes.fromhex(master_seed), validator=validator
+    )
+
+    handler.handle_remote_signing_webhook_request(
+        request.data, request.headers.get(lightspark.SIGNATURE_HEADER), webhook_secret
+    )
+    return "OK"

examples/flask_remote_signin_server.py

@@ -43,6 +43,8 @@
 from lightspark.objects.CreateUmaInvoiceInput import CreateUmaInvoiceInput
 from lightspark.objects.CurrencyAmount import CurrencyAmount
 from lightspark.objects.CurrencyUnit import CurrencyUnit
+from lightspark.objects.DeclineToSignMessagesInput import DeclineToSignMessagesInput
+from lightspark.objects.DeclineToSignMessagesOutput import DeclineToSignMessagesOutput
 from lightspark.objects.DeleteApiTokenInput import DeleteApiTokenInput
 from lightspark.objects.DeleteApiTokenOutput import DeleteApiTokenOutput
 from lightspark.objects.Deposit import Deposit
@@ -53,6 +55,7 @@
 from lightspark.objects.GraphNode import GraphNode
 from lightspark.objects.Hop import Hop
 from lightspark.objects.HtlcAttemptFailureCode import HtlcAttemptFailureCode
+from lightspark.objects.IdAndSignature import IdAndSignature
 from lightspark.objects.IncomingPayment import IncomingPayment
 from lightspark.objects.IncomingPaymentAttempt import IncomingPaymentAttempt
 from lightspark.objects.IncomingPaymentAttemptStatus import IncomingPaymentAttemptStatus
@@ -72,11 +75,14 @@
 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 (
     LightsparkNodeToChannelsConnection,
 )
+from lightspark.objects.LightsparkNodeWithOSK import LightsparkNodeWithOSK
+from lightspark.objects.LightsparkNodeWithRemoteSigning import (
+    LightsparkNodeWithRemoteSigning,
+)
 from lightspark.objects.Node import Node
 from lightspark.objects.NodeAddress import NodeAddress
 from lightspark.objects.NodeAddressType import NodeAddressType
@@ -110,6 +116,15 @@
 from lightspark.objects.PostTransactionData import PostTransactionData
 from lightspark.objects.RegisterPaymentInput import RegisterPaymentInput
 from lightspark.objects.RegisterPaymentOutput import RegisterPaymentOutput
+from lightspark.objects.ReleaseChannelPerCommitmentSecretInput import (
+    ReleaseChannelPerCommitmentSecretInput,
+)
+from lightspark.objects.ReleaseChannelPerCommitmentSecretOutput import (
+    ReleaseChannelPerCommitmentSecretOutput,
+)
+from lightspark.objects.ReleasePaymentPreimageInput import ReleasePaymentPreimageInput
+from lightspark.objects.ReleasePaymentPreimageOutput import ReleasePaymentPreimageOutput
+from lightspark.objects.RemoteSigningSubEventType import RemoteSigningSubEventType
 from lightspark.objects.RequestWithdrawalInput import RequestWithdrawalInput
 from lightspark.objects.RequestWithdrawalOutput import RequestWithdrawalOutput
 from lightspark.objects.RichText import RichText
@@ -123,10 +138,27 @@
 from lightspark.objects.Secret import Secret
 from lightspark.objects.SendPaymentInput import SendPaymentInput
 from lightspark.objects.SendPaymentOutput import SendPaymentOutput
+from lightspark.objects.SetInvoicePaymentHashInput import SetInvoicePaymentHashInput
+from lightspark.objects.SetInvoicePaymentHashOutput import SetInvoicePaymentHashOutput
+from lightspark.objects.Signable import Signable
+from lightspark.objects.SignablePayload import SignablePayload
+from lightspark.objects.SignablePayloadStatus import SignablePayloadStatus
+from lightspark.objects.SignInvoiceInput import SignInvoiceInput
+from lightspark.objects.SignInvoiceOutput import SignInvoiceOutput
+from lightspark.objects.SignMessagesInput import SignMessagesInput
+from lightspark.objects.SignMessagesOutput import SignMessagesOutput
 from lightspark.objects.Transaction import Transaction
 from lightspark.objects.TransactionFailures import TransactionFailures
 from lightspark.objects.TransactionStatus import TransactionStatus
 from lightspark.objects.TransactionType import TransactionType
+from lightspark.objects.UpdateChannelPerCommitmentPointInput import (
+    UpdateChannelPerCommitmentPointInput,
+)
+from lightspark.objects.UpdateChannelPerCommitmentPointOutput import (
+    UpdateChannelPerCommitmentPointOutput,
+)
+from lightspark.objects.UpdateNodeSharedSecretInput import UpdateNodeSharedSecretInput
+from lightspark.objects.UpdateNodeSharedSecretOutput import UpdateNodeSharedSecretOutput
 from lightspark.objects.Wallet import Wallet
 from lightspark.objects.WalletStatus import WalletStatus
 from lightspark.objects.WalletToPaymentRequestsConnection import (
@@ -146,5 +178,6 @@
 from lightspark.objects.WithdrawalRequestToChannelOpeningTransactionsConnection import (
     WithdrawalRequestToChannelOpeningTransactionsConnection,
 )
+from lightspark.remote_signing import *
 from lightspark.version import __version__
 from lightspark.webhooks import SIGNATURE_HEADER, WebhookEvent

lightspark/__init__.py

@@ -81,6 +81,7 @@
 from lightspark.scripts.send_payment import SEND_PAYMENT_MUTATION
 from lightspark.utils.crypto import decrypt_private_key
 from lightspark.utils.enums import parse_enum
+from lightspark.utils.signing_key import SigningKey, Secp256k1SigningKey, RSASigningKey
 
 logger = logging.getLogger("lightspark")
 
@@ -90,7 +91,7 @@
 @dataclass
 class LightsparkSyncClient:
     _requester: Requester
-    _node_private_keys: Dict[str, bytes]
+    _node_private_keys: Dict[str, SigningKey]
 
     def __init__(
         self,
@@ -410,11 +411,11 @@ def get_lightning_fee_estimate_for_node(
             self._requester, json["lightning_fee_estimate_for_node"]
         ).fee_estimate
 
-    def load_node_signing_key(self, node_id: str, signing_key: bytes) -> None:
+    def load_node_signing_key(self, node_id: str, signing_key: SigningKey) -> None:
         logger.info("Loading the signing key for node %s", node_id)
         self._node_private_keys[node_id] = signing_key
 
-    def recover_node_signing_key(self, node_id: str, node_password: str) -> bytes:
+    def recover_node_signing_key(self, node_id: str, node_password: str) -> SigningKey:
         logger.info("Recovering the signing key for node %s", node_id)
         json = self._requester.execute_graphql(
             RECOVER_NODE_SIGNING_KEY_QUERY,
@@ -431,8 +432,16 @@ def recover_node_signing_key(self, node_id: str, node_password: str) -> bytes:
             password=node_password,
         )
 
-        self.load_node_signing_key(node_id=node_id, signing_key=decrypted_private_key)
-        return decrypted_private_key
+        signing_key = RSASigningKey(decrypted_private_key)
+
+        self.load_node_signing_key(node_id=node_id, signing_key=signing_key)
+        return signing_key
+
+    def provide_node_master_seed(
+        self, node_id: str, master_seed: bytes, bitcoin_network: BitcoinNetwork
+    ) -> None:
+        signing_key = Secp256k1SigningKey(master_seed, bitcoin_network)
+        self.load_node_signing_key(node_id=node_id, signing_key=signing_key)
 
     def pay_invoice(
         self,
@@ -518,7 +527,7 @@ def screen_node(self, provider: ComplianceProvider, node_pubkey: str) -> RiskRat
         )
         return parse_enum(RiskRating, json["screen_node"]["rating"])
 
-    def get_signing_key(self, node_id: str) -> bytes:
+    def get_signing_key(self, node_id: str) -> SigningKey:
         if node_id not in self._node_private_keys:
             raise LightsparkException(
                 "SIGNING_ERROR",