hypercore 10.6.1 → 10.8.0

package/README.md

@@ -116,7 +116,8 @@ const blockLocal = await core.get(44, { wait: false })
   wait: true, // wait for block to be downloaded
   onwait: () => {}, // hook that is called if the get is waiting for download
   timeout: 0, // wait at max some milliseconds (0 means no timeout)
-  valueEncoding: 'json' | 'utf-8' | 'binary' // defaults to the core's valueEncoding
+  valueEncoding: 'json' | 'utf-8' | 'binary', // defaults to the core's valueEncoding
+  decrypt: true // automatically decrypts the block if encrypted
 }
 ```
 
@@ -124,10 +125,9 @@ const blockLocal = await core.get(44, { wait: false })
 
 Check if the core has all blocks between `start` and `end`.
 
-#### `const updated = await core.update()`
+#### `const updated = await core.update([options])`
 
-Wait for the core to try and find a signed update to its length.
-Does not download any data from peers except for a proof of the new core length.
+Waits for initial proof of the new core length until all `findingPeers` calls has finished.
 
 ``` js
 const updated = await core.update()
@@ -135,7 +135,17 @@ const updated = await core.update()
 console.log('core was updated?', updated, 'length is', core.length)
 ```
 
-#### `const [index, relativeOffset] = await core.seek(byteOffset)`
+`options` include:
+
+``` js
+{
+  wait: false
+}
+```
+
+Use `core.findingPeers()` or `{ wait: true }` to make `await core.update()` blocking.
+
+#### `const [index, relativeOffset] = await core.seek(byteOffset, [options])`
 
 Seek to a byte offset.
 
@@ -150,6 +160,13 @@ const second = await core.seek(3) // returns [1, 0]
 const third = await core.seek(5) // returns [2, 1]
 ```
 
+``` js
+{
+  wait: true, // wait for data to be downloaded
+  timeout: 0 // wait at max some milliseconds (0 means no timeout)
+}
+```
+
 #### `const stream = core.createReadStream([options])`
 
 Make a read stream to read a range of data out at once.
@@ -282,7 +299,7 @@ Fully close this core.
 
 #### `core.on('close')`
 
-Emitted when then core has been fully closed.
+Emitted when the core has been fully closed.
 
 #### `await core.ready()`
 

package/index.js

@@ -73,6 +73,7 @@ module.exports = class Hypercore extends EventEmitter {
     this.autoClose = !!opts.autoClose
     this.onwait = opts.onwait || null
     this.wait = opts.wait !== false
+    this.timeout = opts.timeout || 0
 
     this.closing = null
     this.opening = this._openSession(key, storage, opts)
@@ -200,12 +201,14 @@ module.exports = class Hypercore extends EventEmitter {
     const sparse = opts.sparse === false ? false : this.sparse
     const wait = opts.wait === false ? false : this.wait
     const onwait = opts.onwait === undefined ? this.onwait : opts.onwait
+    const timeout = opts.timeout === undefined ? this.timeout : opts.timeout
     const Clz = opts.class || Hypercore
     const s = new Clz(this.storage, this.key, {
       ...opts,
       sparse,
       wait,
       onwait,
+      timeout,
       _opening: this.opening,
       _sessions: this.sessions
     })
@@ -646,7 +649,7 @@ module.exports = class Hypercore extends EventEmitter {
       return this._updateSnapshot()
     }
 
-    const remoteWait = typeof (opts && opts.wait) === 'boolean' ? opts.wait : this.replicator.findingPeers > 0
+    const remoteWait = this._shouldWait(opts, this.replicator.findingPeers > 0)
 
     let upgraded = false
 
@@ -676,9 +679,14 @@ module.exports = class Hypercore extends EventEmitter {
 
     if (this.closing !== null) throw SESSION_CLOSED()
 
+    if (!this._shouldWait(opts, this.wait)) return null
+
     const activeRequests = (opts && opts.activeRequests) || this.activeRequests
     const req = this.replicator.addSeek(activeRequests, s)
 
+    const timeout = opts && opts.timeout !== undefined ? opts.timeout : this.timeout
+    if (timeout) req.context.setTimeout(req, timeout)
+
     return req.promise
   }
 
@@ -706,7 +714,7 @@ module.exports = class Hypercore extends EventEmitter {
     let block = await req
     if (!block) return null
 
-    if (this.encryption) {
+    if (this.encryption && (!opts || opts.decrypt !== false)) {
       // Copy the block as it might be shared with other sessions.
       block = b4a.from(block)
 
@@ -738,8 +746,8 @@ module.exports = class Hypercore extends EventEmitter {
 
       if (this.cache) this.cache.set(index, block)
     } else {
-      if (opts && opts.wait === false) return null
-      if (this.wait === false && (!opts || !opts.wait)) return null
+      if (!this._shouldWait(opts, this.wait)) return null
+
       if (opts && opts.onwait) opts.onwait(index, this)
       if (this.onwait) this.onwait(index, this)
 
@@ -747,6 +755,9 @@ module.exports = class Hypercore extends EventEmitter {
 
       const req = this.replicator.addBlock(activeRequests, index)
 
+      const timeout = opts && opts.timeout !== undefined ? opts.timeout : this.timeout
+      if (timeout) req.context.setTimeout(req, timeout)
+
       block = this._cacheOnResolve(index, req.promise, this.core.tree.fork)
     }
 
@@ -763,6 +774,14 @@ module.exports = class Hypercore extends EventEmitter {
     return block
   }
 
+  _shouldWait (opts, defaultValue) {
+    if (opts) {
+      if (opts.wait === false) return false
+      if (opts.wait === true) return true
+    }
+    return defaultValue
+  }
+
   createReadStream (opts) {
     return new ReadStream(this, opts)
   }

package/lib/errors.js

@@ -52,6 +52,10 @@ module.exports = class HypercoreError extends Error {
     return new HypercoreError(msg, 'REQUEST_CANCELLED', HypercoreError.REQUEST_CANCELLED)
   }
 
+  static REQUEST_TIMEOUT (msg = 'Request timed out') {
+    return new HypercoreError(msg, 'REQUEST_TIMEOUT', HypercoreError.REQUEST_TIMEOUT)
+  }
+
   static SESSION_NOT_WRITABLE (msg = 'Session is not writable') {
     return new HypercoreError(msg, 'SESSION_NOT_WRITABLE', HypercoreError.SESSION_NOT_WRITABLE)
   }

package/lib/replicator.js

@@ -2,7 +2,7 @@ const b4a = require('b4a')
 const safetyCatch = require('safety-catch')
 const RandomIterator = require('random-array-iterator')
 const RemoteBitfield = require('./remote-bitfield')
-const { REQUEST_CANCELLED, INVALID_CAPABILITY, SNAPSHOT_NOT_AVAILABLE } = require('./errors')
+const { REQUEST_CANCELLED, REQUEST_TIMEOUT, INVALID_CAPABILITY, SNAPSHOT_NOT_AVAILABLE } = require('./errors')
 const m = require('./messages')
 const caps = require('./caps')
 
@@ -24,7 +24,8 @@ class Attachable {
       snapshot: true,
       resolve: null,
       reject: null,
-      promise: null
+      promise: null,
+      timeout: null
     }
 
     r.sindex = session.push(r) - 1
@@ -54,6 +55,7 @@ class Attachable {
     if (r.rindex < this.refs.length) this.refs[rh.rindex = r.rindex] = rh
     if (r.sindex < r.session.length) r.session[sh.sindex = r.sindex] = sh
 
+    destroyRequestTimeout(r)
     r.context = null
 
     return r
@@ -84,6 +86,11 @@ class Attachable {
       this._detach(this.refs[this.refs.length - 1]).reject(err)
     }
   }
+
+  setTimeout (r, ms) {
+    destroyRequestTimeout(r)
+    r.timeout = setTimeout(onrequesttimeout, ms, r)
+  }
 }
 
 class BlockRequest extends Attachable {
@@ -1684,6 +1691,17 @@ function clampRange (core, r) {
   }
 }
 
+function onrequesttimeout (req) {
+  if (req.context) req.context.detach(req, REQUEST_TIMEOUT())
+}
+
+function destroyRequestTimeout (req) {
+  if (req.timeout !== null) {
+    clearTimeout(req.timeout)
+    req.timeout = null
+  }
+}
+
 function onwireopen (m, c) {
   return c.userData.onopen(m)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore",
-  "version": "10.6.1",
+  "version": "10.8.0",
   "description": "Hypercore is a secure, distributed append-only log",
   "main": "index.js",
   "scripts": {