build:
strategy:
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.36.0 is MSRV for Rust-Lightning, lightning-invoice, and lightning-persister
+ 1.36.0,
+ # 1.41.0 is Debian stable
+ 1.41.0,
+ # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation
+ 1.45.2,
+ # 1.49.0 is MSRV for no_std builds using hashbrown
+ 1.49.0]
include:
- toolchain: stable
build-net-tokio: true
+ build-no-std: true
+ - toolchain: stable
+ platform: macos-latest
+ build-net-tokio: true
+ build-no-std: true
+ - toolchain: stable
+ platform: windows-latest
+ build-net-tokio: true
+ build-no-std: true
- toolchain: beta
build-net-tokio: true
- - toolchain: 1.39.0
+ build-no-std: true
+ - toolchain: 1.36.0
+ build-no-std: false
+ - toolchain: 1.41.0
+ build-no-std: false
+ - toolchain: 1.45.2
build-net-tokio: true
+ build-no-std: false
coverage: true
- - toolchain: 1.34.2
- runs-on: ubuntu-latest
+ - toolchain: 1.49.0
+ build-no-std: true
+ runs-on: ${{ matrix.platform }}
steps:
- name: Checkout source code
uses: actions/checkout@v2
override: true
profile: minimal
- name: Build on Rust ${{ matrix.toolchain }} with net-tokio
- if: matrix.build-net-tokio
+ if: "matrix.build-net-tokio && !matrix.coverage"
+ run: cargo build --verbose --color always
+ - name: Build on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
+ if: matrix.coverage
run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
- name: Build on Rust ${{ matrix.toolchain }}
if: "! matrix.build-net-tokio"
- run: RUSTFLAGS="-C link-dead-code" 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 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 on Rust ${{ matrix.toolchain }} with net-tokio
- if: matrix.build-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 on no_std bullds Rust ${{ matrix.toolchain }}
+ if: "matrix.build-no-std && !matrix.coverage"
+ run: |
+ cd lightning
+ cargo test --verbose --color always --features hashbrown
+ cd ..
+ - name: Test on no_std bullds 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 --features hashbrown
+ cd ..
- name: Test on Rust ${{ matrix.toolchain }}
if: "! matrix.build-net-tokio"
- run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always -p lightning
+ run: |
+ cargo test --verbose --color always -p lightning
+ cargo test --verbose --color always -p lightning-invoice
+ cargo build --verbose --color always -p lightning-persister
+ - 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";
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@v2
+ - 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@v2
+ 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: |
+ wget -O lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
+ if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303" ]; then
+ echo "Bad hash"
+ exit 1
+ fi
+ - 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 unstable
+
check_commits:
runs-on: ubuntu-latest
env:
- TOOLCHAIN: stable
+ # rustc 1.53 regressed and panics when building our (perfectly fine) docs.
+ # See https://github.com/rust-lang/rust/issues/84738
+ TOOLCHAIN: 1.52.1
steps:
- name: Checkout source code
uses: actions/checkout@v2
run: |
git remote add upstream https://github.com/rust-bitcoin/rust-lightning
git fetch upstream
+ export GIT_COMMITTER_EMAIL="rl-ci@example.com"
+ export GIT_COMMITTER_NAME="RL CI"
git rebase upstream/main
- name: For each commit, run cargo check (including in fuzz)
run: ci/check-each-commit.sh upstream/main
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
+ run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
- name: Run fuzzers
- run: cd fuzz && ./ci-fuzz.sh
+ 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
- check_bindings:
+ linting:
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
+ TOOLCHAIN: 1.45.2
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 | sort > lightning-c-bindings/include/lightning.h.sorted
- cat lightning-c-bindings/include/lightning.h.new | 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
- #
- mv lightning-c-bindings/include/lightningpp.hpp lightning-c-bindings/include/lightningpp.hpp.new
- git checkout lightning-c-bindings/include/lightningpp.hpp
- cat lightning-c-bindings/include/lightningpp.hpp | sort > lightning-c-bindings/include/lightningpp.hpp.sorted
- cat lightning-c-bindings/include/lightningpp.hpp.new | sort > lightning-c-bindings/include/lightningpp.hpp.new.sorted
- diff lightning-c-bindings/include/lightningpp.hpp.sorted lightning-c-bindings/include/lightningpp.hpp.new.sorted
- #
- [ "$(diff lightning-c-bindings/include/lightning.h.sorted lightning-c-bindings/include/lightning.h.new.sorted)" != "" ] && exit 2
- [ "$(diff lightning-c-bindings/include/lightningpp.hpp.sorted lightning-c-bindings/include/lightningpp.hpp.new.sorted)" != "" ] && exit 3
- git diff --exit-code
- fi
+ - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: ${{ env.TOOLCHAIN }}
+ override: true
+ profile: minimal
+ - name: Install clippy
+ run: |
+ rustup component add clippy
+ - name: Run default clippy linting
+ run: |
+ cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else