Skip to content

Commit

Permalink
Merge #101: Add mention to README re status of the crate
Browse files Browse the repository at this point in the history
3e0eefc Add mention to README re status of the crate (Tobin C. Harding)

Pull request description:

  This crate is in maintenance mode sine `libbitcoinconsensus` has been deprecated and removed from Core.

  Add a section to the docs so folk are aware of it.

  Close: #100

ACKs for top commit:
  apoelstra:
    utACK 3e0eefc

Tree-SHA512: c2a4752940d721ae398dc9f58d3d14c9d96629ceb99a1f85a5589654a4cb973446b7cb006f9d99a2c4da969ed36e9d311dcb91584b4e6943c54300fceef61c8b
  • Loading branch information
apoelstra committed Feb 14, 2025
2 parents d1a3554 + 3e0eefc commit c4642cc
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ A typical Bitcoin enabled application will however want to access further secp25
The project [rust-secp256k1](https://github.com/rust-bitcoin/rust-secp256k1) offers a cargo build and Rust bindings, therefore we depend on that instead of compiling the Bitcoin embedded sources into `libbitcoinconsensus`.
This introduces a risk, since a difference between the two secp256k1 sources could break consensus with Bitcoin.

## Status

The `libbitcoinconsensus` library was [deprecated in Bitcoin Core v27](https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-27.0.md#libbitcoinconsensus).

> In the future, libbitcoinkernel will provide a much more useful API that is aware of the UTXO set, and therefore be able to fully validate transactions and blocks.
And was [removed in Bitcoin Core v28](https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-28.0.md#libbitcoinconsensus-removal).

As such this library will not likely see many updates i.e., **this crate is in maintenance mode**.

## Version numbers

Expand Down

0 comments on commit c4642cc

Please sign in to comment.