hypercore 11.10.1 → 11.11.1

package/README.md

@@ -61,15 +61,24 @@ Alternatively you can pass a [Hypercore Storage](https://github.com/holepunchto/
   ongc: (session) => { ... }, // A callback called when the session is garbage collected
   notDownloadingLinger: 20000, // How many milliseconds to wait after downloading finishes keeping the connection open. Defaults to a random number between 20-40s
   allowFork: true, // Enables updating core when it forks
+  userData: { foo: 'bar' }, // An object to assign to the local User Uata storage
 }
 ```
 
-You can also set valueEncoding to any [compact-encoding](https://github.com/compact-encoding) instance.
+You can also set `valueEncoding` to any [compact-encoding](https://github.com/compact-encoding) instance.
 
-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`.
+`valueEncoding`s 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`.
 
 The user may provide a custom encryption module as `opts.encryption`, which should satisfy the [HypercoreEncryption](https://github.com/holepunchto/hypercore-encryption) interface.
 
+##### User Data
+
+User Data is a key-value store that is persisted locally and is not replicated with the Hypercore. This is useful as a quick store for data only used by the current peer. For example, `autobase` uses User Data to store information such as encryption keys and connections between a peer's local writer and the Autobase's bootstrap core.
+
+Keys are always strings and values can be strings or buffers.
+
+See [`core.setUserData(key, value)`](#await-coresetuserdatakey-value) and [`core.getUserData(key)`](#const-value--await-coregetuserdatakey) for updating User Data.
+
 #### `const { length, byteLength } = await core.append(block)`
 
 Append a block of data (or an array of blocks) to the core.
@@ -455,6 +464,18 @@ Populated after `ready` has been emitted. Will be `0` before the event.
 
 How much padding is applied to each block of this core? Will be `0` unless block encryption is enabled.
 
+#### `await core.setUserData(key, value)`
+
+Set a key in the User Data key-value store.
+
+`key` is a string and `value` can be a string or buffer.
+
+#### `const value = await core.getUserData(key)`
+
+Return the value for a key in the User Data key-value store.
+
+`key` is a string.
+
 #### `const stream = core.replicate(isInitiatorOrReplicationStream)`
 
 Create a replication stream. You should pipe this to another Hypercore instance.

package/lib/merkle-tree.js

@@ -1091,8 +1091,9 @@ function nodesToRoot (index, nodes, head) {
   const ite = flat.iterator(index)
 
   for (let i = 0; i < nodes; i++) {
+    const index = ite.index
     ite.parent()
-    if (ite.contains(head)) throw BAD_ARGUMENT('Nodes is out of bounds')
+    if (ite.contains(head)) return index
   }
 
   return ite.index

package/lib/streams.js

@@ -9,6 +9,8 @@ class ReadStream extends Readable {
     this.end = typeof opts.end === 'number' ? opts.end : -1
     this.snapshot = !opts.live && opts.snapshot !== false
     this.live = this.end === -1 ? !!opts.live : false
+    this.wait = typeof opts.wait === 'boolean' ? opts.wait : this.core.wait
+    this.timeout = opts.timeout || core.timeout
   }
 
   _open (cb) {
@@ -32,7 +34,7 @@ class ReadStream extends Readable {
       return
     }
 
-    this.push(await this.core.get(this.start++))
+    this.push(await this.core.get(this.start++, { wait: this.wait, timeout: this.timeout }))
   }
 }
 

package/package.json

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