跳转到内容
OpenClaw Docs

Nostr

Nostr

Section titled “Nostr”

状态： 可选插件（默认禁用）。

Nostr 是一个去中心化的社交网络协议。此频道使 OpenClaw 能够通过 NIP-04 接收和回复加密的直连消息 (DM)。

安装（按需）

Section titled “安装（按需）”

入门向导（推荐）

Section titled “入门向导（推荐）”
  • 新手引导 (openclaw onboard) 和 openclaw channels add 列出了可选的渠道插件。
  • 选择 Nostr 会提示您按需安装该插件。

安装默认设置：

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

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

手动安装

Section titled “手动安装”
Terminal window
openclaw plugins install @openclaw/nostr

使用本地检出（开发工作流）：

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

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

非交互式设置

Section titled “非交互式设置”
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-env 将 NOSTR_PRIVATE_KEY 保留在环境中，而不是将密钥存储在配置文件中。

快速设置

Section titled “快速设置”
  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(网关)。

配置参考

Section titled “配置参考”
KeyTypeDefaultDescription
privateKeystringrequirednsec 或十六进制格式的私钥
relaysstring[]['wss://relay.damus.io', 'wss://nos.lol']Relay URL (WebSocket)
dmPolicystringpairing私信 访问策略
allowFromstring[][]允许的发送者公钥
enabledbooleantrue启用/禁用渠道
namestring-显示名称
profileobject-NIP-01 个人资料元数据

个人资料元数据

Section titled “个人资料元数据”

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

访问控制

Section titled “访问控制”

私信 策略

Section titled “私信 策略”
  • pairing (默认)：未知发送者会收到配对码。
  • allowlist：只有 allowFrom 中的公钥可以发送私信。
  • open：公开的入站私信 (需要 allowFrom: ["*"])。
  • disabled：忽略入站私信。

执行说明：

  • 发送方策略在签名验证和 NIP-04 解密之前进行检查。
  • 配对回复的发送不处理原始私信内容。
  • 入站私消息已进行速率限制，超大的负载会在解密前被丢弃。

允许列表示例

Section titled “允许列表示例”
{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      dmPolicy: "allowlist",
      allowFrom: ["npub1abc...", "npub1xyz..."],
    },
  },
}

密钥格式

Section titled “密钥格式”

接受的格式：

  • 私钥： nsec... 或 64 字符十六进制
  • 公钥 (allowFrom)： npub... 或十六进制

中继

Section titled “中继”

默认值：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)。

协议支持

Section titled “协议支持”
NIP状态描述
NIP-01支持基本事件格式 + 个人资料元数据
NIP-04支持加密私信 (kind:4)
NIP-17计划中包装的私信
NIP-44计划中版本化加密

测试

Section titled “测试”

本地中继

Section titled “本地中继”
Terminal window
# Start strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry
{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      relays: ["ws://localhost:7777"],
    },
  },
}

手动测试

Section titled “手动测试”
  1. 从日志中记录 bot 公钥 (npub)。
  2. 打开 Nostr 客户端（Damus、Amethyst 等）。
  3. 向 bot 公钥发送私信。
  4. 验证响应。

故障排除

Section titled “故障排除”

未收到消息

Section titled “未收到消息”
  • 验证私钥是否有效。
  • 确保中继 URL 可访问，并使用 wss://（本地使用 ws://）。
  • 确认 enabled 未设置为 false。
  • 检查 Gateway(网关) 日志中是否有中继连接错误。

未发送响应

Section titled “未发送响应”
  • 检查中继是否接受写入。
  • 验证出站连接。
  • 注意中继速率限制。

重复响应

Section titled “重复响应”
  • 使用多个中继时属于预期情况。
  • 消息按事件 ID 去重；只有首次投递会触发响应。

安全性

Section titled “安全性”
  • 切勿提交私钥。
  • 使用环境变量存储密钥。
  • 对于生产环境机器人，请考虑 allowlist。
  • 配对和允许列表策略在解密之前强制执行，因此未知发送者无法强制执行完整的加密工作。

限制（MVP）

Section titled “限制（MVP）”
  • 仅限私信（无群聊）。
  • 无媒体附件。
  • 仅限 NIP-04（计划支持 NIP-17 gift-wrap）。

相关

Section titled “相关”