btclib-functional-tests

btclib-functional-tests is Bitcoin Core’s functional test suite rewritten on btclib, as a non-regression suite for any node that speaks bitcoin’s RPC and p2p. Its nickname is tf2.

The suite runs today against Bitcoin Core, btclib-node and btcd. A node gains an adapter by subclassing NodeAdapter and declaring what it can do. A test passes on bitcoind before its failure on another node counts as a finding.

Use

The suite is not published to an index. It is run from a checkout, next to the node tree it tests, with uv as the only tool to install:

git clone https://github.com/btclib-org/btclib-functional-tests.git
cd btclib-functional-tests
uv sync

Its CONTRIBUTING.md has the commands for the unit suite and for the integration tests, which start a node and skip without one.

Links

• Documentation
• Source
• Changelog
• Issues
• Contributing
• Security policy
• Report a vulnerability, privately
• License: MIT, in LICENSE