39 个版本

0.4.0 2024 年 8 月 5 日
0.4.0-rc.42024 年 7 月 26 日
0.3.3 2024 年 7 月 25 日
0.3.0-rc.32024 年 3 月 26 日
0.2.0-rc32023 年 11 月 29 日

#951神奇豆子

Download history 103/week @ 2024-04-23 107/week @ 2024-05-07 11/week @ 2024-05-14 155/week @ 2024-05-21 12/week @ 2024-05-28 19/week @ 2024-06-04 14/week @ 2024-06-11 6/week @ 2024-06-18 8/week @ 2024-06-25 177/week @ 2024-07-02 3/week @ 2024-07-09 545/week @ 2024-07-16 314/week @ 2024-07-23 135/week @ 2024-07-30

997 每月下载量
用于 2 crate

MIT 许可证

535KB
12K SLoC

Fedimint

GitHub Actions CI Build Status Developer Discord Chat GitHub Discussion docs built from master Lines of code

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

Fedimint 是在 MIT 许可证 下发布的 alpha 版本软件。这意味着提供的软件“现状”,没有任何形式的保证。我们是一个资源有限的小型开发团队。如果您因本软件中的错误导致资金损失,我们可能没有能力帮助您恢复资金。我们建议您在 mutinynet 等测试网上运行 Fedimint,或者在小额资金的主网上运行。您可以在 此处 找到我们的最新版本。

Fedimint自带3个默认模块 - BitcoinLightningChaumian 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仓库中的开发者环境说明。

维护者

领域 主要维护者 共同维护者 状态
项目负责人 @elsirion @dpc @joschisan X
核心服务器 @joschisan X 大部分模块化良好,没有已知问题
核心共识 @joschisan @bradleystachurski 经过打磨并已记录文档
闪电模块 @joschisan @m1sterc001guy 活跃开发,存在已知问题
铸造模块 @joschisan X 活跃开发,存在已知问题
钱包模块 @bradleystachurski @dpc @joschisan 活跃开发,存在关键问题
核心客户端 @dpc X X
闪电网关 @m1sterc001guy @joschisan X
数据库 @m1sterc001guy X X
网络 X X X
CI / Nix @dpc @maan2003 @bradleystachurski X
测试 @bradleystachurski X X
Devimint @maan2003 X X
配置生成 X X X

依赖项

~40–54MB
~805K SLoC