article
README
🚀 Nostr匿名发帖服务器实现说明
本项目实现了Nostr匿名发帖服务器,具备丰富的功能特性,如对npub格式的本地支持、NIP - 57兼容的zap收据检测等,同时提供了清晰的安装和开发指南。
🚀 快速开始
按照以下步骤完成服务器的安装与启动:
- 从以下链接克隆代码仓库:
git clone https://github.com/your-username/nostr-server.git - 安装依赖项:
cd nostr-server npm install - 编译代码:
npm run build - 启动服务器:
node dist/index.js
✨ 主要特性
- 对npub格式的本地支持:通过NIP - 19协议实现编码和解码。
- NIP - 57兼容的zap收据检测:带有方向感知(发送/接收/自我)。
- 高级bolt11发票解析:具备金额提取功能。
- 智能缓存系统:优化大量zap数据的性能。
- 总金额计算:针对发送/接收/自我的zap,提供净余额计算。
- 可选NIP - 57验证:确保zap收据的完整性。
- 匿名zap支持:生成闪电发票进行支付。
- 多类型目标支持:包括个人资料、事件(note ID)、以及可替代事件(naddr)。
- 工具调用即建立新连接:每次工具调用都会创建新的中继连接,确保数据可靠性。
📦 安装指南
- 克隆代码仓库:
git clone https://github.com/your-username/nostr-server.git - 进入项目目录并安装依赖:
cd nostr-server npm install - 编译代码:
npm run build - 启动服务器:
node dist/index.js
📚 详细文档
限制说明
- 查询默认设置8秒超时。
- 仅支持hex格式或npub格式的公钥。
- 默认情况下仅使用部分中继服务器。
开发指南
若要对本服务器进行修改或扩展,可按以下步骤操作:
- 编辑项目根目录下的相关文件:
index.ts:主要包含服务器设置和工具注册。zap-tools.ts:实现与zap相关的功能(获取已发送zap、接收zap及所有zap)。nips-tools.ts:实现NIP搜索功能。
- 编译代码:
npm run build - 重启Claude桌面版或Cursor以应用更改。
代码结构
- 核心服务器设置及相关工具位于
index.ts。 - Zap相关功能集中在
zap-tools.ts。 - NIP搜索实现位于
nips-tools.ts。
这种模块化设计使得代码库更易维护,也便于添加新功能。
Scan to contact