1 name: Continuous Integration Checks
12 group: ${{ github.workflow }}-${{ github.ref }}
13 cancel-in-progress: true
20 platform: [ ubuntu-latest, windows-latest, macos-latest ]
21 toolchain: [ stable, beta ]
24 platform: ubuntu-latest
26 # 1.48.0 is the MSRV for all crates except lightning-transaction-sync and Win/Mac
28 platform: ubuntu-latest
29 # Windows requires 1.49.0 because that's the MSRV for supported Tokio
31 platform: windows-latest
32 # MacOS-latest requires 1.54.0 because that's what's required for linking to work properly
34 platform: macos-latest
35 runs-on: ${{ matrix.platform }}
37 - name: Checkout source code
38 uses: actions/checkout@v3
39 - name: Install Rust ${{ matrix.toolchain }} toolchain
41 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ matrix.toolchain }}
42 rustup override set ${{ matrix.toolchain }}
43 - name: Install no-std-check dependencies for ARM Embedded
44 if: "matrix.platform == 'ubuntu-latest'"
46 rustup target add thumbv7m-none-eabi
47 sudo apt-get -y install gcc-arm-none-eabi
48 - name: shellcheck the CI script
49 if: "matrix.platform == 'ubuntu-latest'"
51 sudo apt-get -y install shellcheck
52 shellcheck ci/ci-tests.sh
53 - name: Run CI script with coverage generation
55 shell: bash # Default on Winblows is powershell
56 run: LDK_COVERAGE_BUILD=true ./ci/ci-tests.sh
58 if: "!matrix.coverage"
59 shell: bash # Default on Winblows is powershell
61 - name: Install deps for kcov
65 sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
69 wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
71 cd kcov-master && mkdir build && cd build
74 make install DESTDIR=../../kcov-build
75 cd ../.. && rm -rf kcov-master master.tar.gz
76 - name: Generate coverage report
79 for file in target/debug/deps/lightning*; do
80 [ -x "${file}" ] || continue;
81 mkdir -p "target/cov/$(basename $file)";
82 ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
84 - name: Upload coverage
86 uses: codecov/codecov-action@v3
88 # Could you use this to fake the coverage report for your PR? Sure.
89 # Will anyone be impressed by your amazing coverage? No
90 # Maybe if codecov wasn't broken we wouldn't need to do this...
91 token: f421b687-4dc2-4387-ac3d-dc3b2528af57
92 fail_ci_if_error: true
95 runs-on: ubuntu-latest
99 - name: Checkout source code
100 uses: actions/checkout@v3
101 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
103 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
104 rustup override set ${{ env.TOOLCHAIN }}
105 - name: Cache routing graph snapshot
107 uses: actions/cache@v3
109 path: lightning/net_graph-2023-01-18.bin
110 key: ldk-net_graph-v0.0.113-2023-01-18.bin
111 - name: Fetch routing graph snapshot
112 if: steps.cache-graph.outputs.cache-hit != 'true'
114 curl --verbose -L -o lightning/net_graph-2023-01-18.bin https://bitcoin.ninja/ldk-net_graph-v0.0.113-2023-01-18.bin
115 echo "Sha sum: $(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')"
116 if [ "$(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
121 EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: da6066f2bddcddbe7d8a6debbd53545697137b310bbb8c4911bc8c81fc5ff48c
122 - name: Fetch rapid graph sync reference input
124 curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
125 echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
126 if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
131 EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
132 - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
135 RUSTFLAGS="--cfg=require_route_graph_test" cargo test
136 RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
138 - name: Run benchmarks on Rust ${{ matrix.toolchain }}
141 RUSTFLAGS="--cfg=ldk_bench --cfg=require_route_graph_test" cargo bench
142 - name: Run benchmarks with hashbrown on Rust ${{ matrix.toolchain }}
145 RUSTFLAGS="--cfg=ldk_bench --cfg=require_route_graph_test" cargo bench --features hashbrown
148 runs-on: ubuntu-latest
152 - name: Checkout source code
153 uses: actions/checkout@v3
156 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
158 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
159 rustup override set ${{ env.TOOLCHAIN }}
160 - name: Fetch full tree and rebase on upstream
162 git remote add upstream https://github.com/lightningdevkit/rust-lightning
164 export GIT_COMMITTER_EMAIL="rl-ci@example.com"
165 export GIT_COMMITTER_NAME="RL CI"
166 git rebase upstream/main
167 - name: For each commit, run cargo check (including in fuzz)
168 run: ci/check-each-commit.sh upstream/main
171 runs-on: ubuntu-latest
175 - name: Checkout source code
176 uses: actions/checkout@v3
179 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
181 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
182 rustup override set ${{ env.TOOLCHAIN }}
183 - name: Run cargo check for release build.
185 cargo check --release
186 cargo check --no-default-features --features=no-std --release
187 cargo check --no-default-features --features=futures --release
189 - name: Run cargo check for Taproot build.
191 cargo check --release
192 cargo check --no-default-features --features=no-std --release
193 cargo check --no-default-features --features=futures --release
196 RUSTFLAGS: '--cfg=taproot'
197 RUSTDOCFLAGS: '--cfg=taproot'
200 runs-on: ubuntu-latest
204 - name: Checkout source code
205 uses: actions/checkout@v3
206 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
208 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
209 rustup override set ${{ env.TOOLCHAIN }}
210 - name: Install dependencies for honggfuzz
213 sudo apt-get -y install build-essential binutils-dev libunwind-dev
214 - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
215 run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
217 run: cd fuzz && ./ci-fuzz.sh && cd ..
218 - name: Run lightning-invoice fuzzers
219 run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
222 runs-on: ubuntu-latest
226 - name: Checkout source code
227 uses: actions/checkout@v3
228 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
230 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain ${{ env.TOOLCHAIN }}
231 rustup override set ${{ env.TOOLCHAIN }}
232 - name: Install clippy
234 rustup component add clippy
235 - name: Run default clippy linting
237 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err