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, lightning-background-processor
17 # 1.47.0 will be the MSRV for no-std builds using hashbrown once core2 is updated
27 platform: macos-latest
33 test-custom-message: true
35 platform: macos-latest
41 platform: windows-latest
47 platform: windows-latest
58 test-custom-message: true
61 test-log-variants: true
65 build-net-old-tokio: true
74 runs-on: ${{ matrix.platform }}
76 - name: Checkout source code
77 uses: actions/checkout@v3
78 - name: Install Rust ${{ matrix.toolchain }} toolchain
79 uses: actions-rs/toolchain@v1
81 toolchain: ${{ matrix.toolchain }}
84 - name: Pin tokio to 1.14 for Rust 1.45
85 if: "matrix.build-net-old-tokio"
86 run: cargo update -p tokio --precise "1.14.0" --verbose
88 CARGO_NET_GIT_FETCH_WITH_CLI: "true"
89 - name: Build on Rust ${{ matrix.toolchain }} with net-tokio
90 if: "matrix.build-net-tokio && !matrix.coverage"
91 run: cargo build --verbose --color always
92 - name: Build on Rust ${{ matrix.toolchain }} with net-tokio, and full code-linking for coverage generation
94 run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
95 - name: Build on Rust ${{ matrix.toolchain }}
96 if: "! matrix.build-net-tokio"
98 cargo build --verbose --color always -p lightning
99 cargo build --verbose --color always -p lightning-invoice
100 cargo build --verbose --color always -p lightning-persister
101 - name: Build on Rust ${{ matrix.toolchain }} with all Log-Limiting features
102 if: matrix.test-log-variants
105 for FEATURE in $(cat Cargo.toml | grep '^max_level_' | awk '{ print $1 }'); do
106 cargo build --verbose --color always --features $FEATURE
108 - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
109 if: "matrix.build-net-tokio && !matrix.coverage"
111 cd lightning-block-sync
112 cargo build --verbose --color always --features rest-client
113 cargo build --verbose --color always --features rpc-client
114 cargo build --verbose --color always --features rpc-client,rest-client
115 cargo build --verbose --color always --features rpc-client,rest-client,tokio
116 - name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
119 cd lightning-block-sync
120 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rest-client
121 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
122 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
123 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
124 - name: Build Transaction Sync Clients on Rust ${{ matrix.toolchain }} with features
125 if: "matrix.build-tx-sync && !matrix.coverage"
127 cd lightning-transaction-sync
128 cargo build --verbose --color always --features esplora-blocking
129 cargo build --verbose --color always --features esplora-async
130 cargo build --verbose --color always --features esplora-async-https
131 - name: Build transaction sync clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
132 if: "matrix.build-tx-sync && matrix.coverage"
134 cd lightning-transaction-sync
135 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features esplora-blocking
136 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features esplora-async
137 RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features esplora-async-https
138 - name: Test transaction sync clients on Rust ${{ matrix.toolchain }} with features
139 if: "matrix.build-tx-sync"
141 cd lightning-transaction-sync
142 cargo test --verbose --color always --features esplora-blocking
143 cargo test --verbose --color always --features esplora-async
144 cargo test --verbose --color always --features esplora-async-https
145 - name: Test backtrace-debug builds on Rust ${{ matrix.toolchain }}
146 if: "matrix.toolchain == 'stable'"
147 shell: bash # Default on Winblows is powershell
149 cd lightning && RUST_BACKTRACE=1 cargo test --verbose --color always --features backtrace
150 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio
151 if: "matrix.build-net-tokio && !matrix.coverage"
152 run: cargo test --verbose --color always
153 - name: Test on Rust ${{ matrix.toolchain }} with net-tokio, and full code-linking for coverage generation
155 run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
156 - name: Test no-std builds on Rust ${{ matrix.toolchain }}
157 if: "matrix.build-no-std && !matrix.coverage"
158 shell: bash # Default on Winblows is powershell
160 for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
162 cargo test --verbose --color always --no-default-features --features no-std
163 # check if there is a conflict between no-std and the default std feature
164 cargo test --verbose --color always --features no-std
165 # check that things still pass without grind_signatures
166 # note that outbound_commitment_test only runs in this mode, because of hardcoded signature values
167 cargo test --verbose --color always --no-default-features --features std
168 # check if there is a conflict between no-std and the c_bindings cfg
169 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
172 # check no-std compatibility across dependencies
174 cargo check --verbose --color always --features lightning-transaction-sync
175 - name: Build no-std-check on Rust ${{ matrix.toolchain }} for ARM Embedded
176 if: "matrix.build-no-std && matrix.platform == 'ubuntu-latest'"
179 rustup target add thumbv7m-none-eabi
180 sudo apt-get -y install gcc-arm-none-eabi
181 cargo build --target=thumbv7m-none-eabi
182 - name: Test on no-std builds Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
183 if: "matrix.build-no-std && matrix.coverage"
186 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features no-std
187 - name: Test futures builds on Rust ${{ matrix.toolchain }}
188 if: "matrix.build-futures && !matrix.coverage"
189 shell: bash # Default on Winblows is powershell
191 cd lightning-background-processor
192 cargo test --verbose --color always --no-default-features --features futures
193 - name: Test futures builds on Rust ${{ matrix.toolchain }} and full code-linking for coverage generation
194 if: "matrix.build-futures && matrix.coverage"
195 shell: bash # Default on Winblows is powershell
197 cd lightning-background-processor
198 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --no-default-features --features futures
199 - name: Test on Rust ${{ matrix.toolchain }}
200 if: "! matrix.build-net-tokio"
202 cargo test --verbose --color always -p lightning
203 cargo test --verbose --color always -p lightning-invoice
204 cargo test --verbose --color always -p lightning-rapid-gossip-sync
205 cargo test --verbose --color always -p lightning-persister
206 cargo test --verbose --color always -p lightning-background-processor
207 - name: Test C Bindings Modifications on Rust ${{ matrix.toolchain }}
208 if: "! matrix.build-net-tokio"
210 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning
211 RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always -p lightning-invoice
212 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-persister
213 RUSTFLAGS="--cfg=c_bindings" cargo build --verbose --color always -p lightning-background-processor
214 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features
215 if: "matrix.build-net-tokio && !matrix.coverage"
217 cd lightning-block-sync
218 cargo test --verbose --color always --features rest-client
219 cargo test --verbose --color always --features rpc-client
220 cargo test --verbose --color always --features rpc-client,rest-client
221 cargo test --verbose --color always --features rpc-client,rest-client,tokio
222 - name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
225 cd lightning-block-sync
226 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rest-client
227 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
228 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
229 RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
230 - name: Test Custom Message Macros on Rust ${{ matrix.toolchain }}
231 if: "matrix.test-custom-message"
233 cd lightning-custom-message
234 cargo test --verbose --color always
235 - name: Install deps for kcov
239 sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
243 wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
244 tar xzf master.tar.gz
245 cd kcov-master && mkdir build && cd build
248 make install DESTDIR=../../kcov-build
249 cd ../.. && rm -rf kcov-master master.tar.gz
250 - name: Generate coverage report
253 for file in target/debug/deps/lightning*; do
254 [ -x "${file}" ] || continue;
255 mkdir -p "target/cov/$(basename $file)";
256 ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
258 - name: Upload coverage
260 uses: codecov/codecov-action@v3
262 # Could you use this to fake the coverage report for your PR? Sure.
263 # Will anyone be impressed by your amazing coverage? No
264 # Maybe if codecov wasn't broken we wouldn't need to do this...
265 token: f421b687-4dc2-4387-ac3d-dc3b2528af57
266 fail_ci_if_error: true
269 runs-on: ubuntu-latest
273 - name: Checkout source code
274 uses: actions/checkout@v3
275 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
276 uses: actions-rs/toolchain@v1
278 toolchain: ${{ env.TOOLCHAIN }}
281 - name: Cache routing graph snapshot
283 uses: actions/cache@v3
285 path: lightning/net_graph-2023-01-18.bin
286 key: ldk-net_graph-v0.0.113-2023-01-18.bin
287 - name: Fetch routing graph snapshot
288 if: steps.cache-graph.outputs.cache-hit != 'true'
290 curl --verbose -L -o lightning/net_graph-2023-01-18.bin https://bitcoin.ninja/ldk-net_graph-v0.0.113-2023-01-18.bin
291 echo "Sha sum: $(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')"
292 if [ "$(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
297 EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: da6066f2bddcddbe7d8a6debbd53545697137b310bbb8c4911bc8c81fc5ff48c
298 - name: Fetch rapid graph sync reference input
300 curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
301 echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
302 if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
307 EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
308 - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
311 RUSTFLAGS="--cfg=require_route_graph_test" cargo test
312 RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
314 - name: Run benchmarks on Rust ${{ matrix.toolchain }}
316 RUSTC_BOOTSTRAP=1 cargo bench --features _bench_unstable
319 runs-on: ubuntu-latest
323 - name: Checkout source code
324 uses: actions/checkout@v3
327 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
328 uses: actions-rs/toolchain@v1
330 toolchain: ${{ env.TOOLCHAIN }}
333 - name: Fetch full tree and rebase on upstream
335 git remote add upstream https://github.com/lightningdevkit/rust-lightning
337 export GIT_COMMITTER_EMAIL="rl-ci@example.com"
338 export GIT_COMMITTER_NAME="RL CI"
339 git rebase upstream/main
340 - name: For each commit, run cargo check (including in fuzz)
341 run: ci/check-each-commit.sh upstream/main
344 runs-on: ubuntu-latest
348 - name: Checkout source code
349 uses: actions/checkout@v3
352 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
353 uses: actions-rs/toolchain@v1
355 toolchain: ${{ env.TOOLCHAIN }}
358 - name: Run cargo check for release build.
360 cargo check --release
361 cargo check --no-default-features --features=no-std --release
362 cargo check --no-default-features --features=futures --release
366 runs-on: ubuntu-latest
370 - name: Checkout source code
371 uses: actions/checkout@v3
372 - name: Install Rust 1.58 toolchain
373 uses: actions-rs/toolchain@v1
378 - name: Install dependencies for honggfuzz
381 sudo apt-get -y install build-essential binutils-dev libunwind-dev
382 - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
383 run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
385 run: cd fuzz && ./ci-fuzz.sh && cd ..
386 - name: Run lightning-invoice fuzzers
387 run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
390 runs-on: ubuntu-latest
394 - name: Checkout source code
395 uses: actions/checkout@v3
396 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
397 uses: actions-rs/toolchain@v1
399 toolchain: ${{ env.TOOLCHAIN }}
402 - name: Install clippy
404 rustup component add clippy
405 - name: Run default clippy linting
407 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err