40个版本
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.0.1 | 2023年2月22日 |
#508 in 神奇豆
每月551次下载
用于 9 crates
1MB
22K SLoC
Fedimint
Fedimint 是一个基于模块的系统,用于构建联邦应用程序。它被设计为最小化信任、抵抗审查和隐私的集中式应用程序的替代方案。
Fedimint 是一个在 MIT 许可证 下发布的alpha软件。这意味着软件“按原样”提供,不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您因该软件中的错误而损失资金,我们可能无法帮助您恢复资金。我们建议您在mutinynet等测试网上运行Fedimint,或在主网上用少量资金运行。您可以在这里找到我们的最新版本。
Fedimint自带3个默认模块 - Bitcoin、Lightning 和 Chaumian Ecash - 以提供开箱即用的最佳实践,实现私有和最小化信任的支付。您可以编写自定义模块,利用支付模块定义更多的共识项目和交易类型,构建自己的联邦应用程序。编写自定义模块。
Fedimint开发者Discord是获取帮助和提问的最佳场所。加入Discord并打个招呼!我们非常活跃,致力于将所有技能水平的开发者引入Fedimint和相关开源Bitcoin项目。Fedimint触及Bitcoin开发的许多不同领域,因此每个人都有机会。以下是如何参与的更多信息。
运行自己的Fedimint
设置和运行自己的联邦非常简单。Fedimint被设计成拜占庭容错,因此对联邦中的恶意节点具有弹性,节点数量为3m + 1
。如果您运行一个由4个守护者组成的联邦,您对1个恶意守护者具有弹性;如果您运行一个由7个守护者组成的联邦,您对2个守护者具有弹性等。
Fedimint也可以以“单机模式”运行,只有一个守护者。这对于测试和开发很有用,但不建议用于生产。
要进行闪电支付,Fedimint需要一个闪电网关:一个愿意交换ecash以发送/接收闪电支付的联邦用户。闪电网关不是守护者,它作为一个不受信任的经济行为者服务于联邦。
在Mutinynet上运行Fedimint
请参阅Fedimint Mutinynet设置指南。您可以根据需要进行配置选项的修改。
对于开发者
我们正在积极寻找开发者来帮助构建Fedimint和相关开源Bitcoin项目。Fedimint触及Bitcoin开发的许多不同领域,因此每个人都有机会。开始的最佳地方是
- Fedimint开发者Discord:获取帮助和提问的最佳场所。
- Fedimint技术参考文档
- Fedimint贡献者日历:此日历包含所有开发者通话和活动。
- Fedimint开发者通话:我们每周一下午4点UTC举行开发者通话,以审查PR和讨论当前开发优先事项。作为一名新开发者,这是一个寻找好问题并获得核心团队关于如何开始为Fedimint做出贡献的指导的好地方。
- PR审查俱乐部:我们每周二下午4点UTC举行PR审查通话。
- 每周深入研究:我们每周四下午4点UTC进行深入讨论,讨论与Fedimint相关的技术主题:密码学、Rust编程、共识、网络等。这是一个深入了解Fedimint和Bitcoin内部的好地方。我们通常根据贡献者在Fedimint方面希望了解更多方面的请求来计划这些通话,因此如果您有想了解更多的话题,请随时联系我们。
有关贡献指南、贡献领域以及如何参与,请参阅贡献指南。
可贡献的 Fedimint 仓库和项目
- Fedimint:Fedimint 的核心仓库。这里存放着核心共识和网络代码。Fedimint 是一个高级的 Rust 项目,是学习 Rust、密码学、网络、共识和比特币开发的好地方。我们有很多适合新手的任务,愿意指导新开发者,并且一直在寻找有经验的 Rust 开发者来帮助构建核心代码库。
- UI:默认的 Fedimint 守护者和闪电网关 UI。这些都是 TypeScript 和 React 项目。为这个仓库做出贡献有助于 UI/UX 设计和开发,使 Fedimint 更加用户友好。
- 闪电网关:Fedimint 的闪电网关作为 HTLC 中继器实现,目前与 CLN、LND 和 LDK 的示例节点实现兼容。我们一直在寻找闪电开发者来帮助构建闪电网关,特别是在提高支付可靠性和增加更多闪电实现支持方面。
- 自定义模块:Fedimint 随带 3 个默认模块:比特币、闪电和 Chaumian 电子现金。你可以编写自定义模块来定义更多的共识项和交易类型,利用支付模块来构建自己的联邦应用程序。我们一直在寻找开发者来帮助构建自定义模块并改进模块系统。
启动 Fedimint 开发环境
Fedimint 是一个 Rust 项目,使用 Nix 软件包管理器 来管理依赖项并构建项目。
本地开发
我们在 Fedimint 开发者教程 中详细介绍了如何使用 cli 发送/接收电子现金、闪电支付和执行其他开发者操作。
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 | 积极开发,存在已知问题 |
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 |
依赖关系
~75MB
~1.5M SLoC