42 个版本
新 0.4.2-rc.0 | 2024 年 8 月 20 日 |
---|---|
0.4.0-rc.4 | 2024 年 7 月 26 日 |
0.3.0-rc.3 | 2024 年 3 月 26 日 |
0.2.1-rc3 | 2023 年 12 月 22 日 |
0.0.1 | 2023 年 3 月 9 日 |
#885 in 魔法豆
1,619 每月下载量
在 27 个 crate(6 个直接使用) 中使用
18KB
82 行
Fedimint
Fedimint 是一个用于构建联邦应用的模块化系统。它旨在成为一个最小化信任、抗审查和隐私的替代集中式应用的解决方案。
Fedimint 是一个在 MIT 许可证 下发布的 alpha 版软件。这意味着提供的软件“按原样”提供,不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您因该软件中的错误而损失资金,我们可能无法帮助您恢复资金。我们建议您在 mutinynet 等测试网上运行 Fedimint,或在主网上用少量资金运行。您可以在 这里 找到我们的最新版本。
Fedimint 随附 3 个默认模块 - Bitcoin、Lightning 和 Chaumian Ecash - 以实现最佳实践,用于隐私和最小化信任的支付。您可以编写自定义模块,定义更多的共识项目和交易类型,利用支付模块来构建自己的联邦应用。
Fedimint开发者Discord是获取帮助和提问的最佳场所。加入Discord并打个招呼!我们非常活跃,致力于吸引所有技能水平的开发者加入Fedimint及其相关的开源比特币项目。Fedimint涉及比特币开发的许多不同领域,因此每个人都能找到适合自己的项目。下面提供了更多关于如何参与的信息。
运行您自己的Fedimint
设置和运行自己的联邦非常简单。Fedimint设计为拜占庭容错,因此能够抵抗一个包含3m + 1
个节点的联邦中的m
个恶意节点。如果您运行一个由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 |
依赖
~6–14MB
~250K SLoC