libp2r2p 0.10.3 → 0.10.4

package/README.md

@@ -278,6 +278,12 @@ NIP-44 v2 uses the interoperable `nip44-v2` salt by default. A custom UTF-8
 salt of at most 32 bytes may be passed to `getConversationKey()`, but messages
 derived with it are not interoperable with standard NIP-44 implementations.
 
+NIP-46 clients and bunker signers use a 30-second operation timeout by
+default. Set `timeout` in the `Nip46Client`/`BunkerSigner` constructor to
+choose another default, override it for an individual `connect()` or RPC, or
+pass `timeout: null` explicitly when an operation is intentionally allowed to
+wait indefinitely.
+
 Nostr Web Tokens are available from `libp2r2p/nwt`. Creation returns a signed
 kind `27519` event, while transport encoding is kept separate:
 

package/nip46/services/client.js

@@ -129,7 +129,9 @@ export class Nip46Client {
   get pointer () { return { ...this.#pointer, relays: [...this.#pointer.relays] } }
 
   // Connects and immediately asks the remote signer for its preferred relays.
-  async connect ({ requestedPermissions = [], clientMetadata, timeout = null, signal } = {}) {
+  // An omitted timeout inherits the configurable constructor timeout; null
+  // explicitly disables the response deadline.
+  async connect ({ requestedPermissions = [], clientMetadata, timeout, signal } = {}) {
     const permissions = Array.isArray(requestedPermissions)
       ? requestedPermissions.filter(permission => typeof permission === 'string' && permission).join(',')
       : ''

package/nip46/services/transport.js

@@ -59,7 +59,7 @@ export class Nip46Transport {
   #secretKey
   #pubkey
   #relayPool
-  #networkTimeout
+  #operationTimeout
   #timeoutAfterFirstEose
   #onError
   #contexts = new Set()
@@ -80,7 +80,7 @@ export class Nip46Transport {
     this.#secretKey = secretKey
     this.#pubkey = getPublicKey(secretKey)
     this.#relayPool = relayPool
-    this.#networkTimeout = networkTimeout
+    this.#operationTimeout = networkTimeout
     this.#timeoutAfterFirstEose = timeoutAfterFirstEose
     this.#onError = onError
   }
@@ -111,7 +111,7 @@ export class Nip46Transport {
     return context
   }
 
-  async awaitContextReady (context, { timeout = this.#networkTimeout, signal } = {}) {
+  async awaitContextReady (context, { timeout = this.#operationTimeout, signal } = {}) {
     const report = await waitForNip46(context.stream.ready, {
       timeout,
       signal,
@@ -159,11 +159,14 @@ export class Nip46Transport {
     return true
   }
 
-  async sendRequest (peerPubkey, method, params = [], {
-    timeout = null,
-    signal,
-    extension
-  } = {}) {
+  async sendRequest (peerPubkey, method, params = [], options = {}) {
+    const {
+      // Undefined inherits the constructor-wide operation timeout. Passing
+      // null explicitly is the opt-out for RPCs that may wait indefinitely.
+      timeout = this.#operationTimeout,
+      signal,
+      extension
+    } = options
     if (this.#closed) throw new Error('NIP46_CLOSED')
     if (typeof method !== 'string' || !method) throw new ValidationError('NIP46_METHOD_REQUIRED')
     if (!Array.isArray(params) || !params.every(param => typeof param === 'string')) {
@@ -229,7 +232,7 @@ export class Nip46Transport {
     if (!relays.length) throw new Error('NIP46_NO_READY_RELAYS')
     const event = createNip46Event({ secretKey: this.#secretKey, recipientPubkey: peerPubkey, payload })
     const published = await this.#relayPool.sendEvent(event, relays, {
-      timeout: this.#networkTimeout,
+      timeout: this.#operationTimeout,
       timeoutUntilFirstFulfillment: null
     })
     if (!published.success) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2r2p",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "Peer-to-relay-to-peer",
   "keywords": [
     "p2r2p",