#module #fedimint #lightning #bitcoin #federated #e-cash #mint

fedimint-empty-server

fedimint-empty 是一个空 fedimint 模块,是新模块的好模板

17 个版本

新版本 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 日

#2057 in 魔法豆

Download history 44/week @ 2024-04-17 43/week @ 2024-04-24 91/week @ 2024-05-08 2/week @ 2024-05-15 79/week @ 2024-05-22 1/week @ 2024-06-05 98/week @ 2024-06-26 88/week @ 2024-07-03 395/week @ 2024-07-17 237/week @ 2024-07-24 128/week @ 2024-07-31

760 每月下载次数

MIT 许可证

555KB
12K 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 电子现金。您可以编写自定义模块,定义更多的共识项目和交易类型,利用支付模块来构建您自己的联盟应用。我们一直在寻找开发者来帮助构建自定义模块并帮助改进模块系统。

启动 Fedimint 开发环境

Fedimint 是一个 Rust 项目,使用 Nix 软件包管理器 来管理依赖关系并构建项目。

本地开发

我们有一个详细的教程,介绍如何使用 cli 发送/接收电子现金、闪电支付以及执行其他开发者操作,请参阅 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

您可以使用 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–55MB
~809K SLoC