jobs:
build:
strategy:
+ fail-fast: false
matrix:
platform: [ ubuntu-latest ]
toolchain: [ stable,
beta,
- # 1.30.0 is MSRV for Rust-Lightning
- 1.30.0,
- # 1.34.2 is Debian stable
- 1.34.2,
- # 1.39.0 is MSRV for lightning-net-tokio and generates coverage
- 1.39.0]
+ # 1.41.1 is MSRV for Rust-Lightning, lightning-invoice, and lightning-persister
+ 1.41.1,
+ # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, lightning-background-processor, and coverage generation
+ 1.45.2,
+ # 1.47.0 will be the MSRV for no-std builds using hashbrown once core2 is updated
+ 1.47.0]
include:
- toolchain: stable
build-net-tokio: true
+ build-no-std: true
+ build-futures: true
- toolchain: stable
platform: macos-latest
build-net-tokio: true
+ build-no-std: true
+ build-futures: true
+ - toolchain: beta
+ platform: macos-latest
+ build-net-tokio: true
+ build-no-std: true
+ build-futures: true
- toolchain: stable
platform: windows-latest
build-net-tokio: true
+ build-no-std: true
+ build-futures: true
- toolchain: beta
+ platform: windows-latest
build-net-tokio: true
- - toolchain: 1.39.0
+ build-no-std: true
+ build-futures: true
+ - toolchain: beta
build-net-tokio: true
+ build-no-std: true
+ build-futures: true
+ - toolchain: 1.41.1
+ build-no-std: false
+ test-log-variants: true
+ build-futures: false
+ - toolchain: 1.45.2
+ build-net-old-tokio: true
+ build-net-tokio: true
+ build-no-std: false
+ build-futures: true
coverage: true
+ - toolchain: 1.47.0
+ build-futures: true
+ build-no-std: true
runs-on: ${{ matrix.platform }}
steps:
- name: Checkout source code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- name: Install Rust ${{ matrix.toolchain }} toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: ${{ matrix.toolchain }}
override: true
profile: minimal
+ - name: Pin tokio to 1.14 for Rust 1.45
+ if: "matrix.build-net-old-tokio"
+ run: cargo update -p tokio --precise "1.14.0" --verbose
+ env:
+ CARGO_NET_GIT_FETCH_WITH_CLI: "true"
- name: Build on Rust ${{ matrix.toolchain }} with net-tokio
if: "matrix.build-net-tokio && !matrix.coverage"
run: cargo build --verbose --color always
run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
- name: Build on Rust ${{ matrix.toolchain }}
if: "! matrix.build-net-tokio"
- run: cargo build --verbose --color always -p lightning
+ run: |
+ cargo build --verbose --color always -p lightning
+ cargo build --verbose --color always -p lightning-invoice
+ cargo build --verbose --color always -p lightning-persister
+ - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features
+ if: matrix.test-log-variants
+ run: |
+ cd lightning
+ for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
+ cargo build --verbose --color always --features $FEATURE
+ done
+ - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: |
+ cd lightning-block-sync
+ cargo build --verbose --color always --features rest-client
+ cargo build --verbose --color always --features rpc-client
+ cargo build --verbose --color always --features rpc-client,rest-client
+ cargo build --verbose --color always --features rpc-client,rest-client,tokio
+ - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
+ if: matrix.coverage
+ run: |
+ cd lightning-block-sync
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
+ RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
+ - name: Test backtrace-debug builds on Rust ${{ matrix.toolchain }}
+ if: "matrix.build-no-std"
+ run: |
+ cd lightning && cargo test --verbose --color always --features backtrace
- name: Test on Rust ${{ matrix.toolchain }} with net-tokio
if: "matrix.build-net-tokio && !matrix.coverage"
run: cargo test --verbose --color always
- name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
if: matrix.coverage
run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
+ - name: Test no-std builds on Rust ${{ matrix.toolchain }}
+ if: "matrix.build-no-std && !matrix.coverage"
+ shell: bash # Default on Winblows is powershell
+ run: |
+ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
+ cd $DIR
+ cargo test --verbose --color always --no-default-features --features no-std
+ # check if there is a conflict between no-std and the default std feature
+ cargo test --verbose --color always --features no-std
+ # check that things still pass without grind_signatures
+ # note that outbound_commitment_test only runs in this mode, because of hardcoded signature values
+ cargo test --verbose --color always --no-default-features --features std
+ # check if there is a conflict between no-std and the c_bindings cfg
+ RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
+ cd ..
+ done
+ # check no-std compatibility across dependencies
+ cd no-std-check
+ cargo check --verbose --color always
+ - name: Build no-std-check on Rust ${{ matrix.toolchain }} for ARM Embedded
+ if: "matrix.build-no-std && matrix.platform == 'ubuntu-latest'"
+ run: |
+ cd no-std-check
+ rustup target add thumbv7m-none-eabi
+ sudo apt-get -y install gcc-arm-none-eabi
+ cargo build --target=thumbv7m-none-eabi
+ - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
+ if: "matrix.build-no-std && matrix.coverage"
+ run: |
+ cd lightning
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
+ - name: Test futures builds on Rust ${{ matrix.toolchain }}
+ if: "matrix.build-futures && !matrix.coverage"
+ shell: bash # Default on Winblows is powershell
+ run: |
+ cd lightning-background-processor
+ cargo test --verbose --color always --no-default-features --features futures
+ - name: Test futures builds on Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
+ if: "matrix.build-futures && matrix.coverage"
+ shell: bash # Default on Winblows is powershell
+ run: |
+ cd lightning-background-processor
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features futures
- name: Test on Rust ${{ matrix.toolchain }}
if: "! matrix.build-net-tokio"
- run: cargo test --verbose --color always -p lightning
+ run: |
+ cargo test --verbose --color always -p lightning
+ cargo test --verbose --color always -p lightning-invoice
+ cargo test --verbose --color always -p lightning-rapid-gossip-sync
+ cargo test --verbose --color always -p lightning-persister
+ cargo test --verbose --color always -p lightning-background-processor
+ - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
+ if: "! matrix.build-net-tokio"
+ run: |
+ RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning
+ RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning-invoice
+ RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-persister
+ RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-background-processor
+ - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: |
+ cd lightning-block-sync
+ cargo test --verbose --color always --features rest-client
+ cargo test --verbose --color always --features rpc-client
+ cargo test --verbose --color always --features rpc-client,rest-client
+ cargo test --verbose --color always --features rpc-client,rest-client,tokio
+ - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
+ if: matrix.coverage
+ run: |
+ cd lightning-block-sync
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
+ RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
- name: Install deps for kcov
if: matrix.coverage
run: |
- name: Generate coverage report
if: matrix.coverage
run: |
- for file in target/debug/lightning-*; do
+ for file in target/debug/deps/lightning*; do
[ -x "${file}" ] || continue;
mkdir -p "target/cov/$(basename $file)";
./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
done
- name: Upload coverage
if: matrix.coverage
- uses: codecov/codecov-action@v1
+ uses: codecov/codecov-action@v3
with:
# Could you use this to fake the coverage report for your PR? Sure.
# Will anyone be impressed by your amazing coverage? No
token: f421b687-4dc2-4387-ac3d-dc3b2528af57
fail_ci_if_error: true
+ benchmark:
+ runs-on: ubuntu-latest
+ env:
+ TOOLCHAIN: nightly
+ steps:
+ - name: Checkout source code
+ uses: actions/checkout@v3
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Cache routing graph snapshot
+ id: cache-graph
+ uses: actions/cache@v3
+ with:
+ path: lightning/net_graph-2021-05-31.bin
+ key: ldk-net_graph-v0.0.15-2021-05-31.bin
+ - name: Fetch routing graph snapshot
+ if: steps.cache-graph.outputs.cache-hit != 'true'
+ run: |
+ curl --verbose -L -o lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
+ echo "Sha sum: $(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')"
+ if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
+ echo "Bad hash"
+ exit 1
+ fi
+ env:
+ EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: 05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303
+ - name: Fetch rapid graph sync reference input
+ run: |
+ curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
+ echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
+ if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
+ echo "Bad hash"
+ exit 1
+ fi
+ env:
+ EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
+ - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
+ run: |
+ cd lightning
+ RUSTFLAGS="--cfg=require_route_graph_test" cargo test
+ RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
+ cd ..
+ - name: Run benchmarks on Rust ${{ matrix.toolchain }}
+ run: |
+ cargo bench --features _bench_unstable
+
check_commits:
runs-on: ubuntu-latest
env:
- TOOLCHAIN: stable
+ TOOLCHAIN: 1.57.0
steps:
- name: Checkout source code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Install Rust ${{ env.TOOLCHAIN }} toolchain
profile: minimal
- name: Fetch full tree and rebase on upstream
run: |
- git remote add upstream https://github.com/rust-bitcoin/rust-lightning
+ git remote add upstream https://github.com/lightningdevkit/rust-lightning
git fetch upstream
export GIT_COMMITTER_EMAIL="rl-ci@example.com"
export GIT_COMMITTER_NAME="RL CI"
- name: For each commit, run cargo check (including in fuzz)
run: ci/check-each-commit.sh upstream/main
- fuzz:
+ check_release:
runs-on: ubuntu-latest
env:
TOOLCHAIN: stable
steps:
- name: Checkout source code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
- name: Install Rust ${{ env.TOOLCHAIN }} toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: ${{ env.TOOLCHAIN }}
override: true
profile: minimal
- - name: Install dependencies for honggfuzz
+ - name: Run cargo check for release build.
run: |
- sudo apt-get update
- sudo apt-get -y install build-essential binutils-dev libunwind-dev
- - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
- run: cd fuzz && cargo test --verbose --color always
- - name: Run fuzzers
- run: cd fuzz && ./ci-fuzz.sh
+ cargo check --release
+ cargo check --no-default-features --features=no-std --release
+ cargo check --no-default-features --features=futures --release
+ cargo doc --release
- check_bindings:
+ fuzz:
runs-on: ubuntu-latest
- # Ubuntu's version of rustc uses its own LLVM instead of being a real native package.
- # This leaves us with an incompatible LLVM version when linking. Instead, use a real OS.
- # We further (temporarily) use Debian experimental since testing links rustc against the
- # brand-new llvm-10, but clang/llvm still default to LLVM 9.
- container: debian:experimental
env:
TOOLCHAIN: stable
steps:
- - name: Install native Rust toolchain, Valgrind, and build utilitis
- run: |
- echo 'Package: llvm llvm-runtime clang lld' > /etc/apt/preferences.d/99-llvm10
- echo 'Pin: release n=experimental' >> /etc/apt/preferences.d/99-llvm10
- echo 'Pin-Priority: 995' >> /etc/apt/preferences.d/99-llvm10
- apt-get update
- apt-get -y dist-upgrade
- apt-get -y install cargo valgrind lld git g++ clang
- name: Checkout source code
- uses: actions/checkout@v2
- - name: Sanity test bindings
- working-directory: lightning-c-bindings
- run: cargo check
- - name: Install cbindgen
- run: cargo install --force cbindgen
- - name: Rebuild bindings, and check the sample app builds + links
- run: ./genbindings.sh
- - name: Check that the latest bindings are in git
- run: |
- if [ "$(git diff)" != "" ]; then
- # cbindgen's bindings output order can be FS-dependant, so check that the lines are all the same:
- mv lightning-c-bindings/include/lightning.h lightning-c-bindings/include/lightning.h.new
- git checkout lightning-c-bindings/include/lightning.h
- cat lightning-c-bindings/include/lightning.h | grep -v "Generated with cbindgen:[0-9\.]*" | sort > lightning-c-bindings/include/lightning.h.sorted
- cat lightning-c-bindings/include/lightning.h.new | grep -v "Generated with cbindgen:[0-9\.]*" | sort > lightning-c-bindings/include/lightning.h.new.sorted
- diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted
- [ "$(diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted)" != "" ] && exit 2
- git diff --exit-code
- fi
+ uses: actions/checkout@v3
+ - name: Install Rust 1.58 toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: 1.58
+ override: true
+ profile: minimal
+ - name: Install dependencies for honggfuzz
+ run: |
+ sudo apt-get update
+ sudo apt-get -y install build-essential binutils-dev libunwind-dev
+ - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
+ run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
+ - name: Run fuzzers
+ run: cd fuzz && ./ci-fuzz.sh && cd ..
+ - name: Run lightning-invoice fuzzers
+ run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
linting:
runs-on: ubuntu-latest
env:
- TOOLCHAIN: 1.39.0
+ TOOLCHAIN: 1.47.0
steps:
- name: Checkout source code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
- name: Install Rust ${{ env.TOOLCHAIN }} toolchain
uses: actions-rs/toolchain@v1
with:
rustup component add clippy
- name: Run default clippy linting
run: |
- cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else
+ cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err