frost/bdk

Go to file

Daniela Brozzoni 8641847e6c

Merge bitcoindevkit/bdk#1001 : Rename "keychanins" to keychains

22b8a4884245449fcf60877ca031e0e9e7495de9 Rename "keychanins" to keychains (Daniela Brozzoni)

Pull request description:

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  notmandatory:
    ACK 22b8a4884245449fcf60877ca031e0e9e7495de9

Tree-SHA512: 13ebbd597771a9d91c317fedc4dc506a275a641b764f24650cd13217cf8ac0d06c42a935a8c9e1e7f4761d2ade473c7f8381e90875e867b7a61381aa33cd8581

2023-06-02 00:45:03 +02:00

.github

Filter code coverage report results

2023-04-29 15:47:08 -05:00

Fix ci Dockerfile.ledger

2023-02-13 11:38:26 -06:00

crates

Rename "keychanins" to keychains

2023-06-01 19:29:02 +02:00

example-crates

[bdk_chain_redesign] Introduce Append trait for additions

2023-04-05 17:29:20 +08:00

nursery

For examples and nursery remove workspace dependency versions

2023-03-19 23:03:45 -05:00

static

Add back old logo to static/bdk.svg

2021-12-22 21:38:54 -08:00

.gitignore

Add vscode filter to gitignore

2022-09-27 20:40:14 +08:00

Cargo.toml

Add wallet_esplora_async example and various fixes

2023-03-09 11:07:45 +13:00

CHANGELOG.md

Bump version to 0.27.1

2023-02-16 11:22:20 -06:00

clippy.toml

Add clippy.toml

2023-03-03 17:44:07 +01:00

CONTRIBUTING.md

Fixed typos in CONTRIBUTING.md

2023-05-16 21:39:18 -07:00

DEVELOPMENT_CYCLE.md

Update DEVELOPMENT_CYCLE.md to work with [patch.crates-io]

2022-08-31 07:43:03 -05:00

README.md

Doc fixes

2023-03-13 22:23:40 +01:00

README.md

The Bitcoin Dev Kit

BDK

A modern, lightweight, descriptor-based wallet library written in Rust!

Project Homepage | Documentation

About

The bdk libraries aims to provide well engineered and reviewed components for Bitcoin based applications. It is built upon the excellent rust-bitcoin and rust-miniscript crates.

⚠ The Bitcoin Dev Kit developers are in the process of releasing a v1.0 which is a fundamental re-write of how the library works. See for some background on this project: https://bitcoindevkit.org/blog/road-to-bdk-1/ (ignore the timeline 😁) For a release timeline see the bdk_core_staging repo where a lot of the component work is being done. The plan is that everything in the bdk_core_staging repo will be moved into the crates directory here.

Architecture

The project is split up into several crates in the /crates directory:

bdk: Contains the central high level Wallet type that is built from the low-level mechanisms provided by the other components
chain: Tools for storing and indexing chain data
file_store: A (experimental) persistence backend for storing chain data in a single file.
esplora: Extends the esplora-client crate with methods to fetch chain data from an esplora HTTP server in the form that [bdk_chain] and Wallet can consume.
electrum: Extends the electrum-client crate with methods to fetch chain data from an electrum server in the form that [bdk_chain] and Wallet can consume.

Fully working examples of how to use these components are in /example-crates