feat(cbf): add BIP 157 compact block filter chain source

Squashed base CBF commits (rebased onto upstream/main):
- Add optional fee source from esplora/electrum
- Add BIP 157 compact block filter chain source
- Add CBF integration tests and documentation
- Fix CBF chain source build errors and UniFFI bindings
- Remove last_synced_height from cbf

Author: febyeji

.github/workflows/python.yml

@@ -17,15 +17,21 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install uv
-        uses: astral-sh/setup-uv@v7
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
 
       - name: Generate Python bindings
         run: ./scripts/uniffi_bindgen_generate_python.sh
 
       - name: Start bitcoind and electrs
         run: docker compose up -d
 
+      - name: Install testing prerequisites
+        run: |
+          pip3 install requests
+
       - name: Run Python unit tests
         env:
           BITCOIN_CLI_BIN: "docker exec ldk-node-bitcoin-1 bitcoin-cli"
@@ -34,4 +40,4 @@ jobs:
           ESPLORA_ENDPOINT: "http://127.0.0.1:3002"
         run: |
           cd $LDK_NODE_PYTHON_DIR
-          uv run --group dev python -m unittest discover -s src/ldk_node
+          python3 -m unittest discover -s src/ldk_node

.github/workflows/rust.yml

@@ -41,10 +41,6 @@ jobs:
       - name: Check formatting on Rust ${{ matrix.toolchain }}
         if: matrix.check-fmt
         run: rustup component add rustfmt && cargo fmt --all -- --check
-      - name: Pin packages to allow for MSRV
-        if: matrix.msrv
-        run: |
-          cargo update -p idna_adapter --precise "1.2.0" --verbose # idna_adapter 1.2.1 uses ICU4X 2.2.0, requiring 1.86 and newer
       - name: Set RUSTFLAGS to deny warnings
         if: "matrix.toolchain == 'stable'"
         run: echo "RUSTFLAGS=-D warnings" >> "$GITHUB_ENV"
@@ -84,7 +80,11 @@ jobs:
       - name: Test on Rust ${{ matrix.toolchain }}
         if: "matrix.platform != 'windows-latest'"
         run: |
-          RUSTFLAGS="--cfg no_download --cfg cycle_tests" cargo test
+          RUSTFLAGS="--cfg no_download --cfg cycle_tests" cargo test -- --skip cbf
+      - name: Test CBF on Rust ${{ matrix.toolchain }}
+        if: "matrix.platform != 'windows-latest'"
+        run: |
+          RUSTFLAGS="--cfg no_download --cfg cycle_tests" cargo test cbf -- --test-threads=1
       - name: Test with UniFFI support on Rust ${{ matrix.toolchain }}
         if: "matrix.platform != 'windows-latest' && matrix.build-uniffi"
         run: |

Cargo.toml

@@ -54,6 +54,7 @@ lightning-macros = { git = "https://github.com/lightningdevkit/rust-lightning",
 bdk_chain = { version = "0.23.0", default-features = false, features = ["std"] }
 bdk_esplora = { version = "0.22.0", default-features = false, features = ["async-https-rustls", "tokio"]}
 bdk_electrum = { version = "0.23.0", default-features = false, features = ["use-rustls-ring"]}
+bip157 = { version = "0.4.2", default-features = false }
 bdk_wallet = { version = "2.3.0", default-features = false, features = ["std", "keys-bip39"]}
 
 bitreq = { version = "0.3", default-features = false, features = ["async-https", "json-using-serde"] }
@@ -66,7 +67,7 @@ bip21 = { version = "0.5", features = ["std"], default-features = false }
 base64 = { version = "0.22.1", default-features = false, features = ["std"] }
 getrandom = { version = "0.3", default-features = false }
 chrono = { version = "0.4", default-features = false, features = ["clock"] }
-tokio = { version = "1.37", default-features = false, features = [ "rt-multi-thread", "time", "sync", "macros", "net" ] }
+tokio = { version = "1.37", default-features = false, features = [ "rt-multi-thread", "time", "sync", "macros" ] }
 esplora-client = { version = "0.12", default-features = false, features = ["tokio", "async-https-rustls"] }
 electrum-client = { version = "0.24.0", default-features = false, features = ["proxy", "use-rustls-ring"] }
 libc = "0.2"

README.md

@@ -61,7 +61,7 @@ fn main() {
 LDK Node currently comes with a decidedly opinionated set of design choices:
 
 - On-chain data is handled by the integrated [BDK][bdk] wallet.
-- Chain data may currently be sourced from the Bitcoin Core RPC interface, or from an [Electrum][electrum] or [Esplora][esplora] server.
+- Chain data may currently be sourced from the Bitcoin Core RPC interface, from an [Electrum][electrum] or [Esplora][esplora] server, or via [compact block filters (BIP 157)][bip157].
 - Wallet and channel state may be persisted to an [SQLite][sqlite] database, to file system, or to a custom back-end to be implemented by the user.
 - Gossip data may be sourced via Lightning's peer-to-peer network or the [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) protocol.
 - Entropy for the Lightning and on-chain wallets may be sourced from raw bytes or a [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic. In addition, LDK Node offers the means to generate and persist the entropy bytes to disk.
@@ -80,6 +80,7 @@ The Minimum Supported Rust Version (MSRV) is currently 1.85.0.
 [bdk]: https://bitcoindevkit.org/
 [electrum]: https://github.com/spesmilo/electrum-protocol
 [esplora]: https://github.com/Blockstream/esplora
+[bip157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
 [sqlite]: https://sqlite.org/
 [rust]: https://www.rust-lang.org/
 [swift]: https://www.swift.org/

bindings/ldk_node.udl

@@ -9,6 +9,8 @@ typedef dictionary EsploraSyncConfig;
 
 typedef dictionary ElectrumSyncConfig;
 
+typedef dictionary CbfSyncConfig;
+
 typedef dictionary TorConfig;
 
 typedef interface NodeEntropy;
@@ -38,6 +40,7 @@ interface Builder {
 	constructor(Config config);
 	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
 	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
+	void set_chain_source_cbf(sequence<string> peers, CbfSyncConfig? sync_config, FeeSourceConfig? fee_source_config);
 	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
 	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
 	void set_gossip_source_p2p();
@@ -354,6 +357,8 @@ enum Currency {
 
 typedef enum AsyncPaymentsRole;
 
+typedef enum FeeSourceConfig;
+
 [Custom]
 typedef string Txid;
 

bindings/python/hatch_build.py

@@ -1,16 +1,12 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
 [project]
 name = "ldk_node"
 version = "0.7.0"
 authors = [
   { name="Elias Rohrer", email="dev@tnull.de" },
 ]
 description = "A ready-to-go Lightning node library built using LDK and BDK."
-readme = "../../README.md"
-requires-python = ">=3.8"
+readme = "README.md"
+requires-python = ">=3.6"
 classifiers = [
     "Topic :: Software Development :: Libraries",
     "Topic :: Security :: Cryptography",
@@ -23,11 +19,3 @@ classifiers = [
 "Homepage" = "https://lightningdevkit.org/"
 "Github" = "https://github.com/lightningdevkit/ldk-node"
 "Bug Tracker" = "https://github.com/lightningdevkit/ldk-node/issues"
-
-[dependency-groups]
-dev = ["requests"]
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/ldk_node"]
-
-[tool.hatch.build.hooks.custom]

bindings/python/pyproject.toml

@@ -0,0 +1,13 @@
+[options]
+packages = find:
+package_dir =
+    = src
+include_package_data = True
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+ldk_node =
+    *.so
+    *.dylib

bindings/python/setup.cfg

@@ -0,0 +1,3 @@
+#!/bin/bash
+cd bindings/python || exit 1
+python3 -m build