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

fedimint-wallet-server

fedimint-wallet是一个链上比特币钱包模块。它使用键值存储,不是一个标准的HD钱包。

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日

#2547 in 神奇豆

Download history 69/week @ 2024-04-18 26/week @ 2024-04-25 53/week @ 2024-05-02 49/week @ 2024-05-09 14/week @ 2024-05-16 100/week @ 2024-05-23 6/week @ 2024-05-30 13/week @ 2024-06-06 4/week @ 2024-06-13 2/week @ 2024-06-20 139/week @ 2024-06-27 26/week @ 2024-07-04 75/week @ 2024-07-11 487/week @ 2024-07-18 350/week @ 2024-07-25 143/week @ 2024-08-01

1,055每月下载量
用于 3 crates

MIT许可协议

1MB
23K 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,或者在使用少量资金的mainnet上运行。您可以在这里找到我们的最新版本。

Fedimint 默认配备了 3 个模块 - BitcoinLightningChaumian Ecash - 以实现即插即用的最佳实践,用于私有和最小化信任的支付。您可以为 Fedimint 编写自定义模块,定义更多的共识项目和交易类型,利用支付模块构建自己的联邦应用。

Fedimint 开发者 Discord 是获取帮助和提问的最佳场所。请加入 Discord 并打个招呼!我们非常活跃,致力于欢迎所有技能水平的开发者加入 Fedimint 和相关开源 Bitcoin 项目。Fedimint 涉及 Bitcoin 开发的许多不同领域,因此每个人都有自己的用武之地。以下提供了更多关于如何参与的信息。

运行您自己的 Fedimint

设置和运行自己的联邦非常简单。Fedimint 被设计成 拜占庭容错,因此对 m 个恶意节点具有抵抗力,在 3m + 1 个节点的联邦中。如果您运行一个由 4 个守护者组成的联邦,您就可以抵御 1 个恶意守护者;如果您运行一个由 7 个守护者组成的联邦,您就可以抵御 2 个守护者,等等。

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

要进行闪电支付,Fedimint 需要 Lightning Gateway:一个愿意用 ecash 交换发送/接收闪电支付的联邦用户。Lightning Gateway 不是一个守护者,它作为不受信任的经济参与者为联邦提供服务。

在 Mutinynet 上运行 Fedimint

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

面向开发者

我们正在积极寻找开发者来帮助构建 Fedimint 和相关开源 Bitcoin 项目。Fedimint 涉及 Bitcoin 开发的许多不同领域,因此每个人都有自己的用武之地。开始的最佳地点是

  • Fedimint 开发者 Discord:获取帮助和提问的最佳场所。
  • Fedimint 技术参考文档
  • Fedimint 贡献者日历:此日历包含所有开发者会议和活动。
  • Fedimint 开发者会议:我们每周一 UTC 4 点举行开发者会议,以审查 PR 并讨论当前的开发优先事项。作为新开发者,这是一个找到好的第一个问题和从核心团队那里获得关于如何开始贡献 Fedimint 的指导的绝佳地方。
  • PR 审查俱乐部:我们每周二 UTC 4 点举行 PR 审查会议。
  • 每周深入研究:我们每周四 UTC 4 点进行深入研究,以深入讨论与 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 活跃开发,存在已知问题
铸币模块 @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

依赖项

~78MB
~1.5M SLoC