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 日

#1981神奇豆子

Download history 91/week @ 2024-04-22 89/week @ 2024-05-06 5/week @ 2024-05-13 91/week @ 2024-05-20 2/week @ 2024-06-03 4/week @ 2024-06-10 180/week @ 2024-07-01 440/week @ 2024-07-15 361/week @ 2024-07-22 145/week @ 2024-07-29 117/week @ 2024-08-05

1,063 每月下载量
用于 2 crates

MIT 许可证

1MB
21K SLoC

Fedimint

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

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

Fedimint 是在 MIT 许可证 下发布的 alpha 软件版本。这意味着提供的软件是“按原样”提供的,不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您因为本软件中的错误而损失资金,我们可能无法帮助您恢复资金。我们建议您在 mutininet 等测试网上运行 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开发者会议:我们每周一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仓库的开发者环境说明。

维护者

区域 主维护者 共同维护者 状态
项目负责人 @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

依赖项

~47–63MB
~1M SLoC