mirror of
https://github.com/nbd-wtf/nostr-tools.git
synced 2026-02-01 06:48:51 +00:00
Compare commits
4 Commits
b40f59af74
...
v2.22.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b3d314643a | ||
|
|
30ac8a02c2 | ||
|
|
42c9c7554d | ||
|
|
3588d30044 |
43
README.md
43
README.md
@@ -1,4 +1,4 @@
|
||||
#  [](https://jsr.io/@nostr/tools) nostr-tools
|
||||
# [](https://jsr.io/@nostr/tools) @nostr/tools
|
||||
|
||||
Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
|
||||
|
||||
@@ -9,9 +9,6 @@ This package is only providing lower-level functionality. If you want higher-lev
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm install --save nostr-tools
|
||||
|
||||
# jsr
|
||||
npx jsr add @nostr/tools
|
||||
```
|
||||
@@ -27,7 +24,7 @@ https://jsr.io/@nostr/tools/doc
|
||||
### Generating a private key and a public key
|
||||
|
||||
```js
|
||||
import { generateSecretKey, getPublicKey } from 'nostr-tools/pure'
|
||||
import { generateSecretKey, getPublicKey } from '@nostr/tools/pure'
|
||||
|
||||
let sk = generateSecretKey() // `sk` is a Uint8Array
|
||||
let pk = getPublicKey(sk) // `pk` is a hex string
|
||||
@@ -36,7 +33,7 @@ let pk = getPublicKey(sk) // `pk` is a hex string
|
||||
To get the secret key in hex format, use
|
||||
|
||||
```js
|
||||
import { bytesToHex, hexToBytes } from '@noble/hashes/utils' // already an installed dependency
|
||||
import { bytesToHex, hexToBytes } from '@noble/hashes/utils.js' // already an installed dependency
|
||||
|
||||
let skHex = bytesToHex(sk)
|
||||
let backToBytes = hexToBytes(skHex)
|
||||
@@ -45,7 +42,7 @@ let backToBytes = hexToBytes(skHex)
|
||||
### Creating, signing and verifying events
|
||||
|
||||
```js
|
||||
import { finalizeEvent, verifyEvent } from 'nostr-tools/pure'
|
||||
import { finalizeEvent, verifyEvent } from '@nostr/tools/pure'
|
||||
|
||||
let event = finalizeEvent({
|
||||
kind: 1,
|
||||
@@ -62,8 +59,8 @@ let isGood = verifyEvent(event)
|
||||
Doesn't matter what you do, you always should be using a `SimplePool`:
|
||||
|
||||
```js
|
||||
import { finalizeEvent, generateSecretKey, getPublicKey } from 'nostr-tools/pure'
|
||||
import { SimplePool } from 'nostr-tools/pool'
|
||||
import { finalizeEvent, generateSecretKey, getPublicKey } from '@nostr/tools/pure'
|
||||
import { SimplePool } from '@nostr/tools/pool'
|
||||
|
||||
const pool = new SimplePool()
|
||||
|
||||
@@ -126,8 +123,8 @@ relay.close()
|
||||
To use this on Node.js you first must install `ws` and call something like this:
|
||||
|
||||
```js
|
||||
import { useWebSocketImplementation } from 'nostr-tools/pool'
|
||||
// or import { useWebSocketImplementation } from 'nostr-tools/relay' if you're using the Relay directly
|
||||
import { useWebSocketImplementation } from '@nostr/tools/pool'
|
||||
// or import { useWebSocketImplementation } from '@nostr/tools/relay' if you're using the Relay directly
|
||||
|
||||
import WebSocket from 'ws'
|
||||
useWebSocketImplementation(WebSocket)
|
||||
@@ -138,7 +135,7 @@ useWebSocketImplementation(WebSocket)
|
||||
You can enable regular pings of connected relays with the `enablePing` option. This will set up a heartbeat that closes the websocket if it doesn't receive a response in time. Some platforms, like Node.js, don't report websocket disconnections due to network issues, and enabling this can increase the reliability of the `onclose` event.
|
||||
|
||||
```js
|
||||
import { SimplePool } from 'nostr-tools/pool'
|
||||
import { SimplePool } from '@nostr/tools/pool'
|
||||
|
||||
const pool = new SimplePool({ enablePing: true })
|
||||
```
|
||||
@@ -148,7 +145,7 @@ const pool = new SimplePool({ enablePing: true })
|
||||
You can also enable automatic reconnection with the `enableReconnect` option. This will make the pool try to reconnect to relays with an exponential backoff delay if the connection is lost unexpectedly.
|
||||
|
||||
```js
|
||||
import { SimplePool } from 'nostr-tools/pool'
|
||||
import { SimplePool } from '@nostr/tools/pool'
|
||||
|
||||
const pool = new SimplePool({ enableReconnect: true })
|
||||
```
|
||||
@@ -331,7 +328,7 @@ for (let profile of refs.profiles) {
|
||||
### Querying profile data from a NIP-05 address
|
||||
|
||||
```js
|
||||
import { queryProfile } from 'nostr-tools/nip05'
|
||||
import { queryProfile } from '@nostr/tools/nip05'
|
||||
|
||||
let profile = await queryProfile('jb55.com')
|
||||
console.log(profile.pubkey)
|
||||
@@ -343,13 +340,13 @@ console.log(profile.relays)
|
||||
To use this on Node.js < v18, you first must install `node-fetch@2` and call something like this:
|
||||
|
||||
```js
|
||||
import { useFetchImplementation } from 'nostr-tools/nip05'
|
||||
import { useFetchImplementation } from '@nostr/tools/nip05'
|
||||
useFetchImplementation(require('node-fetch'))
|
||||
```
|
||||
|
||||
### Including NIP-07 types
|
||||
```js
|
||||
import type { WindowNostr } from 'nostr-tools/nip07'
|
||||
import type { WindowNostr } from '@nostr/tools/nip07'
|
||||
|
||||
declare global {
|
||||
interface Window {
|
||||
@@ -361,8 +358,8 @@ declare global {
|
||||
### Encoding and decoding NIP-19 codes
|
||||
|
||||
```js
|
||||
import { generateSecretKey, getPublicKey } from 'nostr-tools/pure'
|
||||
import * as nip19 from 'nostr-tools/nip19'
|
||||
import { generateSecretKey, getPublicKey } from '@nostr/tools/pure'
|
||||
import * as nip19 from '@nostr/tools/nip19'
|
||||
|
||||
let sk = generateSecretKey()
|
||||
let nsec = nip19.nsecEncode(sk)
|
||||
@@ -390,7 +387,7 @@ assert(data.relays.length === 2)
|
||||
[`nostr-wasm`](https://github.com/fiatjaf/nostr-wasm) is a thin wrapper over [libsecp256k1](https://github.com/bitcoin-core/secp256k1) compiled to WASM just for hashing, signing and verifying Nostr events.
|
||||
|
||||
```js
|
||||
import { setNostrWasm, generateSecretKey, finalizeEvent, verifyEvent } from 'nostr-tools/wasm'
|
||||
import { setNostrWasm, generateSecretKey, finalizeEvent, verifyEvent } from '@nostr/tools/wasm'
|
||||
import { initNostrWasm } from 'nostr-wasm'
|
||||
|
||||
// make sure this promise resolves before your app starts calling finalizeEvent or verifyEvent
|
||||
@@ -403,9 +400,9 @@ initNostrWasm().then(setNostrWasm)
|
||||
If you're going to use `Relay` and `SimplePool` you must also import `nostr-tools/abstract-relay` and/or `nostr-tools/abstract-pool` instead of the defaults and then instantiate them by passing the `verifyEvent`:
|
||||
|
||||
```js
|
||||
import { setNostrWasm, verifyEvent } from 'nostr-tools/wasm'
|
||||
import { AbstractRelay } from 'nostr-tools/abstract-relay'
|
||||
import { AbstractSimplePool } from 'nostr-tools/abstract-pool'
|
||||
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)
|
||||
@@ -442,7 +439,7 @@ summary for relay read message and verify event
|
||||
|
||||
## Plumbing
|
||||
|
||||
To develop `nostr-tools`, install [`just`](https://just.systems/) and run `just -l` to see commands available.
|
||||
To develop `@nostr/tools`, install [`just`](https://just.systems/) and run `just -l` to see commands available.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
2
jsr.json
2
jsr.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@nostr/tools",
|
||||
"version": "2.20.0",
|
||||
"version": "2.22.0",
|
||||
"exports": {
|
||||
".": "./index.ts",
|
||||
"./core": "./core.ts",
|
||||
|
||||
4
nip04.ts
4
nip04.ts
@@ -1,6 +1,6 @@
|
||||
import { bytesToHex, hexToBytes, randomBytes } from '@noble/hashes/utils.js'
|
||||
import { hexToBytes, randomBytes } from '@noble/hashes/utils.js'
|
||||
import { secp256k1 } from '@noble/curves/secp256k1.js'
|
||||
import { cbc } from '@noble/ciphers/aes'
|
||||
import { cbc } from '@noble/ciphers/aes.js'
|
||||
import { base64 } from '@scure/base'
|
||||
|
||||
import { utf8Decoder, utf8Encoder } from './utils.ts'
|
||||
|
||||
2
nip06.ts
2
nip06.ts
@@ -1,5 +1,5 @@
|
||||
import { bytesToHex } from '@noble/hashes/utils.js'
|
||||
import { wordlist } from '@scure/bip39/wordlists/english'
|
||||
import { wordlist } from '@scure/bip39/wordlists/english.js'
|
||||
import { generateMnemonic, mnemonicToSeedSync, validateMnemonic } from '@scure/bip39'
|
||||
import { HDKey } from '@scure/bip32'
|
||||
|
||||
|
||||
2
nip19.ts
2
nip19.ts
@@ -110,7 +110,7 @@ export function decode(nip19: NPub): DecodedNpub
|
||||
export function decode(nip19: Note): DecodedNote
|
||||
export function decode(code: string): DecodedResult
|
||||
export function decode(code: string): DecodedResult {
|
||||
let { prefix, words } = bech32.decode(code, Bech32MaxSize)
|
||||
let { prefix, words } = bech32.decode(code as `${string}1${string}`, Bech32MaxSize)
|
||||
let data = new Uint8Array(bech32.fromWords(words))
|
||||
|
||||
switch (prefix) {
|
||||
|
||||
4
nip44.ts
4
nip44.ts
@@ -1,5 +1,5 @@
|
||||
import { chacha20 } from '@noble/ciphers/chacha'
|
||||
import { equalBytes } from '@noble/ciphers/utils'
|
||||
import { chacha20 } from '@noble/ciphers/chacha.js'
|
||||
import { equalBytes } from '@noble/ciphers/utils.js'
|
||||
import { secp256k1 } from '@noble/curves/secp256k1.js'
|
||||
import { extract as hkdf_extract, expand as hkdf_expand } from '@noble/hashes/hkdf.js'
|
||||
import { hmac } from '@noble/hashes/hmac.js'
|
||||
|
||||
6
nip49.ts
6
nip49.ts
@@ -1,8 +1,8 @@
|
||||
import { bech32 } from '@scure/base'
|
||||
import { scrypt } from '@noble/hashes/scrypt.js'
|
||||
import { xchacha20poly1305 } from '@noble/ciphers/chacha'
|
||||
import { xchacha20poly1305 } from '@noble/ciphers/chacha.js'
|
||||
import { concatBytes, randomBytes } from '@noble/hashes/utils.js'
|
||||
import { Bech32MaxSize, Ncryptsec, encodeBytes } from './nip19.ts'
|
||||
import { bech32 } from '@scure/base'
|
||||
|
||||
export function encrypt(
|
||||
sec: Uint8Array,
|
||||
@@ -22,7 +22,7 @@ export function encrypt(
|
||||
}
|
||||
|
||||
export function decrypt(ncryptsec: string, password: string): Uint8Array {
|
||||
let { prefix, words } = bech32.decode(ncryptsec, Bech32MaxSize)
|
||||
let { prefix, words } = bech32.decode(ncryptsec as `${string}1${string}`, Bech32MaxSize)
|
||||
if (prefix !== 'ncryptsec') {
|
||||
throw new Error(`invalid prefix ${prefix}, expected 'ncryptsec'`)
|
||||
}
|
||||
|
||||
2
nip77.ts
2
nip77.ts
@@ -1,4 +1,4 @@
|
||||
import { bytesToHex, hexToBytes } from '@noble/ciphers/utils'
|
||||
import { bytesToHex, hexToBytes } from '@noble/hashes/utils.js'
|
||||
import { Filter } from './filter.ts'
|
||||
import { AbstractRelay, Subscription } from './relay.ts'
|
||||
import { sha256 } from '@noble/hashes/sha2.js'
|
||||
|
||||
14
package.json
14
package.json
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"type": "module",
|
||||
"name": "nostr-tools",
|
||||
"version": "2.20.0",
|
||||
"version": "2.22.0",
|
||||
"description": "Tools for making a Nostr client.",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -236,12 +236,12 @@
|
||||
},
|
||||
"license": "Unlicense",
|
||||
"dependencies": {
|
||||
"@noble/ciphers": "^0.5.1",
|
||||
"@noble/curves": "^2.0.1",
|
||||
"@noble/hashes": "^2.0.1",
|
||||
"@scure/base": "1.1.1",
|
||||
"@scure/bip32": "1.3.1",
|
||||
"@scure/bip39": "1.2.1",
|
||||
"@noble/ciphers": "2.1.1",
|
||||
"@noble/curves": "2.0.1",
|
||||
"@noble/hashes": "2.0.1",
|
||||
"@scure/base": "2.0.0",
|
||||
"@scure/bip32": "2.0.1",
|
||||
"@scure/bip39": "2.0.1",
|
||||
"nostr-wasm": "0.1.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
|
||||
Reference in New Issue
Block a user