2 个不稳定版本
0.2.0 | 2022年11月23日 |
---|---|
0.1.0 | 2022年10月14日 |
在 #ln 中排名第 7
12MB
1.5K SLoC
包含 (WOFF 字体, 315KB) boxicons.woff, (WOFF 字体, 150KB) bootstrap-icons.woff, (WOFF 字体, 115KB) bootstrap-icons.woff2, (WOFF 字体, 115KB) boxicons.woff2
关于此项目
这是一个 rust 实现的联邦 Lightning 地址 服务器。
Lightning 地址 / 别名通过使用类似于电子邮件的地址来接收和发送比特币闪电支付,极大地提高了使用 LN 支付的用户体验。
联邦服务器允许您轻松处理 LN 地址请求,并将这些功能添加到您拥有的域中。
该项目包括 服务器 和 命令行工具
- 服务器 负责处理来自 LN 钱包 的请求,并提供别名预留页面和 API。
- 命令行工具 可用于与嵌入的数据库交互,以导出/导入数据或生成使用统计信息。
Keysend
目前 sataddress
是唯一支持 keysend (pubkey) 别名实现的联邦服务器。
通过引入一个中间的闪电节点来接收支付并将其自动转发到目标节点来实现该解决方案。
得益于上述设置,用户不需要公开其 Lightning 节点的 API(包括机密信息),并且能够被动地接收支付。
入门指南
首先,查看 最新部署版本 在 satspay.to
运行服务器最简单的方法是使用自动发布的 docker 容器。
您可以通过传递给 docker 或将它们放入 dot-env
文件中来轻松配置容器。
# .env file
DOMAINS=sataddress.rs,another-domain.com
PIN_SECRET=my-secret-phrase
SITE_NAME=SATADDRESS
SITE_SUB_NAME=.rs
# keysend requires lnbits proxy to work
LNBITS_URL=http://127.0.0.1:5001
LNBITS_API_KEY=THE_API_KEY
LNBITS_ADMIN_ID=ADMIN_ID_UNDER_WHICH_SUBACCOUNTS_ARE_CREATED
一旦您确定了配置,只需运行容器即可。
$ docker run -v $(pwd)/.env:/opt/sataddress/.env -v $(pwd)/sataddress.db:/opt/sataddress/sataddress.db --name sataddress -it --rm sataddress:latest
作为替代方案,如果您熟悉Rust工具集,可以使用just,它也会自动加载您的.env
文件。
$ just run
路线图
- 支持keysend
- 改进测试
- 添加数据操作功能的REST API
- 更好的错误生成和处理
- 可定制的图像、备忘录、最大/最小发票sats
- 更多后端/节点实现(欢迎贡献!)
查看公开问题以获取提议的功能(和已知问题)的完整列表。
许可协议
根据MIT许可协议分发。有关更多信息,请参阅LICENSE
。
联系方式
Bernard Kobos - @bkobos - [email protected]
项目链接: https://github.com/bernii/sataddress-rs
致谢
- satdress原始联邦闪电地址服务器实现,本实现基于此
- go-lnurl,这对于了解LN URL结构很有帮助
- Lightning Address文档和说明
- BTC lightning logo用于创建开源矢量btc标志
依赖项
~17–31MB
~491K SLoC