#fedimint #module #lightning #consensus #bitcoin #federation #e-cash

fedimint-unknown-common

fedimint-unknown 是一个没有客户端实现的 fedimint 模块

19 个版本

0.4.0 2024 年 8 月 5 日
0.4.0-rc.42024 年 7 月 26 日
0.3.3 2024 年 7 月 25 日
0.3.2-rc.02024 年 5 月 23 日
0.3.0-rc.32024 年 3 月 26 日

#498 in 魔法豆

Download history 3/week @ 2024-04-28 87/week @ 2024-05-05 9/week @ 2024-05-12 113/week @ 2024-05-19 3/week @ 2024-05-26 5/week @ 2024-06-02 4/week @ 2024-06-09 2/week @ 2024-06-16 164/week @ 2024-06-30 34/week @ 2024-07-07 434/week @ 2024-07-14 345/week @ 2024-07-21 92/week @ 2024-07-28 110/week @ 2024-08-04 11/week @ 2024-08-11

679 每月下载量
用于 2 crates

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设计为拜占庭容错,因此可以抵抗一个由3m + 1节点组成的联盟中的m恶意节点。如果您运行一个由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电子现金。您可以使用支付模块编写自定义模块,以定义更多共识项目和交易类型,构建自己的联邦应用程序。我们一直在寻找开发者来帮助构建自定义模块并改进模块系统。

启动Fedimint开发者环境

Fedimint是一个Rust项目,使用Nix包管理器来管理依赖项和构建项目。

本地开发

关于如何使用命令行界面发送/接收电子现金、闪电支付以及执行其他开发者操作,我们在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

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

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–55MB
~815K SLoC