40个版本
新 0.4.2-rc.0 | 2024年8月20日 |
---|---|
0.4.0-rc.4 | 2024年7月26日 |
0.3.0-rc.3 | 2024年3月26日 |
0.2.1-rc3 | 2023年12月22日 |
0.2.0-rc3 | 2023年11月29日 |
#887 in 魔法豆
1,114 每月下载量
用于 22 个crate(16 直接使用)
1MB
21K SLoC
Fedimint
Fedimint 是一个基于模块的系统,用于构建联盟应用。它旨在成为去信任、抗审查和隐私化的集中式应用的替代方案。
Fedimint 是在MIT许可证下发布的alpha软件。这意味着软件提供“原样”,不提供任何类型的保证。我们是一个小型开发团队,资源有限。如果您因本软件中的错误导致资金损失,我们可能无法帮助您恢复资金。我们建议您在mutinynet等测试网上运行Fedimint,或使用少量资金在主网上运行。您可以在此处找到我们的最新版本。
Fedimint预装了3个默认模块 - Bitcoin,Lightning,以及Chaumian Ecash - 以提供即插即用的最佳实践,用于私人化和去信任的支付。您可以根据支付模块编写自定义模块,以定义更多的共识项目和交易类型,从而构建自己的联盟应用。您可以编写自定义模块。
Fedimint开发者Discord是获取帮助和提问的最佳场所。加入Discord并打个招呼!我们非常活跃,致力于帮助所有技能水平的开发者加入Fedimint及其相关的开源比特币项目。Fedimint涉及比特币开发的许多不同领域,所以总有适合每个人的内容。下面将提供更多关于如何参与的信息。
运行自己的Fedimint
设置和运行自己的联盟非常简单。Fedimint设计为具有拜占庭容错功能,因此对联盟中的恶意节点具有抗性。在包含3m + 1
个节点的联盟中,可以抵抗m
个恶意节点。如果你运行一个由4个守护者组成的联盟,你可以抵抗1个恶意守护者;如果你运行一个由7个守护者组成的联盟,你可以抵抗2个守护者,等等。
Fedimint也可以在“单守护者模式”下运行。这对于测试和开发很有用,但不建议在生产中使用。
要进行闪电支付,Fedimint需要一个闪电网关:愿意交换ecash以发送/接收闪电支付的联盟用户。闪电网关不是守护者,而是作为为联盟服务的不可信经济行为者。
在Mutinynet上运行Fedimint
请参阅Fedimint Mutinynet设置指南。你可以修改配置选项来部署它。
对于开发者
我们正在积极寻找开发者来帮助构建Fedimint及其相关的开源比特币项目。Fedimint涉及比特币开发的许多不同领域,所以总有适合每个人的内容。开始的最佳地方是
- Fedimint开发者Discord:获取帮助和提问的最佳场所。
- Fedimint技术参考文档
- Fedimint贡献者日历:此日历包含所有开发者会议和活动。
- Fedimint开发者会议:我们每周一下午4点UTC举行开发者会议,以审查PR并讨论当前的开发优先事项。作为新开发者,这是一个找到良好起点和从核心团队获得指导的好地方,了解如何开始为Fedimint做出贡献。
- PR审查俱乐部:我们每周二下午4点UTC举行PR审查会议。
- 每周深度研讨:我们每周四下午4点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的示例节点实现兼容。我们一直在寻找闪电开发者来帮助闪电网关的开发,特别是改善支付可靠性和添加对更多闪电实现的兼容性。
- 自定义模块:Fedimint自带3个默认模块:比特币、闪电和Chaumian Ecash。你可以编写自定义模块,定义更多的共识项和交易类型,利用支付模块来构建自己的联邦应用。我们一直在寻找开发者帮助构建自定义模块,并帮助改进模块系统。
启动Fedimint开发者环境
Fedimint是一个Rust项目,使用Nix包管理器来管理依赖项和构建项目。
本地开发
我们在Fedimint开发者教程中有详细的教程,说明如何使用命令行工具发送/接收ecash、闪电支付以及执行其他开发者操作。
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
并使用以下命令启动一个包含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 |
依赖
~64MB
~1M SLoC