Nostr
Nostr 是一个可下载的频道插件(@openclaw/nostr),可让 OpenClaw 通过 Nostr 中继接收并回复 NIP-04 加密私信。每个网关一个账户;仅限私信。
安装¶
使用裸包规范以跟随当前官方发布标签。仅在需要可复现安装时固定确切版本。
从本地检出(开发工作流):
安装或启用插件会将其应用到正在运行的 Gateway;请检查应用结果。一旦插件安装完成,Onboarding(openclaw onboard)和 openclaw channels add 会从共享频道目录中显示 Nostr。
非交互式设置¶
openclaw channels add --channel nostr --private-key "$NOSTR_PRIVATE_KEY"
openclaw channels add --channel nostr --private-key "$NOSTR_PRIVATE_KEY" --relay-urls "wss://relay.damus.io,wss://relay.primal.net"
使用 --use-env 可将 NOSTR_PRIVATE_KEY 保留在环境变量中,而不是将密钥存储在配置中(仅限默认账户)。
快速设置¶
- 生成 Nostr 密钥对(如需要):
- 添加到配置:
- 导出密钥:
- 重启网关。
配置参考¶
| 键 | 类型 | 默认值 | 描述 |
|---|---|---|---|
privateKey |
string | required | 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: "openclaw@example.com",
lud16: "openclaw@example.com",
},
},
},
}
说明:
- 个人资料 URL 必须使用
https://。 - 从中继导入时会合并字段,并保留本地覆盖。
访问控制¶
私信策略¶
- pairing(默认):未知发送者会收到配对码。
- allowlist:只有
allowFrom中的公钥可以发送私信。 - open:公开入站私信(需要
allowFrom: ["*"])。 - disabled:忽略入站私信。
执行说明:
- 入站事件签名会在发送者策略和 NIP-04 解密之前验证,因此伪造事件会被尽早拒绝。
- 配对回复会在不解密或处理原始私信正文的情况下发送。
- 入站私信会进行速率限制(全局和按发送者),超大负载会在解密前丢弃。
允许列表示例¶
{
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 | 计划中 | 礼物包装私信 |
| NIP-44 | 计划中 | 版本化加密 |
测试¶
本地中继¶
手动测试¶
- 从网关日志或
openclaw channels status中记录机器人公钥(十六进制;如需要可在客户端转换为 npub)。 - 打开一个 Nostr 客户端(Amethyst、Damus 等)。
- 向机器人公钥发送私信。
- 验证响应。
故障排除¶
未收到消息¶
- 验证私钥是否有效。
- 确保中继 URL 可访问,并使用
wss://(本地使用ws://)。 - 确认
enabled不是false。 - 检查网关日志中的中继连接错误。
未发送响应¶
- 检查中继是否接受写入。
- 验证出站连接。
- 留意中继速率限制。
重复响应¶
- 使用多个中继时会出现此情况。
- 消息按事件 ID 去重;只有首次投递会触发响应。
安全¶
- 切勿提交私钥。
- 使用环境变量存储密钥。
- 对于生产环境机器人,考虑使用
allowlist。 - 签名会在发件人策略之前验证,发件人策略会在解密之前执行,因此伪造事件会被尽早拒绝,未知发件人无法强制执行完整加密工作。
限制(MVP)¶
- 仅支持直接消息(不支持群聊)。
- 不支持媒体附件。
- 仅支持 NIP-04(计划支持 NIP-17 gift-wrap)。
相关¶
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw