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

fedimint-mint-common

fedimint-mint 是一个 Chaumian 电子现金铸造模块

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 日

#244 in 神奇豆

Download history 74/week @ 2024-04-28 336/week @ 2024-05-05 293/week @ 2024-05-12 211/week @ 2024-05-19 160/week @ 2024-05-26 273/week @ 2024-06-02 141/week @ 2024-06-09 109/week @ 2024-06-16 52/week @ 2024-06-23 189/week @ 2024-06-30 25/week @ 2024-07-07 575/week @ 2024-07-14 470/week @ 2024-07-21 128/week @ 2024-07-28 149/week @ 2024-08-04 45/week @ 2024-08-11

926 个月下载量
用于 12 个 crate (3 个直接)

MIT 许可证

570KB
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 和相关开源 Bitcoin 项目。Fedimint 涉及到 Bitcoin 开发的许多不同领域,因此总有一款适合您。下面提供更多关于如何参与的信息。

运行您自己的 Fedimint

设置和运行自己的联邦很简单。Fedimint 设计为具有 拜占庭容错 功能,因此对 m 恶意节点具有弹性,在 3m + 1 个节点的联邦中。如果您运行一个由 4 个守护者组成的联邦,则对 1 个恶意守护者具有弹性;如果您运行一个由 7 个守护者组成的联邦,则对 2 个守护者具有弹性,依此类推。

Fedimint 也可以在 "独奏模式" 下运行,只有一个守护者。这对于测试和开发很有用,但不建议用于生产。

要进行闪电支付,Fedimint 需要一个 闪电网关:一个愿意以 ecash 交换发送/接收闪电支付的联盟用户。闪电网关不是一个守护者,而是一个为联盟服务的不可信的经济行为者。

在 Mutinynet 上运行 Fedimint

请参阅 Fedimint Mutinynet 设置指南。您可以根据需要修改配置选项来部署。

对于开发者

我们正在积极寻找开发者来帮助构建 Fedimint 和相关开源 Bitcoin 项目。Fedimint 涉及到 Bitcoin 开发的许多不同领域,因此总有一款适合您。开始的最佳场所是

  • Fedimint 开发者 Discord:获取帮助和提问的最佳场所。
  • Fedimint 技术参考文档
  • Fedimint 贡献者日历:此日历包含所有开发者会议和活动。
  • Fedimint 开发者会议:我们每周一 4PM UTC 进行开发者会议,以审查 PR 并讨论当前的开发优先事项。作为一名新开发者,这是一个找到好的首次问题并从核心团队获得关于如何开始为 Fedimint 做贡献的指导的绝佳场所。
  • PR 审查俱乐部:我们每周二 4PM UTC 进行 PR 审查会议。
  • 每周深度探讨:我们每周四 4PM UTC 进行深度探讨,以深入讨论与 Fedimint 相关的技术主题:密码学、Rust 编程、共识、网络等。这是一个了解 Fedimint 和 Bitcoin 内部结构的好地方。我们通常根据贡献者对 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包管理器来管理依赖项并构建项目。

本地开发

Fedimint开发者教程中,我们有一个详细的教程,介绍如何使用cli发送/接收ecash、闪电支付以及执行其他开发者操作。

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 活跃开发,存在已知问题
Mint模块 @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

依赖关系

~41–56MB
~823K SLoC