Fedimint

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

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

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

联邦明（Fedimint）开发者Discord是获取帮助和提问的最佳场所。加入Discord，打个招呼！我们非常活跃，致力于将所有技能水平的开发者引入联邦明及其相关的开源比特币项目。联邦明涉及比特币开发的许多不同领域，因此每个人都有适合自己的一片天地。以下提供了更多关于如何参与的详细信息。

运行自己的联邦明

设置和运行自己的联邦非常简单。联邦明设计为拜占庭容错，因此可以抵抗一个由3m + 1节点组成的联邦中的m恶意节点。如果您运行一个由4个守护者组成的联邦，则可以抵抗1个恶意守护者；如果您运行一个由7个守护者组成的联邦，则可以抵抗2个守护者，等等。

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

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

在Mutinynet上运行联邦明

请参阅联邦明Mutinynet设置指南。您可以根据需要修改配置选项来部署。

针对开发者

我们正在积极寻找开发者来帮助构建联邦明及其相关的开源比特币项目。联邦明涉及比特币开发的许多不同领域，因此每个人都有适合自己的一片天地。开始的最佳地方是

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

有关贡献指南、贡献领域以及如何参与的更多信息，请参阅贡献指南。

联邦明仓库和可贡献的项目

• 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

然后分叉并克隆Fedimint仓库。

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

然后进入Nix开发者环境。

nix develop

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

just mprocs

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

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

维护者