Merge ldk-server into ldk-node repository #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

joostjager wants to merge 278 commits into lightningdevkit:main from joostjager:ldk-server

+9,331 −0

.github/workflows/ldk-server-rabbitmq-integration.yml

-Original file line number
+Diff line change
@@ -0,0 +1,34 @@
+    name: LDK Server - RabbitMQ Integration Tests
+    on: [ push, pull_request ]
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+    jobs:
+      integration-tests:
+        runs-on: ubuntu-latest
+        services:
+          rabbitmq:
+            image: rabbitmq:3
+            env:
+              RABBITMQ_DEFAULT_USER: guest
+              RABBITMQ_DEFAULT_PASS: guest
+            ports:
+              - 5672:5672
+            options: >-
+              --health-cmd "rabbitmqctl node_health_check"
+              --health-interval 10s
+              --health-timeout 5s
+              --health-retries 5
+        steps:
+          - name: Checkout code
+            uses: actions/checkout@v4
+          - name: Run RabbitMQ integration tests
+            run: cargo test -p ldk-server --features integration-tests-events-rabbitmq --verbose --color=always -- --nocapture
+            env:
+              RUST_BACKTRACE: 1

.github/workflows/ldk-server.yml

-Original file line number
+Diff line change
@@ -0,0 +1,43 @@
+    name: CI Checks - LDK Server
+    on: [push, pull_request]
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+    jobs:
+      build:
+        strategy:
+          matrix:
+            platform: [
+              ubuntu-latest,
+              macos-latest,
+            ]
+            toolchain: [
+              stable,
+              beta,
+.85.0, # MSRV, same as ldk-node
+            ]
+            include:
+              - toolchain: 1.85.0
+                msrv: true
+        runs-on: ${{ matrix.platform }}
+        steps:
+          - name: Checkout source code
+            uses: actions/checkout@v3
+          - name: Install Rust ${{ matrix.toolchain }} toolchain
+            run: |
+              curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ matrix.toolchain }}
+              if [ "${{ matrix.msrv }}" = "true" ]; then rustup component add clippy; fi
+          - name: Build ldk-server crates on Rust ${{ matrix.toolchain }}
+            run: cargo build -p ldk-server -p ldk-server-cli -p ldk-server-client -p ldk-server-protos --verbose --color always
+          - name: Check clippy on ldk-server if on msrv
+            if: matrix.msrv
+            run: cargo clippy -p ldk-server --all-features -- -D warnings
+          - name: Test ldk-server crates on Rust ${{ matrix.toolchain }}
+            run: cargo test -p ldk-server -p ldk-server-cli -p ldk-server-client -p ldk-server-protos
+          - name: Cargo check release on Rust ${{ matrix.toolchain }}
+            run: cargo check --release -p ldk-server -p ldk-server-cli -p ldk-server-client -p ldk-server-protos
+          - name: Cargo check doc on Rust ${{ matrix.toolchain }}
+            run: cargo doc --release -p ldk-server -p ldk-server-cli -p ldk-server-client -p ldk-server-protos

Cargo.toml

-Original file line number
+Diff line change
@@ -1,3 +1,12 @@
+    [workspace]
+    resolver = "2"
+    members = [
+    	"ldk-server/ldk-server",
+    	"ldk-server/ldk-server-cli",
+    	"ldk-server/ldk-server-client",
+    	"ldk-server/ldk-server-protos",
+    ]
     [package]
     name = "ldk-node"
     version = "0.8.0+git"
@@ Expand Down Expand Up @@
     [profile.release]
     panic = "abort"
+    [profile.release.package.ldk-server]
+    opt-level = 3
+    [profile.release.package.ldk-server-cli]
+    opt-level = 3
+    [profile.release.package.ldk-server-client]
+    opt-level = 3
+    [profile.release.package.ldk-server-protos]
+    opt-level = 3
     [profile.dev]
     panic = "abort"
@@ Expand Down @@

ldk-server/.gitignore

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		/target

ldk-server/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,72 @@
+    # LDK Server
+    **LDK Server** is a fully-functional Lightning node in daemon form, built on top of
+    [LDK Node](https://github.com/lightningdevkit/ldk-node), which itself provides a powerful abstraction over the
+    [Lightning Development Kit (LDK)](https://github.com/lightningdevkit/rust-lightning) and uses a built-in
+    [Bitcoin Development Kit (BDK)](https://bitcoindevkit.org/) wallet.
+    The primary goal of LDK Server is to provide an efficient, stable, and API-first solution for deploying and managing
+    a Lightning Network node. With its streamlined setup, LDK Server enables users to easily set up, configure, and run
+    a Lightning node while exposing a robust, language-agnostic API via [Protocol Buffers (Protobuf)](https://protobuf.dev/).
+    ### Features
+    - **Out-of-the-Box Lightning Node**:
+        - Deploy a Lightning Network node with minimal configuration, no coding required.
+    - **API-First Design**:
+        - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
+    - **Powered by LDK**:
+        - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
+    - **Effortless Integration**:
+        - Ideal for embedding Lightning functionality into payment processors, self-hosted nodes, custodial wallets, or other Lightning-enabled
+          applications.
+    ### Project Status
+    🚧 **Work in Progress**:
+    - **APIs Under Development**: Expect breaking changes as the project evolves.
+    - **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
+    - **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
+    - **Pending Testing**: Not tested, hence don't use it for production!
+    We welcome your feedback and contributions to help shape the future of LDK Server!
+    ### Configuration
+    Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.
+    ### Building
+    ```
+    git clone https://github.com/lightningdevkit/ldk-server.git
+    cargo build
+    ```
+    ### Running
+    ```
+    cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
+    ```
+    Interact with the node using CLI:
+    ```
+    ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
+    ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
+    ```
+    ### Shell Completions
+    The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
+    Add completions to your shell config:
+    ```bash
+    # Bash (add to ~/.bashrc)
+    eval "$(ldk-server-cli completions bash)"
+    # Zsh (add to ~/.zshrc)
+    eval "$(ldk-server-cli completions zsh)"
+    # Fish (add to ~/.config/fish/config.fish)
+    ldk-server-cli completions fish | source
+    ```

ldk-server/ldk-server-cli/Cargo.toml

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    [package]
+    name = "ldk-server-cli"
+    version = "0.1.0"
+    edition = "2021"
+    [dependencies]
+    ldk-server-client = { path = "../ldk-server-client", features = ["serde"] }
+    clap = { version = "4.0.5", default-features = false, features = ["derive", "std", "error-context", "suggestions", "help"] }
+    clap_complete = { version = "4.0", default-features = false }
+    hex-conservative = { version = "0.2", default-features = false, features = ["std"] }
+    tokio = { version = "1.38.0", default-features = false, features = ["rt-multi-thread", "macros"] }
+    serde = "1.0"
+    serde_json = "1.0"
+    toml = { version = "0.8", default-features = false, features = ["parse"] }

ldk-server/ldk-server-cli/src/config.rs

-Original file line number
+Diff line change
@@ -0,0 +1,82 @@
+    // This file is Copyright its original authors, visible in version control
+    // history.
+    //
+    // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+    // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+    // You may not use this file except in accordance with one or both of these
+    // licenses.
+    use std::path::PathBuf;
+    use serde::{Deserialize, Serialize};
+    const DEFAULT_CONFIG_FILE: &str = "config.toml";
+    const DEFAULT_CERT_FILE: &str = "tls.crt";
+    const API_KEY_FILE: &str = "api_key";
+    pub fn get_default_data_dir() -> Option<PathBuf> {
+    	#[cfg(target_os = "macos")]
+    	{
+    		#[allow(deprecated)] // todo can remove once we update MSRV to 1.87+
+    		std::env::home_dir().map(|home| home.join("Library/Application Support/ldk-server"))
+    	}
+    	#[cfg(target_os = "windows")]
+    	{
+    		std::env::var("APPDATA").ok().map(|appdata| PathBuf::from(appdata).join("ldk-server"))
+    	}
+    	#[cfg(not(any(target_os = "macos", target_os = "windows")))]
+    	{
+    		#[allow(deprecated)] // todo can remove once we update MSRV to 1.87+
+    		std::env::home_dir().map(|home| home.join(".ldk-server"))
+    	}
+    }
+    pub fn get_default_config_path() -> Option<PathBuf> {
+    	get_default_data_dir().map(|dir| dir.join(DEFAULT_CONFIG_FILE))
+    }
+    pub fn get_default_cert_path() -> Option<PathBuf> {
+    	get_default_data_dir().map(|path| path.join(DEFAULT_CERT_FILE))
+    }
+    pub fn get_default_api_key_path(network: &str) -> Option<PathBuf> {
+    	get_default_data_dir().map(|path| path.join(network).join(API_KEY_FILE))
+    }
+    #[derive(Debug, Deserialize)]
+    pub struct Config {
+    	pub node: NodeConfig,
+    	pub tls: Option<TlsConfig>,
+    }
+    #[derive(Debug, Deserialize, Serialize)]
+    pub struct TlsConfig {
+    	pub cert_path: Option<String>,
+    }
+    #[derive(Debug, Deserialize)]
+    pub struct NodeConfig {
+    	pub rest_service_address: String,
+    	network: String,
+    }
+    impl Config {
+    	pub fn network(&self) -> Result<String, String> {
+    		match self.node.network.as_str() {
+    			"bitcoin" | "mainnet" => Ok("bitcoin".to_string()),
+    			"testnet" => Ok("testnet".to_string()),
+    			"testnet4" => Ok("testnet4".to_string()),
+    			"signet" => Ok("signet".to_string()),
+    			"regtest" => Ok("regtest".to_string()),
+    			other => Err(format!("Unsupported network: {other}")),
+    		}
+    	}
+    }
+    pub fn load_config(path: &PathBuf) -> Result<Config, String> {
+    	let contents = std::fs::read_to_string(path)
+    		.map_err(|e| format!("Failed to read config file '{}': {}", path.display(), e))?;
+    	toml::from_str(&contents)
+    		.map_err(|e| format!("Failed to parse config file '{}': {}", path.display(), e))
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge ldk-server into ldk-node repository #773

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Merge ldk-server into ldk-node repository #773

Are you sure you want to change the base?

Merge ldk-server into ldk-node repository #773

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!