跳转到主要内容

Nostr

**状态:**可选内置插件(默认禁用,需配置后启用)。 Nostr 是一种用于社交网络的去中心化协议。该渠道使 OpenClaw 能够通过 NIP-04 接收并回复加密私信(DM)。

内置插件

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

较旧版本/自定义安装

  • 新手引导(openclaw onboard)和 openclaw channels add 仍会从共享渠道目录中显示 Nostr。
  • 如果你的构建不包含内置 Nostr,请手动安装。
openclaw plugins install @openclaw/nostr
使用本地检出版本(开发工作流):
openclaw plugins install --link <path-to-local-nostr-plugin>
安装或启用插件后,请重启 Gateway 网关。

非交互式设置

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

快速设置

  1. 生成一个 Nostr 密钥对(如有需要):
# Using 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']Relay URL(WebSocket)
dmPolicystringpairing私信访问策略
allowFromstring[][]允许的发送者公钥
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: "openclaw@example.com",
        lud16: "openclaw@example.com",
      },
    },
  },
}
说明:
  • 配置文件 URL 必须使用 https://
  • 从 relay 导入时会合并字段,并保留本地覆盖项。

访问控制

私信策略

  • pairing(默认):未知发送者会收到配对码。
  • allowlist:仅 allowFrom 中的公钥可发送私信。
  • open:公开入站私信(要求 allowFrom: ["*"])。
  • disabled:忽略入站私信。
执行说明:
  • 在执行发送者策略和 NIP-04 解密之前,会先验证入站事件签名,因此伪造事件会被尽早拒绝。
  • 配对回复会在不处理原始私信正文的情况下直接发送。
  • 入站私信会进行速率限制,超大负载会在解密前被丢弃。

allowlist 示例

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

密钥格式

接受的格式:
  • 私钥:nsec... 或 64 字符十六进制
  • 公钥(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 个 relay 以实现冗余。
  • 避免使用过多 relay(延迟、重复)。
  • 付费 relay 可提高可靠性。
  • 本地 relay 适合测试(ws://localhost:7777)。

协议支持

NIP状态说明
NIP-01支持基本事件格式 + 配置文件元数据
NIP-04支持加密私信(kind:4
NIP-17计划中Gift-wrapped 私信
NIP-44计划中版本化加密

测试

本地 relay

# Start 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. 向机器人公钥发送私信。
  4. 验证回复。

故障排除

未收到消息

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

未发送回复

  • 检查 relay 是否接受写入。
  • 验证出站连接性。
  • 留意 relay 速率限制。

重复回复

  • 在使用多个 relay 时属于预期行为。
  • 消息会按事件 ID 去重;只有第一次投递会触发回复。

安全

  • 永远不要提交私钥。
  • 使用环境变量存储密钥。
  • 生产机器人建议考虑使用 allowlist
  • 签名会在发送者策略之前完成验证,而发送者策略会在解密前执行,因此伪造事件会被尽早拒绝,未知发送者也无法强制执行完整的加密计算。

限制(MVP)

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

相关内容