> ## Documentation Index
> Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Nostr

Nostr 是一个可下载的通道插件（`@openclaw/nostr`），它允许 OpenClaw 通过 Nostr 中继接收并回复 NIP-04 加密的私信。每个网关仅对应一个账户；仅支持私信。

## 安装

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw plugins install @openclaw/nostr
```

使用不带版本号的包规范以跟随当前官方发布标签。仅在需要可复现安装时才固定到精确版本。

从本地检出安装（开发工作流）：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw plugins install --link <path-to-local-nostr-plugin>
```

安装或启用插件后重启网关。安装插件后，引导流程（`openclaw onboard`）和 `openclaw channels add` 会从共享渠道目录中显示 Nostr。

### 非交互式设置

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
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 密钥对（如需要）：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
# 使用 nak
nak key generate
```

2. 添加到配置中：

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
    },
  },
}
```

3. 导出密钥：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
export NOSTR_PRIVATE_KEY="nsec1..."
```

4. 重启网关。

## 配置参考

| Key          | Type      | Default                                     | Description                          |
| ------------ | --------- | ------------------------------------------- | ------------------------------------ |
| `privateKey` | string    | required                                    | 私钥，格式为 `nsec` 或 hex；允许使用 secret refs |
| `relays`     | string\[] | `['wss://relay.damus.io', 'wss://nos.lol']` | 中继 URL（WebSocket）                    |
| `dmPolicy`   | string    | `pairing`                                   | DM 访问策略                              |
| `allowFrom`  | string\[] | `[]`                                        | 允许的发送者 pubkey                        |
| `enabled`    | boolean   | `true`                                      | 启用/禁用通道                              |
| `name`       | string    | -                                           | 显示名称                                 |
| `profile`    | object    | -                                           | NIP-01 资料元数据                         |

## 个人资料元数据

个人资料数据会作为 NIP-01 `kind:0` 事件发布。你可以通过 Control UI（Channels -> Nostr -> Profile）进行管理，也可以直接在配置中设置。

示例：

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      profile: {
        name: "openclaw",
        displayName: "OpenClaw",
        about: "个人助手 DM 机器人",
        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://`。
* 从中继导入会合并字段并保留本地覆盖项。

## 访问控制

### DM 策略

* **pairing**（默认）：未知发送方会收到一个配对码。
* **allowlist**：只有 `allowFrom` 中的 pubkey 才能发送 DM。
* **open**：公开入站 DM（需要 `allowFrom: ["*"]`）。
* **disabled**：忽略入站 DM。

执行说明：

* 入站事件签名会在发送方策略和 NIP-04 解密之前进行验证，因此伪造事件会被尽早拒绝。
* 配对回复会在不解密或处理原始 DM 内容的情况下发送。
* 入站 DM 会进行速率限制（全局和按发送方），并且超大载荷会在解密前被丢弃。

### 允许列表示例

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      dmPolicy: "allowlist",
      allowFrom: ["npub1abc...", "npub1xyz..."],
    },
  },
}
```

## 密钥格式

支持的格式：

* **私钥：** `nsec...` 或 64 字符 hex
* **公钥（`allowFrom`）：** `npub...` 或 hex

## 中继

默认值：`relay.damus.io` 和 `nos.lol`。

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  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 | Supported | 基本事件格式 + 个人资料元数据 |
| NIP-04 | Supported | 加密 DM（`kind:4`）  |
| NIP-17 | Planned   | 礼物包装 DM          |
| NIP-44 | Planned   | 版本化加密            |

## 测试

### 本地中继

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
# 启动 strfry
docker run -p 7777:7777 ghcr.io/hoytech/strfry
```

```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
{
  channels: {
    nostr: {
      privateKey: "${NOSTR_PRIVATE_KEY}",
      relays: ["ws://localhost:7777"],
    },
  },
}
```

### 手动测试

1. 记下网关日志中的机器人公钥，或通过 `openclaw channels status` 查看（hex；如果需要，请在你的客户端中将其转换为 npub）。
2. 打开一个 Nostr 客户端（Amethyst、Damus 等）。
3. 向机器人公钥发送私信。
4. 验证响应。

## 故障排除

### 未收到消息

* 验证私钥是否有效。
* 确保中继 URL 可访问，并使用 `wss://`（本地环境使用 `ws://`）。
* 确认 `enabled` 不是 `false`。
* 检查网关日志中是否有中继连接错误。

### 未发送响应

* 检查中继是否接受写入。
* 验证出站连接是否正常。
* 留意中继的速率限制。

### 重复响应

* 在使用多个中继时这是预期行为。
* 消息会按事件 ID 去重；只有第一次投递会触发响应。

## 安全

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

## 限制（MVP）

* 仅支持直接消息（不支持群聊）。
* 不支持媒体附件。
* 仅支持 NIP-04（NIP-17 礼物包装计划中）。

## 相关内容

* [通道概览](/channels) — 所有受支持的通道
* [配对](/channels/pairing) — DM 身份验证和配对流程
* [群组](/channels/groups) — 群聊行为和提及门控
* [通道路由](/channels/channel-routing) — 消息的会话路由
* [安全性](/gateway/security) — 访问模型和加固