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 日 |
#2546 in 魔法豆
1,011 每月下载量
用于 2 crates
1MB
23K SLoC
Fedimint
Fedimint 是一个基于模块的系统,用于构建联盟应用程序。它旨在成为最小化信任、抗审查和隐私的集中式应用程序的替代方案。
Fedimint 是在 MIT 许可证 下发布的 alpha 软件版本。这意味着提供的软件是“现状”,没有任何保证。我们是一个资源有限的小型开发团队。如果您因该软件中的错误导致资金损失,我们可能无法帮助您恢复资金。我们建议您在 mutinynet 等测试网上运行 Fedimint,或在主网上用少量资金运行。您可以在 这里 找到我们最新的版本。
Fedimint 随带 3 个默认模块 - Bitcoin、Lightning 和 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 开发者会议:我们每周一 4PM UTC 举行开发者会议,以审查 PR 并讨论当前的开发优先事项。作为新开发者,这是一个寻找良好入门问题并从核心团队获得指导以开始为 Fedimint 做贡献的好地方。
- PR 审查俱乐部:我们每周二 4PM UTC 举行 PR 审查会议。
- 每周深入研究:我们每周四 4PM UTC 进行深入研究,以深入讨论与 Fedimint 相关的技术主题:密码学、Rust 编程、共识、网络等。这是一个了解 Fedimint 和比特币内部的好地方。我们通常根据贡献者对 Fedimint 想要了解更多方面的请求来计划这些会议,因此如果您有想要了解更多内容的话题,请与我们联系。
有关贡献指南、贡献领域以及如何参与,请参阅 贡献指南。
Fedimint 仓库和可以贡献的项目
- Fedimint:Fedimint 的核心仓库。这是核心共识和网络代码所在之处。Fedimint 是一个高级 Rust 项目,是学习 Rust、密码学、网络、共识和比特币开发的好地方。我们有许多良好入门问题,很高兴指导新开发者,并且始终欢迎经验丰富的 Rust 开发者帮助核心代码库。
- UI:Fedimint 守护者和闪电网关的默认用户界面。这些是 TypeScript 和 React 项目。为该仓库做出贡献有助于 UI/UX 设计和开发,使 Fedimint 更加用户友好。
- Lightning Gateway:Fedimint的Lightning Gateway作为HTLC拦截器实现,目前与CLN、LND和LDK的sample-node实现兼容。我们一直在寻找闪电开发者来帮助改进Lightning Gateway,特别是在提高支付可靠性和添加更多闪电实现支持方面。
- 自定义模块:Fedimint自带3个默认模块:比特币、闪电和Chaumian Ecash。你可以编写自定义模块来定义更多的共识项和交易类型,利用支付模块来构建自己的联邦应用程序。我们一直在寻找开发者来帮助构建自定义模块并改进模块系统。
启动Fedimint开发者环境
Fedimint是一个Rust项目,使用Nix包管理器来管理依赖项和构建项目。
本地开发
我们有一个详细的教程,介绍了如何使用命令行工具发送/接收ecash、闪电支付以及执行其他开发者操作,请参阅Fedimint开发者教程。
Fedimint的开发者环境和Rust构建管道由Nix Flakebox管理。要开始,请安装Nix。
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
然后分叉并克隆Fedimint仓库。
git clone https://github.com/your-username/fedimint.git
然后进入Nix开发者环境。
nix develop
并使用以下命令启动一个包含4个守卫者、一个比特币节点和一个闪电网关的本地regtest网络。
just mprocs
然后您可以使用命令行工具与守卫者和闪电网关进行交互。有关如何使用命令行工具的更多详细信息,请参阅Fedimint开发者教程。
如果您想使用UI运行,请参阅UI仓库以获取开发者环境说明。
维护者
区域 | 主要维护者 | 共同维护者 | 状态 |
---|---|---|---|
项目负责人 | @elsirion | @dpc @joschisan | X |
核心服务器 | @joschisan | X | 大多数因素良好,没有已知问题 |
核心共识 | @joschisan | @bradleystachurski | 抛光并记录 |
闪电模块 | @joschisan | @m1sterc001guy | 积极开发,存在已知问题 |
Mint模块 | @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 |
依赖项
~80MB
~1.5M SLoC