From 88703e9ea2add088191942ee3dbb1c5b6ce41ba0 Mon Sep 17 00:00:00 2001
From: fiatjaf <fiatjaf@gmail.com>
Date: Sun, 17 Dec 2023 22:46:35 -0300
Subject: [PATCH] update readme with new api.

---
 README.md    | 62 ++++++++++++++++++++--------------------------------
 pool.test.ts |  2 +-
 relay.ts     |  2 +-
 3 files changed, 26 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index a452c3b..788b811 100644
--- a/README.md
+++ b/README.md
@@ -48,29 +48,23 @@ let veryOk = verifySignature(event)
 ### Interacting with a relay
 
 ```js
-import { relayInit, finishEvent, generatePrivateKey, getPublicKey } from 'nostr-tools'
+import { relayConnect, finishEvent, generatePrivateKey, getPublicKey } from 'nostr-tools'
 
-const relay = relayInit('wss://relay.example.com')
-relay.on('connect', () => {
-  console.log(`connected to ${relay.url}`)
-})
-relay.on('error', () => {
-  console.log(`failed to connect to ${relay.url}`)
-})
-
-await relay.connect()
+const relay = await relayConnect('wss://relay.example.com')
+console.log(`connected to ${relay.url}`)
 
 // let's query for an event that exists
-let sub = relay.sub([
+const sub = relay.subscribe([
   {
     ids: ['d7dd5eb3ab747e16f8d0212d53032ea2a7cadef53837e5a6c66d42849fcb9027'],
   },
-])
-sub.on('event', event => {
-  console.log('we got the event we wanted:', event)
-})
-sub.on('eose', () => {
-  sub.unsub()
+], {
+  onevent(event) {
+    console.log('we got the event we wanted:', event)
+  },
+  oneose() {
+    sub.close()
+  }
 })
 
 // let's publish a new event while simultaneously monitoring the relay for it
@@ -122,41 +116,33 @@ const pool = new SimplePool()
 
 let relays = ['wss://relay.example.com', 'wss://relay.example2.com']
 
-let sub = pool.sub(
+let h = pool.subscribeMany(
   [...relays, 'wss://relay.example3.com'],
   [
     {
       authors: ['32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'],
     },
   ],
+  {
+    onevent(event) {
+      // this will only be called once the first time the event is received
+      // ...
+    },
+    oneose() {
+      h.close()
+    }
+  }
 )
 
-sub.on('event', event => {
-  // this will only be called once the first time the event is received
-  // ...
-})
+await Promise.any(pool.publish(relays, newEvent))
+console.log('published to at least one relay!')
 
-let pubs = pool.publish(relays, newEvent)
-await Promise.all(pubs)
-
-let events = await pool.list(relays, [{ kinds: [0, 1] }])
+let events = await pool.querySync(relays, [{ kinds: [0, 1] }])
 let event = await pool.get(relays, {
   ids: ['44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'],
 })
-
-let batchedEvents = await pool.batchedList('notes', relays, [{ kinds: [1] }])
-// `batchedList` will wait for other function calls with the same `batchKey`
-// (e.g. 'notes', 'authors', etc) within a fixed amount of time (default: `100ms`) before sending
-// next ws request, and batch all requests with similar `batchKey`s together in a single request.
-
-let relaysForEvent = pool.seenOn('44e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245')
-// relaysForEvent will be an array of URLs from relays a given event was seen on
-
-pool.close()
 ```
 
-read more details about `batchedList` on this pr: [https://github.com/nbd-wtf/nostr-tools/pull/279](https://github.com/nbd-wtf/nostr-tools/pull/279#issue-1859315757)
-
 ### Parsing references (mentions) from a content using NIP-10 and NIP-27
 
 ```js
diff --git a/pool.test.ts b/pool.test.ts
index 1e89462..0f592c2 100644
--- a/pool.test.ts
+++ b/pool.test.ts
@@ -73,7 +73,7 @@ test('same with double querying', async () => {
   expect(received).toHaveLength(2)
 })
 
-test('list()', async () => {
+test('querySync()', async () => {
   let events = await pool.querySync([...relays, 'wss://offchain.pub', 'wss://eden.nostr.land'], {
     authors: ['3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d'],
     kinds: [1],
diff --git a/relay.ts b/relay.ts
index b18ac26..e06b319 100644
--- a/relay.ts
+++ b/relay.ts
@@ -235,7 +235,7 @@ export class Relay {
     return ret
   }
 
-  public async subscribe(filters: Filter[], params: Partial<SubscriptionParams>) {
+  public async subscribe(filters: Filter[], params: Partial<SubscriptionParams>): Promise<Subscription> {
     await this.connect()
     this.serial++
     const id = params.id || 'sub:' + this.serial