Nostr

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

Nostr 是一个去中心化的社交网络协议。这个 Channel 让 OpenClaw 可以通过 NIP-04 接收和回复加密的 DM。

安装(按需)

引导向导(推荐)

  • 引导向导(openclaw onboard)和 openclaw channels add 会列出可选的 Channel Plugin。
  • 选择 Nostr 后会提示你按需安装 Plugin。

安装默认规则:

  • Dev channel + 有 git checkout: 使用本地 Plugin 路径。
  • Stable/Beta: 从 npm 下载。

你可以在提示中随时覆盖这个选择。

手动安装

openclaw plugins install @openclaw/nostr

使用本地代码(开发工作流):

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

安装或启用 Plugin 后需要重启 Gateway。

快速设置

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

配置参考

配置项类型默认值说明
privateKeystring必填私钥,支持 nsec 或 hex 格式
relaysstring[]['wss://relay.damus.io', 'wss://nos.lol']Relay 地址(WebSocket)
dmPolicystringpairingDM 访问策略
allowFromstring[][]允许的发送者公钥列表
enabledbooleantrue启用/禁用 Channel
namestring-显示名称
profileobject-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://
  • 从 relay 导入时会合并字段并保留本地覆盖的设置。

访问控制

DM 策略

  • pairing(默认): 未知发送者会收到 Pairing 码。
  • allowlist: 只有 allowFrom 中的公钥可以发 DM。
  • open: 公开接收 DM(需要设置 allowFrom: ["*"])。
  • disabled: 忽略所有入站 DM。

Allowlist 示例

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

密钥格式

支持的格式:

  • 私钥: nsec... 或 64 字符 hex
  • 公钥(allowFrom): npub... 或 hex

Relay 配置

默认使用: relay.damus.ionos.lol

{
  "channels": {
    "nostr": {
      "privateKey": "${NOSTR_PRIVATE_KEY}",
      "relays": ["wss://relay.damus.io", "wss://relay.primal.net", "wss://nostr.wine"]
    }
  }
}

提示:

  • 使用 2-3 个 relay 来保证冗余。
  • 避免配置太多 relay(会增加延迟和重复消息)。
  • 付费 relay 可以提高可靠性。
  • 测试时可以用本地 relay(ws://localhost:7777)。

协议支持

NIP状态说明
NIP-01已支持基础事件格式 + 个人资料元数据
NIP-04已支持加密 DM(kind:4)
NIP-17计划中Gift-wrapped DM
NIP-44计划中版本化加密

测试

本地 relay

# 启动 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. 验证是否收到回复。

故障排除

收不到消息

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

发不出回复

  • 检查 relay 是否接受写入。
  • 验证出站连接是否正常。
  • 注意 relay 的速率限制。

重复回复

  • 使用多个 relay 时这是正常现象。
  • 消息会通过事件 ID 去重,只有第一次收到时才会触发回复。

安全

  • 永远不要提交私钥到代码仓库。
  • 使用环境变量存储密钥。
  • 生产环境建议使用 allowlist 策略。

限制(MVP 版本)

  • 仅支持 DM(不支持群聊)。
  • 不支持媒体附件。
  • 仅支持 NIP-04(NIP-17 gift-wrap 计划中)。