nostream

nostream

TypeScript 实现的高性能 Nostr 协议中继

nostream 是一个基于 TypeScript 的 Nostr 协议中继实现。该项目支持多种 NIP 规范,包括基本协议流程、加密消息和事件删除。nostream 集成了多个支付处理器,如 ZEBEDEE 和 Nodeless。项目可通过 Docker 或独立模式部署,提供快速启动指南和完整测试套件,适用于生产环境。

nostreamNostr协议中继服务器开源项目TypeScriptGithub

nostream

<p align="center"> <img alt="nostream标志" height="256px" width="256px" src="https://yellow-cdn.veclightyear.com/835a84d5/082d0fe0-1d5f-44ca-b4cc-8f51f9ec59bf.jpg" /> </p> <p align="center"> <a href="https://github.com/Cameri/nostream/releases"> <img alt="GitHub发布" src="https://img.shields.io/github/v/release/Cameri/nostream"> </a> <a href="https://github.com/Cameri/nostream/issues"> <img alt="GitHub问题" src="https://img.shields.io/github/issues/Cameri/nostream?style=plastic" /> </a> <a href="https://github.com/Cameri/nostream/stargazers"> <img alt="GitHub星标" src="https://img.shields.io/github/stars/Cameri/nostream" /> </a> <img alt="GitHub主要语言" src="https://img.shields.io/github/languages/top/Cameri/nostream"> <a href="https://github.com/Cameri/nostream/network"> <img alt="GitHub分支" src="https://img.shields.io/github/forks/Cameri/nostream" /> </a> <a href="https://github.com/Cameri/nostream/blob/main/LICENSE"> <img alt="GitHub许可证" src="https://img.shields.io/github/license/Cameri/nostream" /> </a> <a href='https://coveralls.io/github/Cameri/nostream?branch=main'> <img alt='覆盖率状态' src='https://yellow-cdn.veclightyear.com/835a84d5/098d57da-c9d2-4444-bcc2-fee48e408c0e.svg?branch=main' /> </a> <a href='https://sonarcloud.io/project/overview?id=Cameri_nostr-ts-relay'> <img alt='Sonarcloud质量门' src='https://sonarcloud.io/api/project_badges/measure?project=Cameri_nostr&metric=alert_status' /> </a> <a href='https://github.com/Cameri/nostream/actions'> <img alt='构建状态' src='https://yellow-cdn.veclightyear.com/835a84d5/3c3d5b66-1bb1-4bf2-b6db-2f0ae225490c.svg?branch=main&event=push' /> </a> </p>

这是一个用Typescript编写的nostr中继。

此实现已经可以用于生产环境。请参阅下面的支持功能。

项目主仓库可在GitHub上找到。

在Railway上部署

功能

这里列出了具有中继特定实现的NIPs。

  • NIP-01:基本协议流程描述
  • NIP-02:联系人列表和昵称
  • NIP-04:加密直接消息
  • NIP-09:事件删除
  • NIP-11:中继信息文档
  • NIP-11a:中继信息文档扩展
  • NIP-12:通用标签查询
  • NIP-13:工作量证明
  • NIP-15:存储事件结束通知
  • NIP-16:事件处理
  • NIP-20:命令结果
  • NIP-22:事件created_at限制
  • NIP-26:委托事件签名(已移除)
  • NIP-28:公共聊天
  • NIP-33:参数化可替换事件
  • NIP-40:过期时间戳

要求

独立设置

  • PostgreSQL 14.0
  • Redis
  • Node v18
  • Typescript

Docker设置

  • Docker v20.10
  • Docker Compose v2.10

本地Docker设置

  • Docker Desktop v4.2.0或更新版本
  • mkcert

警告:从Snap、Brew或Debian仓库安装的Docker版本不受支持,会导致错误。 请仅从官方指南安装Docker。

完整指南

接受付款

  1. 开始之前

    • 完成本文档中的一个快速启动指南
    • 创建一个.env文件
    • .nostr/settings.yaml文件中进行以下更改:
      • payments.enabled设置为true
      • payments.feeSchedules.admission.enabled设置为true
      • limits.event.pubkey.minBalance设置为接受事件所需的最小余额(以毫聪为单位)(例如,设置为1000000要求1000聪的余额)
    • 选择以下支付处理器之一:zebedeenodelessopennodelnbitslnurl
  2. ZEBEDEE

    • 完成"开始之前"步骤
    • 注册ZEBEDEE开发者仪表板账户,创建一个新的LIVE项目,并获取该项目的API密钥
    • .env文件中设置ZEBEDEE_API_KEY环境变量,使用上面的API密钥
    ZEBEDEE_API_KEY={在此处输入您的ZEBEDEE_API_KEY}
    
  • 按照所有支付处理器的要求步骤操作
  • .nostr/settings.yaml 文件中进行以下更改:
    • payments.processor 改为 zebedee
    • paymentsProcessors.zebedee.callbackBaseURL 改为匹配你的 Nostream URL (例如 https://{你的域名}/callbacks/zebedee)
  • 重启 Nostream (先执行 ./scripts/stop 然后执行 ./scripts/start)
  • 阅读深入指南以获取更多信息: 使用 ZEBEDEE API 设置付费 Nostr 中继
  1. Nodeless

    • 完成"开始之前"的步骤
    • 注册一个新账户,创建一个新商店并记下商店 ID
    • 前往 Profile > API Tokens 生成一个新的密钥并记下
    • 创建一个商店 webhook,使用你的 Nodeless 回调 URL (例如 https://{你的域名}/callbacks/nodeless),并确保启用所有事件。获取生成的商店 webhook 密钥
    • 设置 NODELESS_API_KEYNODELESS_WEBHOOK_SECRET 环境变量,分别使用生成的 API 密钥和 webhook 密钥
    NODELESS_API_KEY={你的NODELESS_API_KEY}
    NODELESS_WEBHOOK_SECRET={你的NODELESS_WEBHOOK_SECRET}
    
    • 在你的 .nostr/settings.yaml 文件中进行以下更改:
      • payments.processor 设置为 nodeless
      • paymentsProcessors.nodeless.storeId 设置为你的商店 ID
    • 重启 Nostream (执行 ./scripts/stop 然后执行 ./scripts/start)
  2. OpenNode

    • 完成"开始之前"的步骤

    • 注册一个新账户并通过验证

    • 前往 Developers > Integrations 设置两步验证

    • 创建一个具有 Invoices 权限的新 API 密钥

    • 在你的 .env 文件中设置 OPENNODE_API_KEY 环境变量

      OPENNODE_API_KEY={你的OPENNODE_API_KEY}
      
    • 在你的 .nostr/settings.yaml 文件中进行以下更改:

      • payments.processor 设置为 opennode
    • 重启 Nostream (执行 ./scripts/stop 然后执行 ./scripts/start)

  3. LNBITS

    • 完成"开始之前"的步骤

    • 在你的公共 LNbits 实例上创建一个新钱包

      • 不得将演示服务器用于生产环境
      • 你的实例必须可从互联网访问,并拥有有效的 SSL/TLS 证书
    • 获取钱包的 Invoice/read 密钥 (在钱包的 Api docs 部分)

    • 在你的 .env 文件中设置 LNBITS_API_KEY 环境变量,使用上面的 Invoice/read 密钥

      LNBITS_API_KEY={你的LNBITS_API_KEY}
      
    • 在你的 .nostr/settings.yaml 文件中进行以下更改:

      • payments.processor 设置为 lnbits
      • lnbits.baseURL 设置为你的 LNbits 实例 URL (例如 https://{你的LNBITS域名}/)
      • paymentsProcessors.lnbits.callbackBaseURL 设置为匹配你的 Nostream URL (例如 https://{你的域名}/callbacks/lnbits)
    • 重启 Nostream (执行 ./scripts/stop 然后执行 ./scripts/start)

  4. Alby 或任何支持 LNURL-verify 的 LNURL 提供商

    • 完成"开始之前"的步骤
    • 如果你没有 LNURL,创建一个新账户
    • 在你的 .nostr/settings.yaml 文件中进行以下更改:
      • payments.processor 设置为 lnurl
      • lnurl.invoiceURL 设置为你的 LNURL (例如 https://getalby.com/lnurlp/your-username)
    • 重启 Nostream (执行 ./scripts/stop 然后执行 ./scripts/start)
  5. 确保你的公钥需要支付

    • 访问 https://{你的域名}/
    • 你应该看到一个要求支付入场费的表单
    • 填写表单并采取必要步骤支付发票
    • 等待屏幕显示收到付款
    • 将你的中继 URL 添加到你喜欢的 Nostr 客户端 (wss://{你的域名}) 并等待连接
    • 发送几条消息进行测试
    • 前往 https://websocketking.com/ 并连接到你的中继 (wss://{你的域名})
    • 使用密钥转换器将你的 npub 转换为十六进制
    • 发送以下 JSON 消息: ["REQ", "payment-test", {"authors":["你的十六进制公钥"]}]
    • 你应该收到之前发送的几条消息

快速开始 (Docker Compose)

按照官方指南安装 Docker。 如果你使用其他指南安装了 Docker,可能需要先卸载。

克隆仓库并进入目录:

git clone git@github.com:Cameri/nostream.git
cd nostream

生成一个密钥: openssl rand -hex 128 复制输出并粘贴到 .env 文件中:

SECRET=aaabbbccc...dddeeefff
# 密钥为简洁起见已缩短

启动:

./scripts/start

./scripts/start_with_tor

停止服务器:

./scripts/stop

打印 Tor 主机名:

./scripts/print_tor_hostname

作为服务运行

默认情况下,此服务器将持续运行,直到你使用 Ctrl+C 停止它或系统重启。

如果你希望系统重启后服务器自动重新运行,可以安装为 systemd 服务。例如:

$ nano /etc/systemd/system/nostream.service

# 注意: 将 "User=..." 替换为你的用户名,
# "/home/nostr/nostream" 替换为你克隆仓库的目录。

[Unit]
Description=Nostr TS Relay
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=5
User=nostr
WorkingDirectory=/home/nostr/nostream
ExecStart=/home/nostr/nostream/scripts/start
ExecStop=/home/nostr/nostream/scripts/stop

[Install]
WantedBy=multi-user.target

然后:

systemctl enable nostream
systemctl start nostream

可以使用以下命令查看日志:

journalctl -u nostream

快速开始(独立运行)

设置以下环境变量:

DB_URI="postgresql://postgres:postgres@localhost:5432/nostr_ts_relay_test"
DB_USER=postgres

DB_HOST=localhost
DB_PORT=5432
DB_NAME=nostr_ts_relay
DB_USER=postgres
DB_PASSWORD=postgres
REDIS_URI="redis://default:nostr_ts_relay@localhost:6379"

REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_USER=default
REDIS_PASSWORD=nostr_ts_relay

生成一个长的随机密钥并设置 SECRET: 你可以使用 openssl rand -hex 128 来生成密钥。

SECRET=aaabbbccc...dddeeefff
# 密钥为简洁起见已缩短

初始化数据库

创建 nostr_ts_relay 数据库:

$ psql -h $DB_HOST -p $DB_PORT -U $DB_USER -W
postgres=# create database nostr_ts_relay;
postgres=# quit

启动 Redis 并使用 redis-cli 设置默认密码并验证:

$ redis-cli
127.0.0.1:6379> CONFIG SET requirepass "nostr_ts_relay"
OK
127.0.0.1:6379> AUTH nostr_ts_relay
Ok

克隆仓库并进入目录:

git clone git@github.com:Cameri/nostream.git
cd nostream

安装依赖:

npm install -g knex
npm install

运行迁移(至少运行一次,并在拉取新更改后运行):

NODE_OPTIONS="-r dotenv/config" npm run db:migrate

在 nostream 项目文件夹内创建 .nostr 文件夹并复制设置文件:

mkdir .nostr
cp resources/default-settings.yaml .nostr/settings.yaml

以开发模式启动:

npm run dev

或者,以生产模式启动:

npm run start

清理构建、覆盖率和测试报告:

npm run clean

开发快速开始(Docker Compose)

按照官方指南安装 Docker Desktop。 如果你按照其他指南安装了 Docker,可能需要先卸载它。

克隆仓库并进入目录:

git clone git@github.com:Cameri/nostream.git
cd nostream

启动:

./scripts/start_local

这将在终端前台运行,直到你按 Ctrl+C 停止。

测试

单元测试

打开终端并切换到项目目录:

cd /path/to/nostream

运行单元测试:

npm run test:unit

或者,以监视模式运行单元测试:

npm run test:unit:watch

获取单元测试覆盖率:

npm run cover:unit

用浏览器打开 .test-reports/unit/index.html 查看单元测试报告:

open .test-reports/unit/index.html

用浏览器打开 .coverage/unit/lcov-report/index.html 查看单元测试覆盖率报告:

open .coverage/unit/lcov-report/index.html

集成测试(Docker Compose)

打开终端并切换到项目目录:

cd /path/to/nostream

运行集成测试:

npm run docker:test:integration

获取集成测试覆盖率:

npm run docker:cover:integration

集成测试(独立运行)

打开终端并切换到项目目录:

cd /path/to/nostream

设置以下环境变量:

DB_URI="postgresql://postgres:postgres@localhost:5432/nostr_ts_relay_test"

或

DB_HOST=localhost
DB_PORT=5432
DB_NAME=nostr_ts_relay_test
DB_USER=postgres
DB_PASSWORD=postgres
DB_MIN_POOL_SIZE=1
DB_MAX_POOL_SIZE=2

然后运行集成测试:

npm run test:integration

用浏览器打开 .test-reports/integration/report.html 查看集成测试报告:

open .test-reports/integration/report.html

获取集成测试覆盖率:

npm run cover:integration

用浏览器打开 .coverage/integration/lcov-report/index.html 查看集成测试覆盖率报告。

open .coverage/integration/lcov-report/index.html

配置

你可以通过设置 NOSTR_CONFIG_DIR 环境变量来更改默认文件夹。

使用快速开始指南之一运行 nostream 至少一次,nostream/.nostr/settings.json 将被创建。 对设置文件的任何更改将在下次启动时读取。

默认设置可以在 resources/default-settings.yaml 中找到。如果你想在首次运行中继之前就有一个设置文件,可以随意将其复制到 nostream/.nostr/settings.yaml

有关每个环境变量和设置的详细说明,请参阅 CONFIGURATION.md

开发频道

对于开发讨论,请使用 Nostr Typescript Relay 开发群组

对于有关协议的讨论,请随时使用 Nostr Telegram 群组

作者

我在大多数社交网络上的名字是 Cameri。你可以在 Nostr 上通过 npub1qqqqqqyz0la2jjl752yv8h7wgs3v098mh9nztd4nr6gynaef6uqqt0n47m 找到我。

贡献者 (A-Z)

  • Anton Livaja
  • Juan Angel
  • Kevin Smith
  • Saransh Sharma
  • swissrouting
  • André Neves
  • Semisol

许可证

本项目采用 MIT 许可证。

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多