39 个版本
新版本 0.4.0 | 2024 年 8 月 5 日 |
---|---|
0.4.0-rc.4 | 2024 年 7 月 26 日 |
0.3.3 | 2024 年 7 月 25 日 |
0.3.0-rc.3 | 2024 年 3 月 26 日 |
0.2.0-rc3 | 2023 年 11 月 29 日 |
#2101 在 神奇豆子
1,160 每月下载次数
用于 8 个crate(5 个直接使用)
1MB
24K SLoC
Fedimint
Fedimint 是一个基于模块的系统,用于构建联邦应用程序。它被设计为一个最小化信任、抗审查和隐私的集中式应用程序的替代方案。
Fedimint 是一个在 MIT 许可证下发布的 alpha 软件版本。这意味着软件“按原样”提供,不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您由于本软件中的错误而损失资金,我们可能无法帮助您恢复资金。我们建议您在 mutinynet 等测试网上运行 Fedimint,或者在主网上用少量的钱进行测试。您可以在这里找到我们的最新版本 这里。
Fedimint自带3个默认模块 - 比特币、闪电网络和Chaumian 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开发者会议:我们每周一UTC时间下午4点举行开发者会议,以审查PR并讨论当前的开发优先事项。作为新开发者,这是一个找到良好初始问题和从核心团队获得指导以开始为Fedimint做出贡献的好地方。
- PR审查俱乐部:我们每周二UTC时间下午4点举行PR审查会议。
- 每周深入探讨:我们每周四UTC时间下午4点进行深入探讨,以深入讨论与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和clone Fedimint存储库。
git clone https://github.com/your-username/fedimint.git
然后进入nix开发者环境。
nix develop
使用以下命令启动一个具有4个守护者、一个比特币节点和一个闪电网关的本地regtest网络。
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 |
依赖项
~49–66MB
~1M SLoC