Fedimint

Fedimint 是一个基于模块的系统，用于构建联邦应用。它旨在成为一个最小化信任、抗审查和私有的集中式应用替代品。

Fedimint 是在 MIT 许可证 下发布的 alpha 软件。这意味着提供的软件是“原样”提供的，不提供任何类型的保证。我们是一个小型开发团队，资源有限。如果您由于该软件的故障而损失资金，我们可能没有帮助您恢复资金的手段。我们建议您在 mutininet 等测试网上运行 Fedimint，或在主网上用少量资金运行。您可以在 此处 找到我们最新的发布版本。

Fedimint 随附 3 个默认模块 - Bitcoin、Lightning 和 Chaumian Ecash - 以提供开箱即用的最佳实践，用于私人和最小化信任的支付。您可以编写自定义模块，定义进一步的共识项和交易类型，利用支付模块构建自己的联邦应用。您可以编写自定义模块。

联邦米特开发者Discord是获取帮助和提问的最佳场所。《加入Discord》并打招呼！我们非常活跃，致力于将所有技能水平的开发者引入联邦米特及其相关的开源比特币项目。联邦米特触及比特币开发的许多不同领域，因此总有一款适合您。以下是如何参与的更多信息。

运行您自己的联邦米特

设置和运行自己的联邦很简单。联邦米特被设计成拜占庭容错，因此能够抵抗一个由3m + 1个节点组成的联邦中的m恶意节点。如果您运行一个由4个守护者组成的联邦，您将能够抵抗1个恶意守护者；如果您运行一个由7个守护者组成的联邦，您将能够抵抗2个守护者，依此类推。

联邦米特还可以以“单守护者模式”运行。这对于测试和开发很有用，但不推荐用于生产使用。

要进行闪电支付，联邦米特需要一个闪电网关：一个愿意以交换ecash为代价发送/接收闪电支付的用户。闪电网关不是一个守护者，而是一个为联邦服务的未受信任的经济行为者。

在Mutinynet上运行Fedimint

请参阅联邦米特Mutinynet设置指南。您可以修改配置选项以部署。

面向开发者

我们正在积极寻找开发者来帮助构建联邦米特及其相关的开源比特币项目。联邦米特触及比特币开发的许多不同领域，因此总有一款适合您。开始的最佳地方是

• 联邦米特开发者Discord：获取帮助和提问的最佳场所。
• 联邦米特技术参考文档
• 联邦米特贡献者日历：此日历包含所有开发者通话和活动。
• 联邦米特开发者通话：我们每周一晚上8点UTC进行开发者通话，以审查PR并讨论当前的开发优先事项。作为一名新开发者，这是一个寻找好的入门问题和从核心团队获得指导以开始贡献联邦米特的好地方。
• PR审查俱乐部：我们每周二晚上8点UTC进行PR审查通话。
• 每周深入研究：我们每周四晚上8点UTC进行深入研究，以深入讨论与联邦米特相关的技术主题：密码学、Rust编程、共识、网络等。这是一个了解联邦米特和比特币内部的好地方。我们通常根据贡献者对联邦米特某些方面的学习请求来计划这些通话，因此如果您想了解更多信息，请提出。

有关贡献指南、贡献领域以及如何参与，请参阅贡献指南。

联邦米特存储库和可以贡献的项目

• 联邦米特：核心联邦米特存储库。这是核心共识和网络代码所在的地方。联邦米特是一个高级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包管理器来管理依赖项和构建项目。

本地开发

我们有一个详细的教程，介绍了如何使用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

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

just mprocs

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

如果你想要使用UI，请参阅UI仓库中的开发环境说明。

维护者