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日

#766 in 魔法豆

Download history 99/week @ 2024-04-22 103/week @ 2024-05-06 9/week @ 2024-05-13 145/week @ 2024-05-20 4/week @ 2024-05-27 13/week @ 2024-06-03 9/week @ 2024-06-10 3/week @ 2024-06-24 232/week @ 2024-07-01 448/week @ 2024-07-15 331/week @ 2024-07-22 75/week @ 2024-07-29 120/week @ 2024-08-05

974 每月下载量

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 软件版本。这意味着提供的软件是“按原样”提供的,没有任何形式的保证。我们是一个资源有限的小型开发团队。如果您因本软件的故障而损失资金,我们可能无法帮助您恢复资金。我们建议您在 mutinynet 等测试网上运行 Fedimint,或在主网上用少量资金进行测试。您可以通过 这里 找到我们的最新版本。

Fedimint 随附 3 个默认模块 - BitcoinLightning,和 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 开发者会议:我们每周一 4PM UTC 进行开发者会议,以审查 PR 并讨论当前的开发重点。作为一名新开发者,这是一个找到良好起点和从核心团队获得指导的好地方,了解如何开始为 Fedimint 做贡献。
  • PR 审查俱乐部:我们每周二 4PM UTC 进行 PR 审查会议。
  • 每周深入探讨:我们每周四 4PM 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 包管理器 来管理依赖项和构建项目。

本地开发

有关如何使用 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

依赖项

~47–63MB
~1M SLoC