nostr-tools 0.24.1 → 1.0.0-alpha

package/.eslintrc.json

@@ -1,5 +1,9 @@
 {
   "root": true,
+
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+
   "parserOptions": {
     "ecmaVersion": 9,
     "ecmaFeatures": {
@@ -14,9 +18,7 @@
     "node": true
   },
 
-  "plugins": [
-    "babel"
-  ],
+  "plugins": ["babel"],
 
   "globals": {
     "document": false,
@@ -33,23 +35,23 @@
 
   "rules": {
     "accessor-pairs": 2,
-    "arrow-spacing": [2, { "before": true, "after": true }],
+    "arrow-spacing": [2, {"before": true, "after": true}],
     "block-spacing": [2, "always"],
-    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
+    "brace-style": [2, "1tbs", {"allowSingleLine": true}],
     "comma-dangle": 0,
-    "comma-spacing": [2, { "before": false, "after": true }],
+    "comma-spacing": [2, {"before": false, "after": true}],
     "comma-style": [2, "last"],
     "constructor-super": 2,
     "curly": [0, "multi-line"],
     "dot-location": [2, "property"],
     "eol-last": 2,
     "eqeqeq": [2, "allow-null"],
-    "generator-star-spacing": [2, { "before": true, "after": true }],
-    "handle-callback-err": [2, "^(err|error)$" ],
+    "generator-star-spacing": [2, {"before": true, "after": true}],
+    "handle-callback-err": [2, "^(err|error)$"],
     "indent": 0,
     "jsx-quotes": [2, "prefer-double"],
-    "key-spacing": [2, { "beforeColon": false, "afterColon": true }],
-    "keyword-spacing": [2, { "before": true, "after": true }],
+    "key-spacing": [2, {"beforeColon": false, "afterColon": true}],
+    "keyword-spacing": [2, {"before": true, "after": true}],
     "new-cap": 0,
     "new-parens": 0,
     "no-array-constructor": 2,
@@ -81,12 +83,12 @@
     "no-irregular-whitespace": 2,
     "no-iterator": 2,
     "no-label-var": 2,
-    "no-labels": [2, { "allowLoop": false, "allowSwitch": false }],
+    "no-labels": [2, {"allowLoop": false, "allowSwitch": false}],
     "no-lone-blocks": 2,
     "no-mixed-spaces-and-tabs": 2,
     "no-multi-spaces": 2,
     "no-multi-str": 2,
-    "no-multiple-empty-lines": [2, { "max": 2 }],
+    "no-multiple-empty-lines": [2, {"max": 2}],
     "no-native-reassign": 2,
     "no-negated-in-lhs": 2,
     "no-new": 0,
@@ -115,23 +117,34 @@
     "no-undef": 2,
     "no-undef-init": 2,
     "no-unexpected-multiline": 2,
-    "no-unneeded-ternary": [2, { "defaultAssignment": false }],
+    "no-unneeded-ternary": [2, {"defaultAssignment": false}],
     "no-unreachable": 2,
-    "no-unused-vars": [2, { "vars": "local", "args": "none", "varsIgnorePattern": "^_"}],
+    "no-unused-vars": [
+      2,
+      {"vars": "local", "args": "none", "varsIgnorePattern": "^_"}
+    ],
     "no-useless-call": 2,
     "no-useless-constructor": 2,
     "no-with": 2,
-    "one-var": [0, { "initialized": "never" }],
-    "operator-linebreak": [2, "after", { "overrides": { "?": "before", ":": "before" } }],
+    "one-var": [0, {"initialized": "never"}],
+    "operator-linebreak": [
+      2,
+      "after",
+      {"overrides": {"?": "before", ":": "before"}}
+    ],
     "padded-blocks": [2, "never"],
-    "quotes": [2, "single", { "avoidEscape": true, "allowTemplateLiterals": true }],
+    "quotes": [
+      2,
+      "single",
+      {"avoidEscape": true, "allowTemplateLiterals": true}
+    ],
     "semi": [2, "never"],
-    "semi-spacing": [2, { "before": false, "after": true }],
+    "semi-spacing": [2, {"before": false, "after": true}],
     "space-before-blocks": [2, "always"],
     "space-before-function-paren": 0,
     "space-in-parens": [2, "never"],
     "space-infix-ops": 2,
-    "space-unary-ops": [2, { "words": true, "nonwords": false }],
+    "space-unary-ops": [2, {"words": true, "nonwords": false}],
     "spaced-comment": 0,
     "template-curly-spacing": [2, "never"],
     "use-isnan": 2,

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,17 @@
+name: publish npm package
+
+on:
+  - tag
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.github/workflows/test.yml

@@ -0,0 +1,15 @@
+name: test every commit
+on:
+  - push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn --ignore-engines
+      - run: node build.cjs
+      - run: yarn test

package/README.md

@@ -4,89 +4,160 @@ Tools for developing [Nostr](https://github.com/fiatjaf/nostr) clients.
 
 ## Usage
 
-```js
-import {relayPool} from 'nostr-tools'
+### Generating a private key and a public key
 
-const pool = relayPool()
+```js
+import { generatePrivateKey, getPublicKey } from 'nostr-tools'
 
-pool.setPrivateKey('<hex>') // optional
+let sk = generatePrivateKey() # `sk` is a hex string
+let pk = getPublicKey(sk) # `pk` is a hex string
+```
 
-pool.addRelay('ws://some.relay.com', {read: true, write: true})
-pool.addRelay('ws://other.relay.cool', {read: true, write: true})
+### Creating, signing and verifying events
 
-// example callback function for a subscription
-function onEvent(event, relay) {
-  console.log(`got an event from ${relay.url} which is already validated.`, event)
+```js
+import {
+  validateEvent,
+  verifySignature,
+  signEvent,
+  getEventHash,
+  getPublicKey
+} from 'nostr-tools'
+
+let event = {
+  kind: 1,
+  created_at: Math.floor(Date.now() / 1000),
+  tags: [],
+  content: 'hello'
 }
 
-// subscribing to a single user
-// author is the user's public key
-pool.sub({cb: onEvent, filter: {author: '<hex>'}})
-
-//  or bulk follow
-pool.sub({cb:(event, relay) => {...}, filter: {authors: ['<hex1>', '<hex2>', ..., '<hexn>']}})
-
-// reuse a subscription channel
-const mySubscription = pool.sub({cb: ..., filter: ....})
-mySubscription.sub({filter: ....})
-mySubscription.sub({cb: ...})
-mySubscription.unsub()
-
-// get specific event
-const specificChannel = pool.sub({
-  cb: (event, relay) => {
-    console.log('got specific event from relay', event, relay)
-    specificChannel.unsub()
-  },
-  filter: {id: '<hex>'}
-})
+event.id = getEventHash(event.id)
+event.pubkey = getPublicKey(privateKey)
+event.sig = await signEvent(event, privateKey)
 
-// or get a specific event plus all the events that reference it in the 'e' tag
-pool.sub({ cb: (event, relay) => { ... }, filter: [{id: '<hex>'}, {'#e': '<hex>'}] })
+let ok = validateEvent(event)
+let veryOk = await verifySignature(event)
+```
 
-// get all events
-pool.sub({cb: (event, relay) => {...}, filter: {}})
+### Interacting with a relay
 
-// get recent events
-pool.sub({cb: (event, relay) => {...}, filter: {since: timestamp}})
+```js
+import {
+  relayInit,
+  generatePrivateKey,
+  getPublicKey,
+  getEventHash,
+  signEvent
+} from 'nostr-tools'
+
+const relay = relayInit('wss://relay.example.com')
+relay.connect()
+
+relay.on('connect', () => {
+  console.log(`connected to ${relay.url}`)
+})
+relay.on('error', () => {
+  console.log(`failed to connect to ${relay.url}`)
+})
 
-// publishing events(inside an async function):
-const ev = await pool.publish(eventObject, (status, url) => {
-  if (status === 0) {
-    console.log(`publish request sent to ${url}`)
+// let's query for an event that exists
+let sub = relay.sub([
+  {
+    ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027']
   }
-  if (status === 1) {
-    console.log(`event published by ${url}`, ev)
+])
+sub.on('event', event => {
+  console.log('we got the event we wanted:', event)
+})
+sub.on('eose', () => {
+  sub.unsub()
+})
+
+// let's publish a new event while simultaneously monitoring the relay for it
+let sk = generatePrivateKey()
+let pk = getPublicKey(sk)
+
+let sub = relay.sub([
+  {
+    kinds: [1],
+    authors: [pk]
   }
+])
+
+sub.on('event', event => {
+  console.log('got event:', event)
+})
+
+let event = {
+  kind: 1,
+  pubkey: pk,
+  created_at: Math.floor(Date.now() / 1000),
+  tags: [],
+  content: 'hello world'
+}
+event.id = getEventHash(event)
+event.sig = await signEvent(event, sk)
+
+let pub = relay.publish(event)
+pub.on('ok', () => {
+  console.log(`{relay.url} has accepted our event`)
+})
+pub.on('seen', () => {
+  console.log(`we saw the event on {relay.url}`)
+})
+pub.on('failed', reason => {
+  console.log(`failed to publish to {relay.url}: ${reason}`)
 })
-// it will be signed automatically with the key supplied above
-// or pass an already signed event to bypass this
 
-// subscribing to a new relay
-pool.addRelay('<url>')
-// will automatically subscribe to the all the events called with .sub above
+await relay.close()
 ```
 
-All functions expect bytearrays as hex strings and output bytearrays as hex strings.
+### Encrypting and decrypting direct messages
 
-For other utils please read the source (for now).
+```js
+import {nip04, getPublicKey, generatePrivateKey} from 'nostr-tools'
+
+// sender
+let sk1 = generatePrivateKey()
+let pk1 = getPublicKey(sk1)
+
+// receiver
+let sk2 = generatePrivateKey()
+let pk2 = getPublicKey(sk2)
+
+// on the sender side
+let message = 'hello'
+let ciphertext = nip04.encrypt(sk1, pk2, 'hello')
+
+let event = {
+  kind: 4,
+  pubkey: pk1,
+  tags: [['p', pk2]],
+  content: ciphertext,
+  ...otherProperties
+}
 
-### Using from the browser (if you don't want to use a bundler)
+sendEvent(event)
 
-You can import nostr-tools as an ES module. Just add a script tag like this:
+// on the receiver side
 
-```html
-<script type="module">
-  import {generatePrivateKey} from 'https://unpkg.com/nostr-tools/nostr.js'
-  console.log(generatePrivateKey())
-</script>
+sub.on('event', (event) => {
+  let sender = event.tags.find(([k, v]) => k === 'p' && && v && v !== '')[1]
+  pk1 === sender
+  let plaintext = nip04.decrypt(sk2, pk1, event.content)
+})
 ```
 
-And import whatever function you would import from `"nostr-tools"` in a bundler.
+Please consult the tests or [the source code](https://github.com/fiatjaf/nostr-tools) for more information that isn't available here.
 
-## TypeScript
+### Using from the browser (if you don't want to use a bundler)
 
-This module has hand-authored TypeScript declarations. `npm run check-ts` will run a lint-check script to ensure the typings can be loaded and call at least a few standard library functions. It's not at all comprehensive and likely to contain bugs. Issues welcome; tag @rcoder as needed.
+```html
+<script src="https://unpkg.com/nostr-tools/standalone/index.js"></script>
+<script>
+  window.NostrTools.generatePrivateKey('...') // and so on
+</script>
+```
 
 ## License
 

package/build.cjs

@@ -2,24 +2,36 @@
 
 const esbuild = require('esbuild')
 const alias = require('esbuild-plugin-alias')
-const nodeGlobals = require('@esbuild-plugins/node-globals-polyfill').default
 
-const buildOptions = {
-  entryPoints: ['index.js'],
-  outfile: 'nostr.js',
+let common = {
+  entryPoints: ['index.ts'],
   bundle: true,
-  format: 'esm',
   plugins: [
     alias({
       stream: require.resolve('readable-stream')
-    }),
-    nodeGlobals({buffer: true})
+    })
   ],
-  define: {
-    window: 'self',
-    global: 'self'
-  },
-  loader: {'.js': 'jsx'}
+  sourcemap: 'external'
 }
 
-esbuild.build(buildOptions).then(() => console.log('build success.'))
+esbuild
+  .build({...common, outdir: 'esm/', format: 'esm', packages: 'external'})
+  .then(() => console.log('esm build success.'))
+
+esbuild
+  .build({...common, outdir: 'cjs/', format: 'cjs', packages: 'external'})
+  .then(() => console.log('cjs build success.'))
+
+esbuild
+  .build({
+    ...common,
+    outdir: 'standalone/',
+    format: 'iife',
+    globalName: 'NostrTools',
+    define: {
+      window: 'self',
+      global: 'self',
+      process: '{"env": {}}'
+    }
+  })
+  .then(() => console.log('standalone build success.'))