Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
name: Code Coverage

on:
push:
branches: [ "develop" ]
pull_request:
on: [push, pull_request]

env:
CARGO_TERM_COLOR: always

permissions: {}

jobs:
coverage:
name: Code Coverage
runs-on: ubuntu-latest
env:
CARGO_INCREMENTAL: 0
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install lcov tools
run: sudo apt-get install lcov -y
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
Expand All @@ -26,5 +27,18 @@ jobs:
uses: Swatinem/rust-cache@v2.7.8
- name: Install cargo-llvm-cov
run: if [[ ! -e ~/.cargo/bin/cargo-llvm-cov ]]; then cargo install cargo-llvm-cov; fi
- name: Make coverage directory
run: mkdir coverage
- name: Test and report coverage
run: cargo +nightly llvm-cov -q --doctests --branch --workspace --ignore-filename-regex "example-crates/*"
run: cargo +nightly llvm-cov -q --doctests --branch --all --ignore-filename-regex "example-crates/*" --all-features --lcov --output-path ./coverage/lcov.info
- name: Generate HTML coverage report
run: genhtml -o coverage-report.html --ignore-errors unmapped ./coverage/lcov.info
- name: Coveralls upload
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: coverage-report.html
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# `bdk-sp`

<div align="center">
<p>
<strong>An experimental crate to research the implementation of silent payment tools in BDK.</strong>
</p>

<p>
<a href="https://coveralls.io/github/bitcoindevkit/bdk-sp?branch=master"><img src="https://coveralls.io/repos/github/bitcoindevkit/bdk-sp/badge.svg?branch=master"/></a>
</p>
</div>

> [!WARNING]
> Work in progress. Not recommended for use with bitcoin mainnet.

This is an experimental crate to research the implementation of silent payment
tools in BDK.

![execution flow enabled by this crate](../media/sp_flow.gif?raw=true)

This is a second iteration of the work initiated in [rust-bip352].
Expand Down
Loading