nostr-tools

nostr-tools

为Nostr客户端开发提供全面支持的工具集

nostr-tools是一个轻量级的Nostr客户端开发工具集。它提供密钥管理、事件处理和中继通信等核心功能,适用于浏览器和Node.js环境。该工具集支持多项Nostr改进提案(NIP),并能同时与多个中继交互。通过提供这些基础组件,nostr-tools帮助开发者更高效地构建Nostr应用。

Nostr区块链加密密钥生成事件验证Github开源项目

nostr-tools

用于开发 Nostr 客户端的工具。

仅依赖 @scure@noble 包。

本包仅提供低级功能。如果你需要更高级的功能,可以查看 Nostrify,或者如果你想要一个易于使用的全面解决方案,能够抽象出 Nostr 的复杂部分并为你做出决策,可以查看 NDK@snort/system

安装

npm install nostr-tools # 或 yarn add nostr-tools

如果使用 TypeScript,本包要求 TypeScript 版本 >= 5.0。

使用方法

生成私钥和公钥

import { generateSecretKey, getPublicKey } from 'nostr-tools/pure' let sk = generateSecretKey() // `sk` 是一个 Uint8Array let pk = getPublicKey(sk) // `pk` 是一个十六进制字符串

要获取十六进制格式的私钥,可以使用

import { bytesToHex, hexToBytes } from '@noble/hashes/utils' // 已经是安装的依赖 let skHex = bytesToHex(sk) let backToBytes = hexToBytes(skHex)

创建、签名和验证事件

import { finalizeEvent, verifyEvent } from 'nostr-tools/pure' let event = finalizeEvent({ kind: 1, created_at: Math.floor(Date.now() / 1000), tags: [], content: 'hello', }, sk) let isGood = verifyEvent(event)

与中继交互

import { finalizeEvent, generateSecretKey, getPublicKey } from 'nostr-tools/pure' import { Relay } from 'nostr-tools/relay' const relay = await Relay.connect('wss://relay.example.com') console.log(`已连接到 ${relay.url}`) // 让我们查询一个存在的事件 const sub = relay.subscribe([ { ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027'], }, ], { onevent(event) { console.log('我们得到了想要的事件:', event) }, oneose() { sub.close() } }) // 让我们发布一个新事件,同时监控中继以获取它 let sk = generateSecretKey() let pk = getPublicKey(sk) relay.subscribe([ { kinds: [1], authors: [pk], }, ], { onevent(event) { console.log('收到事件:', event) } }) let eventTemplate = { kind: 1, created_at: Math.floor(Date.now() / 1000), tags: [], content: 'hello world', } // 这会在一个步骤中分配公钥、计算事件 ID 并签名事件 const signedEvent = finalizeEvent(eventTemplate, sk) await relay.publish(signedEvent) relay.close()

要在 Node.js 上使用此功能,你首先必须安装 ws 并调用类似以下的代码:

import { useWebSocketImplementation } from 'nostr-tools/pool' // 或者如果你直接使用 Relay,可以使用 import { useWebSocketImplementation } from 'nostr-tools/relay' import WebSocket from 'ws' useWebSocketImplementation(WebSocket)

与多个中继交互

import { SimplePool } from 'nostr-tools/pool' const pool = new SimplePool() let relays = ['wss://relay.example.com', 'wss://relay.example2.com'] let h = pool.subscribeMany( [...relays, 'wss://relay.example3.com'], [ { authors: ['32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'], }, ], { onevent(event) { // 这只会在第一次接收到事件时被调用一次 // ... }, oneose() { h.close() } } ) await Promise.any(pool.publish(relays, newEvent)) console.log('至少发布到了一个中继!') let events = await pool.querySync(relays, { kinds: [0, 1] }) let event = await pool.get(relays, { ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'], })

使用 NIP-10 和 NIP-27 从内容中解析引用(提及)

import { parseReferences } from 'nostr-tools/references' let references = parseReferences(event) let simpleAugmentedContent = event.content for (let i = 0; i < references.length; i++) { let { text, profile, event, address } = references[i] let augmentedReference = profile ? `<strong>@${profilesCache[profile.pubkey].name}</strong>` : event ? `<em>${eventsCache[event.id].content.slice(0, 5)}</em>` : address ? `<a href="${text}">[链接]</a>` : text simpleAugmentedContent.replaceAll(text, augmentedReference) }

从 NIP-05 地址查询配置文件数据

import { queryProfile } from 'nostr-tools/nip05' let profile = await queryProfile('jb55.com') console.log(profile.pubkey) // 输出:32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245 console.log(profile.relays) // 输出:[wss://relay.damus.io]

要在 Node.js < v18 上使用此功能,你首先必须安装 node-fetch@2 并调用类似以下的代码:

import { useFetchImplementation } from 'nostr-tools/nip05' useFetchImplementation(require('node-fetch'))

包含 NIP-07 类型

import type { WindowNostr } from 'nostr-tools/nip07' declare global { interface Window { nostr?: WindowNostr; } }

生成 NIP-06 密钥

import { privateKeyFromSeedWords, accountFromSeedWords, extendedKeysFromSeedWords, accountFromExtendedKey } from 'nostr-tools/nip06' const mnemonic = 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong' const passphrase = '123' // 可选 const accountIndex = 0 const sk0 = privateKeyFromSeedWords(mnemonic, passphrase, accountIndex) const { privateKey: sk1, publicKey: pk1 } = accountFromSeedWords(mnemonic, passphrase, accountIndex) const extendedAccountIndex = 0 const { privateExtendedKey, publicExtendedKey } = extendedKeysFromSeedWords(mnemonic, passphrase, extendedAccountIndex) const { privateKey: sk2, publicKey: pk2 } = accountFromExtendedKey(privateExtendedKey) const { publicKey: pk3 } = accountFromExtendedKey(publicExtendedKey)

编码和解码 NIP-19 代码

import { generateSecretKey, getPublicKey } from 'nostr-tools/pure' import * as nip19 from 'nostr-tools/nip19' 让 sk = generateSecretKey() 让 nsec = nip19.nsecEncode(sk) { type, data } = nip19.decode(nsec) 断言(type === 'nsec') 断言(data === sk) 让 pk = getPublicKey(generateSecretKey()) 让 npub = nip19.npubEncode(pk) { type, data } = nip19.decode(npub) 断言(type === 'npub') 断言(data === pk) 让 pk = getPublicKey(generateSecretKey()) 让 relays = ['wss://relay.nostr.example.mydomain.example.com', 'wss://nostr.banana.com'] 让 nprofile = nip19.nprofileEncode({ pubkey: pk, relays }) { type, data } = nip19.decode(nprofile) 断言(type === 'nprofile') 断言(data.pubkey === pk) 断言(data.relays.length === 2)

nostr-wasm 一起使用

nostr-wasm 是一个薄包装器,包装了编译为 WASM 的 libsecp256k1,仅用于哈希、签名和验证 Nostr 事件。

import { setNostrWasm, generateSecretKey, finalizeEvent, verifyEvent } from 'nostr-tools/wasm' import { initNostrWasm } from 'nostr-wasm' // 确保在应用开始调用 finalizeEvent 或 verifyEvent 之前这个 promise 已解决 initNostrWasm().then(setNostrWasm) // 或使用 'nostr-wasm/gzipped' 甚至 'nostr-wasm/headless', // 查看 https://www.npmjs.com/package/nostr-wasm 了解选项

如果你要使用 RelaySimplePool,你还必须导入 nostr-tools/abstract-relay 和/或 nostr-tools/abstract-pool 而不是默认值,然后通过传递 verifyEvent 来实例化它们:

import { setNostrWasm, verifyEvent } from 'nostr-tools/wasm' import { AbstractRelay } from 'nostr-tools/abstract-relay' import { AbstractSimplePool } from 'nostr-tools/abstract-pool' import { initNostrWasm } from 'nostr-wasm' initNostrWasm().then(setNostrWasm) const relay = AbstractRelay.connect('wss://relayable.org', { verifyEvent }) const pool = new AbstractSimplePool({ verifyEvent })

这可能比默认使用的纯 JS noble 库nostr-tools/pure 更快。基准测试:

benchmark      time (avg)             (min … max)       p75       p99      p995
------------------------------------------------- -----------------------------
• relay read message and verify event (many events)
------------------------------------------------- -----------------------------
wasm        34.94 ms/iter   (34.61 ms … 35.73 ms)  35.07 ms  35.73 ms  35.73 ms
pure js     239.7 ms/iter (235.41 ms … 243.69 ms) 240.51 ms 243.69 ms 243.69 ms
trusted    402.71 µs/iter   (344.57 µs … 2.98 ms) 407.39 µs 745.62 µs 812.59 µs

summary for relay read message and verify event
  wasm
   86.77x slower than trusted
   6.86x faster than pure js

从浏览器使用(如果你不想使用打包工具)

<script src="https://unpkg.com/nostr-tools/lib/nostr.bundle.js"></script> <script> window.NostrTools.generateSecretKey('...') // 等等 </script>

管道

要开发 nostr-tools,安装 just 并运行 just -l 查看可用的命令。

许可证

这是免费且不受限制的软件,发布到公共领域。通过向本项目提交补丁,你同意将此软件的任何和所有版权利益贡献给公共领域。

为此存储库做贡献

使用 NIP-34 将你的补丁发送到:

naddr1qq9kummnw3ez6ar0dak8xqg5waehxw309aex2mrp0yhxummnw3ezucn8qyt8wumn8ghj7un9d3shjtnwdaehgu3wvfskueqpzemhxue69uhhyetvv9ujuurjd9kkzmpwdejhgq3q80cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsxpqqqpmejdv00jq

编辑推荐精选

蛙蛙写作

蛙蛙写作

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 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多