19 个版本
0.4.0 | 2024 年 8 月 5 日 |
---|---|
0.4.0-rc.4 | 2024 年 7 月 26 日 |
0.3.3 | 2024 年 7 月 25 日 |
0.3.2-rc.0 | 2024 年 5 月 23 日 |
0.3.0-rc.3 | 2024 年 3 月 26 日 |
#234 in 魔法豆
849 个月下载量
用于 2 crates
595KB
13K SLoC
Fedimint
Fedimint 是一个基于模块的系统,用于构建联邦应用。它旨在作为一个最小化信任、抗审查和隐私的替代方案,用于集中式应用。
Fedimint 是在 MIT 许可证 下发布的 alpha 软件版本。这意味着提供的软件“现状”,不提供任何类型的保证。我们是一个小型开发团队,资源有限。如果您因本软件中的错误而损失资金,我们可能无法帮助您恢复资金。我们建议您在 mutininet 等测试网上运行 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包管理器来管理依赖项和构建项目。
本地开发
我们在Fedimint开发者教程中有详细的教程,介绍如何使用cli发送/接收ecash、闪电支付以及执行其他开发者操作。
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
然后你可以使用cli与守护者和闪电网关交互。有关如何使用cli的更多详细信息,请参阅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 |
依赖
~42–56MB
~825K SLoC