Validating Lightning Signer

Please see the VLS Project Overview for more information. Our web site.

Limitations

The following remain to be implemented:

vlsd2 --recover-to can only handle a simple force-close by us. It cannot sweep a force-close or a breach by the peer. It also cannot sweep HTLC outputs.
there is no facility to recover from loss of signer state.
on-chain tracking is not fully implemented, so a malicious node can steal funds by failing to remedy a breach (for example)

a no_std VLS wire protocol encoder/decoder - in ./vls-protocol
a no_std protocol handler for VLS - in ./vls-protocol-signer
a replacement for the UNIX CLN hsmd binary, implemented in Rust in ./vls-proxy.

Enable formatting precommit hooks:

./scripts/enable-githooks

For some reason, the ignore configuration for rustfmt is only available on the nightly channel, even though it's documented as stable.

rustup install nightly

cargo +nightly fmt

Build VLS and related crates:

cargo build

cargo test

To enable logging for a failing test (adjust log level to preference):

RUST_LOG=trace cargo test

Dependencies:

sudo dnf install -y elfutils-devel curl-devel binutils-devel

sudo apt-get install -y libcurl4-openssl-dev libelf-dev libdw-dev binutils-dev libiberty-dev

Build v38 of kcov from git@github.com:SimonKagstrom/kcov.git .

Ensure kcov --verify /tmp/x a.out does not complain about libbfd.

More dependencies:

cargo install cargo-kcov
cargo install cargo-coverage-annotations

Run coverage:

./scripts/run-kcov
./scripts/run-kcov --lib
./scripts/run-kcov --test functional_test

View Coverage Report:

[target/kcov/cov/index.html](target/kcov/cov/index.html)