hypercore 10.13.0 → 10.15.0

package/README.md

@@ -303,6 +303,16 @@ To cancel downloading a range simply destroy the range instance.
 range.destroy()
 ```
 
+#### `const session = await core.session([options])`
+
+Creates a new Hypercore instance that shares the same underlying core.
+
+You must close any session you make.
+
+Options are inherited from the parent instance, unless they are re-set.
+
+`options` are the same as in the constructor.
+
 #### `const info = await core.info([options])`
 
 Get information about this core, such as its total size in bytes.

package/index.js

@@ -184,13 +184,14 @@ module.exports = class Hypercore extends EventEmitter {
     const toLock = opts.unlocked ? null : (opts.lock || 'oplog')
     const pool = opts.pool || (opts.poolSize ? RAF.createPool(opts.poolSize) : null)
     const rmdir = !!opts.rmdir
+    const writable = opts.writable !== false
 
     return createFile
 
     function createFile (name) {
       const lock = toLock === null ? false : isFile(name, toLock)
       const sparse = isFile(name, 'data') || isFile(name, 'bitfield') || isFile(name, 'tree')
-      return new RAF(name, { directory, lock, sparse, pool: lock ? null : pool, rmdir })
+      return new RAF(name, { directory, lock, sparse, pool: lock ? null : pool, rmdir, writable })
     }
 
     function isFile (name, n) {
@@ -331,11 +332,13 @@ module.exports = class Hypercore extends EventEmitter {
   async _openCapabilities (keyPair, storage, opts) {
     if (opts.from) return this._openFromExisting(opts.from, opts)
 
-    this.storage = Hypercore.defaultStorage(opts.storage || storage)
+    const unlocked = !!opts.unlocked
+    this.storage = Hypercore.defaultStorage(opts.storage || storage, { unlocked, writable: !unlocked })
 
     this.core = await Core.open(this.storage, {
       force: opts.force,
       createIfMissing: opts.createIfMissing,
+      readonly: unlocked,
       overwrite: opts.overwrite,
       keyPair,
       crypto: this.crypto,
@@ -630,9 +633,9 @@ module.exports = class Hypercore extends EventEmitter {
     }
   }
 
-  async setUserData (key, value) {
+  async setUserData (key, value, { flush = false } = {}) {
     if (this.opened === false) await this.opening
-    return this.core.userData(key, value)
+    return this.core.userData(key, value, flush)
   }
 
   async getUserData (key) {

package/lib/core.js

@@ -72,7 +72,8 @@ module.exports = class Core {
 
     const oplog = new Oplog(oplogFile, {
       headerEncoding: m.oplog.header,
-      entryEncoding: m.oplog.entry
+      entryEncoding: m.oplog.entry,
+      headerOnly: opts.readonly
     })
 
     let { header, entries } = await oplog.open()
@@ -191,7 +192,7 @@ module.exports = class Core {
     await this.blocks.put(index, value, byteOffset)
   }
 
-  async userData (key, value) {
+  async userData (key, value, flush) {
     // TODO: each oplog append can set user data, so we should have a way
     // to just hitch a ride on one of the other ongoing appends?
     await this._mutex.lock()
@@ -219,7 +220,7 @@ module.exports = class Core {
 
       updateUserData(this.header.userData, key, value)
 
-      if (this._shouldFlush()) await this._flushOplog()
+      if (this._shouldFlush() || flush) await this._flushOplog()
     } finally {
       this._mutex.unlock()
     }

package/lib/oplog.js

@@ -4,10 +4,11 @@ const { crc32 } = require('crc-universal')
 const { OPLOG_CORRUPT } = require('./errors')
 
 module.exports = class Oplog {
-  constructor (storage, { pageSize = 4096, headerEncoding = cenc.raw, entryEncoding = cenc.raw } = {}) {
+  constructor (storage, { pageSize = 4096, headerEncoding = cenc.raw, entryEncoding = cenc.raw, headerOnly = false } = {}) {
     this.storage = storage
     this.headerEncoding = headerEncoding
     this.entryEncoding = entryEncoding
+    this.headerOnly = headerOnly
     this.flushed = false
     this.byteLength = 0
     this.length = 0
@@ -101,6 +102,8 @@ module.exports = class Oplog {
 
     result.header = header ? h2.message : h1.message
 
+    if (this.headerOnly) return result
+
     while (true) {
       const entry = this._decodeEntry(state, this.entryEncoding)
       if (!entry) break

package/package.json

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