hypercore 10.5.3 → 10.6.0

package/README.md

@@ -1,5 +1,7 @@
 # Hypercore
 
+### [See the full API docs at docs.holepunch.to](https://docs.holepunch.to/building-blocks/hypercore)
+
 Hypercore is a secure, distributed append-only log.
 
 Built for sharing large datasets and streams of real time data
@@ -76,7 +78,7 @@ Note that `tree`, `data`, and `bitfield` are normally heavily sparse files.
 
 You can also set valueEncoding to any [abstract-encoding](https://github.com/mafintosh/abstract-encoding) or [compact-encoding](https://github.com/compact-encoding) instance.
 
-valueEncodings will be applied to individually blocks, even if you append batches. If you want to control encoding at the batch-level, you can use the `encodeBatch` option, which is a function that takes a batch and returns a binary-encoded batch. If you provide a custom valueEncoding, it will not be applied prior to `encodeBatch`.
+valueEncodings will be applied to individual blocks, even if you append batches. If you want to control encoding at the batch-level, you can use the `encodeBatch` option, which is a function that takes a batch and returns a binary-encoded batch. If you provide a custom valueEncoding, it will not be applied prior to `encodeBatch`.
 
 #### `const { length, byteLength } = await core.append(block)`
 
@@ -124,7 +126,7 @@ Check if the core has all blocks between `start` and `end`.
 
 #### `const updated = await core.update()`
 
-Wait for the core to try and find a signed update to it's length.
+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.
 
 ``` js
@@ -137,7 +139,7 @@ console.log('core was updated?', updated, 'length is', core.length)
 
 Seek to a byte offset.
 
-Returns `[index, relativeOffset]`, where `index` is the data block the byteOffset is contained in and `relativeOffset` is
+Returns `[index, relativeOffset]`, where `index` is the data block the `byteOffset` is contained in and `relativeOffset` is
 the relative byte offset in the data block.
 
 ``` js
@@ -293,7 +295,7 @@ as all internals await this themself.
 
 #### `core.on('ready')`
 
-Emitted after the core has initially opened all it's internal state.
+Emitted after the core has initially opened all its internal state.
 
 #### `core.writable`
 

package/index.js

@@ -385,7 +385,7 @@ module.exports = class Hypercore extends EventEmitter {
   }
 
   async _close (err) {
-    await this.opening
+    if (this.opened === false) await this.opening
 
     const i = this.sessions.indexOf(this)
     if (i === -1) return
@@ -646,20 +646,19 @@ module.exports = class Hypercore extends EventEmitter {
       return this._updateSnapshot()
     }
 
-    const activeRequests = (opts && opts.activeRequests) || this.activeRequests
-    const req = this.replicator.addUpgrade(activeRequests)
+    const remoteWait = typeof (opts && opts.wait) === 'boolean' ? opts.wait : this._findingPeers > 0
 
-    let upgraded = await req.promise
+    let upgraded = false
 
-    if (!this.sparse) {
-      // Download all available blocks in non-sparse mode
-      const start = this.length
-      const end = this.core.tree.length
-      const contig = this.contiguousLength
+    if (await this.replicator.applyPendingReorg()) {
+      upgraded = true
+    }
 
-      await this.download({ start, end, ifAvailable: true }).done()
+    if (!upgraded && remoteWait) {
+      const activeRequests = (opts && opts.activeRequests) || this.activeRequests
+      const req = this.replicator.addUpgrade(activeRequests)
 
-      if (!upgraded) upgraded = this.contiguousLength !== contig
+      upgraded = await req.promise
     }
 
     if (!upgraded) return false

package/lib/replicator.js

@@ -909,7 +909,7 @@ module.exports = class Replicator {
     this._hadPeers = false
     this._ifAvailable = 0
     this._updatesPending = 0
-    this._applyingReorg = false
+    this._applyingReorg = null
   }
 
   cork () {
@@ -959,6 +959,23 @@ module.exports = class Replicator {
     await Promise.allSettled(all)
   }
 
+  async applyPendingReorg () {
+    if (this._applyingReorg !== null) {
+      await this._applyingReorg
+      return true
+    }
+
+    for (let i = this._reorgs.length - 1; i >= 0; i--) {
+      const f = this._reorgs[i]
+      if (f.batch !== null && f.batch.finished) {
+        await this._applyReorg(f)
+        return true
+      }
+    }
+
+    return false
+  }
+
   addUpgrade (session) {
     if (this._upgrade !== null) {
       const ref = this._upgrade.attach(session)
@@ -968,14 +985,6 @@ module.exports = class Replicator {
 
     const ref = this._addUpgrade().attach(session)
 
-    for (let i = this._reorgs.length - 1; i >= 0 && this._applyingReorg === false; i--) {
-      const f = this._reorgs[i]
-      if (f.batch !== null && f.batch.finished) {
-        this._applyReorg(f)
-        break
-      }
-    }
-
     this.updateAll()
 
     return ref
@@ -1070,7 +1079,7 @@ module.exports = class Replicator {
 
     // check if reorgs in progress...
 
-    if (this._applyingReorg === true) return
+    if (this._applyingReorg !== null) return
 
     // TODO: we prob should NOT wait for inflight reorgs here, seems better to just resolve the upgrade
     // and then apply the reorg on the next call in case it's slow - needs some testing in practice
@@ -1429,17 +1438,17 @@ module.exports = class Replicator {
 
     const u = this._upgrade
 
-    this._applyingReorg = true
     this._reorgs = [] // clear all as the nodes are against the old tree - easier
+    this._applyingReorg = this.core.reorg(f.batch, null) // TODO: null should be the first/last peer?
 
     try {
-      await this.core.reorg(f.batch, null) // TODO: null should be the first/last peer?
+      await this._applyingReorg
     } catch (err) {
       this._upgrade = null
       u.reject(err)
     }
 
-    this._applyingReorg = false
+    this._applyingReorg = null
 
     if (this._upgrade !== null) {
       this._resolveUpgradeRequest(null)
@@ -1461,7 +1470,7 @@ module.exports = class Replicator {
   }
 
   _updateFork (peer) {
-    if (this._applyingReorg === true || this.allowFork === false || peer.remoteFork <= this.core.tree.fork) {
+    if (this._applyingReorg !== null || this.allowFork === false || peer.remoteFork <= this.core.tree.fork) {
       return false
     }
 
@@ -1531,7 +1540,7 @@ module.exports = class Replicator {
 
   updatePeer (peer) {
     // Quick shortcut to wait for flushing reorgs - not needed but less waisted requests
-    if (this._applyingReorg === true) return
+    if (this._applyingReorg !== null) return
 
     while (this._updatePeer(peer) === true);
     while (this._updatePeerNonPrimary(peer) === true);
@@ -1542,7 +1551,7 @@ module.exports = class Replicator {
 
   updateAll () {
     // Quick shortcut to wait for flushing reorgs - not needed but less waisted requests
-    if (this._applyingReorg === true) return
+    if (this._applyingReorg !== null) return
 
     const peers = new RandomIterator(this.peers)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore",
-  "version": "10.5.3",
+  "version": "10.6.0",
   "description": "Hypercore is a secure, distributed append-only log",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/hypercore-protocol/hypercore.git"
+    "url": "git+https://github.com/holepunchto/hypercore.git"
   },
   "contributors": [
     {
@@ -25,9 +25,9 @@
   ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/hypercore-protocol/hypercore/issues"
+    "url": "https://github.com/holepunchto/hypercore/issues"
   },
-  "homepage": "https://github.com/hypercore-protocol/hypercore#readme",
+  "homepage": "https://github.com/holepunchto/hypercore#readme",
   "files": [
     "index.js",
     "lib/**.js"
@@ -47,14 +47,14 @@
     "random-access-file": "^4.0.0",
     "random-array-iterator": "^1.0.0",
     "safety-catch": "^1.0.1",
-    "sodium-universal": "^3.0.4",
+    "sodium-universal": "^4.0.0",
     "streamx": "^2.12.4",
     "xache": "^1.1.0",
     "z32": "^1.0.0"
   },
   "devDependencies": {
     "brittle": "^3.0.0",
-    "hyperswarm": "^4.3.0",
+    "hyperswarm": "^4.3.6",
     "random-access-memory": "^6.1.0",
     "random-access-memory-overlay": "^3.0.0",
     "standard": "^17.0.0",