Nostr

状态: 可选插件(默认禁用)。

Nostr 是一个用于社交网络的去中心化协议(decentralized protocol)。此频道使 OpenClaw 能够通过 NIP-04 接收和响应加密的直接消息(DMs)。

按需安装

入门(推荐)

  • 入门向导(openclaw onboard)和 openclaw channels add 列出可选的频道插件。
  • 选择 Nostr 会提示您按需安装插件。

安装默认值:

  • 开发频道 + git 检出可用: 使用本地插件路径。
  • 稳定版/测试版: 从 npm 下载。

您始终可以在提示中覆盖选择。

手动安装

openclaw plugins install @openclaw/nostr

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

openclaw plugins install --link <path-to-openclaw>/extensions/nostr

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

快速设置

  1. 生成 Nostr 密钥对(如果需要):
# 使用 nak
nak key generate
  1. 添加到配置:
{
  "channels": {
    "nostr": {
      "privateKey": "${NOSTR_PRIVATE_KEY}"
    }
  }
}
  1. 导出密钥:
export NOSTR_PRIVATE_KEY="nsec1..."
  1. 重启网关(Gateway)。

配置参考

类型默认值描述
privateKeystring必需nsec 或十六进制格式的私钥
relaysstring[]['wss://relay.damus.io', 'wss://nos.lol']中继 URL(WebSocket)
dmPolicystringpairing直接消息(DM)访问策略
allowFromstring[][]允许的发送者公钥(pubkeys)
enabledbooleantrue启用/禁用频道
namestring-显示名称
profileobject-NIP-01 个人资料元数据

个人资料元数据

个人资料数据作为 NIP-01 kind:0 事件发布。您可以从控制 UI(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://
  • 从中继导入会合并字段并保留本地覆盖。

访问控制

直接消息(DM)策略

  • pairing(默认):未知发送者获得配对码(pairing code)。
  • allowlist:仅 allowFrom 中的公钥可以发送直接消息。
  • open:公开入站直接消息(需要 allowFrom: ["*"])。
  • disabled:忽略入站直接消息。

允许列表示例

{
  "channels": {
    "nostr": {
      "privateKey": "${NOSTR_PRIVATE_KEY}",
      "dmPolicy": "allowlist",
      "allowFrom": ["npub1abc...", "npub1xyz..."]
    }
  }
}

密钥格式

接受的格式:

  • 私钥(Private key): nsec... 或 64 字符十六进制
  • 公钥(Pubkeys,allowFrom): npub... 或十六进制

中继(Relays)

默认值: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计划中Gift-wrapped 直接消息
NIP-44计划中版本化加密

测试

本地中继

# 启动 strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry
{
  "channels": {
    "nostr": {
      "privateKey": "${NOSTR_PRIVATE_KEY}",
      "relays": ["ws://localhost:7777"]
    }
  }
}

手动测试

  1. 从日志中记录机器人公钥(npub)。
  2. 打开 Nostr 客户端(Damus、Amethyst 等)。
  3. 向机器人公钥发送直接消息(DM)。
  4. 验证响应。

故障排除

未接收消息

  • 验证私钥有效。
  • 确保中继 URL 可访问并使用 wss://(或本地使用 ws://)。
  • 确认 enabled 不是 false
  • 检查网关日志中的中继连接错误。

未发送响应

  • 检查中继是否接受写入。
  • 验证出站连接。
  • 注意中继速率限制。

重复响应

  • 使用多个中继时预期会出现。
  • 消息通过事件 ID 去重;仅第一次交付触发响应。

安全

  • 切勿提交私钥。
  • 使用环境变量存储密钥。
  • 生产环境机器人考虑使用 allowlist

限制(MVP)

  • 仅直接消息(无群组聊天)。
  • 无媒体附件。
  • 仅 NIP-04(NIP-17 gift-wrap 计划中)。