hypercore 10.15.0 → 10.16.0

package/README.md

@@ -73,6 +73,7 @@ Note that `tree`, `data`, and `bitfield` are normally heavily sparse files.
   keyPair: kp, // optionally pass the public key and secret key as a key pair
   encryptionKey: k, // optionally pass an encryption key to enable block encryption
   onwait: () => {}, // hook that is called if gets are waiting for download
+  timeout: 0, // wait at max some milliseconds (0 means no timeout)
   writable: true // disable appends and truncates
 }
 ```

package/lib/core.js

@@ -73,7 +73,7 @@ module.exports = class Core {
     const oplog = new Oplog(oplogFile, {
       headerEncoding: m.oplog.header,
       entryEncoding: m.oplog.entry,
-      headerOnly: opts.readonly
+      readonly: opts.readonly
     })
 
     let { header, entries } = await oplog.open()

package/lib/errors.js

@@ -44,6 +44,10 @@ module.exports = class HypercoreError extends Error {
     return new HypercoreError(msg, 'INVALID_PROOF', HypercoreError.INVALID_PROOF)
   }
 
+  static BLOCK_NOT_AVAILABLE (msg = 'Block is not available') {
+    return new HypercoreError(msg, 'BLOCK_NOT_AVAILABLE', HypercoreError.BLOCK_NOT_AVAILABLE)
+  }
+
   static SNAPSHOT_NOT_AVAILABLE (msg = 'Snapshot is not available') {
     return new HypercoreError(msg, 'SNAPSHOT_NOT_AVAILABLE', HypercoreError.SNAPSHOT_NOT_AVAILABLE)
   }

package/lib/oplog.js

@@ -4,11 +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, headerOnly = false } = {}) {
+  constructor (storage, { pageSize = 4096, headerEncoding = cenc.raw, entryEncoding = cenc.raw, readonly = false } = {}) {
     this.storage = storage
     this.headerEncoding = headerEncoding
     this.entryEncoding = entryEncoding
-    this.headerOnly = headerOnly
+    this.readonly = readonly
     this.flushed = false
     this.byteLength = 0
     this.length = 0
@@ -102,8 +102,6 @@ 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
@@ -125,6 +123,7 @@ module.exports = class Oplog {
     if (size === buffer.byteLength) return result
 
     await new Promise((resolve, reject) => {
+      if (this.readonly) return resolve()
       this.storage.truncate(size, err => {
         if (err) return reject(err)
         resolve()

package/package.json

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