Fedimint

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

Fedimint 是一个在 MIT 许可证下发布的 alpha 软件版本。这意味着提供的软件是“原样提供的”，不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您因该软件中的错误而损失资金，我们可能无法帮助您恢复资金。我们建议您在 mutinynet 等测试网上运行 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 和相关的开源比特币项目。Fedimint 涉及到比特币开发的许多不同领域，所以每个人都能找到自己感兴趣的方向。开始的最佳地方是

• Fedimint 开发者 Discord：获得帮助和提问的最佳地方。
• Fedimint 技术参考文档
• Fedimint 贡献者日历：此日历包含所有开发者会议和活动。
• Fedimint 开发者会议：我们每周一 4 点 UTC 举行开发者会议，以审查 PR 并讨论当前的开发优先事项。作为一名新开发者，这是一个找到良好入门问题和从核心团队获得指导的绝佳地方，了解如何开始为 Fedimint 做出贡献。
• PR 审查俱乐部：我们每周二 4 点 UTC 举行 PR 审查会议。
• 每周深入探讨：我们每周四 4 点 UTC 深入探讨技术话题：密码学、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包管理器来管理依赖项和构建项目。

本地开发

关于如何使用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仓库中的开发者环境说明。

维护者