Nostr
状态: 可选插件(默认禁用)。
Nostr 是一个去中心化社交网络协议。此频道使 OpenClaw 能够通过 NIP-04 接收和回复加密私信(DM)。
安装(按需)
引导安装(推荐)
- 引导向导(
openclaw onboard)和openclaw channels add会列出可选频道插件。 - 选择 Nostr 时会提示按需安装该插件。
安装默认行为:
- 开发频道 + Git 仓库可用: 使用本地插件路径。
- 稳定版/Beta 版: 从 npm 下载。
你始终可以在提示中覆盖选择。
手动安装
openclaw plugins install @openclaw/nostr
使用本地代码(开发工作流):
openclaw plugins install --link <path-to-openclaw>/extensions/nostr
安装或启用插件后请重启 Gateway。
快速开始
- 生成 Nostr 密钥对(如需要):
# 使用 nak
nak key generate
- 添加到配置:
{
"channels": {
"nostr": {
"privateKey": "${NOSTR_PRIVATE_KEY}"
}
}
}
- 导出密钥:
export NOSTR_PRIVATE_KEY="nsec1..."
- 重启 Gateway。
配置参考
| 键 | 类型 | 默认值 | 说明 |
|---|---|---|---|
privateKey | string | 必填 | nsec 或十六进制格式的私钥 |
relays | string[] | ['wss://relay.damus.io', 'wss://nos.lol'] | 中继 URL(WebSocket) |
dmPolicy | string | pairing | 私信访问策略 |
allowFrom | string[] | [] | 允许的发送者公钥 |
enabled | boolean | true | 启用/禁用频道 |
name | string | - | 显示名称 |
profile | object | - | NIP-01 个人资料元数据 |
个人资料元数据
个人资料数据以 NIP-01 kind:0 事件发布。你可以在控制界面(Channels -> Nostr -> Profile)中管理,也可以直接在配置中设置。
示例:
{
"channels": {
"nostr": {
"privateKey": "${NOSTR_PRIVATE_KEY}",
"profile": {
"name": "openclaw",
"displayName": "OpenClaw",
"about": "Personal assistant DM bot",
"picture": "https://example.com/avatar.png",
"banner": "https://example.com/banner.png",
"website": "https://example.com",
"nip05": "[email protected]",
"lud16": "[email protected]"
}
}
}
}
注意事项:
- 个人资料 URL 必须使用
https://。 - 从中继导入时会合并字段并保留本地覆盖。
访问控制
私信策略
- pairing(默认):未知发送者收到配对码。
- allowlist:只有
allowFrom中的公钥可以私信。 - open:开放入站私信(需要
allowFrom: ["*"])。 - disabled:忽略入站私信。
白名单示例
{
"channels": {
"nostr": {
"privateKey": "${NOSTR_PRIVATE_KEY}",
"dmPolicy": "allowlist",
"allowFrom": ["npub1abc...", "npub1xyz..."]
}
}
}
密钥格式
支持的格式:
- 私钥:
nsec...或 64 字符十六进制 - 公钥(
allowFrom):npub...或十六进制
中继
默认中继:relay.damus.io 和 nos.lol。
{
"channels": {
"nostr": {
"privateKey": "${NOSTR_PRIVATE_KEY}",
"relays": ["wss://relay.damus.io", "wss://relay.primal.net", "wss://nostr.wine"]
}
}
}
建议:
- 使用 2-3 个中继以确保冗余。
- 避免使用过多中继(会增加延迟和重复)。
- 付费中继可以提高可靠性。
- 本地中继适合测试(
ws://localhost:7777)。
协议支持
| NIP | 状态 | 说明 |
|---|---|---|
| NIP-01 | 已支持 | 基本事件格式 + 个人资料元数据 |
| NIP-04 | 已支持 | 加密私信(kind:4) |
| NIP-17 | 计划中 | Gift-wrapped 私信 |
| NIP-44 | 计划中 | 版本化加密 |
测试
本地中继
# 启动 strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry
{
"channels": {
"nostr": {
"privateKey": "${NOSTR_PRIVATE_KEY}",
"relays": ["ws://localhost:7777"]
}
}
}
手动测试
- 在日志中查看机器人公钥(npub)。
- 打开 Nostr 客户端(Damus、Amethyst 等)。
- 私信机器人公钥。
- 确认收到回复。
故障排查
收不到消息
- 确认私钥有效。
- 确保中继 URL 可达并使用
wss://(本地可用ws://)。 - 确认
enabled不为false。 - 检查 Gateway 日志中的中继连接错误。
不发送回复
- 检查中继是否接受写入。
- 确认出站网络连通性。
- 注意中继速率限制。
收到重复回复
- 使用多个中继时属于正常现象。
- 消息通过事件 ID 去重;只有首次到达的消息会触发响应。
安全
- 切勿提交私钥到代码仓库。
- 使用环境变量存储密钥。
- 生产环境的机器人建议使用
allowlist模式。
限制(MVP)
- 仅支持私信(不支持群聊)。
- 不支持媒体附件。
- 目前仅支持 NIP-04(NIP-17 gift-wrap 计划中)。