Fedimint

Fedimint 是一个基于模块的系统，用于构建联邦应用。它被设计为一个最小化信任、抗审查和隐私的集中式应用的替代方案。

Fedimint 是一个在 MIT 许可证 下发布的alpha软件。这意味着软件提供“原样”，不提供任何保证。我们是一个小型开发团队，资源有限。如果您因为本软件的缺陷而损失资金，我们可能无法帮助您恢复资金。我们建议您在mutinynet等测试网上运行Fedimint，或者用少量资金在主网上运行。您可以在 这里 找到我们的最新版本。

Fedimint自带3个默认模块 - 比特币、闪电网络和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开发者通话：我们每周一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的示例节点实现兼容。我们一直在寻找闪电开发者来帮助闪电网关，特别是在提高支付可靠性和添加更多闪电实现支持方面。
• 自定义模块: 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和克隆Fedimint仓库。

git clone https://github.com/your-username/fedimint.git

然后进入Nix开发者环境。

nix develop

使用此命令启动本地regtest网络，包含4个守护者、一个比特币节点和一个闪电网关。

just mprocs

然后您可以使用cli与守护者和闪电网关进行交互。有关如何使用cli的更多详细信息，请参阅Fedimint开发者教程。

如果您想使用UI运行，请参阅UI仓库的开发者环境说明。

维护者