1 name: Continuous Integration Checks
3 on: [push, pull_request]
10 platform: [ ubuntu-latest ]
13 # 1.41.1 is MSRV for Rust-Lightning, lightning-invoice, and lightning-persister
15 # 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation
17 # 1.47.0 will be the MSRV for no-std builds using hashbrown once core2 is updated
24 platform: macos-latest
28 platform: macos-latest
32 platform: windows-latest
36 platform: windows-latest
44 test-log-variants: true
46 build-net-old-tokio: true
52 runs-on: ${{ matrix.platform }}
54 - name: Checkout source code
55 uses: actions/checkout@v3
56 - name: Install Rust ${{ matrix.toolchain }} toolchain
57 uses: actions-rs/toolchain@v1
59 toolchain: ${{ matrix.toolchain }}
62 - name: Pin tokio to 1.14 for Rust 1.45
63 if: "matrix.build-net-old-tokio"
64 run: cargo update -p tokio --precise "1.14.0" --verbose
66 CARGO_NET_GIT_FETCH_WITH_CLI: "true"
67 - name: Build on Rust ${{ matrix.toolchain }} with net-tokio
68 if: "matrix.build-net-tokio && !matrix.coverage"
69 run: cargo build --verbose --color always
70 - name: Build on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
72 run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
73 - name: Build on Rust ${{ matrix.toolchain }}
74 if: "! matrix.build-net-tokio"
76 cargo build --verbose --color always -p lightning
77 cargo build --verbose --color always -p lightning-invoice
78 cargo build --verbose --color always -p lightning-persister
79 - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features
80 if: matrix.test-log-variants
83 for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
84 cargo build --verbose --color always --features $FEATURE
86 - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
87 if: "matrix.build-net-tokio && !matrix.coverage"
89 cd lightning-block-sync
90 cargo build --verbose --color always --features rest-client
91 cargo build --verbose --color always --features rpc-client
92 cargo build --verbose --color always --features rpc-client,rest-client
93 cargo build --verbose --color always --features rpc-client,rest-client,tokio
94 - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
97 cd lightning-block-sync
98 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
99 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
100 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
101 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
102 - name: Test backtrace-debug builds on Rust ${{ matrix.toolchain }}
103 if: "matrix.build-no-std"
105 cd lightning && cargo test --verbose --color always --features backtrace
106 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
107 if: "matrix.build-net-tokio && !matrix.coverage"
108 run: cargo test --verbose --color always
109 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
111 run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
112 - name: Test on no-std bullds Rust ${{ matrix.toolchain }}
113 if: "matrix.build-no-std && !matrix.coverage"
114 shell: bash # Default on Winblows is powershell
116 for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
118 cargo test --verbose --color always --no-default-features --features no-std
119 # check if there is a conflict between no-std and the default std feature
120 cargo test --verbose --color always --features no-std
121 # check that things still pass without grind_signatures
122 # note that outbound_commitment_test only runs in this mode, because of hardcoded signature values
123 cargo test --verbose --color always --no-default-features --features std
124 # check if there is a conflict between no-std and the c_bindings cfg
125 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
128 # check no-std compatibility across dependencies
130 cargo check --verbose --color always
132 - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
133 if: "matrix.build-no-std && matrix.coverage"
136 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
138 - name: Test on Rust ${{ matrix.toolchain }}
139 if: "! matrix.build-net-tokio"
141 cargo test --verbose --color always -p lightning
142 cargo test --verbose --color always -p lightning-invoice
143 cargo test --verbose --color always -p lightning-rapid-gossip-sync
144 cargo build --verbose --color always -p lightning-persister
145 cargo build --verbose --color always -p lightning-background-processor
146 - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
147 if: "! matrix.build-net-tokio"
149 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning
150 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning-invoice
151 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-persister
152 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-background-processor
153 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
154 if: "matrix.build-net-tokio && !matrix.coverage"
156 cd lightning-block-sync
157 cargo test --verbose --color always --features rest-client
158 cargo test --verbose --color always --features rpc-client
159 cargo test --verbose --color always --features rpc-client,rest-client
160 cargo test --verbose --color always --features rpc-client,rest-client,tokio
161 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
164 cd lightning-block-sync
165 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
166 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
167 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
168 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
169 - name: Install deps for kcov
173 sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
177 wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
178 tar xzf master.tar.gz
179 cd kcov-master && mkdir build && cd build
182 make install DESTDIR=../../kcov-build
183 cd ../.. && rm -rf kcov-master master.tar.gz
184 - name: Generate coverage report
187 for file in target/debug/deps/lightning*; do
188 [ -x "${file}" ] || continue;
189 mkdir -p "target/cov/$(basename $file)";
190 ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
192 - name: Upload coverage
194 uses: codecov/codecov-action@v3
196 # Could you use this to fake the coverage report for your PR? Sure.
197 # Will anyone be impressed by your amazing coverage? No
198 # Maybe if codecov wasn't broken we wouldn't need to do this...
199 token: f421b687-4dc2-4387-ac3d-dc3b2528af57
200 fail_ci_if_error: true
203 runs-on: ubuntu-latest
207 - name: Checkout source code
208 uses: actions/checkout@v3
209 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
210 uses: actions-rs/toolchain@v1
212 toolchain: ${{ env.TOOLCHAIN }}
215 - name: Cache routing graph snapshot
217 uses: actions/cache@v3
219 path: lightning/net_graph-2021-05-31.bin
220 key: ldk-net_graph-v0.0.15-2021-05-31.bin
221 - name: Fetch routing graph snapshot
222 if: steps.cache-graph.outputs.cache-hit != 'true'
224 curl --verbose -L -o lightning/net_graph-2021-05-31.bin https://bitcoin.ninja/ldk-net_graph-v0.0.15-2021-05-31.bin
225 echo "Sha sum: $(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')"
226 if [ "$(sha256sum lightning/net_graph-2021-05-31.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
231 EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: 05a5361278f68ee2afd086cc04a1f927a63924be451f3221d380533acfacc303
232 - name: Fetch rapid graph sync reference input
234 curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
235 echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
236 if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
241 EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
242 - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
245 RUSTFLAGS="--cfg=require_route_graph_test" cargo test
246 RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
248 - name: Run benchmarks on Rust ${{ matrix.toolchain }}
250 cargo bench --features _bench_unstable
253 runs-on: ubuntu-latest
257 - name: Checkout source code
258 uses: actions/checkout@v3
261 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
262 uses: actions-rs/toolchain@v1
264 toolchain: ${{ env.TOOLCHAIN }}
267 - name: Fetch full tree and rebase on upstream
269 git remote add upstream https://github.com/lightningdevkit/rust-lightning
271 export GIT_COMMITTER_EMAIL="rl-ci@example.com"
272 export GIT_COMMITTER_NAME="RL CI"
273 git rebase upstream/main
274 - name: For each commit, run cargo check (including in fuzz)
275 run: ci/check-each-commit.sh upstream/main
278 runs-on: ubuntu-latest
282 - name: Checkout source code
283 uses: actions/checkout@v3
286 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
287 uses: actions-rs/toolchain@v1
289 toolchain: ${{ env.TOOLCHAIN }}
292 - name: Run cargo check for release build.
294 cargo check --release
295 cargo check --no-default-features --features=no-std --release
299 runs-on: ubuntu-latest
303 - name: Checkout source code
304 uses: actions/checkout@v3
305 - name: Install Rust 1.58 toolchain
306 uses: actions-rs/toolchain@v1
311 - name: Install dependencies for honggfuzz
314 sudo apt-get -y install build-essential binutils-dev libunwind-dev
315 - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
316 run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
318 run: cd fuzz && ./ci-fuzz.sh && cd ..
319 - name: Run lightning-invoice fuzzers
320 run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
323 runs-on: ubuntu-latest
327 - name: Checkout source code
328 uses: actions/checkout@v3
329 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
330 uses: actions-rs/toolchain@v1
332 toolchain: ${{ env.TOOLCHAIN }}
335 - name: Install clippy
337 rustup component add clippy
338 - name: Run default clippy linting
340 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err