跳转到内容

Nostr

状态: 可选的捆绑插件(在配置前默认禁用)。

Nostr 是一个用于社交网络的去中心化协议。此渠道使 OpenClaw 能够通过 NIP-04 接收并回复加密私信(私信)。

当前的 OpenClaw 版本将 Nostr 作为捆绑插件提供,因此普通的打包版本不需要单独安装。

  • 新手引导(openclaw onboard)和 openclaw channels add 仍然会从共享渠道目录中展示 Nostr。
  • 如果您的构建排除了捆绑的 Nostr,请直接安装 npm 包。
Terminal window
openclaw plugins install @openclaw/nostr

使用基础包以遵循当前官方发布标签。仅在需要可重现的安装时固定确切版本。

使用本地检出版本(开发工作流):

Terminal window
openclaw plugins install --link <path-to-local-nostr-plugin>

安装或启用插件后,请重启 Gateway(网关)。

Terminal window
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-envNOSTR_PRIVATE_KEY 保留在环境中,而不是将密钥存储在配置中。

  1. 生成 Nostr 密钥对(如果需要):
Terminal window
# Using nak
nak key generate
  1. 添加到配置:
{
channels: {
nostr: {
privateKey: "${NOSTR_PRIVATE_KEY}",
},
},
}
  1. 导出密钥:
Terminal window
export NOSTR_PRIVATE_KEY="nsec1..."
  1. 重启 Gateway(网关)。
类型默认值描述
privateKeystring必填nsec 或十六进制格式的私钥
relaysstring[]['wss://relay.damus.io', 'wss://nos.lol']中继 URL (WebSocket)
dmPolicystringpairing私信访问策略
allowFromstring[][]允许的发送者公钥
enabledbooleantrue启用/禁用渠道
namestring-显示名称
profileobject-NIP-01 个人资料元数据

个人资料数据作为 NIP-01 kind:0 事件发布。您可以从控制 UI(渠道 -> Nostr -> 个人资料)管理它,或直接在配置中设置。

示例:

{
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",
},
},
},
}

注意:

  • 个人资料 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.ionos.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计划中版本化加密
Terminal window
# Start strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry
{
channels: {
nostr: {
privateKey: "${NOSTR_PRIVATE_KEY}",
relays: ["ws://localhost:7777"],
},
},
}
  1. 从日志中记录 bot 公钥 (npub)。
  2. 打开 Nostr 客户端(Damus、Amethyst 等)。
  3. 向 bot 公钥发送私信。
  4. 验证响应。
  • 验证私钥是否有效。
  • 确保中继 URL 可达并使用 wss://(本地使用 ws://)。
  • 确认 enabled 不是 false
  • 检查 Gateway(网关) 日志中的中继连接错误。
  • 检查中继是否接受写入。
  • 验证出站连接。
  • 留意中继速率限制。
  • 使用多个中继时属于预期情况。
  • 消息按事件 ID 去重;仅首次投递会触发响应。
  • 切勿提交私钥。
  • 密钥请使用环境变量。
  • 生产环境的 bot 请考虑使用 allowlist
  • 签名会在发送者策略之前进行验证,发送者策略会在解密之前执行,因此伪造的事件会被尽早拒绝,未知发送者无法强制进行完整的加密运算。
  • 仅支持私信(不支持群聊)。
  • 不支持媒体附件。
  • 仅支持 NIP-04(计划支持 NIP-17 gift-wrap)。