5 个版本 (破坏性更新)

0.6.0 2021年5月12日
0.5.0 2021年4月14日
0.4.0 2021年3月17日
0.3.0 2021年2月17日
0.2.0 2020年12月21日

#bdk 中排名 13

MIT/Apache

28KB
424

比特币开发工具包

BDK

一个用Rust语言编写的现代、轻量级的基于描述符的钱包库!

Crate Info MIT or Apache-2.0 Licensed CI Status Wallet API Docs Rustc Version 1.63.0+ Chat on Discord

项目主页 | 文档

关于

bdk 库旨在为基于比特币的应用程序提供精心设计和审查过的组件。它建立在出色的 rust-bitcoinrust-miniscript 插件之上。

⚠ 比特币开发工具包的开发者正在发布 v1.0 版本,这是对库工作方式的根本重写。关于此项目的背景信息,请参阅:https://bitcoindevkit.org/blog/road-to-bdk-1/(忽略时间表 😁)。有关发布时间表,请参阅BDK 1.0 项目页面

架构

该项目分为几个插件,位于 /crates 目录中

  • wallet:包含由其他组件提供的基础低级别机制构建的中心高级 Wallet 类型
  • chain:存储和索引链数据的工具
  • persist:定义 BDK 钱包数据持久性的类型
  • file_store:一个(实验性)后端,用于将链数据存储在单个文件中。
  • esplora:扩展 esplora-client crate,提供了从 esplora HTTP 服务器获取链数据的方法,这些数据是以 bdk_chainWallet 可以消费的形式提供的。
  • electrum:扩展 electrum-client crate,提供了从 electrum 服务器获取链数据的方法,这些数据是以 bdk_chainWallet 可以消费的形式提供的。

这些组件的完整使用示例在 /example-crates

  • example_cli:由 example_* crate 使用的库。提供同步、显示余额、生成地址和创建交易等实用工具,无需使用 bdk_wallet Wallet
  • example_electrum:一个基于 example_clielectrum crate 的命令行比特币钱包应用程序。它展示了 bdk 工具(chain + file_store + electrum)的强大功能,而不依赖于主要的 bdk_wallet 库。
  • example_esplora:一个基于 example_cliesplora crate 的命令行比特币钱包应用程序。它展示了 bdk 工具(chain + file_store + esplora)的强大功能,而不依赖于主要的 bdk_wallet 库。
  • example_bitcoind_rpc_polling:一个基于 example_clibitcoind_rpc crate 的命令行比特币钱包应用程序。它展示了 bdk 工具(chain + file_store + bitcoind_rpc)的强大功能,而不依赖于主要的 bdk_wallet 库。
  • wallet_esplora_blocking:使用 Wallet 通过 Esplora 阻塞接口同步和支出。
  • wallet_esplora_async:使用 Wallet 通过 Esplora 异步接口同步和支出。
  • wallet_electrum:使用 Wallet 通过 Electrum 同步和支出。

最低支持的 Rust 版本 (MSRV)

此库应与 Rust 1.63.0 的任何功能组合一起编译。

要使用 MSRV 构建,您需要按以下方式固定依赖关系

cargo update -p zstd-sys --precise "2.0.8+zstd.1.5.5"
cargo update -p time --precise "0.3.20"
cargo update -p home --precise "0.5.5"
cargo update -p proptest --precise "1.2.0"
cargo update -p url --precise "2.5.0"

许可证

在以下许可证之一下授权

由您选择。

贡献

除非您明确说明,否则根据Apache-2.0许可证定义的,您有意提交以包含在工作中的任何贡献,将按上述方式双重许可,不附加任何额外条款或条件。

依赖项

~1.5MB
~35K SLoC