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 日

#2265魔法豆

Download history 226/week @ 2024-04-18 92/week @ 2024-04-25 185/week @ 2024-05-02 284/week @ 2024-05-09 70/week @ 2024-05-16 104/week @ 2024-05-23 162/week @ 2024-05-30 185/week @ 2024-06-06 77/week @ 2024-06-13 9/week @ 2024-06-20 139/week @ 2024-06-27 42/week @ 2024-07-04 54/week @ 2024-07-11 479/week @ 2024-07-18 360/week @ 2024-07-25 136/week @ 2024-08-01

每月下载量 1,029 次
用于 fedimint-cli

MIT 许可证

1MB
19K 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 开发者会议:我们每周一 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

然后分叉并克隆 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

依赖项

~64MB
~1M SLoC