Fedimint

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

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

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

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

运行您的Fedimint

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

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

要执行闪电支付，Fedimint需要一个闪电网关：联盟的用户，愿意以电现金交换发送/接收闪电支付。闪电网关不是守护者，它作为不受信任的经济参与者为联盟提供服务。

在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包管理器来管理依赖关系和构建项目。

本地开发

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

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

just mprocs

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

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

维护者