Fedimint

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

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

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

Fedimint开发者Discord是获取帮助和提问的最佳场所。请加入Discord并打招呼！我们非常活跃，致力于欢迎所有技能水平的开发者加入Fedimint及其相关开源比特币项目。Fedimint涉及比特币开发的许多不同领域，因此每个人都有机会参与。下面提供更多有关如何参与的信息。

运行您的Fedimint

设置和运行自己的联邦很简单。Fedimint被设计成拜占庭容错，因此对联邦中的恶意节点m具有弹性，节点数量为3m + 1。如果您运行一个由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包管理器来管理依赖项和构建项目。

本地开发

有关如何使用命令行工具发送/接收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

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

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

维护者