Added docker compose file for btc and lnd signet. Updated readme and code demo. (#1354)

Author: sipsorcery

.gitignore

@@ -176,4 +176,7 @@ docfx/*
 .fake
 .ionide
 
-**/appsettings.Development.json
+**/appsettings.Development.json
+**/btc-data
+**/lnd-data
+**/rtl-data

examples/WebRTCLightningExamples/README.md

@@ -1 +1,144 @@
-The examples in this folder contain sample code to demonstrate WebRTC and Bitcoin Lightning interoperating.
+# WebRTC Lightning Payment Video Stream Demo
+
+This demo project showcases a real-time WebRTC video stream whose source is controlled by Bitcoin Lightning payments. Viewers can trigger changes in the video stream by making micropayments over the Lightning Network.
+
+## Overview
+
+This project integrates two cutting-edge technologies:
+- **WebRTC Video Streaming:** Enabling low-latency, real-time video communications.
+- **Bitcoin Lightning Payments:** Allowing instant, low-cost micropayments that trigger changes in the video source.
+
+When a viewer makes a payment, the system processes and verifies the Lightning payment. Once confirmed, the video source is updated accordingly—demonstrating a pay-per-view or dynamic content control model.
+
+## Features
+
+- **Real-Time Video Streaming:** Built using WebRTC for low-latency video delivery.
+- **Micropayment Control:** Use Bitcoin Lightning payments to trigger video content updates.
+- **Dynamic Integration:** Seamless integration between payment events and WebRTC streaming.
+- **Demo-Ready:** Easy-to-run demo for testing and showcasing the technology.
+
+## Prerequisites
+
+Before running the demo, ensure you have:
+- **Docker** and **Docker Compose** installed on your system.
+- A modern web browser with WebRTC support (Chrome, Firefox, etc.).
+
+## Running the Demo
+
+### 1. Clone the Repository
+
+Clone the repository and navigate to the project directory:
+
+```bash
+git clone [email protected]:sipsorcery-org/sipsorcery.git
+cd sipsorcery/examples/WebRTCLightningExamples/WebRTCLightningGetStarted
+```
+
+### 2. Set Up the Docker Environment
+
+This demo uses a `docker-compose` file to set up a Bitcoin Signet node, an LND Lightning node, and the RTL (Ride the Lightning) web interface.
+
+1. **Start the Docker Containers**
+
+    Run the following command to start the Bitcoin Signet node, LND, and RTL:
+
+    ```bash
+    docker-compose up -d
+    ```
+
+    This will spin up three services:
+
+    - bitcoind: A Bitcoin Signet node.
+    - lnd: A Lightning Network node connected to the Bitcoin Signet network.
+    - rtl: A web interface for managing your LND node.
+
+2. **Wait for Initialization**
+
+    The LND node will take a few minutes to sync with the Bitcoin Signet network. You can monitor the progress by checking the logs:
+
+    ```bash
+    docker logs -f lnd
+    ```
+
+3. **Access RTL (Optional)**
+
+    Once the LND node is synced, you can access the RTL web interface at [http://localhost:3000](http://localhost:3000) to manage your Lightning node.
+
+### 3. Configure the Demo Application
+
+1. **Update appSettings.json:**
+
+    Ensure the LND connection settings in your appSettings.Development.json file match the credentials and ports used in the docker-compose setup. For example:
+
+    ```json
+    {
+      "LndSettings": {
+        "Url": "localhost:10009",
+        "MacaroonPath": "../lnd-data/data/chain/bitcoin/signet/admin.macaroon",
+        "CertificatePath": "../lnd-data/tls.cert"
+      }
+    }
+    ```
+
+    If you're using the default `docker-compose` setup, the paths and ports should already be preconfigured.
+
+2. **Run the Demo Application**
+
+    Start the demo application using the following command:
+
+    ```bash
+    dotnet run
+    ```
+
+### 4. Make Payments
+
+1. **Scan the QR Code**
+
+    The video stream will display a payment request QR code when it transitions to certain states. Use a mobile Lightning Network client (e.g. Zeus) to scan the QR code and make a payment.
+
+2. **Trigger Video Updates**
+
+    Once the payment is detected, the video source will update dynamically, demonstrating the pay-per-view or dynamic content control model.
+
+### 5. Stopping the Demo
+
+To stop the Docker containers, run:
+
+```bash
+docker-compose down
+```
+
+This will gracefully shut down the Bitcoin Signet node, LND, and RTL services.
+
+### Docker Compose Configuration
+
+The `docker-compose.yml` file provided sets up the following services:
+
+- **Bitcoin Signet Node (bitcoind):**
+
+  - Runs a Bitcoin Signet node for testing purposes.
+  - Exposes RPC and ZMQ ports for communication with LND.
+
+- **Lightning Network Node (lnd):**
+
+  - Connects to the Bitcoin Signet node.
+  - Exposes gRPC, REST, and peer-to-peer ports for Lightning Network operations.
+
+- **RTL (Ride the Lightning) Interface (rtl):**
+
+   - Provides a web-based interface for managing the LND node.
+   - Accessible at http://localhost:3000 default password `sipsorcery`.
+
+For advanced configuration, refer to the comments in the `docker-compose.yml` file.
+
+### Troubleshooting
+
+- **LND Node Not Syncing:** Ensure the Bitcoin Signet node is fully synced before using LND. Check the logs with:
+
+```bash
+docker logs -f bitcoind
+```
+
+ - **Connection Issues:** Verify that the `appSettings.json`, or `appSettings.Development.json`, file has the correct LND connection details.
+
+ - **Payment Not Triggering Video Updates:** Ensure the payment is confirmed and the demo application is correctly processing payment events.

examples/WebRTCLightningExamples/WebRTCLightningGetStarted/BackgroundServices/LndInvoiceListener.cs

@@ -84,7 +84,7 @@ protected override async Task ExecuteAsync(CancellationToken cancelToken)
                 _logger.LogError($"{nameof(LndInvoiceListener)} listener exception. {ex}");
             }
 
-            _logger.LogDebug($"{nameof(LndInvoiceListener)} delaying {RESTART_DELAY_SECONDS}s before attempting to reconnect the grpc listener.");
+            _logger.LogDebug($"{nameof(LndInvoiceListener)} delaying {RESTART_DELAY_SECONDS}s before attempting to reconnect the grpc listener at.");
             await Task.Delay(1000 * RESTART_DELAY_SECONDS);
         }
     }

examples/WebRTCLightningExamples/WebRTCLightningGetStarted/ConfigKeys.cs

@@ -19,7 +19,9 @@ public class ConfigKeys
 {
     public const string LND_URL = "Lnd:Url";
 
-    public const string LND_MACAROON = "Lnd:Macaroon";
+    public const string LND_MACAROON_PATH = "Lnd:MacaroonPath";
+
+    public const string LND_MACAROON_HEX = "Lnd:MacaroonHex";
 
     public const string LND_CERTIFICATE_PATH = "Lnd:CertificatePath";
 

examples/WebRTCLightningExamples/WebRTCLightningGetStarted/README.md

@@ -17,6 +17,7 @@
 using Grpc.Net.Client;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using NBitcoin.DataEncoders;
 using System;
 using System.IO;
 using System.Linq;
@@ -42,7 +43,7 @@ public class LightningClientFactory : ILightningClientFactory
     private IConfiguration _config;
 
     private readonly string _lndUrl;
-    private readonly string _lndMacaroon;
+    private readonly string _lndMacaroonHex;
     private readonly X509Certificate2 _lndCertificate;
 
     public LightningClientFactory(
@@ -53,10 +54,28 @@ public LightningClientFactory(
         _config = config;
 
         _lndUrl = config[ConfigKeys.LND_URL] ?? string.Empty;
-        _lndMacaroon = config[ConfigKeys.LND_MACAROON]  ?? string.Empty;
+        _lndMacaroonHex = LoadLndMacaroonAsHex();
         _lndCertificate = LoadLndPublicCertificate() ?? new X509Certificate2([]);
+    }
+
+    private string LoadLndMacaroonAsHex()
+    {
+        var macaroonFilePath = _config[ConfigKeys.LND_MACAROON_PATH];
+
+        if (!string.IsNullOrWhiteSpace(macaroonFilePath))
+        {
+            if(!File.Exists(macaroonFilePath))
+            {
+                _logger.LogError($"Macaroon file does not exist at {macaroonFilePath}.");
+            }
+            else
+            {
+                var macaroonBytes = File.ReadAllBytes(macaroonFilePath);
+                return Encoders.Hex.EncodeData(macaroonBytes);
+            }
+        }
 
-        //_logger.LogInformation($"{nameof(LightningClientFactory)} initialised with url {_lndUrl} and certificate thumbprint {_lndCertificate.Thumbprint}.");
+        return _config[ConfigKeys.LND_MACAROON_HEX] ?? string.Empty;
     }
 
     private X509Certificate2? LoadLndPublicCertificate()
@@ -144,7 +163,7 @@ public Routerrpc.Router.RouterClient GetRouterClient()
 
     private Task AddMacaroon(AuthInterceptorContext context, Metadata metadata)
     {
-        metadata.Add(new Metadata.Entry("macaroon", _lndMacaroon));
+        metadata.Add(new Metadata.Entry("macaroon", _lndMacaroonHex));
         return Task.CompletedTask;
     }
 

examples/WebRTCLightningExamples/WebRTCLightningGetStarted/Services/LightningClientFactory.cs

@@ -1,11 +1,11 @@
 {
   "Lnd": {
-    //"Url": "https://x.x.x.x:10009",
-    // To get the macaroon in base64 format, run the following command: xxd -p -c 1000 admin.macaroon | tr -d '\n'
-    //"Macaroon": "" // Secret store.
-    //"CertificatePath": "c:/dev/certs/lnd-tls.cert",
+    "Url": "https://localhost:10009",
+    "MacaroonPath": "../lnd-data/data/chain/bitcoin/signet/admin.macaroon",
+    // To get the macaroon in hex format, run the following command: xxd -p -c 1000 admin.macaroon | tr -d '\n'
+    //"MacaroonHex": "",
+    "CertificatePath": "../lnd-data/tls.cert"
     // To get the certificate in base64 format, run the following command: cat .lnd/tls.cert | base64 -w 0
     // "CertificateBase64": "base64 cert"
-    "DefaultInvoiceExpirySeconds": 900
   }
 }