#fedimint #build #lightning #information #git-version #bitcoin #build-script

构建 fedimint-build

Fedimint构建脚本工具,用于在构建中包含git版本信息

41个版本

0.4.2-rc.0 2024年8月20日
0.4.0-rc.42024年7月26日
0.3.0-rc.32024年3月26日
0.2.1-rc32023年12月22日
0.0.1 2023年2月22日

#881 in 魔法豆

Download history 104/week @ 2024-04-28 385/week @ 2024-05-05 329/week @ 2024-05-12 282/week @ 2024-05-19 189/week @ 2024-05-26 314/week @ 2024-06-02 161/week @ 2024-06-09 144/week @ 2024-06-16 68/week @ 2024-06-23 241/week @ 2024-06-30 137/week @ 2024-07-07 845/week @ 2024-07-14 562/week @ 2024-07-21 174/week @ 2024-07-28 210/week @ 2024-08-04 90/week @ 2024-08-11

1,183 每月下载量
用于 27 个crate(8 个直接使用)

MIT 协议

17KB
81

Fedimint

GitHub Actions CI Build Status Developer Discord Chat GitHub Discussion docs built from master Lines of code

Fedimint 是一个基于模块的系统,用于构建联邦应用程序。它设计为一种最小化信任、抗审查和隐私的替代集中式应用程序的解决方案。

Fedimint是处于alpha阶段的软件,在MIT许可证下发布。这意味着这里的软件是“按原样”提供的,不提供任何类型的保证。我们是一个资源有限的小型开发团队。如果您因本软件的缺陷而损失资金,我们可能无法帮助您恢复资金。我们建议您在mutinynet等测试网络上运行Fedimint,或在主网上用少量资金运行。您可以在这里找到我们的最新版本。

Fedimint附带3个默认模块 - BitcoinLightningChaumian Ecash - 以实现最佳实践,用于私人化和最小化信任的支付。您还可以编写自定义模块,通过利用支付模块定义更多的共识项目和交易类型,从而构建您自己的联邦应用程序。

联邦明(Fedimint)开发者Discord是获取帮助和提问的最佳场所。加入Discord并打个招呼!我们非常活跃,致力于帮助所有技能水平的开发者加入联邦明和相关开源比特币项目。联邦明涉及比特币开发的许多不同领域,所以每个人都有适合的项目。下面提供更多关于如何参与的信息。

运行您自己的联邦明

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

联邦明也可以以“单守护者模式”运行。这对于测试和开发很有用,但不建议在生产环境中使用。

要进行闪电支付,联邦明需要一个闪电网关:一个愿意以电现金交换发送/接收闪电支付的联邦用户。闪电网关不是守护者,它作为一个未受信任的经济行为者服务于联邦。

在Mutinynet上运行Fedimint

请参阅Fedimint Mutinynet设置指南。您可以根据需要进行配置修改。

针对开发者

我们正在积极寻找开发者来帮助构建联邦明和相关开源比特币项目。联邦明涉及比特币开发的许多不同领域,所以每个人都有适合的项目。开始的最佳地点是

  • 联邦明开发者Discord:获取帮助和提问的最佳场所。
  • 联邦明技术参考文档
  • 联邦明贡献者日历:此日历包含所有开发者会议和活动。
  • 联邦明开发者会议:我们每周一下午4点UTC举行开发者会议,以审查PR并讨论当前的开发优先事项。作为一名新开发者,这是一个找到好的入门问题和从核心团队获得指导以开始贡献联邦明的绝佳场所。
  • PR审查俱乐部:我们每周二下午4点UTC举行PR审查会议。
  • 每周深入探讨:我们每周四下午4点UTC举行深入探讨会议,讨论与联邦明相关的技术主题:密码学、Rust编程、共识、网络等。这是一个了解联邦明和比特币内部结构的绝佳场所。我们通常根据贡献者对联邦明某一方面的学习请求来计划这些会议,所以如果您有任何想了解更多的话题,请告诉我们。

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

联邦明仓库和可贡献的项目

  • 联邦明:核心联邦明仓库。这是核心共识和网络代码所在之处。联邦明是一个高级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

并使用此命令启动一个包含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

依赖项

~0.5–1MB
~20K SLoC