13个版本

0.3.0-alpha.12021年1月16日
0.2.2 2020年12月29日
0.2.0-beta.32020年11月30日
0.2.0-alpha.32020年10月29日

#26 in #lnp-bp

22 每月下载次数

MIT 许可证

74KB
1.5K SLoC

LNP/BP 核心库

Build Tests Lints codecov

Docs unsafe forbidden MIT licensed

这是 LNP/BP 核心库:一个实现 LNP/BP 规范的 Rust 库 https://github.com/LNP-BP/LNPBPs。它可以用来简化在闪电网络和比特币区块链上开发 2 & 3 层解决方案。

基于此库的项目包括以下项目

  • RGB:比特币和闪电网络的保密和可扩展智能合约
  • 通用闪电网络及其参考实现 LNP 节点,它使
    • RGB 扩展
    • DLC 扩展
    • Lightspeed 支付
    • 多对等通道
    • 更快的闪电实验(快速采用 eltoo、Taproot 等)
  • LNP:用于隐私保护和抗审查应用的网络协议,在 P2P 和 RPC 模式下运行(目前作为闪电网络的一部分使用,但我们的努力是使其更通用和可用,即使在不使用 LN 的情况下)。所有由 LNP/BP 标准协会开发的服务都使用 LNP。
  • BP 节点:比特币区块链索引服务;更高效、更通用的 Electrum 服务器替代品。未来 - 验证比特币网络节点(使用 libbitcoinconsus)

计划中的项目

  • 闪电网络的去中心化交易所
  • Bifrost 节点:运行 P2P LNP/BP 网络基础设施节点的
    • 去中心化交易所信息工作流程
    • 瞭望塔(RGB 支持)
    • DLC 预测提供者
    • 匿名中间存储,供客户端验证的数据(如 RGB 寄存物)
    • Storm 存储提供商(见下文)
  • Storm:激励无信任存储和消息协议
  • Prometheus:去中心化无信任计算

使用 LNP/BP 核心库,您可以简化以下内容的开发

  • 离散对数合约
  • 实现实验性闪电功能
  • 执行复杂的多线程或弹性/容器化的客户端-服务微服务架构

想了解更多关于由库提供的技术的信息,请查看

库项目的发展得到了LNP/BP标准协会的支持。

库功能

该库提供了以下代码

  • RGB:带有客户端验证的机密智能合约,支持闪电网络
  • 对比特币协议的改进与工具
  • 可嵌入比特币交易和公钥的确定性承诺(DBC)
  • 一次性印章
  • 客户端验证
  • 闪电网络协议(LNP)
  • 通用闪电网络

此代码同时支持比特币区块链和闪电网络。

项目结构

该库是一个由以下顶级模块构建的单个Rust crate

  • paradigms:通用的范例(API最佳实践),不特定于比特币
  • bp:Bitcoin协议扩展,位于Bitcoin Core功能之外和现有的BIPs。这些也可能包括LNPBP标准,这些标准不针对其他层。
  • lnp:闪电网络协议扩展:网络、通用闪电通道和对BOLT规范的更好分层
  • rgb:基于比特币和闪电网络,具有客户端验证、确定性比特币承诺和一次性印章的智能合约。
  • standards:其他LNPBPs标准实现,不属于上述任何类别

该库基于其他项目

安装

获取依赖项

在Debian上,运行

sudo apt-get install cargo libssl-dev libzmq3-dev pkg-config g++ cmake

在Mac OS上,运行

brew cargo pkg-config zmq

克隆和编译库

最低支持的rust编译器版本(MSRV):1.45(如果使用tokio功能)和1.41.1(如果没有使用tokio)

git clone https://github.com/lnp-bp/rust-lnpbp
cd rust-lnpbp
cargo build --release --all-features

库可以在target/release目录中找到。

您可以使用以下命令运行完整的测试套件

./contrib/test.sh

有关更详细的说明,请参阅cargo文档

在其他项目中使用库

将以下行添加到您的Cargo.toml文件的[dependencies]部分末尾

lnpbp = "~0.2.0"
lnpbp_derive = "~0.2.0"
lnpbp_services = "~0.2.0"

贡献

贡献指南可以在单独的CONTRIBUTING文件中找到

更多信息

关于替代币/替代链的政策

不支持也不计划支持除比特币区块链/比特币协议之外的替代币和“区块链”;针对它们的拉取请求将被拒绝。

许可

请参阅LICENCE文件。

依赖项

~9–19MB
~226K SLoC