9 releases

0.10.3 May 15, 2023
0.10.2 May 11, 2023
0.10.1 Apr 11, 2023
0.10.0-rc.1 Mar 28, 2023
0.10.0-beta.2 Feb 6, 2023

#800 in Magic Beans

Download history 94/week @ 2023-01-31 80/week @ 2023-02-07 148/week @ 2023-02-14 54/week @ 2023-02-21 78/week @ 2023-02-28 152/week @ 2023-03-07 272/week @ 2023-03-14 556/week @ 2023-03-21 264/week @ 2023-03-28 610/week @ 2023-04-04 514/week @ 2023-04-11 118/week @ 2023-04-18 238/week @ 2023-04-25 72/week @ 2023-05-02 643/week @ 2023-05-09 392/week @ 2023-05-16

1,364 downloads per month
Used in 9 crates (3 directly)

Apache-2.0

72KB
1K SLoC

Bitcoin protocol core library

Build Tests Lints codecov

crates.io Docs unsafe forbidden Apache-2 licensed

The library implements components necessary for [client-side-validation] in bitcoin protocol, specifically

Client-side-validation is a paradigm for distributed computing, based on top of proof-of-publication/commitment medium layer, which may be a bitcoin blockchain or other type of distributed consensus system.

The development of the library is supported by LNP/BP Standards Association and is performed on its GitHub page.

The original idea of client-side-validation was proposed by Peter Todd with its possible applications designed by Giacomo Zucco. It was shaped into the protocol design by Dr Maxim Orlovsky with a big input from the community.

Minimum supported rust version for the library (MSRV) is 1.66 and 2021 rust edition.

Documentation

Detailed developer & API documentation for all libraries can be accessed at:

To learn about the technologies enabled by the library please check slides from our tech presentations and LNP/BP tech talks videos.

Usage

The repository contains rust libraries for client-side validation.

Use library in other projects

To use libraries, you just need latest version of libraries, published to crates.io into [dependencies] section of your project Cargo.toml. Here is the full list of available libraries from this repository:

bp-primitives = "1" # Bitcoin protocol primitives crate
bp-dbc = "1" # Deterministic bitcoin commitments crate
bp-seals = "1" # Bitcoin single-use-seals crate
bp-core = "1" # Library including both of the previous crates

bp-core crate is an "umbrella" library containing both deterministic bitcoin commitments and bitcoin seals crates inside.

Known applications

The current list of the projects based on the library include:

Contributing

Contribution guidelines can be found in CONTRIBUTING

More information

MSRV

This library requires minimum rust compiler version (MSRV) 1.66.0.

Policy on altcoins

Altcoins and "blockchains" other than Bitcoin blockchain/Bitcoin protocols are not supported and not planned to be supported; pull requests targeting them will be declined.

Licensing

The libraries are distributed on the terms of Apache 2.0 opensource license. See LICENCE file for the license details.

Dependencies

~8MB
~111K SLoC