Fedimint

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

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

Fedimint附带3个默认模块 - 比特币、闪电网络和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开发者通话：我们每周一在下午4点UTC进行开发者通话，以审查PR并讨论当前的开发优先事项。作为一名新开发者，这是一个找到好的入门问题和从核心团队获得指导的好地方，了解如何开始为Fedimint做出贡献。
• PR审查俱乐部：我们每周二在下午4点UTC进行PR审查通话。
• 每周深入研究：我们每周四在下午4点UTC进行深入研究，讨论与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包管理器来管理依赖关系和构建项目。

本地开发

在Fedimint开发者教程中，我们有关于如何使用命令行工具发送/接收ecash、闪电支付和执行其他开发者操作的详细教程。

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存储库的开发者环境说明。

维护者