Fedimint

Fedimint 是一个基于模块的系统，用于构建联邦应用程序。它被设计成一种最小化信任、抵抗审查和私有的替代集中式应用程序的选择。

Fedimint 是在 MIT 许可证 下发布的 alpha 版本软件。这意味着软件提供“原样”，不提供任何形式的保证。我们是一个资源有限的小型开发团队。如果您由于此软件中的错误导致资金损失，我们可能无法帮助您恢复资金。我们建议您在 mutininet 等测试网络上运行 Fedimint，或在主网上使用少量资金。您可以在这里找到我们的最新版本。

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

Fedimint 开发者 Discord 是获取帮助和提问的最佳场所。加入 Discord 并打个招呼！我们非常活跃，致力于将所有技能水平的开发者引入 Fedimint 和相关的开源 Bitcoin 项目。Fedimint 涉及到 Bitcoin 开发的许多不同领域，因此总有适合每个人的东西。下面提供更多信息，了解如何参与其中。

运行自己的 Fedimint

设置和运行自己的联邦非常简单。Fedimint 设计为 拜占庭容错，因此对联邦中的 m 个恶意节点具有弹性。如果您运行一个由 4 个守护者组成的联邦，则对 1 个恶意守护者具有弹性；如果您运行一个由 7 个守护者组成的联邦，则对 2 个守护者具有弹性，依此类推。

Fedimint 还可以以“单守护者模式”运行。这对于测试和开发很有用，但不建议在生产环境中使用。

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

在 Mutinynet 上运行 Fedimint

请参阅 Fedimint Mutinynet 安装指南。您可以修改配置选项以部署。

对于开发者

我们正在积极寻找开发者来帮助构建 Fedimint 和相关的开源 Bitcoin 项目。Fedimint 涉及到 Bitcoin 开发的许多不同领域，因此总有适合每个人的东西。开始的最佳地方是

• Fedimint 开发者 Discord：获取帮助和提问的最佳场所。
• Fedimint 技术参考文档
• Fedimint 贡献者日历：此日历包含所有开发者通话和活动。
• Fedimint 开发者通话：我们每周一 4PM UTC 进行开发者通话，以审查 PR 并讨论当前的开发优先级。作为一名新开发者，这是一个寻找良好入门问题并获得核心团队关于如何开始为 Fedimint 做贡献的指导的绝佳地方。
• PR 审查俱乐部：我们每周二 4PM UTC 进行 PR 审查通话。
• 每周深度研究：我们每周四 4PM 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 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

然后分叉并克隆Fedimint仓库。

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

然后进入nix开发者环境。

nix develop

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

just mprocs

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

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

维护者