Nostr
状态: 可选插件(默认禁用)。
Nostr 是一个去中心化的社交网络协议。此渠道使 CoderClaw 能够通过 NIP-04 接收和回复加密私信(DMs)。
安装(按需)
Section titled “安装(按需)”新手引导(推荐)
Section titled “新手引导(推荐)”- 新手引导向导(
coderclaw onboard)和coderclaw channels add会列出可选的渠道插件。 - 选择 Nostr 会提示你按需安装插件。
安装默认值:
- Dev 渠道 + git checkout 可用: 使用本地插件路径。
- Stable/Beta: 从 npm 下载。
你可以随时在提示中覆盖选择。
coderclaw plugins install @coderclaw/nostr使用本地 checkout(开发工作流):
coderclaw plugins install --link <path-to-coderclaw>/extensions/nostr安装或启用插件后重启 Gateway 网关。
- 生成 Nostr 密钥对(如需要):
# 使用 naknak key generate- 添加到配置:
{ "channels": { "nostr": { "privateKey": "${NOSTR_PRIVATE_KEY}" } }}- 导出密钥:
export NOSTR_PRIVATE_KEY="nsec1..."- 重启 Gateway 网关。
| 键 | 类型 | 默认值 | 描述 |
|---|---|---|---|
privateKey | string | 必填 | nsec 或十六进制格式的私钥 |
relays | string[] | ['wss://relay.damus.io', 'wss://nos.lol'] | 中继 URL(WebSocket) |
dmPolicy | string | pairing | 私信访问策略 |
allowFrom | string[] | [] | 允许的发送者公钥 |
enabled | boolean | true | 启用/禁用渠道 |
name | string | - | 显示名称 |
profile | object | - | NIP-01 个人资料元数据 |
个人资料元数据
Section titled “个人资料元数据”个人资料数据作为 NIP-01 kind:0 事件发布。你可以从控制界面(Channels -> Nostr -> Profile)管理它,或直接在配置中设置。
示例:
{ "channels": { "nostr": { "privateKey": "${NOSTR_PRIVATE_KEY}", "profile": { "name": "coderclaw", "displayName": "CoderClaw", "about": "Personal assistant DM bot", "picture": "https://example.com/avatar.png", "banner": "https://example.com/banner.png", "website": "https://example.com", } } }}注意事项:
- 个人资料 URL 必须使用
https://。 - 从中继导入会合并字段并保留本地覆盖。
- pairing(默认):未知发送者会收到配对码。
- allowlist:只有
allowFrom中的公钥可以发送私信。 - open:公开接收私信(需要
allowFrom: ["*"])。 - disabled:忽略接收的私信。
允许列表示例
Section titled “允许列表示例”{ "channels": { "nostr": { "privateKey": "${NOSTR_PRIVATE_KEY}", "dmPolicy": "allowlist", "allowFrom": ["npub1abc...", "npub1xyz..."] } }}接受的格式:
- 私钥:
nsec...或 64 字符十六进制 - 公钥(
allowFrom):npub...或十六进制
默认值: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)。
| NIP | 状态 | 描述 |
|---|---|---|
| NIP-01 | 已支持 | 基本事件格式 + 个人资料元数据 |
| NIP-04 | 已支持 | 加密私信(kind:4) |
| NIP-17 | 计划中 | 礼物包装私信 |
| NIP-44 | 计划中 | 版本化加密 |
# 启动 strfrydocker run -p 7777:7777 ghcr.io/hoytech/strfry{ "channels": { "nostr": { "privateKey": "${NOSTR_PRIVATE_KEY}", "relays": ["ws://localhost:7777"] } }}- 从日志中记下机器人公钥(npub)。
- 打开 Nostr 客户端(Damus、Amethyst 等)。
- 向机器人公钥发送私信。
- 验证响应。
- 验证私钥是否有效。
- 确保中继 URL 可访问并使用
wss://(本地使用ws://)。 - 确认
enabled不是false。 - 检查 Gateway 网关日志中的中继连接错误。
- 检查中继是否接受写入。
- 验证出站连接。
- 注意中继速率限制。
- 使用多个中继时属于正常现象。
- 消息按事件 ID 去重;只有首次投递会触发响应。
- 切勿提交私钥。
- 使用环境变量存储密钥。
- 生产环境机器人考虑使用
allowlist。
限制(MVP)
Section titled “限制(MVP)”- 仅支持私信(不支持群聊)。
- 不支持媒体附件。
- 仅支持 NIP-04(计划支持 NIP-17 礼物包装)。