#fedimint #lightning #bitcoin #federation #command #e-cash #active

bin+lib fedimint-cli

fedimint-cli 是客户端库的命令行界面包装器

40 个版本

0.4.0 2024年8月5日
0.4.0-rc.42024年7月26日
0.3.3 2024年7月25日
0.3.0-rc.32024年3月26日
0.0.1 2023年2月22日

#881 in 魔法豆

Download history 87/week @ 2024-04-23 84/week @ 2024-05-07 4/week @ 2024-05-14 85/week @ 2024-05-21 2/week @ 2024-06-04 157/week @ 2024-07-02 465/week @ 2024-07-16 306/week @ 2024-07-23 432/week @ 2024-07-30

1,203 每月下载量

MIT 许可证

2MB
43K SLoC

Fedimint

GitHub Actions CI Build Status Developer Discord Chat GitHub Discussion docs built from master Lines of code

Fedimint 是一个基于模块的系统,用于构建联邦应用。它旨在成为一个最小化信任、抗审查和隐私的替代集中式应用的解决方案。

Fedimint 是在 MIT 许可证 下发布的 alpha 软件版本。这意味着软件是“按原样”提供的,不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您因该软件中的错误而损失资金,我们可能没有能力帮助您恢复资金。我们建议您在 mutininet 等测试网络上或在主网上使用少量资金运行 Fedimint。您可以通过 此处 找到我们最新的发布版本。

Fedimint 随附 3 个默认模块 - BitcoinLightningChaumian Ecash - 以提供开箱即用的最佳实践,用于私有和最小化信任的支付。您可以为定义进一步的共识项目和交易类型编写自定义模块,利用支付模块来构建自己的联邦应用。您可以编写自定义模块

Fedimint 开发者 Discord 是获取帮助和提问的最佳场所。加入 Discord 并打个招呼!我们非常活跃,致力于将所有技能水平的开发者引入 Fedimint 及相关开源比特币项目。Fedimint 涉及比特币开发的许多不同领域,所以总有一款适合每个人。下面了解更多如何参与的详细信息。

运行您自己的 Fedimint

设置和运行您自己的联盟非常简单。Fedimint 被设计成 拜占庭容错,因此对 m 恶意节点具有弹性,在一个有 3m + 1 节点的联盟中。如果您运行一个有 4 个守护者的联盟,您对 1 个恶意守护者具有弹性;如果您运行一个有 7 个守护者的联盟,您对 2 个守护者具有弹性,等等。

Fedimint 还可以以“单机模式”运行,仅有一个守护者。这对于测试和开发很有用,但不建议在生产环境中使用。

要执行闪电支付,Fedimint 需要 闪电网关:联盟的用户,愿意交换 ecash 以发送/接收闪电支付。闪电网关不是一个守护者,而是一个为联盟服务的不可信经济行为者。

在 Mutinynet 上运行 Fedimint

请参阅 Fedimint Mutinynet 设置指南。您可以修改配置选项以部署它。

对于开发者

我们正在积极寻找开发者来帮助构建 Fedimint 及相关开源比特币项目。Fedimint 涉及比特币开发的许多不同领域,所以总有一款适合每个人。开始的最佳地点是

  • Fedimint 开发者 Discord:获取帮助和提问的最佳场所。
  • Fedimint 技术参考文档
  • Fedimint 贡献者日历:此日历包含所有开发者通话和活动。
  • Fedimint 开发者通话:我们每周一 4PM UTC 进行开发者通话,以审查 PR 并讨论当前的开发优先事项。作为一名新开发者,这是一个寻找良好初始问题并获得核心团队关于如何开始为 Fedimint 做贡献的指导的绝佳场所。
  • PR 审查俱乐部:我们每周二 4PM UTC 进行 PR 审查通话。
  • 每周深入探讨:我们每周四 4PM UTC 进行深入探讨,以深入讨论与 Fedimint 相关的技术主题:密码学、Rust 编程、共识、网络等。这是一个了解 Fedimint 和比特币内部结构的绝佳场所。我们通常根据贡献者对 Fedimint 想要了解更多方面的请求来计划这些通话,所以如果您有想要了解更多的话题,请提出。

有关贡献指南、贡献领域以及如何参与,请参阅 贡献指南

Fedimint 存储库和可贡献的项目

  • Fedimint:Fedimint 的核心存储库。这是核心共识和网络代码所在之处。Fedimint 是一个高级 Rust 项目,是学习 Rust、密码学、网络、共识和比特币开发的绝佳场所。我们有很多良好的初始问题,乐于指导新开发者,并且总是寻找有经验的 Rust 开发者来帮助核心代码库。
  • UI:Fedimint的默认守护者和闪电网关UI。这些都是TypeScript和React项目。为这个仓库做出贡献可以帮助UI/UX设计和开发,使Fedimint更加用户友好。
  • 闪电网关:Fedimint的闪电网关作为HTLC拦截器实现,目前与CLN、LND和LDK的sample-node实现兼容。我们一直在寻找闪电开发者来帮助我们改进闪电网关,特别是提高支付可靠性和增加对更多闪电实现的兼容性。
  • 自定义模块:Fedimint附带3个默认模块:比特币、闪电和Chaumian Ecash。您可以通过利用支付模块来定义更多共识项目和交易类型,编写自定义模块来构建自己的联邦应用程序。我们一直在寻找开发者来帮助构建自定义模块并改进模块系统。

启动Fedimint开发环境

Fedimint是一个Rust项目,使用Nix包管理器来管理依赖项和构建项目。

本地开发

我们提供了一个详细的教程,介绍了如何使用cli发送/接收ecash、闪电支付以及执行其他开发者操作,请参阅Fedimint开发者教程

Fedimint的开发环境和Rust构建管道通过Nix Flakebox进行管理。要开始,请安装Nix。

curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install

然后Fork并克隆Fedimint仓库。

git clone https://github.com/your-username/fedimint.git

然后进入nix开发者环境。

nix develop

使用此命令启动一个本地regtest网络,包含4个守护者、一个比特币节点和一个闪电网关。

just mprocs

您可以使用cli与守护者和闪电网关进行交互。有关如何使用cli的更多详细信息,请参阅Fedimint开发者教程

如果您想使用UI,请参阅UI仓库中的开发者环境说明。

维护者

领域 主要维护者 共同维护者 状态
项目负责人 @elsirion @dpc @joschisan X
核心服务器 @joschisan X 大部分已良好分解,无已知问题
核心共识 @joschisan @bradleystachurski 完善并已文档化
闪电模块 @joschisan @m1sterc001guy 积极开发,存在已知问题
铸币模块 @joschisan X 积极开发,存在已知问题
钱包模块 @bradleystachurski @dpc @joschisan 积极开发,存在关键问题
核心客户端 @dpc X X
闪电网关 @m1sterc001guy @joschisan X
数据库 @m1sterc001guy X X
网络 X X X
CI / Nix @dpc @maan2003 @bradleystachurski X
测试 @bradleystachurski X X
Devimint @maan2003 X X
配置生成 X X X

依赖

~104MB
~2M SLoC