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

fedimint-empty-common

fedimint-empty 是一个空的 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日

#681 in 魔法豆

Download history 50/week @ 2024-04-17 43/week @ 2024-04-24 91/week @ 2024-05-08 7/week @ 2024-05-15 94/week @ 2024-05-22 1/week @ 2024-05-29 4/week @ 2024-06-05 4/week @ 2024-06-12 102/week @ 2024-06-26 78/week @ 2024-07-03 547/week @ 2024-07-17 295/week @ 2024-07-24 142/week @ 2024-07-31

984 次每月下载
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 随带三个默认模块 - 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 16:00 举行开发者会议,以审查 PR 并讨论当前的开发优先事项。作为一名新开发者,这是一个寻找好的初始问题和从核心团队那里获得指导如何开始为 Fedimint 做贡献的好地方。
  • PR 审查俱乐部:我们每周二 UTC 16:00 举行 PR 审查会议。
  • 每周深度研讨会:我们每周四 UTC 16:00 进行深度研讨会,深入讨论与 Fedimint 相关的技术主题:密码学、Rust 编程、共识、网络等。这是一个了解 Fedimint 和比特币内部的好地方。我们通常根据贡献者对 Fedimint 的特定方面的学习请求来计划这些会议,所以如果你有想了解更多的话题,请提出。

有关贡献指南、贡献领域以及如何参与,请参阅 贡献指南

Fedimint 仓库和可以贡献的项目

  • Fedimint:核心 Fedimint 仓库。这是核心共识和网络代码所在的地方。Fedimint 是一个高级 Rust 项目,是学习 Rust、密码学、网络、共识和比特币开发的好地方。我们有很多好的初始问题,乐于指导新开发者,并始终在寻找有经验的 Rust 开发者来帮助核心代码库。
  • UI:Fedimint 默认守护者和闪电网关 UI。这些是 TypeScript 和 React 项目。为这个仓库做出贡献有助于 UI/UX 设计和开发,使 Fedimint 更易于使用。
  • 闪电网关:Fedimint 的闪电网关作为 HTLC 中断器实现,目前与 CLN、LND 和 LDK 的 sample-node 实现兼容。我们一直在寻找闪电开发者来帮助闪电网关,特别是改进支付可靠性和添加更多闪电实现的支持。
  • 自定义模块: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

依赖项

~40–54MB
~806K SLoC