Skip to content

Repository files navigation

bdk-sp

An experimental crate to research the implementation of silent payment tools in BDK.

Warning

Work in progress. Not recommended for use with bitcoin mainnet.

execution flow enabled by this crate

This is a second iteration of the work initiated in rust-bip352.

Tip

This is a continuation of the changes applied in bdk:feat/silent-payments-with-rust-silentpayments branch, isolated here for better discoverability. The example-crates/justfile has been refactored to work in isolation from the bdk repository.

The project started building on top of rust-silentpayments, but later extracted the needed parts from it and started evolving by its own.

The project follows BIP352 specification, refer to it to learn more about silentpayments. The only dependencies from the library are:

  • bitcoin
  • serde (optional)

Example

To get started see the encoding::SilentPaymentCode, receive::scan::Scanner or send::bip32::XprivSilentPaymentSender structs depending on the silent payment side you want to focus on.

For a complete program covering both sides, see the send and scan full flow example:

cargo run --example send_and_scan

Contributing

Found a bug, have an issue or a feature request? Feel free to open an issue on GitHub. This library is open source licensed under MIT.

About

Experimental project to integrate silent payments in BDK

Resources

Contributing

Stars

24 stars

Watchers

5 watching

Forks

Releases

Packages

Contributors

Languages